refactor(Telemetry): Ensure to report projectId for interactive

serverless · Dec 23, 2021 · 08b5acb · 08b5acb
1 parent 0190d0d
commit 08b5acb
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 6 deletions.
diff --git a/lib/cli/interactive-setup/deploy.js b/lib/cli/interactive-setup/deploy.js
@@ -142,7 +142,8 @@ module.exports = {
     context.inapplicabilityReasonCode = 'NO_CREDENTIALS_CONFIGURED';
     return false;
   },
-  async run({ initial, configuration, configurationFilename, serviceDir, stepHistory }) {
+  async run(context) {
+    const { initial, configuration, configurationFilename, serviceDir, stepHistory } = context;
     const serviceName = configuration.service;
     const shouldDeploy = await promptWithHistory({
       name: 'shouldDeploy',
@@ -183,6 +184,7 @@ module.exports = {
       await serverless.init();
       delete serverless.isLocallyInstalled;
       await serverless.run();
+      context.awsAccountId = serverless.getProvider('aws').accountId;
     } else {
       try {
         await overrideStdoutWrite(
@@ -197,6 +199,7 @@ module.exports = {
             // Remove previously set `isLocallyInstalled` as it was only needed to avoid local fallback in `init()`
             delete serverless.isLocallyInstalled;
             await serverless.run();
+            context.awsAccountId = serverless.getProvider('aws').accountId;
           }
         );
       } catch (err) {

diff --git a/lib/cli/interactive-setup/index.js b/lib/cli/interactive-setup/index.js
@@ -59,5 +59,6 @@ module.exports = async (context) => {
 
   return {
     configuration: context.configuration,
+    awsAccountId: context.awsAccountId,
   };
 };
diff --git a/lib/utils/telemetry/generatePayload.js b/lib/utils/telemetry/generatePayload.js
@@ -138,6 +138,7 @@ module.exports = ({
   serverless,
   commandUsage,
   variableSources,
+  awsAccountId,
 }) => {
   let commandDurationMs;
 
@@ -300,11 +301,14 @@ module.exports = ({
     payload.isConfigValid = getConfigurationValidationResult(configuration);
     payload.dashboard.orgUid = serverless && serverless.service.orgUid;
 
-    if (serverless && command === 'deploy' && isAwsProvider) {
+    if (
+      isAwsProvider &&
+      ((serverless && command === 'deploy') || (command === '' && awsAccountId))
+    ) {
       const serviceName = isObject(configuration.service)
         ? configuration.service.name
         : configuration.service;
-      const accountId = serverless.getProvider('aws').accountId;
+      const accountId = awsAccountId || (serverless && serverless.getProvider('aws').accountId);
       if (serviceName && accountId) {
         payload.projectId = crypto
           .createHash('sha256')

diff --git a/scripts/serverless.js b/scripts/serverless.js
@@ -514,6 +514,7 @@ const processSpanPromise = (async () => {
     const isStandaloneCommand = notIntegratedCommands.has(command);
 
     if (!isHelpRequest && (isInteractiveSetup || isStandaloneCommand)) {
+      let interactiveResult;
       if (configuration) require('../lib/cli/ensure-supported-command')(configuration);
       if (isInteractiveSetup) {
         if (!process.stdin.isTTY && !process.env.SLS_INTERACTIVE_SETUP_ENABLE) {
@@ -523,15 +524,15 @@ const processSpanPromise = (async () => {
             'INTERACTIVE_SETUP_IN_NON_TTY'
           );
         }
-        const result = await require('../lib/cli/interactive-setup')({
+        interactiveResult = await require('../lib/cli/interactive-setup')({
           configuration,
           serviceDir,
           configurationFilename,
           options,
           commandUsage,
         });
-        if (result.configuration) {
-          configuration = result.configuration;
+        if (interactiveResult.configuration) {
+          configuration = interactiveResult.configuration;
         }
       } else {
         await require(`../commands/${commands.join('-')}`)({
@@ -558,6 +559,7 @@ const processSpanPromise = (async () => {
               configuration,
               commandUsage,
               variableSources: variableSourcesInConfig,
+              awsAccountId: interactiveResult.awsAccountId,
             }),
             outcome: 'success',
           });

diff --git a/test/unit/lib/cli/interactive-setup/deploy.test.js b/test/unit/lib/cli/interactive-setup/deploy.test.js
@@ -215,6 +215,11 @@ describe('test/unit/lib/cli/interactive-setup/deploy.test.js', () => {
             ],
             dashboardPlugin: {},
           };
+          this.getProvider = () => {
+            return {
+              accountId: '123',
+            };
+          };
         }
       }
 
@@ -276,6 +281,11 @@ describe('test/unit/lib/cli/interactive-setup/deploy.test.js', () => {
             ],
             dashboardPlugin: {},
           };
+          this.getProvider = () => {
+            return {
+              accountId: '123',
+            };
+          };
         }
       }
 
@@ -336,6 +346,11 @@ describe('test/unit/lib/cli/interactive-setup/deploy.test.js', () => {
               },
             ],
           };
+          this.getProvider = () => {
+            return {
+              accountId: '123',
+            };
+          };
         }
       }
 
@@ -388,6 +403,11 @@ describe('test/unit/lib/cli/interactive-setup/deploy.test.js', () => {
               },
             ],
           };
+          this.getProvider = () => {
+            return {
+              accountId: '123',
+            };
+          };
         }
       }
 

diff --git a/test/unit/lib/utils/telemetry/generatePayload.test.js b/test/unit/lib/utils/telemetry/generatePayload.test.js
@@ -680,4 +680,24 @@ describe('test/unit/lib/utils/telemetry/generatePayload.test.js', () => {
 
     expect(payload.projectId).to.deep.equal('35dsFwCaexwLHppAP4uDsjKW4ci54q1AKcN5JTNaDtw=');
   });
+
+  it('Should correctly resolve projectId property when account passed externally', async () => {
+    const { serverless } = await runServerless({
+      fixture: 'httpApi',
+      command: 'print',
+      configExt: {
+        service: 'to-ensure-unique-serivce-name',
+      },
+    });
+    const payload = generatePayload({
+      command: '',
+      options: {},
+      commandSchema: commandsSchema.get('deploy'),
+      serviceDir: serverless.serviceDir,
+      configuration: serverless.configurationInput,
+      awsAccountId: '1234567890',
+    });
+
+    expect(payload.projectId).to.deep.equal('35dsFwCaexwLHppAP4uDsjKW4ci54q1AKcN5JTNaDtw=');
+  });
 });