serviceerror: add error checking helpers (#227)

tdeebswihart · web-flow · commit 981440dcff4d · 2025-10-20T13:48:07.000-04:00
diff --git a/serviceerror/aborted.go b/serviceerror/aborted.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -47,3 +48,10 @@ func newAborted(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsAborted returns whether any error in the provided error's chain is an
+// Aborted error.
+func IsAborted(err error) bool {
+	var serr *Aborted
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/already_exists.go b/serviceerror/already_exists.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -53,3 +54,10 @@ func newAlreadyExists(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsAlreadyExists returns whether any error in the provided error's chain is an
+// AlreadyExists error.
+func IsAlreadyExists(err error) bool {
+	var serr *AlreadyExists
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/canceled.go b/serviceerror/canceled.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newCanceled(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsCanceled returns whether any error in the provided error's chain is a
+// Canceled error.
+func IsCanceled(err error) bool {
+	var serr *Canceled
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/cancellation_already_requested.go b/serviceerror/cancellation_already_requested.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -54,3 +55,10 @@ func newCancellationAlreadyRequested(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsCancellationAlreadyRequested returns whether any error in the provided error's chain is a
+// CancellationAlreadyRequested error.
+func IsCancellationAlreadyRequested(err error) bool {
+	var serr *CancellationAlreadyRequested
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/client_version_not_supported.go b/serviceerror/client_version_not_supported.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -70,3 +71,10 @@ func newClientVersionNotSupported(st *status.Status, errDetails *errordetails.Cl
 		st:                st,
 	}
 }
+
+// IsClientVersionNotSupported returns whether any error in the provided error's chain is a
+// ClientVersionNotSupported error.
+func IsClientVersionNotSupported(err error) bool {
+	var serr *ClientVersionNotSupported
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/data_loss.go b/serviceerror/data_loss.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newDataLoss(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsDataLoss returns whether any error in the provided error's chain is a
+// DataLoss error.
+func IsDataLoss(err error) bool {
+	var serr *DataLoss
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/deadline_exceeded.go b/serviceerror/deadline_exceeded.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newDeadlineExceeded(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsDeadlineExceeded returns whether any error in the provided error's chain is a
+// DeadlineExceeded error.
+func IsDeadlineExceeded(err error) bool {
+	var serr *DeadlineExceeded
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/failed_precondition.go b/serviceerror/failed_precondition.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newFailedPrecondition(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsFailedPrecondition returns whether any error in the provided error's chain is a
+// FailedPrecondition error.
+func IsFailedPrecondition(err error) bool {
+	var serr *FailedPrecondition
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/internal.go b/serviceerror/internal.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newInternal(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsInternal returns whether any error in the provided error's chain is an
+// Internal error.
+func IsInternal(err error) bool {
+	var serr *Internal
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/invalid_argument.go b/serviceerror/invalid_argument.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -48,3 +49,10 @@ func newInvalidArgument(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsInvalidArgument returns whether any error in the provided error's chain is an
+// InvalidArgument error.
+func IsInvalidArgument(err error) bool {
+	var serr *InvalidArgument
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/multi_op.go b/serviceerror/multi_op.go
@@ -76,3 +76,10 @@ func newMultiOperationExecution(st *status.Status, errs []error) error {
 		st:      st,
 	}
 }
+
+// IsMultiOperationExecution returns whether any error in the provided error's chain is a
+// MultiOperationExecution error.
+func IsMultiOperationExecution(err error) bool {
+	var serr *MultiOperationExecution
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/multi_op_aborted.go b/serviceerror/multi_op_aborted.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	failurepb "go.temporal.io/api/failure/v1"
@@ -49,3 +50,10 @@ func newMultiOperationAborted(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsMultiOperationAborted returns whether any error in the provided error's chain is a
+// MultiOperationAborted error.
+func IsMultiOperationAborted(err error) bool {
+	var serr *MultiOperationAborted
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/namespace_already_exists.go b/serviceerror/namespace_already_exists.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -54,3 +55,10 @@ func newNamespaceAlreadyExists(st *status.Status) error {
 		st:      st,
 	}
 }
+
+// IsNamespaceAlreadyExists returns whether any error in the provided error's chain is a
+// NamespaceAlreadyExists error.
+func IsNamespaceAlreadyExists(err error) bool {
+	var serr *NamespaceAlreadyExists
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/namespace_invalid_state.go b/serviceerror/namespace_invalid_state.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -70,3 +71,10 @@ func newNamespaceInvalidState(st *status.Status, errDetails *errordetails.Namesp
 		st:            st,
 	}
 }
+
+// IsNamespaceInvalidState returns whether any error in the provided error's chain is a
+// NamespaceInvalidState error.
+func IsNamespaceInvalidState(err error) bool {
+	var serr *NamespaceInvalidState
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/namespace_not_active.go b/serviceerror/namespace_not_active.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -65,3 +66,10 @@ func newNamespaceNotActive(st *status.Status, errDetails *errordetails.Namespace
 		st:             st,
 	}
 }
+
+// IsNamespaceNotActive returns whether any error in the provided error's chain is a
+// NamespaceNotActive error.
+func IsNamespaceNotActive(err error) bool {
+	var serr *NamespaceNotActive
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/namespace_not_found.go b/serviceerror/namespace_not_found.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -55,3 +56,10 @@ func newNamespaceNotFound(st *status.Status, errDetails *errordetails.NamespaceN
 		st:        st,
 	}
 }
+
+// IsNamespaceNotFound returns whether any error in the provided error's chain is a
+// NamespaceNotFound error.
+func IsNamespaceNotFound(err error) bool {
+	var serr *NamespaceNotFound
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/namespace_unavailable.go b/serviceerror/namespace_unavailable.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -57,3 +58,10 @@ func newNamespaceUnavailable(st *status.Status, errDetails *errordetails.Namespa
 		Namespace: errDetails.GetNamespace(),
 	}
 }
+
+// IsNamespaceUnavailable returns whether any error in the provided error's chain is a
+// NamespaceUnavailable error.
+func IsNamespaceUnavailable(err error) bool {
+	var serr *NamespaceUnavailable
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/newer_build_exists.go b/serviceerror/newer_build_exists.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -53,3 +54,10 @@ func newNewerBuildExists(st *status.Status, errDetails *errordetails.NewerBuildE
 		st:             st,
 	}
 }
+
+// IsNewerBuildExists returns whether any error in the provided error's chain is a
+// NewerBuildExists error.
+func IsNewerBuildExists(err error) bool {
+	var serr *NewerBuildExists
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/not_found.go b/serviceerror/not_found.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -61,3 +62,10 @@ func newNotFound(st *status.Status, errDetails *errordetails.NotFoundFailure) er
 		st:             st,
 	}
 }
+
+// IsNotFound returns whether any error in the provided error's chain is a
+// NotFound error.
+func IsNotFound(err error) bool {
+	var serr *NotFound
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/permission_denied.go b/serviceerror/permission_denied.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"go.temporal.io/api/errordetails/v1"
@@ -59,3 +60,10 @@ func newPermissionDenied(st *status.Status, errDetails *errordetails.PermissionD
 		st:      st,
 	}
 }
+
+// IsPermissionDenied returns whether any error in the provided error's chain is a
+// PermissionDenied error.
+func IsPermissionDenied(err error) bool {
+	var serr *PermissionDenied
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/query_failed.go b/serviceerror/query_failed.go
@@ -1,6 +1,7 @@
 package serviceerror
 
 import (
+	"errors"
 	"fmt"
 
 	"google.golang.org/grpc/codes"
@@ -76,3 +77,10 @@ func newQueryFailed(st *status.Status, errDetails *errordetails.QueryFailedFailu
 		st:      st,
 	}
 }
+
+// IsQueryFailed returns whether any error in the provided error's chain is a
+// QueryFailed error.
+func IsQueryFailed(err error) bool {
+	var serr *QueryFailed
+	return errors.As(err, &serr)
+}
diff --git a/serviceerror/resource_exhausted.go b/serviceerror/resource_exhausted.go
diff --git a/serviceerror/server_version_not_supported.go b/serviceerror/server_version_not_supported.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
