feat: Add usage data metrics for sandbox

packages/backend-deployer/API.md

@@ -5,7 +5,6 @@
 ```ts
 
 import { BackendIdentifier } from '@aws-amplify/plugin-types';
-import { DeploymentTimes } from '@aws-amplify/platform-core';
 import { DeploymentType } from '@aws-amplify/plugin-types';
 
 // @public
@@ -19,6 +18,12 @@ export class BackendDeployerFactory {
     static getInstance: () => BackendDeployer;
 }
 
+// @public (undocumented)
+export type DeploymentTimes = {
+    synthesisTime?: number;
+    totalTime?: number;
+};
+
 // @public (undocumented)
 export type DeployProps = {
     deploymentType?: DeploymentType;
@@ -28,7 +33,6 @@ export type DeployProps = {
 
 // @public (undocumented)
 export type DeployResult = {
-    hotswapped?: boolean;
     deploymentTimes: DeploymentTimes;
 };
 

packages/backend-deployer/src/cdk_deployer.test.ts

@@ -25,7 +25,7 @@ void describe('invokeCDKCommand', () => {
 
   const invoker = new CDKDeployer(new CdkErrorMapper(), backendLocator);
   const execaMock = mock.method(invoker, 'executeChildProcess', () =>
-    Promise.resolve('some cdk output')
+    Promise.resolve()
   );
 
   beforeEach(() => {

packages/backend-deployer/src/cdk_deployer.ts

@@ -1,17 +1,16 @@
 import { execa } from 'execa';
 import stream from 'stream';
+import readline from 'readline';
 import {
   BackendDeployer,
   DeployProps,
+  DeployResult,
   DestroyProps,
+  DestroyResult,
 } from './cdk_deployer_singleton_factory.js';
 import { CdkErrorMapper } from './cdk_error_mapper.js';
 import { BackendIdentifier, DeploymentType } from '@aws-amplify/plugin-types';
-import {
-  BackendLocator,
-  CDKContextKey,
-  DeploymentTimes,
-} from '@aws-amplify/platform-core';
+import { BackendLocator, CDKContextKey } from '@aws-amplify/platform-core';
 import { BackendDeployerEnvironmentVariables } from './environment_variables.js';
 
 /**
@@ -51,17 +50,12 @@ export class CDKDeployer implements BackendDeployer {
       }
     }
 
-    const cdkOutput = await this.invokeCdk(
+    return this.invokeCdk(
       InvokableCommand.DEPLOY,
       backendId,
       deployProps?.deploymentType,
       cdkCommandArgs
     );
-
-    return {
-      deploymentTimes: this.getDeploymentTimes(cdkOutput),
-      hotswapped: this.deploymentHotswapped(cdkOutput),
-    };
   };
 
   /**
@@ -71,15 +65,12 @@ export class CDKDeployer implements BackendDeployer {
     backendId?: BackendIdentifier,
     destroyProps?: DestroyProps
   ) => {
-    const cdkOutput = await this.invokeCdk(
+    return this.invokeCdk(
       InvokableCommand.DESTROY,
       backendId,
       destroyProps?.deploymentType,
       ['--force']
     );
-    return {
-      deploymentTimes: this.getDeploymentTimes(cdkOutput),
-    };
   };
 
   private invokeTsc = async (deployProps?: DeployProps) => {
@@ -116,7 +107,7 @@ export class CDKDeployer implements BackendDeployer {
     backendId?: BackendIdentifier,
     deploymentType?: DeploymentType,
     additionalArguments?: string[]
-  ): Promise<string> => {
+  ): Promise<DeployResult | DestroyResult> => {
     // Basic args
     const cdkCommandArgs = [
       'cdk',
@@ -173,54 +164,52 @@ export class CDKDeployer implements BackendDeployer {
     // actionable errors being hidden among the stdout. Moreover execa errors are
     // useless when calling CLIs unless you made execa calling error.
     let aggregatedStderr = '';
-    let aggregatedStdout = '';
     const aggregatorStderrStream = new stream.Writable();
-    const aggregatorStdoutStream = new stream.Writable();
     aggregatorStderrStream._write = function (chunk, encoding, done) {
       aggregatedStderr += chunk;
       done();
     };
-    aggregatorStdoutStream._write = function (chunk, encoding, done) {
-      aggregatedStdout += chunk;
-      done();
-    };
     const childProcess = execa(command, cdkCommandArgs, {
       stdin: 'inherit',
       stdout: 'pipe',
       stderr: 'pipe',
     });
     childProcess.stderr?.pipe(aggregatorStderrStream);
-    childProcess.stdout?.pipe(aggregatorStdoutStream);
     childProcess.stdout?.pipe(process.stdout);
+
+    const cdkOutput = { deploymentTimes: {} };
+    if (childProcess.stdout) {
+      await this.populateCDKOutputFromStdout(cdkOutput, childProcess.stdout);
+    }
+
     try {
       await childProcess;
-      return aggregatedStdout;
+      return cdkOutput;
     } catch (error) {
       // swallow execa error which is not really helpful, rather throw stderr
       throw new Error(aggregatedStderr);
     }
   };
 
-  private getDeploymentTimes = (cdkOutput: string) => {
-    const deploymentTimes: DeploymentTimes = {};
-    // the time can be in fractional or whole seconds. 24.3, 24, 24.22 etc.
+  private populateCDKOutputFromStdout = async (
+    output: DeployResult | DestroyResult,
+    stdout: stream.Readable
+  ) => {
     const regexTotalTime = /✨ {2}Total time: (\d*\.*\d*)s.*/;
-    const totalTime = cdkOutput.match(regexTotalTime);
-    if (totalTime && totalTime.length > 1 && !isNaN(+totalTime[1])) {
-      deploymentTimes.totalTime = +totalTime[1];
-    }
-
     const regexSynthTime = /✨ {2}Synthesis time: (\d*\.*\d*)s/;
-    const synthTime = cdkOutput.match(regexSynthTime);
-    if (synthTime && synthTime.length > 1 && !isNaN(+synthTime[1])) {
-      deploymentTimes.synthesisTime = +synthTime[1];
+    const reader = readline.createInterface(stdout);
+    for await (const line of reader) {
+      if (line.includes('✨')) {
+        // Good chance that it contains timing information
+        const totalTime = line.match(regexTotalTime);
+        if (totalTime && totalTime.length > 1 && !isNaN(+totalTime[1])) {
+          output.deploymentTimes.totalTime = +totalTime[1];
+        }
+        const synthTime = line.match(regexSynthTime);
+        if (synthTime && synthTime.length > 1 && !isNaN(+synthTime[1])) {
+          output.deploymentTimes.synthesisTime = +synthTime[1];
+        }
+      }
     }
-
-    return deploymentTimes;
-  };
-
-  private deploymentHotswapped = (cdkOutput: string) => {
-    const regexTotalTime = /✨.*hotswapped!/;
-    return regexTotalTime.test(cdkOutput);
   };
 }

packages/backend-deployer/src/cdk_deployer_singleton_factory.ts

@@ -1,7 +1,7 @@
 import { BackendIdentifier, DeploymentType } from '@aws-amplify/plugin-types';
 import { CDKDeployer } from './cdk_deployer.js';
 import { CdkErrorMapper } from './cdk_error_mapper.js';
-import { BackendLocator, DeploymentTimes } from '@aws-amplify/platform-core';
+import { BackendLocator } from '@aws-amplify/platform-core';
 
 export type DeployProps = {
   deploymentType?: DeploymentType;
@@ -10,7 +10,6 @@ export type DeployProps = {
 };
 
 export type DeployResult = {
-  hotswapped?: boolean;
   deploymentTimes: DeploymentTimes;
 };
 
@@ -22,6 +21,11 @@ export type DestroyResult = {
   deploymentTimes: DeploymentTimes;
 };
 
+export type DeploymentTimes = {
+  synthesisTime?: number;
+  totalTime?: number;
+};
+
 /**
  * Invokes an invokable command
  */

packages/backend-output-storage/API.md

@@ -8,8 +8,8 @@
 
 import { BackendOutputEntry } from '@aws-amplify/plugin-types';
 import { BackendOutputStorageStrategy } from '@aws-amplify/plugin-types';
-import { LibraryVersionFetcher } from '@aws-amplify/platform-core';
 import * as _os from 'os';
+import { PackageJsonReader } from '@aws-amplify/platform-core';
 import { Stack } from 'aws-cdk-lib';
 
 // @public (undocumented)
@@ -23,7 +23,7 @@ export type AttributionMetadata = {
 
 // @public
 export class AttributionMetadataStorage {
-    constructor(os?: typeof _os, libraryVersionFetcher?: LibraryVersionFetcher);
+    constructor(os?: typeof _os, packageJsonReader?: PackageJsonReader);
     storeAttributionMetadata: (stack: Stack, stackType: string, libraryPackageJsonAbsolutePath: string, additionalMetadata?: Record<string, string>) => void;
 }