openvidu/openvidu-node-client/src/OpenVidu.ts

/*
 * (C) Copyright 2017-2020 OpenVidu (https://openvidu.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

import axios from 'axios';
import { Connection } from './Connection';
import { Recording } from './Recording';
import { RecordingProperties } from './RecordingProperties';
import { Session } from './Session';
import { SessionProperties } from './SessionProperties';
import { RecordingLayout } from './RecordingLayout';

/**
 * @hidden
 */
interface ObjMap<T> { [s: string]: T; }


export class OpenVidu {

  private Buffer = require('buffer/').Buffer;

  /**
   * @hidden
   */
  public host: string;
  /**
   * @hidden
   */
  public basicAuth: string;

  /**
   * @hidden
   */
  static readonly API_PATH: string = '/openvidu/api';
  /**
   * @hidden
   */
  static readonly API_SESSIONS = OpenVidu.API_PATH + '/sessions';
  /**
   * @hidden
   */
  static readonly API_TOKENS = OpenVidu.API_PATH + '/tokens';
  /**
   * @hidden
   */
  static readonly API_RECORDINGS: string = OpenVidu.API_PATH + '/recordings';
  /**
   * @hidden
   */
  static readonly API_RECORDINGS_START: string = OpenVidu.API_RECORDINGS + '/start';
  /**
   * @hidden
   */
  static readonly API_RECORDINGS_STOP: string = OpenVidu.API_RECORDINGS + '/stop';




  /**
   * Array of active sessions. **This value will remain unchanged since the last time method [[OpenVidu.fetch]]
   * was called**. Exceptions to this rule are:
   *
   * - Calling [[OpenVidu.createSession]] automatically adds the new Session object to the local collection.
   * - Calling [[Session.fetch]] updates that specific Session status
   * - Calling [[Session.close]] automatically removes the Session from the list of active Sessions
   * - Calling [[Session.forceDisconnect]] automatically updates the inner affected connections for that specific Session
   * - Calling [[Session.forceUnpublish]] also automatically updates the inner affected connections for that specific Session
   * - Calling [[OpenVidu.startRecording]] and [[OpenVidu.stopRecording]] automatically updates the recording status of the
   * Session ([[Session.recording]])
   *
   * To get the array of active sessions with their current actual value, you must call [[OpenVidu.fetch]] before consulting
   * property [[activeSessions]]
   */
  activeSessions: Session[] = [];

  /**
   * @param hostname URL where your instance of OpenVidu Server is up an running.
   *                 It must be the full URL (e.g. `https://12.34.56.78:1234/`)
   * 
   * @param secret Secret used on OpenVidu Server initialization
   */
  constructor(private hostname: string, secret: string) {
    this.setHostnameAndPort();
    this.basicAuth = this.getBasicAuth(secret);
  }

  /**
   * Creates an OpenVidu session. The session identifier will be available at property [[Session.sessionId]]
   *
   * @returns A Promise that is resolved to the [[Session]] if success and rejected with an Error object if not.
   */
  public createSession(properties?: SessionProperties): Promise<Session> {
    return new Promise<Session>((resolve, reject) => {
      const session = new Session(this, properties);
      session.getSessionHttp()
        .then(response => {
          this.activeSessions.push(session);
          resolve(session);
        })
        .catch(error => {
          reject(error);
        });
    });
  }

  public startRecording(sessionId: string): Promise<Recording>;
  public startRecording(sessionId: string, name: string): Promise<Recording>;
  public startRecording(sessionId: string, properties: RecordingProperties): Promise<Recording>;

  /**
   * Starts the recording of a [[Session]]
   *
   * @param sessionId The `sessionId` of the [[Session]] you want to start recording
   * @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
   *
   * @returns A Promise that is resolved to the [[Recording]] if it successfully started (the recording can be stopped with guarantees) and rejected with an Error
   * object if not. This Error object has as `message` property with the following values:
   * - `404`: no session exists for the passed `sessionId`
   * - `406`: the session has no connected participants
   * - `422`: when passing [[RecordingProperties]], `resolution` parameter exceeds acceptable values (for both width and height, min 100px and max 1999px) or trying
   * to start a recording with both `hasAudio` and `hasVideo` to false
   * - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
   * - `501`: OpenVidu Server recording module is disabled (`OPENVIDU_RECORDING` property set to `false`)
   */
  public startRecording(sessionId: string, param2?: string | RecordingProperties): Promise<Recording> {
    return new Promise<Recording>((resolve, reject) => {

      let data;

      if (!!param2) {
        if (!(typeof param2 === 'string')) {
          const properties = <RecordingProperties>param2;
          data = {
            session: sessionId,
            name: !!properties.name ? properties.name : '',
            outputMode: properties.outputMode,
            hasAudio: properties.hasAudio != null ? properties.hasAudio : null,
            hasVideo: properties.hasVideo != null ? properties.hasVideo : null,
            shmSize: properties.shmSize,
            mediaNode: properties.mediaNode
          };
          if ((data.hasVideo == null || data.hasVideo) && (data.outputMode == null || data.outputMode.toString() === Recording.OutputMode[Recording.OutputMode.COMPOSED]
            || data.outputMode.toString() === Recording.OutputMode[Recording.OutputMode.COMPOSED_QUICK_START])) {
            data.resolution = properties.resolution;
            data.recordingLayout = !!properties.recordingLayout ? properties.recordingLayout : '';
            if (data.recordingLayout.toString() === RecordingLayout[RecordingLayout.CUSTOM]) {
              data.customLayout = !!properties.customLayout ? properties.customLayout : '';
            }
          }
          data = JSON.stringify(data);
        } else {
          data = JSON.stringify({
            session: sessionId,
            name: param2
          });
        }
      } else {
        data = JSON.stringify({
          session: sessionId,
          name: ''
        });
      }

      axios.post(
        this.host + OpenVidu.API_RECORDINGS_START,
        data,
        {
          headers: {
            'Authorization': this.basicAuth,
            'Content-Type': 'application/json'
          }
        }
      )
        .then(res => {
          if (res.status === 200) {
            // SUCCESS response from openvidu-server (Recording in JSON format). Resolve new Recording
            const r: Recording = new Recording(res.data);
            const activeSession = this.activeSessions.find(s => s.sessionId === r.sessionId);
            if (!!activeSession) {
              activeSession.recording = true;
            } else {
              console.warn("No active session found for sessionId '" + r.sessionId + "'. This instance of OpenVidu Node Client didn't create this session");
            }
            resolve(r);
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }

  /**
   * Stops the recording of a [[Session]]
   *
   * @param recordingId The `id` property of the [[Recording]] you want to stop
   *
   * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
   * - `404`: no recording exists for the passed `recordingId`
   * - `406`: recording has `starting` status. Wait until `started` status before stopping the recording
   */
  public stopRecording(recordingId: string): Promise<Recording> {
    return new Promise<Recording>((resolve, reject) => {

      axios.post(
        this.host + OpenVidu.API_RECORDINGS_STOP + '/' + recordingId,
        undefined,
        {
          headers: {
            'Authorization': this.basicAuth,
            'Content-Type': 'application/x-www-form-urlencoded'
          }
        }
      )
        .then(res => {
          if (res.status === 200) {
            // SUCCESS response from openvidu-server (Recording in JSON format). Resolve new Recording
            const r: Recording = new Recording(res.data);
            const activeSession = this.activeSessions.find(s => s.sessionId === r.sessionId);
            if (!!activeSession) {
              activeSession.recording = false;
            } else {
              console.warn("No active session found for sessionId '" + r.sessionId + "'. This instance of OpenVidu Node Client didn't create this session");
            }
            resolve(r);
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received `error.request` is an instance of XMLHttpRequest
            // in the browser and an instance of http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }

  /**
   * Gets an existing [[Recording]]
   *
   * @param recordingId The `id` property of the [[Recording]] you want to retrieve
   *
   * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
   * - `404`: no recording exists for the passed `recordingId`
   */
  public getRecording(recordingId: string): Promise<Recording> {
    return new Promise<Recording>((resolve, reject) => {

      axios.get(
        this.host + OpenVidu.API_RECORDINGS + '/' + recordingId,
        {
          headers: {
            'Authorization': this.basicAuth,
            'Content-Type': 'application/x-www-form-urlencoded'
          }
        }
      )
        .then(res => {
          if (res.status === 200) {
            // SUCCESS response from openvidu-server (Recording in JSON format). Resolve new Recording
            resolve(new Recording(res.data));
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }

  /**
   * Lists all existing recordings
   *
   * @returns A Promise that is resolved to an array with all existing recordings
   */
  public listRecordings(): Promise<Recording[]> {
    return new Promise<Recording[]>((resolve, reject) => {

      axios.get(
        this.host + OpenVidu.API_RECORDINGS,
        {
          headers: {
            Authorization: this.basicAuth
          }
        }
      )
        .then(res => {
          if (res.status === 200) {
            // SUCCESS response from openvidu-server (JSON arrays of recordings in JSON format). Resolve list of new recordings
            const recordingArray: Recording[] = [];
            const responseItems = res.data.items;
            for (const item of responseItems) {
              recordingArray.push(new Recording(item));
            }
            // Order recordings by time of creation (newest first)
            recordingArray.sort((r1, r2) => (r1.createdAt < r2.createdAt) ? 1 : ((r2.createdAt < r1.createdAt) ? -1 : 0));
            resolve(recordingArray);
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }

  /**
   * Deletes a [[Recording]]. The recording must have status `stopped`, `ready` or `failed`
   *
   * @param recordingId
   *
   * @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as `message` property with the following values:
   * - `404`: no recording exists for the passed `recordingId`
   * - `409`: the recording has `started` status. Stop it before deletion
   */
  public deleteRecording(recordingId: string): Promise<Error> {
    return new Promise<Error>((resolve, reject) => {

      axios.delete(
        this.host + OpenVidu.API_RECORDINGS + '/' + recordingId,
        {
          headers: {
            'Authorization': this.basicAuth,
            'Content-Type': 'application/x-www-form-urlencoded'
          }
        }
      )
        .then(res => {
          if (res.status === 204) {
            // SUCCESS response from openvidu-server. Resolve undefined
            resolve(undefined);
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }

  /**
   * Updates every property of every active Session with the current status they have in OpenVidu Server.
   * After calling this method you can access the updated array of active sessions in [[activeSessions]]
   *
   * @returns A promise resolved to true if any Session status has changed with respect to the server, or to false if not.
   * This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Node Client
   */
  public fetch(): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      axios.get(
        this.host + OpenVidu.API_SESSIONS + '?pendingConnections=true',
        {
          headers: {
            Authorization: this.basicAuth
          }
        }
      )
        .then(res => {
          if (res.status === 200) {

            // Boolean to store if any Session has changed
            let hasChanged = false;

            // 1. Array to store fetched sessionIds and later remove closed ones
            const fetchedSessionIds: string[] = [];
            res.data.content.forEach(jsonSession => {

              const fetchedSession: Session = new Session(this, jsonSession);
              fetchedSessionIds.push(fetchedSession.sessionId);
              let storedSession = this.activeSessions.find(s => s.sessionId === fetchedSession.sessionId);

              if (!!storedSession) {

                // 2. Update existing Session
                const changed: boolean = !storedSession.equalTo(fetchedSession);
                storedSession.resetWithJson(jsonSession);
                console.log("Available session '" + storedSession.sessionId + "' info fetched. Any change: " + changed);
                hasChanged = hasChanged || changed;

              } else {

                // 3. Add new Session
                this.activeSessions.push(fetchedSession);
                console.log("New session '" + fetchedSession.sessionId + "' info fetched");
                hasChanged = true;
              }
            });

            // 4. Remove closed sessions from local collection
            for (var i = this.activeSessions.length - 1; i >= 0; --i) {
              let sessionId = this.activeSessions[i].sessionId;
              if (!fetchedSessionIds.includes(sessionId)) {
                console.log("Removing closed session '" + sessionId + "'");
                hasChanged = true;
                this.activeSessions.splice(i, 1);
              }
            }

            console.log('Active sessions info fetched: ', fetchedSessionIds);
            resolve(hasChanged);
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
            reject(error);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
            reject(new Error(error.message));
          }
        });
    });
  }

  /**
   * @hidden
   * @returns A map paring every existing sessionId with true or false depending on whether it has changed or not
   */
  fetchWebRtc(): Promise<any> {

    // tslint:disable:no-string-literal
    const addWebRtcStatsToConnections = (connection: Connection, connectionsExtendedInfo: any) => {
      const connectionExtended = connectionsExtendedInfo.find(c => c.connectionId === connection.connectionId);
      if (!!connectionExtended) {
        connection.publishers.forEach(pub => {
          const publisherExtended = connectionExtended.publishers.find(p => p.streamId === pub.streamId);
          pub['webRtc'] = {
            kms: {
              events: publisherExtended.events,
              localCandidate: publisherExtended.localCandidate,
              remoteCandidate: publisherExtended.remoteCandidate,
              receivedCandidates: publisherExtended.receivedCandidates,
              gatheredCandidates: publisherExtended.gatheredCandidates,
              webrtcEndpointName: publisherExtended.webrtcEndpointName,
              localSdp: publisherExtended.localSdp,
              remoteSdp: publisherExtended.remoteSdp
            }
          };
          pub['localCandidatePair'] = parseRemoteCandidatePair(pub['webRtc'].kms.remoteCandidate);
          if (!!publisherExtended.serverStats) {
            pub['webRtc'].kms.serverStats = publisherExtended.serverStats;
          }
        });
        const subscriberArray = [];
        connection.subscribers.forEach(sub => {
          const subscriberExtended = connectionExtended.subscribers.find(s => s.streamId === sub);
          const subAux = {};
          // Standard properties
          subAux['streamId'] = sub;
          subAux['publisher'] = subscriberExtended.publisher;
          // WebRtc properties
          subAux['createdAt'] = subscriberExtended.createdAt;
          subAux['webRtc'] = {
            kms: {
              events: subscriberExtended.events,
              localCandidate: subscriberExtended.localCandidate,
              remoteCandidate: subscriberExtended.remoteCandidate,
              receivedCandidates: subscriberExtended.receivedCandidates,
              gatheredCandidates: subscriberExtended.gatheredCandidates,
              webrtcEndpointName: subscriberExtended.webrtcEndpointName,
              localSdp: subscriberExtended.localSdp,
              remoteSdp: subscriberExtended.remoteSdp
            }
          };
          subAux['localCandidatePair'] = parseRemoteCandidatePair(subAux['webRtc'].kms.remoteCandidate);
          if (!!subscriberExtended.serverStats) {
            subAux['webRtc'].kms.serverStats = subscriberExtended.serverStats;
          }
          subscriberArray.push(subAux);
        });
        connection.subscribers = subscriberArray;
      }
    };

    const parseRemoteCandidatePair = (candidateStr: string) => {
      if (!candidateStr) {
        return 'ERROR: No remote candidate available';
      }
      const array = candidateStr.split(/\s+/);
      return {
        portNumber: array[5],
        ipAddress: array[4],
        transport: array[2].toLowerCase(),
        candidateType: array[7],
        priority: array[3],
        raw: candidateStr
      };
    };

    return new Promise<{ changes: boolean, sessionChanges: ObjMap<boolean> }>((resolve, reject) => {
      axios.get(
        this.host + OpenVidu.API_SESSIONS + '?webRtcStats=true',
        {
          headers: {
            Authorization: this.basicAuth
          }
        }
      )
        .then(res => {
          if (res.status === 200) {

            // Global changes
            let globalChanges = false;
            // Collection of sessionIds telling whether each one of them has changed or not
            const sessionChanges: ObjMap<boolean> = {};

            // 1. Array to store fetched sessionIds and later remove closed ones
            const fetchedSessionIds: string[] = [];
            res.data.content.forEach(jsonSession => {

              const fetchedSession: Session = new Session(this, jsonSession);
              fetchedSession.connections.forEach(connection => {
                addWebRtcStatsToConnections(connection, jsonSession.connections.content);
              });
              fetchedSessionIds.push(fetchedSession.sessionId);
              let storedSession = this.activeSessions.find(s => s.sessionId === fetchedSession.sessionId);

              if (!!storedSession) {

                // 2. Update existing Session
                let changed = !storedSession.equalTo(fetchedSession);
                if (!changed) { // Check if server webrtc information has changed in any Publisher object (Session.equalTo does not check Publisher.webRtc auxiliary object)
                  fetchedSession.connections.forEach((connection, index1) => {
                    for (let index2 = 0; (index2 < connection['publishers'].length && !changed); index2++) {
                      changed = changed || JSON.stringify(connection['publishers'][index2]['webRtc']) !== JSON.stringify(storedSession.connections[index1]['publishers'][index2]['webRtc']);
                    }
                  });
                }

                storedSession.resetWithJson(jsonSession);
                storedSession.connections.forEach(connection => {
                  addWebRtcStatsToConnections(connection, jsonSession.connections.content);
                });
                console.log("Available session '" + storedSession.sessionId + "' info fetched. Any change: " + changed);
                sessionChanges[storedSession.sessionId] = changed;
                globalChanges = globalChanges || changed;

              } else {

                // 3. Add new Session
                this.activeSessions.push(fetchedSession);
                console.log("New session '" + fetchedSession.sessionId + "' info fetched");
                sessionChanges[fetchedSession.sessionId] = true;
                globalChanges = true;

              }
            });

            // 4. Remove closed sessions from local collection
            for (var i = this.activeSessions.length - 1; i >= 0; --i) {
              let sessionId = this.activeSessions[i].sessionId;
              if (!fetchedSessionIds.includes(sessionId)) {
                console.log("Removing closed session '" + sessionId + "'");
                sessionChanges[sessionId] = true;
                globalChanges = true;
                this.activeSessions.splice(i, 1);
              }
            }

            console.log('Active sessions info fetched: ', fetchedSessionIds);
            resolve({ changes: globalChanges, sessionChanges });
          } else {
            // ERROR response from openvidu-server. Resolve HTTP status
            reject(new Error(res.status.toString()));
          }
        }).catch(error => {
          if (error.response) {
            // The request was made and the server responded with a status code (not 2xx)
            reject(new Error(error.response.status.toString()));
          } else if (error.request) {
            // The request was made but no response was received
            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
            // http.ClientRequest in node.js
            console.error(error.request);
          } else {
            // Something happened in setting up the request that triggered an Error
            console.error('Error', error.message);
          }
        });
    });
  }
  // tslint:enable:no-string-literal

  private getBasicAuth(secret: string): string {
    return 'Basic ' + this.Buffer('OPENVIDUAPP:' + secret).toString('base64');
  }

  private setHostnameAndPort(): void {
    let url: URL;
    try {
      url = new URL(this.hostname);
    } catch (error) {
      console.error('URL format incorrect', error);
      throw new Error('URL format incorrect: ' + error);
    }
    this.host = url.protocol + '//' + url.host;
  }

}