Add library to store cmd-exec-id in context #2439
Open
+140
−28
Conversation
This file contains 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
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
requested review from
pietern,
andrewnester and
denik
as code owners
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
commented
Mar 6, 2025
| @@ -106,7 +107,7 @@ func getCobraCmdForTest(f fixtures.HTTPFixture) (*cobra.Command, *bytes.Buffer) | |||
| func TestTokenCmdWithProfilePrintsHelpfulLoginMessageOnRefreshFailure(t *testing.T) { | |||
| cmd, output := getCobraCmdForTest(refreshFailureTokenResponse) | |||
| cmd.SetArgs([]string{"auth", "token", "--profile", "expired"}) | |||
| err := cmd.Execute() | |||
| err := root.Execute(cmd.Context(), cmd) | |||
There was a problem hiding this comment.
These unrelated tests were modified to use the root.Execute execute function, which ensures that cmd-exec-id is set in the context since, otherwise, these tests fail.
There was a problem hiding this comment.
Are there other side effects of doing so?
This was referenced Mar 6, 2025
andrewnester
approved these changes
Mar 7, 2025
pietern
reviewed
Mar 10, 2025
| @@ -106,7 +107,7 @@ func getCobraCmdForTest(f fixtures.HTTPFixture) (*cobra.Command, *bytes.Buffer) | |||
| func TestTokenCmdWithProfilePrintsHelpfulLoginMessageOnRefreshFailure(t *testing.T) { | |||
| cmd, output := getCobraCmdForTest(refreshFailureTokenResponse) | |||
| cmd.SetArgs([]string{"auth", "token", "--profile", "expired"}) | |||
| err := cmd.Execute() | |||
| err := root.Execute(cmd.Context(), cmd) | |||
There was a problem hiding this comment.
Are there other side effects of doing so?
| @@ -124,6 +125,9 @@ Stack Trace: | |||
| %s`, version, r, string(trace)) | |||
| }() | |||
|
|
|||
| // Set a cmd-exec-id value in the context | |||
There was a problem hiding this comment.
That it is used as cmd-exec-id in the UA is not important here.
I suggest also not abbreviating here.
| // execIDKey is the context key for the execution ID. | ||
| // The value of 1 is arbitrary and can be any number. | ||
| // Other keys in the same package must have different values. | ||
| execIDKey = key(1) |
There was a problem hiding this comment.
Mix of initialism and not, please use one.
| execIDKey = key(1) | ||
| ) | ||
|
|
||
| func SetExecId(ctx context.Context) context.Context { |
There was a problem hiding this comment.
Set implies (to me) that the user specifies a value. That's not the case here. Maybe GenerateExecutionID?
| require.Len(t, matches, 1) | ||
| _, err := uuid.Parse(matches[0][1]) | ||
| assert.NoError(t, err) | ||
| assert.Contains(t, ua, "cmd-exec-id/some-exec-id") |
There was a problem hiding this comment.
If the mock function is only included to make this test not use a regexp, it can be omitted IMO.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
The command execution ID is a UUID that should be initialized once, and then have a consistent read value for the duration of the command.
As we start emitting telemetry events, we also want to emit the command execution ID in the telemetry payload. This library helps consolidate all reads to the
cmd-exec-idvalue, and ensures there's only one write for the UUID.relevant comment: #2432 (comment)
Tests
Unit tests.