errname and fix changes

coder · sreya · Mar 26, 2025 · Mar 21, 2025 · Mar 21, 2025 · Mar 21, 2025
commit 0b3571a580f8a25acdeae6d3cc4c197f950d63b7
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -231,6 +231,8 @@ issues:
 
 run:
   timeout: 10m
+  skip-files:
+    - scripts/rules.go
 
 # Over time, add more and more linters from
 # https://golangci-lint.run/usage/linters/ as the code improves.

diff --git a/cli/cliui/cliui.go b/cli/cliui/cliui.go
@@ -12,7 +12,7 @@ import (
 	"github.com/coder/pretty"
 )
 
-var Canceled = xerrors.New("canceled")
+var ErrCanceled = xerrors.New("canceled")
 
 // DefaultStyles compose visual elements of the UI.
 var DefaultStyles Styles

diff --git a/cli/cliui/prompt.go b/cli/cliui/prompt.go
@@ -124,7 +124,7 @@ func Prompt(inv *serpent.Invocation, opts PromptOptions) (string, error) {
 		return "", err
 	case line := <-lineCh:
 		if opts.IsConfirm && line != "yes" && line != "y" {
-			return line, xerrors.Errorf("got %q: %w", line, Canceled)
+			return line, xerrors.Errorf("got %q: %w", line, ErrCanceled)
 		}
 		if opts.Validate != nil {
 			err := opts.Validate(line)
@@ -139,7 +139,7 @@ func Prompt(inv *serpent.Invocation, opts PromptOptions) (string, error) {
 	case <-interrupt:
 		// Print a newline so that any further output starts properly on a new line.
 		_, _ = fmt.Fprintln(inv.Stdout)
-		return "", Canceled
+		return "", ErrCanceled
 	}
 }
 

diff --git a/cli/cliui/provisionerjob.go b/cli/cliui/provisionerjob.go
@@ -204,7 +204,7 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption
 				switch job.Status {
 				case codersdk.ProvisionerJobCanceled:
 					jobMutex.Unlock()
-					return Canceled
+					return ErrCanceled
 				case codersdk.ProvisionerJobSucceeded:
 					jobMutex.Unlock()
 					return nil

diff --git a/cli/cliui/provisionerjob_test.go b/cli/cliui/provisionerjob_test.go
@@ -250,7 +250,7 @@ func newProvisionerJob(t *testing.T) provisionerJobTest {
 		defer close(done)
 		err := inv.WithContext(context.Background()).Run()
 		if err != nil {
-			assert.ErrorIs(t, err, cliui.Canceled)
+			assert.ErrorIs(t, err, cliui.ErrCanceled)
 		}
 	}()
 	t.Cleanup(func() {

diff --git a/cli/cliui/select.go b/cli/cliui/select.go
@@ -147,7 +147,7 @@ func Select(inv *serpent.Invocation, opts SelectOptions) (string, error) {
 	}
 
 	if model.canceled {
-		return "", Canceled
+		return "", ErrCanceled
 	}
 
 	return model.selected, nil
@@ -360,7 +360,7 @@ func MultiSelect(inv *serpent.Invocation, opts MultiSelectOptions) ([]string, er
 	}
 
 	if model.canceled {
-		return nil, Canceled
+		return nil, ErrCanceled
 	}
 
 	return model.selectedOptions(), nil

diff --git a/cli/configssh.go b/cli/configssh.go
@@ -268,7 +268,7 @@ func (r *RootCmd) configSSH() *serpent.Command {
 					IsConfirm: true,
 				})
 				if err != nil {
-					if line == "" && xerrors.Is(err, cliui.Canceled) {
+					if line == "" && xerrors.Is(err, cliui.ErrCanceled) {
 						return nil
 					}
 					// Selecting "no" will use the last config.

diff --git a/cli/externalauth.go b/cli/externalauth.go
@@ -91,7 +91,7 @@ fi
 				if err != nil {
 					return err
 				}
-				return cliui.Canceled
+				return cliui.ErrCanceled
 			}
 			if extra != "" {
 				if extAuth.TokenExtra == nil {

diff --git a/cli/externalauth_test.go b/cli/externalauth_test.go
@@ -29,7 +29,7 @@ func TestExternalAuth(t *testing.T) {
 		inv.Stdout = pty.Output()
 		waiter := clitest.StartWithWaiter(t, inv)
 		pty.ExpectMatch("https://github.com")
-		waiter.RequireIs(cliui.Canceled)
+		waiter.RequireIs(cliui.ErrCanceled)
 	})
 	t.Run("SuccessWithToken", func(t *testing.T) {
 		t.Parallel()

diff --git a/cli/gitaskpass.go b/cli/gitaskpass.go
@@ -53,7 +53,7 @@ func (r *RootCmd) gitAskpass() *serpent.Command {
 					cliui.Warn(inv.Stderr, "Coder was unable to handle this git request. The default git behavior will be used instead.",
 						lines...,
 					)
-					return cliui.Canceled
+					return cliui.ErrCanceled
 				}
 				return xerrors.Errorf("get git token: %w", err)
 			}

diff --git a/cli/gitaskpass_test.go b/cli/gitaskpass_test.go
@@ -59,7 +59,7 @@ func TestGitAskpass(t *testing.T) {
 		pty := ptytest.New(t)
 		inv.Stderr = pty.Output()
 		err := inv.Run()
-		require.ErrorIs(t, err, cliui.Canceled)
+		require.ErrorIs(t, err, cliui.ErrCanceled)
 		pty.ExpectMatch("Nope!")
 	})
 

diff --git a/cli/login.go b/cli/login.go
@@ -48,7 +48,7 @@ func promptFirstUsername(inv *serpent.Invocation) (string, error) {
 		Text:    "What " + pretty.Sprint(cliui.DefaultStyles.Field, "username") + " would you like?",
 		Default: currentUser.Username,
 	})
-	if errors.Is(err, cliui.Canceled) {
+	if errors.Is(err, cliui.ErrCanceled) {
 		return "", nil
 	}
 	if err != nil {
@@ -64,7 +64,7 @@ func promptFirstName(inv *serpent.Invocation) (string, error) {
 		Default: "",
 	})
 	if err != nil {
-		if errors.Is(err, cliui.Canceled) {
+		if errors.Is(err, cliui.ErrCanceled) {
 			return "", nil
 		}
 		return "", err
@@ -508,7 +508,7 @@ func promptTrialInfo(inv *serpent.Invocation, fieldName string) (string, error)
 		},
 	})
 	if err != nil {
-		if errors.Is(err, cliui.Canceled) {
+		if errors.Is(err, cliui.ErrCanceled) {
 			return "", nil
 		}
 		return "", err

diff --git a/cli/open.go b/cli/open.go
@@ -89,7 +89,7 @@ func (r *RootCmd) openVSCode() *serpent.Command {
 				})
 				if err != nil {
 					if xerrors.Is(err, context.Canceled) {
-						return cliui.Canceled
+						return cliui.ErrCanceled
 					}
 					return xerrors.Errorf("agent: %w", err)
 				}

diff --git a/cli/root.go b/cli/root.go
@@ -171,7 +171,7 @@ func (r *RootCmd) RunWithSubcommands(subcommands []*serpent.Command) {
 			code = exitErr.code
 			err = exitErr.err
 		}
-		if errors.Is(err, cliui.Canceled) {
+		if errors.Is(err, cliui.ErrCanceled) {
 			//nolint:revive
 			os.Exit(code)
 		}

diff --git a/cli/ssh.go b/cli/ssh.go
@@ -264,7 +264,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 			})
 			if err != nil {
 				if xerrors.Is(err, context.Canceled) {
-					return cliui.Canceled
+					return cliui.ErrCanceled
 				}
 				return err
 			}

diff --git a/cli/ssh_test.go b/cli/ssh_test.go
@@ -341,7 +341,7 @@ func TestSSH(t *testing.T) {
 
 		cmdDone := tGo(t, func() {
 			err := inv.WithContext(ctx).Run()
-			assert.ErrorIs(t, err, cliui.Canceled)
+			assert.ErrorIs(t, err, cliui.ErrCanceled)
 		})
 		pty.ExpectMatch(wantURL)
 		cancel()

diff --git a/cli/vscodessh.go b/cli/vscodessh.go
@@ -142,7 +142,7 @@ func (r *RootCmd) vscodeSSH() *serpent.Command {
 			})
 			if err != nil {
 				if xerrors.Is(err, context.Canceled) {
-					return cliui.Canceled
+					return cliui.ErrCanceled
 				}
 			}
 

diff --git a/cmd/cliui/main.go b/cmd/cliui/main.go
@@ -89,7 +89,7 @@ func main() {
 					return nil
 				},
 			})
-			if errors.Is(err, cliui.Canceled) {
+			if errors.Is(err, cliui.ErrCanceled) {
 				return nil
 			}
 			if err != nil {
@@ -100,7 +100,7 @@ func main() {
 				Default:   cliui.ConfirmYes,
 				IsConfirm: true,
 			})
-			if errors.Is(err, cliui.Canceled) {
+			if errors.Is(err, cliui.ErrCanceled) {
 				return nil
 			}
 			if err != nil {

diff --git a/coderd/autobuild/lifecycle_executor_test.go b/coderd/autobuild/lifecycle_executor_test.go
@@ -1219,10 +1219,9 @@ func mustProvisionWorkspaceWithParameters(t *testing.T, client *codersdk.Client,
 	return coderdtest.MustWorkspace(t, client, ws.ID)
 }
 
-func mustSchedule(t *testing.T, _ string) *cron.Schedule {
+func mustSchedule(t *testing.T, s string) *cron.Schedule {
 	t.Helper()
-	// Always use the same schedule string for consistency
-	sched, err := cron.Weekly("CRON_TZ=UTC 0 * * * *")
+	sched, err := cron.Weekly(s)
 	require.NoError(t, err)
 	return sched
 }

diff --git a/coderd/coderdtest/authorize_test.go b/coderd/coderdtest/authorize_test.go
@@ -116,13 +116,11 @@ func fuzzAuthzPrep(t *testing.T, prep rbac.PreparedAuthorized, n int, action pol
 	return pairs
 }
 
-func fuzzAuthz(t *testing.T, sub rbac.Subject, rec rbac.Authorizer, _ int) []coderdtest.ActionObjectPair {
+func fuzzAuthz(t *testing.T, sub rbac.Subject, rec rbac.Authorizer, n int) []coderdtest.ActionObjectPair {
 	t.Helper()
-	// Always use 10 pairs for consistency
-	const numPairs = 10
-	pairs := make([]coderdtest.ActionObjectPair, 0, numPairs)
+	pairs := make([]coderdtest.ActionObjectPair, 0, n)
 
-	for i := 0; i < numPairs; i++ {
+	for i := 0; i < n; i++ {
 		p := coderdtest.ActionObjectPair{Action: coderdtest.RandomRBACAction(), Object: coderdtest.RandomRBACObject()}
 		_ = rec.Authorize(context.Background(), sub, p.Action, p.Object)
 		pairs = append(pairs, p)

diff --git a/coderd/cryptokeys/cache_test.go b/coderd/cryptokeys/cache_test.go
@@ -504,12 +504,10 @@ func decodedSecret(t *testing.T, key codersdk.CryptoKey) []byte {
 	return secret
 }
 
-func generateKey(t *testing.T, _ int) string {
+func generateKey(t *testing.T, size int) string {
 	t.Helper()
 
-	// Always use 64 bytes for consistency
-	const keySize = 64
-	key := make([]byte, keySize)
+	key := make([]byte, size)
 	_, err := rand.Read(key)
 	require.NoError(t, err)
 

diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -33,8 +33,8 @@ var _ database.Store = (*querier)(nil)
 
 const wrapname = "dbauthz.querier"
 
-// NoActorError is returned if no actor is present in the context.
-var NoActorError = xerrors.Errorf("no authorization actor in context")
+// ErrNoActor is returned if no actor is present in the context.
+var ErrNoActor = xerrors.Errorf("no authorization actor in context")
 
 // NotAuthorizedError is a sentinel error that unwraps to sql.ErrNoRows.
 // This allows the internal error to be read by the caller if needed. Otherwise
@@ -69,7 +69,7 @@ func IsNotAuthorizedError(err error) bool {
 	if err == nil {
 		return false
 	}
-	if xerrors.Is(err, NoActorError) {
+	if xerrors.Is(err, ErrNoActor) {
 		return true
 	}
 
@@ -140,7 +140,7 @@ func (q *querier) Wrappers() []string {
 func (q *querier) authorizeContext(ctx context.Context, action policy.Action, object rbac.Objecter) error {
 	act, ok := ActorFromContext(ctx)
 	if !ok {
-		return NoActorError
+		return ErrNoActor
 	}
 
 	err := q.auth.Authorize(ctx, act, action, object.RBACObject())
@@ -466,7 +466,7 @@ func insertWithAction[
 		// Fetch the rbac subject
 		act, ok := ActorFromContext(ctx)
 		if !ok {
-			return empty, NoActorError
+			return empty, ErrNoActor
 		}
 
 		// Authorize the action
@@ -544,7 +544,7 @@ func fetchWithAction[
 		// Fetch the rbac subject
 		act, ok := ActorFromContext(ctx)
 		if !ok {
-			return empty, NoActorError
+			return empty, ErrNoActor
 		}
 
 		// Fetch the database object
@@ -620,7 +620,7 @@ func fetchAndQuery[
 		// Fetch the rbac subject
 		act, ok := ActorFromContext(ctx)
 		if !ok {
-			return empty, NoActorError
+			return empty, ErrNoActor
 		}
 
 		// Fetch the database object
@@ -654,7 +654,7 @@ func fetchWithPostFilter[
 		// Fetch the rbac subject
 		act, ok := ActorFromContext(ctx)
 		if !ok {
-			return empty, NoActorError
+			return empty, ErrNoActor
 		}
 
 		// Fetch the database object
@@ -673,7 +673,7 @@ func fetchWithPostFilter[
 func prepareSQLFilter(ctx context.Context, authorizer rbac.Authorizer, action policy.Action, resourceType string) (rbac.PreparedAuthorized, error) {
 	act, ok := ActorFromContext(ctx)
 	if !ok {
-		return nil, NoActorError
+		return nil, ErrNoActor
 	}
 
 	return authorizer.Prepare(ctx, act, action, resourceType)
@@ -752,7 +752,7 @@ func (*querier) convertToDeploymentRoles(names []string) []rbac.RoleIdentifier {
 func (q *querier) canAssignRoles(ctx context.Context, orgID uuid.UUID, added, removed []rbac.RoleIdentifier) error {
 	actor, ok := ActorFromContext(ctx)
 	if !ok {
-		return NoActorError
+		return ErrNoActor
 	}
 
 	roleAssign := rbac.ResourceAssignRole
@@ -961,7 +961,7 @@ func (q *querier) customRoleEscalationCheck(ctx context.Context, actor rbac.Subj
 func (q *querier) customRoleCheck(ctx context.Context, role database.CustomRole) error {
 	act, ok := ActorFromContext(ctx)
 	if !ok {
-		return NoActorError
+		return ErrNoActor
 	}
 
 	// Org permissions require an org role
@@ -3896,7 +3896,7 @@ func (q *querier) UpdateProvisionerJobWithCancelByID(ctx context.Context, arg da
 			// Only owners can cancel workspace builds
 			actor, ok := ActorFromContext(ctx)
 			if !ok {
-				return NoActorError
+				return ErrNoActor
 			}
 			if !slice.Contains(actor.Roles.Names(), rbac.RoleOwner()) {
 				return xerrors.Errorf("only owners can cancel workspace builds")

diff --git a/coderd/database/dbauthz/setup_test.go b/coderd/database/dbauthz/setup_test.go
@@ -252,7 +252,7 @@ func (s *MethodTestSuite) NoActorErrorTest(callMethod func(ctx context.Context)
 	s.Run("AsRemoveActor", func() {
 		// Call without any actor
 		_, err := callMethod(context.Background())
-		s.ErrorIs(err, dbauthz.NoActorError, "method should return NoActorError error when no actor is provided")
+		s.ErrorIs(err, dbauthz.ErrNoActor, "method should return NoActorError error when no actor is provided")
 	})
 }