fix: ignore context.Canceled errors in Sentry reporting (#4909)

* fix: ignore `context.Canceled` errors in Sentry reporting

* fix lint and add changelog

* fix missing comment

* rollback comments changes

Author: Pantani

changelog.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- [#4909](https://github.com/ignite/cli/pull/4909) Ignore `context.Canceled` errors in Sentry reporting.
+
 ## [`v29.9.2`](https://github.com/ignite/cli/releases/tag/v29.9.2)
 
 - [#4904](https://github.com/ignite/cli/pull/4904) Add variadic options in `modulecreate.AddModuleToAppConfig`.

ignite/pkg/errors/xerrors.go

@@ -13,6 +13,8 @@
 package errors
 
 import (
+	"context"
+
 	"github.com/cockroachdb/errors"
 	"github.com/getsentry/sentry-go"
 )
@@ -21,30 +23,28 @@ import (
 // A stack trace is retained.
 func New(msg string) error {
 	err := errors.New(msg)
-	sentry.CaptureException(err)
+	captureException(err)
 	return err
 }
 
 // Errorf aliases Newf().
 func Errorf(format string, args ...any) error {
 	err := errors.Errorf(format, args...)
-	sentry.CaptureException(err)
+	captureException(err)
 	return err
 }
 
 // WithStack annotates err with a stack trace at the point WithStack was called.
 func WithStack(err error) error {
 	errWithStack := errors.WithStack(err)
-	sentry.CaptureException(errWithStack)
+	captureException(errWithStack)
 	return errWithStack
 }
 
 // Wrap wraps an error with a message prefix. A stack trace is retained.
 func Wrap(err error, msg string) error {
 	errWrap := errors.Wrap(err, msg)
-	if err != nil {
-		sentry.CaptureException(errWrap)
-	}
+	captureException(errWrap)
 	return errWrap
 }
 
@@ -53,12 +53,20 @@ func Wrap(err error, msg string) error {
 // but the extra arguments are still processed for reportable strings.
 func Wrapf(err error, format string, args ...any) error {
 	errWrap := errors.Wrapf(err, format, args...)
-	if err != nil {
-		sentry.CaptureException(errWrap)
-	}
+	captureException(errWrap)
 	return errWrap
 }
 
+func captureException(err error) {
+	if shouldCaptureException(err) {
+		sentry.CaptureException(err)
+	}
+}
+
+func shouldCaptureException(err error) bool {
+	return err != nil && !Is(err, context.Canceled)
+}
+
 // Unwrap accesses the direct cause of the error if any, otherwise
 // returns nil.
 func Unwrap(err error) error { return errors.Unwrap(err) }

ignite/pkg/errors/xerrors_test.go

@@ -1,6 +1,7 @@
 package errors
 
 import (
+	"context"
 	stdErrors "errors"
 	"testing"
 
@@ -55,3 +56,16 @@ func TestWithStack(t *testing.T) {
 	base := stdErrors.New("base")
 	require.True(t, Is(WithStack(base), base))
 }
+
+func TestShouldCaptureException(t *testing.T) {
+	t.Run("canceled errors are ignored", func(t *testing.T) {
+		require.False(t, shouldCaptureException(context.Canceled))
+		require.False(t, shouldCaptureException(Wrap(context.Canceled, "prefix")))
+		require.False(t, shouldCaptureException(Wrapf(context.Canceled, "prefix %s", "x")))
+		require.False(t, shouldCaptureException(WithStack(context.Canceled)))
+	})
+
+	t.Run("other errors are reported", func(t *testing.T) {
+		require.True(t, shouldCaptureException(stdErrors.New("boom")))
+	})
+}

ignite/templates/module/create/app_config_ast.go

@@ -26,7 +26,7 @@ func SkipConfigEntry() AddModuleAppConfigOption {
 }
 
 // SpecifyModuleEntry allows to define to which field the module should be added in the app config.
-// E.g. "PreBlockers", "InitGenesis", "BeginBlockers", "EndBlockers"
+// E.g. "PreBlockers", "InitGenesis", "BeginBlockers", "EndBlockers".
 func SpecifyModuleEntry(fields ...string) AddModuleAppConfigOption {
 	return func(opts *addModuleAppConfigOptions) {
 		opts.runtimeFields = fields