feat: usage data consent (#685)

* feat: user consent for telemetry

* fix: removing unused vars

* fix: lint errors

* feat: integrate with usage_data_emitter

* fix: update API.md

* update comment

* fix: refactor and move LocalConfigController to platform-core

* fix: add encoding when reading config file

* fix: adding additional file verification check

* fix: update unit test

* fix: export all types to update API.md

* fix: update API.md

* fix: open file using file descriptor

* fix: update fs mocks in unit test

* fix: update fs.open mock

* fix: mock fs open for unit test

Author: bombguy

.changeset/forty-geese-decide.md

@@ -0,0 +1,5 @@
+---
+'create-amplify': patch
+---
+
+Adding message about usage data tracking when creating new project

.changeset/nine-socks-attack.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+Added subcommands under configure data tracking preferences

.changeset/slimy-cups-draw.md

@@ -0,0 +1,6 @@
+---
+'@aws-amplify/platform-core': patch
+'@aws-amplify/backend-cli': patch
+---
+
+integrate usage data tracking consent with usage-data-emitter

.eslint_dictionary.json

@@ -62,6 +62,7 @@
   "localhost",
   "lsof",
   "lstat",
+  "macos",
   "matchers",
   "mfas",
   "mkdtemp",

package-lock.json

@@ -1,7 +1,9 @@
+import { configControllerFactory } from '@aws-amplify/platform-core';
 import { CommandModule } from 'yargs';
 import { ConfigureProfileCommand } from './configure_profile_command.js';
 import { ProfileController } from './profile_controller.js';
 import { ConfigureCommand } from './configure_command.js';
+import { ConfigureTelemetryCommand } from './telemetry/configure_telemetry_command.js';
 /**
  * Creates a configure command.
  */
@@ -10,8 +12,12 @@ export const createConfigureCommand = (): CommandModule<object> => {
   const configureProfileCommand = new ConfigureProfileCommand(
     profileController
   );
+  const configureTelemetryCommand = new ConfigureTelemetryCommand(
+    configControllerFactory.getInstance('usage_data_preferences.json')
+  );
 
   return new ConfigureCommand([
     configureProfileCommand as unknown as CommandModule,
+    configureTelemetryCommand as unknown as CommandModule,
   ]);
 };

packages/cli/src/commands/configure/configure_command_factory.ts

@@ -0,0 +1,70 @@
+import { Printer } from '@aws-amplify/cli-core';
+import { beforeEach, describe, it, mock } from 'node:test';
+import yargs, { CommandModule } from 'yargs';
+import assert from 'node:assert';
+import { TestCommandRunner } from '../../../test-utils/command_runner.js';
+import { ConfigureTelemetryCommand } from './configure_telemetry_command.js';
+import {
+  USAGE_DATA_TRACKING_ENABLED,
+  configControllerFactory,
+} from '@aws-amplify/platform-core';
+
+void describe('configure command', () => {
+  const mockedConfigControllerSet = mock.fn();
+  mock.method(configControllerFactory, 'getInstance', () => ({
+    set: mockedConfigControllerSet,
+  }));
+  const telemetryCommand = new ConfigureTelemetryCommand(
+    configControllerFactory.getInstance('usage_data_preferences.json')
+  );
+  const parser = yargs().command(telemetryCommand as unknown as CommandModule);
+  const commandRunner = new TestCommandRunner(parser);
+
+  const mockedPrint = mock.method(Printer, 'print');
+
+  beforeEach(() => {
+    mockedPrint.mock.resetCalls();
+    mockedConfigControllerSet.mock.resetCalls();
+  });
+
+  void it('enable telemetry & updates local config', async () => {
+    await commandRunner.runCommand(`telemetry enable`);
+    assert.match(
+      mockedPrint.mock.calls[0].arguments[0],
+      /You have enabled telemetry data collection/
+    );
+    assert.strictEqual(
+      mockedConfigControllerSet.mock.calls[0].arguments[0],
+      USAGE_DATA_TRACKING_ENABLED
+    );
+    assert.strictEqual(
+      mockedConfigControllerSet.mock.calls[0].arguments[1],
+      true
+    );
+  });
+
+  void it('disables telemetry & updates local config', async () => {
+    await commandRunner.runCommand(`telemetry disable`);
+    assert.match(
+      mockedPrint.mock.calls[0].arguments[0],
+      /You have disabled telemetry data collection/
+    );
+    assert.strictEqual(
+      mockedConfigControllerSet.mock.calls[0].arguments[0],
+      USAGE_DATA_TRACKING_ENABLED
+    );
+    assert.strictEqual(
+      mockedConfigControllerSet.mock.calls[0].arguments[1],
+      false
+    );
+  });
+
+  void it('if subcommand is not defined, it should list of subcommands and demandCommand', async () => {
+    await commandRunner.runCommand(`telemetry`);
+    assert.match(
+      mockedPrint.mock.calls[0].arguments[0],
+      /Not enough non-option arguments: got 0, need at least 1/
+    );
+    assert.strictEqual(mockedConfigControllerSet.mock.callCount(), 0);
+  });
+});

packages/cli/src/commands/configure/telemetry/configure_telemetry_command.test.ts

@@ -0,0 +1,63 @@
+import { Printer } from '@aws-amplify/cli-core';
+import {
+  ConfigurationController,
+  USAGE_DATA_TRACKING_ENABLED,
+} from '@aws-amplify/platform-core';
+import { Argv, CommandModule } from 'yargs';
+import { handleCommandFailure } from '../../../command_failure_handler.js';
+/**
+ * Command to configure AWS Amplify profile.
+ */
+export class ConfigureTelemetryCommand implements CommandModule<object> {
+  /**
+   * @inheritDoc
+   */
+  readonly command: string;
+
+  /**
+   * @inheritDoc
+   */
+  readonly describe: string;
+
+  /**
+   * Configure profile command.
+   */
+  constructor(private readonly configController: ConfigurationController) {
+    this.command = 'telemetry';
+    this.describe = 'Configure anonymous usage data collection';
+  }
+
+  /**
+   * @inheritDoc
+   */
+  handler = () => {
+    // CommandModule requires handler implementation. But this is never called if top level command
+    // is configured to require subcommand.
+    // Help is printed by default in that case before ever attempting to call handler.
+    throw new Error('Top level generate handler should never be called');
+  };
+
+  /**
+   * @inheritDoc
+   */
+  builder = (yargs: Argv) => {
+    return yargs
+      .command('enable', 'Enable anonymous data collection', {}, async () => {
+        await this.configController.set(USAGE_DATA_TRACKING_ENABLED, true);
+
+        Printer.print('You have enabled telemetry data collection');
+      })
+      .command('disable', 'Disable anonymous data collection', {}, async () => {
+        await this.configController.set(USAGE_DATA_TRACKING_ENABLED, false);
+
+        Printer.print('You have disabled telemetry data collection');
+      })
+      .demandCommand()
+      .strictCommands()
+      .recommendCommands()
+      .fail((msg, err) => {
+        handleCommandFailure(msg, err, yargs);
+        yargs.exit(1, err);
+      });
+  };
+}

packages/cli/src/commands/configure/telemetry/configure_telemetry_command.ts

@@ -50,13 +50,14 @@ export const createSandboxCommand = (): CommandModule<
     credentialProvider
   );
 
+  const libraryVersion =
+    new PackageJsonReader().read(
+      fileURLToPath(new URL('../../../package.json', import.meta.url))
+    ).version ?? '';
+
   const eventHandlerFactory = new SandboxEventHandlerFactory(
     sandboxBackendIdentifierResolver,
-    new UsageDataEmitterFactory().getInstance(
-      new PackageJsonReader().read(
-        fileURLToPath(new URL('../../../package.json', import.meta.url))
-      ).version ?? ''
-    )
+    async () => await new UsageDataEmitterFactory().getInstance(libraryVersion)
   );
 
   const commandMiddleWare = new CommandMiddleware();

packages/cli/src/commands/sandbox/sandbox_command_factory.ts

@@ -40,7 +40,7 @@ void describe('sandbox_event_handler_factory', () => {
       name: 'name',
       type: 'sandbox',
     }),
-    usageDataEmitterMock
+    async () => usageDataEmitterMock
   );
 
   afterEach(() => {