Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(cli): add telemetry cli commands #5322

Merged
merged 23 commits into from
Dec 19, 2023
Merged

feat(cli): add telemetry cli commands #5322

merged 23 commits into from
Dec 19, 2023

Conversation

bjoerge
Copy link
Member

@bjoerge bjoerge commented Dec 4, 2023 •
edited
Loading

Description

Adds three new CLI commands for managing telemetry consent, and also adds caching of telemetry consent status.

  • sanity telemetry status – view consent status
  • sanity telemetry disable – disable telemetry by withdrawing consent
  • sanity telemetry enable – enable telemetry by granting consent

In addition:

  • Adds a short lived cache of consent status (to avoid excessive api calls in case of serial cli usages)
  • Adds information about telemetry that will appear the first time the cli is run after upgrading (or on new machines)

What to review

  • Does the changes look ok?

Notes for release

TBD

@vercel Vercel
Copy link

vercel bot commented Dec 4, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
performance-studio ✅ Ready (Inspect) Visit Preview Dec 19, 2023 10:16am
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2023 10:16am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Dec 19, 2023 10:16am

@bjoerge bjoerge requested a review from juice49 December 4, 2023 20:44
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 4, 2023 •
edited
Loading

No changes to documentation

@juice49 juice49 marked this pull request as ready for review December 4, 2023 20:48
@juice49 juice49 requested a review from rexxars as a code owner December 4, 2023 20:48
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 4, 2023 •
edited
Loading

Component Testing Report Updated Dec 19, 2023 10:19 AM (UTC)

File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 15s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 2s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 8s 3 0 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 6s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 16s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 8s 9 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 39s 18 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 6s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 3s 3 0 0

@bjoerge bjoerge changed the title Feat/telemetry cli commands feat(cli): add telemetry cli commands Dec 4, 2023
@bjoerge bjoerge marked this pull request as draft December 4, 2023 20:58
@rexxars rexxars removed their request for review December 4, 2023 22:22
@bjoerge bjoerge force-pushed the feat/telemetry-cli-commands branch from b5be2f6 to b35a8b0 Compare December 7, 2023 11:02
@bjoerge bjoerge force-pushed the feat/telemetry-cli-commands branch from f097e88 to 0e4508f Compare December 11, 2023 12:27
@bjoerge bjoerge force-pushed the feat/telemetry-cli-commands branch from 0e4508f to c52da31 Compare December 11, 2023 12:32
This was referenced Dec 11, 2023
Merged
Merged
@bjoerge Graphite App
Copy link
Member Author

bjoerge commented Dec 11, 2023 •
edited
Loading

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@bjoerge bjoerge force-pushed the feat/telemetry-cli-commands branch from c52da31 to 9b95329 Compare December 11, 2023 12:47
juice49 and others added 23 commits December 19, 2023 11:15
@juice49 @bjoerge
feat(cli): add CLI commands to disable and enable telemetry
cf7a351
@juice49 @bjoerge
feat(cli): abstract telemetry consent action and add HTTP API mocks
88448ac
@juice49 @bjoerge
refactor(cli): adopt CliCommandAction type
ab34cfc
@juice49 @bjoerge
refactor(cli): add debug logs to telemetry consent CLI
5dee27a
@juice49 @bjoerge
refactor(cli): allow telemetry resolveConsent function to be reused
ce4e2f8
@juice49 @bjoerge
feat(cli): add telemetry status command
d647a74
@juice49 @bjoerge
refactor(cli): improve unauthenticated message
4f1582e 
Co-authored-by: Bjørge Næss <[email protected]>
@juice49 @bjoerge
refactor(cli): add granular reasons to telemetry statuses
cbcce5d
@juice49 @bjoerge
feat(cli): add createExpiringConfig utility for managing expiring c…
a532ee5 
…onfigs
@juice49 @bjoerge
refactor(cli): remove unnecessary type assertions
fa7021d
@juice49 @bjoerge
feat(cli): cache telemetry consent status
c11a1d9
@juice49 @bjoerge
fix: clear cached value after setting telemetry consent
6a6e629
@juice49 @bjoerge
feat(cli): update telemetry consent copy
2df18b7
@juice49 @bjoerge
test(cli): add tests for telemetry status and enable commands
19a68d0
@juice49 @bjoerge
test(cli): add tests for denying telemetry consent
98a9b06
@juice49 @bjoerge
feat(cli): improve message shown when DO_NOT_TRACK is used
3a81994
@juice49 @bjoerge
fix(cli): remove erroneous line break
9688a05
@juice49 @bjoerge
feat(cli): add telemetry disclosure message
4ca1cb0
@juice49 @bjoerge
feat(cli): improve telemetry disclosure config key
2b283eb
@juice49 @bjoerge
test(cli): use live API for telemetry consent testing
4dafa36 
For now, I have removed some tests that cannot easily be achieved.

For example: there is no way to unset consent status via the API,
and unfortunately, there isn't any easy way to mock HTTP requests
(e.g. using Nock) for CLI tests (because they rely on spawning
another process). This also limits our ability to simulate failed
requests.
@juice49 @bjoerge
test(cli): remove incorrectly concurrent tests
6d35dff
@juice49 @bjoerge
test(cli): override CI environment variable when testing functionalit…
6940773 
…y that depends on it
@bjoerge
fixup! refactor(cli): adopt CliCommandAction type
e6c53e7
@bjoerge bjoerge force-pushed the feat/telemetry-cli-commands branch from 5179e8d to e6c53e7 Compare December 19, 2023 10:15
@bjoerge bjoerge added this pull request to the merge queue Dec 19, 2023
Merged via the queue into next with commit 02f4cf2 Dec 19, 2023
68 of 69 checks passed
@bjoerge bjoerge deleted the feat/telemetry-cli-commands branch December 19, 2023 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@svirs svirs svirs left review comments

@juice49 juice49 Awaiting requested review from juice49

@rexxars rexxars Awaiting requested review from rexxars

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bjoerge @juice49 @svirs