feat(cli): --no-version-reporting equals --no-telemetry for cli telemetry and library metadata exclusion (#718)

`--no-version-reporting` and `--no-telemetry` will disable cli telemetry
and library metadata for that specific command execution. to disable cli
telemetry permanently see options
[here](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0732-cdk-cli-telemetry.md#opt-out)

---
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license

---------

Signed-off-by: github-actions <[email protected]>
Co-authored-by: github-actions <[email protected]>

Author: kaizencc

packages/aws-cdk/lib/cli/cdk-toolkit.ts

@@ -208,8 +208,10 @@ export class CdkToolkit {
     await this.props.configuration.saveContext();
   }
 
-  public async cliTelemetryStatus() {
-    const canCollect = canCollectTelemetry(this.props.configuration.context);
+  public async cliTelemetryStatus(versionReporting: boolean = true) {
+    // recreate the version-reporting property in args rather than bring the entire args object over
+    const args = { ['version-reporting']: versionReporting };
+    const canCollect = canCollectTelemetry(args, this.props.configuration.context);
     if (canCollect) {
       await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.');
     } else {

packages/aws-cdk/lib/cli/cli-config.ts

@@ -32,7 +32,7 @@ export async function makeConfig(): Promise<CliConfig> {
       'proxy': { type: 'string', desc: 'Use the indicated proxy. Will read from HTTPS_PROXY environment variable if not specified', requiresArg: true },
       'ca-bundle-path': { type: 'string', desc: 'Path to CA certificate to use when validating HTTPS requests. Will read from AWS_CA_BUNDLE environment variable if not specified', requiresArg: true },
       'ec2creds': { type: 'boolean', alias: 'i', default: undefined, desc: 'Force trying to fetch EC2 instance credentials. Default: guess EC2 instance status' },
-      'version-reporting': { type: 'boolean', desc: 'Include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)', default: undefined },
+      'version-reporting': { type: 'boolean', desc: 'Disable CLI telemetry and do not include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)', default: undefined, alias: 'telemetry' },
       'path-metadata': { type: 'boolean', desc: 'Include "aws:cdk:path" CloudFormation metadata for each resource (enabled by default)', default: undefined },
       'asset-metadata': { type: 'boolean', desc: 'Include "aws:asset:*" CloudFormation metadata for resources that uses assets (enabled by default)', default: undefined },
       'role-arn': { type: 'string', alias: 'r', desc: 'ARN of Role to use when invoking CloudFormation', default: undefined, requiresArg: true },

packages/aws-cdk/lib/cli/cli-type-registry.json

@@ -78,7 +78,8 @@
     },
     "version-reporting": {
       "type": "boolean",
-      "desc": "Include the \"AWS::CDK::Metadata\" resource in synthesized templates (enabled by default)"
+      "desc": "Disable CLI telemetry and do not include the \"AWS::CDK::Metadata\" resource in synthesized templates (enabled by default)",
+      "alias": "telemetry"
     },
     "path-metadata": {
       "type": "boolean",

packages/aws-cdk/lib/cli/cli.ts

@@ -501,7 +501,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
         }
 
         if (args.status) {
-          return cli.cliTelemetryStatus();
+          return cli.cliTelemetryStatus(args['version-reporting']);
         } else {
           const enable = args.enable ?? !args.disable;
           return cli.cliTelemetry(enable);

packages/aws-cdk/lib/cli/io-host/cli-io-host.ts

@@ -181,7 +181,7 @@ export class CliIoHost implements IIoHost {
       });
     }
     // TODO: uncomment this at launch
-    // if (canCollectTelemetry(context)) {
+    // if (canCollectTelemetry(args, context)) {
     //   sink = new EndpointTelemetrySink({
     //     ioHost: this,
     //     agent: proxyAgent,

packages/aws-cdk/lib/cli/parse-command-line-arguments.ts

@@ -102,7 +102,8 @@ export function parseCommandLineArguments(args: Array<string>): any {
     .option('version-reporting', {
       default: undefined,
       type: 'boolean',
-      desc: 'Include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)',
+      desc: 'Disable CLI telemetry and do not include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)',
+      alias: 'telemetry',
     })
     .option('path-metadata', {
       default: undefined,

packages/aws-cdk/lib/cli/telemetry/collect-telemetry.ts

@@ -3,8 +3,10 @@ import type { Context } from '../../api/context';
 /**
  * Whether or not we collect telemetry
  */
-export function canCollectTelemetry(context: Context): boolean {
-  if ((['true', '1'].includes(process.env.CDK_DISABLE_CLI_TELEMETRY ?? '')) || ['false', false].includes(context.get('cli-telemetry'))) {
+export function canCollectTelemetry(args: any, context: Context): boolean {
+  if ((['true', '1'].includes(process.env.CDK_DISABLE_CLI_TELEMETRY ?? '')) ||
+    ['false', false].includes(context.get('cli-telemetry')) ||
+    (args['version-reporting'] !== undefined && !args['version-reporting'])) /* aliased with telemetry option */ {
     return false;
   }
 

packages/aws-cdk/lib/cli/user-input.ts

@@ -252,7 +252,7 @@ export interface GlobalOptions {
   readonly ec2creds?: boolean;
 
   /**
-   * Include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)
+   * Disable CLI telemetry and do not include the "AWS::CDK::Metadata" resource in synthesized templates (enabled by default)
    *
    * @default - undefined
    */

packages/aws-cdk/lib/cli/version.ts

@@ -1,4 +1,3 @@
-/* c8 ignore start */
 import * as path from 'path';
 import { cliRootDir } from './root-dir';
 

packages/aws-cdk/test/cli/telemetry/collect-telemetry.test.ts

@@ -10,38 +10,42 @@ describe(canCollectTelemetry, () => {
   });
 
   test('returns true by default', async () => {
-    expect(canCollectTelemetry(context)).toBeTruthy();
+    expect(canCollectTelemetry({}, context)).toBeTruthy();
   });
 
   test('returns false if env variable is set to true', async () => {
     await withEnv(async () => {
-      expect(canCollectTelemetry(context)).toBeFalsy();
+      expect(canCollectTelemetry({}, context)).toBeFalsy();
     }, {
       CDK_DISABLE_CLI_TELEMETRY: 'true',
     });
   });
 
   test('returns false if env variable is set to 1', async () => {
     await withEnv(async () => {
-      expect(canCollectTelemetry(context)).toBeFalsy();
+      expect(canCollectTelemetry({}, context)).toBeFalsy();
     }, {
       CDK_DISABLE_CLI_TELEMETRY: '1',
     });
   });
 
   test('returns false if context is set to false', async () => {
     context.set('cli-telemetry', false);
-    expect(canCollectTelemetry(context)).toBeFalsy();
+    expect(canCollectTelemetry({}, context)).toBeFalsy();
 
     context.set('cli-telemetry', 'false');
-    expect(canCollectTelemetry(context)).toBeFalsy();
+    expect(canCollectTelemetry({}, context)).toBeFalsy();
   });
 
   test('returns true if context is set to true', async () => {
     context.set('cli-telemetry', true);
-    expect(canCollectTelemetry(context)).toBeTruthy();
+    expect(canCollectTelemetry({}, context)).toBeTruthy();
 
     context.set('cli-telemetry', 'true');
-    expect(canCollectTelemetry(context)).toBeTruthy();
+    expect(canCollectTelemetry({}, context)).toBeTruthy();
+  });
+
+  test('returns false if no-version-reporting is set', async () => {
+    expect(canCollectTelemetry({ 'version-reporting': false }, context)).toBeFalsy();
   });
 });