AHOYAPPS-489 Update override behavior (#19)

Aaron Alaniz · Tim Mendoza · web-flow · commit b2def3eb882c · 2020-03-24T11:53:28.000-05:00
* Enable overriding an existing token server without delete

* Add support for overriding assets

* Add test to validate override after app deploy

* Address PR feedback

* Remove superfluous definition

* Add unit tests for deploy function

Co-authored-by: Tim Mendoza &lt;tmendoza@twilio.com&gt;
diff --git a/src/commands/rtc/apps/video/deploy.js b/src/commands/rtc/apps/video/deploy.js
@@ -15,23 +15,17 @@ class DeployCommand extends TwilioClientCommand {
       }
     }
 
-    const appInfo = await getAppInfo.call(this);
+    this.appInfo = await getAppInfo.call(this);
 
-    if (appInfo) {
-      if (this.flags.override) {
-        await this.twilioClient.serverless.services(appInfo.sid).remove();
-        console.log(`Removed app with Passcode: ${appInfo.passcode}`);
-      } else {
-        console.log('A Video app is already deployed. Use the --override flag to override the existing deployment.');
-        await displayAppInfo.call(this);
-        return;
-      }
+    if (this.appInfo && !this.flags.override) {
+      console.log('A Video app is already deployed. Use the --override flag to override the existing deployment.');
+      await displayAppInfo.call(this);
+      return;
     }
     await deploy.call(this);
     await displayAppInfo.call(this);
   }
 }
-
 DeployCommand.flags = Object.assign(
   {
     'app-directory': flags.string({
diff --git a/src/helpers.js b/src/helpers.js
@@ -48,10 +48,12 @@ async function getAssets(folder) {
   assets.push({
     ...indexHTML,
     path: '/',
+    name: '/',
   });
   assets.push({
     ...indexHTML,
     path: '/login',
+    name: '/login',
   });
 
   return assets;
@@ -130,7 +132,6 @@ async function deploy() {
       API_PASSCODE_EXPIRY: expiryTime,
     },
     pkgJson: {},
-    serviceName: APP_NAME,
     functionsEnv: 'dev',
     functions: [
       {
@@ -143,6 +144,12 @@ async function deploy() {
     assets: assets,
   };
 
+  if (this.appInfo && this.appInfo.sid) {
+    deployOptions.serviceSid = this.appInfo.sid;
+  } else {
+    deployOptions.serviceName = APP_NAME;
+  }
+
   try {
     await serverlessClient.deployProject(deployOptions);
     cli.action.stop();
diff --git a/test/e2e/e2e.test.js b/test/e2e/e2e.test.js
@@ -148,6 +148,41 @@ describe('the RTC Twilio-CLI Plugin', () => {
         stdout.stop();
         expect(stdout.output).toContain('A Video app is already deployed. Use the --override flag to override the existing deployment.');
       });
+
+      it('should redeploy the app when --override flag is passed', async () => {
+        stdout.start();
+        await DeployCommand.run([
+          '--authentication',
+          'passcode',
+          '--override',
+          '--app-directory',
+          path.join(__dirname, '../test-assets'),
+        ]);
+        stdout.stop();
+        const updatedPasscode = getPasscode(stdout.output);
+        const testURL = getURL(stdout.output);
+        const testWebAppURL = getWebAppURL(stdout.output);
+        expect(updatedPasscode).not.toEqual(passcode)
+        expect(testURL).toEqual(URL)
+        const { text } = await superagent.get(testWebAppURL + '/login');
+        expect(text).toEqual('<html>test</html>');
+      });
+
+      it('should redeploy the token server when no app-directory is set and when --override flag is true', async () => {
+        stdout.start();
+        await DeployCommand.run([
+          '--authentication',
+          'passcode',
+          '--override',
+        ]);
+        stdout.stop();
+        const updatedPasscode = getPasscode(stdout.output);
+        const testURL = getURL(stdout.output);
+        const testWebAppURL = getWebAppURL(stdout.output);
+        expect(updatedPasscode).not.toEqual(passcode)
+        expect(testURL).toEqual(URL)
+        superagent.get(`${testWebAppURL}`).catch(e => expect(e.status).toBe(404));
+      });
     });
   });
 
@@ -202,6 +237,26 @@ describe('the RTC Twilio-CLI Plugin', () => {
       it('should return a 404 from "/"', () => {
         superagent.get(`${URL}`).catch(e => expect(e.status).toBe(404));
       });
+
+      it('should redeploy the token server when --override flag is passed', async () => {
+        stdout.start();
+        await DeployCommand.run([
+          '--authentication',
+          'passcode',
+          '--override',
+        ]);
+        stdout.stop();
+
+        const updatedPasscode = getPasscode(stdout.output);
+        const testURL = getURL(stdout.output);
+        expect(updatedPasscode).not.toEqual(passcode)
+        expect(testURL).toEqual(URL)
+
+        const { body } = await superagent
+          .post(`${testURL}/token`)
+          .send({ passcode: updatedPasscode, room_name: 'test-room', user_identity: 'test user' });
+        expect(jwt.decode(body.token).grants).toEqual({ identity: 'test user', video: { room: 'test-room' } });
+      });
     });
   });
 });
diff --git a/test/helpers/helpers.test.js b/test/helpers/helpers.test.js
@@ -1,5 +1,6 @@
 const { APP_NAME } = require('../../src/constants');
 const {
+  deploy,
   displayAppInfo,
   findApp,
   getAppInfo,
@@ -12,6 +13,16 @@ const { getListOfFunctionsAndAssets } = require('@twilio-labs/serverless-api/dis
 const path = require('path');
 const { stdout } = require('stdout-stderr');
 
+const mockDeployProject = jest.fn(() => Promise.resolve());
+
+jest.mock('@twilio-labs/serverless-api', () => ({
+  TwilioServerlessApiClient: function() {
+    return {
+      deployProject: mockDeployProject,
+    };
+  },
+}));
+
 jest.mock('@twilio-labs/serverless-api/dist/utils/fs', () => ({
   getListOfFunctionsAndAssets: jest.fn(() => ({
     assets: [
@@ -98,12 +109,12 @@ describe('the getAssets function', () => {
         content: 'mockHTMLcontent',
       },
       {
-        name: 'index.html',
+        name: '/',
         path: '/',
         content: 'mockHTMLcontent',
       },
       {
-        name: 'index.html',
+        name: '/login',
         path: '/login',
         content: 'mockHTMLcontent',
       },
@@ -225,3 +236,33 @@ describe('the displayAppInfo function', () => {
 `);
   });
 });
+
+describe('the deploy function', () => {
+  it('should set serviceSid when appInfo exists', async () => {
+    await deploy.call({
+      twilioClient: {
+        username: '',
+        password: '',
+      },
+      appInfo: {
+        sid: '1234',
+      },
+      flags: {},
+    });
+
+    expect(mockDeployProject.mock.calls[0][0].serviceSid).toBe('1234');
+    expect(mockDeployProject.mock.calls[0][0].serviceName).toBe(undefined);
+  });
+
+  it('should set serviceName when appInfo doesnt exist', async () => {
+    await deploy.call({
+      twilioClient: {
+        username: '',
+        password: '',
+      },
+      flags: {},
+    });
+    expect(mockDeployProject.mock.calls[0][0].serviceSid).toBe(undefined);
+    expect(mockDeployProject.mock.calls[0][0].serviceName).toBe(APP_NAME);
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -15,23 +15,17 @@ class DeployCommand extends TwilioClientCommand {`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`
`18`		`- const appInfo = await getAppInfo.call(this);`
	`18`	`+ this.appInfo = await getAppInfo.call(this);`
`19`	`19`
`20`		`- if (appInfo) {`
`21`		`- if (this.flags.override) {`
`22`		`- await this.twilioClient.serverless.services(appInfo.sid).remove();`
`23`		- console.log(`Removed app with Passcode: ${appInfo.passcode}`);
`24`		`- } else {`
`25`		`- console.log('A Video app is already deployed. Use the --override flag to override the existing deployment.');`
`26`		`- await displayAppInfo.call(this);`
`27`		`- return;`
`28`		`- }`
	`20`	`+ if (this.appInfo && !this.flags.override) {`
	`21`	`+ console.log('A Video app is already deployed. Use the --override flag to override the existing deployment.');`
	`22`	`+ await displayAppInfo.call(this);`
	`23`	`+ return;`
`29`	`24`	`}`
`30`	`25`	`await deploy.call(this);`
`31`	`26`	`await displayAppInfo.call(this);`
`32`	`27`	`}`
`33`	`28`	`}`
`34`		`-`
`35`	`29`	`DeployCommand.flags = Object.assign(`
`36`	`30`	`{`
`37`	`31`	`'app-directory': flags.string({`