feat: multi srs (#93)

* feat: record all call

* feat: record all call

* feat: record all call

* feat: record all call

* add record format in recording url

* add record format to recording url

* fix ext

.github/workflows/docker-publish.yml

@@ -2,6 +2,8 @@ name: Docker
 
 on:
   push:
+    branches:
+      - main
     tags:
       - '*'
 
@@ -18,7 +20,7 @@ jobs:
       - name: prepare tag 
         id: prepare_tag
         run: |
-            IMAGE_ID=$GITHUB_REPOSITORY
+            IMAGE_ID=jambonz/sbc-outbound
 
             # Strip git ref prefix from version
             VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')

app.js

@@ -3,12 +3,38 @@ assert.ok(process.env.JAMBONES_MYSQL_HOST &&
   process.env.JAMBONES_MYSQL_USER &&
   process.env.JAMBONES_MYSQL_PASSWORD &&
   process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
-assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
+if (process.env.JAMBONES_REDIS_SENTINELS) {
+  assert.ok(process.env.JAMBONES_REDIS_SENTINEL_MASTER_NAME,
+    'missing JAMBONES_REDIS_SENTINEL_MASTER_NAME env var, JAMBONES_REDIS_SENTINEL_PASSWORD env var is optional');
+} else {
+  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_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_NETWORK_CIDR env var');
 assert.ok(process.env.JAMBONES_TIME_SERIES_HOST, 'missing JAMBONES_TIME_SERIES_HOST env var');
 
+const JAMBONES_REDIS_SENTINELS = process.env.JAMBONES_REDIS_SENTINELS ? {
+  sentinels: process.env.JAMBONES_REDIS_SENTINELS.split(',').map((sentinel) => {
+    let host, port = 26379;
+    if (sentinel.includes(':')) {
+      const arr = sentinel.split(':');
+      host = arr[0];
+      port = parseInt(arr[1], 10);
+    } else {
+      host = sentinel;
+    }
+    return {host, port};
+  }),
+  name: process.env.JAMBONES_REDIS_SENTINEL_MASTER_NAME,
+  ...(process.env.JAMBONES_REDIS_SENTINEL_PASSWORD && {
+    password: process.env.JAMBONES_REDIS_SENTINEL_PASSWORD
+  }),
+  ...(process.env.JAMBONES_REDIS_SENTINEL_USERNAME && {
+    username: process.env.JAMBONES_REDIS_SENTINEL_USERNAME
+  })
+} : null;
+
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-outbound');
 const CIDRMatcher = require('cidr-matcher');
@@ -61,8 +87,8 @@ const {
   incrKey,
   decrKey,
   retrieveSet,
-  isMemberOfSet
-} = require('@jambonz/realtimedb-helpers')({
+  isMemberOfSet,
+} = require('@jambonz/realtimedb-helpers')(JAMBONES_REDIS_SENTINELS || {
   host: process.env.JAMBONES_REDIS_HOST,
   port: process.env.JAMBONES_REDIS_PORT || 6379
 }, logger);
@@ -102,10 +128,7 @@ srf.locals = {...srf.locals,
     isMemberOfSet
   }
 };
-const {initLocals, checkLimits, route} = require('./lib/middleware')(srf, logger, {
-  host: process.env.JAMBONES_REDIS_HOST,
-  port: process.env.JAMBONES_REDIS_PORT || 6379
-});
+const {initLocals, checkLimits, route} = require('./lib/middleware')(srf, logger, redisClient);
 const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
 const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
 const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {

lib/call-session.js

@@ -33,19 +33,21 @@ const createBLegToHeader = (req, teams) => {
   return `sip:anonymous@${host}`;
 };
 
-const initCdr = (srf, req) => {
-  const uri = parseUri(req.uri);
+const initCdr = (req, invite) => {
+  const {srf} = req;
+  const {trace_id} = req.locals;
+  const uri = parseUri(invite.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;
+  let arr = regex.exec(invite.calledNumber);
+  const to = arr ? arr[1] : invite.calledNumber;
+  arr = regex.exec(invite.callingNumber);
+  const from = arr ? arr[1] : invite.callingNumber;
   const applicationSid = req.get('X-Application-Sid');
 
   return {
     account_sid: req.get('X-Account-Sid'),
     call_sid: req.get('X-Call-Sid'),
-    sip_callid: req.get('Call-ID'),
+    sip_callid: invite.get('Call-ID'),
     ...(applicationSid && {application_sid: applicationSid}),
     from,
     to,
@@ -55,7 +57,7 @@ const initCdr = (srf, req) => {
     direction: 'outbound',
     host: srf.locals.sipAddress,
     remote_host: uri.host,
-    trace_id: req.get('X-Trace-ID') || '00000000000000000000000000000000'
+    trace_id: trace_id || '00000000000000000000000000000000'
   };
 };
 
@@ -169,6 +171,7 @@ class CallSession extends Emitter {
     this.subscribeRequest = subscribeRequest;
     this.subscribeAnswer = subscribeAnswer;
     this.unsubscribe = unsubscribe;
+    this.srsClients = [];
 
     this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, this.useWss || teams, teams);
     this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
@@ -424,7 +427,7 @@ class CallSession extends Emitter {
               }
               else {
                 this.req.locals.cdr = {
-                  ...initCdr(this.req.srf, inv),
+                  ...initCdr(this.req, inv),
                   service_provider_sid: this.req.locals.service_provider_sid,
                   account_sid: this.req.locals.account_sid,
                   ...(this.req.locals.application_sid && {application_sid: this.req.locals.application_sid}),
@@ -540,12 +543,18 @@ class CallSession extends Emitter {
         /* write cdr for connected call */
         if (this.req.locals.cdr) {
           const now = Date.now();
+          const day = new Date();
+          const recordAllCalls = this.req.locals.record_all_calls;
+          let recording_url = `/Accounts/${this.account_sid}/RecentCalls/${this.req.locals.cdr.call_sid}/record`;
+          recording_url += `/${day.getFullYear()}/${(day.getMonth() + 1).toString().padStart(2, '0')}`;
+          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${recordAllCalls}`;
           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)
+            duration: Math.floor((now - callStart) / 1000),
+            ...(recordAllCalls && {recording_url})
           }).catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
         }
         /* de-link the 2 Dialogs for GC */
@@ -554,10 +563,7 @@ class CallSession extends Emitter {
         dlg.other = null;
         other.other = null;
 
-        if (this.srsClient) {
-          this.srsClient.stop();
-          this.srsClient = null;
-        }
+        this._stopRecording();
 
         this.logger.info(`call ended with normal termination, there are ${this.activeCallIds.size} active`);
         if (this.activeCallIds.size === 0) this.idleEmitter.emit('idle');
@@ -582,6 +588,13 @@ class CallSession extends Emitter {
     forwardInDialogRequests(uac,  ['notify', 'options', 'message']);
   }
 
+  _stopRecording() {
+    if (this.srsClients.length) {
+      this.srsClients.forEach((c) => c.stop());
+      this.srsClients = [];
+    }
+  }
+
   async _onRefer(dlg, req, res) {
     /* REFER coming in from a sip device, forward to feature server */
     try {
@@ -727,7 +740,7 @@ Duration=${payload.duration} `
             const callSid = req.get('X-Call-Sid');
             const accountSid = req.get('X-Account-Sid');
             const applicationSid = req.get('X-Application-Sid');
-            if (this.srsClient) {
+            if (this.srsClients.length) {
               res.send(400);
               this.logger.info('discarding duplicate startCallRecording request for a call');
               return;
@@ -737,13 +750,14 @@ Duration=${payload.duration} `
               res.send(400);
               return;
             }
-            this.srsClient = new SrsClient(this.logger, {
+            const arr = srsUrl.split(',');
+            this.srsClients = arr.map((url) => new SrsClient(this.logger, {
               srf: dlg.srf,
               direction: 'outbound',
               originalInvite: this.req,
               callingNumber: this.req.callingNumber,
               calledNumber: this.req.calledNumber,
-              srsUrl,
+              srsUrl: url,
               srsRecordingId,
               callSid,
               accountSid,
@@ -758,41 +772,49 @@ Duration=${payload.duration} `
               blockMedia: this.blockMedia,
               unblockMedia: this.unblockMedia,
               unsubscribe: this.unsubscribe
-            });
+            }));
             try {
-              succeeded = await this.srsClient.start();
+              succeeded = (await Promise.all(
+                this.srsClients.map((c) => c.start())
+              )).every((r) => r);
             } catch (err) {
               this.logger.error({err}, 'Error starting SipRec call recording');
             }
           }
           else if (reason === 'stopCallRecording') {
-            if (!this.srsClient) {
+            if (!this.srsClients.length) {
               res.send(400);
               this.logger.info('discarding stopCallRecording request because we are not recording');
               return;
             }
             try {
-              succeeded = await this.srsClient.stop();
+              succeeded = (await Promise.all(
+                this.srsClients.map((c) => c.stop())
+              )).every((r) => r);
             } catch (err) {
               this.logger.error({err}, 'Error stopping SipRec call recording');
             }
-            this.srsClient = null;
+            this.srsClients = [];
           }
           else if (reason === 'pauseCallRecording') {
-            if (!this.srsClient || this.srsClient.paused) {
+            if (!this.srsClients.length || this.srsClients.every((c) => c.paused)) {
               this.logger.info('discarding invalid pauseCallRecording request');
               res.send(400);
               return;
             }
-            succeeded = await this.srsClient.pause();
+            succeeded = (await Promise.all(
+              this.srsClients.map((c) => c.pause())
+            )).every((r) => r);
           }
           else if (reason === 'resumeCallRecording') {
-            if (!this.srsClient || !this.srsClient.paused) {
+            if (!this.srsClients.length || !this.srsClients.every((c) => c.paused)) {
               res.send(400);
               this.logger.info('discarding invalid resumeCallRecording request');
               return;
             }
-            succeeded = await this.srsClient.resume();
+            succeeded = (await Promise.all(
+              this.srsClients.map((c) => c.resume())
+            )).every((r) => r);
           }
           res.send(succeeded ? 200 : 503);
         }

lib/middleware.js

@@ -4,10 +4,10 @@ const Registrar = require('@jambonz/mw-registrar');
 const {selectHostPort, nudgeCallCounts} = require('./utils');
 const FS_UUID_SET_NAME =  'fsUUIDs';
 
-module.exports = (srf, logger, opts) => {
+module.exports = (srf, logger, redisClient) => {
   const {incrKey, decrKey, isMemberOfSet} = srf.locals.realtimeDbHelpers;
   const {stats} = srf.locals;
-  const registrar = new Registrar(opts);
+  const registrar = new Registrar(logger, redisClient);
   const {
     lookupAccountCapacitiesBySid,
     lookupAccountBySid,
@@ -19,6 +19,7 @@ module.exports = (srf, logger, opts) => {
     const callId = req.get('Call-ID');
     req.locals.account_sid = req.get('X-Account-Sid');
     req.locals.application_sid = req.get('X-Application-Sid');
+    req.locals.record_all_calls = req.get('X-Record-All-Calls');
     const traceId = req.locals.trace_id = req.get('X-Trace-ID');
     req.locals.logger = logger.child({
       callId,

package-lock.json

@@ -1,18 +1,18 @@
 {
   "name": "sbc-outbound",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sbc-outbound",
-      "version": "0.8.3",
+      "version": "0.8.4",
       "license": "MIT",
       "dependencies": {
         "@jambonz/db-helpers": "^0.9.0",
         "@jambonz/http-health-check": "^0.0.1",
-        "@jambonz/mw-registrar": "0.2.2",
-        "@jambonz/realtimedb-helpers": "^0.8.1",
+        "@jambonz/mw-registrar": "0.2.4",
+        "@jambonz/realtimedb-helpers": "^0.8.6",
         "@jambonz/rtpengine-utils": "^0.4.3",
         "@jambonz/siprec-client-utils": "^0.2.5",
         "@jambonz/stats-collector": "^0.1.8",
@@ -601,30 +601,17 @@
       }
     },
     "node_modules/@jambonz/mw-registrar": {
-      "version": "0.2.2",
-      "resolved": "https://registry.npmjs.org/@jambonz/mw-registrar/-/mw-registrar-0.2.2.tgz",
-      "integrity": "sha512-CG0MUVRZZ+tBgB5kvjn5IS1R/OdNV5PpAsxCKE0ehe6XVJ1ap4ch9hSZmEh2q7qPnWu8sR451peF33dnoSeaPA==",
+      "version": "0.2.4",
+      "resolved": "https://registry.npmjs.org/@jambonz/mw-registrar/-/mw-registrar-0.2.4.tgz",
+      "integrity": "sha512-GHRlvHsDvwfQfqOUKh4Emt+CvoiODQ+Tny5zg8ZT5q5yz77qy3XIfOF072xO9gDSPrXjn0rH13W3iIKtNzcOIA==",
       "dependencies": {
-        "@jambonz/promisify-redis": "^0.0.6",
-        "debug": "^4.3.1",
-        "redis": "^3.1.1"
-      }
-    },
-    "node_modules/@jambonz/promisify-redis": {
-      "version": "0.0.6",
-      "resolved": "https://registry.npmjs.org/@jambonz/promisify-redis/-/promisify-redis-0.0.6.tgz",
-      "integrity": "sha512-9KmWV+ODDOPwdqijhgXOXkloGNm7nmCf3ch4D1vN46lh9FQLmnlQmEmBHIFaKB3vAgIgcMzNzcNmY23JGCGguA==",
-      "dependencies": {
-        "redis-commands": "^1.6.0"
-      },
-      "peerDependencies": {
-        "redis": "^3.0.0"
+        "debug": "^4.3.1"
       }
     },
     "node_modules/@jambonz/realtimedb-helpers": {
-      "version": "0.8.1",
-      "resolved": "https://registry.npmjs.org/@jambonz/realtimedb-helpers/-/realtimedb-helpers-0.8.1.tgz",
-      "integrity": "sha512-SkF5+raJdSfzAdg82jvbQp11ioXrt1Dn456Urf/01y/Zp8jbAZKbiztxoh13lZ5Dvo6XjOuWNJVZQIIYVy0+aA==",
+      "version": "0.8.6",
+      "resolved": "https://registry.npmjs.org/@jambonz/realtimedb-helpers/-/realtimedb-helpers-0.8.6.tgz",
+      "integrity": "sha512-ODKVVat2VAQheY13DjiAxiBBOmffMoeu3xviTjsTODr3ySZkqQZvSWU7N80pAIZvoiWG1UUEy9yI8D8mE4Jgiw==",
       "dependencies": {
         "debug": "^4.3.4",
         "ioredis": "^5.3.2"
@@ -3801,29 +3788,6 @@
         "node": ">= 12.13.0"
       }
     },
-    "node_modules/redis": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/redis/-/redis-3.1.2.tgz",
-      "integrity": "sha512-grn5KoZLr/qrRQVwoSkmzdbw6pwF+/rwODtrOr6vuBRiR/f3rjSTGupbF90Zpqm2oenix8Do6RV7pYEkGwlKkw==",
-      "dependencies": {
-        "denque": "^1.5.0",
-        "redis-commands": "^1.7.0",
-        "redis-errors": "^1.2.0",
-        "redis-parser": "^3.0.0"
-      },
-      "engines": {
-        "node": ">=10"
-      },
-      "funding": {
-        "type": "opencollective",
-        "url": "https://opencollective.com/node-redis"
-      }
-    },
-    "node_modules/redis-commands": {
-      "version": "1.7.0",
-      "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz",
-      "integrity": "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ=="
-    },
     "node_modules/redis-errors": {
       "version": "1.2.0",
       "resolved": "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz",
@@ -3843,14 +3807,6 @@
         "node": ">=4"
       }
     },
-    "node_modules/redis/node_modules/denque": {
-      "version": "1.5.1",
-      "resolved": "https://registry.npmjs.org/denque/-/denque-1.5.1.tgz",
-      "integrity": "sha512-XwE+iZ4D6ZUB7mfYRMb5wByE8L74HCn30FBN7sWnXksWc1LO1bPDl67pBR9o/kC4z/xSNAwkMYcGgqDV3BE3Hw==",
-      "engines": {
-        "node": ">=0.10"
-      }
-    },
     "node_modules/regexp.prototype.flags": {
       "version": "1.4.3",
       "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.3.tgz",
@@ -5310,27 +5266,17 @@
       }
     },
     "@jambonz/mw-registrar": {
-      "version": "0.2.2",
-      "resolved": "https://registry.npmjs.org/@jambonz/mw-registrar/-/mw-registrar-0.2.2.tgz",
-      "integrity": "sha512-CG0MUVRZZ+tBgB5kvjn5IS1R/OdNV5PpAsxCKE0ehe6XVJ1ap4ch9hSZmEh2q7qPnWu8sR451peF33dnoSeaPA==",
+      "version": "0.2.4",
+      "resolved": "https://registry.npmjs.org/@jambonz/mw-registrar/-/mw-registrar-0.2.4.tgz",
+      "integrity": "sha512-GHRlvHsDvwfQfqOUKh4Emt+CvoiODQ+Tny5zg8ZT5q5yz77qy3XIfOF072xO9gDSPrXjn0rH13W3iIKtNzcOIA==",
       "requires": {
-        "@jambonz/promisify-redis": "^0.0.6",
-        "debug": "^4.3.1",
-        "redis": "^3.1.1"
-      }
-    },
-    "@jambonz/promisify-redis": {
-      "version": "0.0.6",
-      "resolved": "https://registry.npmjs.org/@jambonz/promisify-redis/-/promisify-redis-0.0.6.tgz",
-      "integrity": "sha512-9KmWV+ODDOPwdqijhgXOXkloGNm7nmCf3ch4D1vN46lh9FQLmnlQmEmBHIFaKB3vAgIgcMzNzcNmY23JGCGguA==",
-      "requires": {
-        "redis-commands": "^1.6.0"
+        "debug": "^4.3.1"
       }
     },
     "@jambonz/realtimedb-helpers": {
-      "version": "0.8.1",
-      "resolved": "https://registry.npmjs.org/@jambonz/realtimedb-helpers/-/realtimedb-helpers-0.8.1.tgz",
-      "integrity": "sha512-SkF5+raJdSfzAdg82jvbQp11ioXrt1Dn456Urf/01y/Zp8jbAZKbiztxoh13lZ5Dvo6XjOuWNJVZQIIYVy0+aA==",
+      "version": "0.8.6",
+      "resolved": "https://registry.npmjs.org/@jambonz/realtimedb-helpers/-/realtimedb-helpers-0.8.6.tgz",
+      "integrity": "sha512-ODKVVat2VAQheY13DjiAxiBBOmffMoeu3xviTjsTODr3ySZkqQZvSWU7N80pAIZvoiWG1UUEy9yI8D8mE4Jgiw==",
       "requires": {
         "debug": "^4.3.4",
         "ioredis": "^5.3.2"
@@ -7754,29 +7700,6 @@
       "resolved": "https://registry.npmjs.org/real-require/-/real-require-0.1.0.tgz",
       "integrity": "sha512-r/H9MzAWtrv8aSVjPCMFpDMl5q66GqtmmRkRjpHTsp4zBAa+snZyiQNlMONiUmEJcsnaw0wCauJ2GWODr/aFkg=="
     },
-    "redis": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/redis/-/redis-3.1.2.tgz",
-      "integrity": "sha512-grn5KoZLr/qrRQVwoSkmzdbw6pwF+/rwODtrOr6vuBRiR/f3rjSTGupbF90Zpqm2oenix8Do6RV7pYEkGwlKkw==",
-      "requires": {
-        "denque": "^1.5.0",
-        "redis-commands": "^1.7.0",
-        "redis-errors": "^1.2.0",
-        "redis-parser": "^3.0.0"
-      },
-      "dependencies": {
-        "denque": {
-          "version": "1.5.1",
-          "resolved": "https://registry.npmjs.org/denque/-/denque-1.5.1.tgz",
-          "integrity": "sha512-XwE+iZ4D6ZUB7mfYRMb5wByE8L74HCn30FBN7sWnXksWc1LO1bPDl67pBR9o/kC4z/xSNAwkMYcGgqDV3BE3Hw=="
-        }
-      }
-    },
-    "redis-commands": {
-      "version": "1.7.0",
-      "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz",
-      "integrity": "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ=="
-    },
     "redis-errors": {
       "version": "1.2.0",
       "resolved": "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-outbound",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "main": "app.js",
   "engines": {
     "node": ">= 12.0.0"
@@ -28,9 +28,9 @@
   },
   "dependencies": {
     "@jambonz/db-helpers": "^0.9.0",
-    "@jambonz/realtimedb-helpers": "^0.8.1",
+    "@jambonz/realtimedb-helpers": "^0.8.6",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/mw-registrar": "0.2.2",
+    "@jambonz/mw-registrar": "0.2.4",
     "@jambonz/rtpengine-utils": "^0.4.3",
     "@jambonz/siprec-client-utils": "^0.2.5",
     "@jambonz/stats-collector": "^0.1.8",