RFE: remove pusher.com dependency

Author: nonameentername

Diff for: .env.example

@@ -15,3 +15,7 @@ GITHUB_CLIENT_ID=redacted
 GITHUB_CLIENT_SECRET=redacted
 GITHUB_OAUTH_TOKEN=redacted
 HASH_SECRET=redacted
+COTURN_USERNAME=redacted
+COTURN_PASSWORD=redacted
+ACTIVE_PUB_SUB_GATEWAY=pusher
+ACTIVE_ICE_SERVER_PROVIDER=twilio

Diff for: .env.local.example

@@ -0,0 +1,21 @@
+DATABASE_URL=postgres://teletype:password@localhost:5432/teletype-server-dev
+TEST_DATABASE_URL=postgres://teletype:password@localhost:5433/teletype-server-test
+PORT=3000
+PUSHER_APP_ID=348824
+PUSHER_KEY=redacted
+PUSHER_SECRET=redacted
+PUSHER_CLUSTER=mt1
+TWILIO_ACCOUNT=redacted
+TWILIO_AUTH_TOKEN=redacted
+NEW_RELIC_ENABLED=false
+NEW_RELIC_APP_NAME=atom-teletype-development
+NEW_RELIC_LICENSE_KEY=redacted
+GITHUB_API_URL=https://api.github.com
+GITHUB_CLIENT_ID=redacted
+GITHUB_CLIENT_SECRET=redacted
+GITHUB_OAUTH_TOKEN=redacted
+HASH_SECRET=redacted
+COTURN_USERNAME=teletype
+COTURN_PASSWORD=password
+ACTIVE_PUB_SUB_GATEWAY=socketcluster
+ACTIVE_ICE_SERVER_PROVIDER=coturn

Diff for: .gitignore

@@ -1,3 +1,4 @@
 node_modules
 .env
 newrelic_agent.log
+redis

Diff for: README.md

@@ -43,6 +43,40 @@ To run teletype-server locally, you'll first need to have:
     npm test
     ```
 
+### Running locally using docker
+
+This allows to deploy teletype-server to a full private solution.
+Coturn is used instead of Twilio and SocketCluster instead of Pusher.
+
+1. Clone and bootstrap
+
+    ```
+    git clone https://github.com/atom/teletype-server.git
+    cd teletype-server
+    cp .env.local.example .env
+    docker-compose build
+    docker-compose up -d
+    createdb teletype-server-dev
+    createdb teletype-server-test
+    npm install
+    npm run migrate up
+    ```
+
+2. Copy the client ID and client secret for your OAuth app on github.com, and set those values in your `.env` file
+
+3. Start the server
+
+    ```
+    ./script/server
+    ```
+
+4. Run the tests
+
+    ```
+    npm test
+    ```
+
+
 ## Deploying
 
 Atom core team members can use [this guide](./docs/deployment.md) to test pull requests and deploy changes to production.

Diff for: app.json

@@ -40,6 +40,18 @@
     },
     "TWILIO_AUTH_TOKEN": {
       "required": true
+    },
+    "COTURN_USERNAME": {
+      "required": true
+    },
+    "COTURN_PASSWORD": {
+      "required": true
+    },
+    "ACTIVE_PUB_SUB_GATEWAY": {
+      "required": true
+    },
+    "ACTIVE_ICE_SERVER_PROVIDER": {
+      "required": true
     }
   },
   "formation": {},

Diff for: coturn/Dockerfile

@@ -0,0 +1,10 @@
+FROM ubuntu:18.04
+
+RUN apt-get update
+RUN DEBIAN_FRONTEND=noninteractive apt-get install -y coturn
+
+ADD turnserver.conf /etc/turnserver.conf
+
+EXPOSE 3478
+
+CMD exec /bin/bash -c "trap : TERM INT; /usr/bin/turnserver -c /etc/turnserver.conf -v"

Diff for: coturn/turnserver.conf

@@ -0,0 +1,6 @@
+no-stun
+verbose
+fingerprint
+lt-cred-mech
+user=teletype:password
+realm=teletype

Diff for: docker-compose.yml

@@ -0,0 +1,59 @@
+version: '3'
+
+services:
+  database:
+    image: postgres
+    ports:
+     - 5432:5432
+    volumes:
+     - ./database:/var/lib/postgresql/data
+    restart: always
+    environment:
+      POSTGRES_USER: teletype
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: teletype-server-dev
+    networks:
+      teletype:
+
+  test-database:
+    image: postgres
+    ports:
+     - 5433:5432
+    volumes:
+     - ./test-database:/var/lib/postgresql/data
+    restart: always
+    environment:
+      POSTGRES_USER: teletype
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: teletype-server-test
+    networks:
+      teletype:
+
+  coturn:
+    image: coturn
+    build:
+      context: coturn
+      dockerfile: Dockerfile
+    ports:
+     - 3478:3478
+    restart: always
+    networks:
+      teletype:
+        aliases:
+          - coturn
+
+  socketcluster:
+    image: socketcluster
+    build:
+      context: socketcluster
+      dockerfile: Dockerfile
+    ports:
+     - 8000:8000
+    restart: always
+    networks:
+      teletype:
+        aliases:
+          - socketcluster
+
+networks:
+  teletype:

Diff for: index.js

@@ -25,7 +25,11 @@ async function startServer (id) {
     githubOauthToken: process.env.GITHUB_OAUTH_TOKEN,
     boomtownSecret: process.env.BOOMTOWN_SECRET,
     hashSecret: process.env.HASH_SECRET,
-    port: process.env.PORT || 3000
+    port: process.env.PORT || 3000,
+    coturnUsername: process.env.COTURN_USERNAME,
+    coturnPassword: process.env.COTURN_PASSWORD,
+    activePubSubGateway: process.env.ACTIVE_PUB_SUB_GATEWAY,
+    activeIceServerProvider: process.env.ACTIVE_ICE_SERVER_PROVIDER
   })
   await server.start()
   console.log(`Worker ${id} (pid: ${process.pid}): listening on port ${server.port}`)

Diff for: lib/coturn-ice-server-provider.js

@@ -0,0 +1,27 @@
+module.exports =
+class CoturnIceServerProvider {
+  constructor ({coturnUsername, coturnPassword}) {
+      this.coturnUsername = coturnUsername
+      this.coturnPassword = coturnPassword
+  }
+
+  async fetchICEServers () {
+    return {ttl: 86400, servers: [
+          {
+              'urls': 'stun:stun.l.google.com:19302'
+          },
+          {
+              'urls': 'turn:localhost:3478?transport=udp',
+              'username': this.coturnUsername,
+              'credential': this.coturnPassword
+          },
+          {
+              'urls': 'turn:localhost:3478?transport=tcp',
+              'username': this.coturnUsername,
+              'credential': this.coturnPassword
+          }
+      ]
+    }
+
+  }
+}

Diff for: lib/server.js

@@ -3,7 +3,10 @@ const pgp = require('pg-promise')()
 const request = require('request-promise-native')
 const IdentityProvider = require('./identity-provider')
 const ModelLayer = require('./model-layer')
-const PubSubGateway = require('./pusher-pub-sub-gateway')
+const PusherPubSubGateway = require('./pusher-pub-sub-gateway')
+const SocketClusterPubSubGateway = require('./socketcluster-pub-sub-gateway')
+const TwilioIceServerProvider = require('./twilio-ice-server-provider')
+const CoturnIceServerProvider = require('./coturn-ice-server-provider')
 
 module.exports =
 class Server {
@@ -21,7 +24,11 @@ class Server {
     this.githubOauthToken = options.githubOauthToken
     this.boomtownSecret = options.boomtownSecret
     this.hashSecret = options.hashSecret
-    this.port = options.port
+    this.port = options.port,
+    this.coturnUsername = options.coturnUsername,
+    this.coturnPassword = options.coturnPassword,
+    this.activePubSubGateway = options.activePubSubGateway,
+    this.activeIceServerProvider = options.activeIceServerProvider
   }
 
   async start () {
@@ -33,23 +40,50 @@ class Server {
       clientSecret: this.githubClientSecret,
       oauthToken: this.githubOauthToken
     })
-    const pubSubGateway = new PubSubGateway({
-      appId: this.pusherAppId,
-      key: this.pusherKey,
-      secret: this.pusherSecret,
-      cluster: this.pusherCluster
-    })
 
-    const twilioICEServerURL = `https://${this.twilioAccount}:${this.twilioAuthToken}@api.twilio.com/2010-04-01/Accounts/${this.twilioAccount}/Tokens.json`
+    var pubSubGateway
+
+    switch(this.activePubSubGateway) {
+        case 'socketcluster':
+            pubSubGateway = new SocketClusterPubSubGateway({})
+            break;
+
+        case 'pusher':
+        default:
+            pubSubGateway = new PusherPubSubGateway({
+              appId: this.pusherAppId,
+              key: this.pusherKey,
+              secret: this.pusherSecret,
+              cluster: this.pusherCluster
+            })
+            break;
+    }
+
+    var iceServerProvider
+    switch(this.activeIceServerProvider) {
+        case 'coturn':
+            iceServerProvider = new CoturnIceServerProvider({
+                coturnUsername: this.coturnUsername,
+                coturnPassword: this.coturnPassword
+            })
+            break;
+
+        case 'twilio':
+        default:
+            iceServerProvider = new TwilioIceServerProvider({
+                twilioAccount: this.twilioAccount,
+                twilioAuthToken: this.twilioAuthToken
+            })
+            break;
+    }
 
     const controllerLayer = buildControllerLayer({
       modelLayer,
       pubSubGateway,
       identityProvider,
       boomtownSecret: this.boomtownSecret,
       fetchICEServers: async () => {
-        const response = JSON.parse(await request.post(twilioICEServerURL))
-        return {ttl: parseInt(response.ttl), servers: response.ice_servers}
+        iceServerProvider.fetchICEServers()
       }
     })
 

Diff for: lib/socketcluster-pub-sub-gateway.js

@@ -0,0 +1,31 @@
+const socketCluster = require('socketcluster-client');
+
+module.exports =
+class SocketClusterPubSubGateway {
+  constructor ({appId, key, secret, cluster}) {
+    var options = {
+      port: 8000,
+      autoConnect: true,
+      autoReconnect: true
+    };
+
+    this.socket = socketCluster.create(options);
+    this.socket.on('error', function (error) {
+    });
+  }
+
+  broadcast (channelName, eventName, data) {
+    channelName = channelName.replace(/\//g, '.')
+    var message = {
+        channel: `${channelName}.${eventName}`,
+        data: data
+    }
+    this.socket.emit('publish', message);
+  }
+
+  async isOperational () {
+    return new Promise((resolve) => {
+        resolve(this.socket.state == this.socket.OPEN)
+    })
+  }
+}

Diff for: lib/twilio-ice-server-provider.js

@@ -0,0 +1,15 @@
+module.exports =
+class TwilioIceServerProvider {
+  constructor ({twilioAccount, twilioAuthToken}) {
+      this.twilioAccount = twilioAccount
+      this.twilioAuthToken = twilioAuthToken
+  }
+
+  async fetchICEServers () {
+    const twilioICEServerURL = `https://${this.twilioAccount}:${this.twilioAuthToken}@api.twilio.com/2010-04-01/Accounts/${this.twilioAccount}/Tokens.json`
+
+    const response = JSON.parse(await request.post(twilioICEServerURL))
+    return {ttl: parseInt(response.ttl), servers: response.ice_servers}
+
+  }
+}