Merge pull request #89 from millicast/develop

Release v0.1.9

Author: R-Delfino95

packages/millicast-sdk/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@millicast/sdk",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "SDK for building a realtime broadcaster using the Millicast platform.",
   "keywords": [
     "sdk",

packages/millicast-sdk/package.json

@@ -7,6 +7,7 @@ const streamTypes = {
   RTMP: 'Rtmp'
 }
 
+let liveWebsocketDomain = ''
 export const defaultApiEndpoint = 'https://director.millicast.com'
 let apiEndpoint = defaultApiEndpoint
 
@@ -59,6 +60,26 @@ export default class Director {
     return apiEndpoint
   }
 
+  /**
+   * Set Websocket Live domain from Director API response.
+   * If it is set to empty, it will not parse the response.
+   *
+   * @param {String} domain - New Websocket Live domain
+  */
+  static setLiveDomain (domain) {
+    liveWebsocketDomain = domain.replace(/\/$/, '')
+  }
+
+  /**
+   * Get current Websocket Live domain.
+   *
+   * By default is empty which corresponds to not parse the Director response.
+   * @returns {String} Websocket Live domain
+  */
+  static getLiveDomain () {
+    return liveWebsocketDomain
+  }
+
   /**
    * Get publisher connection data.
    * @param {DirectorPublisherOptions | String} options - Millicast options or *Deprecated Millicast Publishing Token.*
@@ -96,7 +117,8 @@ export default class Director {
     const headers = { Authorization: `Bearer ${optionsParsed.token}` }
     const url = `${this.getEndpoint()}/api/director/publish`
     try {
-      const { data } = await axios.post(url, payload, { headers })
+      let { data } = await axios.post(url, payload, { headers })
+      data = parseIncomingDirectorResponse(data)
       logger.debug('Getting publisher response: ', data)
       return data.data
     } catch (e) {
@@ -149,7 +171,8 @@ export default class Director {
     }
     const url = `${this.getEndpoint()}/api/director/subscribe`
     try {
-      const { data } = await axios.post(url, payload, { headers })
+      let { data } = await axios.post(url, payload, { headers })
+      data = parseIncomingDirectorResponse(data)
       logger.debug('Getting subscriber response: ', data)
       return data.data
     } catch (e) {
@@ -182,3 +205,12 @@ const getSubscriberOptions = (options, legacyStreamAccountId, legacySubscriberTo
   }
   return parsedOptions
 }
+
+const parseIncomingDirectorResponse = (directorResponse) => {
+  if (Director.getLiveDomain()) {
+    const domainRegex = /(?<=\/\/)(.*?)(?=\/)/
+    const urlsParsed = directorResponse.data.urls.map(url => url.replace(domainRegex, Director.getLiveDomain()))
+    directorResponse.data.urls = urlsParsed
+  }
+  return directorResponse
+}

packages/millicast-sdk/src/Director.js

@@ -15,6 +15,9 @@ export const webRTCEvents = {
   connectionStateChange: 'connectionStateChange'
 }
 
+export const defaultTurnServerLocation = 'https://turn.millicast.com/webrtc/_turn'
+let turnServerLocation = defaultTurnServerLocation
+
 const localSDPOptions = {
   stereo: false,
   mediaStream: null,
@@ -40,6 +43,25 @@ export default class PeerConnection extends EventEmitter {
     this.peerConnectionStats = null
   }
 
+  /**
+   * Set TURN server location.
+   *
+   * @param {String} url - New TURN location
+   */
+  static setTurnServerLocation (url) {
+    turnServerLocation = url
+  }
+
+  /**
+   * Get current TURN location.
+   *
+   * By default, https://turn.millicast.com/webrtc/_turn is the current TURN location.
+   * @returns {String} TURN url
+   */
+  static getTurnServerLocation () {
+    return turnServerLocation
+  }
+
   /**
    * Instance new RTCPeerConnection.
    * @param {RTCConfiguration} config - Peer configuration.
@@ -91,10 +113,11 @@ export default class PeerConnection extends EventEmitter {
 
   /**
    * Get Ice servers from a Millicast signaling server.
-   * @param {String} location - URL of signaling server where Ice servers will be obtained.
+   * @param {String} location - *Deprecated, use .setTurnServerLocation() method instead* URL of signaling server where Ice servers will be obtained.
    * @returns {Promise<Array<RTCIceServer>>} Promise object which represents a list of Ice servers.
    */
-  async getRTCIceServers (location = 'https://turn.millicast.com/webrtc/_turn') {
+  async getRTCIceServers (location) {
+    location = location ?? turnServerLocation
     logger.info('Getting RTC ICE servers')
     logger.debug('RTC ICE servers request location: ', location)
 

packages/millicast-sdk/src/PeerConnection.js

@@ -8,6 +8,9 @@ const logger = Logger.get('StreamEvents')
 const messageType = { REQUEST: 1, RESPONSE: 3 }
 let invocationId = 0
 
+export const defaultEventsLocation = 'wss://streamevents.millicast.com/ws'
+let eventsLocation = defaultEventsLocation
+
 const errorMsg = 'You need to initialize stream event with StreamEvents.init()'
 
 /**
@@ -40,12 +43,31 @@ export default class StreamEvents {
    */
   static async init () {
     const instance = new StreamEvents()
-    instance.eventSubscriber = new EventSubscriber()
+    instance.eventSubscriber = new EventSubscriber(this.getEventsLocation())
     await instance.eventSubscriber.initializeHandshake()
 
     return instance
   }
 
+  /**
+   * Set Websocket Stream Events location.
+   *
+   * @param {String} url - New Stream Events location
+  */
+  static setEventsLocation (url) {
+    eventsLocation = url
+  }
+
+  /**
+   * Get current Websocket Stream Events location.
+   *
+   * By default, wss://streamevents.millicast.com/ws is the location.
+   * @returns {String} Stream Events location
+  */
+  static getEventsLocation () {
+    return eventsLocation
+  }
+
   /**
    * Subscribes to User Count event and invokes the callback once a new message is available.
    * @param {String} accountId - Millicast Account Id.

packages/millicast-sdk/src/StreamEvents.js

@@ -2,13 +2,13 @@ import Logger from '../Logger'
 import EventEmitter from 'events'
 
 const logger = Logger.get('EventSubscriber')
-export const eventsLocation = 'wss://streamevents.millicast.com/ws'
 export const recordSeparator = '\x1E'
 
 export default class EventSubscriber extends EventEmitter {
-  constructor () {
+  constructor (eventsLocation) {
     super()
     this.webSocket = null
+    this.eventsLocation = eventsLocation
   }
 
   /**
@@ -41,7 +41,7 @@ export default class EventSubscriber extends EventEmitter {
     if (this.webSocket?.readyState !== WebSocket.CONNECTING && this.webSocket?.readyState !== WebSocket.OPEN) {
       return new Promise((resolve, reject) => {
         logger.info('Starting events WebSocket handshake.')
-        this.webSocket = new WebSocket(eventsLocation)
+        this.webSocket = new WebSocket(this.eventsLocation)
         this.webSocket.onopen = () => {
           logger.info('Connection established with events WebSocket.')
           const handshakeRequest = {

packages/millicast-sdk/src/utils/EventSubscriber.js

@@ -24,3 +24,8 @@ Feature: As a user I want to get ICE server so I can configure a peer connection
     Given I do not have an ICE server location
     When I want to get the RTC Ice Servers and server responds with 500 error
     Then returns empty ICE Servers
+
+  Scenario: Get RTC Ice servers with custom location set in static method
+    Given I have an ICE server location
+    When I set the TURN server location and I want to get the RTC Ice Servers
+    Then returns the ICE Servers

packages/millicast-sdk/tests/features/GetIceServer.feature

@@ -23,4 +23,9 @@ Feature: As a user I want to publish to a Millicast Stream so I can get a connec
   Scenario: Publish with an existing stream name, valid token and options as object
     Given I have a valid token and an existing stream name
     When I request a connection path to Director API using options object
+    Then I get the publish connection path
+
+  Scenario: Publish to an existing stream name, valid token and custom live websocket domain
+    Given I have a valid token and an existing stream name
+    When I set a custom live websocket domain and I request a connection path to Director API
     Then I get the publish connection path

packages/millicast-sdk/tests/features/GetPublisherConnectionPath.feature

@@ -23,4 +23,9 @@ Feature: As a user I want to subscribe to a Millicast Stream so I can get a conn
   Scenario: Subscribe to an existing unrestricted stream, valid accountId, no token and options as object
     Given I have an existing stream name, accountId and no token
     When I request a connection path to Director API using options object
+    Then I get the subscriber connection path
+
+  Scenario: Subscribe to an existing stream, valid accountId, no token and custom live websocket domain
+    Given I have an existing stream name, accountId and no token
+    When I set a custom live websocket domain and I request a connection path to Director API
     Then I get the subscriber connection path

packages/millicast-sdk/tests/features/GetSubscriberConnectionPath.feature

@@ -1,13 +1,14 @@
 import { loadFeature, defineFeature } from 'jest-cucumber'
 import axios from 'axios'
-import PeerConnection from '../../../src/PeerConnection'
+import PeerConnection, { defaultTurnServerLocation } from '../../../src/PeerConnection'
 import './__mocks__/MockMediaStream'
 const feature = loadFeature('../GetIceServer.feature', { loadRelativePath: true, errors: true })
 
 jest.mock('axios')
 
 defineFeature(feature, test => {
   afterEach(async () => {
+    PeerConnection.setTurnServerLocation(defaultTurnServerLocation)
     jest.restoreAllMocks()
   })
 
@@ -167,4 +168,46 @@ defineFeature(feature, test => {
       expect(iceServers).toEqual([])
     })
   })
+
+  test('Get RTC Ice servers with custom location set in static method', ({ given, when, then }) => {
+    const peerConnection = new PeerConnection()
+    const axiosResponse = {
+      data: {
+        v: {
+          iceServers: [
+            {
+              url: 'stun:us-turn4.xirsys.com'
+            },
+            {
+              username: 'gXvMYEfTmYMN0kBpnL0jJ947Fadjts8n4CFUTS4j_eqZ0De7Lx4lHzlI40gLyhI8AAAAAGCC7OptaWxsaWNhc3Q=',
+              url: 'turn:us-turn4.xirsys.com:80?transport=udp',
+              credential: 'b74d7ac6-a44b-11eb-a304-0242ac140004'
+            }
+          ]
+        },
+        s: 'ok'
+      }
+    }
+    let location
+    let iceServers
+
+    given('I have an ICE server location', async () => {
+      location = 'https://myIceServersLocation.com/webrtc'
+    })
+
+    when('I set the TURN server location and I want to get the RTC Ice Servers', async () => {
+      axios.put.mockResolvedValue(axiosResponse)
+      PeerConnection.setTurnServerLocation(location)
+      iceServers = await peerConnection.getRTCIceServers()
+    })
+
+    then('returns the ICE Servers', async () => {
+      expect(PeerConnection.getTurnServerLocation()).toBe(location)
+      for (const iceServer of iceServers) {
+        expect(iceServer.url).toBeUndefined()
+        expect(iceServer.urls).not.toBeUndefined()
+        expect(axiosResponse.data.v.iceServers.filter(x => x.url === iceServer.urls)).toBeDefined()
+      }
+    })
+  })
 })