@wazo/sdk 0.43.6 → 1.0.0-alpha.0

package/esm/voice/softphone.js

@@ -0,0 +1,347 @@
+/* eslint-disable no-underscore-dangle */
+import { EventEmitter } from 'events';
+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';
+export const EVENT_INCOMING = 'incoming';
+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_ON_MESSAGE = 'message';
+export const EVENT_ON_CHAT = 'phone/ON_CHAT';
+export const EVENT_ON_SIGNAL = 'phone/ON_SIGNAL';
+export const MESSAGE_TYPE_CHAT = 'message/TYPE_CHAT';
+export const MESSAGE_TYPE_SIGNAL = 'message/TYPE_SIGNAL';
+const logger = IssueReporter.loggerFor('softphone');
+export class Softphone extends EventEmitter {
+    audioOutputDeviceId;
+    audioRingDeviceId;
+    audioOutputVolume;
+    audioRingVolume;
+    eventEmitter;
+    calls;
+    client;
+    session;
+    sipLine;
+    softphoneActor;
+    options;
+    shouldSendReinvite;
+    constructor() {
+        super();
+        this.calls = [];
+        this.softphoneActor = createActor(softphoneStateMachine);
+        this.softphoneActor.start();
+    }
+    connect(options = {}) {
+        this.calls = [];
+        this.options = options;
+        this.audioOutputVolume = 1;
+        this.audioRingVolume = 1;
+        const server = Wazo.Auth.getHost();
+        const session = Wazo.Auth.getSession();
+        if (!server || !session) {
+            throw new Error('Please connect to the server using `Wazo.Auth.logIn` or `Wazo.Auth.authenticate` before using Room.connect().');
+        }
+        this.session = session;
+        this.sipLine = this.getPrimaryWebRtcLine();
+        if (!this.sipLine) {
+            throw new Error('Sorry, no sip lines found for this user');
+        }
+        this.options.userUuid = session.uuid || '';
+        return this.connectWithCredentials(server, this.sipLine, session.displayName(), options);
+    }
+    async disconnect() {
+        assertCan(this.softphoneActor, Actions.UNREGISTER);
+        if (!this.client) {
+            return null;
+        }
+        // Terminate all calls
+        await Promise.all(this.calls.map(call => call.hangup()));
+        return this.client.unregister();
+    }
+    getPrimaryWebRtcLine() {
+        return this.session?.primaryWebRtcLine() || null;
+    }
+    async connectWithCredentials(server, sipLine, displayName, rawOptions = {}) {
+        assertCan(this.softphoneActor, Actions.REGISTER);
+        this.softphoneActor.send({ type: Actions.REGISTER });
+        const [host, port = 443] = server.split(':');
+        let options = { ...rawOptions };
+        options.media = options.media || {
+            audio: true,
+            video: false,
+        };
+        options.uaConfigOverrides = options.uaConfigOverrides || {};
+        if (IssueReporter.enabled) {
+            options = configureLogger(options);
+        }
+        this.client = new WazoWebRTCClient({
+            host,
+            port: typeof port === 'string' ? parseInt(port, 10) : port,
+            displayName,
+            authorizationUser: sipLine.username,
+            password: sipLine.secret,
+            uri: `${sipLine.username}@${server}`,
+            ...options,
+        }, undefined, options.uaConfigOverrides);
+        this._bindEvents();
+        return this.client.register().catch(error => {
+            // Avoid exception on `t.server.scheme` in sip transport when losing the webrtc socket connection
+            logger.error('softphone - register error', { message: error.message, stack: error.stack });
+            this._sendAction(Actions.UNREGISTER);
+        });
+    }
+    reconnect() {
+        logger.info('softphone - reconnect', { client: !!this.client });
+        if (!this.client) {
+            return;
+        }
+        this.client.attemptReconnection();
+    }
+    async call(options) {
+        logger.info('softphone - call', options);
+        if (!options.params.To) {
+            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) {
+            logger.info('softphone - calling when registering, waiting for Softphone to be registered ...');
+            await waitUntilState(this.softphoneActor, States.REGISTERED);
+        }
+        // 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);
+            return call;
+        }
+        catch (error) {
+            logger.warn('softphone - call, error', { message: error.message, stack: error.stack });
+            return Promise.resolve(null);
+        }
+    }
+    removeCall(callToRemove) {
+        this.calls = this.calls.filter((call) => call.id !== callToRemove.id);
+    }
+    holdAllCalls(exceptCall = null) {
+        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() });
+        if (!this.client || this.client.hasHeartbeat()) {
+            return;
+        }
+        this.client.startHeartbeat();
+    }
+    stopHeartbeat() {
+        logger.info('softphone - stop heartbeat', { client: !!this.client });
+        if (!this.client) {
+            return;
+        }
+        this.client.stopHeartbeat();
+    }
+    setMediaConstraints(media) {
+        this.client.setMediaConstraints(media);
+    }
+    changeAudioOutputDevice(id) {
+        logger.info('softphone - change audio device', { deviceId: id });
+        this.audioOutputDeviceId = id;
+        return this.client.changeAudioOutputDevice(id);
+    }
+    changeAudioInputDevice(id, force) {
+        logger.info('softphone - changeAudio input device', { deviceId: id });
+        const currentCall = this.getCurrentCall();
+        return this.client.changeAudioInputDevice(id, currentCall?.sipCall, force);
+    }
+    changeVideoInputDevice(id) {
+        logger.info('softphone - change video input device', { deviceId: id });
+        const currentCall = this.getCurrentCall();
+        return this.client.changeVideoInputDevice(id, currentCall?.sipCall);
+    }
+    changeRingDevice(id) {
+        logger.info('softphone - changing ring device', { id });
+        this.audioRingDeviceId = id;
+    }
+    hasSfu() {
+        return this.sipLine?.hasVideoConference() || false;
+    }
+    // volume is a value between 0 and 1
+    changeAudioVolume(volume) {
+        logger.info('softphone - changing audio volume', { volume });
+        this.audioOutputVolume = volume;
+        this.client.changeAudioOutputVolume(volume);
+    }
+    // volume is a value between 0 and 1
+    changeRingVolume(volume) {
+        logger.info('softphone - changing ring volume', { volume });
+        this.audioRingVolume = volume;
+    }
+    getCalls() {
+        return this.calls;
+    }
+    getCurrentCall() {
+        return this.calls.find(call => call.isEstablished());
+    }
+    getState() {
+        return this.softphoneActor.getSnapshot().value;
+    }
+    getUserAgent() {
+        return this.client?.config?.userAgentString || 'softphone';
+    }
+    _bindEvents() {
+        this.client.on(this.client.INVITE, (sipSession) => {
+            const call = new Call(sipSession, this);
+            call._sendAction(CallActions.INCOMING_CALL);
+            this.calls.push(call);
+            this.eventEmitter.emit(EVENT_INCOMING, call);
+        });
+        this.client.on(this.client.ON_REINVITE, (sipCall, request, updatedCalleeName, updatedNumber, hadRemoteVideo) => {
+            logger.info('softphone - on reinvite', {
+                callId: sipCall.id,
+                inviteId: request.callId,
+                updatedCalleeName,
+                updatedNumber,
+                hadRemoteVideo,
+            });
+            this._onCallEvent(sipCall, 'onReinvite', request, updatedCalleeName, updatedNumber, hadRemoteVideo);
+        });
+        this.client.on(this.client.ACCEPTED, async (sipCall) => {
+            this._onCallEvent(sipCall, 'onAccepted');
+            if (this.audioOutputDeviceId) {
+                await this.client.changeAudioOutputDevice(this.audioOutputDeviceId);
+            }
+        });
+        this.client.on(this.client.ON_ERROR, (e, sipCall) => {
+            this._onCallEvent(sipCall, 'onError', e);
+        });
+        this.client.on(this.client.REJECTED, (sipCall) => {
+            this._onCallEvent(sipCall, 'onRejected');
+        });
+        this.client.on(this.client.ON_PROGRESS, (sipCall) => {
+            this._onCallEvent(sipCall, 'onProgress');
+        });
+        this.client.on(this.client.ON_EARLY_MEDIA, (sipCall) => {
+            this._onCallEvent(sipCall, 'onEarlyMedia');
+        });
+        this.client.on(this.client.ON_TRACK, (sipCall, event) => {
+            this._onCallEvent(sipCall, 'onTrack', event);
+        });
+        this.client.on(this.client.ON_NETWORK_STATS, (sipCall, stats, previousStats) => {
+            this._onCallEvent(sipCall, 'onNetworkStats', stats, previousStats);
+        });
+        // Used when upgrading directly in screenshare mode
+        this.client.on(this.client.ON_SCREEN_SHARING_REINVITE, (sipCall, response, desktop) => {
+            this._onCallEvent(sipCall, 'onScreenshareReinvite', response, desktop);
+        });
+        this.client.on(this.client.UNREGISTERED, () => {
+            logger.info('softphone - unregistered');
+            this.eventEmitter.emit(EVENT_UNREGISTERED);
+            this._sendAction(Actions.UNREGISTERED);
+        });
+        this.client.on(this.client.ON_DISCONNECTED, () => {
+            logger.info('softphone - disconnected');
+            this.eventEmitter.emit(EVENT_DISCONNECTED);
+            this._sendAction(Actions.TRANSPORT_CLOSED);
+        });
+        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) });
+                return;
+            }
+            this.stopHeartbeat();
+            this._sendAction(Actions.REGISTER_DONE);
+            this.eventEmitter.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) {
+                this.shouldSendReinvite = false;
+                // Send reinvite for all active calls
+                this.calls.filter(call => call.isEstablished())
+                    .forEach(call => { call.sendReinvite({ conference: call.isConference(), iceRestart: true }); });
+            }
+        });
+        this.client.on(this.client.CONNECTED, () => {
+            logger.info('softphone - connected');
+            this.stopHeartbeat();
+        });
+        this.client.on(this.client.DISCONNECTED, () => {
+            logger.info('softphone - disconnected');
+            this.eventEmitter.emit(EVENT_DISCONNECTED);
+            // Do not trigger heartbeat if already running
+            if (!this.client.hasHeartbeat()) {
+                this.startHeartbeat();
+            }
+            // Tell to send reinvite when reconnecting
+            this.shouldSendReinvite = this.calls.length > 0;
+        });
+        this.client.on('onVideoInputChange', stream => {
+            this.eventEmitter.emit(EVENT_VIDEO_INPUT_CHANGE, stream);
+        });
+        this.client.on(this.client.MESSAGE, (message) => {
+            this._onMessage(message);
+            this.eventEmitter.emit(EVENT_ON_MESSAGE, message);
+        });
+        this.client.setOnHeartbeatTimeout(() => {
+            this.eventEmitter.emit(EVENT_HEARTBEAT_TIMEOUT);
+        });
+        this.client.setOnHeartbeatCallback(() => {
+            this.eventEmitter.emit(EVENT_HEARTBEAT);
+        });
+    }
+    _sendAction(action) {
+        this.softphoneActor.send({ type: action });
+    }
+    _getCall(sipCall) {
+        return this.calls.find(call => call.id === sipCall.id);
+    }
+    _onCallEvent(sipCall, eventName, ...args) {
+        logger.warn('softphone - received call event', { eventName, sipId: sipCall.id });
+        const call = this._getCall(sipCall);
+        if (!call) {
+            logger.warn('softphone - no call found to send the event', { eventName, sipId: sipCall.id });
+            return;
+        }
+        // @ts-ignore
+        call[eventName](...args);
+    }
+    _onMessage(message) {
+        if (!message || message.method !== 'MESSAGE') {
+            return;
+        }
+        let body;
+        try {
+            body = JSON.parse(message.body || '');
+        }
+        catch (e) {
+            return;
+        }
+        const { type, content, } = body;
+        switch (type) {
+            case MESSAGE_TYPE_CHAT:
+                this.eventEmitter.emit(EVENT_ON_CHAT, content);
+                break;
+            case MESSAGE_TYPE_SIGNAL:
+                {
+                    this.eventEmitter.emit(EVENT_ON_SIGNAL, content);
+                    break;
+                }
+            default:
+        }
+    }
+}
+export default new Softphone();