@webex/plugin-meetings 3.0.0-beta.185 → 3.0.0-beta.187

package/test/unit/spec/locus-info/index.js

@@ -3,6 +3,7 @@ import sinon from 'sinon';
 import {cloneDeep} from 'lodash';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
+import testUtils from '../../../utils/testUtils';
 import Meetings from '@webex/plugin-meetings';
 import LocusInfo from '@webex/plugin-meetings/src/locus-info';
 import SelfUtils from '@webex/plugin-meetings/src/locus-info/selfUtils';
@@ -1547,6 +1548,7 @@ describe('plugin-meetings', () => {
           meeting: true,
           participants: true,
           url: 'newLocusUrl',
+          syncUrl: 'newSyncUrl',
         };
       });
 
@@ -1707,39 +1709,82 @@ describe('plugin-meetings', () => {
         assert.calledWith(meeting.locusInfo.onDeltaLocus, fakeLocus);
       });
 
-      it('applyLocusDeltaData gets full locus on DESYNC action', () => {
+      it('applyLocusDeltaData gets delta locus on DESYNC action if we have a syncUrl', () => {
         const {DESYNC} = LocusDeltaParser.loci;
+        const fakeDeltaLocus = {id: 'fake delta locus'};
         const meeting = {
           meetingRequest: {
-            getFullLocus: sandbox.stub().resolves(true),
+            getLocusDTO: sandbox.stub().resolves({body: fakeDeltaLocus}),
           },
           locusInfo: {
+            handleLocusDelta: sandbox.stub(),
+          },
+          locusUrl: 'oldLocusUrl',
+        };
+
+        locusInfo.locusParser.workingCopy = {
+          syncUrl: 'oldSyncUrl',
+        };
+
+        // Since we have a promise inside a function we want to test that's not returned,
+        // we will wait and stub it's last function to resolve this waiting promise.
+        // Also ensures .handleLocusDelta() is called before .resume()
+        return new Promise((resolve) => {
+          locusInfo.locusParser.resume = sandbox.stub().callsFake(() => resolve());
+          locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
+        }).then(() => {
+          assert.calledOnceWithExactly(meeting.meetingRequest.getLocusDTO, { url: 'oldSyncUrl' });
+
+          assert.calledOnceWithExactly(meeting.locusInfo.handleLocusDelta, fakeDeltaLocus, meeting);
+          assert.calledOnce(locusInfo.locusParser.resume);
+        });
+      });
+
+      it('applyLocusDeltaData gets delta locus on DESYNC action if we have a syncUrl (empty response body)', () => {
+        const {DESYNC} = LocusDeltaParser.loci;
+        const meeting = {
+          meetingRequest: {
+            getLocusDTO: sandbox.stub().resolves({body: {}}),
+          },
+          locusInfo: {
+            handleLocusDelta: sandbox.stub(),
             onFullLocus: sandbox.stub(),
           },
           locusUrl: 'oldLocusUrl',
         };
 
-        locusInfo.locusParser.resume = sandbox.stub();
-        locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
+        locusInfo.locusParser.workingCopy = {
+          syncUrl: 'oldSyncUrl',
+        };
 
-        assert.calledOnceWithExactly(meeting.meetingRequest.getFullLocus,
-          {
-            desync: true,
-            locusUrl: 'newLocusUrl',
-          }
-          );
+        // Since we have a promise inside a function we want to test that's not returned,
+        // we will wait and stub it's last function to resolve this waiting promise.
+        return new Promise((resolve) => {
+          locusInfo.locusParser.resume = sandbox.stub().callsFake(() => resolve());
+          locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
+        }).then(() => {
+          assert.calledOnceWithExactly(meeting.meetingRequest.getLocusDTO, { url: 'oldSyncUrl' });
+
+          assert.notCalled(meeting.locusInfo.handleLocusDelta);
+          assert.notCalled(meeting.locusInfo.onFullLocus);
+          assert.calledOnce(locusInfo.locusParser.resume);
+        });
       });
 
-      it('getFullLocus handles DESYNC action correctly', () => {
+      it('applyLocusDeltaData gets full locus on DESYNC action if we do not have a syncUrl', () => {
         const {DESYNC} = LocusDeltaParser.loci;
+        const fakeFullLocusDto = {id: 'fake full locus dto'};
         const meeting = {
           meetingRequest: {
-            getFullLocus: sandbox.stub().resolves({body: true}),
+            getLocusDTO: sandbox.stub().resolves({body: fakeFullLocusDto}),
+          },
+          locusInfo: {
+            onFullLocus: sandbox.stub(),
           },
-          locusInfo,
+          locusUrl: 'oldLocusUrl',
         };
 
-        locusInfo.onFullLocus = sandbox.stub();
+        locusInfo.locusParser.workingCopy = {}; // no syncUrl
 
         // Since we have a promise inside a function we want to test that's not returned,
         // we will wait and stub it's last function to resolve this waiting promise.
@@ -1748,7 +1793,9 @@ describe('plugin-meetings', () => {
           locusInfo.locusParser.resume = sandbox.stub().callsFake(() => resolve());
           locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
         }).then(() => {
-          assert.calledOnce(meeting.locusInfo.onFullLocus);
+          assert.calledOnceWithExactly(meeting.meetingRequest.getLocusDTO, { url: 'oldLocusUrl' });
+
+          assert.calledOnceWithExactly(meeting.locusInfo.onFullLocus, fakeFullLocusDto);
           assert.calledOnce(locusInfo.locusParser.resume);
         });
       });
@@ -2083,5 +2130,295 @@ describe('plugin-meetings', () => {
         });
       });
     });
+
+    // semi-integration tests that use real LocusInfo with real Parser
+    // and test various scenarios related to handling out-of-order Locus delta events 
+    describe('handling of out-of-order Locus delta events', () => {
+      let clock;
+
+      const generateDeltaEvent = (base, sequence) => {
+        return {
+          baseSequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [base]
+          },
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [sequence]
+          },
+          syncUrl: `fake sync url for sequence ${sequence}`,
+          self: {
+            person: {
+              id: 'test person id'
+            }
+          },
+        }
+      };
+
+      // a list of example delta events, sorted by time and each event is based on the previous one
+      const deltaEvents = [
+        generateDeltaEvent(10, 20), // 0
+        generateDeltaEvent(20, 30), // 1
+        generateDeltaEvent(30, 40), // 2
+        generateDeltaEvent(40, 50), // 3
+        generateDeltaEvent(50, 60), // 4
+        generateDeltaEvent(60, 70), // 5
+        generateDeltaEvent(70, 80), // 6
+        generateDeltaEvent(80, 90), // 7
+        generateDeltaEvent(90, 100), // 8
+      ];
+
+      let updateLocusInfoStub; // we use this stub to verify that an event has been fully processed
+      let syncRequestStub;
+
+      beforeEach(() => {
+        clock = sinon.useFakeTimers();
+
+        sinon.stub(locusInfo, 'updateParticipantDeltas');
+        sinon.stub(locusInfo, 'updateParticipants');
+        sinon.stub(locusInfo, 'isMeetingActive'),
+        sinon.stub(locusInfo, 'handleOneOnOneEvent'),
+
+        updateLocusInfoStub = sinon.stub(locusInfo, 'updateLocusInfo');
+        syncRequestStub = sinon.stub().resolves({body: {}});
+
+        mockMeeting.locusInfo = locusInfo;
+        mockMeeting.locusUrl = 'fake locus url';
+        mockMeeting.meetingRequest = {
+          getLocusDTO: syncRequestStub,
+        };
+
+        locusInfo.onFullLocus({
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [10]
+          },
+          self: {
+            person: {
+              id: 'test person id'
+            }
+          },
+        });
+
+        updateLocusInfoStub.resetHistory();
+      });
+
+      afterEach(() => {
+        clock.restore();
+      });
+
+      it('queues out-of-order deltas until it receives a correct delta', () => {
+        // send some out-of-order deltas
+        locusInfo.handleLocusDelta(deltaEvents[1], mockMeeting);
+        locusInfo.handleLocusDelta(deltaEvents[4], mockMeeting);
+
+        // they should be queued and not processed
+        assert.notCalled(updateLocusInfoStub); 
+
+        // now one of the missing ones, but not the one SDK is really waiting for
+        locusInfo.handleLocusDelta(deltaEvents[2], mockMeeting);
+
+        // still nothing should be processed
+        assert.notCalled(updateLocusInfoStub);
+
+        // now send the one SDK is waiting for
+        locusInfo.handleLocusDelta(deltaEvents[0], mockMeeting);
+
+        // so deltaEvents with indexes 1,2,3 can be processed, but 5 still not, because 4 is missing
+        assert.callCount(updateLocusInfoStub, 3);        
+        assert.calledWith(updateLocusInfoStub.getCall(0), deltaEvents[0]);
+        assert.calledWith(updateLocusInfoStub.getCall(1), deltaEvents[1]);
+        assert.calledWith(updateLocusInfoStub.getCall(2), deltaEvents[2]);
+
+        updateLocusInfoStub.resetHistory();
+        
+        // now send deltaEvents[4]
+        locusInfo.handleLocusDelta(deltaEvents[3], mockMeeting);
+
+        // and verify deltaEvents[4] and deltaEvents[5] have been processed
+        assert.callCount(updateLocusInfoStub, 2);
+        assert.calledWith(updateLocusInfoStub.getCall(0), deltaEvents[3]);
+        assert.calledWith(updateLocusInfoStub.getCall(1), deltaEvents[4]);
+      });
+
+      it('handles out-of-order deltas correctly even if all arrive in reverse order', () => {
+        // send a bunch deltas in reverse order
+        for(let i = 4; i >= 0; i--) {
+          locusInfo.handleLocusDelta(deltaEvents[i], mockMeeting);
+        }
+
+        // they should be queued and then processed in correct order
+        assert.callCount(updateLocusInfoStub, 5);        
+        assert.calledWith(updateLocusInfoStub.getCall(0), deltaEvents[0]);
+        assert.calledWith(updateLocusInfoStub.getCall(1), deltaEvents[1]);
+        assert.calledWith(updateLocusInfoStub.getCall(2), deltaEvents[2]);
+        assert.calledWith(updateLocusInfoStub.getCall(3), deltaEvents[3]);
+        assert.calledWith(updateLocusInfoStub.getCall(4), deltaEvents[4]);
+      });
+
+      it('sends a sync request using syncUrl if it receives at least 1 delta event and processes later deltas after sync correctly', async () => {
+        // the test first sends an initial "good" delta
+        const initialDeltaIdx = 0;
+        const initialDelta = deltaEvents[initialDeltaIdx];
+
+        // then it sends a bunch of out-of-order deltas (at least 6 to trigger a sync), last one being lastOooDelta
+        const firstOooDeltaIdx = 2;
+        const lastOooDeltaIdx = 7;
+        const lastOooDelta = deltaEvents[lastOooDeltaIdx];
+
+        // and finally, after the sync it sends another "good" delta
+        const goodDeltaAfterSync = deltaEvents[8];
+
+        const deltaLocusFromSyncResponse = {
+          baseSequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [initialDelta.sequence.entries[0]]
+          },
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [lastOooDelta.sequence.entries[0]]
+          },
+          syncUrl: `fake sync url for sequence ${lastOooDelta.sequence.entries[0]}`,
+          self: {
+            person: {
+              id: 'test person id'
+            }
+          },
+        };
+        
+        syncRequestStub.resolves({
+          body: deltaLocusFromSyncResponse
+        });
+        
+        // send one correct delta so that SDK has the syncUrl
+        locusInfo.handleLocusDelta(initialDelta, mockMeeting);
+
+        updateLocusInfoStub.resetHistory();
+        
+        // send 6 out-of-order deltas to trigger a sync (we're skipping deltaEvents[1])
+        for(let i = firstOooDeltaIdx; i <= lastOooDeltaIdx; i++) {
+          locusInfo.handleLocusDelta(deltaEvents[i], mockMeeting);
+        }
+
+        await testUtils.flushPromises();
+
+        // check that sync was done using the correct syncUrl
+        assert.calledOnceWithExactly(syncRequestStub, {url: initialDelta.syncUrl});
+        assert.calledOnceWithExactly(updateLocusInfoStub, deltaLocusFromSyncResponse);
+
+        updateLocusInfoStub.resetHistory();
+
+        // now send another delta - a good one, it should be processed as normal
+        locusInfo.handleLocusDelta(goodDeltaAfterSync, mockMeeting);
+
+        assert.calledOnceWithExactly(updateLocusInfoStub, goodDeltaAfterSync);
+      });
+
+      it('does a sync if blocked on out-of-order deltas for too long', async () => {
+        // stub random so that the timer fires after 12500 ms
+        sinon.stub(Math, 'random').returns(0.5);
+
+        const oooDelta = deltaEvents[3];
+        
+        // setup the stubs so that the sync request receives a full DTO with the sequence equal to the out-of-order delta we simulate
+        const fullLocus = {
+          sequence: oooDelta.sequence
+        };
+        syncRequestStub.resolves({
+          body: fullLocus
+        });
+
+        // send an out-of-order delta
+        locusInfo.handleLocusDelta(oooDelta, mockMeeting);
+
+        await clock.tickAsync(12499);
+        await testUtils.flushPromises();
+        assert.notCalled(syncRequestStub);
+        assert.notCalled(updateLocusInfoStub);
+
+        await clock.tickAsync(1);
+        await testUtils.flushPromises();
+
+        assert.calledOnceWithExactly(syncRequestStub, {url: mockMeeting.locusUrl});
+        assert.calledOnceWithExactly(updateLocusInfoStub, fullLocus);
+      });
+
+      it('does a sync if out-of-order deltas queue becomes too big', async () => {        
+        // setup the stubs so that the sync request receives a full DTO with the sequence equal to the out-of-order delta we simulate
+        const fullLocus = {
+          sequence: deltaEvents[6].sequence
+        };
+        syncRequestStub.resolves({
+          body: fullLocus
+        });
+
+        // send 5 deltas, starting from deltaEvents[1] so that SDK is blocked waiting for deltaEvents[0]
+        for(let i = 0; i < 5; i++) {
+          locusInfo.handleLocusDelta(deltaEvents[i + 1], mockMeeting);
+        }
+
+        // nothing should happen, SDK should still be waiting for deltaEvents[0]
+        assert.notCalled(syncRequestStub);
+        assert.notCalled(updateLocusInfoStub);
+
+        // now send one more out-of-order delta to trigger a sync request
+        locusInfo.handleLocusDelta(deltaEvents[6], mockMeeting);
+
+        await testUtils.flushPromises();
+
+        // check sync was done
+        assert.calledOnceWithExactly(syncRequestStub, {url: mockMeeting.locusUrl});
+        assert.calledOnceWithExactly(updateLocusInfoStub, fullLocus);
+      });
+
+      it('processes delta events that are not included in sync response', async () => {
+        // this test sends a bunch of out-of-order deltas, this triggers a sync
+        // but the full locus response doesn't include the last 2 deltas received, so 
+        // we check that these 2 deltas are also processed after sync response
+        const fullLocusFromSyncResponse = {
+          baseSequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [deltaEvents[0].sequence.entries[0]]
+          },
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+            entries: [deltaEvents[5].sequence.entries[0]]
+          },
+          syncUrl: `fake sync url for sequence ${deltaEvents[5].sequence.entries[0]}`,
+          self: {
+            person: {
+              id: 'test person id'
+            }
+          },
+        };
+        
+        syncRequestStub.resolves({
+          body: fullLocusFromSyncResponse
+        });
+        
+        // send at least 6 out-of-order deltas to trigger a sync (we're skipping deltaEvents[0])
+        for(let i = 1; i <= 7; i++) {
+          locusInfo.handleLocusDelta(deltaEvents[i], mockMeeting);
+        }
+
+        await testUtils.flushPromises();
+
+        // check that sync was done
+        assert.calledOnceWithExactly(syncRequestStub, {url: mockMeeting.locusUrl});
+        
+        // and that remaining deltas from the queue that were not included in full Locus were also processed
+        assert.callCount(updateLocusInfoStub, 3);
+        assert.calledWith(updateLocusInfoStub.getCall(0), fullLocusFromSyncResponse);
+        assert.calledWith(updateLocusInfoStub.getCall(1), deltaEvents[6]);
+        assert.calledWith(updateLocusInfoStub.getCall(2), deltaEvents[7]);
+      });
+    });
   });
 });

package/test/unit/spec/locus-info/parser.js

@@ -334,27 +334,5 @@ describe('locus-info/parser', () => {
 
       assert.isFalse(result);
     });
-
-    it('sets parser status to IDLE if workingCopy is invalid', () => {
-      const {IDLE, WORKING} = LocusDeltaParser.status;
-
-      parser.workingCopy = null;
-      parser.status = WORKING;
-
-      parser.isValidLocus(loci);
-
-      assert.equal(parser.status, IDLE);
-    });
-
-    it('sets parser status to IDLE if new loci is invalid', () => {
-      const {IDLE, WORKING} = LocusDeltaParser.status;
-
-      parser.workingCopy = loci;
-      parser.status = WORKING;
-
-      parser.isValidLocus(null);
-
-      assert.equal(parser.status, IDLE);
-    });
   });
 });

package/test/unit/spec/meeting/muteState.js

@@ -37,7 +37,7 @@ describe('plugin-meetings', () => {
       unmuteVideoAllowed: true,
 
       locusInfo: {
-        onDeltaLocus: sinon.stub(),
+        handleLocusDelta: sinon.stub(),
       },
       members: {
         selfId: 'fake self id',

package/test/unit/spec/meeting/utils.js

@@ -179,10 +179,10 @@ describe('plugin-meetings', () => {
     });
 
     describe('updateLocusWithDelta', () => {
-      it('should call onDeltaLocus with the new delta locus', () => {
+      it('should call handleLocusDelta with the new delta locus', () => {
         const meeting = {
           locusInfo: {
-            onDeltaLocus: sinon.stub()
+            handleLocusDelta: sinon.stub()
           },
         };
 
@@ -195,13 +195,13 @@ describe('plugin-meetings', () => {
         const response = MeetingUtil.updateLocusWithDelta(meeting, originalResponse);
 
         assert.deepEqual(response, originalResponse);
-        assert.calledOnceWithExactly(meeting.locusInfo.onDeltaLocus, 'locus');
+        assert.calledOnceWithExactly(meeting.locusInfo.handleLocusDelta, 'locus', meeting);
       });
 
       it('should handle locus being missing from the response', () => {
         const meeting = {
           locusInfo: {
-            onDeltaLocus: sinon.stub(),
+            handleLocusDelta: sinon.stub(),
           },
         };
 
@@ -212,7 +212,7 @@ describe('plugin-meetings', () => {
         const response = MeetingUtil.updateLocusWithDelta(meeting, originalResponse);
 
         assert.deepEqual(response, originalResponse);
-        assert.notCalled(meeting.locusInfo.onDeltaLocus);
+        assert.notCalled(meeting.locusInfo.handleLocusDelta);
       });
 
       it('should work with an undefined meeting', () => {