[STREAM-926] [STREAM-912] - Updated screen recording metadata request to retry on failures and use exponential backoff. Bumped streaming-client. (#944)

Author: zservies

changelog.md

@@ -4,6 +4,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 # [Unreleased](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.0...HEAD)
+
+# Changed
+* [STREAM-926](https://inindca.atlassian.net/browse/STREAM-926) - Updated screen recording metadata request to use `requestApiWithRetry` to retry failed requests with exponential backoff.
+* [STREAM-912](https://inindca.atlassian.net/browse/STREAM-912) - Bump streaming-client to `19.4.0` to remove SDP answer payload from logging.
+* [NO-JIRA] - Bump axios to `1.12.2` to address Snyk vulnerability.
+
 # Added
 * [STREAM-866](https://inindca.atlassian.net/browse/STREAM-850) - Generate a test report in JUnit.xml format
 

package-lock.json

@@ -57,11 +57,11 @@
   "dependencies": {
     "@babel/runtime": "^7.24.6",
     "@babel/runtime-corejs3": "^7.24.6",
-    "axios": "^1.10.0",
+    "axios": "^1.12.2",
     "browserama": "^3.2.2",
     "core-js": "^3.37.1",
     "genesys-cloud-client-logger": "^4.2.17",
-    "genesys-cloud-streaming-client": "^19.3.1",
+    "genesys-cloud-streaming-client": "^19.4.0",
     "jwt-decode": "^4.0.0",
     "lodash": "^4.17.21",
     "process-fast": "^1.0.0",

package.json

@@ -9,7 +9,7 @@ import {
 } from '../types/interfaces';
 import BaseSessionHandler from './base-session-handler';
 import { SessionTypes, SdkErrorTypes } from '../types/enums';
-import { createAndEmitSdkError, getBareJid, isPeerConnectionDisconnected, isScreenRecordingJid, requestApi } from '../utils';
+import { createAndEmitSdkError, getBareJid, isPeerConnectionDisconnected, isScreenRecordingJid, requestApiWithRetry } from '../utils';
 import { filter, fromEvent, take, takeWhile } from 'rxjs';
 
 export class ScreenRecordingSessionHandler extends BaseSessionHandler {
@@ -95,7 +95,7 @@ export class ScreenRecordingSessionHandler extends BaseSessionHandler {
   }
 
   private updateScreenRecordingMetadatas (session: ScreenRecordingMediaSession, metadatas: ScreenRecordingMetadata[]) {
-    this.log('debug', 'sending screen metadatas', { conversationId: session.conversationId, sessionId: session.id, metadatas })
+    this.log('info', 'sending screen metadatas', { conversationId: session.conversationId, sessionId: session.id, metadatas })
     metadatas.forEach((meta) => {
       // adding any here because I don't want to add this to the public interface
       (meta as any)._trackId = meta.trackId;
@@ -124,11 +124,28 @@ export class ScreenRecordingSessionHandler extends BaseSessionHandler {
       url += '/backgroundassistant';
     }
 
-    return requestApi.call(this.sdk, url, {
-      method: 'post',
-      authToken: accessToken || jwt,
-      data
-    });
+    return requestApiWithRetry
+      .call(this.sdk, url, {
+        method: 'post',
+        authToken: accessToken || jwt,
+        data,
+      })
+      .promise.then(() => {
+        this.log('info', 'Screen recording metadata sent.', {
+          conversationId: session.conversationId,
+          sessionId: session.id,
+          metadatas,
+        });
+      })
+      .catch((e) => {
+        this.log('error', 'Failed to send screen recording metadata.', {
+          error: e,
+          conversationId: session.conversationId,
+          sessionId: session.id,
+          metadatas,
+        });
+        throw e;
+      });
   }
 }
 

src/sessions/screen-recording-session-handler.ts

@@ -105,7 +105,7 @@ describe('sendMetadataWhenSessionConnects', () => {
     pc.connectionState = 'disconnected';
     pc.dispatchEvent(new Event('connectionstatechange'));
     expect(spy).not.toHaveBeenCalled();
-    
+
     // since the above state was disconnected, the observable should have ended and should no longer process changes
     pc.connectionState = 'connected';
     pc.dispatchEvent(new Event('connectionstatechange'));
@@ -169,7 +169,7 @@ describe('acceptSession', () => {
 
     expect(metadatasSpy).not.toHaveBeenCalled();
   });
-  
+
   it('should throw if no metadatas are empty', async () => {
     const metadatasSpy = jest.spyOn(utils, 'requestApi').mockResolvedValue(null);
     const session = {
@@ -242,7 +242,16 @@ describe('updateOutgoingMedia', () => {
 });
 
 describe('updateScreenRecordingMetadatas', () => {
-  it('should replace trackIds with mid', async () => {
+  let mockRetryRequest: any;
+
+  beforeEach(() => {
+    mockRetryRequest = {
+      promise: Promise.resolve()
+    };
+    jest.spyOn(utils, 'requestApiWithRetry').mockReturnValue(mockRetryRequest);
+  });
+
+  it('should replace trackIds with mid and use retry logic', async () => {
     const metas = [
       {
         trackId: 'trackId123'
@@ -276,10 +285,12 @@ describe('updateScreenRecordingMetadatas', () => {
     const session = {
       pc: {
         getTransceivers: jest.fn().mockReturnValue(transceivers)
-      }
+      },
+      conversationId: 'conv123',
+      id: 'session456'
     };
 
-    jest.spyOn(utils, 'requestApi').mockResolvedValue(null);
+    const logSpy = jest.spyOn(handler as any, 'log');
 
     await handler['updateScreenRecordingMetadatas'](session as any, metas as any);
 
@@ -288,9 +299,16 @@ describe('updateScreenRecordingMetadatas', () => {
 
     expect(metas[1].trackId).toBe('7');
     expect((metas[1] as any)._trackId).toBe('trackId456');
+
+    expect(utils.requestApiWithRetry).toHaveBeenCalled();
+    expect(logSpy).toHaveBeenCalledWith('info', 'Screen recording metadata sent.', expect.objectContaining({
+      conversationId: 'conv123',
+      sessionId: 'session456',
+      metadatas: metas
+    }));
   });
 
-  it('should use the backgroundassistant url', async () => {
+  it('should use the backgroundassistant url with retry logic', async () => {
     const metas = [
       { trackId: 'trackId123' }
     ];
@@ -307,23 +325,25 @@ describe('updateScreenRecordingMetadatas', () => {
     const session = {
       pc: {
         getTransceivers: jest.fn().mockReturnValue(transceivers)
-      }
+      },
+      conversationId: 'conv123',
+      id: 'session456'
     };
 
-    jest.spyOn(utils, 'requestApi').mockResolvedValue(null);
-
     Object.defineProperty(mockSdk, 'isJwtAuth', { get: () => true });
     mockSdk._config.jwt = 'myjwt';
     mockSdk._config.accessToken = null;
 
     await handler['updateScreenRecordingMetadatas'](session as any, metas as any);
 
-    expect(utils.requestApi).toHaveBeenCalledWith(
+    expect(utils.requestApiWithRetry).toHaveBeenCalledWith(
       expect.stringContaining('backgroundassistant'),
       expect.objectContaining({
-        authToken: 'myjwt'
-      }
-    ));
+        method: 'post',
+        authToken: 'myjwt',
+        data: expect.any(String)
+      })
+    );
     expect(metas[0].trackId).toBe('3');
     expect((metas[0] as any)._trackId).toBe('trackId123');
   });
@@ -340,14 +360,113 @@ describe('updateScreenRecordingMetadatas', () => {
     const session = {
       pc: {
         getTransceivers: jest.fn().mockReturnValue([])
-      }
+      },
+      conversationId: 'conv123',
+      id: 'session456'
     };
 
-    jest.spyOn(utils, 'requestApi').mockResolvedValue(null);
     const logSpy = jest.spyOn(handler as any, 'log');
 
     await handler['updateScreenRecordingMetadatas'](session as any, metas as any);
 
     expect(logSpy).toHaveBeenCalledWith('warn', expect.stringContaining('Failed to find transceiver'), expect.anything());
   });
+
+  it('should log error and re-throw when retry request fails', async () => {
+    const error = new Error('Network failure after retries');
+    mockRetryRequest.promise = Promise.reject(error);
+
+    const metas = [{ trackId: 'trackId123' }];
+    const transceivers = [{
+      mid: '3',
+      sender: { track: { id: metas[0].trackId } }
+    }];
+
+    const session = {
+      pc: {
+        getTransceivers: jest.fn().mockReturnValue(transceivers)
+      },
+      conversationId: 'conv123',
+      id: 'session456'
+    };
+
+    const logSpy = jest.spyOn(handler as any, 'log');
+
+    await expect(handler['updateScreenRecordingMetadatas'](session as any, metas as any))
+      .rejects.toThrow('Network failure after retries');
+
+    expect(logSpy).toHaveBeenCalledWith('error', 'Failed to send screen recording metadata.', expect.objectContaining({
+      error,
+      conversationId: 'conv123',
+      sessionId: 'session456',
+      metadatas: metas
+    }));
+    expect(utils.requestApiWithRetry).toHaveBeenCalled();
+  });
+
+  it('should use accessToken when not jwt auth', async () => {
+    const metas = [{ trackId: 'trackId123' }];
+    const transceivers = [{
+      mid: '3',
+      sender: { track: { id: metas[0].trackId } }
+    }];
+
+    const session = {
+      pc: {
+        getTransceivers: jest.fn().mockReturnValue(transceivers)
+      },
+      conversationId: 'conv123',
+      id: 'session456'
+    };
+
+    Object.defineProperty(mockSdk, 'isJwtAuth', { get: () => false });
+    mockSdk._config.accessToken = 'access123';
+    mockSdk._config.jwt = null;
+
+    await handler['updateScreenRecordingMetadatas'](session as any, metas as any);
+
+    expect(utils.requestApiWithRetry).toHaveBeenCalledWith(
+      '/recordings/screensessions/metadata',
+      expect.objectContaining({
+        method: 'post',
+        authToken: 'access123',
+        data: expect.any(String)
+      })
+    );
+  });
+
+  it('should include correct payload in the request', async () => {
+    const metas = [{ trackId: 'trackId123', someProperty: 'value' }];
+    const transceivers = [{
+      mid: '3',
+      sender: { track: { id: metas[0].trackId } }
+    }];
+
+    const session = {
+      pc: {
+        getTransceivers: jest.fn().mockReturnValue(transceivers)
+      },
+      conversationId: 'conv123',
+      id: 'session456',
+      originalRoomJid: 'room@conference.example.com'
+    };
+
+    jest.spyOn(utils, 'getBareJid').mockReturnValue('user@example.com');
+
+    await handler['updateScreenRecordingMetadatas'](session as any, metas as any);
+
+    const requestCall = (utils.requestApiWithRetry as jest.Mock).mock.calls[0];
+    const requestData = JSON.parse(requestCall[1].data);
+
+    expect(requestData).toEqual({
+      participantJid: 'user@example.com',
+      metaData: [expect.objectContaining({
+        trackId: '3',
+        someProperty: 'value',
+        _trackId: 'trackId123'
+      })],
+      roomId: 'room@conference.example.com',
+      conversationId: 'conv123'
+    });
+  });
 });