fix: disordered event sequence issue (#34)

* fix: disordered event sequence issue * chore: remove unused code * chore: lint issue * chore: add tests * feat: clear session when drop session with 404 * fix: use partyId as event sequence key * chore: demo loading issue
ringcentral · Dec 7, 2021 · f5226cf · f5226cf
1 parent 88f13e8
commit f5226cf
Show file tree

Hide file tree

Showing 8 changed files with 248 additions and 97 deletions.
diff --git a/demo/index.js b/demo/index.js
@@ -84,7 +84,7 @@ $(function() {
           refreshCallList();
         });
       });
-      $('.modal').modal('hide');
+      $loadingModal.modal('hide');
     }
     if (rcCallControl.ready) {
       onInitializedEvent();

diff --git a/demo/redirect.html b/demo/redirect.html
@@ -13,7 +13,6 @@
 <body>
 <p>Loading</p>
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/es6-promise/3.2.2/es6-promise.js"></script>
-<script type="text/javascript" src="https://cdn.pubnub.com/sdk/javascript/pubnub.4.20.1.js"></script>
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/fetch/0.11.1/fetch.js"></script>
 <script type="text/javascript" src="https://unpkg.com/@ringcentral/sdk@latest/dist/ringcentral.js"></script>
 <script>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ringcentral-call-control",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "main": "lib/index.js",
   "license": "MIT",
   "repository": {

diff --git a/src/Session.ts b/src/Session.ts
@@ -68,7 +68,6 @@ export interface SessionData {
   sessionId: string;
   creationTime: string;
   voiceCallToken?: string;
-  sequence?: number;
   origin: Origin;
 }
 
@@ -202,36 +201,16 @@ function diffParties(oldParties: Party[], updatedParties: Party[]) {
 
 export class Session extends EventEmitter {
   private _data: any;
-  private _eventPartySequences: any;
   private _sdk: RingCentralSDK;
   private _accountLevel: boolean;
   private _userAgent: string;
 
   constructor(rawData: SessionData, sdk: RingCentralSDK, accountLevel: boolean, userAgent?: string) {
     super();
-    const { sequence, ...data } = rawData;
-    this._data = data;
-    this._eventPartySequences = {};
+    this._data = { ...rawData };
     this._sdk = sdk;
     this._accountLevel = !!accountLevel;
     this._userAgent = userAgent;
-
-    this._updatePartiesSequence(this._data.parties, sequence);
-
-    this.on('status', ({ party }) => {
-      this._onPartyUpdated(party);
-    });
-  }
-
-  _updatePartiesSequence(parties: Party[] = [], sequence?: Number) {
-    if (!sequence) {
-      return;
-    }
-    parties.forEach((party) => {
-      if (!this._eventPartySequences[party.id] || this._eventPartySequences[party.id] < sequence) {
-        this._eventPartySequences[party.id] = sequence;
-      }
-    });
   }
 
   public onUpdated(data: SessionData) {
@@ -242,10 +221,6 @@ export class Session extends EventEmitter {
         this.emit('status', { party: diff.party });
         return;
       }
-      const lastSequence = this._eventPartySequences[diff.party.id]
-      if (lastSequence && data.sequence < lastSequence) {
-        return;
-      }
       if (diff.type === 'update') {
         const oldPartyIndex = this.parties.findIndex(p => p.id === diff.party.id);
         const parties = this.parties.slice(0);
@@ -260,16 +235,6 @@ export class Session extends EventEmitter {
         return;
       }
     });
-    this._updatePartiesSequence(data.parties, data.sequence);
-  }
-
-  _onPartyUpdated(party) {
-    if (
-      party.status.code === PartyStatusCode.disconnected &&
-      party.status.reason === 'Pickup'
-    ) {
-      this._data.parties = this.parties.filter(p => p.id !== party.id);
-    }
   }
 
   public restore(data: SessionData) {
@@ -369,11 +334,28 @@ export class Session extends EventEmitter {
   }
 
   async drop() {
-    await this._sdk.platform().delete(
-      `/restapi/v1.0/account/~/telephony/sessions/${this._data.id}`,
-      null,
-      this.requestOptions
-    );
+    try {
+      await this._sdk.platform().delete(
+        `/restapi/v1.0/account/~/telephony/sessions/${this._data.id}`,
+        null,
+        this.requestOptions
+      );
+    } catch (e) {
+      if (e && e.response && e.response.status === 404) {
+        // Force drop session at client side
+        const disconnectedParty = {
+          ...this.party,
+          status: {
+            ...this.party.status,
+            code: PartyStatusCode.disconnected,
+          },
+        };
+        this.saveNewPartyData(disconnectedParty);
+        this.emit('status', { party: this.party });
+        return;
+      }
+      throw e;
+    }
   }
 
   private saveNewPartyData(rawParty) {

diff --git a/src/index.ts b/src/index.ts
@@ -35,6 +35,16 @@ export interface Device {
   lastLocationReportTime: string;
 }
 
+export interface EventSequenceData {
+  sequence: number;
+  updatedAt: number;
+  telephonySessionId: string;
+}
+
+export interface EventSequenceMap {
+  [key: string]: EventSequenceData;
+}
+
 export interface Account {
   id: string;
 }
@@ -78,6 +88,7 @@ export class RingCentralCallControl extends EventEmitter {
   private _preloadSessions: boolean;
   private _preloadDevices: boolean;
   private _userAgent: string;
+  private _eventSequenceMap: EventSequenceMap = {};
 
   constructor({
     sdk,
@@ -141,6 +152,10 @@ export class RingCentralCallControl extends EventEmitter {
     if (!telephonySessionId) {
       return;
     }
+    const validatedSequence = this.checkSequence(message.body);
+    if (!validatedSequence) {
+      return;
+    }
     const existedSession = this._sessionsMap.get(telephonySessionId);
     newData.id = telephonySessionId;
     newData.extensionId = this.extensionId;
@@ -179,6 +194,33 @@ export class RingCentralCallControl extends EventEmitter {
     }
   }
 
+  private checkSequence({ sequence, telephonySessionId, parties }) {
+    let result = true;
+    const partyId = parties[0] && parties[0].id;
+    const eventSequenceData = this._eventSequenceMap[partyId];
+    if (eventSequenceData && eventSequenceData.sequence > sequence) {
+      result = false;
+    } else {
+      this._eventSequenceMap[partyId] = {
+        sequence,
+        telephonySessionId,
+        updatedAt: Date.now(),
+      };
+    }
+    this.cleanExpiredSequenceData();
+    return result;
+  }
+
+  private cleanExpiredSequenceData() {
+    Object.keys(this._eventSequenceMap).forEach((partyId) => {
+      const eventSequenceData = this._eventSequenceMap[partyId];
+      const existedSession = this._sessionsMap.get(eventSequenceData.telephonySessionId);
+      if (!existedSession && eventSequenceData.updatedAt + 60000 < Date.now()) {
+        delete this._eventSequenceMap[partyId];
+      }
+    });
+  }
+
   get sessions(): Session[] {
     return Array.from(this._sessionsMap.values());
   }
@@ -193,7 +235,7 @@ export class RingCentralCallControl extends EventEmitter {
         await this._sdk.platform().get('/restapi/v1.0/account/~/extension/~', null, this.requestOptions);
       this._currentExtension = await response.json();
     } catch (e) {
-      console.error('Fetch presence error', e);
+      console.error('Fetch extension info error', e);
     }
   }
 
@@ -376,4 +418,8 @@ export class RingCentralCallControl extends EventEmitter {
       userAgent: this._userAgent ? `${this._userAgent} ${USER_AGENT}` : USER_AGENT,
     };
   }
+
+  get eventSequenceMap() {
+    return this._eventSequenceMap;
+  }
 }