Merge pull request #77 from millicast/develop

Release v0.1.7

Author: emilsas

packages/millicast-sdk/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@millicast/sdk",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "SDK for building a realtime broadcaster using the Millicast platform.",
   "keywords": [
     "sdk",
@@ -48,6 +48,7 @@
     "buffer": "^6.0.3",
     "events": "^3.3.0",
     "js-logger": "^1.6.1",
+    "jwt-decode": "^3.1.2",
     "re-emitter": "^1.1.4",
     "semantic-sdp": "^3.21.0",
     "transaction-manager": "^2.1.3",

packages/millicast-sdk/package.json

@@ -1,4 +1,5 @@
 import axios from 'axios'
+import jwtDecode from 'jwt-decode'
 import Logger from './Logger'
 
 const logger = Logger.get('Director')
@@ -14,6 +15,7 @@ let apiEndpoint = defaultApiEndpoint
  * @typedef {Object} MillicastDirectorResponse
  * @property {Array<String>} urls - WebSocket available URLs.
  * @property {String} jwt - Access token for signaling initialization.
+ * @property {Object} jwtDecoded - Access token decoded.
  */
 
 /**
@@ -83,7 +85,7 @@ export default class Director {
     try {
       const { data } = await axios.post(url, payload, { headers })
       logger.debug('Getting publisher response: ', data)
-      return data.data
+      return { ...data.data, jwtDecoded: jwtDecode(data.data.jwt).millicast }
     } catch (e) {
       logger.error('Error while getting publisher connection path: ', e.response?.data)
       throw e
@@ -134,7 +136,7 @@ export default class Director {
     try {
       const { data } = await axios.post(url, payload, { headers })
       logger.debug('Getting subscriber response: ', data)
-      return data.data
+      return { ...data.data, jwtDecoded: jwtDecode(data.data.jwt).millicast }
     } catch (e) {
       logger.error('Error while getting subscriber connection path: ', e.response?.data)
       throw e

packages/millicast-sdk/src/Director.js

@@ -254,16 +254,18 @@ export default class PeerConnection extends EventEmitter {
 
   /**
    * @typedef {Object} MillicastCapability
-   * @property {String} codec - Audio or video codec name.
-   * @property {String} mimeType - Audio or video codec mime type.
-   * @property {Array<String>} [scalabilityModes] - In case of SVC support, a list of scalability modes supported.
-   * @property {Number} [channels] - Only for audio, the number of audio channels supported.
+   * @property {Array<Object>} codecs
+   * @property {String} codecs.codec - Audio or video codec name.
+   * @property {String} codecs.mimeType - Audio or video codec mime type.
+   * @property {Array<String>} [codecs.scalabilityModes] - In case of SVC support, a list of scalability modes supported.
+   * @property {Number} [codecs.channels] - Only for audio, the number of audio channels supported.
+   * @property {Array<RTCRtpHeaderExtensionCapability>} headerExtensions - An array specifying the URI of the header extension, as described in RFC 5285.
    */
   /**
    * Gets user's browser media capabilities compared with Millicast Media Server support.
    *
    * @param {"audio"|"video"} kind - Type of media for which you wish to get sender capabilities.
-   * @returns {Array<MillicastCapability>} An array with all capabilities supported by user's browser and Millicast Media Server.
+   * @returns {MillicastCapability} Object with all capabilities supported by user's browser and Millicast Media Server.
    */
   static getCapabilities (kind) {
     const browserData = new UserAgent()

packages/millicast-sdk/src/PeerConnection.js

@@ -52,6 +52,7 @@ export default class Publish extends BaseWebRTC {
    * @param {String} options.scalabilityMode - Selected scalability mode. You can get the available capabilities using <a href="PeerConnection#.getCapabilities">PeerConnection.getCapabilities</a> method.
    * **Only available in Google Chrome.**
    * @param {RTCConfiguration} options.peerConfig - Options to configure the new RTCPeerConnection.
+   * @param {Boolean} [options.record] - Enable stream recording. If record is not provided, use default Token configuration. **Only available in Tokens with recording enabled.**
    * @returns {Promise<void>} Promise object which resolves when the broadcast started successfully.
    * @fires PeerConnection#connectionStateChange
    * @example await publish.connect(options)
@@ -111,7 +112,7 @@ export default class Publish extends BaseWebRTC {
     reemit(this.webRTCPeer, this, [webRTCEvents.connectionStateChange])
 
     const localSdp = await this.webRTCPeer.getRTCLocalSDP(this.options)
-    let remoteSdp = await this.signaling.publish(localSdp, this.options.codec)
+    let remoteSdp = await this.signaling.publish(localSdp, this.options.codec, this.options.record)
 
     if (!this.options.disableVideo && this.options.bandwidth > 0) {
       remoteSdp = this.webRTCPeer.updateBandwidthRestriction(remoteSdp, this.options.bandwidth)

packages/millicast-sdk/src/Publish.js

@@ -203,10 +203,11 @@ export default class Signaling extends EventEmitter {
    * Establish WebRTC connection with Millicast Server as Publisher role.
    * @param {String} sdp - The SDP information created by your offer.
    * @param {VideoCodec} [codec="h264"] - Codec for publish stream.
+   * @param {Boolean} [record] - Enable stream recording. If record is not provided, use default Token configuration. **Only available in Tokens with recording enabled.**
    * @example const response = await millicastSignaling.publish(sdp, 'h264')
    * @return {Promise<String>} Promise object which represents the SDP command response.
    */
-  async publish (sdp, codec = VideoCodec.H264) {
+  async publish (sdp, codec = VideoCodec.H264, record = null) {
     logger.info(`Starting publishing to streamName: ${this.streamName}, codec: ${codec}`)
     logger.debug('Publishing local description: ', sdp)
 
@@ -227,6 +228,10 @@ export default class Signaling extends EventEmitter {
       codec
     }
 
+    if (record !== null) {
+      data.record = record
+    }
+
     try {
       await this.connect()
       logger.info('Sending publish command')

packages/millicast-sdk/src/Signaling.js

@@ -2,7 +2,7 @@ Feature: As a user I want to signal Millicast Server so I can offer publishing a
 
   Scenario: Offer a SDP with no previous connection and h264 codec
     Given a local sdp and no previous connection to server
-    When I offer my local sdp with h264 codec
+    When I offer my local sdp with h264 codec and recording option
     Then returns a filtered sdp to offer to remote peer
 
   Scenario: Offer a SDP with no previous connection and vp8 codec

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

@@ -4,6 +4,7 @@ import Director from '../../../src/Director'
 const feature = loadFeature('../GetPublisherConnectionPath.feature', { loadRelativePath: true, errors: true })
 
 jest.mock('axios')
+const dummyToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyLCJtaWxsaWNhc3QiOnt9fQ.IqT-PLLz-X7Wn7BNo-x4pFApAbMT9mmnlupR8eD9q4U'
 
 defineFeature(feature, test => {
   test('Publish with an existing stream name and valid token', ({ given, when, then }) => {
@@ -19,7 +20,7 @@ defineFeature(feature, test => {
           urls: [
             'wss://live-west.millicast.com/ws/v2/pub/12345'
           ],
-          jwt: '123jwt',
+          jwt: dummyToken,
           streamAccountId: 'Existing_accountId'
         }
       }
@@ -36,7 +37,7 @@ defineFeature(feature, test => {
 
     then('I get the publish connection path', async () => {
       expect(response).toBeDefined()
-      expect(response).toEqual(mockedResponse.data.data)
+      expect(response).toEqual(expect.objectContaining(mockedResponse.data.data))
     })
   })
 
@@ -104,7 +105,7 @@ defineFeature(feature, test => {
 
     then('throws an error with "invalid token" message', async () => {
       expect(responseError).toBeDefined()
-      expect(responseError.response.data).toEqual(mockedResponse.response.data)
+      expect(responseError.response.data).toEqual(expect.objectContaining(mockedResponse.response.data))
     })
   })
 
@@ -121,7 +122,7 @@ defineFeature(feature, test => {
           urls: [
             'wss://live-west.millicast.com/ws/v2/pub/12345'
           ],
-          jwt: '123jwt',
+          jwt: dummyToken,
           streamAccountId: 'Existing_accountId'
         }
       }
@@ -144,7 +145,7 @@ defineFeature(feature, test => {
         expect.any(Object)
       )
       expect(response).toBeDefined()
-      expect(response).toEqual(mockedResponse.data.data)
+      expect(response).toEqual(expect.objectContaining(mockedResponse.data.data))
     })
   })
 })

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

@@ -4,6 +4,7 @@ import Director from '../../../src/Director'
 const feature = loadFeature('../GetSubscriberConnectionPath.feature', { loadRelativePath: true, errors: true })
 
 jest.mock('axios')
+const dummyToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyLCJtaWxsaWNhc3QiOnt9fQ.IqT-PLLz-X7Wn7BNo-x4pFApAbMT9mmnlupR8eD9q4U'
 
 defineFeature(feature, test => {
   test('Subscribe to an existing unrestricted stream, valid accountId and no token', ({ given, when, then }) => {
@@ -18,7 +19,7 @@ defineFeature(feature, test => {
           urls: [
             'wss://live-west.millicast.com/ws/v2/sub/12345'
           ],
-          jwt: '123jwt',
+          jwt: dummyToken,
           streamAccountId: 'Existing_accountId'
         }
       }
@@ -35,7 +36,7 @@ defineFeature(feature, test => {
 
     then('I get the subscriber connection path', async () => {
       expect(response).toBeDefined()
-      expect(response).toEqual(mockedResponse.data.data)
+      expect(response).toEqual(expect.objectContaining(mockedResponse.data.data))
     })
   })
 
@@ -51,7 +52,7 @@ defineFeature(feature, test => {
           urls: [
             'wss://live-west.millicast.com/ws/v2/sub/12345'
           ],
-          jwt: '123jwt',
+          jwt: dummyToken,
           streamAccountId: 'Existing_accountId'
         }
       }
@@ -68,7 +69,7 @@ defineFeature(feature, test => {
 
     then('I get the subscriber connection path', async () => {
       expect(response).toBeDefined()
-      expect(response).toEqual(mockedResponse.data.data)
+      expect(response).toEqual(expect.objectContaining(mockedResponse.data.data))
     })
   })
 
@@ -119,7 +120,7 @@ defineFeature(feature, test => {
           urls: [
             'wss://live-west.millicast.com/ws/v2/sub/12345'
           ],
-          jwt: '123jwt',
+          jwt: dummyToken,
           streamAccountId: 'Existing_accountId'
         }
       }
@@ -142,7 +143,7 @@ defineFeature(feature, test => {
         expect.any(Object)
       )
       expect(response).toBeDefined()
-      expect(response).toEqual(mockedResponse.data.data)
+      expect(response).toEqual(expect.objectContaining(mockedResponse.data.data))
     })
   })
 })

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

@@ -72,12 +72,12 @@ defineFeature(feature, test => {
       })
     })
 
-    when('I offer my local sdp with h264 codec', async () => {
+    when('I offer my local sdp with h264 codec and recording option', async () => {
       const signaling = new Signaling({
         streamName: streamName,
         url: publishWebSocketLocation
       })
-      response = await signaling.publish(localSdp, 'h264')
+      response = await signaling.publish(localSdp, 'h264', true)
     })
 
     then('returns a filtered sdp to offer to remote peer', async () => {