Add New...f constructors for all service errors (#221)

alexshtin · web-flow · commit 39aa8c9e49a6 · 2025-05-15T16:45:22.000-07:00
diff --git a/serviceerror/already_exists.go b/serviceerror/already_exists.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -13,13 +15,25 @@ type (
 	}
 )
 
-// NewAlreadyExist returns new AlreadyExists error.
+// Deprecated. Typo in the name. Use NewAlreadyExists instead.
 func NewAlreadyExist(message string) error {
+	return NewAlreadyExists(message)
+}
+
+// NewAlreadyExists returns new AlreadyExists error.
+func NewAlreadyExists(message string) error {
 	return &AlreadyExists{
 		Message: message,
 	}
 }
 
+// NewAlreadyExistsf returns new AlreadyExists error with formatted message.
+func NewAlreadyExistsf(format string, args ...any) error {
+	return &AlreadyExists{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *AlreadyExists) Error() string {
 	return e.Message
diff --git a/serviceerror/canceled.go b/serviceerror/canceled.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewCanceled(message string) error {
 	}
 }
 
+// NewCanceledf returns new Canceled error with formatted message.
+func NewCanceledf(format string, args ...any) error {
+	return &Canceled{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *Canceled) Error() string {
 	return e.Message
diff --git a/serviceerror/cancellation_already_requested.go b/serviceerror/cancellation_already_requested.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -22,6 +24,13 @@ func NewCancellationAlreadyRequested(message string) error {
 	}
 }
 
+// NewCancellationAlreadyRequestedf returns new CancellationAlreadyRequested error with formatted message.
+func NewCancellationAlreadyRequestedf(format string, args ...any) error {
+	return &CancellationAlreadyRequested{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *CancellationAlreadyRequested) Error() string {
 	return e.Message
diff --git a/serviceerror/client_version_not_supported.go b/serviceerror/client_version_not_supported.go
@@ -30,6 +30,16 @@ func NewClientVersionNotSupported(clientVersion, clientName, supportedVersions s
 	}
 }
 
+// NewClientVersionNotSupportedf returns new ClientVersionNotSupported error with formatted message.
+func NewClientVersionNotSupportedf(clientVersion, clientName, supportedVersions, format string, args ...any) error {
+	return &ClientVersionNotSupported{
+		Message:           fmt.Sprintf(format, args...),
+		ClientVersion:     clientVersion,
+		ClientName:        clientName,
+		SupportedVersions: supportedVersions,
+	}
+}
+
 // Error returns string message.
 func (e *ClientVersionNotSupported) Error() string {
 	return e.Message
diff --git a/serviceerror/convert.go b/serviceerror/convert.go
@@ -176,7 +176,7 @@ func FromStatus(st *status.Status) error {
 	return st.Err()
 }
 
-func extractErrorDetails(st *status.Status) interface{} {
+func extractErrorDetails(st *status.Status) any {
 	details := st.Details()
 	if len(details) > 0 {
 		return details[0]
diff --git a/serviceerror/data_loss.go b/serviceerror/data_loss.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewDataLoss(message string) error {
 	}
 }
 
+// NewDataLossf returns new DataLoss error with formatted message.
+func NewDataLossf(format string, args ...any) error {
+	return &DataLoss{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *DataLoss) Error() string {
 	return e.Message
diff --git a/serviceerror/deadline_exceeded.go b/serviceerror/deadline_exceeded.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewDeadlineExceeded(message string) error {
 	}
 }
 
+// NewDeadlineExceededf returns new DeadlineExceeded error with formatted message.
+func NewDeadlineExceededf(format string, args ...any) error {
+	return &DeadlineExceeded{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *DeadlineExceeded) Error() string {
 	return e.Message
diff --git a/serviceerror/failed_precondition.go b/serviceerror/failed_precondition.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewFailedPrecondition(message string) error {
 	}
 }
 
+// NewFailedPreconditionf returns new FailedPrecondition error with formatted message.
+func NewFailedPreconditionf(format string, args ...any) error {
+	return &FailedPrecondition{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *FailedPrecondition) Error() string {
 	return e.Message
diff --git a/serviceerror/internal.go b/serviceerror/internal.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewInternal(message string) error {
 	}
 }
 
+// NewInternalf returns new Internal error with formatted message.
+func NewInternalf(format string, args ...any) error {
+	return &Internal{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *Internal) Error() string {
 	return e.Message
diff --git a/serviceerror/invalid_argument.go b/serviceerror/invalid_argument.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -20,6 +22,13 @@ func NewInvalidArgument(message string) error {
 	}
 }
 
+// NewInvalidArgumentf returns new InvalidArgument error with formatted message.
+func NewInvalidArgumentf(format string, args ...any) error {
+	return &InvalidArgument{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *InvalidArgument) Error() string {
 	return e.Message
diff --git a/serviceerror/multi_op.go b/serviceerror/multi_op.go
@@ -2,6 +2,7 @@ package serviceerror
 
 import (
 	"errors"
+	"fmt"
 
 	"go.temporal.io/api/errordetails/v1"
 	"google.golang.org/grpc/codes"
@@ -20,6 +21,11 @@ func NewMultiOperationExecution(message string, errs []error) error {
 	return &MultiOperationExecution{Message: message, errs: errs}
 }
 
+// NewMultiOperationExecutionf returns a new MultiOperationExecution error with formatted message.
+func NewMultiOperationExecutionf(errs []error, format string, args ...any) error {
+	return &MultiOperationExecution{Message: fmt.Sprintf(format, args...), errs: errs}
+}
+
 // Error returns string message.
 func (e *MultiOperationExecution) Error() string {
 	return e.Message
diff --git a/serviceerror/multi_op_aborted.go b/serviceerror/multi_op_aborted.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	failurepb "go.temporal.io/api/failure/v1"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -19,6 +21,13 @@ func NewMultiOperationAborted(message string) error {
 	}
 }
 
+// NewMultiOperationAbortedf returns MultiOperationAborted with formatted message.
+func NewMultiOperationAbortedf(format string, args ...any) error {
+	return &MultiOperationAborted{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e MultiOperationAborted) Error() string {
 	return e.Message
diff --git a/serviceerror/namespace_already_exists.go b/serviceerror/namespace_already_exists.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -22,6 +24,13 @@ func NewNamespaceAlreadyExists(message string) error {
 	}
 }
 
+// NewNamespaceAlreadyExistsf returns new NamespaceAlreadyExists error with formatted message.
+func NewNamespaceAlreadyExistsf(format string, args ...any) error {
+	return &NamespaceAlreadyExists{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *NamespaceAlreadyExists) Error() string {
 	return e.Message
diff --git a/serviceerror/not_found.go b/serviceerror/not_found.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -24,6 +26,13 @@ func NewNotFound(message string) error {
 	}
 }
 
+// NewNotFoundf returns new NotFound error with formatted message.
+func NewNotFoundf(format string, args ...any) error {
+	return &NotFound{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // Error returns string message.
 func (e *NotFound) Error() string {
 	return e.Message
diff --git a/serviceerror/permission_denied.go b/serviceerror/permission_denied.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"go.temporal.io/api/errordetails/v1"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -23,6 +25,14 @@ func NewPermissionDenied(message, reason string) error {
 	}
 }
 
+// NewPermissionDeniedf returns new PermissionDenied error with formatted message.
+func NewPermissionDeniedf(reason, format string, args ...any) error {
+	return &PermissionDenied{
+		Message: fmt.Sprintf(format, args...),
+		Reason:  reason,
+	}
+}
+
 // Error returns string message.
 func (e *PermissionDenied) Error() string {
 	return e.Message
diff --git a/serviceerror/query_failed.go b/serviceerror/query_failed.go
@@ -1,6 +1,8 @@
 package serviceerror
 
 import (
+	"fmt"
+
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -12,8 +14,7 @@ type (
 	// QueryFailed represents query failed error.
 	QueryFailed struct {
 		Message string
-		// The full reason for this query failure. May not be available if the response is generated by an old
-		// SDK.
+		// The full reason for this query failure. May not be available if the response is generated by an old SDK.
 		Failure *failure.Failure
 		st      *status.Status
 	}
@@ -26,6 +27,13 @@ func NewQueryFailed(message string) error {
 	}
 }
 
+// NewQueryFailedf returns new QueryFailed error with formatted message.
+func NewQueryFailedf(format string, args ...any) error {
+	return &QueryFailed{
+		Message: fmt.Sprintf(format, args...),
+	}
+}
+
 // NewQueryFailed returns new QueryFailed error.
 func NewQueryFailedWithFailure(message string, failure *failure.Failure) error {
 	return &QueryFailed{
@@ -34,6 +42,14 @@ func NewQueryFailedWithFailure(message string, failure *failure.Failure) error {
 	}
 }
 
+// NewQueryFailedWithFailuref returns new QueryFailed error with failure and formatted message.
+func NewQueryFailedWithFailuref(failure *failure.Failure, format string, args ...any) error {
+	return &QueryFailed{
+		Message: fmt.Sprintf(format, args...),
+		Failure: failure,
+	}
+}
+
 // Error returns string message.
 func (e *QueryFailed) Error() string {
 	return e.Message
diff --git a/serviceerror/resource_exhausted.go b/serviceerror/resource_exhausted.go
diff --git a/serviceerror/system_workflow.go b/serviceerror/system_workflow.go
diff --git a/serviceerror/unavailable.go b/serviceerror/unavailable.go
diff --git a/serviceerror/unimplemented.go b/serviceerror/unimplemented.go
diff --git a/serviceerror/workflow_execution_already_started.go b/serviceerror/workflow_execution_already_started.go
diff --git a/serviceerror/workflow_not_ready.go b/serviceerror/workflow_not_ready.go

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ func FromStatus(st *status.Status) error {`
`176`	`176`	`return st.Err()`
`177`	`177`	`}`
`178`	`178`
`179`		`-func extractErrorDetails(st *status.Status) interface{} {`
	`179`	`+func extractErrorDetails(st *status.Status) any {`
`180`	`180`	`details := st.Details()`
`181`	`181`	`if len(details) > 0 {`
`182`	`182`	`return details[0]`