Merge pull request #109 from devsapp/fix-userAgent

fix: userAgent function

Author: rsonghuster

__tests__/ut/commands/layer_test.ts

@@ -123,6 +123,12 @@ jest.mock('../../../src/utils', () => ({
   calculateCRC64: jest.fn(),
   getFileSize: jest.fn(),
   isAppCenter: jest.fn(),
+  getUserAgent: jest.fn((userAgent, command) => {
+    return (
+      userAgent ||
+      `Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch};command:${command}`
+    );
+  }),
 }));
 
 describe('Layer', () => {

__tests__/ut/commands/remove/remove_test.ts

@@ -139,13 +139,10 @@ describe('Remove', () => {
     it('should execute remove successfully with basic function config', async () => {
       await remove.run();
 
-      expect(FC).toHaveBeenCalledWith(
-        'cn-hangzhou',
-        undefined,
-        expect.objectContaining({
-          userAgent: expect.stringContaining('command:remove'),
-        }),
-      );
+      expect(FC).toHaveBeenCalledWith('cn-hangzhou', undefined, {
+        endpoint: undefined,
+        userAgent: undefined,
+      });
       expect(mockFcInstance.getFunction).toHaveBeenCalledWith('test-function');
     });
 

__tests__/ut/commands/scaling/index_test.ts

@@ -20,6 +20,12 @@ jest.mock('../../../../src/resources/fc', () => {
 jest.mock('../../../../src/utils', () => ({
   promptForConfirmOrDetails: jest.fn(),
   isAppCenter: jest.fn(),
+  getUserAgent: jest.fn((userAgent, command) => {
+    return (
+      userAgent ||
+      `Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch};command:${command}`
+    );
+  }),
 }));
 
 describe('Scaling', () => {

__tests__/ut/commands/session_test.ts

@@ -17,6 +17,12 @@ jest.mock('../../../src/logger', () => ({
 jest.mock('../../../src/utils', () => ({
   promptForConfirmOrDetails: jest.fn(),
   isAppCenter: jest.fn(),
+  getUserAgent: jest.fn((userAgent, command) => {
+    return (
+      userAgent ||
+      `Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch};command:${command}`
+    );
+  }),
 }));
 
 describe('Session', () => {

__tests__/ut/commands/version_test.ts

@@ -30,6 +30,12 @@ jest.mock('../../../src/logger', () => {
 jest.mock('../../../src/utils', () => ({
   promptForConfirmOrDetails: jest.fn(),
   isAppCenter: jest.fn(),
+  getUserAgent: jest.fn((userAgent, command) => {
+    return (
+      userAgent ||
+      `Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch};command:${command}`
+    );
+  }),
 }));
 
 describe('Version', () => {

src/subCommands/alias/index.ts

@@ -4,7 +4,7 @@ import _ from 'lodash';
 import logger from '../../logger';
 import FC from '../../resources/fc';
 import commandsHelp from '../../commands-help/alias';
-import { isAppCenter, promptForConfirmOrDetails, tableShow } from '../../utils';
+import { getUserAgent, promptForConfirmOrDetails, tableShow } from '../../utils';
 
 const commandsList = Object.keys(commandsHelp.subCommands);
 
@@ -70,13 +70,10 @@ export default class Alias {
     this.versionId = versionId;
     this.additionalVersionWeight = additionalVersionWeight;
 
-    const function_ai = isAppCenter() ? 'function_ai;' : '';
+    const userAgent = getUserAgent(inputs.userAgent, 'alias');
     this.fcSdk = new FC(this.region, inputs.credential, {
       endpoint: inputs.props.endpoint,
-      userAgent: `${
-        inputs.userAgent ||
-        `${function_ai}Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch}`
-      }command:alias`,
+      userAgent,
     });
   }
 

src/subCommands/build/impl/defaultBuilder.ts

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import * as path from 'path';
 
 import { Builder } from './baseBuilder';
-import { runCommand, isAppCenter, isYunXiao } from '../../../utils';
+import { runCommand, isAppCenter, isYunXiao, getUserAgent } from '../../../utils';
 import logger from '../../../logger';
 import { buildPythonLocalPath } from '../../../default/image';
 import { parseArgv } from '@serverless-devs/utils';
@@ -112,13 +112,10 @@ export class DefaultBuilder extends Builder {
     logger.debug(`${region}`);
     checkRegion(region);
     const credential = (await this.inputs.getCredential()) as ICredentials;
-    const function_ai = isAppCenter() ? 'function_ai;' : '';
+    const userAgent = getUserAgent(this.inputs.userAgent, 'build-publish-layer');
     const fcSdk = new FC(region, credential, {
       endpoint: this.getProps().endpoint,
-      userAgent: `${
-        this.inputs.userAgent ||
-        `${function_ai}Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch}`
-      }command:build-publish-layer`,
+      userAgent,
     });
     let buildDir: string = this.getBuildDir();
     buildDir = path.isAbsolute(buildDir) ? buildDir : path.join(this.baseDir, buildDir);

src/subCommands/concurrency/index.ts

@@ -4,7 +4,7 @@ import { IInputs, IRegion, checkRegion } from '../../interface';
 import logger from '../../logger';
 import _ from 'lodash';
 import FC from '../../resources/fc';
-import { promptForConfirmOrDetails } from '../../utils';
+import { getUserAgent, promptForConfirmOrDetails } from '../../utils';
 
 const commandsList = Object.keys(commandsHelp.subCommands);
 
@@ -53,12 +53,10 @@ export default class Concurrency {
     this.yes = !!yes;
     this.subCommand = subCommand;
 
+    const userAgent = getUserAgent(inputs.userAgent, 'concurrency');
     this.fcSdk = new FC(this.region, inputs.credential, {
       endpoint: inputs.props.endpoint,
-      userAgent: `${
-        inputs.userAgent ||
-        `serverless-devs;Nodejs:${process.version};OS:${process.platform}-${process.arch}`
-      }command:concurrency`,
+      userAgent,
     });
   }
 

src/subCommands/deploy/impl/base.ts

@@ -1,21 +1,18 @@
 import { ICredentials } from '@serverless-devs/component-interface';
 import { IInputs } from '../../../interface';
 import FC from '../../../resources/fc';
-import { isAppCenter } from '../../../utils';
+import { getUserAgent } from '../../../utils';
 
 export default abstract class Base {
   readonly fcSdk: FC;
   needDeploy: boolean | undefined;
 
   constructor(readonly inputs: IInputs, needDeploy: boolean | undefined) {
     this.needDeploy = needDeploy;
-    const function_ai = isAppCenter() ? 'function_ai;' : '';
+    const userAgent = getUserAgent(inputs.userAgent, 'deploy');
     this.fcSdk = new FC(inputs.props.region, inputs.credential as ICredentials, {
       endpoint: inputs.props.endpoint,
-      userAgent: `${
-        inputs.userAgent ||
-        `${function_ai}Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch}`
-      }command:deploy`,
+      userAgent,
     });
   }
 

src/subCommands/info/index.ts

@@ -6,7 +6,7 @@ import FC, { GetApiType } from '../../resources/fc';
 import logger from '../../logger';
 import { parseArgv } from '@serverless-devs/utils';
 import loadComponent from '@serverless-devs/load-component';
-import { isAppCenter, transformCustomDomainProps } from '../../utils';
+import { getUserAgent, transformCustomDomainProps } from '../../utils';
 import { FC3_DOMAIN_COMPONENT_NAME } from '../../constant';
 
 export default class Info {
@@ -38,13 +38,10 @@ export default class Info {
       throw new Error('functionName not specified, please specify --function-name');
     }
     this.triggersName = _.get(inputs, 'props.triggers', []).map((item) => item.triggerName);
-    const function_ai = isAppCenter() ? 'function_ai;' : '';
+    const userAgent = getUserAgent(inputs.userAgent, 'info');
     this.fcSdk = new FC(this.region, this.inputs.credential as ICredentials, {
       endpoint: inputs.props.endpoint,
-      userAgent: `${
-        inputs.userAgent ||
-        `${function_ai}Component:fc3;Nodejs:${process.version};OS:${process.platform}-${process.arch}`
-      }command:info`,
+      userAgent,
     });
     this.getApiType = GetApiType.simple;
   }