Merge pull request #58 from millicast/develop

Release v0.1.3

Author: emilsas

packages/millicast-sdk/package-lock.json

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

packages/millicast-sdk/package.json

@@ -80,6 +80,7 @@ export default class Publish extends BaseWebRTC {
     }
   ) {
     logger.debug('Broadcast option values: ', options)
+    this.options = options
     if (!options.mediaStream) {
       logger.error('Error while broadcasting. MediaStream required')
       throw new Error('MediaStream required')
@@ -89,7 +90,6 @@ export default class Publish extends BaseWebRTC {
       throw new Error('Broadcast currently working')
     }
     let publisherData
-    this.options = options
     try {
       publisherData = await this.tokenGenerator()
     } catch (error) {

packages/millicast-sdk/src/Publish.js

@@ -90,12 +90,12 @@ export default class View extends BaseWebRTC {
     }
   ) {
     logger.debug('Viewer connect options values: ', options)
+    this.options = options
     if (this.isActive()) {
       logger.warn('Viewer currently subscribed')
       throw new Error('Viewer currently subscribed')
     }
     let subscriberData
-    this.options = options
     try {
       subscriberData = await this.tokenGenerator()
     } catch (error) {

packages/millicast-sdk/src/View.js

@@ -3,6 +3,7 @@ import PeerConnection, { webRTCEvents } from '../PeerConnection'
 import { signalingEvents } from '../Signaling'
 let logger
 const maxReconnectionInterval = 32000
+const baseInterval = 1000
 
 /**
  * Callback invoke when a new connection path is needed.
@@ -40,7 +41,7 @@ export default class BaseWebRTC extends EventEmitter {
     this.signaling = null
     this.streamName = streamName
     this.autoReconnect = autoReconnect
-    this.reconnectionInterval = 1000
+    this.reconnectionInterval = baseInterval
     this.alreadyDisconnected = false
     this.firstReconnection = true
     this.tokenGenerator = tokenGenerator
@@ -98,32 +99,30 @@ export default class BaseWebRTC extends EventEmitter {
    * Reconnects to last broadcast.
    * @fires BaseWebRTC#reconnect
    */
-  reconnect () {
-    /**
-     * Emits with every reconnection attempt made when an active stream
-     * stopped unexpectedly.
-     *
-     * @event BaseWebRTC#reconnect
-     * @type {Object}
-     * @property {Number} timeout - Next retry interval in milliseconds.
-     */
-    this.emit('reconnect', { timeout: this.reconnectionInterval })
-
-    setTimeout(async () => {
-      try {
-        if (!this.isActive()) {
-          this.stop()
-          await this.connect(this.options)
-          this.alreadyDisconnected = false
-          this.reconnectionInterval = 1000
-          this.firstReconnection = true
-        }
-      } catch (error) {
-        this.reconnectionInterval = nextReconnectInterval(this.reconnectionInterval)
-        logger.error(`Reconnection failed, retrying in ${this.reconnectionInterval}ms. Error was: `, error)
-        this.reconnect()
+  async reconnect () {
+    try {
+      if (!this.isActive()) {
+        this.stop()
+        await this.connect(this.options)
+        this.alreadyDisconnected = false
+        this.reconnectionInterval = baseInterval
+        this.firstReconnection = true
       }
-    }, this.reconnectionInterval)
+    } catch (error) {
+      this.reconnectionInterval = nextReconnectInterval(this.reconnectionInterval)
+      logger.error(`Reconnection failed, retrying in ${this.reconnectionInterval}ms. Error was: `, error)
+      /**
+       * Emits with every reconnection attempt made when an active stream
+       * stopped unexpectedly.
+       *
+       * @event BaseWebRTC#reconnect
+       * @type {Object}
+       * @property {Number} timeout - Next retry interval in milliseconds.
+       * @property {Error} error - Error object with cause of failure.
+       */
+      this.emit('reconnect', { timeout: this.reconnectionInterval, error })
+      setTimeout(() => this.reconnect(), this.reconnectionInterval)
+    }
   }
 }
 

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

@@ -152,6 +152,7 @@ defineFeature(feature, test => {
   test('Reconnection interval when peer has an error', ({ given, when, then }) => {
     let publisher
     const reconnectHandler = jest.fn()
+    const errorMessage = 'Error has ocurred'
 
     given('an instance of Publish with reconnection enabled and peer with error', async () => {
       publisher = new Publish('streamName', mockTokenGenerator, true)
@@ -162,24 +163,24 @@ defineFeature(feature, test => {
     })
 
     when('reconnection is called and fails', () => {
-      jest.spyOn(publisher, 'connect').mockImplementation(() => { throw new Error() })
+      jest.spyOn(publisher, 'connect').mockImplementation(() => { throw new Error(errorMessage) })
       publisher.reconnect()
     })
 
     then('reconnection is called again in increments of 2 seconds until 32 seconds', async () => {
-      let interval = 1000
-      for (let i = 1; i <= 6; i++) {
+      let interval = 2000
+      for (let i = 1; i <= 5; i++) {
         expect(setTimeout).toHaveBeenCalledTimes(i)
         expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), interval)
         expect(reconnectHandler).toHaveBeenCalledTimes(i)
-        expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: interval })
+        expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: interval, error: new Error(errorMessage) })
         jest.runOnlyPendingTimers()
         interval = interval * 2
       }
-      expect(setTimeout).toHaveBeenCalledTimes(7)
+      expect(setTimeout).toHaveBeenCalledTimes(6)
       expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 32000)
-      expect(reconnectHandler).toHaveBeenCalledTimes(7)
-      expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: 32000 })
+      expect(reconnectHandler).toHaveBeenCalledTimes(6)
+      expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: 32000, error: new Error(errorMessage) })
       jest.runOnlyPendingTimers()
     })
   })
@@ -198,8 +199,7 @@ defineFeature(feature, test => {
     })
 
     then('reconnection is not called again', async () => {
-      jest.advanceTimersByTime(62000)
-      expect(setTimeout).toHaveBeenCalledTimes(1)
+      expect(setTimeout).not.toHaveBeenCalled()
     })
   })
 
@@ -217,13 +217,7 @@ defineFeature(feature, test => {
     })
 
     then('peer reconnects and reconnection is not called again', async () => {
-      expect(setTimeout).toHaveBeenCalledTimes(1)
-      expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 1000)
-      jest.runOnlyPendingTimers()
-      jest.spyOn(publisher, 'isActive').mockImplementation(() => { return true })
-
-      jest.advanceTimersByTime(62000)
-      expect(setTimeout).toHaveBeenCalledTimes(1)
+      expect(setTimeout).not.toHaveBeenCalled()
     })
   })
 })

packages/millicast-sdk/tests/features/step-definitions/PublisherReconnect.steps.js

@@ -149,6 +149,7 @@ defineFeature(feature, test => {
   test('Reconnection interval when peer has an error', ({ given, when, then }) => {
     let viewer
     const reconnectHandler = jest.fn()
+    const errorMessage = 'Error has ocurred'
 
     given('an instance of Viewer with reconnection enabled and peer with error', async () => {
       viewer = new View('streamName', mockTokenGenerator, null, true)
@@ -159,24 +160,24 @@ defineFeature(feature, test => {
     })
 
     when('reconnection is called and fails', () => {
-      jest.spyOn(viewer, 'connect').mockImplementation(() => { throw new Error() })
+      jest.spyOn(viewer, 'connect').mockImplementation(() => { throw new Error(errorMessage) })
       viewer.reconnect()
     })
 
     then('reconnection is called again in increments of 2 seconds until 32 seconds', async () => {
-      let interval = 1000
-      for (let i = 1; i <= 6; i++) {
+      let interval = 2000
+      for (let i = 1; i <= 5; i++) {
         expect(setTimeout).toHaveBeenCalledTimes(i)
         expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), interval)
         expect(reconnectHandler).toHaveBeenCalledTimes(i)
-        expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: interval })
+        expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: interval, error: new Error(errorMessage) })
         jest.runOnlyPendingTimers()
         interval = interval * 2
       }
-      expect(setTimeout).toHaveBeenCalledTimes(7)
+      expect(setTimeout).toHaveBeenCalledTimes(6)
       expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 32000)
-      expect(reconnectHandler).toHaveBeenCalledTimes(7)
-      expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: 32000 })
+      expect(reconnectHandler).toHaveBeenCalledTimes(6)
+      expect(reconnectHandler).toHaveBeenLastCalledWith({ timeout: 32000, error: new Error(errorMessage) })
       jest.runOnlyPendingTimers()
       expect(viewer.connect).toBeCalledTimes(7)
     })
@@ -196,8 +197,7 @@ defineFeature(feature, test => {
     })
 
     then('reconnection is not called again', async () => {
-      jest.advanceTimersByTime(62000)
-      expect(setTimeout).toHaveBeenCalledTimes(1)
+      expect(setTimeout).not.toHaveBeenCalled()
     })
   })
 
@@ -216,13 +216,7 @@ defineFeature(feature, test => {
     })
 
     then('peer reconnects and reconnection is not called again', async () => {
-      expect(setTimeout).toHaveBeenCalledTimes(1)
-      expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 1000)
-      jest.runOnlyPendingTimers()
-      jest.spyOn(viewer, 'isActive').mockImplementation(() => { return true })
-
-      jest.advanceTimersByTime(62000)
-      expect(setTimeout).toHaveBeenCalledTimes(1)
+      expect(setTimeout).not.toHaveBeenCalled()
     })
   })
 })

packages/millicast-sdk/tests/features/step-definitions/ViewerReconnect.steps.js

@@ -38,9 +38,10 @@ class MillicastViewTest {
       this.millicastView.on('connectionStateChange', (state) => {
         console.log('Event from connectionStateChange: ', state)
       })
-      this.millicastView.connect(options)
+      await this.millicastView.connect(options)
     } catch (error) {
-      console.log('There was an error while trying to connect with the publisher: ', error)
+      console.log('There was an error while trying to connect with the publisher')
+      this.millicastView.reconnect()
     }
   }