Refactor cryptokeys comments and variable typo

sreya · sreya · commit e7cfb468e38e · 2024-10-17T01:09:33.000Z
Adjust comments to accurately describe cache functionality
and fix a typo in the `New` function parameters for clarity.
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -683,9 +683,9 @@ func New(options *Options) *API {
 		AgentProvider:       api.agentProvider,
 		StatsCollector:      workspaceapps.NewStatsCollector(options.WorkspaceAppsStatsCollectorOptions),
 
-		DisablePathApps:     options.DeploymentValues.DisablePathApps.Value(),
-		SecureAuthCookie:    options.DeploymentValues.SecureAuthCookie.Value(),
-		APIKeyEncryptionKey: options.AppEncryptionKeyCache,
+		DisablePathApps:          options.DeploymentValues.DisablePathApps.Value(),
+		SecureAuthCookie:         options.DeploymentValues.SecureAuthCookie.Value(),
+		APIKeyEncryptionKeycache: options.AppEncryptionKeyCache,
 	}
 
 	apiKeyMiddleware := httpmw.ExtractAPIKeyMW(httpmw.ExtractAPIKeyConfig{
diff --git a/coderd/cryptokeys/cache.go b/coderd/cryptokeys/cache.go
@@ -155,7 +155,7 @@ func (c *cache) EncryptingKey(ctx context.Context) (string, interface{}, error)
 		return "", nil, ErrInvalidFeature
 	}
 
-	//nolint:gocritic // cache can only rotate crypto keys.
+	//nolint:gocritic // cache can only read crypto keys.
 	ctx = dbauthz.AsKeyReader(ctx)
 	return c.cryptoKey(ctx, latestSequence)
 }
@@ -170,7 +170,7 @@ func (c *cache) DecryptingKey(ctx context.Context, id string) (interface{}, erro
 		return nil, xerrors.Errorf("parse id: %w", err)
 	}
 
-	//nolint:gocritic // cache can only rotate crypto keys.
+	//nolint:gocritic // cache can only read crypto keys.
 	ctx = dbauthz.AsKeyReader(ctx)
 	_, secret, err := c.cryptoKey(ctx, int32(seq))
 	if err != nil {
@@ -184,7 +184,7 @@ func (c *cache) SigningKey(ctx context.Context) (string, interface{}, error) {
 		return "", nil, ErrInvalidFeature
 	}
 
-	//nolint:gocritic // cache can only rotate crypto keys.
+	//nolint:gocritic // cache can only read crypto keys.
 	ctx = dbauthz.AsKeyReader(ctx)
 	return c.cryptoKey(ctx, latestSequence)
 }
@@ -204,7 +204,7 @@ func (c *cache) VerifyingKey(ctx context.Context, id string) (interface{}, error
 		return nil, xerrors.Errorf("crypto key: %w", err)
 	}
 
-	//nolint:gocritic // cache can only rotate crypto keys.
+	//nolint:gocritic // cache can only read crypto keys.
 	ctx = dbauthz.AsKeyReader(ctx)
 	return secret, nil
 }

Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ func (c *cache) EncryptingKey(ctx context.Context) (string, interface{}, error)`
`155`	`155`	`return "", nil, ErrInvalidFeature`
`156`	`156`	`}`
`157`	`157`
`158`		`- //nolint:gocritic // cache can only rotate crypto keys.`
	`158`	`+ //nolint:gocritic // cache can only read crypto keys.`
`159`	`159`	`ctx = dbauthz.AsKeyReader(ctx)`
`160`	`160`	`return c.cryptoKey(ctx, latestSequence)`
`161`	`161`	`}`
`@@ -170,7 +170,7 @@ func (c *cache) DecryptingKey(ctx context.Context, id string) (interface{}, erro`
`170`	`170`	`return nil, xerrors.Errorf("parse id: %w", err)`
`171`	`171`	`}`
`172`	`172`
`173`		`- //nolint:gocritic // cache can only rotate crypto keys.`
	`173`	`+ //nolint:gocritic // cache can only read crypto keys.`
`174`	`174`	`ctx = dbauthz.AsKeyReader(ctx)`
`175`	`175`	`_, secret, err := c.cryptoKey(ctx, int32(seq))`
`176`	`176`	`if err != nil {`
`@@ -184,7 +184,7 @@ func (c *cache) SigningKey(ctx context.Context) (string, interface{}, error) {`
`184`	`184`	`return "", nil, ErrInvalidFeature`
`185`	`185`	`}`
`186`	`186`
`187`		`- //nolint:gocritic // cache can only rotate crypto keys.`
	`187`	`+ //nolint:gocritic // cache can only read crypto keys.`
`188`	`188`	`ctx = dbauthz.AsKeyReader(ctx)`
`189`	`189`	`return c.cryptoKey(ctx, latestSequence)`
`190`	`190`	`}`
`@@ -204,7 +204,7 @@ func (c *cache) VerifyingKey(ctx context.Context, id string) (interface{}, error`
`204`	`204`	`return nil, xerrors.Errorf("crypto key: %w", err)`
`205`	`205`	`}`
`206`	`206`
`207`		`- //nolint:gocritic // cache can only rotate crypto keys.`
	`207`	`+ //nolint:gocritic // cache can only read crypto keys.`
`208`	`208`	`ctx = dbauthz.AsKeyReader(ctx)`
`209`	`209`	`return secret, nil`
`210`	`210`	`}`