feat(cli): cli-telemetry status command (#697)

- Introduces `cdk cli-telemetry --status` command that reports whether
cli telemetry is enabled/disabled.
- Pulls `canCollectTelemetry` command + tests out of #631
- Adds `cli-telemetry` to the readme

---
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 <github-actions@github.com>
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Eli Polonsky <Eli.polonsky@gmail.com>

Author: 3 people

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-adds-context-value.integtest.ts

@@ -45,7 +45,7 @@ integTest(
         ['cli-telemetry']: false,
       });
     } finally {
-      await fs.unlink(path.join(fixture.integTestDir, 'cdk.context.json'));
+      await fs.unlink(contextFile);
     }
   }),
 );

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-reports-status.integtest.ts

@@ -0,0 +1,24 @@
+import { promises as fs } from 'fs';
+import * as path from 'path';
+import { integTest, withDefaultFixture } from '../../../lib';
+
+jest.setTimeout(2 * 60 * 60_000); // Includes the time to acquire locks, worst-case single-threaded runtime
+
+integTest(
+  'CLI Telemetry reports status',
+  withDefaultFixture(async (fixture) => {
+    const userContextFile = path.join(fixture.integTestDir, 'cdk.json');
+    try {
+      // default status is enabled
+      const output1 = await fixture.cdk(['cli-telemetry', '--status']);
+      expect(output1).toContain('CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.');
+
+      // disable status
+      await fs.writeFile(userContextFile, JSON.stringify({ context: { 'cli-telemetry': false } }));
+      const output2 = await fixture.cdk(['cli-telemetry', '--status']);
+      expect(output2).toContain('CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.');
+    } finally {
+      await fs.unlink(userContextFile);
+    }
+  }),
+);

packages/aws-cdk/README.md

@@ -11,26 +11,27 @@
 
 The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
 
-| Command                               | Description                                                                       |
-| ------------------------------------- | --------------------------------------------------------------------------------- |
-| [`cdk docs`](#cdk-docs)               | Access the online documentation                                                   |
-| [`cdk init`](#cdk-init)               | Start a new CDK project (app or library)                                          |
-| [`cdk list`](#cdk-list)               | List stacks and their dependencies in an application                              |
-| [`cdk synth`](#cdk-synth)             | Synthesize a CDK app to CloudFormation template(s)                                |
-| [`cdk diff`](#cdk-diff)               | Diff stacks against current state                                                 |
-| [`cdk deploy`](#cdk-deploy)           | Deploy a stack into an AWS account                                                |
-| [`cdk rollback`](#cdk-rollback)       | Roll back a failed deployment                                                     |
-| [`cdk import`](#cdk-import)           | Import existing AWS resources into a CDK stack                                    |
-| [`cdk migrate`](#cdk-migrate)         | Migrate AWS resources, CloudFormation stacks, and CloudFormation templates to CDK |
-| [`cdk watch`](#cdk-watch)             | Watches a CDK app for deployable and hotswappable changes                         |
-| [`cdk destroy`](#cdk-destroy)         | Deletes a stack from an AWS account                                               |
-| [`cdk bootstrap`](#cdk-bootstrap)     | Deploy a toolkit stack to support deploying large stacks & artifacts              |
-| [`cdk gc`](#cdk-gc)                   | Garbage collect assets associated with the bootstrapped stack                     |
-| [`cdk doctor`](#cdk-doctor)           | Inspect the environment and produce information useful for troubleshooting        |
-| [`cdk acknowledge`](#cdk-acknowledge) | Acknowledge (and hide) a notice by issue number                                   |
-| [`cdk notices`](#cdk-notices)         | List all relevant notices for the application                                     |
-| [`cdk refactor`](#cdk-refactor)       | Moves resources between stacks or within the same stack                           |
-| [`cdk drift`](#cdk-drift)             | Detect drifts in the given CloudFormation stack(s)                                |
+| Command                                  | Description                                                                       |
+| ---------------------------------------- | --------------------------------------------------------------------------------- |
+| [`cdk docs`](#cdk-docs)                  | Access the online documentation                                                   |
+| [`cdk init`](#cdk-init)                  | Start a new CDK project (app or library)                                          |
+| [`cdk list`](#cdk-list)                  | List stacks and their dependencies in an application                              |
+| [`cdk synth`](#cdk-synth)                | Synthesize a CDK app to CloudFormation template(s)                                |
+| [`cdk diff`](#cdk-diff)                  | Diff stacks against current state                                                 |
+| [`cdk deploy`](#cdk-deploy)              | Deploy a stack into an AWS account                                                |
+| [`cdk rollback`](#cdk-rollback)          | Roll back a failed deployment                                                     |
+| [`cdk import`](#cdk-import)              | Import existing AWS resources into a CDK stack                                    |
+| [`cdk migrate`](#cdk-migrate)            | Migrate AWS resources, CloudFormation stacks, and CloudFormation templates to CDK |
+| [`cdk watch`](#cdk-watch)                | Watches a CDK app for deployable and hotswappable changes                         |
+| [`cdk destroy`](#cdk-destroy)            | Deletes a stack from an AWS account                                               |
+| [`cdk bootstrap`](#cdk-bootstrap)        | Deploy a toolkit stack to support deploying large stacks & artifacts              |
+| [`cdk gc`](#cdk-gc)                      | Garbage collect assets associated with the bootstrapped stack                     |
+| [`cdk doctor`](#cdk-doctor)              | Inspect the environment and produce information useful for troubleshooting        |
+| [`cdk acknowledge`](#cdk-acknowledge)    | Acknowledge (and hide) a notice by issue number                                   |
+| [`cdk notices`](#cdk-notices)            | List all relevant notices for the application                                     |
+| [`cdk refactor`](#cdk-refactor)          | Moves resources between stacks or within the same stack                           |
+| [`cdk drift`](#cdk-drift)                | Detect drifts in the given CloudFormation stack(s)                                |
+| [`cdk cli-telemetry](#cdk-cli-telemetry) | Enable or disable cli telemetry collection                                        |
 
 ## Common topics
 
@@ -1213,6 +1214,31 @@ $ # Detect drift against the currently-deployed stack with the verbose flag enab
 $ cdk drift --verbose 
 ```
 
+### `cdk cli-telemetry`
+
+Enables or disables cli telemetry collection for your local CDK App. Records your
+choice in `cdk.context.json`. You can also set your preference manually under the `context` key in your
+`~/.cdk.json` file or `<app-root>/cdk.json` file.
+
+```bash
+$ # Disable telemetry
+$ cdk cli-telemetry --disable
+
+$ # Enable telemetry
+$ cdk cli-telemetry --enable
+```
+
+You can also check the current status on whether your CDK App is opted in or out of
+cli telemetry collection. Note that this takes into account all methods of disabling
+cli telemetry, including environment variables and
+[context values](https://docs.aws.amazon.com/cdk/v2/guide/context.html)
+that can be set in many different ways (such as `~/.cdk.json`).
+
+```bash
+$ # Check the current status of telemetry
+$ cdk cli-telemetry --status
+```
+
 ## Global Options
 
 ### `unstable`

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

@@ -64,6 +64,7 @@ import {
   serializeStructure,
   validateSnsTopicArn,
 } from '../util';
+import { canCollectTelemetry } from './telemetry/collect-telemetry';
 
 // Must use a require() otherwise esbuild complains about calling a namespace
 // eslint-disable-next-line @typescript-eslint/no-require-imports,@typescript-eslint/consistent-type-imports
@@ -207,6 +208,15 @@ export class CdkToolkit {
     await this.props.configuration.saveContext();
   }
 
+  public async cliTelemetryStatus() {
+    const canCollect = canCollectTelemetry(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 {
+      await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.');
+    }
+  }
+
   public async cliTelemetry(enable: boolean) {
     this.props.configuration.context.set('cli-telemetry', enable);
     await this.props.configuration.saveContext();

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

@@ -476,6 +476,11 @@ export async function makeConfig(): Promise<CliConfig> {
             desc: 'Disable anonymous telemetry',
             conflicts: 'enable',
           },
+          status: {
+            type: 'boolean',
+            desc: 'Report telemetry opt-in/out status',
+            conflicts: ['enable', 'disable'],
+          },
         },
       },
     },

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

@@ -939,6 +939,14 @@
           "type": "boolean",
           "desc": "Disable anonymous telemetry",
           "conflicts": "enable"
+        },
+        "status": {
+          "type": "boolean",
+          "desc": "Report telemetry opt-in/out status",
+          "conflicts": [
+            "enable",
+            "disable"
+          ]
         }
       }
     }

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

@@ -478,13 +478,16 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
 
       case 'cli-telemetry':
         ioHost.currentAction = 'cli-telemetry';
-        if (args.enable === undefined && args.disable === undefined) {
-          throw new ToolkitError('Must specify either \'--enable\' or \'--disable\'');
+        if (args.enable === undefined && args.disable === undefined && args.status === undefined) {
+          throw new ToolkitError('Must specify \'--enable\', \'--disable\', or \'--status\'');
         }
 
-        const enable = args.enable ?? !args.disable;
-        return cli.cliTelemetry(enable);
-
+        if (args.status) {
+          return cli.cliTelemetryStatus();
+        } else {
+          const enable = args.enable ?? !args.disable;
+          return cli.cliTelemetry(enable);
+        }
       case 'init':
         ioHost.currentAction = 'init';
         const language = configuration.settings.get(['language']);

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

@@ -284,6 +284,7 @@ export function convertYargsToUserInput(args: any): UserInput {
       commandOptions = {
         enable: args.enable,
         disable: args.disable,
+        status: args.status,
       };
       break;
   }
@@ -488,6 +489,7 @@ export function convertConfigToUserInput(config: any): UserInput {
   const cliTelemetryOptions = {
     enable: config.cliTelemetry?.enable,
     disable: config.cliTelemetry?.disable,
+    status: config.cliTelemetry?.status,
   };
   const userInput: UserInput = {
     globalOptions,

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

@@ -926,6 +926,12 @@ export function parseCommandLineArguments(args: Array<string>): any {
           type: 'boolean',
           desc: 'Disable anonymous telemetry',
           conflicts: 'enable',
+        })
+        .option('status', {
+          default: undefined,
+          type: 'boolean',
+          desc: 'Report telemetry opt-in/out status',
+          conflicts: ['enable', 'disable'],
         }),
     )
     .version(helpers.cliVersion())

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

@@ -0,0 +1,12 @@
+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'))) {
+    return false;
+  }
+
+  return true;
+}