Merge pull request #14113 from aws-amplify/telemetry-updates

Fix: update telemetry collection

Author: ShadowCat567

.github/workflows/build-test-mac.yml

@@ -10,7 +10,7 @@ env:
 
 jobs:
   build-and-test:
-    runs-on: macos-latest-xl
+    runs-on: macos-latest-xlarge
     steps:
       - name: Checkout Code
         uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3

packages/amplify-category-auth/src/__tests__/commands/update.test.ts

@@ -120,8 +120,11 @@ describe('auth update:', () => {
       });
     });
     it('update run method should detect presence of dependent resource and print a message', async () => {
+      const originalExitCode = process.exitCode;
       await update.run(mockContext);
       expect(printer.info).toBeCalledWith(messages.dependenciesExists);
+      // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+      process.exitCode = originalExitCode;
     });
     it('serviceSelectionPrompt should still be called even when warning displayed for existing resource', async () => {
       await update.run(mockContext);

packages/amplify-cli/src/__tests__/amplify-exception-handler.test.ts

@@ -35,16 +35,20 @@ describe('test exception handler', () => {
     init(contextMock);
   });
   it('error handler should call usageData emitError', async () => {
+    const originalExitCode = process.exitCode;
     const amplifyError = new AmplifyError('NotImplementedError', {
       message: 'Test Not implemented',
       resolution: 'Test Not implemented',
     });
     await handleException(amplifyError);
 
     expect(contextMock.usageData.emitError).toHaveBeenCalledWith(amplifyError);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should send error report', async () => {
+    const originalExitCode = process.exitCode;
     const amplifyError = new AmplifyError('NotImplementedError', {
       message: 'Test Not implemented',
       resolution: 'Test Not implemented',
@@ -53,9 +57,12 @@ describe('test exception handler', () => {
 
     expect(reportErrorMock).toHaveBeenCalledWith(contextMock, amplifyError);
     expect(processExit).toHaveBeenCalledWith(1);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should print error', async () => {
+    const originalExitCode = process.exitCode;
     const amplifyError = new AmplifyError('NotImplementedError', {
       message: 'Test Not implemented(message)',
       details: 'Test Not implemented(details)',
@@ -69,9 +76,12 @@ describe('test exception handler', () => {
     expect(printerMock.info).toHaveBeenNthCalledWith(1, `Resolution: ${amplifyError.resolution}`);
     expect(printerMock.info).toHaveBeenLastCalledWith('Learn more at: https://docs.amplify.aws/cli/project/troubleshooting/');
     expect(printerMock.debug).toHaveBeenCalledWith(amplifyError.stack);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should handle encountered errors gracefully', async () => {
+    const originalExitCode = process.exitCode;
     const amplifyError = new AmplifyError('NotImplementedError', {
       message: 'Test Not implemented(message)',
       details: 'Test Not implemented(details)',
@@ -87,9 +97,12 @@ describe('test exception handler', () => {
     expect(printerMock.info).toHaveBeenLastCalledWith('Learn more at: https://docs.amplify.aws/cli/project/troubleshooting/');
     expect(printerMock.debug).toHaveBeenCalledWith(amplifyError.stack);
     expect(printerMock.error).toHaveBeenCalledWith('Failed to report error: MockTestError');
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should handle nodejs file permission errors for log files', async () => {
+    const originalExitCode = process.exitCode;
     const code = 'EACCES';
     const path = '/user/name/.amplify/path/to/log';
     const nodeJSError = new Error(`permission denied, open ${path}`) as NodeJS.ErrnoException;
@@ -102,9 +115,12 @@ describe('test exception handler', () => {
       new AmplifyError('FileSystemPermissionsError', { message: `permission denied, open ${path}` }),
     );
     expect(printerMock.info).toHaveBeenCalledWith(`Resolution: Try running 'sudo chown -R $(whoami):$(id -gn) ~/.amplify' to fix this`);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should handle nodejs file permission errors for ~/.aws/amplify files', async () => {
+    const originalExitCode = process.exitCode;
     const code = 'EACCES';
     const path = '/user/name/.aws/amplify/someFile';
     const nodeJSError = new Error(`permission denied, open ${path}`) as NodeJS.ErrnoException;
@@ -117,9 +133,12 @@ describe('test exception handler', () => {
       new AmplifyError('FileSystemPermissionsError', { message: `permission denied, open ${path}` }),
     );
     expect(printerMock.info).toHaveBeenCalledWith(`Resolution: Try running 'sudo chown -R $(whoami):$(id -gn) ~/.aws/amplify' to fix this`);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should handle nodejs file permission errors for amplify project', async () => {
+    const originalExitCode = process.exitCode;
     const code = 'EACCES';
     const path = '/user/name/workspace/amplify/path/to/manifest';
     const nodeJSError = new Error(`permission denied, open ${path}`) as NodeJS.ErrnoException;
@@ -135,9 +154,12 @@ describe('test exception handler', () => {
     expect(printerMock.info).toHaveBeenCalledWith(
       `Resolution: Try running 'sudo chown -R $(whoami):$(id -gn) <your amplify app directory>' to fix this`,
     );
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 
   it('error handler should handle nodejs file permission errors for other files', async () => {
+    const originalExitCode = process.exitCode;
     const code = 'EACCES';
     const path = '/usr/name/.aws/config';
     const nodeJSError = new Error(`permission denied, open ${path}`) as NodeJS.ErrnoException;
@@ -151,6 +173,8 @@ describe('test exception handler', () => {
     );
     // different resolution based on the file path compared to last test
     expect(printerMock.info).toHaveBeenCalledWith(`Resolution: Try running 'sudo chown -R $(whoami):$(id -gn) ${path}' to fix this`);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   });
 });
 

packages/amplify-cli/src/__tests__/flow-report.test.ts

@@ -15,6 +15,7 @@ import {
 import { v4 as uuid } from 'uuid';
 import { Redactor } from '@aws-amplify/amplify-cli-logger';
 import { CLIFlowReport } from '../domain/amplify-usageData/FlowReport';
+import { homedir } from 'os';
 
 describe('Test FlowReport Logging', () => {
   beforeAll(() => {});
@@ -103,6 +104,20 @@ describe('Test FlowReport Logging', () => {
     expect(flowReport.optionFlowData[0].input).toContain(input.serviceConfiguration.mapStyle);
     expect(flowReport.optionFlowData[0].input).toEqual(Redactor(inputString));
   });
+
+  it('runtime does not contain home directory info', () => {
+    const flowReport = new CLIFlowReport();
+    flowReport.setInput(mockInputs.headlessInput('auth', 'add'));
+
+    expect(flowReport.runtime).not.toContain(homedir());
+  });
+
+  it('executable does not contain home directory info', () => {
+    const flowReport = new CLIFlowReport();
+    flowReport.setInput(mockInputs.headlessInput('auth', 'add'));
+
+    expect(flowReport.executable).not.toContain(homedir());
+  });
 });
 
 const redactValue = (key: string, value: unknown) => {
@@ -180,7 +195,7 @@ const mockInputs = {
   Geo: mockAddGeoInput,
   GraphQLAPI: mockAddAPIInput,
   headlessInput: (feature, command) => ({
-    argv: [],
+    argv: [`${homedir()}/.amplify/bin/amplify.exe`, `${homedir()}/amplify-cli/build/node_modules/@aws-amplify/cli-internal/bin/amplify`],
     plugin: feature,
     command,
   }),

packages/amplify-cli/src/__tests__/serializable-error.test.ts

@@ -54,4 +54,23 @@ describe('test serializabe error', () => {
     expect(serializableError.name).toBe('NotImplementedError');
     expect(serializableError.details).toBe('some error details with arn: <escaped ARN> and arn: <escaped ARN> and something else');
   });
+
+  it('test SerializableError has no stack arns in error message', () => {
+    const testStack = 'amplify-someStackName-dev-u9910';
+    const error = new AmplifyError('NotImplementedError', {
+      message: `Could not initialize ${testStack}`,
+    });
+
+    const serializableError = new SerializableError(error);
+    expect(serializableError.message).toBe('Could not initialize <escaped stack>');
+  });
+
+  it('test SerializeError error message has no home directories in file paths', () => {
+    const error = new AmplifyError('FileSystemPermissionsError', {
+      message: `Permission denied, open '${os.homedir()}/.amplify/logs/amplify-cli-10371230.log`,
+    });
+
+    const serializableError = new SerializableError(error);
+    expect(serializableError.message).not.toContain(os.homedir());
+  });
 });

packages/amplify-cli/src/__tests__/test-aborting.test.ts

@@ -111,6 +111,7 @@ describe('test SIGINT with execute', () => {
 
     jest.mock('@aws-amplify/amplify-environment-parameters');
 
+    const originalExitCode = process.exitCode;
     setTimeout(() => {
       process.emit('SIGINT', 'SIGINT');
       process.exitCode = 2;
@@ -124,6 +125,8 @@ describe('test SIGINT with execute', () => {
     expect(mockContext.usageData.emitError).toHaveBeenCalledTimes(0);
     expect(mockContext.usageData.emitSuccess).toHaveBeenCalledTimes(0);
     expect(mockExit).toBeCalledWith(2);
+    // Setting exitCode back to original, see https://github.com/jestjs/jest/issues/9324#issuecomment-1808090455
+    process.exitCode = originalExitCode;
   }, 10000);
 });
 

packages/amplify-cli/src/__tests__/usage-data.test.ts

@@ -67,6 +67,41 @@ describe('test usageData', () => {
     expect(a).toEqual(b);
   });
 
+  it('expects accountId to be a valid UUID', () => {
+    const a = UsageData.Instance;
+    const timeStamp = Date.now();
+    const testAccountID = '123456789012';
+    a.init(
+      uuid.v4(),
+      '',
+      new CommandLineInput([]),
+      testAccountID,
+      { editor: 'vscode', framework: 'react', frontend: 'javascript' } as unknown as ProjectSettings,
+      timeStamp,
+    );
+
+    expect(uuid.validate(a.getUsageDataPayload(null, 'SUCCESS').accountId)).toEqual(true);
+  });
+
+  it('returns cached accountId on subsequent calls', () => {
+    const a = UsageData.Instance;
+    const timeStamp = Date.now();
+    const testAccountID = '123456789012';
+    a.init(
+      uuid.v4(),
+      '',
+      new CommandLineInput([]),
+      testAccountID,
+      { editor: 'vscode', framework: 'react', frontend: 'javascript' } as unknown as ProjectSettings,
+      timeStamp,
+    );
+
+    const accountId1 = a.getUsageDataPayload(null, 'SUCCESS').accountId;
+    const accountId2 = a.getUsageDataPayload(null, 'SUCCESS').accountId;
+
+    expect(accountId1).toEqual(accountId2);
+  });
+
   it('records specified code path timer', async () => {
     const usageData = UsageData.Instance;
     usageData.startCodePathTimer(ManuallyTimedCodePath.PLUGIN_TIME);

packages/amplify-cli/src/domain/amplify-usageData/FlowReport.ts

@@ -12,6 +12,7 @@ import {
   TypeOptionFlowData,
 } from '@aws-amplify/amplify-cli-shared-interfaces';
 import { createHashedIdentifier } from '../../commands/helpers/encryption-helpers';
+import { homedir } from 'os';
 
 /**
  * Store the data and sequence of events of CLI walkthrough
@@ -32,6 +33,11 @@ export class CLIFlowReport implements IFlowData {
   projectIdentifier?: string; // hash( ProjectName + Amplify App Id)
   envName?: string;
 
+  // (file:/+)? -> matches optional file url prefix
+  // homedir() -> users home directory, replacing \ with /
+  // [\\w.\\-_@\\\\/]+ -> matches nested directories and file name
+  filePathRegex = new RegExp(`(file:/+)?${homedir().replaceAll('\\', '/')}[\\w.\\-_@\\\\/]+`, 'g');
+
   constructor() {
     const currentTime = Date.now();
     this.logger = getAmplifyLogger();
@@ -66,8 +72,15 @@ export class CLIFlowReport implements IFlowData {
    */
   setInput(input: CLIInput): void {
     this.input = input;
-    this.runtime = input.argv[0] as string;
-    this.executable = input.argv[1] as string;
+    for (let i = 0; i < input.argv.length; i++) {
+      if (input.argv[i].match(this.filePathRegex)) {
+        const arg = this.anonymizePath(input.argv[i]);
+        this.input.argv[i] = arg;
+      }
+    }
+
+    this.runtime = this.input.argv[0] as string;
+    this.executable = this.input.argv[1] as string;
     this.cmd = input.argv[2] as string;
     this.subCmd = input.argv[3] ? input.argv[3] : undefined;
     this.optionFlowData = []; // key-value store with ordering maintained
@@ -139,4 +152,12 @@ export class CLIFlowReport implements IFlowData {
     const timeStampedOption: IOptionFlowHeadlessData = { input: cleanOption, timestamp: new Date().valueOf() }; // attach unix-style timestamp
     this.optionFlowData.push(timeStampedOption);
   }
+
+  private anonymizePath = (str: string): string => {
+    let result = str;
+    if (result.match(this.filePathRegex)) {
+      result = result.replace(this.filePathRegex, '');
+    }
+    return result;
+  };
 }

packages/amplify-cli/src/domain/amplify-usageData/SerializableError.ts

@@ -1,10 +1,18 @@
 import { $TSAny } from '@aws-amplify/amplify-cli-core';
+import { homedir } from 'os';
 import * as path from 'path';
 
 const stackTraceRegex = /^\s*at (?:((?:\[object object\])?[^\\/]+(?: \[as \S+\])?) )?\(?(.*?):(\d+)(?::(\d+))?\)?\s*$/i;
 const ARNRegex =
   /arn:[a-z0-9][-.a-z0-9]{0,62}:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}/g;
 
+// Gen1 stacks have same structure as Gen2 stacks
+const stackRegex = /amplify-[a-zA-Z0-9-]+/g;
+// (file:/+)? -> matches optional file url prefix
+// homedir() -> users home directory, replacing \ with /
+// [\\w.\\-_@\\\\/]+ -> matches nested directories and file name
+const filePathRegex = new RegExp(`(file:/+)?${homedir().replaceAll('\\', '/')}[\\w.\\-_@\\\\/]+`, 'g');
+
 /**
  * Wrapper around Error.name
  */
@@ -16,7 +24,7 @@ export class SerializableError {
   trace?: Trace[];
   constructor(error: Error) {
     this.name = error.name;
-    this.message = removeARN(error.message)!;
+    this.message = anonymizePaths(sanitize(error.message)!);
     this.details = removeARN((error as $TSAny)?.details);
     this.code = (error as $TSAny)?.code;
     this.trace = extractStackTrace(error);
@@ -83,10 +91,32 @@ const processPaths = (paths: string[]): string[] => {
   });
 };
 
+const sanitize = (str?: string): string | undefined => {
+  let result = str;
+  result = removeARN(result);
+  result = removeStackIdentifier(result);
+
+  return result;
+};
+
 const removeARN = (str?: string): string | undefined => {
   return str?.replace(ARNRegex, '<escaped ARN>');
 };
 
+const removeStackIdentifier = (str?: string): string | undefined => {
+  return str?.replace(stackRegex, '<escaped stack>') ?? '';
+};
+
+const anonymizePaths = (str: string): string => {
+  let result = str;
+
+  if (result.match(filePathRegex)) {
+    result = result.replaceAll(filePathRegex, '');
+  }
+
+  return result;
+};
+
 type Trace = {
   methodName: string;
   file: string;

packages/amplify-cli/src/domain/amplify-usageData/UsageData.ts

@@ -4,7 +4,7 @@ import { prompter, printer } from '@aws-amplify/amplify-prompts';
 import https from 'https';
 import { pick } from 'lodash';
 import { UrlWithStringQuery } from 'url';
-import { v4 as uuid } from 'uuid';
+import { v4 as uuid, v5 as uuidV5 } from 'uuid';
 import { CLIInput } from '../command-input';
 import {
   JSONUtilities,
@@ -24,6 +24,8 @@ import redactInput from './identifiable-input-regex';
 import { Timer } from './Timer';
 import { UsageDataPayload } from './UsageDataPayload';
 
+const AMPLIFY_CLI_UUID_NAMESPACE = '7bf41e64-b0be-4a57-8d92-9cfbc1600f0f';
+
 /**
  * Singleton class that manages the lifecycle of usage data during a CLI command
  */
@@ -63,7 +65,7 @@ export class UsageData implements IUsageData {
     processStartTimeStamp: number,
   ): void {
     this.installationUuid = installationUuid;
-    this.accountId = accountId;
+    this.accountId = uuidV5(accountId.slice(0, -2), AMPLIFY_CLI_UUID_NAMESPACE);
     this.projectSettings = projectSettings;
     this.version = version;
     this.inputOptions = input.options ? pick(input.options as InputOptions, ['sandboxId']) : {};