@wazo/sdk 1.0.0-alpha.6 → 1.0.0-alpha.8

package/lib/voice/softphone.js

@@ -81,6 +81,7 @@ class Softphone extends events_1.EventEmitter {
         this.audioRingVolume = 1;
         const server = __1.default.Auth.getHost();
         const session = __1.default.Auth.getSession();
+        logger.info('softphone - connect', { server, session: !!session });
         if (!server || !session) {
             throw new Error('Please connect to the server using `Wazo.Auth.logIn` or `Wazo.Auth.authenticate` before using Room.connect().');
         }
@@ -101,6 +102,7 @@ class Softphone extends events_1.EventEmitter {
         return __awaiter(this, void 0, void 0, function* () {
             (0, utils_1.assertCan)(this.softphoneActor, softphone_state_machine_1.Actions.UNREGISTER);
             if (!this.client) {
+                logger.info('softphone - disconnect, not client to disconnect, bailing');
                 return null;
             }
             // Terminate all calls
@@ -115,7 +117,8 @@ class Softphone extends events_1.EventEmitter {
     connectWithCredentials(server_1, sipLine_1, displayName_1) {
         return __awaiter(this, arguments, void 0, function* (server, sipLine, displayName, rawOptions = {}) {
             (0, utils_1.assertCan)(this.softphoneActor, softphone_state_machine_1.Actions.REGISTER);
-            this.softphoneActor.send({ type: softphone_state_machine_1.Actions.REGISTER });
+            logger.info('softphone - connect with credentials', { server, username: sipLine.username, displayName, options: rawOptions });
+            this._sendAction(softphone_state_machine_1.Actions.REGISTER);
             const [host, port = 443] = server.split(':');
             let options = Object.assign({}, rawOptions);
             options.media = options.media || {
@@ -162,6 +165,7 @@ class Softphone extends events_1.EventEmitter {
             try {
                 sipCall = this.client.call(options.params.To, options.withCamera, options.audioOnly, options.conference, options);
                 const call = new call_1.default(sipCall, this);
+                call.onMakeCall();
                 this.calls.push(call);
                 this.emit(exports.EVENT_OUTGOING, call);
                 return call;
@@ -231,7 +235,8 @@ class Softphone extends events_1.EventEmitter {
         this.calls.filter(call => !call.isHeld() && call.id === (exceptCall === null || exceptCall === void 0 ? void 0 : exceptCall.id)).forEach(call => call.hold());
     }
     startHeartbeat() {
-        logger.info('softphone - start heartbeat', { client: !!this.client, hasHeartbeat: this.client.hasHeartbeat() });
+        var _a;
+        logger.info('softphone - start heartbeat', { client: !!this.client, hasHeartbeat: (_a = this.client) === null || _a === void 0 ? void 0 : _a.hasHeartbeat() });
         if (!this.client || this.client.hasHeartbeat()) {
             return;
         }
@@ -362,18 +367,26 @@ class Softphone extends events_1.EventEmitter {
         });
         this.client.on(this.client.UNREGISTERED, () => {
             logger.info('softphone - unregistered');
+            if (!(0, utils_1.can)(this.softphoneActor, softphone_state_machine_1.Actions.UNREGISTER)) {
+                logger.warn('softphone - cannot unregister', { state: this.state });
+                return;
+            }
+            this._sendAction(softphone_state_machine_1.Actions.UNREGISTER);
             this.emit(exports.EVENT_UNREGISTERED);
-            this._sendAction(softphone_state_machine_1.Actions.UNREGISTERED);
         });
         this.client.on(this.client.ON_DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.emit(exports.EVENT_DISCONNECTED);
+            if (!(0, utils_1.can)(this.softphoneActor, softphone_state_machine_1.Actions.TRANSPORT_CLOSED)) {
+                logger.warn('softphone - cannot disconnected', { state: this.state });
+                return;
+            }
             this._sendAction(softphone_state_machine_1.Actions.TRANSPORT_CLOSED);
+            this.emit(exports.EVENT_DISCONNECTED);
         });
         this.client.on(this.client.REGISTERED, () => {
             logger.info('softphone - registered', { state: (0, utils_1.getState)(this.softphoneActor) });
             if (!(0, utils_1.can)(this.softphoneActor, softphone_state_machine_1.Actions.REGISTER_DONE)) {
-                logger.warn('softphone - registered but not in REGISTERING state', { state: (0, utils_1.getState)(this.softphoneActor) });
+                logger.warn('softphone - registered but not in REGISTERING state', { state: this.state });
                 return;
             }
             this.stopHeartbeat();
@@ -389,9 +402,13 @@ class Softphone extends events_1.EventEmitter {
             }
         });
         this.client.on(this.client.CONNECTED, () => {
-            logger.info('softphone - connected');
+            logger.info('softphone - connected', { state: this.state });
             this.stopHeartbeat();
         });
+        this.client.on(this.client.REGISTERING, () => {
+            logger.info('softphone - registering', { state: this.state });
+            this._sendAction(softphone_state_machine_1.Actions.REGISTER);
+        });
         this.client.on(this.client.DISCONNECTED, () => {
             logger.info('softphone - disconnected');
             this.emit(exports.EVENT_DISCONNECTED);
@@ -417,7 +434,9 @@ class Softphone extends events_1.EventEmitter {
         });
     }
     _sendAction(action) {
+        const was = this.state;
         this.softphoneActor.send({ type: action });
+        logger.trace('softphone - send action', { action, was, state: this.state });
     }
     _getCall(sipCall) {
         return this.calls.find(call => call.id === (0, sdp_1.getSipCallId)(sipCall));

package/lib/web-rtc-client.js

@@ -51,6 +51,7 @@ const logger = IssueReporter_1.default ? IssueReporter_1.default.loggerFor('webr
 const statsLogger = IssueReporter_1.default ? IssueReporter_1.default.loggerFor('webrtc-stats') : console;
 // events
 const REGISTERED = 'registered';
+const REGISTERING = 'registering';
 const UNREGISTERED = 'unregistered';
 const REGISTRATION_FAILED = 'registrationFailed';
 const INVITE = 'invite';
@@ -68,7 +69,7 @@ const ON_ERROR = 'onError';
 const ON_SCREEN_SHARING_REINVITE = 'onScreenSharingReinvite';
 const ON_NETWORK_STATS = 'onNetworkStats';
 const ON_DISCONNECTED = 'onDisconnected';
-exports.events = [REGISTERED, UNREGISTERED, REGISTRATION_FAILED, INVITE];
+exports.events = [REGISTERED, REGISTERING, UNREGISTERED, REGISTRATION_FAILED, INVITE];
 exports.transportEvents = [CONNECTED, DISCONNECTED, TRANSPORT_ERROR, MESSAGE];
 class CanceledCallError extends Error {
 }
@@ -112,6 +113,7 @@ class WebRTCClient extends Emitter_1.default {
         this.heartbeat.setOnHeartbeatTimeout(this._onHeartbeatTimeout.bind(this));
         // sugar
         this.REGISTERED = REGISTERED;
+        this.REGISTERING = REGISTERING;
         this.UNREGISTERED = UNREGISTERED;
         this.REGISTRATION_FAILED = REGISTRATION_FAILED;
         this.INVITE = INVITE;
@@ -244,6 +246,7 @@ class WebRTCClient extends Emitter_1.default {
                 return Promise.resolve();
             }
             logger.info('sdk webrtc registering...', logInfo);
+            this.eventEmitter.emit(REGISTERING);
             if (!this.userAgent) {
                 logger.info('sdk webrtc recreating User Agent');
                 this.userAgent = this.createUserAgent(this.uaConfigOverrides);
@@ -1265,8 +1268,8 @@ class WebRTCClient extends Emitter_1.default {
             return audio;
         });
     }
-    _onTransportError() {
-        logger.error('on transport error');
+    _onTransportError(reason) {
+        logger.warn('on transport error', { reason });
         this.eventEmitter.emit(TRANSPORT_ERROR);
         this.attemptReconnection();
     }
@@ -1321,7 +1324,7 @@ class WebRTCClient extends Emitter_1.default {
                     }
                 }
                 // We can invoke disconnect() with an error that can be catcher by `onDisconnect`, so we have to trigger it here.
-                this._onTransportError();
+                this._onTransportError('heartbeat timeout');
             }
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wazo/sdk",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.8",
   "description": "Wazo's JavaScript Software Development Kit.",
   "main": "index.js",
   "types": "lib/types/index.d.ts",

package/src/state-machine/softphone-state-machine.ts

@@ -12,7 +12,6 @@ export const Actions = {
   REGISTER: 'register',
   REGISTER_DONE: 'registerDone',
   UNREGISTER: 'unregister',
-  UNREGISTERED: 'unregistered',
   TRANSPORT_CLOSED: 'transportClosed',
 } as const;
 
@@ -32,7 +31,7 @@ const softphoneMachine = setup({}).createMachine({
       on: {
         [Actions.REGISTER_DONE]: States.REGISTERED,
         [Actions.TRANSPORT_CLOSED]: States.UNREGISTERED,
-        [Actions.UNREGISTERED]: States.UNREGISTERED,
+        [Actions.UNREGISTER]: States.UNREGISTERED,
       },
     },
     [States.REGISTERED]: {

package/src/state-machine/utils.ts

@@ -16,8 +16,15 @@ export const can = (actor: SoftphoneActorRef | CallActorRef, action: SoftphoneAc
   return actor.getSnapshot().can({ type: action });
 };
 
-export const hasState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates): boolean => {
-  return getState(actor) === state;
+export const hasState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates, innerState?: EstablishedStateTypes): boolean => {
+  const currentState = getState(actor);
+
+  // When using nested states, we'll have an object here
+  if (typeof currentState === 'object') {
+    return innerState ? state in currentState && currentState[state as CallStates] === innerState : state in currentState;
+  }
+
+  return currentState === state;
 };
 
 export const waitUntilState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates, timeout = 5000): Promise<unknown> => {

package/src/voice/call.ts

@@ -550,6 +550,10 @@ class Call extends EventEmitter {
     this._onScreenSharing(localStream as MediaStream, false, desktop);
   }
 
+  onMakeCall() {
+    this._sendAction(Actions.MAKE_CALL);
+  }
+
   onAccepted() {
     this._sendAction(Actions.REMOTLY_ACCEPTED);
     this.emit(EVENT_CALL_REMOTLY_ACCEPTED);
@@ -816,7 +820,9 @@ class Call extends EventEmitter {
   }
 
   private _sendAction(action: ActionTypes | EstablishedActionTypes) {
+    const was = this.state;
     this.callActor.send({ type: action });
+    logger.trace('call - send action', { action, was, state: this.state });
   }
 }
 

package/src/voice/softphone.ts

@@ -93,6 +93,8 @@ export class Softphone extends EventEmitter {
     const server = Wazo.Auth.getHost();
     const session = Wazo.Auth.getSession();
 
+    logger.info('softphone - connect', { server, session: !!session });
+
     if (!server || !session) {
       throw new Error('Please connect to the server using `Wazo.Auth.logIn` or `Wazo.Auth.authenticate` before using Room.connect().');
     }
@@ -116,6 +118,7 @@ export class Softphone extends EventEmitter {
   async disconnect() {
     assertCan(this.softphoneActor, Actions.UNREGISTER);
     if (!this.client) {
+      logger.info('softphone - disconnect, not client to disconnect, bailing');
       return null;
     }
 
@@ -137,7 +140,9 @@ export class Softphone extends EventEmitter {
   ): Promise<void> {
     assertCan(this.softphoneActor, Actions.REGISTER);
 
-    this.softphoneActor.send({ type: Actions.REGISTER });
+    logger.info('softphone - connect with credentials', { server, username: sipLine.username, displayName, options: rawOptions });
+
+    this._sendAction(Actions.REGISTER);
 
     const [host, port = 443] = server.split(':');
     let options = { ...rawOptions };
@@ -207,6 +212,7 @@ export class Softphone extends EventEmitter {
     try {
       sipCall = this.client.call(options.params.To, options.withCamera, options.audioOnly, options.conference, options) as SipCall;
       const call = new Call(sipCall, this);
+      call.onMakeCall();
 
       this.calls.push(call);
       this.emit(EVENT_OUTGOING, call);
@@ -290,7 +296,7 @@ export class Softphone extends EventEmitter {
   }
 
   startHeartbeat() {
-    logger.info('softphone - start heartbeat', { client: !!this.client, hasHeartbeat: this.client.hasHeartbeat() });
+    logger.info('softphone - start heartbeat', { client: !!this.client, hasHeartbeat: this.client?.hasHeartbeat() });
     if (!this.client || this.client.hasHeartbeat()) {
       return;
     }
@@ -455,22 +461,32 @@ export class Softphone extends EventEmitter {
 
     this.client.on(this.client.UNREGISTERED, () => {
       logger.info('softphone - unregistered');
-      this.emit(EVENT_UNREGISTERED);
+      if (!can(this.softphoneActor, Actions.UNREGISTER)) {
+        logger.warn('softphone - cannot unregister', { state: this.state });
+        return;
+      }
+
+      this._sendAction(Actions.UNREGISTER);
 
-      this._sendAction(Actions.UNREGISTERED);
+      this.emit(EVENT_UNREGISTERED);
     });
 
     this.client.on(this.client.ON_DISCONNECTED, () => {
       logger.info('softphone - disconnected');
-      this.emit(EVENT_DISCONNECTED);
+      if (!can(this.softphoneActor, Actions.TRANSPORT_CLOSED)) {
+        logger.warn('softphone - cannot disconnected', { state: this.state });
+        return;
+      }
 
       this._sendAction(Actions.TRANSPORT_CLOSED);
+
+      this.emit(EVENT_DISCONNECTED);
     });
 
     this.client.on(this.client.REGISTERED, () => {
       logger.info('softphone - registered', { state: getState(this.softphoneActor) });
       if (!can(this.softphoneActor, Actions.REGISTER_DONE)) {
-        logger.warn('softphone - registered but not in REGISTERING state', { state: getState(this.softphoneActor) });
+        logger.warn('softphone - registered but not in REGISTERING state', { state: this.state });
         return;
       }
 
@@ -491,10 +507,16 @@ export class Softphone extends EventEmitter {
     });
 
     this.client.on(this.client.CONNECTED, () => {
-      logger.info('softphone - connected');
+      logger.info('softphone - connected', { state: this.state });
       this.stopHeartbeat();
     });
 
+    this.client.on(this.client.REGISTERING, () => {
+      logger.info('softphone - registering', { state: this.state });
+
+      this._sendAction(Actions.REGISTER);
+    });
+
     this.client.on(this.client.DISCONNECTED, () => {
       logger.info('softphone - disconnected');
       this.emit(EVENT_DISCONNECTED);
@@ -528,7 +550,9 @@ export class Softphone extends EventEmitter {
   }
 
   private _sendAction(action: ActionTypes) {
+    const was = this.state;
     this.softphoneActor.send({ type: action });
+    logger.trace('softphone - send action', { action, was, state: this.state });
   }
 
   private _getCall(sipCall: SipCall): Call | undefined {

package/src/web-rtc-client.ts

@@ -39,6 +39,7 @@ const logger = IssueReporter ? IssueReporter.loggerFor('webrtc-client') : consol
 const statsLogger = IssueReporter ? IssueReporter.loggerFor('webrtc-stats') : console;
 // events
 const REGISTERED = 'registered';
+const REGISTERING = 'registering';
 const UNREGISTERED = 'unregistered';
 const REGISTRATION_FAILED = 'registrationFailed';
 const INVITE = 'invite';
@@ -57,7 +58,7 @@ const ON_SCREEN_SHARING_REINVITE = 'onScreenSharingReinvite';
 const ON_NETWORK_STATS = 'onNetworkStats';
 const ON_DISCONNECTED = 'onDisconnected';
 
-export const events = [REGISTERED, UNREGISTERED, REGISTRATION_FAILED, INVITE];
+export const events = [REGISTERED, REGISTERING, UNREGISTERED, REGISTRATION_FAILED, INVITE];
 export const transportEvents = [CONNECTED, DISCONNECTED, TRANSPORT_ERROR, MESSAGE];
 export class CanceledCallError extends Error {}
 
@@ -119,6 +120,8 @@ export default class WebRTCClient extends Emitter {
 
   REGISTERED: string;
 
+  REGISTERING: string;
+
   UNREGISTERED: string;
 
   REGISTRATION_FAILED: string;
@@ -196,6 +199,7 @@ export default class WebRTCClient extends Emitter {
     this.heartbeat.setOnHeartbeatTimeout(this._onHeartbeatTimeout.bind(this));
     // sugar
     this.REGISTERED = REGISTERED;
+    this.REGISTERING = REGISTERING;
     this.UNREGISTERED = UNREGISTERED;
     this.REGISTRATION_FAILED = REGISTRATION_FAILED;
     this.INVITE = INVITE;
@@ -343,6 +347,8 @@ export default class WebRTCClient extends Emitter {
 
     logger.info('sdk webrtc registering...', logInfo);
 
+    this.eventEmitter.emit(REGISTERING);
+
     if (!this.userAgent) {
       logger.info('sdk webrtc recreating User Agent');
       this.userAgent = this.createUserAgent(this.uaConfigOverrides);
@@ -1547,8 +1553,8 @@ export default class WebRTCClient extends Emitter {
     return audio;
   }
 
-  _onTransportError(): void {
-    logger.error('on transport error');
+  _onTransportError(reason?: string): void {
+    logger.warn('on transport error', { reason });
     this.eventEmitter.emit(TRANSPORT_ERROR);
     this.attemptReconnection();
   }
@@ -1610,7 +1616,7 @@ export default class WebRTCClient extends Emitter {
       }
 
       // We can invoke disconnect() with an error that can be catcher by `onDisconnect`, so we have to trigger it here.
-      this._onTransportError();
+      this._onTransportError('heartbeat timeout');
     }
   }