Report npm user agent (#2248)

* Report npm user agent

* change field.

Author: Kamil Sobol

.changeset/dry-falcons-hammer.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/platform-core': patch
+---
+
+Report npm user agent

packages/platform-core/src/usage-data/usage_data.ts

@@ -16,4 +16,5 @@ export type UsageData = {
   accountId: string;
   input: { command: string; plugin: string };
   codePathDurations: { platformStartup?: number; totalDuration?: number };
+  projectSetting: { editor?: string };
 };

packages/platform-core/src/usage-data/usage_data_emitter.test.ts

@@ -1,4 +1,4 @@
-import { afterEach, describe, mock, test } from 'node:test';
+import { after, afterEach, before, describe, mock, test } from 'node:test';
 import assert from 'node:assert';
 import { DefaultUsageDataEmitter } from './usage_data_emitter';
 import { v4, validate } from 'uuid';
@@ -12,6 +12,9 @@ import { UsageData } from './usage_data';
 import isCI from 'is-ci';
 import { AmplifyError, AmplifyUserError } from '..';
 
+const originalNpmUserAgent = process.env.npm_config_user_agent;
+const testNpmUserAgent = 'testNpmUserAgent';
+
 void describe('UsageDataEmitter', () => {
   let usageDataEmitter: DefaultUsageDataEmitter;
 
@@ -39,6 +42,14 @@ void describe('UsageDataEmitter', () => {
 
   mock.method(https, 'request', () => reqMock);
 
+  before(() => {
+    process.env.npm_config_user_agent = testNpmUserAgent;
+  });
+
+  after(() => {
+    process.env.npm_config_user_agent = originalNpmUserAgent;
+  });
+
   afterEach(() => {
     onReqEndMock.mock.resetCalls();
     onReqEndMock.mock.restore();
@@ -72,6 +83,10 @@ void describe('UsageDataEmitter', () => {
     assert.deepStrictEqual(usageDataSent.isCi, isCI);
     assert.deepStrictEqual(usageDataSent.osPlatform, os.platform());
     assert.deepStrictEqual(usageDataSent.osRelease, os.release());
+    assert.deepStrictEqual(
+      usageDataSent.projectSetting.editor,
+      testNpmUserAgent
+    );
     assert.ok(validate(usageDataSent.sessionUuid));
     assert.ok(validate(usageDataSent.installationUuid));
     assert.ok(usageDataSent.error == undefined);
@@ -105,6 +120,10 @@ void describe('UsageDataEmitter', () => {
     assert.deepStrictEqual(usageDataSent.isCi, isCI);
     assert.deepStrictEqual(usageDataSent.osPlatform, os.platform());
     assert.deepStrictEqual(usageDataSent.osRelease, os.release());
+    assert.deepStrictEqual(
+      usageDataSent.projectSetting.editor,
+      testNpmUserAgent
+    );
     assert.ok(validate(usageDataSent.sessionUuid));
     assert.ok(validate(usageDataSent.installationUuid));
     assert.strictEqual(usageDataSent.error?.message, 'some error message');

packages/platform-core/src/usage-data/usage_data_emitter.ts

@@ -64,7 +64,7 @@ export class DefaultUsageDataEmitter implements UsageDataEmitter {
     metrics?: Record<string, number>;
     dimensions?: Record<string, string>;
     error?: AmplifyError;
-  }) => {
+  }): Promise<UsageData> => {
     return {
       accountId: await this.accountIdFetcher.fetch(),
       sessionUuid: this.sessionUuid,
@@ -86,6 +86,9 @@ export class DefaultUsageDataEmitter implements UsageDataEmitter {
       codePathDurations: this.translateMetricsToUsageData(options.metrics),
       input: this.translateDimensionsToUsageData(options.dimensions),
       isCi: isCI,
+      projectSetting: {
+        editor: process.env.npm_config_user_agent,
+      },
     };
   };