feat(video): Support for configurable room name (#309)

Author: jmulcahey-twilio

video/.env

@@ -10,6 +10,11 @@ API_KEY=
 # required: true
 API_SECRET=
 
+# description: Choose a room name for your video call
+# format: text
+# required: true
+ROOM_NAME=
+
 # description: Choose a passcode for your app. Users have to use this passcode to enter the video call
 # format: text
 # required: true

video/README.md

@@ -10,12 +10,13 @@ This project requires some environment variables to be set. To keep your tokens
 
 In your `.env` file, set the following values:
 
-| Variable     | Description                                                                       | Required |
-| :----------- | :-------------------------------------------------------------------------------- | :------- |
-| `ACCOUNT_SID`| Find in the [console](https://www.twilio.com/console)                             | Yes      |
-| `API_KEY`    | Twilio API Key. Create one here (https://www.twilio.com/console/runtime/api-keys) | Yes      |
-| `API_SECRET` | Twilio API Secret corresponding to your API Key                                   | Yes      |
-| `PASSCODE`   | A passcode to gate your video call                                                | Yes      |
+| Variable      | Description                                                                       | Required |
+| :------------ | :-------------------------------------------------------------------------------- | :------- |
+| `ACCOUNT_SID` | Find in the [console](https://www.twilio.com/console)                             | Yes      |
+| `API_KEY`     | Twilio API Key. Create one here (https://www.twilio.com/console/runtime/api-keys) | Yes      |
+| `API_SECRET`  | Twilio API Secret corresponding to your API Key                                   | Yes      |
+| `ROOM_NAME`   | A room name to identify your video call                                           | Yes      |
+| `PASSCODE`    | A passcode to gate your video call                                                | Yes      |
 
 ### Function Parameters
 

video/assets/conference.js

@@ -39,7 +39,6 @@ const participantDisconnected = (participant) => {
 };
 
 (() => {
-  const ROOM_NAME = 'demo';
   const { Video } = Twilio;
   let videoRoom;
   let localStream;
@@ -77,10 +76,10 @@ const participantDisconnected = (participant) => {
         }
       })
       .then((body) => {
-        const { token } = body;
+        const { token, room } = body;
         console.log(token);
         // connect to room
-        return Video.connect(token, { name: ROOM_NAME });
+        return Video.connect(token, { name: room });
       })
       .then((room) => {
         console.log(`Connected to Room ${room.name}`);

video/functions/video-token.js

@@ -1,5 +1,6 @@
 exports.handler = function (context, event, callback) {
   const VALID_PASSCODE = context.PASSCODE;
+  const { ROOM_NAME } = context;
   const TWILIO_ACCOUNT_SID = context.ACCOUNT_SID;
   const TWILIO_API_KEY = context.API_KEY;
   const TWILIO_API_SECRET = context.API_SECRET;
@@ -14,7 +15,6 @@ exports.handler = function (context, event, callback) {
     return callback(null, response);
   }
 
-  const ROOM_NAME = 'demo'; // fixed room name
   const { AccessToken } = Twilio.jwt;
   const { VideoGrant } = AccessToken;
   /*
@@ -34,5 +34,6 @@ exports.handler = function (context, event, callback) {
   accessToken.identity = ACCESS_TOKEN_IDENTITY;
   return callback(null, {
     token: accessToken.toJwt(), // Serialize the token to a JWT string
+    room: ROOM_NAME,
   });
 };

video/tests/video-token.test.js

@@ -6,6 +6,7 @@ const baseContext = {
   ACCOUNT_SID: 'ACxxx',
   API_KEY: 'api-key',
   API_SECRET: 'api-secret',
+  ROOM_NAME: 'test',
 };
 
 describe('video-token/token', () => {
@@ -20,12 +21,13 @@ describe('video-token/token', () => {
     const callback = (_err, result) => {
       expect(result).toBeDefined();
       expect(typeof result.token).toBe('string');
+      expect(result.room).toEqual(baseContext.ROOM_NAME);
       jwt.verify(result.token, baseContext.API_SECRET, (err, decoded) => {
         expect(err).toBeNull();
         expect(decoded.iss).toBe(baseContext.API_KEY);
         expect(decoded.sub).toBe(baseContext.ACCOUNT_SID);
         expect(decoded.grants.video).toEqual({
-          room: 'demo',
+          room: baseContext.ROOM_NAME,
         });
         expect(typeof decoded.grants.identity).toEqual('string');
         done();