@webex/calling 3.12.0-task-refactor.1 → 3.12.0-webex-services-ready.2

package/dist/common/Utils.js

@@ -27,10 +27,13 @@ exports.handleCallErrors = handleCallErrors;
 exports.handleCallingClientErrors = handleCallingClientErrors;
 exports.handleRegistrationErrors = handleRegistrationErrors;
 exports.inferIdFromUuid = inferIdFromUuid;
+exports.isValidServiceDomain = isValidServiceDomain;
 exports.modifySdpForIPv4 = modifySdpForIPv4;
+exports.normalizeMobiusUris = normalizeMobiusUris;
 exports.parseMediaQualityStatistics = parseMediaQualityStatistics;
 exports.resolveCallerIdByName = resolveCallerIdByName;
 exports.resolveCallerIdDisplay = resolveCallerIdDisplay;
+exports.resolveCallingBackend = resolveCallingBackend;
 exports.resolveContact = resolveContact;
 exports.scimQuery = scimQuery;
 exports.serviceErrorCodeHandler = serviceErrorCodeHandler;
@@ -66,13 +69,15 @@ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof _Symbo
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? _Array$from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } /* eslint-disable no-fallthrough */ /* eslint-disable no-underscore-dangle */ /* eslint-disable @typescript-eslint/no-shadow */
 function filterMobiusUris(mobiusServers, defaultMobiusUrl) {
-  var _mobiusServers$primar, _mobiusServers$backup;
+  var _mobiusServers$primar, _mobiusServers$primar2, _mobiusServers$backup, _mobiusServers$backup2;
   var logContext = {
     file: _constants.UTILS_FILE,
     method: 'filterMobiusUris'
   };
   var urisArrayPrimary = [];
   var urisArrayBackup = [];
+  var wssArrayPrimary = [];
+  var wssArrayBackup = [];
   if (mobiusServers !== null && mobiusServers !== void 0 && (_mobiusServers$primar = mobiusServers.primary) !== null && _mobiusServers$primar !== void 0 && _mobiusServers$primar.uris) {
     _Logger.default.info('Adding Primary uris', logContext);
     var _iterator = _createForOfIteratorHelper(mobiusServers.primary.uris),
@@ -88,14 +93,14 @@ function filterMobiusUris(mobiusServers, defaultMobiusUrl) {
       _iterator.f();
     }
   }
-  if (mobiusServers !== null && mobiusServers !== void 0 && (_mobiusServers$backup = mobiusServers.backup) !== null && _mobiusServers$backup !== void 0 && _mobiusServers$backup.uris) {
-    _Logger.default.info('Adding Backup uris', logContext);
-    var _iterator2 = _createForOfIteratorHelper(mobiusServers.backup.uris),
+  if (mobiusServers !== null && mobiusServers !== void 0 && (_mobiusServers$primar2 = mobiusServers.primary) !== null && _mobiusServers$primar2 !== void 0 && _mobiusServers$primar2.wss) {
+    _Logger.default.info('Adding Primary wss uris', logContext);
+    var _iterator2 = _createForOfIteratorHelper(mobiusServers.primary.wss),
       _step2;
     try {
       for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-        var _uri = _step2.value;
-        urisArrayBackup.push("".concat(_uri).concat(_constants.URL_ENDPOINT));
+        var wssUri = _step2.value;
+        wssArrayPrimary.push(wssUri);
       }
     } catch (err) {
       _iterator2.e(err);
@@ -103,6 +108,36 @@ function filterMobiusUris(mobiusServers, defaultMobiusUrl) {
       _iterator2.f();
     }
   }
+  if (mobiusServers !== null && mobiusServers !== void 0 && (_mobiusServers$backup = mobiusServers.backup) !== null && _mobiusServers$backup !== void 0 && _mobiusServers$backup.uris) {
+    _Logger.default.info('Adding Backup uris', logContext);
+    var _iterator3 = _createForOfIteratorHelper(mobiusServers.backup.uris),
+      _step3;
+    try {
+      for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+        var _uri = _step3.value;
+        urisArrayBackup.push("".concat(_uri).concat(_constants.URL_ENDPOINT));
+      }
+    } catch (err) {
+      _iterator3.e(err);
+    } finally {
+      _iterator3.f();
+    }
+  }
+  if (mobiusServers !== null && mobiusServers !== void 0 && (_mobiusServers$backup2 = mobiusServers.backup) !== null && _mobiusServers$backup2 !== void 0 && _mobiusServers$backup2.wss) {
+    _Logger.default.info('Adding Backup wss uris', logContext);
+    var _iterator4 = _createForOfIteratorHelper(mobiusServers.backup.wss),
+      _step4;
+    try {
+      for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+        var _wssUri = _step4.value;
+        wssArrayBackup.push(_wssUri);
+      }
+    } catch (err) {
+      _iterator4.e(err);
+    } finally {
+      _iterator4.f();
+    }
+  }
 
   /*
    * If there are no entries in both primary and backup arrays then add the default
@@ -116,6 +151,8 @@ function filterMobiusUris(mobiusServers, defaultMobiusUrl) {
   }
   var primaryUris = [];
   var backupUris = [];
+  var primaryWss = [];
+  var backupWss = [];
 
   /* Remove duplicates from primary by keeping the order intact */
   for (var i = 0; i < urisArrayPrimary.length; i += 1) {
@@ -130,9 +167,25 @@ function filterMobiusUris(mobiusServers, defaultMobiusUrl) {
       backupUris.push(urisArrayBackup[_i]);
     }
   }
+
+  /* Remove duplicates from primary wss by keeping the order intact */
+  for (var _i2 = 0; _i2 < wssArrayPrimary.length; _i2 += 1) {
+    if (primaryWss.indexOf(wssArrayPrimary[_i2]) === -1) {
+      primaryWss.push(wssArrayPrimary[_i2]);
+    }
+  }
+
+  /* Remove duplicates from backup wss by keeping the order intact */
+  for (var _i3 = 0; _i3 < wssArrayBackup.length; _i3 += 1) {
+    if (backupWss.indexOf(wssArrayBackup[_i3]) === -1) {
+      backupWss.push(wssArrayBackup[_i3]);
+    }
+  }
   return {
     primary: primaryUris,
-    backup: backupUris
+    backup: backupUris,
+    primaryWss: primaryWss,
+    backupWss: backupWss
   };
 }
 
@@ -196,9 +249,9 @@ function updateErrorContext(errContext, type, message, clientError) {
  * @param caller - Method which called this handler.
  * @param file - File name from where error got reported.
  */
-function emitFinalFailure(emitterCb, loggerContext) {
-  var clientError = (0, _LineError.createLineError)('', {}, _types2.ERROR_TYPE.DEFAULT, _types3.RegistrationStatus.INACTIVE);
-  updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.SERVICE_UNAVAILABLE, 'An unknown error occurred. Wait a moment and try again. Please contact the administrator if the problem persists.', _types3.RegistrationStatus.INACTIVE, clientError);
+function emitFinalFailure(emitterCb, loggerContext, message) {
+  var clientError = (0, _LineError.createLineError)(message || '', {}, _types2.ERROR_TYPE.DEFAULT, _types3.RegistrationStatus.INACTIVE);
+  updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.SERVICE_UNAVAILABLE, message || 'An unknown error occurred. Wait a moment and try again. Please contact the administrator if the problem persists.', _types3.RegistrationStatus.INACTIVE, clientError);
   emitterCb(clientError);
 }
 
@@ -230,111 +283,151 @@ function handleRegistrationErrors(_x, _x2, _x3, _x4, _x5) {
  */
 function _handleRegistrationErrors() {
   _handleRegistrationErrors = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee(err, emitterCb, loggerContext, retry429Cb, restoreRegCb) {
-    var lineError, errorCode, finalError, caller, retryAfter, errorBody, code, errorMessage, _caller, _errorMessage, _errorMessage2, _errorMessage3, _t, _t2;
+    var serverCount,
+      shouldDisconnect,
+      lineError,
+      errorCode,
+      finalError,
+      caller,
+      retryAfter,
+      errorBody,
+      code,
+      errorMessage,
+      _caller,
+      _errorMessage,
+      _errorMessage2,
+      _errorMessage3,
+      _args = arguments,
+      _t,
+      _t2;
     return _regenerator.default.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
+          serverCount = _args.length > 5 && _args[5] !== undefined ? _args[5] : 1;
+          shouldDisconnect = false;
           lineError = (0, _LineError.createLineError)('', {}, _types2.ERROR_TYPE.DEFAULT, _types3.RegistrationStatus.INACTIVE);
           errorCode = Number(err.statusCode);
           finalError = false;
           _Logger.default.warn("Status code: -> ".concat(errorCode), loggerContext);
           _t = errorCode;
-          _context.next = _t === _types2.ERROR_CODE.BAD_REQUEST ? 1 : _t === _types2.ERROR_CODE.UNAUTHORIZED ? 2 : _t === _types2.ERROR_CODE.DEVICE_NOT_FOUND ? 3 : _t === _types2.ERROR_CODE.TOO_MANY_REQUESTS ? 4 : _t === _types2.ERROR_CODE.INTERNAL_SERVER_ERROR ? 5 : _t === _types2.ERROR_CODE.SERVICE_UNAVAILABLE ? 6 : _t === _types2.ERROR_CODE.FORBIDDEN ? 7 : 15;
+          _context.next = _t === _types2.ERROR_CODE.BAD_REQUEST ? 1 : _t === _types2.ERROR_CODE.UNAUTHORIZED ? 2 : _t === _types2.ERROR_CODE.DEVICE_NOT_FOUND ? 3 : _t === _types2.ERROR_CODE.TOO_MANY_REQUESTS ? 4 : _t === _types2.ERROR_CODE.INTERNAL_SERVER_ERROR ? 6 : _t === _types2.ERROR_CODE.SERVICE_UNAVAILABLE ? 7 : _t === _types2.ERROR_CODE.FORBIDDEN ? 8 : 16;
           break;
         case 1:
           finalError = true;
           _Logger.default.warn("400 Bad Request", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.BAD_REQUEST, 'Invalid input. Please verify the required parameters, sign out and then sign back in with the valid data', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 16);
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 17);
         case 2:
           // Return it to the Caller
           finalError = true;
           _Logger.default.warn("401 Unauthorized", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.TOKEN_ERROR, 'User is unauthorized due to an expired token. Sign out, then sign back in.', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 16);
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 17);
         case 3:
           finalError = true;
           _Logger.default.warn("404 Device Not Found", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.NOT_FOUND, 'Webex Calling is unable to find your device. Sign out, then sign back in', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 16);
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 17);
         case 4:
           _Logger.default.warn("429 Too Many Requests", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.TOO_MANY_REQUESTS, 'Server is handling too many request at the time. Wait a moment and try again', _types3.RegistrationStatus.INACTIVE, lineError);
           caller = loggerContext.method || 'handleErrors';
-          if (retry429Cb && err.headers) {
-            retryAfter = Number(err.headers['retry-after']);
-            retry429Cb(retryAfter, caller);
+          if (!(retry429Cb && err.headers)) {
+            _context.next = 5;
+            break;
           }
-          return _context.abrupt("continue", 16);
+          retryAfter = Number(err.headers['retry-after']);
+          _context.next = 5;
+          return retry429Cb(retryAfter, caller);
         case 5:
+          shouldDisconnect = false;
+          return _context.abrupt("continue", 17);
+        case 6:
           _Logger.default.warn("500 Internal Server Error", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.SERVER_ERROR, 'An unknown error occurred while placing the request. Wait a moment and try again.', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 16);
-        case 6:
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 17);
+        case 7:
           _Logger.default.warn("503 Service Unavailable", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.SERVICE_UNAVAILABLE, 'An error occurred on the server while processing the request. Wait a moment and try again.', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 16);
-        case 7:
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 17);
+        case 8:
           _Logger.default.warn("403 Forbidden", loggerContext);
           errorBody = err.body;
           if (errorBody) {
-            _context.next = 8;
+            _context.next = 9;
             break;
           }
           _Logger.default.warn('Error response has no body, throwing default error', loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.FORBIDDEN_ERROR, 'An unauthorized action has been received. This action has been blocked. Please contact the administrator if this persists.', _types3.RegistrationStatus.INACTIVE, lineError);
           emitterCb(lineError, finalError);
-          return _context.abrupt("return", finalError);
-        case 8:
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("return", {
+            finalError: finalError,
+            shouldDisconnect: shouldDisconnect
+          });
+        case 9:
           code = Number(errorBody.errorCode);
           _Logger.default.warn("Error code found : ".concat(code), loggerContext);
           _t2 = code;
-          _context.next = _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_LIMIT_EXCEEDED ? 9 : _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_CREATION_DISABLED ? 11 : _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_CREATION_FAILED ? 12 : 13;
+          _context.next = _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_LIMIT_EXCEEDED ? 10 : _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_CREATION_DISABLED ? 12 : _t2 === _types2.DEVICE_ERROR_CODE.DEVICE_CREATION_FAILED ? 13 : 14;
           break;
-        case 9:
+        case 10:
           errorMessage = 'User device limit exceeded';
           _Logger.default.warn(errorMessage, loggerContext);
           if (!restoreRegCb) {
-            _context.next = 10;
+            _context.next = 11;
             break;
           }
           _caller = loggerContext.method || 'handleErrors';
-          _context.next = 10;
+          _context.next = 11;
           return restoreRegCb(errorBody, _caller);
-        case 10:
-          return _context.abrupt("continue", 14);
         case 11:
+          shouldDisconnect = false;
+          return _context.abrupt("continue", 15);
+        case 12:
           _errorMessage = 'User is not configured for WebRTC calling. Please contact the administrator to resolve this issue.';
           finalError = true;
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.FORBIDDEN_ERROR, _errorMessage, _types3.RegistrationStatus.INACTIVE, lineError);
           _Logger.default.warn(_errorMessage, loggerContext);
           emitterCb(lineError, true);
-          return _context.abrupt("continue", 14);
-        case 12:
+          shouldDisconnect = true;
+          return _context.abrupt("continue", 15);
+        case 13:
           _errorMessage2 = 'An unknown error occurred while provisioning the device. Wait a moment and try again.';
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.FORBIDDEN_ERROR, _errorMessage2, _types3.RegistrationStatus.INACTIVE, lineError);
           _Logger.default.warn(_errorMessage2, loggerContext);
           emitterCb(lineError, finalError);
-          return _context.abrupt("continue", 14);
-        case 13:
+          shouldDisconnect = serverCount > 1;
+          return _context.abrupt("continue", 15);
+        case 14:
           _errorMessage3 = 'An unknown error occurred. Wait a moment and try again. Please contact the administrator if the problem persists.';
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.FORBIDDEN_ERROR, _errorMessage3, _types3.RegistrationStatus.INACTIVE, lineError);
           _Logger.default.warn(_errorMessage3, loggerContext);
           emitterCb(lineError, finalError);
-        case 14:
-          return _context.abrupt("continue", 16);
+          shouldDisconnect = serverCount > 1;
         case 15:
+          return _context.abrupt("continue", 17);
+        case 16:
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.DEFAULT, 'Unknown error', _types3.RegistrationStatus.INACTIVE, lineError);
           _Logger.default.warn("Unknown Error", loggerContext);
           emitterCb(lineError, finalError);
-        case 16:
-          return _context.abrupt("return", finalError);
+          shouldDisconnect = serverCount > 1;
         case 17:
+          return _context.abrupt("return", {
+            finalError: finalError,
+            shouldDisconnect: shouldDisconnect
+          });
+        case 18:
         case "end":
           return _context.stop();
       }
@@ -529,6 +622,8 @@ function _handleCallErrors() {
           return _context3.abrupt("continue", 20);
         case 19:
           _Logger.default.warn("Unknown Error", loggerContext);
+          updateCallErrorContext(loggerContext, _types2.ERROR_TYPE.DEFAULT, 'An unknown error occurred in the call.', correlationId, callError);
+          emitterCb(callError);
         case 20:
           return _context3.abrupt("return", abort);
         case 21:
@@ -876,15 +971,15 @@ var waitForMsecs = exports.waitForMsecs = function waitForMsecs(msec) {
 };
 
 /**
- * Register calling backend.
+ * Determine the calling backend from the device object.
  *
- * @param webex -.
+ * @param device - The device object containing callingBehavior and entitlement features.
  * @returns CallingBackEnd.
  */
-function getCallingBackEnd(webex) {
-  var entModels = webex.internal.device.features.entitlement.models;
+function resolveCallingBackend(device) {
+  var entModels = device.features.entitlement.models;
   var callingBackend;
-  if (webex.internal.device.callingBehavior === _constants2.NATIVE_WEBEX_TEAMS_CALLING) {
+  if (device.callingBehavior === _constants2.NATIVE_WEBEX_TEAMS_CALLING) {
     for (var i = 0; i < entModels.length; i += 1) {
       if (entModels[i][_constants2.VALUES][_constants2.KEY] === _constants2.ENTITLEMENT_BASIC || entModels[i][_constants2.VALUES][_constants2.KEY] === _constants2.ENTITLEMENT_STANDARD) {
         callingBackend = _types3.CALLING_BACKEND.WXC;
@@ -894,12 +989,22 @@ function getCallingBackEnd(webex) {
         break;
       }
     }
-  } else if (webex.internal.device.callingBehavior === _constants2.NATIVE_SIP_CALL_TO_UCM) {
+  } else if (device.callingBehavior === _constants2.NATIVE_SIP_CALL_TO_UCM) {
     callingBackend = _types3.CALLING_BACKEND.UCM;
   } else {
     callingBackend = _types3.CALLING_BACKEND.INVALID;
   }
-  return callingBackend;
+  return callingBackend || _types3.CALLING_BACKEND.INVALID;
+}
+
+/**
+ * Register calling backend.
+ *
+ * @param webex -.
+ * @returns CallingBackEnd.
+ */
+function getCallingBackEnd(webex) {
+  return resolveCallingBackend(webex.internal.device);
 }
 
 /**
@@ -922,7 +1027,7 @@ function getXsiActionEndpoint(_x16, _x17, _x18) {
  */
 function _getXsiActionEndpoint() {
   _getXsiActionEndpoint = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5(webex, loggerContext, callingBackend) {
-    var _userIdResponse$heade, userIdResponse, response, xsiEndpoint, _bwTokenResponse$head, bwTokenResponse, _response, _xsiEndpoint, xsiUrl, errorInfo, _t7, _t8;
+    var _webex$internal$servi, _userIdResponse$heade, hydraEndpoint, userIdResponse, response, xsiEndpoint, _bwTokenResponse$head, bwTokenResponse, _response, _xsiEndpoint, xsiUrl, errorInfo, _t7, _t8;
     return _regenerator.default.wrap(function (_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
@@ -931,9 +1036,10 @@ function _getXsiActionEndpoint() {
           _context5.next = _t7 === _types3.CALLING_BACKEND.WXC ? 1 : _t7 === _types3.CALLING_BACKEND.BWRKS ? 3 : 5;
           break;
         case 1:
+          hydraEndpoint = ((_webex$internal$servi = webex.internal.services._serviceUrls) === null || _webex$internal$servi === void 0 ? void 0 : _webex$internal$servi.hydra) || webex.internal.services.get(webex.internal.services._activeServices.hydra);
           _context5.next = 2;
           return webex.request({
-            uri: "".concat(webex.internal.services._serviceUrls.hydra, "/").concat(_constants2.XSI_ACTION_ENDPOINT_ORG_URL_PARAM),
+            uri: "".concat(hydraEndpoint, "/").concat(_constants2.XSI_ACTION_ENDPOINT_ORG_URL_PARAM),
             method: _types3.HTTP_METHODS.GET
           });
         case 2:
@@ -1326,7 +1432,7 @@ function isValidServiceDomain(serviceData) {
 }
 
 /**
- * Validates service data object(indicator & domain) and throws
+ * Validates service data object(indicator) and throws
  * exception with a message indicating the reason for validation
  * failure.
  *
@@ -1338,9 +1444,6 @@ function validateServiceData(serviceData) {
   if (!isValidServiceIndicator(serviceData.indicator)) {
     throw new Error("Invalid service indicator, Allowed values are: ".concat(formattedValues));
   }
-  if (!isValidServiceDomain(serviceData)) {
-    throw new Error('Invalid service domain.');
-  }
 }
 
 /**
@@ -1478,4 +1581,9 @@ function _uploadLogs() {
   }));
   return _uploadLogs.apply(this, arguments);
 }
+function normalizeMobiusUris(urls) {
+  return urls.map(function (url) {
+    return !url.endsWith('/') ? "".concat(url, "/") : url;
+  });
+}
 //# sourceMappingURL=Utils.js.map