feat(plugin-assets): adds flag for setting service name in init (#286)

Author: philnash

packages/plugin-assets/package.json

@@ -12,7 +12,8 @@
     "@twilio-labs/serverless-api": "^5.1.0",
     "@twilio/cli-core": "^5.22.0",
     "inquirer": "^8.0.0",
-    "ora": "^5.4.0"
+    "ora": "^5.4.0",
+    "project-name-generator": "^2.1.9"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.22.2",

packages/plugin-assets/src/commands/assets/init.js

@@ -1,6 +1,8 @@
 const { flags } = require('@oclif/command');
 const { TwilioClientCommand } = require('@twilio/cli-core').baseCommands;
 const { getPluginConfig } = require('../../pluginConfig');
+const generateProjectName = require('project-name-generator');
+
 const { init } = require('../../init');
 
 class InitCommand extends TwilioClientCommand {
@@ -14,6 +16,7 @@ class InitCommand extends TwilioClientCommand {
         accountSid: this.currentProfile.accountSid,
         pluginConfig: pluginConfig,
         logger: this.logger,
+        serviceName: this.flags['service-name'],
       });
       this.output(result, this.flags.properties);
     } catch (error) {
@@ -23,6 +26,11 @@ class InitCommand extends TwilioClientCommand {
 }
 
 InitCommand.flags = {
+  'service-name': flags.string({
+    description:
+      'A unique name for your asset service. May only contain alphanumeric characters and hyphens.',
+    default: () => generateProjectName().dashed,
+  }),
   properties: flags.string({
     default: 'service_sid, sid, domain_name',
     description:

packages/plugin-assets/src/commands/assets/list.js

@@ -6,7 +6,6 @@ const { list } = require('../../list');
 class ListCommand extends TwilioClientCommand {
   async run() {
     await super.run();
-
     try {
       const pluginConfig = getPluginConfig(this);
       const assets = await list({

packages/plugin-assets/src/commands/assets/upload.js

@@ -8,14 +8,13 @@ class UploadCommand extends TwilioClientCommand {
     await super.run();
 
     try {
-      const { args } = this.parse(UploadCommand);
       const pluginConfig = getPluginConfig(this);
       const assets = await upload({
         apiKey: this.currentProfile.apiKey,
         apiSecret: this.currentProfile.apiSecret,
         accountSid: this.currentProfile.accountSid,
         pluginConfig: pluginConfig,
-        file: args.file,
+        file: this.args.file,
         logger: this.logger,
       });
       this.output(assets, this.flags.properties);

packages/plugin-assets/src/init.js

@@ -10,18 +10,31 @@ const { TwilioCliError } = require('@twilio/cli-core').services.error;
 
 const { couldNotGetEnvironment } = require('./errorMessages');
 
-const DEFAULT_ASSET_SERVICE_NAME = 'CLI-Assets-Bucket';
-
-async function createServiceAndEnvironment(client) {
-  const serviceSid = await createService(DEFAULT_ASSET_SERVICE_NAME, client);
+async function createServiceAndEnvironment(client, serviceName) {
+  const serviceSid = await createService(serviceName, client);
   const environment = await createEnvironmentFromSuffix('', serviceSid, client);
   return {
     serviceSid,
     environment,
   };
 }
 
-async function init({ apiKey, apiSecret, accountSid, pluginConfig, logger }) {
+function validateServiceName(serviceName) {
+  if (!serviceName.match(/^(?=.*$)[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*$/)) {
+    throw new TwilioCliError(
+      `Service name may only contain alphanumeric characters and hyphens.`
+    );
+  }
+}
+
+async function init({
+  apiKey,
+  apiSecret,
+  accountSid,
+  pluginConfig,
+  logger,
+  serviceName,
+}) {
   logger.debug('Loading config');
   const client = new TwilioServerlessApiClient({
     username: apiKey,
@@ -53,7 +66,11 @@ async function init({ apiKey, apiSecret, accountSid, pluginConfig, logger }) {
   } else {
     try {
       logger.debug('Creating new assets service and environment');
-      const serviceAndEnvironment = await createServiceAndEnvironment(client);
+      validateServiceName(serviceName);
+      const serviceAndEnvironment = await createServiceAndEnvironment(
+        client,
+        serviceName
+      );
       config[accountSid] = {
         serviceSid: serviceAndEnvironment.serviceSid,
         environmentSid: serviceAndEnvironment.environment.sid,
@@ -62,9 +79,13 @@ async function init({ apiKey, apiSecret, accountSid, pluginConfig, logger }) {
       return serviceAndEnvironment.environment;
     } catch (error) {
       logger.debug(error.toString());
-      throw new TwilioCliError(
-        `Could not create a new asset service for account ${accountSid}`
-      );
+      if (error.name === 'TwilioCliError') {
+        throw error;
+      } else {
+        throw new TwilioCliError(
+          `Could not create a new asset service for account ${accountSid}`
+        );
+      }
     }
   }
 }

packages/plugin-assets/tests/init.test.js

@@ -30,8 +30,6 @@ const mockLogger = {
   debug: jest.fn(),
 };
 
-const configPath = path.join(tmpdir(), 'scratch', 'plugin-assets-config.json');
-
 describe('init', () => {
   describe('with nothing in the config', () => {
     const fakeConfig = {
@@ -45,6 +43,7 @@ describe('init', () => {
         accountSid: 'test-account-sid',
         pluginConfig: fakeConfig,
         logger: mockLogger,
+        serviceName: 'test-asset-service',
       });
 
       expect(createEnvironmentFromSuffix).toHaveBeenCalledTimes(1);