feat: add instance_id to gause calls metric (#87)

Co-authored-by: Quan HL <quanluuhoang8@gmail.com>

Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=linux/amd64 node:18.12.1-alpine3.16 as base
+FROM --platform=linux/amd64 node:18.14.1-alpine3.16 as base
 
 RUN apk --update --no-cache add --virtual .builds-deps build-base python3
 

app.js

@@ -247,7 +247,8 @@ if (process.env.K8S || process.env.HTTP_PORT) {
 if ('test' !== process.env.NODE_ENV) {
   /* update call stats periodically */
   setInterval(() => {
-    stats.gauge('sbc.sip.calls.count', activeCallIds.size, ['direction:inbound']);
+    stats.gauge('sbc.sip.calls.count', activeCallIds.size,
+      ['direction:inbound', `instance_id:${process.env.INSTANCE_ID || 0}`]);
   }, 20000);
 }
 
@@ -321,8 +322,18 @@ process.on('SIGUSR2', handle.bind(null, removeFromSet, setName));
 process.on('SIGTERM', handle.bind(null, removeFromSet, setName));
 
 function handle(removeFromSet, setName, signal) {
-  logger.info(`got signal ${signal}, removing ${srf.locals.privateSipAddress} from set ${setName}`);
-  removeFromSet(setName, srf.locals.privateSipAddress);
+  logger.info(`got signal ${signal}`);
+  if (srf.locals.privateSipAddress && setName) {
+    logger.info(`removing ${srf.locals.privateSipAddress} from set ${setName}`);
+    removeFromSet(setName, srf.locals.privateSipAddress);
+  }
+  if (process.env.K8S) {
+    lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+    if (0 === activeCallIds.size) {
+      logger.info('exiting immediately since we have no calls in progress');
+      process.exit(0);
+    }
+  }
 }
 
 module.exports = {srf, logger};

lib/autoscale-manager.js

@@ -57,6 +57,9 @@ module.exports = (logger) => {
       }
     })();
   }
+  else if (process.env.K8S) {
+    lifecycleEmitter.scaleIn = () => process.exit(0);
+  }
 
   return {lifecycleEmitter};
 };

lib/call-session.js

@@ -22,8 +22,10 @@ const MS_TEAMS_SIP_ENDPOINT = 'sip.pstnhub.microsoft.com';
 const createBLegFromHeader = (req) => {
   const from = req.getParsedHeader('From');
   const uri = parseUri(from.uri);
-  if (uri && uri.user) return `<sip:${uri.user}@localhost>`;
-  return '<sip:anonymous@localhost>';
+  const name = from.name;
+  const displayName = name ? `${name} ` : '';
+  if (uri && uri.user) return `${displayName}<sip:${uri.user}@localhost>`;
+  else return `${displayName}<sip:anonymous@localhost>`;
 };
 
 const createSiprecBody = (headers, sdp, type, content) => {
@@ -291,7 +293,6 @@ class CallSession extends Emitter {
     } catch (err) {
       this.rtpEngineResource.destroy().catch((err) => this.logger.info({err}, 'Error destroying rtpe after failure'));
       this.activeCallIds.delete(this.req.get('Call-ID'));
-      this.stats.gauge('sbc.sip.calls.count', this.activeCallIds.size);
       if (err instanceof SipError) {
         const tags = ['accepted:no', `sipStatus:${err.status}`, `originator:${this.req.locals.originator}`];
         this.stats.increment('sbc.terminations', tags);
@@ -426,6 +427,12 @@ class CallSession extends Emitter {
 
     // default forwarding of other request types
     forwardInDialogRequests(uas, ['notify', 'options', 'message']);
+
+    // we need special handling for invite with null sdp followed by 3pcc re-invite
+    if (uas.local.sdp.includes('a=recvonly') || uas.local.sdp.includes('a=inactive')) {
+      this.logger.info('incoming call is recvonly or inactive, waiting for re-invite');
+      this._recvonly = true;
+    }
   }
 
   async _onDTMF(dlg, payload) {
@@ -528,24 +535,70 @@ Duration=${payload.duration} `
   }
 
   async _onReinvite(dlg, req, res) {
+    const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
+    const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
+    const reason = req.get('X-Reason');
+    const isReleasingMedia = reason && dlg.type === 'uac' && ['release-media', 'anchor-media'].includes(reason);
+    const offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
+    const answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
+    const direction =  dlg.type === 'uas' ? ['public', 'private'] : ['private', 'public'];
+
     try {
       /* check for re-invite with no SDP -- seen that from BT when they provide UUI info */
       if (!req.body) {
-        this.logger.info('got a reINVITE with no SDP; just respond with our current offer');
-        res.send(200, {body: dlg.local.sdp});
+        if (dlg.type === 'uas' && this._recvonly) {
+          /* seen this from Broadworks - initial INVITE has no SDP, then reINVITE with SDP */
+          this._recvonly = false;  //one-time only
+          const myMungedSdp = dlg.local.sdp.replace('a=recvonly', 'a=sendrecv').replace('a=inactive', 'a=sendrecv');
+          this.logger.info({myMungedSdp}, '_onReinvite (3gpp): got a reINVITE with no SDP while in recvonly mode');
+          res.send(200,
+            {
+              body: myMungedSdp
+            },
+            (err, req) => {},
+            async(ack) => {
+              const remoteOffer = ack.body;
+              this.logger.info({remoteOffer}, '_onReinvite (3gpp): got ACK for reINVITE with SDP');
+              let opts = {
+                ...this.rtpEngineOpts.common,
+                ...offerMedia,
+                'from-tag': fromTag,
+                'to-tag': toTag,
+                direction,
+                sdp: remoteOffer,
+              };
+              let response = await this.offer(opts);
+              if ('ok' !== response.result) {
+                res.send(488);
+                throw new Error(`_onReinvite (3gpp): rtpengine failed: offer: ${JSON.stringify(response)}`);
+              }
+              this.logger.info({response}, '_onReinvite (3gpp): response from rtpengine for offer');
+              const fsSdp = await dlg.other.modify(response.sdp);
+              opts = {
+                ...this.rtpEngineOpts.common,
+                ...answerMedia,
+                'from-tag': fromTag,
+                'to-tag': toTag,
+                sdp: fsSdp
+              };
+              response = await this.answer(opts);
+              if ('ok' !== response.result) {
+                res.send(488);
+                throw new Error(`_onReinvite(3gpp): rtpengine failed answer: ${JSON.stringify(response)}`);
+              }
+            }
+          );
+        }
+        else {
+          this.logger.info('got a reINVITE with no SDP; just respond with our current offer');
+          res.send(200, {body: dlg.local.sdp});
+        }
         return;
       }
       const offeredSdp = Array.isArray(req.payload) && req.payload.length > 1 ?
         req.payload.find((p) => p.type === 'application/sdp').content :
         req.body;
 
-      const reason = req.get('X-Reason');
-      const isReleasingMedia = reason && dlg.type === 'uac' && ['release-media', 'anchor-media'].includes(reason);
-      const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
-      const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
-      const offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
-      const answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
-      const direction =  dlg.type === 'uas' ? ['public', 'private'] : ['private', 'public'];
       if (isReleasingMedia) {
         if (!offerMedia.flags.includes('asymmetric')) offerMedia.flags.push('asymmetric');
         offerMedia.flags = offerMedia.flags.filter((f) => f !== 'media handover');

lib/db-utils.js

@@ -28,7 +28,8 @@ vc.account_sid, vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ip
 FROM sip_gateways sg, voip_carriers vc
 WHERE sg.voip_carrier_sid = vc.voip_carrier_sid 
 AND vc.service_provider_sid IS NOT NULL 
-AND vc.is_active = 1`;
+AND vc.is_active = 1 
+AND sg.inbound = 1`;
 
 const sqlCarriersForAccountBySid =
 `SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
@@ -210,7 +211,19 @@ module.exports = (srf, logger) => {
     else {
       /* find all carrier entries that have an inbound gateway matching the source IP */
       const [gw] = await pp.query(sqlSelectAllGatewaysForSP);
-      const matches = gw.filter(gatewayMatchesSourceAddress.bind(null, req.source_address));
+      let matches = gw
+        .filter(gatewayMatchesSourceAddress.bind(null, req.source_address))
+        .map((gw) => {
+          return {
+            voip_carrier_sid: gw.voip_carrier_sid,
+            name: gw.name,
+            service_provider_sid: gw.service_provider_sid,
+            account_sid: gw.account_sid,
+            application_sid: gw.application_sid
+          };
+        });
+      /* remove duplicates, winnow down to voip_carriers, not gateways */
+      matches = [...new Set(matches.map(JSON.stringify))].map(JSON.parse);
       if (matches.length) {
         /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
         const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-inbound",
-  "version": "v0.7.8",
+  "version": "v0.8.1",
   "main": "app.js",
   "engines": {
     "node": ">= 12.0.0"
@@ -28,9 +28,9 @@
     "@jambonz/db-helpers": "^0.7.4",
     "@jambonz/http-authenticator": "^0.2.2",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.6.3",
+    "@jambonz/realtimedb-helpers": "^0.7.0",
     "@jambonz/rtpengine-utils": "^0.4.3",
-    "@jambonz/siprec-client-utils": "^0.2.0",
+    "@jambonz/siprec-client-utils": "^0.2.4",
     "@jambonz/stats-collector": "^0.1.6",
     "@jambonz/time-series": "^0.2.5",
     "aws-sdk": "^2.1261.0",