refactor(serverless-api): update user-agent string for better debugging

packages/plugin-assets/src/client.js

@@ -0,0 +1,12 @@
+const pkgJson = require('../package.json');
+const { TwilioServerlessApiClient } = require('@twilio-labs/serverless-api');
+
+function getTwilioClient(apiKey, apiSecret) {
+  return new TwilioServerlessApiClient({
+    username: apiKey,
+    password: apiSecret,
+    userAgentExtensions: [`@twilio-labs/plugin-assets/${pkgJson.version}`],
+  });
+}
+
+module.exports = { getTwilioClient: getTwilioClient };

packages/plugin-assets/src/init.js

@@ -1,4 +1,3 @@
-const { TwilioServerlessApiClient } = require('@twilio-labs/serverless-api');
 const {
   createService,
 } = require('@twilio-labs/serverless-api/dist/api/services');
@@ -9,6 +8,7 @@ const {
 const { TwilioCliError } = require('@twilio/cli-core').services.error;
 
 const { couldNotGetEnvironment } = require('./errorMessages');
+const { getTwilioClient } = require('./client');
 
 async function createServiceAndEnvironment(client, serviceName) {
   const serviceSid = await createService(serviceName, client);
@@ -36,10 +36,7 @@ async function init({
   serviceName,
 }) {
   logger.debug('Loading config');
-  const client = new TwilioServerlessApiClient({
-    username: apiKey,
-    password: apiSecret,
-  });
+  const client = getTwilioClient(apiKey, apiSecret);
   const config = await pluginConfig.getConfig();
   if (
     config[accountSid] &&

packages/plugin-assets/src/list.js

@@ -1,10 +1,10 @@
-const { TwilioServerlessApiClient } = require('@twilio-labs/serverless-api');
 const {
   getEnvironment,
 } = require('@twilio-labs/serverless-api/dist/api/environments');
 const { getBuild } = require('@twilio-labs/serverless-api/dist/api/builds');
 const { TwilioCliError } = require('@twilio/cli-core').services.error;
 const { couldNotGetEnvironment, couldNotGetBuild } = require('./errorMessages');
+const { getTwilioClient } = require('./client');
 
 async function list({ pluginConfig, apiKey, apiSecret, accountSid, logger }) {
   let environment;
@@ -15,10 +15,7 @@ async function list({ pluginConfig, apiKey, apiSecret, accountSid, logger }) {
     config[accountSid].environmentSid
   ) {
     const { serviceSid, environmentSid } = config[accountSid];
-    const client = new TwilioServerlessApiClient({
-      username: apiKey,
-      password: apiSecret,
-    });
+    const client = getTwilioClient(apiKey, apiSecret);
     try {
       logger.debug(
         `Fetching environment with sid ${environmentSid} from service with sid ${serviceSid}`

packages/plugin-assets/src/upload.js

@@ -1,6 +1,5 @@
 const ora = require('ora');
 const inquirer = require('inquirer');
-const { TwilioServerlessApiClient } = require('@twilio-labs/serverless-api');
 const { TwilioCliError } = require('@twilio/cli-core').services.error;
 const {
   getEnvironment,
@@ -31,6 +30,8 @@ const {
   debugFlagMessage,
 } = require('./errorMessages');
 
+const { getTwilioClient } = require('./client');
+
 function getUtils(spinner, logger) {
   function debug(message) {
     const wasSpinning = spinner.isSpinning;
@@ -328,10 +329,7 @@ async function upload({
     config[accountSid].environmentSid
   ) {
     const { serviceSid, environmentSid } = config[accountSid];
-    const client = new TwilioServerlessApiClient({
-      username: apiKey,
-      password: apiSecret,
-    });
+    const client = getTwilioClient(apiKey, apiSecret);
     const environment = await getEnvironmentWithClient(
       client,
       environmentSid,

packages/plugin-serverless/src/utils.js

@@ -1,6 +1,7 @@
 const path = require('path');
 const camelCase = require('lodash.camelcase');
 const { flags } = require('@oclif/command');
+const pkgJson = require('../package.json');
 
 function convertYargsOptionsToOclifFlags(options) {
   const aliasMap = new Map();
@@ -73,6 +74,10 @@ function normalizeFlags(flags, aliasMap, argv) {
 
 function createExternalCliOptions(flags, twilioClient) {
   const profile = flags.profile;
+  const pluginInfo = {
+    version: pkgJson.version,
+    name: pkgJson.name,
+  };
 
   if (
     (typeof flags.username === 'string' && flags.username.length > 0) ||
@@ -85,6 +90,7 @@ function createExternalCliOptions(flags, twilioClient) {
       profile: undefined,
       logLevel: undefined,
       outputFormat: undefined,
+      pluginInfo,
     };
   }
 
@@ -95,6 +101,7 @@ function createExternalCliOptions(flags, twilioClient) {
     profile,
     logLevel: undefined,
     outputFormat: undefined,
+    pluginInfo,
   };
 }
 

packages/serverless-api/src/client.ts

@@ -67,6 +67,7 @@ import {
 import { DeployStatus } from './types/consts';
 import { ClientApiError, convertApiErrorsAndThrow } from './utils/error';
 import { getListOfFunctionsAndAssets, SearchConfig } from './utils/fs';
+import getUserAgent from './utils/user-agent';
 
 const log = debug('twilio-serverless-api:client');
 
@@ -87,7 +88,7 @@ export function createGotClient(config: ClientConfig): GotClient {
     username: username,
     password: password,
     headers: {
-      'User-Agent': 'twilio-serverless-api',
+      'User-Agent': getUserAgent(config.userAgentExtensions),
     },
   }) as GotClient;
   if (process.env.HTTP_PROXY) {
@@ -137,6 +138,7 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
     debug.enable(process.env.DEBUG || '');
     super();
     this.config = config;
+
     this.client = createGotClient(config);
     this.limit = pLimit(config.concurrency || CONCURRENCY);
   }
@@ -343,8 +345,13 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
    */
   async activateBuild(activateConfig: ActivateConfig): Promise<ActivateResult> {
     try {
-      let { buildSid, targetEnvironment, serviceSid, sourceEnvironment, env } =
-        activateConfig;
+      let {
+        buildSid,
+        targetEnvironment,
+        serviceSid,
+        sourceEnvironment,
+        env,
+      } = activateConfig;
 
       if (!buildSid && !sourceEnvironment) {
         const error = new Error(
@@ -685,6 +692,7 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
       statusCodes: [429],
       errorCodes: [],
     };
+
     return this.limit(() => this.client[method](path, options));
   }
 }

packages/serverless-api/src/types/client.ts

@@ -17,6 +17,10 @@ type BaseClientConfig = {
    * Number of retry attempts the client will make on a failure
    */
   retryLimit?: number;
+  /**
+   * Additional information to pass to the User-Agent. !!!Should not contain sensitive information
+   */
+  userAgentExtensions?: string[];
 };
 
 export type AccountSidConfig = BaseClientConfig & {

packages/serverless-api/src/utils/__tests__/package-info.test.ts

@@ -0,0 +1,6 @@
+import pkgJson from '../package-info';
+
+test('imports package.json information', () => {
+  const pkgJsonSource = require('../../../package.json');
+  expect(pkgJson).toEqual(pkgJsonSource);
+});

packages/serverless-api/src/utils/__tests__/user-agent.test.ts

@@ -0,0 +1,39 @@
+import { getUserAgent } from '../user-agent';
+
+jest.mock('../package-info', () => {
+  return {
+    name: '@twilio-labs/serverless-api-test',
+    version: '1.0.0-test',
+  };
+});
+
+jest.mock('os', () => {
+  return {
+    platform: () => 'darwin',
+    arch: () => 'x64',
+  };
+});
+
+const nodeVersion = process.version;
+
+describe('getUserAgent', () => {
+  test('should return the right base information', () => {
+    expect(getUserAgent()).toEqual(
+      `@twilio-labs/serverless-api-test/1.0.0-test (darwin x64) node/${nodeVersion}`
+    );
+  });
+
+  test('adds extensions and correctly resets extensions', () => {
+    expect(
+      getUserAgent([
+        'twilio-run/2.0.0-test',
+        '@twilio-labs/plugin-serverless/1.1.0-test',
+      ])
+    ).toEqual(
+      `@twilio-labs/serverless-api-test/1.0.0-test (darwin x64) node/${nodeVersion} twilio-run/2.0.0-test @twilio-labs/plugin-serverless/1.1.0-test`
+    );
+    expect(getUserAgent()).toEqual(
+      `@twilio-labs/serverless-api-test/1.0.0-test (darwin x64) node/${nodeVersion}`
+    );
+  });
+});

packages/serverless-api/src/utils/package-info.ts

@@ -0,0 +1,9 @@
+import fs from 'fs';
+import path from 'path';
+import { PackageJson } from 'type-fest';
+
+const pkgJson: PackageJson = JSON.parse(
+  fs.readFileSync(path.resolve(__dirname, '../../package.json'), 'utf8')
+);
+
+export default pkgJson;

packages/serverless-api/src/utils/user-agent.ts

@@ -0,0 +1,15 @@
+import os from 'os';
+import pkgJson from './package-info';
+
+export function getUserAgent(extensions: string[] = []) {
+  const name = pkgJson.name || '@twilio-labs/serverless-api';
+  const version = pkgJson.version || '0.0.0';
+  const osName = os.platform() || 'unknown';
+  const osArch = os.arch() || 'unknown';
+  const nodeVersion = process.version || '0.0.0';
+  const extensionString =
+    extensions.length > 0 ? ' ' + extensions.join(' ') : '';
+  return `${name}/${version} (${osName} ${osArch}) node/${nodeVersion}${extensionString}`;
+}
+
+export default getUserAgent;

packages/serverless-twilio-runtime/util/util.js

@@ -2,11 +2,12 @@
 
 const {
   TwilioServerlessApiClient,
-  utils
+  utils,
 } = require('@twilio-labs/serverless-api');
 const path = require('path');
 const { readFile } = utils;
 const { logMessage } = require('./log');
+const pkgJson = require('../package.json');
 
 /**
  * Initialize the Twilio client and attach serverless logging to it
@@ -19,10 +20,13 @@ function getTwilioClient(serverless) {
 
   const client = new TwilioServerlessApiClient({
     accountSid,
-    authToken
+    authToken,
+    userAgentExtensions: [
+      `@twilio-labs/serverless-twilio-runtime/${pkgJson.version}`,
+    ],
   });
 
-  client.on('status-update', evt => {
+  client.on('status-update', (evt) => {
     logMessage(serverless, evt.message);
   });
 
@@ -40,13 +44,13 @@ async function getTwilioDeployConfig(serverless, options = {}) {
   const config = {
     env: serverless.service.provider.environmentVars || {},
     pkgJson: {
-      dependencies: serverless.service.provider.dependencies
+      dependencies: serverless.service.provider.dependencies,
     },
     serviceName: serverless.service.service,
     functionsEnv: serverless.service.provider.environment || 'dev',
     assets: [],
     functions: [],
-    overrideExistingService: true
+    overrideExistingService: true,
   };
 
   if (serverless.service.functions) {
@@ -134,11 +138,11 @@ async function getEnvironment(
 ) {
   const { environments } = await twilioServerlessClient.list({
     types: ['environments'],
-    serviceName
+    serviceName,
   });
 
   const environment = environments.find(
-    env => env.domain_suffix === environmentName
+    (env) => env.domain_suffix === environmentName
   );
 
   if (!environment) {
@@ -154,5 +158,5 @@ module.exports = {
   getEnvironment,
   getTwilioClient,
   getTwilioDeployConfig,
-  readFile
+  readFile,
 };

packages/twilio-run/src/commands/shared.ts

@@ -6,4 +6,8 @@ export type ExternalCliOptions = {
   project?: string;
   logLevel?: string;
   outputFormat?: string;
+  pluginInfo?: {
+    name: string;
+    version: string;
+  };
 };

packages/twilio-run/src/config/deploy.ts

@@ -18,6 +18,7 @@ import {
   readPackageJsonContent,
 } from './utils';
 import { mergeFlagsAndConfig } from './utils/mergeFlagsAndConfig';
+import { getUserAgentExtensions } from './utils/userAgentExtensions';
 
 export type DeployLocalProjectConfig = ApiDeployLocalProjectConfig & {
   username: string;
@@ -131,5 +132,6 @@ export async function getConfigFromFlags(
     region,
     edge,
     runtime,
+    userAgentExtensions: getUserAgentExtensions('deploy', externalCliOptions),
   };
 }

packages/twilio-run/src/config/list.ts

@@ -18,6 +18,7 @@ import {
   readLocalEnvFile,
 } from './utils';
 import { mergeFlagsAndConfig } from './utils/mergeFlagsAndConfig';
+import { getUserAgentExtensions } from './utils/userAgentExtensions';
 
 export type ListConfig = ApiListConfig & {
   username: string;
@@ -99,11 +100,12 @@ export async function getConfigFromFlags(
     serviceName,
     environment: flags.environment,
     properties: flags.properties
-      ? flags.properties.split(',').map(x => x.trim())
+      ? flags.properties.split(',').map((x) => x.trim())
       : undefined,
     extendedOutput: flags.extendedOutput,
     types,
     region,
     edge,
+    userAgentExtensions: getUserAgentExtensions('list', externalCliOptions),
   };
 }

packages/twilio-run/src/config/logs.ts

@@ -16,6 +16,7 @@ import { getFunctionServiceSid } from '../serverless-api/utils';
 import { readSpecializedConfig } from './global';
 import { getCredentialsFromFlags, readLocalEnvFile } from './utils';
 import { mergeFlagsAndConfig } from './utils/mergeFlagsAndConfig';
+import { getUserAgentExtensions } from './utils/userAgentExtensions';
 
 export type LogsConfig = ClientConfig &
   ApiLogsConfig & {
@@ -104,5 +105,6 @@ export async function getConfigFromFlags(
     region,
     edge,
     logCacheSize: flags.logCacheSize,
+    userAgentExtensions: getUserAgentExtensions('logs', externalCliOptions),
   };
 }