major merge of features from com version (#11)

major merge of features from the hosted branch that was created temporarily during the initial launch of jambonz.org

app.js

@@ -6,7 +6,6 @@ assert.ok(process.env.JAMBONES_MYSQL_HOST &&
 assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
 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 JAMBONES_RTPENGINES env var');
 
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-outbound');
@@ -14,35 +13,77 @@ const opts = Object.assign({
   timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
 }, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
 const logger = require('pino')(opts);
+const {
+  writeCdrs,
+  queryCdrs,
+  writeAlerts,
+  AlertType
+} = require('@jambonz/time-series')(logger, {
+  host: process.env.JAMBONES_TIME_SERIES_HOST,
+  commitSize: 50,
+  commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+});
 const StatsCollector = require('@jambonz/stats-collector');
-const stats = srf.locals.stats = new StatsCollector(logger);
+const stats = new StatsCollector(logger);
-const {route, setLogger} = require('./lib/middleware');
 const CallSession = require('./lib/call-session');
-const {performLcr, lookupAllTeamsFQDNs, lookupAccountBySipRealm} = require('@jambonz/db-helpers')({
+const setNameRtp = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-rtp`;
+const rtpServers = [];
+const {
+  performLcr,
+  lookupAllTeamsFQDNs,
+  lookupAccountBySipRealm,
+  lookupAccountBySid,
+  lookupAccountCapacitiesBySid
+} = require('@jambonz/db-helpers')({
   host: process.env.JAMBONES_MYSQL_HOST,
   user: process.env.JAMBONES_MYSQL_USER,
   password: process.env.JAMBONES_MYSQL_PASSWORD,
   database: process.env.JAMBONES_MYSQL_DATABASE,
   connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
 }, logger);
-srf.locals.dbHelpers = {performLcr, lookupAllTeamsFQDNs, lookupAccountBySipRealm};
+const {createHash, retrieveHash, incrKey, decrKey, retrieveSet} = require('@jambonz/realtimedb-helpers')({
-const {createHash, retrieveHash} = require('@jambonz/realtimedb-helpers')({
   host: process.env.JAMBONES_REDIS_HOST || 'localhost',
   port: process.env.JAMBONES_REDIS_PORT || 6379
 }, logger);
-srf.locals.realtimeDbHelpers = {createHash, retrieveHash};
 
-const {getRtpEngine} = require('@jambonz/rtpengine-utils')(process.env.JAMBONES_RTPENGINES.split(','), logger, {
+const activeCallIds = new Map();
-  emitter: srf.locals.stats
+
+srf.locals = {...srf.locals,
+  stats,
+  writeCdrs,
+  writeAlerts,
+  AlertType,
+  queryCdrs,
+  activeCallIds,
+  dbHelpers: {
+    performLcr,
+    lookupAllTeamsFQDNs,
+    lookupAccountBySipRealm,
+    lookupAccountBySid,
+    lookupAccountCapacitiesBySid
+  },
+  realtimeDbHelpers: {
+    createHash,
+    retrieveHash,
+    incrKey,
+    decrKey
+  }
+};
+const {initLocals, checkLimits, route} = require('./lib/middleware')(srf, logger, {
+  host: process.env.JAMBONES_REDIS_HOST,
+  port: process.env.JAMBONES_REDIS_PORT || 6379
 });
+const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {emitter: stats});
 srf.locals.getRtpEngine = getRtpEngine;
 
-const activeCallIds = srf.locals.activeCallIds = new Set();
-
 if (process.env.DRACHTIO_HOST) {
   srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
   srf.on('connect', (err, hp) => {
     logger.info(`connected to drachtio listening on ${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`);
+    srf.locals.sipAddress = arr[2];
   });
 }
 else {
@@ -54,19 +95,55 @@ if (process.env.NODE_ENV === 'test') {
   });
 }
 
-srf.use('invite', [setLogger(logger), route({
+srf.use('invite', [initLocals, checkLimits, route]);
-  host: process.env.JAMBONES_REDIS_HOST,
-  port: process.env.JAMBONES_REDIS_PORT || 6379
-})]);
 srf.invite((req, res) => {
   const session = new CallSession(logger, req, res);
   session.connect();
 });
 
+/* update call stats periodically */
 setInterval(() => {
   stats.gauge('sbc.sip.calls.count', activeCallIds.size, ['direction:outbound']);
 }, 5000);
 
+const arrayCompare = (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;
+};
+
+/* update rtpengines periodically */
+if (process.env.JAMBONES_RTPENGINES) {
+  setRtpEngines([process.env.JAMBONES_RTPENGINES]);
+}
+else {
+  const getActiveRtpServers = async() => {
+    try {
+      const set = await retrieveSet(setNameRtp);
+      const newArray = Array.from(set);
+      logger.debug({newArray, rtpServers}, 'getActiveRtpServers');
+      if (!arrayCompare(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 {pingMsTeamsGateways} = require('./lib/utils');
 pingMsTeamsGateways(logger, srf);
 

lib/call-session.js

@@ -1,8 +1,8 @@
 const Emitter = require('events');
-const {makeRtpEngineOpts} = require('./utils');
+const {makeRtpEngineOpts, makeCallCountKey} = require('./utils');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {SipError} = require('drachtio-srf');
-const {parseUri, stringifyUri} = require('drachtio-srf');
+const {parseUri} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-outbound');
 
 const makeInviteInProgressKey = (callid) => `sbc-out-iip${callid}`;
@@ -25,6 +25,29 @@ const createBLegToHeader = (req, teams) => {
   return `sip:anonymous@${host}`;
 };
 
+const initCdr = (srf, req) => {
+  const uri = parseUri(req.uri);
+  const regex = /^\+(\d+)$/;
+  let arr = regex.exec(req.calledNumber);
+  const to = arr ? arr[1] : req.calledNumber;
+  arr = regex.exec(req.callingNumber);
+  const from = arr ? arr[1] : req.callingNumber;
+
+  return {
+    account_sid: req.get('X-Account-Sid'),
+    call_sid: req.get('X-Call-Sid'),
+    sip_callid: req.get('Call-ID'),
+    from,
+    to,
+    duration: 0,
+    answered: false,
+    attempted_at: Date.now(),
+    direction: 'outbound',
+    host: srf.locals.sipAddress,
+    remote_host: uri.host
+  };
+};
+
 class CallSession extends Emitter {
   constructor(logger, req, res) {
     super();
@@ -36,6 +59,15 @@ class CallSession extends Emitter {
     this.useWss = req.locals.registration && req.locals.registration.protocol === 'wss';
     this.stats = this.srf.locals.stats;
     this.activeCallIds = this.srf.locals.activeCallIds;
+    this.writeCdrs = this.srf.locals.writeCdrs;
+
+    this.incrKey = req.srf.locals.realtimeDbHelpers.incrKey;
+    this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
+    this.callCountKey = makeCallCountKey(req.locals.account_sid);
+  }
+
+  get account_sid() {
+    return this.req.locals.account_sid;
   }
 
   async connect() {
@@ -43,8 +75,6 @@ class CallSession extends Emitter {
     const engine = this.srf.locals.getRtpEngine();
     if (!engine) {
       this.logger.info('No available rtpengines, rejecting call!');
-      const tags = ['accepted:no', 'sipStatus:408'];
-      this.stats.increment('sbc.originations', tags);
       return this.res.send(480);
     }
     debug(`got engine: ${JSON.stringify(engine)}`);
@@ -62,29 +92,23 @@ class CallSession extends Emitter {
     try {
       // determine where to send the call
       debug(`connecting call: ${JSON.stringify(this.req.locals)}`);
-      const headers = {
+      let headers = {
         'From': createBLegFromHeader(this.req, teams),
+        'Contact': createBLegFromHeader(this.req, teams),
         'To': createBLegToHeader(this.req, teams),
-        Allow: 'INVITE, ACK, OPTIONS, CANCEL, BYE, NOTIFY, UPDATE, PRACK'
+        Allow: 'INVITE, ACK, OPTIONS, CANCEL, BYE, NOTIFY, UPDATE, PRACK',
+        'X-Account-Sid': this.account_sid
       };
 
       if (this.req.locals.registration) {
-        debug(`sending call to registered user ${JSON.stringify(this.req.locals.registration)}`);
+        debug(`sending call to user ${JSON.stringify(this.req.locals.registration)}`);
         const contact = this.req.locals.registration.contact;
-        let destUri = this.req.uri;
-        if (this.req.has('X-Override-To')) {
-          const dest = this.req.get('X-Override-To');
-          const uri = parseUri(contact);
-          uri.user = dest;
-          destUri = stringifyUri(uri);
-          this.logger.info(`overriding destination user with ${dest}, so final uri is ${destUri}`);
-        }
         if (contact.includes('transport=ws')) {
           uris = [contact];
         }
         else {
           proxy = this.req.locals.registration.proxy;
-          uris = [destUri];
+          uris = [this.req.uri];
         }
       }
       else if (this.req.locals.target === 'forward') {
@@ -97,9 +121,10 @@ class CallSession extends Emitter {
           uris = [`sip:${this.req.calledNumber}@sip.pstnhub.microsoft.com;${vmailParam}`];
         }
         else uris = [`sip:${this.req.calledNumber}@sip.pstnhub.microsoft.com`];
-        Object.assign(headers, {
+        headers = {
+          ...headers,
           Contact: `sip:${this.req.calledNumber}@${this.req.get('X-MS-Teams-Tenant-FQDN')}:5061;transport=tls`
-        });
+        };
       }
       else {
         debug('calling lcr');
@@ -111,24 +136,25 @@ class CallSession extends Emitter {
           const routableNumber = this.req.calledNumber.startsWith('+') ?
             this.req.calledNumber.slice(1) :
             this.req.calledNumber;
-          //uris = await this.performLcr(routableNumber);
+          const gateways = await this.performLcr(routableNumber, this.account_sid);
-          const gateways = await this.performLcr(routableNumber);
           if (!gateways || gateways.length === 0) throw new Error('no routes found');
           debug(`got gateways: ${JSON.stringify(gateways)}`);
-          gateways.forEach((gw) => mapGateways.set(gw.uri, gw.auth));
+          gateways.forEach((gw) => mapGateways.set(gw.uri, {
+            name: gw.name,
+            auth: gw.auth,
+            diversion: gw.diversion,
+            hostport: gw.hostport
+          }));
           uris = gateways.map((gw) => gw.uri);
         } catch (err) {
           debug(err);
           this.logger.error(err, 'Error performing lcr');
-          const tags = ['accepted:no', 'sipStatus:488'];
-          this.stats.increment('sbc.originations', tags);
           return this.res.send(488);
         }
         debug(`sending call to PSTN ${uris}`);
       }
 
       // rtpengine 'offer'
-      debug('sending offer command to rtpengine');
       const opts = {
         ...this.rtpEngineOpts.common,
         ...this.rtpEngineOpts.uac.mediaOpts,
@@ -144,38 +170,56 @@ class CallSession extends Emitter {
         throw new Error('rtpengine failed: answer');
       }
 
+      /* check if call was abandoned */
+      if (this.req.canceled) throw new Error('abandoned');
+
       // crank through the list of gateways until connected, exhausted or caller hangs up
       let earlyMedia = false;
       while (uris.length) {
-        const hdrs = { ...headers};
+        let hdrs = { ...headers};
         const uri = uris.shift();
-        const auth = mapGateways.get(uri);
+        const gw = mapGateways.get(uri);
         const passFailure = 0 === uris.length;  // only a single target
         if (0 === uris.length) {
           try {
             const key = makeInviteInProgressKey(this.req.get('Call-ID'));
             const obj = await retrieveHash(key);
             if (obj && obj.callId && obj.cseq) {
-              Object.assign(hdrs, {
+              hdrs = {
+                ...hdrs,
                 'Call-ID': obj.callId,
                 'CSeq': `${obj.cseq} INVITE`
-              });
+              };
             }
           } catch (err) {
             this.logger.info({err}, 'Error retrieving iip key');
           }
         }
-        debug(`sending INVITE to ${uri} via ${proxy})`);
+        if (gw) {
-        this.logger.info(`sending INVITE to ${uri}`);
+          this.logger.info({gw}, `sending INVITE to ${uri} via carrier ${gw.name}`);
+          hdrs = {...hdrs, 'To': uri};
+          if (gw.diversion) {
+            let div = gw.diversion;
+            if (div.startsWith('+')) {
+              div = `<sip:${div}@${gw.hostport}>;reason=unknown;counter=1;privacy=off`;
+            }
+            else div = `<sip:+${div}@${gw.hostport}>;reason=unknown;counter=1;privacy=off`;
+            hdrs = {
+              ...hdrs,
+              'Diversion': div
+            };
+          }
+        }
+        else this.logger.info(`sending INVITE to ${uri} via proxy ${proxy})`);
         try {
           const {uas, uac} = await this.srf.createB2BUA(this.req, this.res, uri, {
             proxy,
             passFailure,
             proxyRequestHeaders: ['all', '-X-MS-Teams-FQDN', '-X-MS-Teams-Tenant-FQDN', 'X-CID', '-Allow',
-              '-X-Account-Sid', '-Session-Expires', 'Min-SE'],
+              '-Session-Expires', 'Min-SE'],
             proxyResponseHeaders: ['all', '-Allow', '-Session-Expires'],
             headers: hdrs,
-            auth,
+            auth: gw ? gw.auth : undefined,
             localSdpB: response.sdp,
             localSdpA: async(sdp, res) => {
               this.rtpEngineOpts.uac.tag = res.getParsedHeader('To').params.tag;
@@ -189,13 +233,27 @@ class CallSession extends Emitter {
               const response = await this.answer(opts);
               this.logger.debug({answer: opts, response}, 'rtpengine answer');
               if ('ok' !== response.result) {
-                this.logger.error(`rtpengine answer failed with ${JSON.stringify(response)}`);
+                /* note: this can happen if call was abandoned while we were waiting for B leg to answer */
-                throw new Error('rtpengine failed: answer');
+                this.logger.info(`rtpengine answer failed with ${JSON.stringify(response)}`);
+                throw new Error(`rtpengine failed: ${response['error-reason']}`);
               }
               return response.sdp;
             }
           }, {
             cbRequest: async(err, inv) => {
+              let trunk = gw ? gw.name : null;
+              if (!trunk) {
+                if (teams) trunk = 'Microsoft Teams';
+                else if (this.req.locals.registration) trunk = 'user';
+                else trunk = 'sipUri';
+              }
+              if (!this.req.locals.account.disable_cdrs) {
+                this.req.locals.cdr = {
+                  ...initCdr(this.req.srf, inv),
+                  account_sid: this.req.locals.account_sid,
+                  trunk
+                };
+              }
               const opts = {
                 callId: inv.get('Call-ID'),
                 cseq: ++inv.getParsedHeader('CSeq').seq
@@ -227,15 +285,24 @@ class CallSession extends Emitter {
             !(err instanceof SipError) ||   // unexpected error
             err.status === 487) {           // caller hung up
 
-            if (err instanceof SipError) this.logger.info(`final call failure  ${err.status}`);
+            const abandoned = err.message.includes('rtpengine failed: Unknown call-id');
-            else this.logger.error(err, 'unexpected call failure');
+            const status = err.status || (abandoned ? 487 : 500);
+            if (err instanceof SipError) this.logger.info(`final call failure  ${status}`);
+            else if (!abandoned) this.logger.error(err, 'unexpected call failure');
             debug(`got final outdial error: ${err}`);
-            if (!passFailure) this.res.send(err.status || 500);
+            if (!passFailure) this.res.send(status);
             this.emit('failed');
             this.rtpEngineResource.destroy();
-            const tags = ['accepted:no', `sipStatus:${err.status || 500}`];
+            const tags = ['accepted:no', `sipStatus:${status}`];
             this.stats.increment('sbc.originations', tags);
-            break;
+
+            if (this.req.locals.cdr && ![401, 407].includes(status)) {
+              this.writeCdrs({...this.req.locals.cdr,
+                terminated_at: Date.now(),
+                termination_reason: 487 === status ? 'caller abandoned' : 'failed',
+                sip_status: status,
+              }).catch((err) => this.logger.error({err}, 'Error writing cdr for call failure'));
+            }
           }
           else {
             this.logger.info(`got ${err.status}, cranking back to next destination`);
@@ -243,26 +310,52 @@ class CallSession extends Emitter {
         }
       }
     } catch (err) {
-      this.logger.error(err, `Error setting up outbonund call to: ${uris}`);
+      if ('abandonded' !== err.message) this.logger.error(err, `Error setting up outbonund call to: ${uris}`);
       this.emit('failed');
       this.rtpEngineResource.destroy();
     }
   }
 
   _setHandlers({uas, uac}) {
-    this.activeCallIds.add(this.req.get('Call-ID'));
+    const callStart = Date.now();
     const tags = ['accepted:yes', 'sipStatus:200'];
     this.stats.increment('sbc.originations', tags);
-
+    this.activeCallIds.set(this.req.get('Call-ID'), this);
+    if (this.req.locals.cdr) {
+      this.req.locals.cdr = {
+        ...this.req.locals.cdr,
+        answered: true,
+        answered_at: callStart
+      };
+    }
     this.uas = uas;
     this.uac = uac;
     [uas, uac].forEach((dlg) => {
-      //hangup
       dlg.on('destroy', () => {
         this.logger.info('call ended');
         this.rtpEngineResource.destroy();
         this.activeCallIds.delete(this.req.get('Call-ID'));
         dlg.other.destroy();
+
+        this.decrKey(this.callCountKey)
+          .then((count) => {
+            this.logger.debug(`after hangup there are ${count} active calls for this account`);
+            debug(`after hangup there are ${count} active calls for this account`);
+            return;
+          })
+          .catch((err) => this.logger.error({err}, 'Error decrementing call count'));
+
+        /* write cdr for connected call */
+        if (this.req.locals.cdr) {
+          const now = Date.now();
+          this.writeCdrs({...this.req.locals.cdr,
+            terminated_at: now,
+            termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
+            sip_status: 200,
+            answered: true,
+            duration: Math.floor((now - callStart) / 1000)
+          }).catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
+        }
       });
     });
 
@@ -316,6 +409,7 @@ class CallSession extends Emitter {
     }
   }
 
+
   async _onFeatureServerTransfer(dlg, req, res) {
     try {
       const referTo = req.getParsedHeader('Refer-To');
@@ -334,8 +428,6 @@ class CallSession extends Emitter {
         Object.assign(headers, {'X-Retain-Call-Sid': req.get('X-Retain-Call-Sid')});
       }
       const dlg = await this.srf.createUAC(referTo.uri, {localSdp: dlg.local.sdp, headers});
-      this.uas.destroy();
-
       this.uas = dlg;
       this.uas.other = this.uac;
       this.uac.other = this.uas;

lib/middleware.js

@@ -1,30 +1,122 @@
 const debug = require('debug')('jambonz:sbc-outbound');
 const parseUri = require('drachtio-srf').parseUri;
-const Registrar = require('jambonz-mw-registrar');
+const Registrar = require('@jambonz/mw-registrar');
-const {selectHostPort} = require('./utils');
+const {selectHostPort, makeCallCountKey} = require('./utils');
 
-function setLogger(logger) {
+const isLocalUri = (host, req) => {
-  return (req, res, next) => {
-    debug('setting logger');
-    req.locals = req.locals || {};
-    req.locals.logger = logger.child({callId: req.get('Call-ID')});
-    req.srf.locals.stats.increment('sbc.invites', ['direction:outbound']);
-    next();
-  };
-}
-
-function isLocalUri(host, req) {
   debug({hostport: req.server.hostport}, `is ${host} local?`);
   return req.server.hostport.includes(host);
-}
+};
 
-function route(opts) {
+
+module.exports = (srf, logger, opts) => {
+  const {incrKey, decrKey} = srf.locals.realtimeDbHelpers;
+  const {stats} = srf.locals;
   const registrar = new Registrar(opts);
-  return async(req, res, next) => {
+  const {
+    lookupAccountCapacitiesBySid,
+    lookupAccountBySid
+  }  = srf.locals.dbHelpers;
+
+  const initLocals = async(req, res, next) => {
+    req.locals = req.locals || {};
+    const callId = req.get('Call-ID');
+    req.locals.account_sid = req.get('X-Account-Sid');
+    req.locals.logger = logger.child({callId, account_sid: req.locals.account_sid});
+
+    if (!req.locals.account_sid) {
+      logger.info('missing X-Account-Sid on outbound call');
+      return res.send(403, {
+        headers: {
+          'X-Reason': 'missing X-Account-Sid'
+        }
+      });
+    }
+
+    stats.increment('sbc.invites', ['direction:outbound']);
+
+    req.on('cancel', () => {
+      req.locals.logger.info({callId}, 'caller hungup before connecting');
+      req.canceled = true;
+      const tags = ['canceled:yes', 'sipStatus:487'];
+      if (req.locals.originator) tags.push(`originator:${req.locals.originator}`);
+      stats.increment('sbc.terminations', tags);
+    });
+
+    try {
+      req.locals.account = await lookupAccountBySid(req.locals.account_sid);
+    } catch (err) {
+      req.locals.logger.error({err}, `Error looking up account sid ${req.locals.account_sid}`);
+      return res.send(500);
+    }
+    next();
+  };
+
+  const checkLimits = async(req, res, next) => {
+    const {logger, account_sid} = req.locals;
+    const {writeAlerts, AlertType} = req.srf.locals;
+
+    const key = makeCallCountKey(account_sid);
+    try {
+      /* increment the call count */
+      const calls = await incrKey(key);
+      debug(`checkLimits: call count is now ${calls}`);
+
+      /* decrement count if INVITE is later rejected */
+      res.once('end', ({status}) => {
+        if (status > 200) {
+          debug('checkLimits: decrementing call count due to rejection');
+          decrKey(key)
+            .then((count) => {
+              logger.debug({key}, `after rejection there are ${count} active calls for this account`);
+              debug({key}, `after rejection there are ${count} active calls for this account`);
+              return;
+            })
+            .catch((err) => logger.error({err}, 'checkLimits: decrKey err'));
+          const tags = ['accepted:no', `sipStatus:${status}`];
+          stats.increment('sbc.originations', tags);
+        }
+        else {
+          const tags = ['accepted:yes', 'sipStatus:200'];
+          stats.increment('sbc.originations', tags);
+        }
+      });
+
+      /* 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;
+      if (calls <= minLimit) return next();
+
+      const capacities = await lookupAccountCapacitiesBySid(account_sid);
+      const limit = capacities.find((c) => c.category == 'voice_call_session');
+      if (!limit) throw new Error('no account_capacities found');
+      const limit_sessions = limit.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.CALL_LIMIT,
+          account_sid,
+          count: limit_sessions
+        }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+
+        res.send(503, 'Maximum Calls In Progress');
+      }
+      next();
+    } catch (err) {
+      logger.error({err}, 'error checking limits error for inbound call');
+      res.send(500);
+    }
+  };
+
+  const route = async(req, res, next) => {
     const logger = req.locals.logger;
     const {lookupAccountBySipRealm} = req.srf.locals.dbHelpers;
     logger.info(`received outbound INVITE to ${req.uri} from server at ${req.server.hostport}`);
     const uri = parseUri(req.uri);
+
     if (!uri.user || !uri.host) {
       logger.info({uri: req.uri}, 'invalid request-uri on outbound call, rejecting');
       res.send(404, {
@@ -32,18 +124,14 @@ function route(opts) {
           'X-Reason': 'invalid request-uri'
         }
       });
-      const tags = ['accepted:no', 'sipStatus:404'];
-      req.srf.locals.stats.increment('sbc.originations', tags);
       return;
     }
     const aor = `${uri.user}@${uri.host}`;
-    req.locals = req.locals || {};
-
-    debug(`received outbound INVITE to ${req.calledNumber} from server at ${req.server.hostport}`);
-
     let reg;
     const dotDecimalHost = /^[0-9\.]+$/.test(uri.host);
 
+    debug(`received outbound INVITE to ${req.calledNumber} from server at ${req.server.hostport}`);
+
     if (req.has('X-MS-Teams-FQDN') && req.has('X-MS-Teams-Tenant-FQDN')) {
       logger.debug('This is a call to ms teams');
       req.locals.target = 'teams';
@@ -51,7 +139,7 @@ function route(opts) {
     }
     else if (!dotDecimalHost) {
       // uri host is not a dot-decimal address, so try to look up user
-      debug(`searching for registered user ${aor}`);
+      logger.debug(`searching for registered user ${aor}`);
       reg = await registrar.query(aor);
       if (reg) {
         // user is registered..find out which sbc is handling it
@@ -90,8 +178,6 @@ function route(opts) {
     if (!/^\d+$/.test(req.calledNumber.slice(1)) || req.calledNumber.length < 8) {
       debug(`unable to route call to ${aor}; no registered user found`);
       logger.info(`unable to route call to ${aor}; no registered user found`);
-      const tags = ['accepted:no', 'sipStatus:404'];
-      req.srf.locals.stats.increment('sbc.originations', tags);
       return res.send(404);
     }
 
@@ -99,9 +185,10 @@ function route(opts) {
     req.locals.target = 'lcr';
     next();
   };
-}
 
-module.exports = {
+  return {
-  setLogger,
+    initLocals,
-  route
+    checkLimits,
+    route
+  };
 };

lib/utils.js

@@ -6,7 +6,7 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
   const from = req.getParsedHeader('from');
   const srtpOpts = teams ? srtpCharacteristics['teams'] : srtpCharacteristics['default'];
   const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCharacteristics;
-  const srctOpts = srcIsUsingSrtp ? srtpOpts : rtpCharacteristics;
+  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCharacteristics;
   const common = {
     'call-id': req.get('Call-ID'),
     'replace': ['origin', 'session-connection']
@@ -15,7 +15,7 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
     common,
     uas: {
       tag: from.params.tag,
-      mediaOpts: srctOpts
+      mediaOpts: srcOpts
     },
     uac: {
       tag: null,
@@ -24,7 +24,7 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
   };
 }
 
-function selectHostPort(hostport, protocol) {
+const selectHostPort = (hostport, protocol) => {
   debug(`selectHostPort: ${hostport}, ${protocol}`);
   const sel = hostport
     .split(',')
@@ -36,9 +36,9 @@ function selectHostPort(hostport, protocol) {
       return hp[0] === protocol && hp[1] !== '127.0.0.1';
     });
   return sel[0];
-}
+};
 
-function pingMs(logger, srf, gateway, fqdns) {
+const pingMs = (logger, srf, gateway, fqdns) => {
   const uri = `sip:${gateway}`;
   const proxy = `sip:${gateway}:5061;transport=tls`;
   fqdns.forEach((fqdn) => {
@@ -52,8 +52,9 @@ function pingMs(logger, srf, gateway, fqdns) {
       }
     }).catch((err) => logger.error(err, `Error pinging MS Teams at ${gateway}`));
   });
-}
+};
-function pingMsTeamsGateways(logger, srf) {
+
+const pingMsTeamsGateways = (logger, srf) => {
   const {lookupAllTeamsFQDNs} = srf.locals.dbHelpers;
   lookupAllTeamsFQDNs()
     .then((fqdns) => {
@@ -68,10 +69,13 @@ function pingMsTeamsGateways(logger, srf) {
     .catch((err) => {
       logger.error(err, 'Error looking up all ms teams fqdns');
     });
-}
+};
+
+const makeCallCountKey = (sid) => `${sid}:outcalls`;
 
 module.exports = {
   makeRtpEngineOpts,
   selectHostPort,
-  pingMsTeamsGateways
+  pingMsTeamsGateways,
+  makeCallCountKey
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-outbound",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "main": "app.js",
   "engines": {
     "node": ">= 8.10.0"
@@ -22,26 +22,26 @@
   "description": "jambonz session border controller application for outbound calls",
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test 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=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ | ./node_modules/.bin/tap-spec",
+    "test": "NODE_ENV=test JAMBONZ_HOSTING=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_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 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.5.10",
+    "@jambonz/db-helpers": "^0.6.12",
-    "@jambonz/realtimedb-helpers": "^0.2.22",
+    "@jambonz/mw-registrar": "0.2.1",
-    "@jambonz/rtpengine-utils": "^0.1.8",
+    "@jambonz/realtimedb-helpers": "^0.4.3",
+    "@jambonz/rtpengine-utils": "^0.1.12",
     "@jambonz/stats-collector": "^0.1.5",
+    "@jambonz/time-series": "^0.1.5",
     "debug": "^4.3.1",
     "drachtio-fn-b2b-sugar": "^0.0.12",
-    "drachtio-srf": "^4.4.46",
+    "drachtio-srf": "^4.4.49",
-    "jambonz-mw-registrar": "^0.1.3",
+    "pino": "^6.11.2"
-    "pino": "^6.11.0"
   },
   "devDependencies": {
-    "blue-tape": "^1.0.0",
     "eslint": "^7.18.0",
     "eslint-plugin-promise": "^4.2.1",
     "nyc": "^15.1.0",
-    "tap-spec": "^5.0.0"
+    "tape": "^5.2.2"
   }
 }

test/create-test-db.js

@@ -1,5 +1,4 @@
-const test = require('blue-tape');
+const test = require('tape');
-//const test = require('tape').test ;
 const exec = require('child_process').exec ;
 const pwd = '-p$MYSQL_ROOT_PASSWORD';
 

test/db/jambones-sql.sql

@@ -2,20 +2,46 @@
 
 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 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_carriers;
+
+DROP TABLE IF EXISTS account_offers;
+
+DROP TABLE IF EXISTS products;
+
+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 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 +56,41 @@ 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 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 +99,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,6 +119,61 @@ 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 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 api_keys
 (
 api_key_sid CHAR(36) NOT NULL UNIQUE ,
@@ -59,7 +184,16 @@ 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,64 +205,121 @@ 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 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 ,
+name VARCHAR(255) NOT NULL,
-hashed_password VARCHAR(1024) NOT NULL,
+email VARCHAR(255) NOT NULL,
-salt CHAR(16) NOT NULL,
+pending_email VARCHAR(255),
-force_change BOOLEAN NOT NULL DEFAULT TRUE,
+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';
+) 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';
 
 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',
@@ -147,11 +338,22 @@ 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',
+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 ',
@@ -160,8 +362,9 @@ 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
 (
@@ -172,7 +375,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
 (
@@ -181,67 +384,144 @@ 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,
 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 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_2 (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_3 (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 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_4 (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_5 (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_6 (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 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_3 (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_4 (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_7 (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_8 (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_5 (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);
+CREATE INDEX account_sid_idx ON voip_carriers (account_sid);
-ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_9 (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_6 (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 smpp_gateway_sid_idx ON smpp_gateways (smpp_gateway_sid);
-CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
+CREATE INDEX voip_carrier_sid_idx ON smpp_gateways (voip_carrier_sid);
-ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (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_10 (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 INDEX service_provider_sid_idx ON phone_numbers (service_provider_sid);
-CREATE UNIQUE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+ALTER TABLE phone_numbers ADD FOREIGN KEY service_provider_sid_idxfk_7 (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_8 (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_11 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REFERENCES webhooks (webhook_sid);
 
@@ -257,10 +537,12 @@ 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_9 (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);
 
 SET FOREIGN_KEY_CHECKS=1;

test/db/populate-test-data.sql

@@ -1,11 +1,23 @@
+-- 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 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', 'sip.example.com', '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, service_provider_sid) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 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.39.0.20', true, true);
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, port, inbound, outbound) 

test/db/populate-test-data2.sql

@@ -1,18 +1,29 @@
+-- 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)
+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', 'sip.example.com', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'sip.example.com', '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);
 
 -- "good" carrier - "westco" at 172.39.0.20
-insert into voip_carriers (voip_carrier_sid, name) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 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.39.0.20', true, true);
 
 -- "bad" carrier - "eastco" at 172.39.0.21 (returns 503)
-insert into voip_carriers (voip_carrier_sid, name) values ('1d8ef351-062a-4487-94f8-7698d5a40d24', 'eastco');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) values ('1d8ef351-062a-4487-94f8-7698d5a40d24', 'eastco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('e71519ff-4494-4c98-a06a-324e2712d94b', '1d8ef351-062a-4487-94f8-7698d5a40d24', '172.39.0.21', true, true);
 

test/db/populate-test-data3.sql

@@ -1,22 +1,34 @@
+-- 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 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', 'sip.example.com', '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);
 
 -- "good" carrier - "westco" at 172.39.0.20
-insert into voip_carriers (voip_carrier_sid, name) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 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.39.0.20', true, true);
 
 -- "bad" carrier - "eastco" at 172.39.0.21 (returns 503)
-insert into voip_carriers (voip_carrier_sid, name) values ('1d8ef351-062a-4487-94f8-7698d5a40d24', 'eastco');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) values ('1d8ef351-062a-4487-94f8-7698d5a40d24', 'eastco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('e71519ff-4494-4c98-a06a-324e2712d94b', '1d8ef351-062a-4487-94f8-7698d5a40d24', '172.39.0.21', true, true);
 
 -- "bad" carrier - "northco" at 172.39.0.22 (returns 100 Trying and never answers)
-insert into voip_carriers (voip_carrier_sid, name) values ('7b4b9c56-4d81-4f31-9d70-62cd7d82193b', 'northco');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) values ('7b4b9c56-4d81-4f31-9d70-62cd7d82193b', 'northco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('fcbb2109-582c-4d55-b38a-b6bc7cc4be73', '7b4b9c56-4d81-4f31-9d70-62cd7d82193b', '172.39.0.22', true, true);
 

test/db/populate-test-data4.sql

@@ -1,12 +1,24 @@
+-- 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 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', 'sip.example.com', '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);
 
 -- one carrier, uas script expecting a reinvite
-insert into voip_carriers (voip_carrier_sid, name, e164_leading_plus, requires_register, register_username, register_sip_realm, register_password) 
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid, e164_leading_plus, requires_register, register_username, register_sip_realm, register_password) 
-values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', 0, 1, 'foo', 'jambonz.org', 'bar');
+values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 0, 1, 'foo', 'jambonz.org', 'bar');
 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.39.0.23', true, true);

test/db/populate-test-data5.sql

@@ -0,0 +1,25 @@
+-- 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, webhook_secret)
+values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'sip.example.com', '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', 0);
+
+
+-- one carrier, uas script expecting a reinvite
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid, e164_leading_plus, requires_register, register_username, register_sip_realm, register_password) 
+values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 0, 1, 'foo', 'jambonz.org', 'bar');
+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.39.0.23', true, true);

test/docker-compose-testbed.yaml

@@ -116,3 +116,12 @@ services:
     networks:
       sbc-outbound:
         ipv4_address: 172.39.0.24
+
+  influxdb:
+    image: influxdb:1.8-alpine
+    ports:
+      - "8086:8086"
+    networks:
+      sbc-outbound:
+        ipv4_address: 172.39.0.90
+        

test/docker_start.js

@@ -1,5 +1,4 @@
-const test = require('blue-tape');
+const test = require('tape');
-//const test = require('tape').test ;
 const exec = require('child_process').exec ;
 
 test('starting docker network..', (t) => {

test/docker_stop.js

@@ -1,4 +1,4 @@
-const test = require('blue-tape');
+const test = require('tape');
 //const test = require('tape').test ;
 const exec = require('child_process').exec ;
 

test/scenarios/uac-cancel.xml

@@ -34,6 +34,8 @@
       Contact: sip:sipp@[local_ip]:[local_port]
       Max-Forwards: 70
       Subject: uac-pcap-carrier-success
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
       Content-Type: application/sdp
       Content-Length: [len]
 

test/scenarios/uac-pcap-carrier-fail-limits.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16173333456@127.0.0.1 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:16173333456@127.0.0.1>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: ff49e33-e771-403a-8c99-1780eabbc803
+      Subject: uac-pcap-carrier-fail-limits
+      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="503" rtd="true" crlf="true">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:sip:+16173333456@127.0.0.1 SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:sip:+16173333456@127.0.0.1>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Subject: uac-pcap-carrier-fail-limits
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+
+</scenario>

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

@@ -15,6 +15,8 @@
       Contact: sip:sipp@[local_ip]:[local_port]
       Max-Forwards: 70
       Subject: uac-pcap-carrier-success
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
       Content-Type: application/sdp
       Content-Length: [len]
 

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

@@ -14,6 +14,8 @@
       CSeq: 1 INVITE
       Contact: sip:sipp@[local_ip]:[local_port]
       Max-Forwards: 70
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
       Subject: uac-pcap-carrier-success
       Content-Type: application/sdp
       Content-Length: [len]

test/scenarios/uac-pcap-device-404.xml

@@ -35,6 +35,8 @@
       Contact: sip:sipp@[local_ip]:[local_port]
       Max-Forwards: 70
       Subject: uac-pcap-device-success
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: ff649e33-e771-403a-8c99-1780eabbc803
       Content-Type: application/sdp
       Content-Length: [len]
 

test/scenarios/uac-sip-uri-auth-success.xml

@@ -35,6 +35,8 @@
       Contact: sip:sipp@[local_ip]:[local_port]
       Max-Forwards: 70
       Subject: uac-sip-uri-auth-success
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
       Content-Type: application/sdp
       Content-Length: [len]
 
@@ -86,6 +88,8 @@
       [authentication username=foo password=bar]
       Max-Forwards: 70
       Subject: uac-sip-uri-auth-success
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
       Content-Type: application/sdp
       Content-Length: [len]
 

test/sip-tests.js

@@ -1,13 +1,19 @@
-const test = require('blue-tape');
+const test = require('tape');
 const { output, sippUac } = require('./sipp')('test_sbc-outbound');
 const {execSync} = require('child_process');
 const debug = require('debug')('jambonz:sbc-outbound');
-const pwd = '-p$MYSQL_ROOT_PASSWORD';
+const consoleLogger = {error: console.error, info: console.log, debug: console.log};
 
 process.on('unhandledRejection', (reason, p) => {
   console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
 });
 
+function waitFor(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms * 1000);
+  });
+}
+
 function connect(connectable) {
   return new Promise((resolve, reject) => {
     connectable.on('connect', () => {
@@ -18,6 +24,7 @@ function connect(connectable) {
 
 test('sbc-outbound tests', async(t) => {
   const {srf} = require('../app');
+  const { queryCdrs } = srf.locals;
 
   try {
     await connect(srf);
@@ -58,7 +65,21 @@ test('sbc-outbound tests', async(t) => {
     /* invite to sipUri that challenges */
     await sippUac('uac-sip-uri-auth-success.xml');
     t.pass('successfully connected to sip uri that requires auth');
+  
+    // re-rack test data
+    execSync(`mysql -h 127.0.0.1 -u root  --protocol=tcp -D jambones_test < ${__dirname}/db/jambones-sql.sql`);
+    execSync(`mysql -h 127.0.0.1 -u root  --protocol=tcp -D jambones_test < ${__dirname}/db/populate-test-data5.sql`);
     
+    /* fails when session limit exceeded */
+    await sippUac('uac-pcap-carrier-fail-limits.xml');
+    t.pass('fails when max calls in progress');
+      
+    await waitFor(10);
+
+    const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});
+    //console.log(`cdrs: ${JSON.stringify(res)}`);
+    t.ok(res.total === 6, 'wrote 6 cdrs');
+
     srf.disconnect();
   } catch (err) {
     console.error(err);