feat: Adjust setReceiverConstraints to use new format (#1813)

* feat: Adjust setReceiverConstraints to use new format

* add ReceiveVideoController spec

* rename prioritizedSources to onStageSources

* call FeatureFlags.init in specs and update description

* provide a default flags argument to FeatureFlags.init

JitsiMeetJS.js

@@ -146,9 +146,7 @@ export default _mergeNamespaceAndModule({
         Statistics.init(options);
 
         // Configure the feature flags.
-        FeatureFlags.init({
-            sourceNameSignaling: options.sourceNameSignaling
-        });
+        FeatureFlags.init(options.flags || { });
 
         // Initialize global window.connectionTimes
         // FIXME do not use 'window'

modules/qualitycontrol/ReceiveVideoController.js

@@ -2,6 +2,7 @@ import { getLogger } from '@jitsi/logger';
 import isEqual from 'lodash.isequal';
 
 import * as JitsiConferenceEvents from '../../JitsiConferenceEvents';
+import FeatureFlags from '../flags/FeatureFlags';
 
 const logger = getLogger(__filename);
 const MAX_HEIGHT_ONSTAGE = 2160;
@@ -306,6 +307,20 @@ export class ReceiveVideoController {
             this._receiverVideoConstraints = new ReceiverVideoConstraints();
         }
 
+        const isEndpointsFormat = Object.keys(constraints).includes('onStageEndpoints', 'selectedEndpoints');
+        const isSourcesFormat = Object.keys(constraints).includes('onStageSources', 'selectedSources');
+
+        if (!FeatureFlags.isSourceNameSignalingEnabled() && isSourcesFormat) {
+            throw new Error(
+                '"onStageSources" and "selectedSources" are not supported when sourceNameSignaling is disabled.'
+            );
+        }
+
+        if (FeatureFlags.isSourceNameSignalingEnabled() && isEndpointsFormat) {
+            throw new Error(
+                '"onStageEndpoints" and "selectedEndpoints" are not supported when sourceNameSignaling is enabled.'
+            );
+        }
         const constraintsChanged = this._receiverVideoConstraints.updateReceiverVideoConstraints(constraints);
 
         if (constraintsChanged) {

modules/qualitycontrol/ReceiveVideoController.spec.js

@@ -0,0 +1,125 @@
+import FeatureFlags from '../flags/FeatureFlags';
+import Listenable from '../util/Listenable';
+
+import { ReceiveVideoController } from './ReceiveVideoController';
+
+// JSDocs disabled for Mock classes to avoid duplication - check on the original classes for info.
+/* eslint-disable require-jsdoc */
+/**
+ * Mock conference for the purpose of this test file.
+ */
+class MockConference extends Listenable {
+    /**
+     * A constructor...
+     */
+    constructor() {
+        super();
+        this.options = {
+            config: {}
+        };
+
+        this.activeMediaSession = undefined;
+        this.mediaSessions = [];
+    }
+
+    _getMediaSessions() {
+        return this.mediaSessions;
+    }
+}
+
+/**
+ * Mock {@link RTC} - add things as needed, but only things useful for all tests.
+ */
+export class MockRTC extends Listenable {
+    /**
+     * constructor
+     */
+    /* eslint-disable no-useless-constructor */
+    constructor() {
+        super();
+    }
+
+    // eslint-disable-next-line no-empty-function
+    setNewReceiverVideoConstraints() {
+
+    }
+}
+
+/* eslint-enable require-jsdoc */
+describe('ReceiveVideoController', () => {
+    let conference;
+    let rtc;
+    let receiveVideoController;
+
+    beforeEach(() => {
+        conference = new MockConference();
+        rtc = new MockRTC();
+        receiveVideoController = new ReceiveVideoController(conference, rtc);
+    });
+
+    describe('when sourceNameSignaling is enabled', () => {
+        beforeEach(() => {
+            FeatureFlags.init({ sourceNameSignaling: true });
+        });
+
+        it('should call setNewReceiverVideoConstraints with the source names format.', () => {
+            const rtcSpy = spyOn(rtc, 'setNewReceiverVideoConstraints');
+            const constraints = {
+                onStageSources: [ 'A_camera_1', 'B_screen_2', 'C_camera_1' ],
+                selectedSources: [ 'A_camera_1' ]
+            };
+
+            receiveVideoController.setReceiverConstraints(constraints);
+            expect(rtcSpy).toHaveBeenCalledWith(constraints);
+        });
+
+        it('should not allow the endpoints format.', () => {
+            const constraints = {
+                onStageEndpoints: [ 'A', 'B', 'C' ],
+                selectedEndpoints: [ 'A' ]
+            };
+
+            try {
+                receiveVideoController.setReceiverConstraints(constraints);
+                fail();
+            } catch (error) {
+                expect(error).toEqual(new Error(
+                    '"onStageEndpoints" and "selectedEndpoints" are not supported when sourceNameSignaling is enabled.'
+                ));
+            }
+        });
+    });
+
+    describe('when sourceNameSignaling is disabled', () => {
+        beforeEach(() => {
+            FeatureFlags.init({ sourceNameSignaling: false });
+        });
+
+        it('should call setNewReceiverVideoConstraints with the endpoints format.', () => {
+            const rtcSpy = spyOn(rtc, 'setNewReceiverVideoConstraints');
+            const constraints = {
+                onStageEndpoints: [ 'A', 'B', 'C' ],
+                selectedEndpoints: [ 'A' ]
+            };
+
+            receiveVideoController.setReceiverConstraints(constraints);
+            expect(rtcSpy).toHaveBeenCalledWith(constraints);
+        });
+
+        it('should not allow the source names format.', () => {
+            const constraints = {
+                onStageSources: [ 'A_camera_1', 'B_screen_2', 'C_camera_1' ],
+                selectedSources: [ 'A_camera_1' ]
+            };
+
+            try {
+                receiveVideoController.setReceiverConstraints(constraints);
+                fail();
+            } catch (error) {
+                expect(error).toEqual(new Error(
+                    '"onStageSources" and "selectedSources" are not supported when sourceNameSignaling is disabled.'
+                ));
+            }
+        });
+    });
+});