anear-js-api 0.3.13 → 0.3.16

package/lib/messaging/AnearMessaging.js

@@ -16,6 +16,7 @@ const EventTransitionMessageType = 'event_transition'
 
 const PRESENCE_ENTER = 'enter'
 const PRESENCE_LEAVE = 'leave'
+const ALREADY_PRESENT = 'present'
 
 // any channel messages sent with 5 secs (5s) of initial attach will be delivered
 // to the subscribers
@@ -97,9 +98,8 @@ class AnearMessaging {
     if (timeoutMsecs > 0) {
       const timer = this.participantTimers[participant.id] || this.createTimer(anearEvent, participant, timeoutMsecs)
 
-      if (timer.isPaused) {
-        timeRemaining = this.timeRemaining
-        timerStarter = () => timer.resume()
+      if (timer.isRunning) {
+        timeRemaining = timer.interrupt()
       } else {
         timerStarter = () => timer.start(timeoutMsecs)
       }
@@ -130,10 +130,10 @@ class AnearMessaging {
     }
   }
 
-  pauseParticipantTimer(participantId) {
+  interruptParticipantTimer(participantId) {
     const timer = this.participantTimers[participantId]
 
-    if (timer && timer.isRunning) timer.pause()
+    if (timer && timer.isRunning) timer.interrupt()
   }
 
   resetParticipantTimer(participantId) {
@@ -441,9 +441,7 @@ class AnearMessaging {
 
     logger.debug(`**** LEAVE PARTICIPANT ****  participantLeaveMessagingCallback(participant: ${participantId})`)
 
-    // pause the participant timer if one was active.   The participant may return shortly
-    // and we can resume this timer.
-    this.pauseParticipantTimer(participantId)
+    this.interruptParticipantTimer(participantId)
   }
 
   async closeParticipant(anearEvent, participantId, callback) {

package/lib/utils/ParticipantTimer.js

@@ -16,39 +16,54 @@ class ParticipantTimer {
   }
   
   start(timeoutMsecs, now = Date.now()) {
-    this.startedAt = now
     logger.debug(`starting ${timeoutMsecs} msec timer for participant ${this.participantId}`)
-    this.runTimer(timeoutMsecs)
+    this.runTimer(now, timeoutMsecs)
   }
 
-  runTimer(timeoutMsecs) {
-    const timerExpired = () => {
-      this.state = Expired
-      this.expireCallback()
-    }
+  timerExpired() {
+    logger.debug(`TIMEOUT!! timer expired for participant ${this.participantId}`)
+    this.state = Expired
+    this.expireCallback()
+  }
+
+  runTimer(now, timeoutMsecs) {
+    this.startedAt = now
+    this.timeRemaining = timeoutMsecs
     this.state = Running
-    this.id = setTimeout(timerExpired, timeoutMsecs)
+    this.id = setTimeout(() => this.timerExpired(), timeoutMsecs)
+  }
+
+  interrupt(now = Date.now()) {
+    // pause the timer to set the timeRemaining and then resume
+    // This is useful when a Participant does a quick LEAVE then rejoins with a REFRESH
+    this.pause(now)
+    this.resume(now)
+
+    return this.timeRemaining
   }
 
   pause(now = Date.now()) {
     // if running, stop the timer
-    if (!this.isRunning) throw new Error("timer not running")
+    this.checkTimerIs(Running)
 
     clearTimeout(this.id)
     this.id = null
-    this.timeRemaining = now - this.startedAt
+    this.timeRemaining -= (now - this.startedAt)
 
     logger.debug(`pausing timer for participant ${this.participantId}. Time remaining: ${this.timeRemaining}`)
     this.state = Paused
   }
 
-  resume() {
+  resume(now = Date.now()) {
     // if paused, restarts the timer with the timeRemaining
-    if (!this.isPaused) throw new Error("timer not paused")
+    this.checkTimerIs(Paused)
 
     if (this.timeRemaining > 0) {
       logger.debug(`resuming ${this.timeRemaining} msec timer for participant ${this.participantId}`)
-      this.runTimer(this.timeRemaining)
+      this.runTimer(now, this.timeRemaining)
+    } else {
+      logger.debug(`resume() detects timeRemaining of ${this.timeRemaining} so is calling timerExpired() for participant ${this.participantId}`)
+      this.timerExpired()
     }
   }
 
@@ -67,6 +82,10 @@ class ParticipantTimer {
     this.startedAt = null
   }
 
+  checkTimerIs(state) {
+    if (this.state !== state) throw new Error(`timer is not ${state}`)
+  }
+
   get isRunning() {
     return this.state === Running
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anear-js-api",
-  "version": "0.3.13",
+  "version": "0.3.16",
   "description": "Javascript Developer API for Anear Apps",
   "main": "lib/index.js",
   "scripts": {

package/tests/ParticipantTimer.test.js

@@ -47,3 +47,20 @@ test('start, pause, then resume', () => {
   jest.advanceTimersByTime(501);
   expect(callback).toHaveBeenCalledTimes(1)
 })
+
+test('start and interrupt multiple times', () => {
+  const callback = jest.fn()
+  const t = new ParticipantTimer(ParticipantId, callback)
+
+  t.start(1000, Now)
+  jest.advanceTimersByTime(500);
+  t.interrupt(Now + 500)
+  expect(t.timeRemaining).toEqual(500)
+  expect(t.isRunning).toBe(true)
+  jest.advanceTimersByTime(250);
+  t.interrupt(Now + 750)
+  expect(t.timeRemaining).toEqual(250)
+  expect(t.isRunning).toBe(true)
+  jest.advanceTimersByTime(501);
+  expect(callback).toHaveBeenCalledTimes(1)
+})