Merge pull request #40 from twilio-labs/support-room-type

Support room type

Author: timmydoza

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.0
+
+### Enhancements
+
+- This version adds the ability to specify the room type when deploying a video application token server. Use the `--room-type` flag when deploying the app. For example: `twilio rtc:apps:video:deploy --authentication passcode --room-type group-small`. The payload returned by the token server will also include the room type (see the [readme](README.md) for details). The `--room-type` flag is optional and the default value is `group`.
+
 ## 0.2.0
 
 ### Breaking Change

README.md

@@ -90,11 +90,12 @@ POST /token
 
 ###### Parameters
 
-| Name            | Type     | Description                                                                            |
-| --------------- | -------- | -------------------------------------------------------------------------------------- |
-| `passcode`      | `string` | **Required**. The application passcode.                                                |
-| `user_identity` | `string` | **Required**. The user's identity.                                                     |
-| `room_name`     | `string` | A room name that will be used to create a token scoped to connecting to only one room. |
+| Name            | Type      | Description                                                                            |
+| --------------- | --------- | -------------------------------------------------------------------------------------- |
+| `passcode`      | `string`  | **Required**. The application passcode.                                                |
+| `user_identity` | `string`  | **Required**. The user's identity.                                                     |
+| `room_name`     | `string`  | A room name that will be used to create a token scoped to connecting to only one room. |
+| `create_room`   | `boolean` | (default: `true`) When false, a room will not be created when a token is requested.    |
 
 ###### Success Responses
 
@@ -108,7 +109,8 @@ POST /token
 
 ```json
 {
-  "token": "0000000000000000.0000000000000000000000.00000000000000000"
+  "token": "0000000000000000.0000000000000000000000.00000000000000000",
+  "room_type": "group" | "group-small" | "peer-to-peer" | null
 }
 ```
 
@@ -172,6 +174,19 @@ POST /token
 </td>
 </tr>
 
+<tr>
+<td> 400 </td>
+<td>
+
+```json
+{
+  "error": {
+    "message": "invalid parameter",
+    "explanation": "A boolean value must be provided for the create_room parameter"
+  }
+}
+```
+
 </table>
 
 ## Commands
@@ -208,11 +223,12 @@ USAGE
   $ twilio rtc:apps:video:deploy --authentication <auth>
 
 OPTIONS
-  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
-  -p, --profile=profile            Shorthand identifier for your profile.
-  --app-directory=app-directory    Name of app directory to use
-  --authentication=(passcode)      (required) Type of authentication to use
-  --override                       Override an existing App deployment
+  -l=(debug|info|warn|error|none)               [default: info] Level of logging messages.
+  -p, --profile=profile                         Shorthand identifier for your profile.
+  --app-directory=app-directory                 Name of app directory to use
+  --authentication=(passcode)                   (required) Type of authentication to use
+  --override                                    Override an existing App deployment
+  --room-type=(group|group-small|peer-to-peer)  [default: group] Set room type
 
 DESCRIPTION
   This command publishes two components as a Twilio Function: an application token
@@ -233,21 +249,33 @@ EXAMPLES
   $ twilio rtc:apps:video:deploy --authentication passcode
   deploying app... done
   Passcode: xxx xxx xxxx xxxx
+  Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+  Room Type: group
 
   # Deploy an application token server with the React app
   $ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
   deploying app... done
   Web App URL: https://video-app-xxxx-xxxx-dev.twil.io?passcode=xxxxxxxxxxxxxx
   Passcode: xxx xxx xxxx xxxx
+  Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+  Room Type: group
 
   # Override an existing app with a fresh deployment
   # Please note that this will remove a previously deployed web application if no
   # app directory is provided
   $ twilio rtc:apps:video:deploy --authentication passcode --override
   Removed app with Passcode: xxx xxx xxxx xxxx
   deploying app... done
+  Passcode: yyy yyy yyyy yyyy
+  Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+  Room Type: group
+
+  # Deploy an application token server with a specific room type
+  $ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
+  deploying app... done
   Passcode: xxx xxx xxxx xxxx
   Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+  Room Type: peer-to-peer
 ```
 
 ## `twilio rtc:apps:video:view`
@@ -266,6 +294,7 @@ EXAMPLE
   $ twilio rtc:apps:video:view
   Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
   Passcode: xxx xxx xxxx xxxx
+  Room Type: group
 ```
 
 <!-- commandsstop -->

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@twilio-labs/plugin-rtc",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A Twilio-CLI plugin for real-time communication apps",
   "main": "index.js",
   "publishConfig": {
@@ -22,6 +22,7 @@
     "@oclif/plugin-help": "^2",
     "@twilio-labs/serverless-api": "^4.0.1",
     "@twilio/cli-core": "^5.8.0",
+    "lodash": "^4.17.20",
     "moment": "^2.24.0",
     "nanoid": "^3.1.12"
   },
@@ -35,7 +36,8 @@
     "jest": "^25.1.0",
     "lint-staged": "^10.0.8",
     "prettier": "^1.19.1",
-    "superagent": "^5.2.2"
+    "superagent": "^5.2.2",
+    "twilio": "^3.48.2"
   },
   "eslintConfig": {
     "extends": "eslint:recommended",

package.json

@@ -42,6 +42,12 @@ DeployCommand.flags = Object.assign(
       default: false,
       description: 'Override an existing App deployment',
     }),
+    'room-type': flags.enum({
+      options: ['group', 'group-small', 'peer-to-peer'],
+      description: 'Type of room to use',
+      required: false,
+      default: 'group',
+    }),
   },
   TwilioClientCommand.flags
 );
@@ -68,22 +74,34 @@ DeployCommand.examples = [
   `# Deploy an application token server with passcode authentication
 $ twilio rtc:apps:video:deploy --authentication passcode
 deploying app... done
-Passcode: 1111111111`,
+Passcode: xxx xxx xxxx xxxx
+Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+Room Type: group`,
   `
 # Deploy an application token server with the React app
 $ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
 deploying app... done
-Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
-Passcode: 1111111111`,
+Web App URL: https://video-app-xxxx-xxxx-dev.twil.io?passcode=xxxxxxxxxxxxxx
+Passcode: xxx xxx xxxx xxxx
+Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+Room Type: group`,
   `
 # Override an existing app with a fresh deployment
 # Please note that this will remove a previously deployed web application if no
 # app directory is provided
 $ twilio rtc:apps:video:deploy --authentication passcode --override 
-Removed app with Passcode: 1111111111
+Removed app with Passcode: xxx xxx xxxx xxxx
+deploying app... done
+Passcode: yyy yyy yyyy yyyy
+Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+Room Type: group`,
+  `
+# Deploy an application token server with a specific room type
+$ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
 deploying app... done
-Passcode: 2222222222
-Expires: Mon Mar 09 2020 16:36:23 GMT-0600`,
+Passcode: xxx xxx xxxx xxxx
+Expires: Mon Mar 09 2020 16:36:23 GMT-0600
+Room Type: peer-to-peer`,
 ];
 
 module.exports = DeployCommand;

src/commands/rtc/apps/video/deploy.js

@@ -81,9 +81,11 @@ async function getAppInfo() {
 
   const passcodeVar = variables.find(v => v.key === 'API_PASSCODE');
   const expiryVar = variables.find(v => v.key === 'API_PASSCODE_EXPIRY');
+  const roomTypeVar = variables.find(v => v.key === 'ROOM_TYPE');
 
   const passcode = passcodeVar ? passcodeVar.value : '';
   const expiry = expiryVar ? expiryVar.value : '';
+  const roomType = roomTypeVar ? roomTypeVar.value : '';
 
   const fullPasscode = getPasscode(environment.domainName, passcode);
 
@@ -93,6 +95,7 @@ async function getAppInfo() {
     sid: app.sid,
     passcode: fullPasscode,
     hasAssets: Boolean(assets.length),
+    roomType,
   };
 }
 
@@ -107,8 +110,13 @@ async function displayAppInfo() {
   if (appInfo.hasAssets) {
     console.log(`Web App URL: ${appInfo.url}`);
   }
+
   console.log(`Passcode: ${appInfo.passcode.replace(/(\d{3})(\d{3})(\d{4})(\d{4})/, '$1 $2 $3 $4')}`);
   console.log(`Expires: ${appInfo.expiry}`);
+
+  if (appInfo.roomType) {
+    console.log(`Room Type: ${appInfo.roomType}`);
+  }
 }
 
 async function deploy() {
@@ -151,6 +159,7 @@ TWILIO_API_SECRET = the secret for the API Key`);
       TWILIO_API_KEY_SECRET: this.twilioClient.password,
       API_PASSCODE: pin,
       API_PASSCODE_EXPIRY: expiryTime,
+      ROOM_TYPE: this.flags['room-type'],
     },
     pkgJson: {},
     functionsEnv: 'dev',

src/helpers.js

@@ -5,22 +5,34 @@ const AccessToken = Twilio.jwt.AccessToken;
 const VideoGrant = AccessToken.VideoGrant;
 const MAX_ALLOWED_SESSION_DURATION = 14400;
 
-module.exports.handler = (context, event, callback) => {
+module.exports.handler = async (context, event, callback) => {
   const {
     ACCOUNT_SID,
     TWILIO_API_KEY_SID,
     TWILIO_API_KEY_SECRET,
     API_PASSCODE,
     API_PASSCODE_EXPIRY,
     DOMAIN_NAME,
+    ROOM_TYPE,
   } = context;
 
-  const { user_identity, room_name, passcode } = event;
+  const { user_identity, room_name, passcode, create_room = true } = event;
   const [, appID, serverlessID] = DOMAIN_NAME.match(/-?(\d*)-(\d+)(?:-\w+)?.twil.io$/);
 
   let response = new Twilio.Response();
   response.appendHeader('Content-Type', 'application/json');
 
+  if (typeof create_room !== 'boolean') {
+    response.setStatusCode(400);
+    response.setBody({
+      error: {
+        message: 'invalid parameter',
+        explanation: 'A boolean value must be provided for the create_room parameter',
+      },
+    });
+    return callback(null, response);
+  }
+
   if (Date.now() > API_PASSCODE_EXPIRY) {
     response.setStatusCode(401);
     response.setBody({
@@ -30,8 +42,7 @@ module.exports.handler = (context, event, callback) => {
           'The passcode used to validate application users has expired. Re-deploy the application to refresh the passcode.',
       },
     });
-    callback(null, response);
-    return;
+    return callback(null, response);
   }
 
   if (API_PASSCODE + appID + serverlessID !== passcode) {
@@ -42,8 +53,7 @@ module.exports.handler = (context, event, callback) => {
         explanation: 'The passcode used to validate application users is incorrect.',
       },
     });
-    callback(null, response);
-    return;
+    return callback(null, response);
   }
 
   if (!user_identity) {
@@ -54,8 +64,27 @@ module.exports.handler = (context, event, callback) => {
         explanation: 'The user_identity parameter is missing.',
       },
     });
-    callback(null, response);
-    return;
+    return callback(null, response);
+  }
+
+  if (create_room) {
+    const client = context.getTwilioClient();
+
+    try {
+      await client.video.rooms.create({ uniqueName: room_name, type: ROOM_TYPE });
+    } catch (e) {
+      // Ignore 53113 error (room already exists). See: https://www.twilio.com/docs/api/errors/53113
+      if (e.code !== 53113) {
+        response.setStatusCode(500);
+        response.setBody({
+          error: {
+            message: 'error creating room',
+            explanation: 'Something went wrong when creating a room.',
+          },
+        });
+        return callback(null, response);
+      }
+    }
   }
 
   const token = new AccessToken(ACCOUNT_SID, TWILIO_API_KEY_SID, TWILIO_API_KEY_SECRET, {
@@ -65,6 +94,6 @@ module.exports.handler = (context, event, callback) => {
   const videoGrant = new VideoGrant({ room: room_name });
   token.addGrant(videoGrant);
   response.setStatusCode(200);
-  response.setBody({ token: token.toJwt() });
-  callback(null, response);
+  response.setBody({ token: token.toJwt(), room_type: create_room ? ROOM_TYPE : null });
+  return callback(null, response);
 };