Merge branch 'main' into austinmerrick/fix-corepack-detection-on-monorepos

onsclom · web-flow · commit cf1d93c75cd1 · 2024-10-04T12:06:42.000-07:00
diff --git a/.changeset/rude-waves-check.md b/.changeset/rude-waves-check.md
@@ -0,0 +1,5 @@
+---
+"vercel": patch
+---
+
+[cli] set telemetry enabled to false with VERCEL_TELEMETRY_DISABLED
diff --git a/.changeset/twenty-swans-lick.md b/.changeset/twenty-swans-lick.md
@@ -0,0 +1,5 @@
+---
+"vercel": patch
+---
+
+[cli] Remove incorrect --output docs for `vercel certs`
diff --git a/packages/cli/src/commands/certs/command.ts b/packages/cli/src/commands/certs/command.ts
@@ -89,7 +89,6 @@ export const certsCommand = {
       description: 'Show next page of results',
     },
     { name: 'overwrite', shorthand: null, type: Boolean, deprecated: false },
-    { name: 'output', shorthand: null, type: String, deprecated: false },
   ],
   examples: [
     {
diff --git a/packages/cli/src/util/telemetry/index.ts b/packages/cli/src/util/telemetry/index.ts
@@ -172,7 +172,11 @@ export class TelemetryEventStore {
     this.events = [];
   }
 
-  enabled() {
+  get enabled() {
+    if (process.env.VERCEL_TELEMETRY_DISABLED) {
+      return false;
+    }
+
     return this.config?.enabled === false ? false : true;
   }
 
@@ -188,7 +192,7 @@ export class TelemetryEventStore {
       return;
     }
 
-    if (this.enabled()) {
+    if (this.enabled) {
       // send events to the server
     }
   }
diff --git a/packages/cli/test/unit/index.test.ts b/packages/cli/test/unit/index.test.ts
@@ -45,6 +45,7 @@ describe('main', () => {
         { key: 'cpu_count', value: '1' },
       ]);
     });
+
     it('tracks platform', () => {
       vi.spyOn(os, 'platform').mockImplementation(() => 'linux');
       const output = new Output(process.stderr, {
@@ -68,6 +69,7 @@ describe('main', () => {
         { key: 'platform', value: 'linux' },
       ]);
     });
+
     it('tracks arch', () => {
       vi.spyOn(os, 'arch').mockImplementation(() => 'x86');
       const output = new Output(process.stderr, {
@@ -140,6 +142,28 @@ describe('main', () => {
       });
     });
 
+    describe('tracking enabled', () => {
+      it('is false when VERCEL_TELEMETRY_DISABLED set', () => {
+        const configThatWillBeIgnoredAnyway = {
+          enabled: true,
+        };
+
+        vi.stubEnv('VERCEL_TELEMETRY_DISABLED', '1');
+        const output = new Output(process.stderr, {
+          debug: true,
+          noColor: false,
+        });
+
+        const telemetryEventStore = new TelemetryEventStore({
+          isDebug: true,
+          output,
+          config: configThatWillBeIgnoredAnyway,
+        });
+
+        expect(telemetryEventStore.enabled).toBe(false);
+      });
+    });
+
     describe('CI Vendor Name', () => {
       let telemetry: RootTelemetryClient;
       let telemetryEventStore: TelemetryEventStore;
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -19,11 +19,7 @@ The `@vercel/sdk` is a type-safe Typescript SDK that gives you full control over
     </a>
 </div>
 
-<!-- Start Summary [summary] -->
-## Summary
-
-Vercel API: Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
-<!-- End Summary [summary] -->
+<!-- No Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"vercel": patch
 +---
++
 +[cli] set telemetry enabled to false with VERCEL_TELEMETRY_DISABLED
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,6 @@ export const certsCommand = {`
`89`	`89`	`description: 'Show next page of results',`
`90`	`90`	`},`
`91`	`91`	`{ name: 'overwrite', shorthand: null, type: Boolean, deprecated: false },`
`92`		`- { name: 'output', shorthand: null, type: String, deprecated: false },`
`93`	`92`	`],`
`94`	`93`	`examples: [`
`95`	`94`	`{`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,11 @@ export class TelemetryEventStore {`
`172`	`172`	`this.events = [];`
`173`	`173`	`}`
`174`	`174`
`175`		`- enabled() {`
	`175`	`+ get enabled() {`
	`176`	`+ if (process.env.VERCEL_TELEMETRY_DISABLED) {`
	`177`	`+ return false;`
	`178`	`+ }`
	`179`	`+`
`176`	`180`	`return this.config?.enabled === false ? false : true;`
`177`	`181`	`}`
`178`	`182`
`@@ -188,7 +192,7 @@ export class TelemetryEventStore {`
`188`	`192`	`return;`
`189`	`193`	`}`
`190`	`194`
`191`		`- if (this.enabled()) {`
	`195`	`+ if (this.enabled) {`
`192`	`196`	`// send events to the server`
`193`	`197`	`}`
`194`	`198`	`}`