Feature/app call count tracking (#51)

* add call count tracking at the app level (optional)

* add histogram for rtt to rtpengine commands

* update time-series

* update rtpengine-utils

.eslintrc.json

@@ -8,7 +8,7 @@
       "jsx": false,
       "modules": false
     },
-    "ecmaVersion": 2017 
+    "ecmaVersion": 2020
   },
   "plugins": ["promise"],
   "rules": {

.github/workflows/docker-publish.yml

@@ -0,0 +1,51 @@
+name: Docker
+
+on:
+  push:
+    # Publish `master` as Docker `latest` image.
+    branches:
+      - main
+
+    # Publish `v1.2.3` tags as releases.
+    tags:
+      - v*
+
+env:
+  IMAGE_NAME: sbc-inbound
+
+jobs:
+  push:
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build image
+        run: docker build . --file Dockerfile --tag $IMAGE_NAME
+
+      - name: Log into registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Push image
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "main" ] && VERSION=latest
+
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.github/workflows/npm-ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+      - run: npm ci
+      - run: npm run jslint
+      - run: npm test
+
+ 

.gitignore

@@ -1,7 +1,7 @@
 # Logs
 logs
 *.log
-
+.vscode/
 # Runtime data
 pids
 *.pid

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run jslint

.travis.yml

@@ -1,9 +0,0 @@
-sudo: required
-language: node_js
-node_js:
-  - "lts/*"
-services:
-  - docker
-  - mysql
-script:
-  - npm test

Dockerfile

@@ -1,13 +1,23 @@
-FROM node:lts-alpine
+FROM --platform=linux/amd64 node:18.8.0-alpine as base
 
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
+RUN apk --update --no-cache add --virtual .builds-deps build-base python3
+
+WORKDIR /opt/app/
+
+FROM base as build
+
+COPY package.json package-lock.json ./
+
+RUN npm ci
+
+COPY . .
+
+FROM base
+
+COPY --from=build /opt/app /opt/app/
 
 ARG NODE_ENV
+
 ENV NODE_ENV $NODE_ENV
 
-COPY package.json /usr/src/app/
-RUN npm install
-COPY . /usr/src/app
-
-CMD [ "npm", "start" ]
+CMD [ "node", "app.js" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 jambonz
+Copyright (c) 2021 Drachtio Communications Services, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# sbc-inbound [![Build Status](https://secure.travis-ci.org/jambonz/sbc-inbound.png)](http://travis-ci.org/jambonz/sbc-inbound)
+# sbc-inbound ![Build Status](https://github.com/jambonz/sbc-inbound/workflows/CI/badge.svg)
 
 This application provides a part of the SBC (Session Border Controller) functionality of jambonz.  It handles incoming INVITE requests from carrier sip trunks or from sip devices and webrtc applications. SIP INVITEs from known carriers are allowed in, while INVITEs from sip devices are challenged to authenticate.  SIP traffic that is allowed in is sent on to a jambonz application server in a private subnet.
 

app.js

@@ -5,28 +5,48 @@ assert.ok(process.env.JAMBONES_MYSQL_HOST &&
   process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
 assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
 assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
-assert.ok(process.env.JAMBONES_RTPENGINES, 'missing DRACHTIO_SECRET env var');
-
+assert.ok(process.env.JAMBONES_TIME_SERIES_HOST, 'missing JAMBONES_TIME_SERIES_HOST env var');
+assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_NETWORK_CIDR env var');
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-inbound');
 const opts = Object.assign({
   timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
 }, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
 const logger = require('pino')(opts);
-const StatsCollector = require('@jambonz/stats-collector');
-const stats = srf.locals.stats = new StatsCollector(logger);
-srf.locals.getFeatureServer = require('./lib/fs-tracking')(srf, logger);
-const {getRtpEngine} = require('@jambonz/rtpengine-utils')(process.env.JAMBONES_RTPENGINES.split(','), logger, {
-  emitter: srf.locals.stats
+const {
+  writeCallCount,
+  writeCallCountSP,
+  writeCallCountApp,
+  queryCdrs,
+  writeCdrs,
+  writeAlerts,
+  AlertType
+} = require('@jambonz/time-series')(logger, {
+  host: process.env.JAMBONES_TIME_SERIES_HOST,
+  port: process.env.JAMBONES_TIME_SERIES_PORT || 8086,
+  commitSize: 50,
+  commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
 });
-srf.locals.getRtpEngine = getRtpEngine;
-const activeCallIds = srf.locals.activeCallIds = new Map();
-logger.info('starting..');
+const StatsCollector = require('@jambonz/stats-collector');
+const stats = new StatsCollector(logger);
+const {equalsIgnoreOrder, createHealthCheckApp, systemHealth} = require('./lib/utils');
+const {LifeCycleEvents} = require('./lib/constants');
+const setNameRtp = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-rtp`;
+const rtpServers = [];
+const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
 
 const {
+  pool,
+  ping,
   lookupAuthHook,
   lookupSipGatewayBySignalingAddress,
-  addSbcAddress
+  addSbcAddress,
+  lookupAccountByPhoneNumber,
+  lookupAppByTeamsTenant,
+  lookupAccountBySipRealm,
+  lookupAccountBySid,
+  lookupAccountCapacitiesBySid,
+  queryCallLimits
 } = require('@jambonz/db-helpers')({
   host: process.env.JAMBONES_MYSQL_HOST,
   user: process.env.JAMBONES_MYSQL_USER,
@@ -34,24 +54,113 @@ const {
   database: process.env.JAMBONES_MYSQL_DATABASE,
   connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
 }, logger);
+const {
+  client: redisClient,
+  createSet,
+  retrieveSet,
+  addToSet,
+  removeFromSet,
+  incrKey,
+  decrKey} = require('@jambonz/realtimedb-helpers')({
+  host: process.env.JAMBONES_REDIS_HOST || 'localhost',
+  port: process.env.JAMBONES_REDIS_PORT || 6379
+}, logger);
 
-srf.locals.dbHelpers = {
-  lookupAuthHook,
-  lookupSipGatewayBySignalingAddress
+const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {
+  emitter: stats,
+  dtmfListenPort: process.env.DTMF_LISTEN_PORT || 22224,
+  protocol: 'udp'
+});
+srf.locals = {...srf.locals,
+  stats,
+  writeCallCount,
+  writeCallCountSP,
+  writeCallCountApp,
+  queryCdrs,
+  writeCdrs,
+  writeAlerts,
+  AlertType,
+  activeCallIds: new Map(),
+  getRtpEngine,
+  dbHelpers: {
+    pool,
+    ping,
+    lookupAuthHook,
+    lookupSipGatewayBySignalingAddress,
+    lookupAccountByPhoneNumber,
+    lookupAppByTeamsTenant,
+    lookupAccountBySid,
+    lookupAccountBySipRealm,
+    lookupAccountCapacitiesBySid,
+    queryCallLimits
+  },
+  realtimeDbHelpers: {
+    createSet,
+    incrKey,
+    decrKey,
+    retrieveSet
+  }
 };
-const {challengeDeviceCalls, initLocals} = require('./lib/middleware')(srf, logger);
+const {
+  getSPForAccount,
+  wasOriginatedFromCarrier,
+  getApplicationForDidAndCarrier,
+  getOutboundGatewayForRefer
+} = require('./lib/db-utils')(srf, logger);
+srf.locals = {
+  ...srf.locals,
+  getSPForAccount,
+  wasOriginatedFromCarrier,
+  getApplicationForDidAndCarrier,
+  getOutboundGatewayForRefer,
+  getFeatureServer: require('./lib/fs-tracking')(srf, logger)
+};
+const activeCallIds = srf.locals.activeCallIds;
+
+const {
+  initLocals,
+  handleSipRec,
+  identifyAccount,
+  checkLimits,
+  challengeDeviceCalls
+} = require('./lib/middleware')(srf, logger);
 const CallSession = require('./lib/call-session');
 
-if (process.env.DRACHTIO_HOST) {
+if (process.env.DRACHTIO_HOST && !process.env.K8S) {
+  const CIDRMatcher = require('cidr-matcher');
+  const cidrs = process.env.JAMBONES_NETWORK_CIDR
+    .split(',')
+    .map((s) => s.trim());
+  const matcher = new CIDRMatcher(cidrs);
+
   srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
   srf.on('connect', (err, hp) => {
-    const last = hp.split(',').pop();
-    const arr = /^(.*)\/(.*):(\d+)$/.exec(last);
-    logger.info(`connected to drachtio listening on ${hp}: adding ${arr[2]} to sbc_addresses table`);
-    addSbcAddress(arr[2]);
+    if (err) return this.logger.error({err}, 'Error connecting to drachtio server');
+    logger.info(`connected to drachtio listening on ${hp}`);
+
+    const hostports = hp.split(',');
+    for (const hp of hostports) {
+      const arr = /^(.*)\/(.*):(\d+)$/.exec(hp);
+      if (arr && 'udp' === arr[1] && !matcher.contains(arr[2])) {
+        logger.info(`adding sbc public address to database: ${arr[2]}`);
+        srf.locals.sipAddress = arr[2];
+        if (!process.env.SBC_ACCOUNT_SID) addSbcAddress(arr[2]);
+      }
+      else if (arr && 'tcp' === arr[1] && matcher.contains(arr[2])) {
+        const hostport = `${arr[2]}:${arr[3]}`;
+        logger.info(`adding sbc private address to redis: ${hostport}`);
+        srf.locals.privateSipAddress = hostport;
+        srf.locals.addToRedis = () => addToSet(setName, hostport);
+        srf.locals.removeFromRedis = () => removeFromSet(setName, hostport);
+        srf.locals.addToRedis();
+      }
+    }
   });
 }
 else {
+  srf.on('listening', () => {
+    logger.info(`listening in outbound mode on port ${process.env.DRACHTIO_PORT}`);
+  });
   srf.listen({port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET});
 }
 if (process.env.NODE_ENV === 'test') {
@@ -60,8 +169,14 @@ if (process.env.NODE_ENV === 'test') {
   });
 }
 
-// challenge calls from devices, let calls from sip gateways through
-srf.use('invite', [initLocals, challengeDeviceCalls]);
+/* install middleware */
+srf.use('invite', [
+  initLocals,
+  handleSipRec,
+  identifyAccount,
+  checkLimits,
+  challengeDeviceCalls
+]);
 
 srf.invite((req, res) => {
   if (req.has('Replaces')) {
@@ -84,8 +199,112 @@ srf.use((req, res, next, err) => {
   res.send(500);
 });
 
-setInterval(() => {
-  stats.gauge('sbc.sip.calls.count', activeCallIds.size, ['direction:inbound']);
+if (process.env.K8S || process.env.HTTP_PORT) {
+  const PORT = process.env.HTTP_PORT || 3000;
+  const healthCheck = require('@jambonz/http-health-check');
+
+  const getCount = () => srf.locals.activeCallIds.size;
+
+  createHealthCheckApp(PORT, logger)
+    .then((app) => {
+      healthCheck({
+        app,
+        logger,
+        path: '/',
+        fn: getCount
+      });
+      healthCheck({
+        app,
+        logger,
+        path: '/system-health',
+        fn: systemHealth.bind(null, redisClient, ping, getCount)
+      });
+      return;
+    })
+    .catch((err) => {
+      logger.error({err}, 'Error creating health check server');
+    });
+}
+if ('test' !== process.env.NODE_ENV) {
+  /* update call stats periodically */
+  setInterval(() => {
+    stats.gauge('sbc.sip.calls.count', activeCallIds.size, ['direction:inbound']);
+  }, 20000);
+}
+
+const lookupRtpServiceEndpoints = (lookup, serviceName) => {
+  logger.debug(`dns lookup for ${serviceName}..`);
+  lookup(serviceName, {family: 4, all: true}, (err, addresses) => {
+    if (err) {
+      logger.error({err}, `Error looking up ${serviceName}`);
+      return;
+    }
+    logger.debug({addresses, rtpServers}, `dns lookup for ${serviceName} returned`);
+    const addrs = addresses.map((a) => a.address);
+    if (!equalsIgnoreOrder(addrs, rtpServers)) {
+      rtpServers.length = 0;
+      Array.prototype.push.apply(rtpServers, addrs);
+      logger.info({rtpServers}, 'rtpserver endpoints have been updated');
+      setRtpEngines(rtpServers.map((a) => `${a}:${process.env.RTPENGINE_PORT || 22222}`));
+    }
+  });
+};
+
+if (process.env.K8S_RTPENGINE_SERVICE_NAME) {
+  /* poll dns for endpoints every so often */
+  const arr = /^(.*):(\d+)$/.exec(process.env.K8S_RTPENGINE_SERVICE_NAME);
+  const svc = arr[1];
+  logger.info(`rtpengine(s) will be found at dns name: ${svc}`);
+  const {lookup} = require('dns');
+  lookupRtpServiceEndpoints(lookup, svc);
+  setInterval(lookupRtpServiceEndpoints.bind(null, lookup, svc), process.env.RTPENGINE_DNS_POLL_INTERVAL || 10000);
+}
+else if (process.env.JAMBONES_RTPENGINES) {
+  /* static list of rtpengines */
+  setRtpEngines([process.env.JAMBONES_RTPENGINES]);
+}
+else {
+  /* poll redis periodically for rtpengines that have registered via OPTIONS ping */
+  const getActiveRtpServers = async() => {
+    try {
+      const set = await retrieveSet(setNameRtp);
+      const newArray = Array.from(set);
+      logger.debug({newArray, rtpServers}, 'getActiveRtpServers');
+      if (!equalsIgnoreOrder(newArray, rtpServers)) {
+        logger.info({newArray}, 'resetting active rtpengines');
+        setRtpEngines(newArray.map((a) => `${a}:${process.env.RTPENGINE_PORT || 22222}`));
+        rtpServers.length = 0;
+        Array.prototype.push.apply(rtpServers, newArray);
+      }
+    } catch (err) {
+      logger.error({err}, 'Error setting new rtpengines');
+    }
+  };
+  setInterval(() => {
+    getActiveRtpServers();
+  }, 30000);
+  getActiveRtpServers();
+
+}
+
+const {lifecycleEmitter} = require('./lib/autoscale-manager')(logger);
+
+/* if we are scaling in, check every so often if call count has gone to zero */
+setInterval(async() => {
+  if (lifecycleEmitter.operationalState === LifeCycleEvents.ScaleIn) {
+    if (0 === activeCallIds.size) {
+      logger.info('scale-in complete now that calls have dried up');
+      lifecycleEmitter.scaleIn();
+    }
+  }
 }, 20000);
 
+process.on('SIGUSR2', handle.bind(null, removeFromSet, setName));
+process.on('SIGTERM', handle.bind(null, removeFromSet, setName));
+
+function handle(removeFromSet, setName, signal) {
+  logger.info(`got signal ${signal}, removing ${srf.locals.privateSipAddress} from set ${setName}`);
+  removeFromSet(setName, srf.locals.privateSipAddress);
+}
+
 module.exports = {srf, logger};

bin/k8s-pre-stop-hook.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const bent = require('bent');
+const getJSON = bent('json');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+(async function() {
+
+  try {
+    do {
+      const obj = await getJSON(`http://127.0.0.1:${PORT}/`);
+      const {calls} = obj;
+      if (calls === 0) {
+        console.log('no calls on the system, we can exit');
+        process.exit(0);
+      }
+      else {
+        console.log(`waiting for ${calls} to exit..`);
+      }
+      await sleep(10000);
+    } while (1);
+  } catch (err) {
+    console.error(err, 'Error querying health endpoint');
+    process.exit(-1);
+  }
+})();

data/rtp-transcoding.json

@@ -3,6 +3,6 @@
   "DTLS": "off",
   "SDES": "off",
   "ICE": "remove",
-  "flags": ["media handover"],
+  "flags": ["media handover", "port latching"],
   "rtcp-mux": ["accept"]
 }

data/srtp-transcoding.json

@@ -3,14 +3,14 @@
     "transport-protocol": "UDP/TLS/RTP/SAVPF",
     "ICE": "force",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover"],
+    "flags": ["generate mid", "SDES-no", "media handover", "port latching"],
     "rtcp-mux": ["require"]  
   },
   "teams": {
     "transport-protocol": "RTP/SAVP",
     "ICE": "force",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover"],
+    "flags": ["generate mid", "SDES-no", "media handover", "port latching"],
     "rtcp-mux": ["accept"]
   }
 }

lib/autoscale-manager.js

@@ -0,0 +1,63 @@
+const noopLogger = {info: () => {}, error: () => {}};
+const {LifeCycleEvents} = require('./constants');
+const Emitter = require('events');
+
+module.exports = (logger) => {
+  logger = logger || noopLogger;
+
+  // listen for SNS lifecycle changes
+  let lifecycleEmitter = new Emitter();
+  lifecycleEmitter.dryUpCalls = false;
+  if (process.env.AWS_SNS_TOPIC_ARM) {
+
+    (async function() {
+      try {
+        lifecycleEmitter = await require('./aws-sns-lifecycle')(logger);
+
+        lifecycleEmitter
+          .on(LifeCycleEvents.ScaleIn, async() => {
+            logger.info('AWS scale-in notification: begin drying up calls');
+            lifecycleEmitter.dryUpCalls = true;
+            lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+
+            const {srf} = require('..');
+            const {activeCallIds, removeFromRedis} = srf.locals;
+
+            /* remove our private IP from the set of active SBCs so rtp and fs know we are gone */
+            removeFromRedis();
+
+            /* if we have zero calls, we can complete the scale-in right now */
+            const calls = activeCallIds.size;
+            if (0 === calls) {
+              logger.info('scale-in can complete immediately as we have no calls in progress');
+              lifecycleEmitter.completeScaleIn();
+            }
+            else {
+              logger.info(`${calls} calls in progress; scale-in will complete when they are done`);
+            }
+          })
+          .on(LifeCycleEvents.StandbyEnter, () => {
+            lifecycleEmitter.dryUpCalls = true;
+            const {srf} = require('..');
+            const {removeFromRedis} = srf.locals;
+            removeFromRedis();
+
+            logger.info('AWS enter pending state notification: begin drying up calls');
+          })
+          .on(LifeCycleEvents.StandbyExit, () => {
+            lifecycleEmitter.dryUpCalls = false;
+            const {srf} = require('..');
+            const {addToRedis} = srf.locals;
+            addToRedis();
+
+            logger.info('AWS exit pending state notification: re-enable calls');
+          });
+      } catch (err) {
+        logger.error({err}, 'Failure creating SNS notifier, lifecycle events will be disabled');
+      }
+    })();
+  }
+
+  return {lifecycleEmitter};
+};
+

lib/aws-sns-lifecycle.js

@@ -0,0 +1,186 @@
+const Emitter = require('events');
+const bent = require('bent');
+const assert = require('assert');
+const PORT = process.env.AWS_SNS_PORT || 3001;
+const {LifeCycleEvents} = require('./constants');
+const express = require('express');
+const app = express();
+const getString = bent('string');
+const AWS = require('aws-sdk');
+const sns = new AWS.SNS({apiVersion: '2010-03-31'});
+const autoscaling = new AWS.AutoScaling({apiVersion: '2011-01-01'});
+const {Parser} = require('xml2js');
+const parser = new Parser();
+const {validatePayload} = require('verify-aws-sns-signature');
+
+AWS.config.update({region: process.env.AWS_REGION});
+
+class SnsNotifier extends Emitter {
+  constructor(logger) {
+    super();
+
+    this.logger = logger;
+  }
+
+  async _handlePost(req, res) {
+    try {
+      const parsedBody = JSON.parse(req.body);
+      this.logger.debug({headers: req.headers, body: parsedBody}, 'Received HTTP POST from AWS');
+      if (!validatePayload(parsedBody)) {
+        this.logger.info('incoming AWS SNS HTTP POST failed signature validation');
+        return res.sendStatus(403);
+      }
+      this.logger.debug('incoming HTTP POST passed validation');
+      res.sendStatus(200);
+
+      switch (parsedBody.Type) {
+        case 'SubscriptionConfirmation':
+          const response = await getString(parsedBody.SubscribeURL);
+          const result = await parser.parseStringPromise(response);
+          this.subscriptionArn = result.ConfirmSubscriptionResponse.ConfirmSubscriptionResult[0].SubscriptionArn[0];
+          this.subscriptionRequestId = result.ConfirmSubscriptionResponse.ResponseMetadata[0].RequestId[0];
+          this.logger.info({
+            subscriptionArn: this.subscriptionArn,
+            subscriptionRequestId: this.subscriptionRequestId
+          }, 'response from SNS SubscribeURL');
+          const data = await this.describeInstance();
+          this.lifecycleState = data.AutoScalingInstances[0].LifecycleState;
+          break;
+
+        case 'Notification':
+          if (parsedBody.Subject.startsWith('Auto Scaling:  Lifecycle action \'TERMINATING\'')) {
+            const msg = JSON.parse(parsedBody.Message);
+            if (msg.EC2InstanceId === this.instanceId) {
+              this.logger.info('SnsNotifier - begin scale-in operation');
+              this.scaleInParams = {
+                AutoScalingGroupName: msg.AutoScalingGroupName,
+                LifecycleActionResult: 'CONTINUE',
+                LifecycleActionToken: msg.LifecycleActionToken,
+                LifecycleHookName: msg.LifecycleHookName
+              };
+              this.operationalState = LifeCycleEvents.ScaleIn;
+              this.emit(LifeCycleEvents.ScaleIn);
+              this.unsubscribe();
+            }
+            else {
+              this.logger.debug(`SnsNotifier - instance ${msg.EC2InstanceId} is scaling in (not us)`);
+            }
+          }
+          break;
+
+        default:
+          this.logger.info(`unhandled SNS Post Type: ${parsedBody.Type}`);
+      }
+
+    } catch (err) {
+      this.logger.error({err}, 'Error processing SNS POST request');
+      if (!res.headersSent) res.sendStatus(500);
+    }
+  }
+
+  async init() {
+    try {
+      this.logger.info('SnsNotifier: retrieving instance data');
+      this.instanceId = await getString('http://169.254.169.254/latest/meta-data/instance-id');
+      this.publicIp = await getString('http://169.254.169.254/latest/meta-data/public-ipv4');
+      this.snsEndpoint = `http://${this.publicIp}:${PORT}`;
+      this.logger.info({
+        instanceId: this.instanceId,
+        publicIp: this.publicIp,
+        snsEndpoint: this.snsEndpoint
+      }, 'retrieved AWS instance data');
+
+      // start listening
+      app.use(express.urlencoded({ extended: true }));
+      app.use(express.json());
+      app.use(express.text());
+      app.post('/', this._handlePost.bind(this));
+      app.use((err, req, res, next) => {
+        this.logger.error(err, 'burped error');
+        res.status(err.status || 500).json({msg: err.message});
+      });
+      app.listen(PORT);
+
+    } catch (err) {
+      this.logger.error({err}, 'Error retrieving AWS instance metadata');
+    }
+  }
+
+  async subscribe() {
+    try {
+      const response = await sns.subscribe({
+        Protocol: 'http',
+        TopicArn: process.env.AWS_SNS_TOPIC_ARM,
+        Endpoint: this.snsEndpoint
+      }).promise();
+      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+    } catch (err) {
+      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+    }
+  }
+
+  async unsubscribe() {
+    if (!this.subscriptionArn) throw new Error('SnsNotifier#unsubscribe called without an active subscription');
+    try {
+      const response = await sns.unsubscribe({
+        SubscriptionArn: this.subscriptionArn
+      }).promise();
+      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+    } catch (err) {
+      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+    }
+  }
+
+  completeScaleIn() {
+    assert(this.scaleInParams);
+    autoscaling.completeLifecycleAction(this.scaleInParams, (err, response) => {
+      if (err) return this.logger.error({err}, 'Error completing scale-in');
+      this.logger.info({response}, 'Successfully completed scale-in action');
+    });
+  }
+
+  describeInstance() {
+    return new Promise((resolve, reject) => {
+      if (!this.instanceId) return reject('instance-id unknown');
+      autoscaling.describeAutoScalingInstances({
+        InstanceIds: [this.instanceId]
+      }, (err, data) => {
+        if (err) {
+          this.logger.error({err}, 'Error describing instances');
+          reject(err);
+        } else {
+          this.logger.info({data}, 'SnsNotifier: describeInstance');
+          resolve(data);
+        }
+      });
+    });
+  }
+
+}
+
+module.exports = async function(logger) {
+  const notifier = new SnsNotifier(logger);
+  await notifier.init();
+  await notifier.subscribe();
+
+  process.on('SIGHUP', async() => {
+    try {
+      const data = await notifier.describeInstance();
+      const state = data.AutoScalingInstances[0].LifecycleState;
+      if (state !== notifier.lifecycleState) {
+        notifier.lifecycleState = state;
+        switch (state) {
+          case 'Standby':
+            notifier.emit(LifeCycleEvents.StandbyEnter);
+            break;
+          case 'InService':
+            notifier.emit(LifeCycleEvents.StandbyExit);
+            break;
+        }
+      }
+    } catch (err) {
+      console.error(err);
+    }
+  });
+  return notifier;
+};

lib/call-session.js

@@ -1,7 +1,15 @@
 const Emitter = require('events');
-const {makeRtpEngineOpts, SdpWantsSrtp} = require('./utils');
+const SrsClient = require('@jambonz/siprec-client-utils');
+const {
+  makeRtpEngineOpts,
+  SdpWantsSrtp,
+  nudgeCallCounts,
+  roundTripTime,
+  parseConnectionIp
+} = require('./utils');
+
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
-const {parseUri, SipError} = require('drachtio-srf');
+const {parseUri, stringifyUri, SipError} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-inbound');
 const MS_TEAMS_USER_AGENT = 'Microsoft.PSTNHub.SIPProxy';
 const MS_TEAMS_SIP_ENDPOINT = 'sip.pstnhub.microsoft.com';
@@ -13,8 +21,22 @@ const MS_TEAMS_SIP_ENDPOINT = 'sip.pstnhub.microsoft.com';
 const createBLegFromHeader = (req) => {
   const from = req.getParsedHeader('From');
   const uri = parseUri(from.uri);
-  if (uri && uri.user) return `sip:${uri.user}@localhost`;
-  return 'sip:anonymous@localhost';
+  if (uri && uri.user) return `<sip:${uri.user}@localhost>`;
+  return '<sip:anonymous@localhost>';
+};
+
+const createSiprecBody = (headers, sdp, type, content) => {
+  const sep = 'uniqueBoundary';
+  headers['Content-Type'] = `multipart/mixed;boundary="${sep}"`;
+  return `--${sep}\r
+Content-Type: application/sdp\r
+\r
+${sdp}\r
+--${sep}\r
+Content-Type: ${type}\r
+Content-Disposition: recording-session\r
+\r
+${content}`;
 };
 
 class CallSession extends Emitter {
@@ -24,18 +46,42 @@ class CallSession extends Emitter {
     this.res = res;
     this.srf = req.srf;
     this.logger = logger.child({callId: req.get('Call-ID')});
+    this.siprec = req.locals.siprec;
+    this.xml = req.locals.xml;
 
     this.getRtpEngine = req.srf.locals.getRtpEngine;
     this.getFeatureServer = req.srf.locals.getFeatureServer;
     this.stats = this.srf.locals.stats;
+    this.writeCdrs = this.srf.locals.writeCdrs;
     this.activeCallIds = this.srf.locals.activeCallIds;
+
+    this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
+    this._mediaReleased = false;
+
+    this.application_sid = req.locals.application_sid;
+    this.account_sid = req.locals.account_sid;
+    this.service_provider_sid = req.locals.service_provider_sid;
   }
 
   get isFromMSTeams() {
     return !!this.req.locals.msTeamsTenantFqdn;
   }
 
+  get privateSipAddress() {
+    return this.srf.locals.privateSipAddress;
+  }
+
+  get isMediaReleased() {
+    return this._mediaReleased;
+  }
+
+  get callerIsUsingSrtp() {
+    const tp = this.rtpEngineOpts?.uas?.mediaOpts['transport-protocol'];
+    return tp && -1 !== tp.indexOf('SAVP');
+  }
+
   async connect() {
+    const {sdp} = this.req.locals;
     this.logger.info('inbound call accepted for routing');
     const engine = this.getRtpEngine();
     if (!engine) {
@@ -45,21 +91,45 @@ class CallSession extends Emitter {
       return this.res.send(480);
     }
     debug(`got engine: ${JSON.stringify(engine)}`);
-    const {offer, answer, del} = engine;
+    const {
+      offer,
+      answer,
+      del,
+      blockMedia,
+      unblockMedia,
+      blockDTMF,
+      unblockDTMF,
+      playDTMF,
+      subscribeDTMF,
+      unsubscribeDTMF,
+      subscribeRequest,
+      subscribeAnswer,
+      unsubscribe
+    } = engine;
     this.offer = offer;
     this.answer = answer;
     this.del = del;
+    this.blockMedia = blockMedia;
+    this.unblockMedia = unblockMedia;
+    this.blockDTMF = blockDTMF;
+    this.unblockDTMF = unblockDTMF;
+    this.playDTMF = playDTMF;
+    this.subscribeDTMF = subscribeDTMF;
+    this.unsubscribeDTMF = unsubscribeDTMF;
+    this.subscribeRequest = subscribeRequest;
+    this.subscribeAnswer = subscribeAnswer;
+    this.unsubscribe = unsubscribe;
 
-    const featureServer = this.getFeatureServer();
+    const featureServer = await this.getFeatureServer();
     if (!featureServer) {
       this.logger.info('No available feature servers, rejecting call!');
       const tags = ['accepted:no', 'sipStatus:480', `originator:${this.req.locals.originator}`];
       this.stats.increment('sbc.terminations', tags);
       return this.res.send(480);
     }
-    debug(`using feature server ${featureServer}`);
+    this.logger.debug(`using feature server ${featureServer}`);
 
-    this.rtpEngineOpts = makeRtpEngineOpts(this.req, SdpWantsSrtp(this.req.body), false, this.isFromMSTeams);
+    this.rtpEngineOpts = makeRtpEngineOpts(this.req, SdpWantsSrtp(sdp), false, this.isFromMSTeams);
     this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
     const obj = parseUri(this.req.uri);
     let proxy, host, uri;
@@ -79,23 +149,45 @@ class CallSession extends Emitter {
     this.logger.info(`uri will be: ${uri}, proxy ${proxy}`);
 
     try {
-      const opts = Object.assign(this.rtpEngineOpts.offer, {sdp: this.req.body});
+      const opts = {
+        ...this.rtpEngineOpts.common,
+        ...this.rtpEngineOpts.uac.mediaOpts,
+        'from-tag': this.rtpEngineOpts.uas.tag,
+        direction:  ['public', 'private'],
+        sdp
+      };
+      const startAt = process.hrtime();
       const response = await this.offer(opts);
-      this.logger.debug({opts, response}, 'response from rtpengine to offer');
+      this.rtpengineIp = opts.sdp ? parseConnectionIp(opts.sdp) : 'undefined';
+      const rtt = roundTripTime(startAt);
+      this.stats.histogram('app.rtpengine.response_time', rtt, [
+        'direction:inbound', 'command:offer', `rtpengine:${this.rtpengineIp}`]);
+      this.logger.debug({opts, response, rtt, rtpengine: this.rtpengineIp}, 'response from rtpengine to offer');
       if ('ok' !== response.result) {
         this.logger.error({}, `rtpengine offer failed with ${JSON.stringify(response)}`);
         throw new Error('rtpengine failed: answer');
       }
 
-      // now send the INVITE in towards the feature servers
-      const headers = {
+      let headers = {
         'From': createBLegFromHeader(this.req),
         'To': this.req.get('To'),
+        'X-Account-Sid': this.req.locals.account_sid,
         'X-CID': this.req.get('Call-ID'),
-        'X-Forwarded-For': `${this.req.source_address}:${this.req.source_port}`
+        'X-Forwarded-For': `${this.req.source_address}`
       };
+      if (this.privateSipAddress) headers = {...headers, Contact: `<sip:${this.privateSipAddress}>`};
+
+      const spdOfferB = this.siprec && this.xml ?
+        createSiprecBody(headers, response.sdp, this.xml.type, this.xml.content) :
+        response.sdp;
+
       const responseHeaders = {};
-      if (this.req.locals.carrier) Object.assign(headers, {'X-Originating-Carrier': this.req.locals.carrier});
+      if (this.req.locals.carrier) {
+        Object.assign(headers, {
+          'X-Originating-Carrier': this.req.locals.carrier,
+          'X-Voip-Carrier-Sid': this.req.locals.voip_carrier_sid
+        });
+      }
       if (this.req.locals.msTeamsTenantFqdn) {
         Object.assign(headers, {'X-MS-Teams-Tenant-FQDN': this.req.locals.msTeamsTenantFqdn});
 
@@ -120,18 +212,36 @@ class CallSession extends Emitter {
 
       if (this.req.canceled) throw new Error('call canceled');
 
+      // now send the INVITE in towards the feature servers
       debug(`sending INVITE to ${proxy} with ${uri}`);
       const {uas, uac} = await this.srf.createB2BUA(this.req, this.res, uri, {
         proxy,
         headers,
         responseHeaders,
-        proxyRequestHeaders: ['all', '-Authorization', '-Max-Forwards', '-Record-Route', '-Session-Expires', 'Min-SE'],
-        proxyResponseHeaders: ['all'],
-        localSdpB: response.sdp,
+        proxyRequestHeaders: [
+          'all',
+          '-Authorization',
+          '-Max-Forwards',
+          '-Record-Route',
+          '-Session-Expires',
+          '-X-Subspace-Forwarded-For'
+        ],
+        proxyResponseHeaders: ['all', '-X-Trace-ID'],
+        localSdpB: spdOfferB,
         localSdpA: async(sdp, res) => {
-          this.toTag = res.getParsedHeader('To').params.tag;
-          const opts = Object.assign(this.rtpEngineOpts.answer, {sdp, 'to-tag': this.toTag});
+          this.rtpEngineOpts.uac.tag = res.getParsedHeader('To').params.tag;
+          const opts = {
+            ...this.rtpEngineOpts.common,
+            ...this.rtpEngineOpts.uas.mediaOpts,
+            'from-tag': this.rtpEngineOpts.uas.tag,
+            'to-tag': this.rtpEngineOpts.uac.tag,
+            sdp
+          };
+          const startAt = process.hrtime();
           const response = await this.answer(opts);
+          const rtt = roundTripTime(startAt);
+          this.stats.histogram('app.rtpengine.response_time', rtt, [
+            'direction:inbound', 'command:answer', `rtpengine:${this.rtpengineIp}`]);
           if ('ok' !== response.result) {
             this.logger.error(`rtpengine answer failed with ${JSON.stringify(response)}`);
             throw new Error('rtpengine failed: answer');
@@ -142,61 +252,176 @@ class CallSession extends Emitter {
 
       // successfully connected
       this.logger.info('call connected successfully to feature server');
+      debug('call connected successfully to feature server');
       this._setHandlers({uas, uac});
       return;
     } catch (err) {
-      this.rtpEngineResource.destroy();
+      this.rtpEngineResource.destroy().catch((err) => this.logger.info({err}, 'Error destroying rtpe after failure'));
       this.activeCallIds.delete(this.req.get('Call-ID'));
       this.stats.gauge('sbc.sip.calls.count', this.activeCallIds.size);
       if (err instanceof SipError) {
         const tags = ['accepted:no', `sipStatus:${err.status}`, `originator:${this.req.locals.originator}`];
         this.stats.increment('sbc.terminations', tags);
         this.logger.info(`call failed to connect to feature server with ${err.status}`);
-        return this.emit('failed');
+        this.emit('failed');
       }
       else if (err.message !== 'call canceled') {
         this.logger.error(err, 'unexpected error routing inbound call');
       }
+      this.srf.endSession(this.req);
     }
   }
 
   _setDlgHandlers(dlg) {
-    this.activeCallIds.set(this.req.get('Call-ID'), this);
+    const {callId} = dlg.sip;
+    this.activeCallIds.set(callId, this);
+    this.subscribeDTMF(this.logger, callId, this.rtpEngineOpts.uas.tag,
+      this._onDTMF.bind(this));
     dlg.on('destroy', () => {
+      debug('call ended with normal termination');
       this.logger.info('call ended with normal termination');
       this.rtpEngineResource.destroy().catch((err) => {});
-      this.activeCallIds.delete(this.req.get('Call-ID'));
+      this.activeCallIds.delete(callId);
       if (dlg.other && dlg.other.connected) dlg.other.destroy().catch((e) => {});
+
+      if (this.srsClient) {
+        this.srsClient.stop();
+        this.srsClient = null;
+      }
+
+      this.srf.endSession(this.req);
     });
+
     //re-invite
     dlg.on('modify', this._onReinvite.bind(this, dlg));
   }
 
   _setHandlers({uas, uac}) {
     this.emit('connected');
+    const callStart = Date.now();
     const tags = ['accepted:yes', 'sipStatus:200', `originator:${this.req.locals.originator}`];
     this.stats.increment('sbc.terminations', tags);
     this.activeCallIds.set(this.req.get('Call-ID'), this);
-
+    const call_sid = uac.res?.get('X-Call-Sid');
+    const application_sid = this.application_sid || uac.res?.get('X-Application-Sid');
+    if (this.req.locals.cdr) {
+      this.req.locals.cdr = {
+        ...this.req.locals.cdr,
+        answered: true,
+        answered_at: callStart,
+        ...(call_sid && {call_sid}),
+        ...(application_sid && {application_sid}),
+        trace_id: uac.res?.get('X-Trace-ID') || '00000000000000000000000000000000'
+      };
+    }
     this.uas = uas;
     this.uac = uac;
     [uas, uac].forEach((dlg) => {
-      //hangup
-      dlg.on('destroy', () => {
-        this.logger.info('call ended with normal termination');
+      dlg.on('destroy', async() => {
+        const other = dlg.other;
         this.rtpEngineResource.destroy().catch((err) => {});
         this.activeCallIds.delete(this.req.get('Call-ID'));
-        dlg.other.destroy().catch((e) => {});
+        try {
+          await other.destroy();
+        } catch (err) {}
+        this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uas.tag);
+
+        const trackingOn = process.env.JAMBONES_TRACK_ACCOUNT_CALLS ||
+          process.env.JAMBONES_TRACK_SP_CALLS ||
+          process.env.JAMBONES_TRACK_APP_CALLS;
+
+        if (process.env.JAMBONES_HOSTING || trackingOn) {
+          const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
+          await nudgeCallCounts(this.logger, {
+            service_provider_sid: this.service_provider_sid,
+            account_sid: this.account_sid,
+            application_sid: this.application_sid
+          }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
+            .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
+        }
+
+        /* write cdr for connected call */
+        if (this.req.locals.cdr) {
+          const now = Date.now();
+          const trunk = ['trunk', 'teams'].includes(this.req.locals.originator) ?
+            this.req.locals.carrier :
+            this.req.locals.originator;
+          const cdr = {...this.req.locals.cdr,
+            terminated_at: now,
+            termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
+            sip_status: 200,
+            duration: Math.floor((now - callStart) / 1000),
+            trunk
+          };
+          this.logger.info({cdr}, 'going to write a cdr now..');
+          this.writeCdrs({...this.req.locals.cdr,
+            terminated_at: now,
+            termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
+            sip_status: 200,
+            duration: Math.floor((now - callStart) / 1000),
+            trunk
+          })
+            .then(() => this.logger.debug('successfully wrote cdr'))
+            .catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
+        }
+        /* de-link the 2 Dialogs for GC */
+        dlg.removeAllListeners();
+        other.removeAllListeners();
+        dlg.other = null;
+        other.other = null;
+
+        if (this.srsClient) {
+          this.srsClient.stop();
+          this.srsClient = null;
+        }
+
+        this.logger.info(`call ended with normal termination, there are ${this.activeCallIds.size} active`);
+        this.srf.endSession(this.req);
       });
     });
-    uas.on('modify', this._onReinvite.bind(this, uas));
 
-    uac.on('modify', this._onFeatureServerReinvite.bind(this, uac));
+    this.subscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uas.tag,
+      this._onDTMF.bind(this, uac));
+
+    uas.on('modify', this._onReinvite.bind(this, uas));
+    uac.on('modify', this._onReinvite.bind(this, uac));
+
     uac.on('refer', this._onFeatureServerTransfer.bind(this, uac));
     uas.on('refer', this._onRefer.bind(this, uas));
 
+    uas.on('info', this._onInfo.bind(this, uas));
+    uac.on('info', this._onInfo.bind(this, uac));
+
     // default forwarding of other request types
-    forwardInDialogRequests(uas, ['info', 'notify', 'options', 'message']);
+    forwardInDialogRequests(uas, ['notify', 'options', 'message']);
+  }
+
+  async _onDTMF(dlg, payload) {
+    this.logger.info({payload}, '_onDTMF');
+    try {
+      let dtmf;
+      switch (payload.event) {
+        case 10:
+          dtmf = '*';
+          break;
+        case 11:
+          dtmf = '#';
+          break;
+        default:
+          dtmf = '' + payload.event;
+          break;
+      }
+      await dlg.request({
+        method: 'INFO',
+        headers: {
+          'Content-Type': 'application/dtmf-relay'
+        },
+        body: `Signal=${dtmf}
+Duration=${payload.duration} `
+      });
+    } catch (err) {
+      this.logger.info({err}, 'Error sending INFO application/dtmf-relay');
+    }
   }
 
   /**
@@ -206,7 +431,19 @@ class CallSession extends Emitter {
    */
   async replaces(req, res) {
     try {
-      let opts = Object.assign(this.rtpEngineOpts.offer, {sdp: req.body});
+      const fromTag = this.rtpEngineOpts.uas.tag;
+      const toTag =  this.rtpEngineOpts.uac.tag;
+      const offerMedia = this.rtpEngineOpts.uac.mediaOpts;
+      const answerMedia = this.rtpEngineOpts.uas.mediaOpts;
+      const direction = ['public', 'private'];
+      let opts = {
+        ...this.rtpEngineOpts.common,
+        ...offerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        direction,
+        sdp: req.body,
+      };
       let response = await this.offer(opts);
       if ('ok' !== response.result) {
         res.send(488);
@@ -214,8 +451,13 @@ class CallSession extends Emitter {
       }
       this.logger.info({opts, response}, 'sent offer for reinvite to rtpengine');
       const sdp = await this.uac.modify(response.sdp);
-      opts = Object.assign(this.rtpEngineOpts.answer, {sdp, 'to-tag': this.toTag});
-      Object.assign(this.rtpEngineOpts.offer, {'to-tag': this.toTag});
+      opts = {
+        ...this.rtpEngineOpts.common,
+        ...answerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        sdp
+      };
       response = await this.answer(opts);
       if ('ok' !== response.result) {
         res.send(488);
@@ -233,6 +475,8 @@ class CallSession extends Emitter {
         });
       }
 
+      this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uas.tag);
+
       const uas = await this.srf.createUAS(req, res, {
         localSdp: response.sdp,
         headers
@@ -253,38 +497,230 @@ class CallSession extends Emitter {
 
   async _onReinvite(dlg, req, res) {
     try {
-      let opts = Object.assign(this.rtpEngineOpts.offer, {sdp: req.body, 'to-tag': this.toTag});
+      /* check for re-invite with no SDP -- seen that from BT when they provide UUI info */
+      if (!req.body) {
+        this.logger.info('got a reINVITE with no SDP; just respond with our current offer');
+        res.send(200, {body: dlg.local.sdp});
+        return;
+      }
+      const offeredSdp = Array.isArray(req.payload) && req.payload.length > 1 ?
+        req.payload.find((p) => p.type === 'application/sdp').content :
+        req.body;
+
+      const reason = req.get('X-Reason');
+      const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
+      const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
+      const offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
+      const answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
+      const direction =  dlg.type === 'uas' ? ['public', 'private'] : ['private', 'public'];
+      let opts = {
+        ...this.rtpEngineOpts.common,
+        ...offerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        direction,
+        sdp: offeredSdp,
+      };
+      if (reason && opts.flags && !opts.flags.includes('reset')) opts.flags.push('reset');
+
       let response = await this.offer(opts);
       if ('ok' !== response.result) {
         res.send(488);
         throw new Error(`_onReinvite: rtpengine failed: offer: ${JSON.stringify(response)}`);
       }
-      this.logger.info({opts, response}, 'sent offer for reinvite to rtpengine');
-      const sdp = await dlg.other.modify(response.sdp);
-      opts = Object.assign(this.rtpEngineOpts.answer, {sdp});
+
+      /* if this is a re-invite from the FS to change media anchoring, avoid sending the reinvite out */
+      let sdp;
+      if (reason && dlg.type === 'uac' && ['release-media', 'anchor-media'].includes(reason) &&
+        !this.callerIsUsingSrtp) {
+        this.logger.info({response}, `got a reinvite from FS to ${reason}`);
+        sdp = dlg.other.remote.sdp;
+        answerMedia.flags = ['asymmetric', 'port latching'];
+        this._mediaReleased = 'release-media' === reason;
+      }
+      else {
+        sdp = await dlg.other.modify(response.sdp);
+      }
+      opts = {
+        ...this.rtpEngineOpts.common,
+        ...answerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        sdp
+      };
       response = await this.answer(opts);
       if ('ok' !== response.result) {
         res.send(488);
         throw new Error(`_onReinvite: rtpengine failed: ${JSON.stringify(response)}`);
       }
-      this.logger.info({opts, response}, 'sent answer for reinvite to rtpengine');
       res.send(200, {body: response.sdp});
     } catch (err) {
       this.logger.error(err, 'Error handling reinvite');
     }
   }
 
-  async _onFeatureServerReinvite(dlg, req, res) {
+  async _onInfo(dlg, req, res) {
+    const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
+    const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
+    const contentType = req.get('Content-Type');
     try {
-      const opts = Object.assign(this.rtpEngineOpts.answer, {sdp: req.body, 'to-tag': this.toTag});
-      const response = await this.answer(opts);
-      if ('ok' !== response.result) {
-        res.send(488);
-        throw new Error(`_onFeatureServerReinvite: rtpengine failed: ${JSON.stringify(response)}`);
+      if (dlg.type === 'uac' && req.has('X-Reason')) {
+        const reason = req.get('X-Reason');
+        const opts = {
+          ...this.rtpEngineOpts.common,
+          flags: ['reset'],
+          'from-tag': fromTag
+        };
+        this.logger.info(`_onInfo: got request ${reason}`);
+
+        if (reason.startsWith('mute')) {
+          const response = Promise.all([this.blockMedia(opts), this.blockDTMF(opts)]);
+          res.send(200);
+          this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
+        }
+        else if (reason.startsWith('unmute')) {
+          const response = Promise.all([this.unblockMedia(opts), this.unblockDTMF(opts)]);
+          res.send(200);
+          this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
+        }
+        else if (reason.includes('CallRecording')) {
+          let succeeded = false;
+          if (reason === 'startCallRecording') {
+            const from = this.req.getParsedHeader('From');
+            const to = this.req.getParsedHeader('To');
+            const aorFrom = from.uri;
+            const aorTo = to.uri;
+            this.logger.info({to, from}, 'startCallRecording request for a call');
+
+            const srsUrl = req.get('X-Srs-Url');
+            const srsRecordingId = req.get('X-Srs-Recording-ID');
+            const callSid = req.get('X-Call-Sid');
+            const accountSid = req.get('X-Account-Sid');
+            const applicationSid = req.get('X-Application-Sid');
+            if (this.srsClient) {
+              res.send(400);
+              this.logger.info('discarding duplicate startCallRecording request for a call');
+              return;
+            }
+            if (!srsUrl) {
+              this.logger.info('startCallRecording request is missing X-Srs-Url header');
+              res.send(400);
+              return;
+            }
+            this.srsClient = new SrsClient(this.logger, {
+              srf: dlg.srf,
+              direction: 'inbound',
+              originalInvite: this.req,
+              callingNumber: this.req.callingNumber,
+              calledNumber: this.req.calledNumber,
+              srsUrl,
+              srsRecordingId,
+              callSid,
+              accountSid,
+              applicationSid,
+              rtpEngineOpts: this.rtpEngineOpts,
+              fromTag,
+              toTag,
+              aorFrom,
+              aorTo,
+              subscribeRequest: this.subscribeRequest,
+              subscribeAnswer: this.subscribeAnswer,
+              del: this.del,
+              blockMedia: this.blockMedia,
+              unblockMedia: this.unblockMedia,
+              unsubscribe: this.unsubscribe
+            });
+            try {
+              succeeded = await this.srsClient.start();
+            } catch (err) {
+              this.logger.error({err}, 'Error starting SipRec call recording');
+            }
+          }
+          else if (reason === 'stopCallRecording') {
+            if (!this.srsClient) {
+              res.send(400);
+              this.logger.info('discarding stopCallRecording request because we are not recording');
+              return;
+            }
+            try {
+              succeeded = await this.srsClient.stop();
+            } catch (err) {
+              this.logger.error({err}, 'Error stopping SipRec call recording');
+            }
+            this.srsClient = null;
+          }
+          else if (reason === 'pauseCallRecording') {
+            if (!this.srsClient || this.srsClient.paused) {
+              this.logger.info('discarding invalid pauseCallRecording request');
+              res.send(400);
+              return;
+            }
+            succeeded = await this.srsClient.pause();
+          }
+          else if (reason === 'resumeCallRecording') {
+            if (!this.srsClient || !this.srsClient.paused) {
+              res.send(400);
+              this.logger.info('discarding invalid resumeCallRecording request');
+              return;
+            }
+            succeeded = await this.srsClient.resume();
+          }
+          res.send(succeeded ? 200 : 503);
+        }
+      }
+      else if (dlg.type === 'uas' && ['application/dtmf-relay', 'application/dtmf'].includes(contentType)) {
+        const arr = /Signal=\s*([0-9#*])/.exec(req.body);
+        if (!arr) {
+          this.logger.info({body: req.body}, '_onInfo: invalid INFO dtmf request');
+          throw new Error(`_onInfo: no dtmf in body for ${contentType}`);
+        }
+        const code = arr[1];
+        const arr2 = /Duration=\s*(\d+)/.exec(req.body);
+        const duration = arr2 ? arr2[1] : 250;
+
+        if (this.isMediaReleased) {
+          /* just relay on to the feature server */
+          this.logger.info({code, duration}, 'got SIP INFO DTMF from caller, relaying to feature server');
+          this._onDTMF(dlg.other, {event: code, duration})
+            .catch((err) => this.logger.info({err}, 'Error relaying DTMF to feature server'));
+          res.send(200);
+        }
+        else {
+          /* else convert SIP INFO to RFC 2833 telephony events */
+          this.logger.info({code, duration}, 'got SIP INFO DTMF from caller, converting to RFC 2833');
+          const opts = {
+            ...this.rtpEngineOpts.common,
+            'from-tag': this.rtpEngineOpts.uas.tag,
+            code,
+            duration
+          };
+          const response = await this.playDTMF(opts);
+          if ('ok' !== response.result) {
+            this.logger.info({response}, `rtpengine playDTMF failed with ${JSON.stringify(response)}`);
+            throw new Error('rtpengine failed: answer');
+          }
+          res.send(200);
+        }
+      }
+      else {
+        const immutableHdrs = ['via', 'from', 'to', 'call-id', 'cseq', 'max-forwards', 'content-length'];
+        const headers = {};
+        Object.keys(req.headers).forEach((h) => {
+          if (!immutableHdrs.includes(h)) headers[h] = req.headers[h];
+        });
+        const response = await dlg.other.request({method: 'INFO', headers, body: req.body});
+        const responseHeaders = {};
+        if (response.has('Content-Type')) {
+          Object.assign(responseHeaders, {'Content-Type': response.get('Content-Type')});
+        }
+        res.send(response.status, {headers: responseHeaders, body: response.body});
       }
-      res.send(200, {body: dlg.local.sdp});
     } catch (err) {
-      this.logger.error(err, 'Error handling reinvite from feature server');
+      if (this.srsClient) {
+        this.srsClient = null;
+      }
+      res.send(500);
+      this.logger.info({err}, `Error handing INFO request on ${dlg.type} leg`);
     }
   }
 
@@ -292,11 +728,50 @@ class CallSession extends Emitter {
     try {
       const referTo = req.getParsedHeader('Refer-To');
       const uri = parseUri(referTo.uri);
-      this.logger.info({uri, referTo}, 'received REFER from feature server');
+      this.logger.info({uri, referTo, headers: req.headers}, 'received REFER from feature server');
       const arr = /context-(.*)/.exec(uri.user);
       if (!arr) {
-        this.logger.info(`invalid Refer-To header: ${referTo.uri}`);
-        return res.send(501);
+        /* call transfer requested */
+        const {gateway} = this.req.locals;
+        const referredBy = req.getParsedHeader('Referred-By');
+        if (!referredBy) return res.send(400);
+        const u = parseUri(referredBy.uri);
+
+        let selectedGateway = false;
+        let e164 = false;
+        if (gateway) {
+          /* host of Refer-to to an outbound gateway */
+          const gw = await this.srf.locals.getOutboundGatewayForRefer(gateway.voip_carrier_sid);
+          if (gw) {
+            selectedGateway = true;
+            e164 = gw.e164_leading_plus;
+            uri.host = gw.ipv4;
+            uri.port = gw.port;
+          }
+        }
+        if (!selectedGateway) {
+          uri.host = this.req.source_address;
+          uri.port = this.req.source_port;
+        }
+        if (e164 && !uri.user.startsWith('+')) {
+          uri.user = `+${uri.user}`;
+        }
+        // eslint-disable-next-line no-unused-vars
+        const {via, from, to, 'call-id':callid, cseq, 'max-forwards':maxforwards,
+          // eslint-disable-next-line no-unused-vars
+          'content-length':contentlength, 'refer-to':_referto, 'referred-by':_referredby,
+          ...customHeaders
+        } = req.headers;
+
+        const response = await this.uas.request({
+          method: 'REFER',
+          headers: {
+            'Refer-To': stringifyUri(uri),
+            'Referred-By': stringifyUri(u),
+            ...customHeaders
+          }
+        });
+        return res.send(response.status);
       }
       res.send(202);
 
@@ -316,6 +791,7 @@ class CallSession extends Emitter {
         this.rtpEngineResource.destroy();
         this.activeCallIds.delete(this.req.get('Call-ID'));
         uac.other.destroy();
+        this.srf.endSession(this.req);
       });
       // now we can destroy the old dialog
       dlg.destroy().catch(() => {});
@@ -387,6 +863,7 @@ class CallSession extends Emitter {
 
         // successfully connected
         this.logger.info('successfully connected new call leg for REFER');
+        this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uas.tag);
         this.referInvite = null;
         sendNotify(this.uas, '200 OK');
         this.uas.destroy();
@@ -400,8 +877,20 @@ class CallSession extends Emitter {
       }
     }
     else {
-      // TODO: forward on to feature server
-      res.send(501);
+      /* REFER coming in from a sip device, forward to feature server */
+      try {
+        const response = await dlg.other.request({
+          method: 'REFER',
+          headers: {
+            'Refer-To': req.get('Refer-To'),
+            'Referred-By': req.get('Referred-By'),
+            'User-Agent': req.get('User-Agent')
+          }
+        });
+        res.send(response.status, response.reason);
+      } catch (err) {
+        this.logger.error({err}, 'CallSession:_onRefer: error handling incoming REFER');
+      }
     }
   }
 

lib/constants.json

@@ -0,0 +1,7 @@
+{
+  "LifeCycleEvents" : {
+    "ScaleIn": "scale-in",
+    "StandbyEnter": "standby-enter",
+    "StandbyExit": "standby-exit"
+  }
+}

lib/db-utils.js

@@ -0,0 +1,208 @@
+const assert = require('assert');
+const CIDRMatcher = require('cidr-matcher');
+const {parseUri} = require('drachtio-srf');
+const {normalizeDID} = require('./utils');
+
+const sqlSelectSPForAccount = 'SELECT service_provider_sid FROM accounts WHERE account_sid = ?';
+
+const sqlSelectAllCarriersForAccountByRealm =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
+FROM sip_gateways sg, voip_carriers vc, accounts acc 
+WHERE acc.sip_realm = ? 
+AND vc.account_sid = acc.account_sid 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid`;
+
+const sqlSelectAllCarriersForSPByRealm =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
+FROM sip_gateways sg, voip_carriers vc, accounts acc 
+WHERE acc.sip_realm = ? 
+AND vc.service_provider_sid = acc.service_provider_sid  
+AND vc.account_sid IS NULL 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid`;
+
+const sqlSelectAllGatewaysForSP =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid 
+AND vc.service_provider_sid IS NOT NULL 
+AND vc.is_active = 1`;
+
+const sqlCarriersForAccountBySid =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
+FROM sip_gateways sg, voip_carriers vc, accounts acc 
+WHERE acc.account_sid = ? 
+AND vc.account_sid = acc.account_sid 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid`;
+
+const sqlAccountByRealm = 'SELECT * from accounts WHERE sip_realm = ?';
+const sqlAccountBySid = 'SELECT * from accounts WHERE account_sid = ?';
+
+const sqlQueryApplicationByDid = `
+SELECT * FROM phone_numbers 
+WHERE number = ? 
+AND voip_carrier_sid = ?`;
+
+const sqlQueryAllDidsForCarrier = `
+SELECT * FROM phone_numbers 
+WHERE voip_carrier_sid = ?`;
+
+const sqlSelectOutboundGatewayForCarrier = `
+SELECT ipv4, port, e164_leading_plus  
+FROM sip_gateways sg, voip_carriers vc 
+WHERE sg.voip_carrier_sid = ? 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid 
+AND outbound = 1`;
+
+const gatewayMatchesSourceAddress = (source_address, gw) => {
+  if (32 === gw.netmask && gw.ipv4 === source_address) return true;
+  if (gw.netmask < 32) {
+    const matcher = new CIDRMatcher([`${gw.ipv4}/${gw.netmask}`]);
+    return matcher.contains(source_address);
+  }
+  return false;
+};
+
+module.exports = (srf, logger) => {
+  const {pool}  = srf.locals.dbHelpers;
+  const pp = pool.promise();
+
+  const getSPForAccount = async(account_sid) => {
+    const [r] = await pp.query(sqlSelectSPForAccount, [account_sid]);
+    if (0 === r.length) return null;
+    return r[0].service_provider_sid;
+  };
+
+  const getOutboundGatewayForRefer = async(voip_carrier_sid) => {
+    try {
+      const [r] = await pp.query(sqlSelectOutboundGatewayForCarrier, [voip_carrier_sid]);
+      if (0 === r.length) return null;
+
+      /* if multiple, prefer a DNS name */
+      const hasDns = r.find((row) => row.ipv4.match(/^[A-Za-z]/));
+      return hasDns || r[0];
+    } catch (err) {
+      logger.error({err}, 'getOutboundGatewayForRefer');
+    }
+  };
+
+  const getApplicationForDidAndCarrier = async(req, voip_carrier_sid) => {
+    const did = normalizeDID(req.calledNumber);
+
+    try {
+      /* straight DID match */
+      const [r] = await pp.query(sqlQueryApplicationByDid, [did, voip_carrier_sid]);
+      if (r.length) return r[0].application_sid;
+
+      /* wildcard / regex match */
+      const [r2] = await pp.query(sqlQueryAllDidsForCarrier, [voip_carrier_sid]);
+      const match = r2
+        .filter((o) => o.number.match(/\D/))                  // look at anything with non-digit characters
+        .sort((a, b) => b.number.length - a.number.length)    // prefer longest match
+        .find((o) => did.match(new RegExp(o.number.endsWith('*') ? `${o.number.slice(0, -1)}\\d*` : o.number)));
+      if (match) return match.application_sid;
+      return null;
+    } catch (err) {
+      logger.error({err}, 'getApplicationForDidAndCarrier');
+    }
+  };
+
+  const wasOriginatedFromCarrier = async(req) => {
+    const failure = {fromCarrier: false};
+    const uri = parseUri(req.uri);
+    const isDotDecimal = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/.test(uri.host);
+
+    if (isDotDecimal) {
+      if (process.env.JAMBONES_HOSTING) {
+        if (!process.env.SBC_ACCOUNT_SID) return failure;
+
+        /* look for carrier only within that account */
+        const [r] = await pp.query(sqlCarriersForAccountBySid,
+          [process.env.SBC_ACCOUNT_SID, req.source_address, req.source_port]);
+        if (0 === r.length) return failure;
+        const service_provider_sid = await getSPForAccount(process.env.SBC_ACCOUNT_SID);
+        return {
+          fromCarrier: true,
+          gateway: r[0],
+          account_sid: process.env.SBC_ACCOUNT_SID,
+          service_provider_sid
+        };
+      }
+      else {
+        /* we may have a carrier at the service provider level */
+        const [gw] = await pp.query(sqlSelectAllGatewaysForSP);
+        const matches = gw.filter(gatewayMatchesSourceAddress.bind(null, req.source_address));
+        if (matches.length) {
+          /* we have one or more carriers that match.  Now we need to find one with a provisioned phone number */
+          const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+          const did = normalizeDID(req.calledNumber);
+          const sql =  `SELECT * FROM phone_numbers WHERE number = ${did} AND voip_carrier_sid IN (${vc_sids})`;
+          logger.debug({matches, sql, did, vc_sids}, 'looking up DID');
+
+          const [r] = await pp.query(sql);
+          if (0 === r.length) {
+            /* came from a carrier, but number is not provisioned..
+               check if we only have a single account, otherwise we have no
+               way of knowing which account this is for
+            */
+            const [r] = await pp.query('SELECT count(*) as count from accounts where service_provider_sid = ?',
+              matches[0].service_provider_sid);
+            if (r[0].count === 0) return {fromCarrier: true};
+            else {
+              const [accounts] = await pp.query('SELECT * from accounts where service_provider_sid = ?',
+                matches[0].service_provider_sid);
+              return {
+                fromCarrier: true,
+                gateway: matches[0],
+                service_provider_sid: accounts[0].service_provider_sid,
+                account_sid: accounts[0].account_sid,
+                account: accounts[0]
+              };
+            }
+          }
+          const gateway = matches.find((m) => m.voip_carrier_sid === r[0].voip_carrier_sid);
+          const [accounts] = await pp.query(sqlAccountBySid, r[0].account_sid);
+          assert(accounts.length);
+          return {
+            fromCarrier: true,
+            gateway,
+            service_provider_sid: accounts[0].service_provider_sid,
+            account_sid: r[0].account_sid,
+            application_sid: r[0].application_sid,
+            account: accounts[0]
+          };
+        }
+        return failure;
+      }
+    }
+
+    /* get all the carriers and gateways for the account owning this sip realm */
+    const [gwAcc] = await pp.query(sqlSelectAllCarriersForAccountByRealm, uri.host);
+    const [gwSP] = gwAcc.length ? [[]] : await pp.query(sqlSelectAllCarriersForSPByRealm, uri.host);
+    const gw = gwAcc.concat(gwSP);
+    const selected = gw.find(gatewayMatchesSourceAddress.bind(null, req.source_address));
+    if (selected) {
+      const [a] = await pp.query(sqlAccountByRealm, uri.host);
+      if (0 === a.length) return failure;
+      return {
+        fromCarrier: true,
+        gateway: selected,
+        service_provider_sid: a[0].service_provider_sid,
+        account_sid: a[0].account_sid,
+        application_sid: selected.application_sid,
+        account: a[0]
+      };
+    }
+    return failure;
+  };
+
+  return {
+    wasOriginatedFromCarrier,
+    getApplicationForDidAndCarrier,
+    getOutboundGatewayForRefer,
+    getSPForAccount
+  };
+};

lib/fs-tracking.js

@@ -1,100 +1,33 @@
-const contacts = new Map();
-const noopLogger = {info: () => {}, error: () => {}};
-const debug = require('debug')('jambonz:sbc-inbound');
+const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+const assert = require('assert');
+
+assert.ok(!process.env.K8S || process.env.K8S_FEATURE_SERVER_SERVICE_NAME,
+  'when running in Kubernetes, an env var K8S_FEATURE_SERVER_SERVICE_NAME is required');
 
 module.exports = (srf, logger) => {
-  logger = logger || noopLogger;
-  let dynamic = true;
+  const {retrieveSet, createSet} = srf.locals.realtimeDbHelpers;
   let idx = 0;
-  const stats = srf.locals.stats;
-  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
 
-  const {createSet} = require('@jambonz/realtimedb-helpers')({
-    host: process.env.JAMBONES_REDIS_HOST || 'localhost',
-    port: process.env.JAMBONES_REDIS_PORT || 6379
-  }, logger);
+  if ('test' === process.env.NODE_ENV) {
+    createSet(setName, [process.env.JAMBONES_FEATURE_SERVERS]);
+  }
 
-  srf.options((req, res) => {
-    res.send(200);
-    if (req.has('X-FS-Status')) {
-      const uri = `${req.source_address}:${req.source_port}`;
-      const status = req.get('X-FS-Status');
-      const calls = req.has('X-FS-Calls') ? parseInt(req.get('X-FS-Calls')) : 0;
-      if (status === 'open') {
-        const adding = !contacts.has(uri);
-        debug(`Feature server at ${uri} has ${calls} calls`);
-        contacts.set(uri, {pingTime: new Date(), calls: calls});
-        if (adding) {
-          logger.info(`adding feature server at ${uri}: ${[...contacts.keys()]}`);
-          stats.gauge('sbc.featureservers.count', contacts.size);
-          const featureServerIps = [...contacts.keys()].map((u) => {
-            const arr = /^(.*):\d+$/.exec(u);
-            return arr[1];
-          });
-          createSet(setName, new Set(featureServerIps));
-        }
+  return async() => {
+    try {
+      if (process.env.K8S) {
+        return process.env.K8S_FEATURE_SERVER_SERVICE_NAME;
       }
       else {
-        if (contacts.has(uri)) {
-          contacts.delete(uri);
-          logger.info(`removing feature server at ${uri}, leaving ${[...contacts.keys()]}`);
-          stats.gauge('sbc.featureservers.count', contacts.size);
-          const featureServerIps = [...contacts.keys()].map((u) => {
-            const arr = /^(.*):\d+$/.exec(u);
-            return arr[1];
-          });
-          createSet(setName, new Set(featureServerIps));
+        const fs = await retrieveSet(setName);
+        if (0 === fs.length) {
+          logger.info('No available feature servers to handle incoming call');
+          return;
         }
+        logger.debug({fs}, `retrieved ${setName}`);
+        return fs[idx++ % fs.length];
       }
+    } catch (err) {
+      logger.error({err}, `Error retrieving ${setName}`);
     }
-  });
-
-  // NB: this should only be used for test suite at this point
-  // in actual scenario OPTIONS pings from feature servers are used
-  if (process.env.NODE_ENV === 'test' && process.env.JAMBONES_FEATURE_SERVERS) {
-    dynamic = false;
-    process.env.JAMBONES_FEATURE_SERVERS
-      .split(',')
-      .map((hp) => hp.trim())
-      .forEach((uri) => contacts.set(uri, {active: 0, calls: 0}));
-    debug(`using static list of feature servers: ${[ ...contacts]}`);
-  }
-
-  if (dynamic) {
-    const CHECK_INTERVAL = 35;
-    setInterval(() => {
-      const dead = [];
-      const deadline = Date.now() - 90000;
-      for (const obj of contacts) {
-        if (obj[1].pingTime.getTime() < deadline) dead.push(obj[0]);
-      }
-      dead.forEach((uri) => {
-        logger.info(`removing feature server at ${uri} due to lack of OPTIONS ping`);
-        contacts.delete(uri);
-      });
-
-      const keys = [ ...contacts.keys() ];
-      debug({keys}, `there are ${keys.length} feature servers online`);
-      stats.gauge('sbc.featureservers.count', contacts.size);
-    }, CHECK_INTERVAL * 1000);
-  }
-
-  return () => {
-    let selectedUri;
-
-    if (dynamic) {
-      const featureServers = [ ...contacts].map((o) => Object.assign({}, {uri: o[0]}, o[1]));
-      debug({featureServers}, 'selecting feature servers with least calls');
-      const fs = featureServers.sort((a, b) => (a.calls - b.calls)).shift();
-      if (!fs) logger.info('No available feature servers!');
-      else selectedUri = fs.uri;
-    }
-    else {
-      const featureServers = [ ...contacts].map((o) => o[0]);
-      debug({featureServers}, 'selecting feature servers from static list');
-      selectedUri = featureServers[idx++ % featureServers.length];
-      debug(`selected ${selectedUri}`);
-    }
-    return selectedUri;
   };
 };

lib/middleware.js

@@ -1,28 +1,90 @@
 const debug = require('debug')('jambonz:sbc-inbound');
+const assert = require('assert');
 const Emitter = require('events');
 const parseUri = require('drachtio-srf').parseUri;
-const msProxyIps = process.env.MS_TEAMS_SIP_PROXY_IPS ? process.env.MS_TEAMS_SIP_PROXY_IPS.split(',').map((i) => i.trim()) : [];
+const {nudgeCallCounts} = require('./utils');
+const msProxyIps = process.env.MS_TEAMS_SIP_PROXY_IPS ?
+  process.env.MS_TEAMS_SIP_PROXY_IPS.split(',').map((i) => i.trim()) :
+  [];
 
-class AuthOutcomeReporter extends Emitter {
-  constructor(stats) {
-    super();
-    this.on('regHookOutcome', ({rtt, status}) => {
-      stats.histogram('app.hook.response_time', rtt, ['hook_type:auth', `status:${status}`]);
-    });
-  }
-}
+const initCdr = (req) => {
+  return {
+    from: req.callingNumber,
+    to: req.calledNumber,
+    sip_callid: req.get('Call-ID'),
+    duration: 0,
+    attempted_at: Date.now(),
+    direction: 'inbound',
+    host: req.srf.locals.sipAddress,
+    remote_host: req.source_address,
+    answered: false
+  };
+};
 
 module.exports = function(srf, logger) {
-  const {lookupSipGatewayBySignalingAddress, lookupAuthHook}  = srf.locals.dbHelpers;
-  const {stats} = srf.locals;
-  const authenticator = require('jambonz-http-authenticator')(lookupAuthHook, logger, {
+  class AuthOutcomeReporter extends Emitter {
+    constructor(stats) {
+      super();
+      this
+        .on('regHookOutcome', ({rtt, status}) => {
+          stats.histogram('app.hook.response_time', rtt, ['hook_type:auth', `status:${status}`]);
+        })
+        .on('error', async(err, req) => {
+          const {account_sid, account} = req.locals;
+          const {writeAlerts, AlertType} = req.srf.locals;
+          if (account_sid) {
+            let opts = {account_sid, service_provider_sid: account.service_provider_sid};
+            if (err.code === 'ECONNREFUSED') {
+              opts = {...opts, alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE, url: err.hook};
+            }
+            else if (err.code === 'ENOTFOUND') {
+              opts = {...opts, alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE, url: err.hook};
+            }
+            else if (err.name === 'StatusError') {
+              opts = {...opts, alert_type: AlertType.WEBHOOK_STATUS_FAILURE, url: err.hook, status: err.statusCode};
+            }
+
+            if (opts.alert_type) {
+              try {
+                await writeAlerts(opts);
+              } catch (err) {
+                logger.error({err, opts}, 'Error writing alert');
+              }
+            }
+          }
+        });
+    }
+  }
+
+  const {
+    lookupAuthHook,
+    lookupAppByTeamsTenant,
+    lookupAccountBySipRealm,
+    lookupAccountBySid,
+    lookupAccountCapacitiesBySid,
+    queryCallLimits
+  }  = srf.locals.dbHelpers;
+  const {stats, writeCdrs} = srf.locals;
+  const authenticator = require('@jambonz/http-authenticator')(lookupAuthHook, logger, {
     blacklistUnknownRealms: true,
     emitter: new AuthOutcomeReporter(stats)
   });
 
-  function initLocals(req, res, next) {
-    req.locals = req.locals || {};
+  const initLocals = (req, res, next) => {
     const callId = req.get('Call-ID');
+    req.locals = req.locals || {callId};
+
+    /* check if forwarded by a proxy that applied an X-Forwarded-For Header */
+    if (req.has('X-Forwarded-For') || req.has('X-Subspace-Forwarded-For')) {
+      const original_source_address = req.get('X-Forwarded-For') || req.get('X-Subspace-Forwarded-For');
+      logger.info({
+        callId: req.get('Call-ID'),
+        original_source_address,
+        proxy_source_address: req.source_address,
+      }, 'overwriting source address for proxied SIP INVITE');
+      req.source_address = original_source_address;
+    }
+    req.locals.cdr = initCdr(req);
     req.on('cancel', () => {
       logger.info({callId}, 'caller hungup before connecting to feature server');
       req.canceled = true;
@@ -31,38 +93,297 @@ module.exports = function(srf, logger) {
       stats.increment('sbc.terminations', tags);
     });
     stats.increment('sbc.invites', ['direction:inbound']);
-    next();
-  }
 
-  async function challengeDeviceCalls(req, res, next) {
+    /* write cdr for non-success response here */
+    res.once('end', ({status}) => {
+      if (req.locals.cdr && req.locals.cdr.account_sid && status > 200  && 401 !== status) {
+        const trunk = ['trunk', 'teams'].includes(req.locals.originator) ? req.locals.carrier : req.locals.originator;
+        writeCdrs({...req.locals.cdr,
+          terminated_at: Date.now(),
+          termination_reason: status === 487 === status ? 'caller abandoned' : 'failed',
+          sip_status: status,
+          trunk
+        }).catch((err) => logger.error({err}, 'Error writing cdr for call failure'));
+      }
+    });
+
+    next();
+  };
+
+  const handleSipRec = async(req, res, next) => {
+    const {callId} = req.locals;
+    if (Array.isArray(req.payload) && req.payload.length > 1) {
+      const sdp = req.payload
+        .find((p) => p.type === 'application/sdp')
+        .content;
+      if (!sdp) {
+        logger.error({callId}, 'No SDP in multipart sdp');
+        return res.send(503);
+      }
+      const xml = req.payload.find((p) => p.type !== 'application/sdp');
+      const endPos = xml.content.indexOf('</recording>');
+      xml.content = endPos !== -1 ?
+        `${xml.content.substring(0, endPos + 12)}` :
+        xml.content;
+      logger.debug({callId, xml}, 'incoming call with SIPREC body');
+      req.locals = {...req.locals, sdp, siprec: true, xml};
+    }
+    else req.locals = {...req.locals, sdp: req.body};
+    next();
+  };
+
+  const identifyAccount = async(req, res, next) => {
     try {
-      const gateway = await lookupSipGatewayBySignalingAddress(req.source_address, req.source_port);
-      if (gateway) {
-        debug(`challengeDeviceCalls: call came from gateway: ${JSON.stringify(gateway)}`);
-        req.locals.originator = 'trunk';
-        req.locals.carrier = gateway.name;
-        if (gateway.application_sid) req.locals.application_sid = gateway.application_sid;
-        return next();
+      const {siprec, callId} = req.locals;
+      const {getSPForAccount, wasOriginatedFromCarrier, getApplicationForDidAndCarrier} = req.srf.locals;
+      const {
+        fromCarrier,
+        gateway,
+        account_sid,
+        application_sid,
+        service_provider_sid,
+        account
+      } = await wasOriginatedFromCarrier(req);
+      /**
+       * calls come from 3 sources:
+       * (1) A carrier
+       * (2) Microsoft Teams
+       * (3) A SIP user
+       */
+      if (fromCarrier) {
+        if (!gateway) {
+          logger.info('identifyAccount: rejecting call from carrier because DID has not been provisioned');
+          return res.send(404, 'Number Not Provisioned');
+        }
+        logger.debug({gateway}, 'identifyAccount: incoming call from gateway');
+
+        let sid;
+        if (siprec) {
+          if (!account.siprec_hook_sid) {
+            logger.info({callId}, 'identifyAccount: rejecting call because SIPREC hook has not been provisioned');
+            return res.send(404);
+          }
+          sid = account.siprec_hook_sid;
+        }
+        else {
+          /* check for phone number level routing */
+          sid = application_sid || await getApplicationForDidAndCarrier(req, gateway.voip_carrier_sid);
+        }
+        req.locals = {
+          originator: 'trunk',
+          carrier: gateway.name,
+          gateway,
+          voip_carrier_sid: gateway.voip_carrier_sid,
+          application_sid: sid || gateway.application_sid,
+          service_provider_sid,
+          account_sid,
+          account,
+          ...req.locals
+        };
       }
-      if (msProxyIps.includes(req.source_address)) {
-        logger.debug({source_address: req.source_address}, 'challengeDeviceCalls: incoming call from Microsoft Teams');
+      else if (msProxyIps.includes(req.source_address)) {
+        logger.debug({source_address: req.source_address}, 'identifyAccount: incoming call from Microsoft Teams');
         const uri = parseUri(req.uri);
-        req.locals.originator = 'teams';
-        req.locals.carrier = 'Microsoft Teams';
-        req.locals.msTeamsTenantFqdn = uri.host;
-        return next();
+
+        const app = await lookupAppByTeamsTenant(uri.host);
+        if (!app) {
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          res.send(404, {headers: {'X-Reason': 'no configured application'}});
+          return req.srf.endSession(req);
+        }
+        const service_provider_sid = await getSPForAccount(app.account_sid);
+        req.locals = {
+          originator: 'teams',
+          carrier: 'Microsoft Teams',
+          msTeamsTenantFqdn: uri.host,
+          account_sid: app.account_sid,
+          service_provider_sid,
+          ...req.locals
+        };
       }
-      req.locals.originator = 'device';
+      else {
+        req.locals.originator = 'user';
+        const uri = parseUri(req.uri);
+        logger.debug({source_address: req.source_address, realm: uri.host},
+          'identifyAccount: incoming user call');
+        const account = await lookupAccountBySipRealm(uri.host);
+        if (!account) {
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          res.send(404);
+          return req.srf.endSession(req);
+        }
+
+        /* if this is a dedicated SBC (static IP) only take calls for that account's sip realm */
+        if (process.env.SBC_ACCOUNT_SID && account.account_sid !== process.env.SBC_ACCOUNT_SID) {
+          logger.info(
+            `identifyAccount: static IP for ${process.env.SBC_ACCOUNT_SID} but call for ${account.account_sid}`);
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          delete req.locals.cdr;
+          res.send(404);
+          return req.srf.endSession(req);
+        }
+        req.locals = {
+          service_provider_sid: account.service_provider_sid,
+          account_sid: account.account_sid,
+          account,
+          application_sid: account.device_calling_application_sid,
+          webhook_secret: account.webhook_secret,
+          ...req.locals
+        };
+      }
+      assert(req.locals.service_provider_sid);
+      assert(req.locals.account_sid);
+      req.locals.cdr.account_sid = req.locals.account_sid;
+
+      if (!req.locals.account) {
+        req.locals.account = await lookupAccountBySid(req.locals.account_sid);
+      }
+      req.locals.cdr.service_provider_sid = req.locals.account?.service_provider_sid;
+
+      if (!req.locals.account.is_active) {
+        stats.increment('sbc.terminations', ['sipStatus:503']);
+        return res.send(503, {headers: {'X-Reason': 'Account exists but is inactive'}});
+      }
+
+      if (req.locals.account.disable_cdrs) {
+        logger.info({account_sid: req.locals.account_sid}, 'Not writing CDRs for this account');
+        delete req.locals.cdr;
+      }
+
+      req.locals.logger = logger.child({
+        callId: req.get('Call-ID'),
+        service_provider_sid: req.locals.service_provider_sid,
+        account_sid: req.locals.account_sid
+      });
+
+      next();
+    } catch (err) {
+      stats.increment('sbc.terminations', ['sipStatus:500']);
+      logger.error(err, `${req.get('Call-ID')} database error for inbound call`);
+      res.send(500);
+    }
+  };
+
+  const checkLimits = async(req, res, next) => {
+    const trackingOn = process.env.JAMBONES_TRACK_ACCOUNT_CALLS ||
+    process.env.JAMBONES_TRACK_SP_CALLS ||
+    process.env.JAMBONES_TRACK_APP_CALLS;
+    if (!process.env.JAMBONES_HOSTING && !trackingOn) return next(); // skip
+
+    const {incrKey, decrKey} = req.srf.locals.realtimeDbHelpers;
+    const {logger, account_sid, account, service_provider_sid, application_sid} = req.locals;
+    const {writeCallCount, writeCallCountSP, writeCallCountApp, writeAlerts, AlertType} = req.srf.locals;
+    assert(account_sid);
+    assert(service_provider_sid);
+
+    /* decrement count if INVITE is later rejected */
+    res.once('end', async({status}) => {
+      if (status > 200) {
+        nudgeCallCounts(logger, {
+          service_provider_sid,
+          account_sid,
+          application_sid
+        }, decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
+          .catch((err) => logger.error(err, 'Error decrementing call counts'));
+      }
+    });
+
+    try {
+      /* increment the call count */
+      const  {callsSP, calls} = await nudgeCallCounts(logger, {
+        service_provider_sid,
+        account_sid,
+        application_sid
+      }, incrKey, {writeCallCountSP, writeCallCount, writeCallCountApp});
+
+      /* compare to account's limit, though avoid db hit when call count is low */
+      const minLimit = process.env.MIN_CALL_LIMIT ?
+        parseInt(process.env.MIN_CALL_LIMIT) :
+        0;
+      logger.debug(`checkLimits: call count is now ${calls}, limit is ${minLimit}`);
+      if (calls <= minLimit) return next();
+
+      if (process.env.JAMBONES_HOSTING) {
+        const accountCapacities = await lookupAccountCapacitiesBySid(account_sid);
+        const accountLimit = accountCapacities.find((c) => c.category == 'voice_call_session');
+        if (accountLimit) {
+          /* check account limit */
+          const limit_sessions = accountLimit.quantity;
+          if (calls > limit_sessions) {
+            debug(`checkLimits: limits exceeded: call count ${calls}, limit ${limit_sessions}`);
+            logger.info({calls, limit_sessions}, 'checkLimits: limits exceeded');
+            writeAlerts({
+              alert_type: AlertType.ACCOUNT_CALL_LIMIT,
+              service_provider_sid: account.service_provider_sid,
+              account_sid,
+              count: limit_sessions
+            }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+            res.send(503, 'Maximum Calls In Progress');
+            return req.srf.endSession(req);
+          }
+        }
+      }
+      else if (trackingOn) {
+        const {account_limit, sp_limit} = await queryCallLimits(service_provider_sid, account_sid);
+        if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS && account_limit > 0 && calls > account_limit) {
+          logger.info({calls, account_limit}, 'checkLimits: account limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.ACCOUNT_CALL_LIMIT,
+            service_provider_sid: service_provider_sid,
+            account_sid,
+            count: calls
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Max Account Calls In Progress', {
+            headers: {
+              'X-Account-Sid': account_sid,
+              'X-Call-Limit': account_limit
+            }
+          });
+          return req.srf.endSession(req);
+        }
+        if (process.env.JAMBONES_TRACK_SP_CALLS && sp_limit > 0 && callsSP > sp_limit) {
+          logger.info({callsSP, sp_limit}, 'checkLimits: service provider limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.SP_CALL_LIMIT,
+            service_provider_sid: service_provider_sid,
+            count: callsSP
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Max Service Provider Calls In Progress', {
+            headers: {
+              'X-Service-Provider-Sid': service_provider_sid,
+              'X-Call-Limit': sp_limit
+            }
+          });
+          return req.srf.endSession(req);
+        }
+      }
+      next();
+    } catch (err) {
+      stats.increment('sbc.terminations', ['sipStatus:500']);
+      logger.error({err}, 'error checking limits error for inbound call');
+      res.send(500);
+      req.srf.endSession(req);
+    }
+  };
+
+  const challengeDeviceCalls = async(req, res, next) => {
+    try {
+      /* TODO: check if this is a gateway that we have an ACL for */
+      if (req.locals.originator !== 'user') return next();
       return authenticator(req, res, next);
     } catch (err) {
       stats.increment('sbc.terminations', ['sipStatus:500']);
       logger.error(err, `${req.get('Call-ID')} Error looking up related info for inbound call`);
       res.send(500);
+      req.srf.endSession(req);
     }
-  }
+  };
 
   return {
     initLocals,
-    challengeDeviceCalls
+    handleSipRec,
+    challengeDeviceCalls,
+    identifyAccount,
+    checkLimits
   };
 };

lib/utils.js

@@ -2,40 +2,172 @@ const rtpCharacteristics = require('../data/rtp-transcoding');
 const srtpCharacteristics = require('../data/srtp-transcoding');
 let idx = 0;
 
-function isWSS(req) {
+const isWSS = (req) => {
   return req.getParsedHeader('Via')[0].protocol.toLowerCase().startsWith('ws');
-}
+};
 
-function getAppserver(srf) {
+const getAppserver = (srf) => {
   const len = srf.locals.featureServers.length;
   return srf.locals.featureServers[ idx++ % len];
-}
+};
 
 function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
-  const srtpOpts = teams ? srtpCharacteristics['teams'] : srtpCharacteristics['default'];
   const from = req.getParsedHeader('from');
-  const common = {'call-id': req.get('Call-ID'), 'from-tag': from.params.tag};
+  const srtpOpts = teams ? srtpCharacteristics['teams'] : srtpCharacteristics['default'];
+  const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCharacteristics;
+  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCharacteristics;
+
+  /* webrtc clients (e.g. sipjs) send DMTF via SIP INFO */
+  if ((srcIsUsingSrtp || dstIsUsingSrtp) && !teams) {
+    dstOpts.flags.push('inject DTMF');
+    srcOpts.flags.push('inject DTMF');
+  }
+  const common = {
+    'call-id': req.get('Call-ID'),
+    'replace': ['origin', 'session-connection']
+  };
   return {
     common,
-    offer: Object.assign(
-      {'sdp': req.body, 'replace': ['origin', 'session-connection']},
-      {'direction': [ 'public', 'private']},
-      common,
-      dstIsUsingSrtp ? srtpOpts : rtpCharacteristics),
-    answer: Object.assign(
-      {'replace': ['origin', 'session-connection']},
-      common,
-      srcIsUsingSrtp ? srtpOpts : rtpCharacteristics)
+    uas: {
+      tag: from.params.tag,
+      mediaOpts: srcOpts
+    },
+    uac: {
+      tag: null,
+      mediaOpts: dstOpts
+    }
   };
 }
 
-function SdpWantsSrtp(sdp) {
+const SdpWantsSrtp = (sdp) => {
   return /m=audio.*SAVP/.test(sdp);
-}
+};
+
+const makeAccountCallCountKey = (sid) => `incalls:account:${sid}`;
+const makeSPCallCountKey = (sid) => `incalls:sp:${sid}:`;
+const makeAppCallCountKey = (sid) => `incalls:app${sid}:`;
+
+const normalizeDID = (tel) => {
+  const regex = /^\+(\d+)$/;
+  const arr = regex.exec(tel);
+  return arr ? arr[1] : tel;
+};
+
+const equalsIgnoreOrder = (a, b) => {
+  if (a.length !== b.length) return false;
+  const uniqueValues = new Set([...a, ...b]);
+  for (const v of uniqueValues) {
+    const aCount = a.filter((e) => e === v).length;
+    const bCount = b.filter((e) => e === v).length;
+    if (aCount !== bCount) return false;
+  }
+  return true;
+};
+
+const  systemHealth = async(redisClient, ping, getCount) => {
+  await Promise.all([redisClient.ping(), ping()]);
+  return getCount();
+};
+
+const createHealthCheckApp = (port, logger) => {
+  const express = require('express');
+  const app = express();
+
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
+
+  return new Promise((resolve) => {
+    app.listen(port, () => {
+      logger.info(`Health check server started at http://localhost:${port}`);
+      resolve(app);
+    });
+  });
+};
+
+const nudgeCallCounts = async(logger, sids, nudgeOperator, writers) => {
+  const {service_provider_sid, account_sid, application_sid} = sids;
+  const {writeCallCount, writeCallCountSP, writeCallCountApp} = writers;
+  const nudges = [];
+  const writes = [];
+
+  if (process.env.JAMBONES_TRACK_SP_CALLS) {
+    const key = makeSPCallCountKey(service_provider_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS || process.env.JAMBONES_HOSTING) {
+    const key = makeAccountCallCountKey(account_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  if (process.env.JAMBONES_TRACK_APP_CALLS && application_sid) {
+    const key = makeAppCallCountKey(application_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  try {
+    const [callsSP, calls, callsApp] = await Promise.all(nudges);
+    logger.debug({
+      calls, callsSP, callsApp,
+      service_provider_sid, account_sid, application_sid}, 'call counts after adjustment');
+    if (process.env.JAMBONES_TRACK_SP_CALLS) {
+      writes.push(writeCallCountSP({service_provider_sid, calls_in_progress: callsSP}));
+    }
+
+    if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS || process.env.JAMBONES_HOSTING) {
+      writes.push(writeCallCount({service_provider_sid, account_sid, calls_in_progress: calls}));
+    }
+
+    if (process.env.JAMBONES_TRACK_APP_CALLS && application_sid) {
+      writes.push(writeCallCountApp({service_provider_sid, account_sid, application_sid, calls_in_progress: callsApp}));
+    }
+
+    /* write the call counts to the database */
+    Promise.all(writes).catch((err) => logger.error({err}, 'Error writing call counts'));
+
+    return {callsSP, calls, callsApp};
+  } catch (err) {
+    logger.error(err, 'error incrementing call counts');
+  }
+
+  return {callsSP: null, calls: null, callsApp: null};
+};
+
+const roundTripTime = (startAt) => {
+  const diff = process.hrtime(startAt);
+  const time = diff[0] * 1e3 + diff[1] * 1e-6;
+  return time.toFixed(0);
+};
+
+const parseConnectionIp = (sdp) => {
+  const regex = /c=IN IP4 ([0-9.]+)/;
+  const arr = regex.exec(sdp);
+  return arr ? arr[1] : null;
+};
+
 
 module.exports = {
   isWSS,
   SdpWantsSrtp,
   getAppserver,
-  makeRtpEngineOpts
+  makeRtpEngineOpts,
+  makeAccountCallCountKey,
+  makeSPCallCountKey,
+  makeAppCallCountKey,
+  normalizeDID,
+  equalsIgnoreOrder,
+  systemHealth,
+  createHealthCheckApp,
+  nudgeCallCounts,
+  roundTripTime,
+  parseConnectionIp
 };

liveness.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+TCP_SERVER_PORT="${DRACHTIO_PORT:-4000}"
+nc -v -z localhost $TCP_SERVER_PORT
+
+# if last command exited with non zero
+if [ $? != 0 ]
+then
+    exit 1
+fi
+
+HTTP_SERVER_PORT="${HTTP_PORT:-3000}"
+
+printf 'GET /system-health HTTP/1.1\r\nHost: localhost\r\n\r\n' | nc -v localhost 3000 | grep calls
+
+# grep will automatically exit with 1 if string is not matched, however, will leave that call there in case 
+# we pivot to pipe to dev/null
+
+if [ $? != 0 ]
+then
+    exit 1
+fi
+
+exit 0

package.json

@@ -1,9 +1,9 @@
 {
   "name": "sbc-inbound",
-  "version": "0.3.6",
+  "version": "v0.7.6",
   "main": "app.js",
   "engines": {
-    "node": ">= 10.16.0"
+    "node": ">= 12.0.0"
   },
   "keywords": [
     "sip",
@@ -20,28 +20,36 @@
   },
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_MYSQL_HOST=localhost JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ | ./node_modules/.bin/tap-spec",
+    "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONES_NETWORK_CIDR='127.0.0.1/32' JAMBONES_HOSTING=1 SBC_ACCOUNT_SID=ed649e33-e771-403a-8c99-1780eabbc803 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=debug DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.4.2",
-    "@jambonz/realtimedb-helpers": "0.2.16",
-    "@jambonz/rtpengine-utils": "^0.1.7",
-    "@jambonz/stats-collector": "0.0.4",
-    "debug": "^4.1.1",
+    "@jambonz/db-helpers": "^0.6.19",
+    "@jambonz/http-authenticator": "^0.2.2",
+    "@jambonz/http-health-check": "^0.0.1",
+    "@jambonz/realtimedb-helpers": "^0.4.29",
+    "@jambonz/rtpengine-utils": "^0.3.4",
+    "@jambonz/siprec-client-utils": "^0.1.4",
+    "@jambonz/stats-collector": "^0.1.6",
+    "@jambonz/time-series": "^0.2.4",
+    "aws-sdk": "^2.1152.0",
+    "bent": "^7.3.12",
+    "cidr-matcher": "^2.1.1",
+    "debug": "^4.3.4",
     "drachtio-fn-b2b-sugar": "0.0.12",
-    "drachtio-srf": "^4.4.37",
-    "jambonz-http-authenticator": "0.1.5",
-    "pino": "^6.5.1",
-    "rtpengine-client": "^0.1.1"
+    "drachtio-srf": "^4.5.1",
+    "express": "^4.18.1",
+    "pino": "^7.11.0",
+    "sdp-transform": "^2.14.1",
+    "uuid": "^8.3.2",
+    "verify-aws-sns-signature": "^0.1.0",
+    "xml2js": "^0.4.23"
   },
   "devDependencies": {
-    "blue-tape": "^1.0.0",
-    "clear-module": "^4.1.1",
-    "eslint": "^7.7.0",
-    "eslint-plugin-promise": "^4.2.1",
+    "eslint": "^7.32.0",
+    "eslint-plugin-promise": "^4.3.1",
     "nyc": "^15.1.0",
-    "tap-spec": "^5.0.0"
+    "tape": "^4.15.1"
   }
 }

test/create-test-db.js

@@ -1,9 +1,8 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
 
 test('creating jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('database successfully created');
     t.end();
@@ -11,7 +10,7 @@ test('creating jambones_test database', (t) => {
 });
 
 test('creating schema', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/jambones-sql.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  -D jambones_test < ${__dirname}/db/jambones-sql.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('schema successfully created');
     t.end();
@@ -19,7 +18,7 @@ test('creating schema', (t) => {
 });
 
 test('populating test case data', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/populate-test-data.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  -D jambones_test < ${__dirname}/db/populate-test-data.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('test data set created');
     t.end();

test/db/create_test_db.sql

@@ -1,3 +1,3 @@
 create database jambones_test;
-create user jambones_test@localhost IDENTIFIED WITH mysql_native_password by 'jambones_test';
-grant all on jambones_test.* to jambones_test@localhost;
+create user jambones_test@'%' IDENTIFIED WITH mysql_native_password by 'jambones_test';
+grant all on jambones_test.* to jambones_test@'%';

test/db/jambones-sql.sql

@@ -2,20 +2,54 @@
 
 SET FOREIGN_KEY_CHECKS=0;
 
+DROP TABLE IF EXISTS account_static_ips;
+
+DROP TABLE IF EXISTS account_products;
+
+DROP TABLE IF EXISTS account_subscriptions;
+
+DROP TABLE IF EXISTS account_limits;
+
+DROP TABLE IF EXISTS beta_invite_codes;
+
 DROP TABLE IF EXISTS call_routes;
 
+DROP TABLE IF EXISTS dns_records;
+
 DROP TABLE IF EXISTS lcr_carrier_set_entry;
 
 DROP TABLE IF EXISTS lcr_routes;
 
-DROP TABLE IF EXISTS api_keys;
+DROP TABLE IF EXISTS predefined_sip_gateways;
 
-DROP TABLE IF EXISTS ms_teams_tenants;
+DROP TABLE IF EXISTS predefined_smpp_gateways;
+
+DROP TABLE IF EXISTS predefined_carriers;
+
+DROP TABLE IF EXISTS account_offers;
+
+DROP TABLE IF EXISTS products;
+
+DROP TABLE IF EXISTS schema_version;
+
+DROP TABLE IF EXISTS api_keys;
 
 DROP TABLE IF EXISTS sbc_addresses;
 
+DROP TABLE IF EXISTS ms_teams_tenants;
+
+DROP TABLE IF EXISTS signup_history;
+
+DROP TABLE IF EXISTS service_provider_limits;
+
+DROP TABLE IF EXISTS smpp_addresses;
+
+DROP TABLE IF EXISTS speech_credentials;
+
 DROP TABLE IF EXISTS users;
 
+DROP TABLE IF EXISTS smpp_gateways;
+
 DROP TABLE IF EXISTS phone_numbers;
 
 DROP TABLE IF EXISTS sip_gateways;
@@ -30,6 +64,50 @@ DROP TABLE IF EXISTS service_providers;
 
 DROP TABLE IF EXISTS webhooks;
 
+CREATE TABLE account_static_ips
+(
+account_static_ip_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+public_ipv4 VARCHAR(16) NOT NULL UNIQUE ,
+private_ipv4 VARBINARY(16) NOT NULL UNIQUE ,
+PRIMARY KEY (account_static_ip_sid)
+);
+
+CREATE TABLE account_subscriptions
+(
+account_subscription_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+pending BOOLEAN NOT NULL DEFAULT false,
+effective_start_date DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+effective_end_date DATETIME,
+change_reason VARCHAR(255),
+stripe_subscription_id VARCHAR(56),
+stripe_payment_method_id VARCHAR(56),
+stripe_statement_descriptor VARCHAR(255),
+last4 VARCHAR(512),
+exp_month INTEGER,
+exp_year INTEGER,
+card_type VARCHAR(16),
+pending_reason VARBINARY(52),
+PRIMARY KEY (account_subscription_sid)
+);
+
+CREATE TABLE account_limits
+(
+account_limits_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_limits_sid)
+);
+
+CREATE TABLE beta_invite_codes
+(
+invite_code CHAR(6) NOT NULL UNIQUE ,
+in_use BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (invite_code)
+);
+
 CREATE TABLE call_routes
 (
 call_route_sid CHAR(36) NOT NULL UNIQUE ,
@@ -38,7 +116,16 @@ account_sid CHAR(36) NOT NULL,
 regex VARCHAR(255) NOT NULL,
 application_sid CHAR(36) NOT NULL,
 PRIMARY KEY (call_route_sid)
-) ENGINE=InnoDB COMMENT='a regex-based pattern match for call routing';
+) COMMENT='a regex-based pattern match for call routing';
+
+CREATE TABLE dns_records
+(
+dns_record_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+record_type VARCHAR(6) NOT NULL,
+record_id INTEGER NOT NULL,
+PRIMARY KEY (dns_record_sid)
+);
 
 CREATE TABLE lcr_routes
 (
@@ -49,17 +136,100 @@ priority INTEGER NOT NULL UNIQUE  COMMENT 'lower priority routes are attempted f
 PRIMARY KEY (lcr_route_sid)
 ) COMMENT='Least cost routing table';
 
+CREATE TABLE predefined_carriers
+(
+predefined_carrier_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+requires_static_ip BOOLEAN NOT NULL DEFAULT false,
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+PRIMARY KEY (predefined_carrier_sid)
+);
+
+CREATE TABLE predefined_sip_gateways
+(
+predefined_sip_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+netmask INTEGER NOT NULL DEFAULT 32,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_sip_gateway_sid)
+);
+
+CREATE TABLE predefined_smpp_gateways
+(
+predefined_smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway. ',
+port INTEGER NOT NULL DEFAULT 2775 COMMENT 'smpp signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound SMS from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'i',
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+use_tls BOOLEAN DEFAULT 0,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_smpp_gateway_sid)
+);
+
+CREATE TABLE products
+(
+product_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device') NOT NULL,
+PRIMARY KEY (product_sid)
+);
+
+CREATE TABLE account_products
+(
+account_product_sid CHAR(36) NOT NULL UNIQUE ,
+account_subscription_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_product_sid)
+);
+
+CREATE TABLE account_offers
+(
+account_offer_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+stripe_product_id VARCHAR(56) NOT NULL,
+PRIMARY KEY (account_offer_sid)
+);
+
+CREATE TABLE schema_version
+(
+version VARCHAR(16)
+);
+
 CREATE TABLE api_keys
 (
 api_key_sid CHAR(36) NOT NULL UNIQUE ,
 token CHAR(36) NOT NULL UNIQUE ,
 account_sid CHAR(36),
 service_provider_sid CHAR(36),
-expires_at TIMESTAMP NULL,
-last_used TIMESTAMP NULL,
+expires_at TIMESTAMP NULL  DEFAULT NULL,
+last_used TIMESTAMP NULL  DEFAULT NULL,
 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
 PRIMARY KEY (api_key_sid)
-) ENGINE=InnoDB COMMENT='An authorization token that is used to access the REST api';
+) COMMENT='An authorization token that is used to access the REST api';
+
+CREATE TABLE sbc_addresses
+(
+sbc_address_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(255) NOT NULL,
+port INTEGER NOT NULL DEFAULT 5060,
+service_provider_sid CHAR(36),
+PRIMARY KEY (sbc_address_sid)
+);
 
 CREATE TABLE ms_teams_tenants
 (
@@ -71,60 +241,130 @@ tenant_fqdn VARCHAR(255) NOT NULL UNIQUE ,
 PRIMARY KEY (ms_teams_tenant_sid)
 ) COMMENT='A Microsoft Teams customer tenant';
 
-CREATE TABLE sbc_addresses
+CREATE TABLE signup_history
 (
-sbc_address_sid CHAR(36) NOT NULL UNIQUE ,
+email VARCHAR(255) NOT NULL,
+name VARCHAR(255),
+signed_up_at DATETIME DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (email)
+);
+
+CREATE TABLE service_provider_limits
+(
+service_provider_limits_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (service_provider_limits_sid)
+);
+
+CREATE TABLE smpp_addresses
+(
+smpp_address_sid CHAR(36) NOT NULL UNIQUE ,
 ipv4 VARCHAR(255) NOT NULL,
 port INTEGER NOT NULL DEFAULT 5060,
+use_tls BOOLEAN NOT NULL DEFAULT 0,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
 service_provider_sid CHAR(36),
-PRIMARY KEY (sbc_address_sid)
+PRIMARY KEY (smpp_address_sid)
+);
+
+CREATE TABLE speech_credentials
+(
+speech_credential_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36),
+account_sid CHAR(36),
+vendor VARCHAR(32) NOT NULL,
+credential VARCHAR(8192) NOT NULL,
+use_for_tts BOOLEAN DEFAULT true,
+use_for_stt BOOLEAN DEFAULT true,
+last_used DATETIME,
+last_tested DATETIME,
+tts_tested_ok BOOLEAN,
+stt_tested_ok BOOLEAN,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (speech_credential_sid)
 );
 
 CREATE TABLE users
 (
 user_sid CHAR(36) NOT NULL UNIQUE ,
-name CHAR(36) NOT NULL UNIQUE ,
-hashed_password VARCHAR(1024) NOT NULL,
-salt CHAR(16) NOT NULL,
-force_change BOOLEAN NOT NULL DEFAULT TRUE,
+name VARCHAR(255) NOT NULL,
+email VARCHAR(255) NOT NULL,
+pending_email VARCHAR(255),
+phone VARCHAR(20) UNIQUE ,
+hashed_password VARCHAR(1024),
+account_sid CHAR(36),
+service_provider_sid CHAR(36),
+force_change BOOLEAN NOT NULL DEFAULT FALSE,
+provider VARCHAR(255) NOT NULL,
+provider_userid VARCHAR(255),
+scope VARCHAR(16) NOT NULL DEFAULT 'read-write',
+phone_activation_code VARCHAR(16),
+email_activation_code VARCHAR(16),
+email_validated BOOLEAN NOT NULL DEFAULT false,
+phone_validated BOOLEAN NOT NULL DEFAULT false,
+email_content_opt_out BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (user_sid)
 );
 
 CREATE TABLE voip_carriers
 (
 voip_carrier_sid CHAR(36) NOT NULL UNIQUE ,
-name VARCHAR(64) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
 description VARCHAR(255),
-account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a customer PBX that is associated with a specific account',
+account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a sip trunk that is associated with a specific account',
+service_provider_sid CHAR(36),
 application_sid CHAR(36) COMMENT 'If provided, all incoming calls from this source will be routed to the associated application',
-e164_leading_plus BOOLEAN NOT NULL DEFAULT false,
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+smpp_system_id VARCHAR(255),
+smpp_password VARCHAR(64),
+smpp_enquire_link_interval INTEGER DEFAULT 0,
+smpp_inbound_system_id VARCHAR(255),
+smpp_inbound_password VARCHAR(64),
 PRIMARY KEY (voip_carrier_sid)
-) ENGINE=InnoDB COMMENT='A Carrier or customer PBX that can send or receive calls';
+) COMMENT='A Carrier or customer PBX that can send or receive calls';
+
+CREATE TABLE smpp_gateways
+(
+smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL,
+port INTEGER NOT NULL DEFAULT 2775,
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+inbound BOOLEAN NOT NULL DEFAULT 0 COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL DEFAULT 1 COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+use_tls BOOLEAN DEFAULT 0,
+voip_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (smpp_gateway_sid)
+);
 
 CREATE TABLE phone_numbers
 (
 phone_number_sid CHAR(36) UNIQUE ,
 number VARCHAR(32) NOT NULL UNIQUE ,
-voip_carrier_sid CHAR(36) NOT NULL,
+voip_carrier_sid CHAR(36),
 account_sid CHAR(36),
 application_sid CHAR(36),
+service_provider_sid CHAR(36) COMMENT 'if not null, this number is a test number for the associated service provider',
 PRIMARY KEY (phone_number_sid)
-) ENGINE=InnoDB COMMENT='A phone number that has been assigned to an account';
-
-CREATE TABLE webhooks
-(
-webhook_sid CHAR(36) NOT NULL UNIQUE ,
-url VARCHAR(1024) NOT NULL,
-method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
-username VARCHAR(255),
-password VARCHAR(255),
-PRIMARY KEY (webhook_sid)
-) COMMENT='An HTTP callback';
+) COMMENT='A phone number that has been assigned to an account';
 
 CREATE TABLE sip_gateways
 (
 sip_gateway_sid CHAR(36),
 ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+netmask INTEGER NOT NULL DEFAULT 32,
 port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
 inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
 outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
@@ -143,20 +383,33 @@ priority INTEGER NOT NULL DEFAULT 0 COMMENT 'lower priority carriers are attempt
 PRIMARY KEY (lcr_carrier_set_entry_sid)
 ) COMMENT='An entry in the LCR routing list';
 
+CREATE TABLE webhooks
+(
+webhook_sid CHAR(36) NOT NULL UNIQUE ,
+url VARCHAR(1024) NOT NULL,
+method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
+username VARCHAR(255),
+password VARCHAR(255),
+PRIMARY KEY (webhook_sid)
+) COMMENT='An HTTP callback';
+
 CREATE TABLE applications
 (
 application_sid CHAR(36) NOT NULL UNIQUE ,
 name VARCHAR(64) NOT NULL,
-account_sid CHAR(36) NOT NULL COMMENT 'account that this application belongs to',
-call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls to phone numbers owned by this account',
+service_provider_sid CHAR(36) COMMENT 'if non-null, this application is a test application that can be used by any account under the associated service provider',
+account_sid CHAR(36) COMMENT 'account that this application belongs to (if null, this is a service provider test application)',
+call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls ',
 call_status_hook_sid CHAR(36) COMMENT 'webhook to call for call status events',
+messaging_hook_sid CHAR(36) COMMENT 'webhook to call for inbound SMS/MMS ',
 speech_synthesis_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_synthesis_language VARCHAR(12) NOT NULL DEFAULT 'en-US',
 speech_synthesis_voice VARCHAR(64),
 speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
 PRIMARY KEY (application_sid)
-) ENGINE=InnoDB COMMENT='A defined set of behaviors to be applied to phone calls ';
+) COMMENT='A defined set of behaviors to be applied to phone calls ';
 
 CREATE TABLE service_providers
 (
@@ -167,7 +420,7 @@ root_domain VARCHAR(128) UNIQUE ,
 registration_hook_sid CHAR(36),
 ms_teams_fqdn VARCHAR(255),
 PRIMARY KEY (service_provider_sid)
-) ENGINE=InnoDB COMMENT='A partition of the platform used by one service provider';
+) COMMENT='A partition of the platform used by one service provider';
 
 CREATE TABLE accounts
 (
@@ -176,72 +429,166 @@ name VARCHAR(64) NOT NULL,
 sip_realm VARCHAR(132) UNIQUE  COMMENT 'sip domain that will be used for devices registering under this account',
 service_provider_sid CHAR(36) NOT NULL COMMENT 'service provider that owns the customer relationship with this account',
 registration_hook_sid CHAR(36) COMMENT 'webhook to call when devices underr this account attempt to register',
+queue_event_hook_sid CHAR(36),
 device_calling_application_sid CHAR(36) COMMENT 'application to use for outbound calling from an account',
 is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+plan_type ENUM('trial','free','paid') NOT NULL DEFAULT 'trial',
+stripe_customer_id VARCHAR(56),
+webhook_secret VARCHAR(36) NOT NULL,
+disable_cdrs BOOLEAN NOT NULL DEFAULT 0,
+trial_end_date DATETIME,
+deactivated_reason VARCHAR(255),
+device_to_call_ratio INTEGER NOT NULL DEFAULT 5,
+subspace_client_id VARCHAR(255),
+subspace_client_secret VARCHAR(255),
+subspace_sip_teleport_id VARCHAR(255),
+subspace_sip_teleport_destinations VARCHAR(255),
+siprec_hook_sid CHAR(36),
 PRIMARY KEY (account_sid)
-) ENGINE=InnoDB COMMENT='An enterprise that uses the platform for comm services';
+) COMMENT='An enterprise that uses the platform for comm services';
 
+CREATE INDEX account_static_ip_sid_idx ON account_static_ips (account_static_ip_sid);
+CREATE INDEX account_sid_idx ON account_static_ips (account_sid);
+ALTER TABLE account_static_ips ADD FOREIGN KEY account_sid_idxfk (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX account_subscription_sid_idx ON account_subscriptions (account_subscription_sid);
+CREATE INDEX account_sid_idx ON account_subscriptions (account_sid);
+ALTER TABLE account_subscriptions ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX account_sid_idx ON account_limits (account_sid);
+ALTER TABLE account_limits ADD FOREIGN KEY account_sid_idxfk_2 (account_sid) REFERENCES accounts (account_sid) ON DELETE CASCADE;
+
+CREATE INDEX invite_code_idx ON beta_invite_codes (invite_code);
 CREATE INDEX call_route_sid_idx ON call_routes (call_route_sid);
-ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE call_routes ADD FOREIGN KEY application_sid_idxfk (application_sid) REFERENCES applications (application_sid);
 
+CREATE INDEX dns_record_sid_idx ON dns_records (dns_record_sid);
+ALTER TABLE dns_records ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX predefined_carrier_sid_idx ON predefined_carriers (predefined_carrier_sid);
+CREATE INDEX predefined_sip_gateway_sid_idx ON predefined_sip_gateways (predefined_sip_gateway_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_sip_gateways (predefined_carrier_sid);
+ALTER TABLE predefined_sip_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
+
+CREATE INDEX predefined_smpp_gateway_sid_idx ON predefined_smpp_gateways (predefined_smpp_gateway_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_smpp_gateways (predefined_carrier_sid);
+ALTER TABLE predefined_smpp_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk_1 (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
+
+CREATE INDEX product_sid_idx ON products (product_sid);
+CREATE INDEX account_product_sid_idx ON account_products (account_product_sid);
+CREATE INDEX account_subscription_sid_idx ON account_products (account_subscription_sid);
+ALTER TABLE account_products ADD FOREIGN KEY account_subscription_sid_idxfk (account_subscription_sid) REFERENCES account_subscriptions (account_subscription_sid);
+
+ALTER TABLE account_products ADD FOREIGN KEY product_sid_idxfk (product_sid) REFERENCES products (product_sid);
+
+CREATE INDEX account_offer_sid_idx ON account_offers (account_offer_sid);
+CREATE INDEX account_sid_idx ON account_offers (account_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX product_sid_idx ON account_offers (product_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY product_sid_idxfk_1 (product_sid) REFERENCES products (product_sid);
+
 CREATE INDEX api_key_sid_idx ON api_keys (api_key_sid);
 CREATE INDEX account_sid_idx ON api_keys (account_sid);
-ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_6 (account_sid) REFERENCES accounts (account_sid);
 
 CREATE INDEX service_provider_sid_idx ON api_keys (service_provider_sid);
 ALTER TABLE api_keys ADD FOREIGN KEY service_provider_sid_idxfk (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
-CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
-
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_2 (account_sid) REFERENCES accounts (account_sid);
-
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);
-
-CREATE INDEX tenant_fqdn_idx ON ms_teams_tenants (tenant_fqdn);
 CREATE INDEX sbc_addresses_idx_host_port ON sbc_addresses (ipv4,port);
 
 CREATE INDEX sbc_address_sid_idx ON sbc_addresses (sbc_address_sid);
 CREATE INDEX service_provider_sid_idx ON sbc_addresses (service_provider_sid);
-ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_7 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX tenant_fqdn_idx ON ms_teams_tenants (tenant_fqdn);
+CREATE INDEX email_idx ON signup_history (email);
+CREATE INDEX service_provider_sid_idx ON service_provider_limits (service_provider_sid);
+ALTER TABLE service_provider_limits ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid) ON DELETE CASCADE;
+
+CREATE INDEX smpp_address_sid_idx ON smpp_addresses (smpp_address_sid);
+CREATE INDEX service_provider_sid_idx ON smpp_addresses (service_provider_sid);
+ALTER TABLE smpp_addresses ADD FOREIGN KEY service_provider_sid_idxfk_4 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE UNIQUE INDEX speech_credentials_idx_1 ON speech_credentials (vendor,account_sid);
+
+CREATE INDEX speech_credential_sid_idx ON speech_credentials (speech_credential_sid);
+CREATE INDEX service_provider_sid_idx ON speech_credentials (service_provider_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY service_provider_sid_idxfk_5 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX account_sid_idx ON speech_credentials (account_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY account_sid_idxfk_8 (account_sid) REFERENCES accounts (account_sid);
 
 CREATE INDEX user_sid_idx ON users (user_sid);
-CREATE INDEX name_idx ON users (name);
+CREATE INDEX email_idx ON users (email);
+CREATE INDEX phone_idx ON users (phone);
+CREATE INDEX account_sid_idx ON users (account_sid);
+ALTER TABLE users ADD FOREIGN KEY account_sid_idxfk_9 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON users (service_provider_sid);
+ALTER TABLE users ADD FOREIGN KEY service_provider_sid_idxfk_6 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX email_activation_code_idx ON users (email_activation_code);
 CREATE INDEX voip_carrier_sid_idx ON voip_carriers (voip_carrier_sid);
-CREATE INDEX name_idx ON voip_carriers (name);
-ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
+CREATE INDEX account_sid_idx ON voip_carriers (account_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_10 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON voip_carriers (service_provider_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY service_provider_sid_idxfk_7 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 ALTER TABLE voip_carriers ADD FOREIGN KEY application_sid_idxfk_2 (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
-CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
-ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+CREATE INDEX smpp_gateway_sid_idx ON smpp_gateways (smpp_gateway_sid);
+CREATE INDEX voip_carrier_sid_idx ON smpp_gateways (voip_carrier_sid);
+ALTER TABLE smpp_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
-ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
+CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
+CREATE INDEX number_idx ON phone_numbers (number);
+CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_11 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE phone_numbers ADD FOREIGN KEY application_sid_idxfk_3 (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
-CREATE UNIQUE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+CREATE INDEX service_provider_sid_idx ON phone_numbers (service_provider_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY service_provider_sid_idxfk_8 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
-ALTER TABLE sip_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+CREATE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+
+CREATE INDEX voip_carrier_sid_idx ON sip_gateways (voip_carrier_sid);
+ALTER TABLE sip_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk_2 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
 ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY lcr_route_sid_idxfk (lcr_route_sid) REFERENCES lcr_routes (lcr_route_sid);
 
-ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_2 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_3 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
+CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
 CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);
 
 CREATE INDEX application_sid_idx ON applications (application_sid);
+CREATE INDEX service_provider_sid_idx ON applications (service_provider_sid);
+ALTER TABLE applications ADD FOREIGN KEY service_provider_sid_idxfk_9 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
 CREATE INDEX account_sid_idx ON applications (account_sid);
-ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_12 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REFERENCES webhooks (webhook_sid);
 
 ALTER TABLE applications ADD FOREIGN KEY call_status_hook_sid_idxfk (call_status_hook_sid) REFERENCES webhooks (webhook_sid);
 
+ALTER TABLE applications ADD FOREIGN KEY messaging_hook_sid_idxfk (messaging_hook_sid) REFERENCES webhooks (webhook_sid);
+
 CREATE INDEX service_provider_sid_idx ON service_providers (service_provider_sid);
 CREATE INDEX name_idx ON service_providers (name);
 CREATE INDEX root_domain_idx ON service_providers (root_domain);
@@ -250,10 +597,14 @@ ALTER TABLE service_providers ADD FOREIGN KEY registration_hook_sid_idxfk (regis
 CREATE INDEX account_sid_idx ON accounts (account_sid);
 CREATE INDEX sip_realm_idx ON accounts (sip_realm);
 CREATE INDEX service_provider_sid_idx ON accounts (service_provider_sid);
-ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_10 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 ALTER TABLE accounts ADD FOREIGN KEY registration_hook_sid_idxfk_1 (registration_hook_sid) REFERENCES webhooks (webhook_sid);
 
+ALTER TABLE accounts ADD FOREIGN KEY queue_event_hook_sid_idxfk (queue_event_hook_sid) REFERENCES webhooks (webhook_sid);
+
 ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (device_calling_application_sid) REFERENCES applications (application_sid);
 
+ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);
+
 SET FOREIGN_KEY_CHECKS=1;

test/db/populate-test-data.sql

@@ -1,22 +1,69 @@
+-- create our products
+insert into products (product_sid, name, category)
+values
+('c4403cdb-8e75-4b27-9726-7d8315e3216d', 'concurrent call session', 'voice_call_session'),
+('2c815913-5c26-4004-b748-183b459329df', 'registered device', 'device'),
+('35a9fb10-233d-4eb9-aada-78de5814d680', 'api call', 'api_rate');
+
 insert into webhooks(webhook_sid, url, username, password) values('90dda62e-0ea2-47d1-8164-5bd49003476c', 'http://127.0.0.1:4000/auth', 'foo', 'bar');
 
 insert into service_providers (service_provider_sid, name, root_domain, registration_hook_sid) 
 values ('3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'SP A', 'jambonz.org', '90dda62e-0ea2-47d1-8164-5bd49003476c');
-insert into accounts(account_sid, service_provider_sid, name, sip_realm, registration_hook_sid)
-values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'sip.example.com', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into service_provider_limits (service_provider_limits_sid, service_provider_sid, category, quantity) VALUES ('a79d3ade-e0da-4461-80f3-7c73f01e18b4', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'voice_call_session', 1);
 
-insert into voip_carriers (voip_carrier_sid, name) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco');
+insert into accounts(account_sid, service_provider_sid, name, sip_realm, registration_hook_sid, webhook_secret)
+values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'jambonz.org', '90dda62e-0ea2-47d1-8164-5bd49003476c', 'foobar');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('f4e1848d-3ff8-40eb-b9c1-30e1ef053f94','ed649e33-e771-403a-8c99-1780eabbc803',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('f23ff996-6534-4aba-8666-4b347391eca2', 'f4e1848d-3ff8-40eb-b9c1-30e1ef053f94', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 10);
+
+insert into voip_carriers (voip_carrier_sid, name, account_sid) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', 'ed649e33-e771-403a-8c99-1780eabbc803');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('124a5339-c62c-4075-9e19-f4de70a96597', '287c1452-620d-4195-9f19-c9814ef90d78', '172.38.0.20', true, true);
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, port, inbound, outbound) 
 values ('efbc4830-57cd-4c78-a56f-d64fdf210fe8', '287c1452-620d-4195-9f19-c9814ef90d78', '3.3.3.3', 5062, false, true);
 
 insert into webhooks(webhook_sid, url) values('4d7ce0aa-5ead-4e61-9a6b-3daa732218b1', 'http://example.com/status');
-insert into accounts (account_sid, name, service_provider_sid)
-values ('ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'delta.sip.jambonz.org');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('4f3853e6-d8b0-43de-ba62-d9279801695d','ee9d7d49-b3e4-4fdb-9d66-661149f717e8',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('61840638-ccde-4bc5-b645-5d32718c68a5', '4f3853e6-d8b0-43de-ba62-d9279801695d', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 10);
+
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('d7cc37cb-d152-49ef-a51b-485f6e917089', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'echo.sip.jambonz.org');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('73bbcc5d-512f-4cea-8535-9a6e3d2bd19d','d7cc37cb-d152-49ef-a51b-485f6e917089',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('92f137f7-4bc3-4157-b096-6817e54b1874', '73bbcc5d-512f-4cea-8535-9a6e3d2bd19d', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 0);
+insert into account_limits(account_limits_sid, account_sid, category, quantity) values('a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d', 'd7cc37cb-d152-49ef-a51b-485f6e917089', 'voice_call_session', 0);
+
+insert into voip_carriers (voip_carrier_sid, name, account_sid) values ('9b1abdc7-0220-4964-bc66-32b5c70cd9ab', 'westco', 'd7cc37cb-d152-49ef-a51b-485f6e917089');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('12f401d9-cbb1-49e5-bd33-cefbca0badc3', '9b1abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.20', true, true);
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, port, inbound, outbound) 
+values ('1401eb72-0daf-4471-aba6-038a0a2587b3', '9b1abdc7-0220-4964-bc66-32b5c70cd9ab', '3.3.3.3', 5062, false, true);
+
+
 insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
 values ('3b43e39f-4346-4218-8434-a53130e8be49', 'test', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '4d7ce0aa-5ead-4e61-9a6b-3daa732218b1');
 
 insert into voip_carriers (voip_carrier_sid, name, account_sid, application_sid) values ('999c1452-620d-4195-9f19-c9814ef90d78', 'customer PBX', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '3b43e39f-4346-4218-8434-a53130e8be49');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('888a5339-c62c-4075-9e19-f4de70a96597', '999c1452-620d-4195-9f19-c9814ef90d78', '172.38.0.21', true, false);
+ 
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('999a5339-c62c-4075-9e19-f4de70a96597', '16173333456', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('29543d4e-d959-4a25-836a-cde7161cd7d5', '1508222*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('dddd5c34-feae-4d70-98af-bb4d1f8dc965', '1508*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('d458bf7a-bcea-47b2-ac96-66dfc9c5c220', '150822233*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('f7ad205d-b92f-4363-8160-f8b5216b40d3', '15083871234', '287c1452-620d-4195-9f19-c9814ef90d78', 'd7cc37cb-d152-49ef-a51b-485f6e917089');

test/docker-compose-testbed.yaml

@@ -7,7 +7,21 @@ networks:
       config:
         - subnet: 172.38.0.0/16
 
-services:
+services:  
+  mysql:
+    image: mysql:5.7
+    platform: linux/x86_64
+    ports:
+      - "3306:3306"
+    environment: 
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost", "--protocol", "tcp"]
+      timeout: 5s
+      retries: 15    
+    networks:
+      sbc-inbound:
+        ipv4_address: 172.38.0.2
   sbc:
     image: drachtio/drachtio-server:latest
     command: drachtio --contact "sip:*;transport=udp" --loglevel debug --sofia-loglevel 9
@@ -16,6 +30,9 @@ services:
     networks:
       sbc-inbound:
         ipv4_address: 172.38.0.10
+    depends_on:
+      mysql:
+        condition: service_healthy
 
   appserver:
     image: drachtio/sipp:latest
@@ -54,3 +71,10 @@ services:
       sbc-inbound:
         ipv4_address: 172.38.0.14
 
+  influxdb:
+    image: influxdb:1.8
+    ports:
+      - "8086:8086"
+    networks:
+      sbc-inbound:
+        ipv4_address: 172.38.0.90

test/docker_start.js

@@ -1,9 +1,9 @@
 const test = require('tape').test ;
 const exec = require('child_process').exec ;
-const async = require('async');
 
 test('starting docker network..', (t) => {
   exec(`docker-compose -f ${__dirname}/docker-compose-testbed.yaml up -d`, (err, stdout, stderr) => {
+    t.pass('docker is up');
     t.end(err);
   });
   

test/index.js

@@ -1,5 +1,4 @@
 require('./docker_start');
 require('./create-test-db');
 require('./sip-tests');
-require('./remove-test-db');
 require('./docker_stop');

test/remove-test-db.js

@@ -1,11 +0,0 @@
-const test = require('tape').test ;
-const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
-
-test('dropping jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
-    if (err) return t.end(err);
-    t.pass('database successfully dropped');
-    t.end();
-  });
-});

test/scenarios/uac-device-unknown-realm.xml

@@ -53,7 +53,7 @@
   <recv response="100" optional="true">
   </recv>
 
-  <recv response="403">
+  <recv response="404">
   </recv>
 
   <send>

test/scenarios/uac-did-regex-match.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-pcap-carrier-max-call-limit.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+15083871234@echo.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@echo.sip.jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-max-call-limit
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="503" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:15083871234@echo.sip.jambonz.org SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@echo.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-max-call-limit
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

test/scenarios/uac-pcap-carrier-success.xml

@@ -25,10 +25,10 @@
   <send retrans="500">
     <![CDATA[
 
-      INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      INVITE sip:+16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>
+      To: <sip:16173333456@jambonz.org>
       Call-ID: [call_id]
       CSeq: 1 INVITE
       Contact: sip:sipp@[local_ip]:[local_port]
@@ -67,10 +67,10 @@
   <send>
     <![CDATA[
 
-      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      ACK sip:16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
       Call-ID: [call_id]
       CSeq: 1 ACK
       Max-Forwards: 70
@@ -94,10 +94,10 @@
   <send retrans="500">
     <![CDATA[
 
-      BYE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      BYE sip:16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
       Call-ID: [call_id]
       CSeq: 2 BYE
       Subject: uac-pcap-carrier-success

test/scenarios/uas.xml

@@ -124,7 +124,24 @@
   ]]>
 </send>
 
+<recv request="BYE">
+</recv>
+
+<send next="2">
+  <![CDATA[
+
+    SIP/2.0 200 OK
+    [last_Via:]
+    [last_From:]
+    [last_To:]
+    [last_Call-ID:]
+    [last_CSeq:]
+    Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+    Content-Length: 0
+
+  ]]>
+</send>
+
 <label id="2"/>
 
 </scenario>
-

test/sip-tests.js

@@ -1,7 +1,7 @@
-const test = require('blue-tape');
-const { output, sippUac } = require('./sipp')('test_sbc-inbound');
-const debug = require('debug')('drachtio:sbc-inbound');
-const clearModule = require('clear-module');
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_sbc-inbound');
+const bent = require('bent');
+const getJSON = bent('json');
 
 process.on('unhandledRejection', (reason, p) => {
   console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -15,60 +15,62 @@ function connect(connectable) {
   });
 }
 
-test('incoming call tests', (t) => {
-  const {srf} = require('../app');
+function waitFor(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms * 1000);
+  });
+}
 
-  connect(srf)
-    .then(() => {
-      return sippUac('uac-pcap-carrier-success.xml', '172.38.0.20');
-    })
-    .then(() => {
-      return t.pass('incoming call from carrier completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-pbx-success.xml', '172.38.0.21');
-    })
-    .then(() => {
-      return t.pass('incoming call from customer PBX completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-device-success.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('incoming call from authenticated device completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-device-unknown-user.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('unknown user is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-device-unknown-realm.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('unknown realm is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-device-invalid-password.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('invalid password for valid user is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-device-success-in-dialog-request.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('handles in-dialog requests');
-    })
-    .then(() => {
-      srf.disconnect();
-      t.end();
-      return;
-    })
-    .catch((err) => {
-      console.log(`error received: ${err}`);
-      if (srf) srf.disconnect();
-      t.error(err);
-    });
+test('incoming call tests', async(t) => {
+  const {srf} = require('../app');
+  const { queryCdrs } = srf.locals;
+  let res;
+  
+  try {
+    await connect(srf);
+
+    let obj = await getJSON('http://127.0.0.1:3050/');
+    t.ok(obj.calls === 0, 'HTTP GET / works (current call count)')
+    obj = await getJSON('http://127.0.0.1:3050/system-health');
+    t.ok(obj.calls === 0, 'HTTP GET /system-health works (health check)')
+
+    await sippUac('uac-pcap-carrier-success.xml', '172.38.0.20');
+    t.pass('incoming call from carrier completed successfully');
+
+    await sippUac('uac-pcap-pbx-success.xml', '172.38.0.21');
+    t.pass('incoming call from account-level carrier completed successfully');
+  
+    await sippUac('uac-did-regex-match.xml', '172.38.0.20');
+    t.pass('incoming call matched by trailing wildcard *');
+  
+    await sippUac('uac-pcap-device-success.xml', '172.38.0.30');
+    t.pass('incoming call from authenticated device completed successfully');
+  
+    await sippUac('uac-device-unknown-user.xml', '172.38.0.30');
+    t.pass('unknown user is rejected with a 403');
+  
+    await sippUac('uac-device-unknown-realm.xml', '172.38.0.30');
+    t.pass('unknown realm is rejected with a 404');
+  
+    await sippUac('uac-device-invalid-password.xml', '172.38.0.30');
+    t.pass('invalid password for valid user is rejected with a 403');
+  
+    await sippUac('uac-pcap-device-success-in-dialog-request.xml', '172.38.0.30');
+    t.pass('handles in-dialog requests');
+  
+    await sippUac('uac-pcap-carrier-max-call-limit.xml', '172.38.0.20');
+    t.pass('rejects incoming call with 503 when max calls per account reached')
+  
+    await waitFor(12);
+    const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});
+    console.log(`cdrs: ${JSON.stringify(res)}`);
+    t.ok(7 === res.total, 'successfully wrote 7 cdrs for calls');
+
+    srf.disconnect();
+    t.end();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    if (srf) srf.disconnect();
+    t.error(err);
+  }
 });

test/sipp.js

@@ -1,5 +1,5 @@
 const { spawn } = require('child_process');
-const debug = require('debug')('test:sipp');
+const debug = require('debug')('jambonz:ci');
 let network;
 const obj = {};
 let output = '';
@@ -27,7 +27,7 @@ obj.output = () => {
 obj.sippUac = (file, bindAddress) => {
   const cmd = 'docker';
   const args = [
-    'run', '-ti', '--rm', '--net', `${network}`,
+    'run', '--rm', '--net', `${network}`,
     '-v', `${__dirname}/scenarios:/tmp/scenarios`,
     'drachtio/sipp', 'sipp', '-sf', `/tmp/scenarios/${file}`,
     '-m', '1',
@@ -37,7 +37,7 @@ obj.sippUac = (file, bindAddress) => {
     'sbc'
   ];
 
-  if (bindAddress) args.splice(5, 0, '--ip', bindAddress);
+  if (bindAddress) args.splice(4, 0, '--ip', bindAddress);
 
   //console.log(args.join(' '));
   clearOutput();
@@ -57,11 +57,11 @@ obj.sippUac = (file, bindAddress) => {
     });
 
     child_process.stdout.on('data', (data) => {
-      //debug(`stdout: ${data}`);
+      debug(`stderr: ${data}`);
       addOutput(data.toString());
     });
-    child_process.stdout.on('data', (data) => {
-      //debug(`stdout: ${data}`);
+    child_process.stderr.on('data', (data) => {
+      debug(`stderr: ${data}`);
       addOutput(data.toString());
     });
   });