- Notifications
You must be signed in to change notification settings - Fork1k
chore: prevent nil derefs in non-critical paths#11411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
3 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
29 changes: 24 additions & 5 deletionscli/cliui/agent.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -200,12 +200,12 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO | ||
| switch agent.LifecycleState { | ||
| case codersdk.WorkspaceAgentLifecycleReady: | ||
| sw.Complete(stage,safeDuration(sw,agent.ReadyAt,agent.StartedAt)) | ||
| case codersdk.WorkspaceAgentLifecycleStartTimeout: | ||
| sw.Fail(stage, 0) | ||
| sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script timed out and your workspace may be incomplete.") | ||
| case codersdk.WorkspaceAgentLifecycleStartError: | ||
| sw.Fail(stage,safeDuration(sw,agent.ReadyAt,agent.StartedAt)) | ||
| // Use zero time (omitted) to separate these from the startup logs. | ||
| sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script exited with an error and your workspace may be incomplete.") | ||
| sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#startup-script-exited-with-an-error")) | ||
| @@ -221,7 +221,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO | ||
| case agent.LifecycleState.ShuttingDown(): | ||
| // We no longer know if the startup script failed or not, | ||
| // but we need to tell the user something. | ||
| sw.Complete(stage,safeDuration(sw,agent.ReadyAt,agent.StartedAt)) | ||
| return errAgentShuttingDown | ||
| } | ||
| } | ||
| @@ -238,13 +238,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO | ||
| sw.Log(time.Now(), codersdk.LogLevelWarn, "Wait for it to reconnect or restart your workspace.") | ||
| sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#agent-connection-issues")) | ||
| disconnectedAt := agent.DisconnectedAt | ||
| for agent.Status == codersdk.WorkspaceAgentDisconnected { | ||
| if agent, err = fetch(); err != nil { | ||
| return xerrors.Errorf("fetch: %w", err) | ||
| } | ||
| } | ||
| sw.Complete(stage,safeDuration(sw,agent.LastConnectedAt,disconnectedAt)) | ||
| } | ||
| } | ||
| } | ||
| @@ -257,6 +257,25 @@ func troubleshootingMessage(agent codersdk.WorkspaceAgent, url string) string { | ||
| return m | ||
| } | ||
| // safeDuration returns a-b. If a or b is nil, it returns 0. | ||
| // This is because we often dereference a time pointer, which can | ||
| // cause a panic. These dereferences are used to calculate durations, | ||
| // which are not critical, and therefor should not break things | ||
| // when it fails. | ||
| // A panic has been observed in a test. | ||
| func safeDuration(sw *stageWriter, a, b *time.Time) time.Duration { | ||
| if a == nil || b == nil { | ||
| if sw != nil { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. No need for sw to be an optional param here, IMO 🤔 (i.e. no need to check). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I just really didn't want to accidently introduce a new place to deref a nil lol | ||
| // Ideally the message includes which fields are <nil>, but you can | ||
| // use the surrounding log lines to figure that out. And passing more | ||
| // params makes this unwieldy. | ||
| sw.Log(time.Now(), codersdk.LogLevelWarn, "Warning: Failed to calculate duration from a time being <nil>.") | ||
| } | ||
| return 0 | ||
| } | ||
| return a.Sub(*b) | ||
| } | ||
| type closeFunc func() error | ||
| func (c closeFunc) Close() error { | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.