Add telemetry enable/disable command

.changeset/angry-boxes-kiss.md

@@ -0,0 +1,6 @@
+---
+'@vercel-internals/types': patch
+'vercel': patch
+---
+
+Add a command for enabling and disabling telemetry. Telemetry collection is not currently enabled and when it is, will be a major version bump for the CLI.

internals/types/index.d.ts

@@ -37,9 +37,12 @@ export interface GlobalConfig {
   '// Note'?: string;
   '// Docs'?: string;
   currentTeam?: string;
-  collectMetrics?: boolean;
   api?: string;
 
+  telemetry?: {
+    enabled?: boolean;
+  };
+
   // TODO: legacy - remove
   updateChannel?: string;
   desktop?: {

packages/cli/src/commands/index.ts

@@ -40,5 +40,6 @@ export default new Map([
   ['targets', 'target'],
   ['team', 'teams'],
   ['teams', 'teams'],
+  ['telemetry', 'telemetry'],
   ['whoami', 'whoami'],
 ]);

packages/cli/src/commands/telemetry/command.ts

@@ -0,0 +1,35 @@
+export const telemetryCommand = {
+  name: 'telemetry',
+  description: 'Allows you to enable or disable telemetry collection.',
+  arguments: [
+    {
+      name: 'command',
+      required: false,
+    },
+  ],
+  subcommands: [
+    {
+      name: 'status',
+      description: 'Shows whether telemetry collection is enabled or disabled',
+      arguments: [],
+      options: [],
+      examples: [],
+    },
+    {
+      name: 'enable',
+      description: 'Enables telemetry collection',
+      arguments: [],
+      options: [],
+      examples: [],
+    },
+    {
+      name: 'disable',
+      description: 'Disables telemetry collection',
+      arguments: [],
+      options: [],
+      examples: [],
+    },
+  ],
+  options: [],
+  examples: [],
+} as const;

packages/cli/src/commands/telemetry/disable.ts

@@ -0,0 +1,17 @@
+import Client from '../../util/client';
+import { writeToConfigFile } from '../../util/config/files';
+import status from './status';
+
+export default async function disable(client: Client) {
+  client.config = {
+    ...client.config,
+    telemetry: {
+      ...client.config.telemetry,
+      enabled: false,
+    },
+  };
+
+  writeToConfigFile(client.output, client.config);
+  await status(client);
+  return 0;
+}

packages/cli/src/commands/telemetry/enable.ts

@@ -0,0 +1,17 @@
+import Client from '../../util/client';
+import { writeToConfigFile } from '../../util/config/files';
+import status from './status';
+
+export default async function enable(client: Client) {
+  client.config = {
+    ...client.config,
+    telemetry: {
+      ...client.config.telemetry,
+      enabled: true,
+    },
+  };
+
+  writeToConfigFile(client.output, client.config);
+  await status(client);
+  return 0;
+}

packages/cli/src/commands/telemetry/index.ts

@@ -0,0 +1,63 @@
+import { handleError } from '../../util/error';
+import Client from '../../util/client';
+import { parseArguments } from '../../util/get-args';
+import getSubcommand from '../../util/get-subcommand';
+import { help } from '../help';
+import status from './status';
+import enable from './enable';
+import disable from './disable';
+import { telemetryCommand } from './command';
+import { getFlagsSpecification } from '../../util/get-flags-specification';
+import chalk from 'chalk';
+
+const COMMAND_CONFIG = {
+  status: ['status'],
+  enable: ['enable'],
+  disable: ['disable'],
+};
+
+export default async function telemetry(client: Client) {
+  let parsedArguments;
+
+  const flagsSpecification = getFlagsSpecification(telemetryCommand.options);
+
+  try {
+    parsedArguments = parseArguments(client.argv.slice(2), flagsSpecification);
+  } catch (err) {
+    handleError(err);
+    return 1;
+  }
+
+  if (parsedArguments.flags['--help']) {
+    client.output.print(
+      help(telemetryCommand, { columns: client.stderr.columns })
+    );
+  }
+
+  const { subcommand } = getSubcommand(
+    parsedArguments.args.slice(1),
+    COMMAND_CONFIG
+  );
+
+  switch (subcommand) {
+    case 'status':
+      return status(client);
+    case 'enable':
+      return enable(client);
+    case 'disable':
+      return disable(client);
+    default: {
+      const errorMessage =
+        parsedArguments.args.length !== 2
+          ? `Invalid number of arguments`
+          : `Invalid subcommand`;
+      client.output.print(
+        `${chalk.red('Error')}: ${errorMessage}. See help instructions for usage:\n`
+      );
+      client.output.print(
+        help(telemetryCommand, { columns: client.stderr.columns })
+      );
+      return 2;
+    }
+  }
+}

packages/cli/src/commands/telemetry/status.ts

@@ -0,0 +1,24 @@
+import chalk from 'chalk';
+import Client from '../../util/client';
+
+export default async function status(client: Client) {
+  const status: 'disabled' | 'enabled' =
+    client.config.telemetry?.enabled === false ? 'disabled' : 'enabled';
+
+  const message =
+    status === 'disabled' ? chalk.red('Disabled') : chalk.green('Enabled');
+  await client.output.print(
+    `\n${chalk.bold('Telemetry status')}: ${message}\n\n`
+  );
+
+  // TODO: enable this message when we have a proper URL
+  // const learnMoreMessage = `\n\nLearn more: ${chalk.cyan(`https://vercel.com/some-link`)}\n`;
+  const learnMoreMessage = ``;
+  const optedInMessage = `You have opted in to Vercel CLI telemetry${learnMoreMessage}`;
+  const optedOutMessage = `You have opted out of Vercel CLI telemetry\nNo data will be collected from your machine${learnMoreMessage}`;
+  const optedInorOutMessage =
+    status === 'disabled' ? optedOutMessage : optedInMessage;
+  await client.output.print(optedInorOutMessage);
+
+  return 0;
+}

packages/cli/src/index.ts

@@ -113,20 +113,6 @@ const main = async () => {
     noColor: isNoColor,
   });
 
-  const telemetryEventStore = new TelemetryEventStore({
-    isDebug: isDebugging,
-    output,
-  });
-
-  const telemetry = new TelemetryBaseClient({
-    opts: {
-      store: telemetryEventStore,
-      output,
-    },
-  });
-
-  telemetry.trackCIVendorName();
-
   debug = output.debug;
 
   const localConfigPath = parsedArgs.flags['--local-config'];
@@ -258,6 +244,21 @@ const main = async () => {
     }
   }
 
+  const telemetryEventStore = new TelemetryEventStore({
+    isDebug: isDebugging,
+    output,
+    config: config.telemetry,
+  });
+
+  const telemetry = new TelemetryBaseClient({
+    opts: {
+      store: telemetryEventStore,
+      output,
+    },
+  });
+
+  telemetry.trackCIVendorName();
+
   if (typeof parsedArgs.flags['--api'] === 'string') {
     apiUrl = parsedArgs.flags['--api'];
   } else if (config && config.api) {
@@ -630,6 +631,9 @@ const main = async () => {
         case 'teams':
           func = require('./commands/teams').default;
           break;
+        case 'telemetry':
+          func = require('./commands/telemetry').default;
+          break;
         case 'whoami':
           func = require('./commands/whoami').default;
           break;

packages/cli/src/util/config/get-default.ts

@@ -5,7 +5,6 @@ export const defaultGlobalConfig: GlobalConfig = {
     'This is your Vercel config file. For more information see the global configuration documentation.',
   '// Docs':
     'https://vercel.com/docs/projects/project-configuration/global-configuration#config.json',
-  collectMetrics: true,
 };
 
 export const defaultAuthConfig: AuthConfig = {

packages/cli/src/util/telemetry/index.ts

@@ -1,5 +1,6 @@
 import { randomUUID } from 'node:crypto';
 import type { Output } from '../output';
+import { GlobalConfig } from '@vercel-internals/types';
 
 const LogLabel = `['telemetry']:`;
 
@@ -113,12 +114,18 @@ export class TelemetryEventStore {
   private output: Output;
   private isDebug: boolean;
   private sessionId: string;
+  private config: GlobalConfig['telemetry'];
 
-  constructor(opts: { output: Output; isDebug?: boolean }) {
+  constructor(opts: {
+    output: Output;
+    isDebug?: boolean;
+    config: GlobalConfig['telemetry'];
+  }) {
     this.isDebug = opts.isDebug || false;
     this.output = opts.output;
     this.sessionId = randomUUID();
     this.events = [];
+    this.config = opts.config;
   }
 
   add(event: Event) {
@@ -134,12 +141,19 @@ export class TelemetryEventStore {
     this.events = [];
   }
 
+  enabled() {
+    return this.config?.enabled === false ? false : true;
+  }
+
   save() {
     if (this.isDebug) {
       this.output.debug(`${LogLabel} Flushing Events`);
       this.events.forEach(event => {
         this.output.debug(JSON.stringify(event));
       });
     }
+    if (this.enabled()) {
+      // send events to the server
+    }
   }
 }