-
Notifications
You must be signed in to change notification settings - Fork 86
feat(telemetry): print a post-command notice on first run #2156
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Hweinstock
wants to merge
4
commits into
aws:refactor
Choose a base branch
from
Hweinstock:feat/telemetry-first-run-notice
base: refactor
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d92c666
feat(globalConfig): detect first run via persisted installationId
Hweinstock e4213e7
feat(telemetry): notify users of telemetry collection on first run
Hweinstock ab99cbf
refactor(globalConfig): persist installationId at root on first run
Hweinstock bc4bef2
refactor(telemetry): simplify first-run notice to a single function
Hweinstock File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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 |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| export { DefaultTelemetryClient } from "./client"; | ||
| export { printFirstRunNotice } from "./notice"; | ||
| export { type AttributesOf, type MetricEvent } from "./types"; |
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 |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import { test, describe, expect } from "bun:test"; | ||
| import { printFirstRunNotice } from "./notice"; | ||
|
|
||
| describe("printFirstRunNotice", () => { | ||
| test.each([ | ||
| [true, true, 1], | ||
| [true, false, 0], | ||
| [false, true, 0], | ||
| [false, false, 0], | ||
| ])( | ||
| "isFirstRun=%p telemetryEnabled=%p writes the notice %p time(s)", | ||
| (isFirstRun, telemetryEnabled, expectedWrites) => { | ||
| const written: string[] = []; | ||
|
|
||
| printFirstRunNotice(isFirstRun, telemetryEnabled, { | ||
| write: (text) => void written.push(text), | ||
| }); | ||
|
|
||
| expect(written).toHaveLength(expectedWrites); | ||
| if (expectedWrites > 0) { | ||
| expect(written[0]).toContain("collects aggregated, anonymous usage analytics"); | ||
| expect(written[0]).toContain("agentcore config telemetry.enabled false"); | ||
| } | ||
| }, | ||
| ); | ||
| }); |
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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| /** | ||
| * Writes the telemetry-collection notice to the given stream on the first run of | ||
| * the CLI, unless telemetry is already disabled. | ||
| */ | ||
| export function printFirstRunNotice( | ||
| isFirstRun: boolean, | ||
| telemetryEnabled: boolean, | ||
| out: { write(text: string): void }, | ||
| ): void { | ||
| if (!isFirstRun || !telemetryEnabled) return; | ||
|
|
||
| out.write( | ||
| [ | ||
| "", | ||
| "The AgentCore CLI collects aggregated, anonymous usage analytics to help improve the tool.", | ||
| "To opt out: agentcore config telemetry.enabled false", | ||
| "To audit: agentcore config telemetry.audit true", | ||
| "", | ||
| ].join("\n"), | ||
| ); | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be simpler to return
isFirstRunin the output here? Would that avoid having to make many of these other changes?