[cli] Add telemetry for `vc env pull` #12368

onsclom · 2024-10-24T20:34:31Z

1 argument: filename
2 options: environment, git-branch
1 flag: yes

vc build sometimes calls vc env pull, so vc build may trigger vc env pull telemetry events.

changeset-bot · 2024-10-24T20:34:35Z

🦋 Changeset detected

Latest commit: a2f2155

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
vercel	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

EndangeredMassa · 2024-10-24T22:07:31Z

packages/cli/src/util/telemetry/commands/env/pull.ts

+    if (environment) {
+      this.trackCliOption({
+        option: 'environment',
+        value: this.redactedValue,


suggestion (soft-blocking): track system environments

If this value is a system environment (production, preview), we should track that value. If it's any other value, we should use this.redactedValue.‏

EndangeredMassa · 2024-10-24T22:08:25Z

packages/cli/test/unit/commands/build/index.test.ts

@@ -376,6 +376,9 @@ describe('build', () => {
    }
    expect(client.telemetryEventStore).toHaveTelemetryEvents([
      { key: 'flag:yes', value: 'TRUE' },
+      // from `vc env pull`
+      { key: 'argument:filename', value: '[REDACTED]' },
+      { key: 'option:environment', value: '[REDACTED]' },


suggestion (non-blocking): We can remove these later after we resolve this command-to-command logic.

See: https://github.com/vercel/vercel/pull/12372/files‏

EndangeredMassa · 2024-10-24T22:09:45Z

packages/cli/test/unit/commands/env/pull.test.ts

-  describe.todo('[filename]');
-  describe.todo('--yes');
-  describe.todo('--git-branch');
+  describe('[filename]', () => {


suggestion (non-blocking): use existing tests

We can add these metrics assertions to existing tests. I did this in my attempt here: https://github.com/vercel/vercel/pull/12369/files#diff-f323de450c6e0956c9afe44145acae8e46e44b58d7017ebef9abdef006cffd6dR39

I'm not against explicit tests for them, though.‏

One thing the single übertest doesn't protect us from us is accidentally passing the value to telemetry even when it wasn't passed to the CLI.

trek · 2024-10-25T18:59:43Z

packages/cli/test/unit/commands/env/pull.test.ts

-  describe.todo('[filename]');
-  describe.todo('--yes');
-  describe.todo('--git-branch');
+  describe('[filename]', () => {


One thing the single übertest doesn't protect us from us is accidentally passing the value to telemetry even when it wasn't passed to the CLI.

…ng-for-vercel-env-pull

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## vercel@37.13.0 ### Minor Changes - Add telemetry for `vercel logs` ([#12386](#12386)) - Add telemetry for `vercel env pull` ([#12368](#12368)) - add telemetry for `vercel env rm` ([#12384](#12384)) - [cli] add subcommand tracking for `dns` group ([#12375](#12375)) - [cli] add telemetry for `vercel certs ls` ([#12383](#12383)) - [cli] add telemetry tracking to vercel inspect ([#12367](#12367)) - Add telemetry for `vercel certs remove` ([#12394](#12394)) - Add telemetry for `vercel integration list` ([#12404](#12404)) - add telemetry tracking to `env add` ([#12357](#12357)) - track standard environments in `vc env add` ([#12385](#12385)) - [cli] add telemetry for `vercel target ls` ([#12352](#12352)) - [cli] add telemetry tracking for `vercel domains ls` ([#12400](#12400)) - [cli] add `VERCEL_ENV` and `VERCEL` to process to simulate runtime ([#12358](#12358)) - Add telemetry for `vercel domains move` ([#12411](#12411)) - [cli] add telemetry tracking to `git connect` and `git disconnect` ([#12373](#12373)) - Add telemetry to `vercel domains buy` ([#12413](#12413)) - [cli] add telemetry tracking to `project list` ([#12339](#12339)) - Add telemetry for `vercel domains add` ([#12409](#12409)) - Add telemetry to `vercel domains rm` ([#12410](#12410)) - Add telemetry for `vercel list` ([#12364](#12364)) - [cli] add subcommand tracking for `integration` group ([#12377](#12377)) - Add telemetry for `vercel certs add` ([#12391](#12391)) - [cli] add subcommand tracking for `domains` group ([#12374](#12374)) - [cli] add telemetry tracking to `project add` ([#12340](#12340)) - Add telemetry for `vercel integration open` ([#12408](#12408)) - Add telemetry for `vercel init` ([#12371](#12371)) - [cli] add subcommand tracking for `integration` group ([#12377](#12377)) - [cli] add telemetry tracking for `vercel dns import` ([#12379](#12379)) - [cli] add telemetry for `vercel dns ls` ([#12380](#12380)) - Add telemetry for `vercel env ls` ([#12392](#12392)) - Add telemetry for `vercel bisect` ([#12362](#12362)) - [cli] add telemetry for `vercel dns remove` ([#12381](#12381)) - Add telemetry for `vercel integration add` ([#12406](#12406)) - [cli] add telemetry tracking for vercel dev invocations ([#12349](#12349)) - [cli] add subcommand tracking for `certs` group ([#12376](#12376)) - [cli] add telemetry for `vercel redeploy` ([#12353](#12353)) - [cli] add telemetry for `vercel domains inspect` ([#12407](#12407)) - Add telemetry for `vercel certs issue` ([#12401](#12401)) - Add telemetry for `vercel link` ([#12360](#12360)) ### Patch Changes - Remove stray file ([#12363](#12363)) - add metrics to dns add ([#12414](#12414)) - Add telemetry to the `teams` subcommands. Telemetry collection is not currently enabled and when it is, will be a major version bump for the CLI. ([#12346](#12346)) - add telemetry to `vc pull` ([#12387](#12387)) - [cli] refactor Output usage ([#12305](#12305)) - extract pull invocation from build ([#12372](#12372)) - extract vc pull logic from entrypoint ([#12378](#12378)) - Updated dependencies \[[`13bb443f2b0791c7bd402447fcb540cffd0b6eae`](13bb443)]: - @vercel/remix-builder@2.2.13 ## @vercel/remix-builder@2.2.13 ### Patch Changes - Update `@remix-run/dev` fork to v2.13.1 ([#12334](#12334)) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## vercel@37.13.0 ### Minor Changes - Add telemetry for `vercel logs` ([#12386](vercel/vercel#12386)) - Add telemetry for `vercel env pull` ([#12368](vercel/vercel#12368)) - add telemetry for `vercel env rm` ([#12384](vercel/vercel#12384)) - [cli] add subcommand tracking for `dns` group ([#12375](vercel/vercel#12375)) - [cli] add telemetry for `vercel certs ls` ([#12383](vercel/vercel#12383)) - [cli] add telemetry tracking to vercel inspect ([#12367](vercel/vercel#12367)) - Add telemetry for `vercel certs remove` ([#12394](vercel/vercel#12394)) - Add telemetry for `vercel integration list` ([#12404](vercel/vercel#12404)) - add telemetry tracking to `env add` ([#12357](vercel/vercel#12357)) - track standard environments in `vc env add` ([#12385](vercel/vercel#12385)) - [cli] add telemetry for `vercel target ls` ([#12352](vercel/vercel#12352)) - [cli] add telemetry tracking for `vercel domains ls` ([#12400](vercel/vercel#12400)) - [cli] add `VERCEL_ENV` and `VERCEL` to process to simulate runtime ([#12358](vercel/vercel#12358)) - Add telemetry for `vercel domains move` ([#12411](vercel/vercel#12411)) - [cli] add telemetry tracking to `git connect` and `git disconnect` ([#12373](vercel/vercel#12373)) - Add telemetry to `vercel domains buy` ([#12413](vercel/vercel#12413)) - [cli] add telemetry tracking to `project list` ([#12339](vercel/vercel#12339)) - Add telemetry for `vercel domains add` ([#12409](vercel/vercel#12409)) - Add telemetry to `vercel domains rm` ([#12410](vercel/vercel#12410)) - Add telemetry for `vercel list` ([#12364](vercel/vercel#12364)) - [cli] add subcommand tracking for `integration` group ([#12377](vercel/vercel#12377)) - Add telemetry for `vercel certs add` ([#12391](vercel/vercel#12391)) - [cli] add subcommand tracking for `domains` group ([#12374](vercel/vercel#12374)) - [cli] add telemetry tracking to `project add` ([#12340](vercel/vercel#12340)) - Add telemetry for `vercel integration open` ([#12408](vercel/vercel#12408)) - Add telemetry for `vercel init` ([#12371](vercel/vercel#12371)) - [cli] add subcommand tracking for `integration` group ([#12377](vercel/vercel#12377)) - [cli] add telemetry tracking for `vercel dns import` ([#12379](vercel/vercel#12379)) - [cli] add telemetry for `vercel dns ls` ([#12380](vercel/vercel#12380)) - Add telemetry for `vercel env ls` ([#12392](vercel/vercel#12392)) - Add telemetry for `vercel bisect` ([#12362](vercel/vercel#12362)) - [cli] add telemetry for `vercel dns remove` ([#12381](vercel/vercel#12381)) - Add telemetry for `vercel integration add` ([#12406](vercel/vercel#12406)) - [cli] add telemetry tracking for vercel dev invocations ([#12349](vercel/vercel#12349)) - [cli] add subcommand tracking for `certs` group ([#12376](vercel/vercel#12376)) - [cli] add telemetry for `vercel redeploy` ([#12353](vercel/vercel#12353)) - [cli] add telemetry for `vercel domains inspect` ([#12407](vercel/vercel#12407)) - Add telemetry for `vercel certs issue` ([#12401](vercel/vercel#12401)) - Add telemetry for `vercel link` ([#12360](vercel/vercel#12360)) ### Patch Changes - Remove stray file ([#12363](vercel/vercel#12363)) - add metrics to dns add ([#12414](vercel/vercel#12414)) - Add telemetry to the `teams` subcommands. Telemetry collection is not currently enabled and when it is, will be a major version bump for the CLI. ([#12346](vercel/vercel#12346)) - add telemetry to `vc pull` ([#12387](vercel/vercel#12387)) - [cli] refactor Output usage ([#12305](vercel/vercel#12305)) - extract pull invocation from build ([#12372](vercel/vercel#12372)) - extract vc pull logic from entrypoint ([#12378](vercel/vercel#12378)) - Updated dependencies \[[`e4304c4526f6062d23b7fdb381d9bb24c7431a0d`](vercel/vercel@e4304c4)]: - @vercel/remix-builder@2.2.13 ## @vercel/remix-builder@2.2.13 ### Patch Changes - Update `@remix-run/dev` fork to v2.13.1 ([#12334](vercel/vercel#12334)) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

vercel bot deployed to Preview October 24, 2024 21:02 View deployment

vercel bot deployed to Preview October 24, 2024 21:17 View deployment

EndangeredMassa mentioned this pull request Oct 24, 2024

add telemetry to vc env pull #12369

Closed

EndangeredMassa previously approved these changes Oct 24, 2024

View reviewed changes

onsclom dismissed EndangeredMassa’s stale review via 1343465 October 25, 2024 17:05

onsclom force-pushed the austinmerrick/zero-2670-add-telemetry-tracking-for-vercel-env-pull branch from a2b63c1 to 1343465 Compare October 25, 2024 17:05

vercel bot deployed to Preview October 25, 2024 17:06 View deployment

vercel bot deployed to Preview October 25, 2024 17:08 View deployment

onsclom force-pushed the austinmerrick/zero-2670-add-telemetry-tracking-for-vercel-env-pull branch from 7219b64 to f9d4fac Compare October 25, 2024 17:16

vercel bot deployed to Preview October 25, 2024 17:17 View deployment

vercel bot deployed to Preview October 25, 2024 17:24 View deployment

onsclom force-pushed the austinmerrick/zero-2670-add-telemetry-tracking-for-vercel-env-pull branch from a2457db to 85d7297 Compare October 25, 2024 18:36

vercel bot deployed to Preview October 25, 2024 18:36 View deployment

onsclom added 6 commits October 25, 2024 11:41

Track env pull

8807de5

Add changeset

0802f02

Add vc env pull tracking info to vc build test

8a836ca

Add remaining missing vc env pull events

6ce6aa1

Use existing tests

dcda9c8

Update tests

93e76d9

onsclom force-pushed the austinmerrick/zero-2670-add-telemetry-tracking-for-vercel-env-pull branch from 85d7297 to 93e76d9 Compare October 25, 2024 18:42

vercel bot deployed to Preview October 25, 2024 18:43 View deployment

onsclom marked this pull request as ready for review October 25, 2024 18:56

onsclom requested review from TooTallNate, trek, jeffsee55 and erikareads as code owners October 25, 2024 18:56

Remove missed comment

f316ea8

vercel bot deployed to Preview October 25, 2024 18:58 View deployment

trek approved these changes Oct 25, 2024

View reviewed changes

onsclom added the pr: automerge Automatically merge the PR when checks pass label Oct 25, 2024

Merge branch 'main' into austinmerrick/zero-2670-add-telemetry-tracki…

a2f2155

…ng-for-vercel-env-pull

vercel bot deployed to Preview October 25, 2024 20:09 View deployment

kodiakhq bot merged commit eeec441 into main Oct 25, 2024
138 checks passed

kodiakhq bot deleted the austinmerrick/zero-2670-add-telemetry-tracking-for-vercel-env-pull branch October 25, 2024 20:20

vercel-release-bot mentioned this pull request Oct 25, 2024

Version Packages #12345

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[cli] Add telemetry for `vc env pull` #12368

[cli] Add telemetry for `vc env pull` #12368

Uh oh!

onsclom commented Oct 24, 2024 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 24, 2024 •

edited

Loading

Uh oh!

EndangeredMassa Oct 24, 2024

Uh oh!

EndangeredMassa Oct 24, 2024

Uh oh!

EndangeredMassa Oct 24, 2024

Uh oh!

trek Oct 25, 2024

Uh oh!

trek Oct 25, 2024

Uh oh!

Uh oh!

Uh oh!

[cli] Add telemetry for vc env pull #12368

[cli] Add telemetry for vc env pull #12368

Uh oh!

Conversation

onsclom commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

EndangeredMassa Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

trek Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

trek Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[cli] Add telemetry for `vc env pull` #12368

[cli] Add telemetry for `vc env pull` #12368

onsclom commented Oct 24, 2024 •

edited

Loading

changeset-bot bot commented Oct 24, 2024 •

edited

Loading