Merge pull request #39 from twilio-labs/ahoyapps-803-improve-app-code

Ahoyapps 803 improve app code

Author: timmydoza

.circleci/config.yml

@@ -1,7 +1,6 @@
 version: 2.1
 
-workspace: &workspace
-  ~/plugin-rtc
+workspace: &workspace ~/plugin-rtc
 
 node-defaults: &node-defaults
   working_directory: *workspace
@@ -27,7 +26,7 @@ jobs:
       - node/with-cache:
           steps:
             - run: npm install
-            - run: npm test -- -i --verbose
+            - run: npm test -- --verbose
       - persist_to_workspace:
           root: .
           paths: .
@@ -52,7 +51,7 @@ jobs:
                     exit 1
                   fi
             - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > $PWD/.npmrc
-            - run: npm publish 
+            - run: npm publish
             - run: echo 'export DEFAULT_BRANCH=$(git remote show origin | grep HEAD | cut -d ":" -f2- | xargs)' >> $BASH_ENV
             - run:
                 name: Set git information
@@ -66,15 +65,15 @@ jobs:
             - run: git push origin $DEFAULT_BRANCH
 
 workflows:
-    build-and-test:
-      jobs:
-        - build-and-test
+  build-and-test:
+    jobs:
+      - build-and-test
 
-    publish-release:
-      jobs:
-        - build-and-test:
-            <<: *release-filter
-        - publish-release:
-            <<: *release-filter
-            requires: 
-              - build-and-test
+  publish-release:
+    jobs:
+      - build-and-test:
+          <<: *release-filter
+      - publish-release:
+          <<: *release-filter
+          requires:
+            - build-and-test

CHANGELOG.md

@@ -1,51 +1,57 @@
 # Changelog
 
+## 0.2.0
+
+### Breaking Change
+
+- This version adds extra random digits to the URL used by the Twilio Video Apps. The format of the URL has changed from `https://video-app-xxxx-dev.twil.io` to `https://video-app-xxxx-yyyy-dev.twil.io`. The [iOS Video App](https://github.com/twilio/twilio-video-app-ios) and [Android Video App](https://github.com/twilio/twilio-video-app-android) must be upgraded in order to work with this new format. The [React Video App](https://github.com/twilio/twilio-video-app-react) does not need to be upgraded. This change is being made to increase the number of available domains (from ten thousand to ten million) which will greatly reduce the number of 409 (conflict) errors experienced by users.
+
 ## 0.1.6
 
 ### Maintenance
 
-* Move @oclif/plugin-help from devDependencies to dependencies to resolve NPM warning.
+- Move @oclif/plugin-help from devDependencies to dependencies to resolve NPM warning.
 
 ## 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.
+- 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
 
-* Updated `twilio rtc:apps:video:delete` command so that it doesn't check for serverless environments before deleting the app. This allows the command to delete the app even when no environments exist.
+- Updated `twilio rtc:apps:video:delete` command so that it doesn't check for serverless environments before deleting the app. This allows the command to delete the app even when no environments exist.
 
 ## 0.1.3
 
 ### Features
 
-* Updated the `twilio rtc:apps:video:deploy --override` flag behavior to update an existing Twilio Serverless instance rather than deleting and redeploying an instance. This behavior allows users to update an existing deployment's passcode without changing their application's URL. This betterment was proposed in #14.
+- Updated the `twilio rtc:apps:video:deploy --override` flag behavior to update an existing Twilio Serverless instance rather than deleting and redeploying an instance. This behavior allows users to update an existing deployment's passcode without changing their application's URL. This betterment was proposed in #14.
 
 ### Maintenance
 
-* Use the Twilio Account SID from a Twilio Function context rather than copying from a Twilio Client instance.
+- Use the Twilio Account SID from a Twilio Function context rather than copying from a Twilio Client instance.
 
 ## 0.1.2
 
 ### Maintenance
 
-* Addressed security alerts
+- Addressed security alerts
 
 ## 0.1.1
 
 ### Maintenance
 
-* Updated the token server to return the following error response with status code `400` when the request body is missing the `user_identity` field.
+- Updated the token server to return the following error response with status code `400` when the request body is missing the `user_identity` field.
 
 ```json
 {
-    "error": {
-      "message": "missing user_identity",
-      "explanation": "The user_identity parameter is missing."
-    }
+  "error": {
+    "message": "missing user_identity",
+    "explanation": "The user_identity parameter is missing."
+  }
 }
 ```
 

README.md

@@ -5,9 +5,9 @@
 
 This plugin adds functionality to the [Twilio CLI](https://github.com/twilio/twilio-cli) which supports developing and deploying real-time communication apps.
 
-* [Getting Started](#getting-started)
-* [Supported Apps](#supported-apps)
-* [Commands](#commands)
+- [Getting Started](#getting-started)
+- [Supported Apps](#supported-apps)
+- [Commands](#commands)
 
 ## Getting Started
 
@@ -52,17 +52,17 @@ This plugin currently supports the following applications:
 
 A mobile and web collaboration application built with Twilio Programmable Video. Visit the projects below for instructions on how to use this plugin to build and deploy the Twilio Video app.
 
-  * [React App](https://github.com/twilio/twilio-video-app-react)
-  * [iOS App](https://github.com/twilio/twilio-video-app-ios)
-  * [Android App](https://github.com/twilio/twilio-video-app-android)
+- [React App](https://github.com/twilio/twilio-video-app-react)
+- [iOS App](https://github.com/twilio/twilio-video-app-ios)
+- [Android App](https://github.com/twilio/twilio-video-app-android)
 
 #### Token Server API Documentation
 
 The following section documents the application [token server](/src/video-token-server.js) used to provide [Programable Video access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) to supported Twilio Video applications. The token server is deployed as a [Twilio Function](https://www.twilio.com/docs/runtime/functions).
 
-| Method | URL |
-| --- | --- |
-| POST | [`/token`](#token) |
+| Method | URL                |
+| ------ | ------------------ |
+| POST   | [`/token`](#token) |
 
 ##### Authentication
 
@@ -74,7 +74,7 @@ Each request is verified using a passcode generated at deploy time. Passcodes re
 
 ```
 {
-  "passcode": "1234564321",
+  "passcode": "12345612341234",
   "user_identity": "User",
   "room_name": "Demo",
 }
@@ -90,11 +90,11 @@ 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. |
 
 ###### Success Responses
 
@@ -108,7 +108,7 @@ POST /token
 
 ```json
 {
-    "token": "0000000000000000.0000000000000000000000.00000000000000000"
+  "token": "0000000000000000.0000000000000000000000.00000000000000000"
 }
 ```
 
@@ -130,10 +130,10 @@ POST /token
 
 ```json
 {
-    "error": {
-      "message": "missing user_identity",
-      "explanation": "The user_identity parameter is missing."
-    }
+  "error": {
+    "message": "missing user_identity",
+    "explanation": "The user_identity parameter is missing."
+  }
 }
 ```
 
@@ -146,10 +146,10 @@ POST /token
 
 ```json
 {
-    "error": {
-      "message": "passcode expired",
-      "explanation": "The passcode used to validate application users has expired. Re-deploy the application to refresh the passcode."
-    }
+  "error": {
+    "message": "passcode expired",
+    "explanation": "The passcode used to validate application users has expired. Re-deploy the application to refresh the passcode."
+  }
 }
 ```
 
@@ -162,10 +162,10 @@ POST /token
 
 ```json
 {
-    "error": {
-      "message": "passcode incorrect",
-      "explanation": "The passcode used to validate application users is incorrect."
-    }
+  "error": {
+    "message": "passcode incorrect",
+    "explanation": "The passcode used to validate application users is incorrect."
+  }
 }
 ```
 
@@ -175,10 +175,12 @@ POST /token
 </table>
 
 ## Commands
+
   <!-- commands -->
-* [`twilio rtc:apps:video:delete`](#twilio-rtcappsvideodelete)
-* [`twilio rtc:apps:video:deploy --authentication <auth>`](#twilio-rtcappsvideodeploy---authentication-auth)
-* [`twilio rtc:apps:video:view`](#twilio-rtcappsvideoview)
+
+- [`twilio rtc:apps:video:delete`](#twilio-rtcappsvideodelete)
+- [`twilio rtc:apps:video:deploy --authentication <auth>`](#twilio-rtcappsvideodeploy---authentication-auth)
+- [`twilio rtc:apps:video:view`](#twilio-rtcappsvideoview)
 
 ## `twilio rtc:apps:video:delete`
 
@@ -190,25 +192,23 @@ USAGE
 
 OPTIONS
   -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
-  -o=(columns|json|tsv)            [default: columns] Format of command output.
   -p, --profile=profile            Shorthand identifier for your profile.
 
 EXAMPLE
   $ twilio rtc:apps:video:delete
-  Removed app with Passcode: 1111111111
+  Successfully deleted app.
 ```
 
 ## `twilio rtc:apps:video:deploy --authentication <auth>`
 
-Deploy a Programmable Video app 
+Deploy a Programmable Video app
 
 ```
 USAGE
   $ twilio rtc:apps:video:deploy --authentication <auth>
 
 OPTIONS
   -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
-  -o=(columns|json|tsv)            [default: columns] Format of command output.
   -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
@@ -232,21 +232,21 @@ 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
 
   # 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
 
   # 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
+  $ twilio rtc:apps:video:deploy --authentication passcode --override
+  Removed app with Passcode: xxx xxx xxxx xxxx
   deploying app... done
-  Passcode: 2222222222
+  Passcode: xxx xxx xxxx xxxx
   Expires: Mon Mar 09 2020 16:36:23 GMT-0600
 ```
 
@@ -260,12 +260,12 @@ USAGE
 
 OPTIONS
   -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
-  -o=(columns|json|tsv)            [default: columns] Format of command output.
   -p, --profile=profile            Shorthand identifier for your profile.
 
 EXAMPLE
   $ twilio rtc:apps:video:view
-  Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
-  Passcode: 1111111111
+  Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
+  Passcode: xxx xxx xxxx xxxx
 ```
+
 <!-- commandsstop -->