@wazo/sdk 1.0.0-alpha.0 → 1.0.0-alpha.10

package/esm/voice/softphone.js

@@ -4,19 +4,24 @@ import { createActor } from 'xstate';
 import InvalidState from '../domain/InvalidState';
 import Wazo from '..';
 import softphoneStateMachine, { Actions, States } from '../state-machine/softphone-state-machine';
-import { Actions as CallActions } from '../state-machine/call-state-machine';
 import WazoWebRTCClient from '../web-rtc-client';
 import IssueReporter from '../service/IssueReporter';
 import configureLogger from '../utils/sip-logger';
 import Call from './call';
 import { assertCan, can, getState, waitUntilState } from '../state-machine/utils';
+import { getSipCallId } from '../utils/sdp';
 export const EVENT_INCOMING = 'incoming';
+export const EVENT_OUTGOING = 'outgoing';
 export const EVENT_HEARTBEAT = 'heartbeat';
 export const EVENT_HEARTBEAT_TIMEOUT = 'heartbeatTimeout';
 export const EVENT_REGISTERED = 'registered';
 export const EVENT_UNREGISTERED = 'unregistered';
 export const EVENT_DISCONNECTED = 'disconnected';
 export const EVENT_VIDEO_INPUT_CHANGE = 'videoInputChange';
+export const EVENT_TERMINATE_SOUND = 'terminateSound';
+export const EVENT_PLAY_HANGUP_SOUND = 'playHangupSound';
+export const EVENT_PLAY_RING_SOUND = 'playRingSound';
+export const EVENT_PLAY_INBOUND_CALL_SOUND = 'playInboundCallSound';
 export const EVENT_ON_MESSAGE = 'message';
 export const EVENT_ON_CHAT = 'phone/ON_CHAT';
 export const EVENT_ON_SIGNAL = 'phone/ON_SIGNAL';
@@ -28,7 +33,6 @@ export class Softphone extends EventEmitter {
     audioRingDeviceId;
     audioOutputVolume;
     audioRingVolume;
-    eventEmitter;
     calls;
     client;
     session;
@@ -36,6 +40,7 @@ export class Softphone extends EventEmitter {
     softphoneActor;
     options;
     shouldSendReinvite;
+    ringingEnabled = true;
     constructor() {
         super();
         this.calls = [];
@@ -49,6 +54,7 @@ export class Softphone extends EventEmitter {
         this.audioRingVolume = 1;
         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().');
         }
@@ -60,13 +66,17 @@ export class Softphone extends EventEmitter {
         this.options.userUuid = session.uuid || '';
         return this.connectWithCredentials(server, this.sipLine, session.displayName(), options);
     }
+    async hangupAllCalls() {
+        return Promise.all(this.calls.map(call => call.hangup()));
+    }
     async disconnect() {
         assertCan(this.softphoneActor, Actions.UNREGISTER);
         if (!this.client) {
+            logger.info('softphone - disconnect, not client to disconnect, bailing');
             return null;
         }
         // Terminate all calls
-        await Promise.all(this.calls.map(call => call.hangup()));
+        await this.hangupAllCalls();
         return this.client.unregister();
     }
     getPrimaryWebRtcLine() {
@@ -74,7 +84,8 @@ export class Softphone extends EventEmitter {
     }
     async connectWithCredentials(server, sipLine, displayName, rawOptions = {}) {
         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 };
         options.media = options.media || {
@@ -114,19 +125,22 @@ export class Softphone extends EventEmitter {
             logger.warn('softphone -  calling with empty number, bailing.');
             return Promise.resolve(null);
         }
-        if (this.getState() !== States.UNREGISTERED) {
-            throw new InvalidState(`Invalid state ${States.UNREGISTERED}`, States.UNREGISTERED);
-        }
-        if (this.getState() !== States.REGISTERING) {
+        if (this.state === States.REGISTERING) {
             logger.info('softphone - calling when registering, waiting for Softphone to be registered ...');
             await waitUntilState(this.softphoneActor, States.REGISTERED);
         }
+        if (this.state !== States.REGISTERED) {
+            throw new InvalidState(`Invalid state ${States.UNREGISTERED}`, States.UNREGISTERED);
+        }
         // Hold other calls
         this.holdAllCalls();
         let sipCall;
         try {
             sipCall = this.client.call(options.params.To, options.withCamera, options.audioOnly, options.conference, options);
             const call = new Call(sipCall, this);
+            call.onMakeCall();
+            this.calls.push(call);
+            this.emit(EVENT_OUTGOING, call);
             return call;
         }
         catch (error) {
@@ -137,11 +151,64 @@ export class Softphone extends EventEmitter {
     removeCall(callToRemove) {
         this.calls = this.calls.filter((call) => call.id !== callToRemove.id);
     }
+    onCallTerminated(call) {
+        logger.info('softphone - on call terminated', { id: call.id });
+        const currentCall = this.getCurrentCall();
+        const isCurrentCall = currentCall?.id === call.id;
+        const isRinging = call.isRinging();
+        const isCurrentIncomingCall = isCurrentCall && isRinging;
+        const incomingCalls = this.getIncomingCalls();
+        const nbIncomingCalls = incomingCalls.length;
+        // Send an event to terminate ringing sound
+        if (isCurrentIncomingCall) {
+            setTimeout(() => {
+                // Avoid race condition when the other is calling and hanging up immediately
+                this.emit(EVENT_TERMINATE_SOUND, call, 'call terminated');
+            }, 5);
+        }
+        // If the terminated call was an incoming call, we have to re-trigger if it's was the first incoming call
+        // Otherwise, we have to re-trigger an incoming call event if another call is incoming
+        const shouldRetrigger = isCurrentCall ? nbIncomingCalls : isCurrentIncomingCall;
+        // Re-trigger incoming call event for remaining incoming calls
+        logger.info('Softphone - check to re-trigger incoming call', { shouldRetrigger, nbIncomingCalls });
+        if (shouldRetrigger && nbIncomingCalls > 1) {
+            const nextCall = incomingCalls.find(c => c.id !== call.id);
+            // Avoid race condition
+            setTimeout(() => {
+                if (this.ringingEnabled) {
+                    if (currentCall) {
+                        this.emit(EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, nextCall);
+                    }
+                    else {
+                        this.emit(EVENT_PLAY_INBOUND_CALL_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, nextCall);
+                    }
+                }
+                this.emit(EVENT_INCOMING, nextCall);
+            }, 100);
+        }
+        // @ts-ignore: does not exist
+        if (!call.sipCall.isCanceled) {
+            setTimeout(() => {
+                this.emit(EVENT_PLAY_HANGUP_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, call);
+            }, 10);
+        }
+        this.client.onCallEnded(call.sipCall);
+        this.removeCall(call);
+    }
+    enableRinging() {
+        logger.info('softphone - enable ringing');
+        this.ringingEnabled = true;
+    }
+    disableRinging() {
+        logger.info('softphone - disable ringing');
+        this.ringingEnabled = false;
+    }
     holdAllCalls(exceptCall = null) {
-        this.calls.filter(call => !call.isHeld() && call.id === exceptCall?.id).forEach(call => call.hold());
+        logger.info('softphone - hold all calls', { exceptId: exceptCall?.id, ids: this.calls.map(call => call.id) });
+        this.calls.filter(call => !call.isHeld() && call.id !== exceptCall?.id).forEach(call => call.hold());
     }
     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;
         }
@@ -190,28 +257,52 @@ export class Softphone extends EventEmitter {
         logger.info('softphone - changing ring volume', { volume });
         this.audioRingVolume = volume;
     }
-    getCalls() {
-        return this.calls;
-    }
     getCurrentCall() {
-        return this.calls.find(call => call.isEstablished());
+        return this.getActiveCalls()[0];
+    }
+    getActiveCalls() {
+        return this.calls.filter(call => call.isEstablished());
     }
-    getState() {
-        return this.softphoneActor.getSnapshot().value;
+    getIncomingCalls() {
+        return this.calls.filter(call => call.isRinging());
+    }
+    get state() {
+        return getState(this.softphoneActor);
+    }
+    get user() {
+        return this.client?.userAgent?.contact?.uri?.user;
     }
     getUserAgent() {
         return this.client?.config?.userAgentString || 'softphone';
     }
+    isRegistering() {
+        return this.state === States.REGISTERING;
+    }
+    isRegistered() {
+        return this.state === States.REGISTERED;
+    }
+    isUnRegistered() {
+        return this.state === States.UNREGISTERED;
+    }
     _bindEvents() {
         this.client.on(this.client.INVITE, (sipSession) => {
             const call = new Call(sipSession, this);
-            call._sendAction(CallActions.INCOMING_CALL);
+            logger.info('softphone - on invite', { callId: call.id, number: call.number });
+            call.onCallIncoming();
             this.calls.push(call);
-            this.eventEmitter.emit(EVENT_INCOMING, call);
+            this.emit(EVENT_INCOMING, call);
+            if (!this.getCurrentCall()) {
+                if (this.ringingEnabled) {
+                    this.emit(EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, call);
+                }
+            }
+            else {
+                this.emit(EVENT_PLAY_INBOUND_CALL_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, call);
+            }
         });
         this.client.on(this.client.ON_REINVITE, (sipCall, request, updatedCalleeName, updatedNumber, hadRemoteVideo) => {
             logger.info('softphone - on reinvite', {
-                callId: sipCall.id,
+                callId: getSipCallId(sipCall),
                 inviteId: request.callId,
                 updatedCalleeName,
                 updatedNumber,
@@ -220,6 +311,8 @@ export class Softphone extends EventEmitter {
             this._onCallEvent(sipCall, 'onReinvite', request, updatedCalleeName, updatedNumber, hadRemoteVideo);
         });
         this.client.on(this.client.ACCEPTED, async (sipCall) => {
+            const call = this._getCall(sipCall);
+            this.emit(EVENT_TERMINATE_SOUND, call, 'call accepted');
             this._onCallEvent(sipCall, 'onAccepted');
             if (this.audioOutputDeviceId) {
                 await this.client.changeAudioOutputDevice(this.audioOutputDeviceId);
@@ -249,23 +342,31 @@ export class Softphone extends EventEmitter {
         });
         this.client.on(this.client.UNREGISTERED, () => {
             logger.info('softphone - unregistered');
-            this.eventEmitter.emit(EVENT_UNREGISTERED);
-            this._sendAction(Actions.UNREGISTERED);
+            if (!can(this.softphoneActor, Actions.UNREGISTER)) {
+                logger.warn('softphone - cannot unregister', { state: this.state });
+                return;
+            }
+            this._sendAction(Actions.UNREGISTER);
+            this.emit(EVENT_UNREGISTERED);
         });
         this.client.on(this.client.ON_DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.eventEmitter.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;
             }
             this.stopHeartbeat();
             this._sendAction(Actions.REGISTER_DONE);
-            this.eventEmitter.emit(EVENT_REGISTERED);
+            this.emit(EVENT_REGISTERED);
             // If the phone registered with a current callSession (eg: when switching network):
             // send a reinvite to renegociate ICE with new IP
             if (this.shouldSendReinvite) {
@@ -276,12 +377,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.eventEmitter.emit(EVENT_DISCONNECTED);
+            this.emit(EVENT_DISCONNECTED);
             // Do not trigger heartbeat if already running
             if (!this.client.hasHeartbeat()) {
                 this.startHeartbeat();
@@ -290,30 +395,35 @@ export class Softphone extends EventEmitter {
             this.shouldSendReinvite = this.calls.length > 0;
         });
         this.client.on('onVideoInputChange', stream => {
-            this.eventEmitter.emit(EVENT_VIDEO_INPUT_CHANGE, stream);
+            this.emit(EVENT_VIDEO_INPUT_CHANGE, stream);
         });
         this.client.on(this.client.MESSAGE, (message) => {
             this._onMessage(message);
-            this.eventEmitter.emit(EVENT_ON_MESSAGE, message);
+            this.emit(EVENT_ON_MESSAGE, message);
         });
         this.client.setOnHeartbeatTimeout(() => {
-            this.eventEmitter.emit(EVENT_HEARTBEAT_TIMEOUT);
+            this.emit(EVENT_HEARTBEAT_TIMEOUT);
         });
         this.client.setOnHeartbeatCallback(() => {
-            this.eventEmitter.emit(EVENT_HEARTBEAT);
+            this.emit(EVENT_HEARTBEAT);
         });
     }
     _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 === sipCall.id);
+        return this.calls.find(call => call.id === getSipCallId(sipCall));
+    }
+    _getCallIds() {
+        return this.calls.map(call => call.id);
     }
     _onCallEvent(sipCall, eventName, ...args) {
-        logger.warn('softphone - received call event', { eventName, sipId: sipCall.id });
+        logger.info('softphone - received call event', { eventName, sipId: getSipCallId(sipCall) });
         const call = this._getCall(sipCall);
         if (!call) {
-            logger.warn('softphone - no call found to send the event', { eventName, sipId: sipCall.id });
+            logger.warn('softphone - no call found to send the event', { eventName, sipId: getSipCallId(sipCall), ids: this._getCallIds() });
             return;
         }
         // @ts-ignore
@@ -333,11 +443,11 @@ export class Softphone extends EventEmitter {
         const { type, content, } = body;
         switch (type) {
             case MESSAGE_TYPE_CHAT:
-                this.eventEmitter.emit(EVENT_ON_CHAT, content);
+                this.emit(EVENT_ON_CHAT, content);
                 break;
             case MESSAGE_TYPE_SIGNAL:
                 {
-                    this.eventEmitter.emit(EVENT_ON_SIGNAL, content);
+                    this.emit(EVENT_ON_SIGNAL, content);
                     break;
                 }
             default: