Merge pull request #28 from twilio-labs/add-api-key-error

Add api key error

Author: timmydoza

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.5
+
+### Maintenance
+
+* Updated `twilio rtc:apps:video:deploy` command so that it checks for the existence of a necessary Twilio API Key before deploying the video token server.
+
 ## 0.1.4
 
 ### Maintenance

src/helpers.js

@@ -1,5 +1,6 @@
 const { APP_NAME, EXPIRY_PERIOD } = require('./constants');
 const { cli } = require('cli-ux');
+const { CLIError } = require('@oclif/errors');
 const fs = require('fs');
 const { getListOfFunctionsAndAssets } = require('@twilio-labs/serverless-api/dist/utils/fs');
 const moment = require('moment');
@@ -21,18 +22,18 @@ function verifyAppDirectory(dirpath) {
     const hasIndexHTML = [...dir].includes('index.html');
 
     if (!hasIndexHTML) {
-      throw new Error(
+      throw new CLIError(
         'The provided app-directory does not appear to be a valid app. There is no index.html found in the app-directory.'
       );
     }
   } catch (err) {
     switch (err.code) {
       case 'ENOENT':
-        throw new Error('The provided app-directory does not exist.');
+        throw new CLIError('The provided app-directory does not exist.');
       case 'ENOTDIR':
-        throw new Error('The provided app-directory is not a directory.');
+        throw new CLIError('The provided app-directory is not a directory.');
       default:
-        throw new Error(err.message);
+        throw new CLIError(err.message);
     }
   }
 }
@@ -112,6 +113,25 @@ async function displayAppInfo() {
 async function deploy() {
   const assets = this.flags['app-directory'] ? await getAssets(this.flags['app-directory']) : [];
 
+  if (this.twilioClient.username === this.twilioClient.accountSid) {
+    // When twilioClient.username equals twilioClient.accountSid, it means that the user
+    // authenticated with the Twilio CLI by providing their Account SID and Auth Token
+    // as environment variables. When this happens, the CLI does not create the required API
+    // key that is needed by the token server.
+
+    throw new CLIError(`No API Key found.
+
+Please login to the Twilio CLI to create an API key:
+
+twilio login
+
+Alternatively, the Twilio CLI can use credentials stored in these environment variables:
+
+TWILIO_ACCOUNT_SID = your Account SID from twil.io/console
+TWILIO_API_KEY = an API Key created at twil.io/get-api-key
+TWILIO_API_SECRET = the secret for the API Key`);
+  }
+
   const serverlessClient = new TwilioServerlessApiClient({
     accountSid: this.twilioClient.username,
     authToken: this.twilioClient.password,

test/helpers/helpers.test.js

@@ -265,4 +265,29 @@ describe('the deploy function', () => {
     expect(mockDeployProject.mock.calls[0][0].serviceSid).toBe(undefined);
     expect(mockDeployProject.mock.calls[0][0].serviceName).toBe(APP_NAME);
   });
+
+  it('should display an error when the API key is not provided', () => {
+    return expect(
+      deploy.call({
+        twilioClient: {
+          username: 'testAccountSid',
+          password: 'testAuthToken',
+          accountSid: 'testAccountSid',
+        },
+        flags: {},
+      })
+    ).rejects.toMatchInlineSnapshot(`
+[Error: No API Key found.
+
+Please login to the Twilio CLI to create an API key:
+
+twilio login
+
+Alternatively, the Twilio CLI can use credentials stored in these environment variables:
+
+TWILIO_ACCOUNT_SID = your Account SID from twil.io/console
+TWILIO_API_KEY = an API Key created at twil.io/get-api-key
+TWILIO_API_SECRET = the secret for the API Key]
+`);
+  });
 });