anear-js-api 0.3.2 → 0.3.5

package/lib/messaging/AnearMessaging.js

@@ -31,7 +31,7 @@ class AnearMessaging {
     this.AnearEventClass = AnearEventClass
     this.AnearParticipantClass = AnearParticipantClass
     this.mutex = new Mutex()
-
+    this.anearEvents = {}
 
     const baseUrl          = this.api.api_base_url
     const authUrl          = `${baseUrl}/messaging_auth`
@@ -49,7 +49,7 @@ class AnearMessaging {
       echoMessages: false,
       log: {
         level: AblyLogLevel,
-        handler: (message) => {logger.debug(message)}
+        handler: message => {logger.debug(message)}
       }
     }
 
@@ -94,34 +94,26 @@ class AnearMessaging {
     }
   }
 
-  setParticipantTimer(eventId, participant, timeoutMilliseconds) {
+  setParticipantTimer(anearEvent, participant, timeoutMilliseconds) {
     const participantId = participant.id
 
     this.clearParticipantTimer(participantId)
 
     if (timeoutMilliseconds === 0) return
 
-    logger.debug(`setting ${timeoutMilliseconds} msec timer for event ${eventId}, participant ${participant.id}`)
+    logger.debug(`setting ${timeoutMilliseconds} msec timer for event ${anearEvent.id}, participant ${participant.id}`)
 
     this.participantTimers[participantId] = setTimeout(
-      async () => await this.timerExpired(eventId, participant, timeoutMilliseconds),
+      async () => await this.timerExpired(anearEvent, participant, timeoutMilliseconds),
       timeoutMilliseconds
     )
   }
 
-  async timerExpired(eventId, participant, timeoutMilliseconds) {
-    const participantId = participant.id
-
-    logger.debug(`participant (${eventId}, ${participantId}) TIMED OUT after ${timeoutMilliseconds} msecs`)
+  async timerExpired(anearEvent, participant, timeoutMilliseconds) {
+    logger.debug(`participant (${anearEvent.id}, ${participant.id}) TIMED OUT after ${timeoutMilliseconds} msecs`)
 
-    await this.getAnearEventWithLockFromStorage(
-      eventId,
-      async anearEvent => {
-        const participant = await this.getAnearParticipantFromStorage(participantId)
-        await anearEvent.participantTimedOut(participant)
-        await anearEvent.update()
-      }
-    )
+    await anearEvent.participantTimedOut(participant)
+    await anearEvent.update()
   }
 
   async getAnearEventFromStorage(eventId) {
@@ -171,6 +163,7 @@ class AnearMessaging {
       // we just return if the event already exists
       //
       await this.loadOrPersistEventAndInitialize(anearEvent)
+
     } catch(err) {
       logger.error(err)
     }
@@ -187,6 +180,9 @@ class AnearMessaging {
       await this.runExclusive("createEventCallback", async () => {
         await anearEvent.createdEventCallback()
         await anearEvent.persist()
+        // start the state machine before initialiing Realtime Messaging
+        // as REFRESH events come in and the state machine should be ready
+        // to handle those XState events
         anearEvent.startStateMachine()
         await this.initEventRealtimeMessaging(anearEvent)
       })
@@ -198,6 +194,8 @@ class AnearMessaging {
 
     logger.info(`New ${loadedEvent.constructor.name} Event: `, loadedEvent.toJSON())
 
+    this.anearEvents[loadedEvent.id] = loadedEvent
+
     return loadedEvent
   }
 
@@ -211,6 +209,9 @@ class AnearMessaging {
         for (const eventData of events) {
           const eventJson = await this.api.getEvent(eventData.id)
           const anearEvent = new this.AnearEventClass(eventJson, this)
+          // THIS does NOT work yet.  This is logic that restarte events in progress
+          // if the nodeJS process crahsed during play
+          //
           // const loadedEvent = await this.loadOrPersistEventAndInitialize(anearEvent)
           // await this.refreshActiveParticipants(loadedEvent) DOES NOT WORK YET
         }
@@ -402,7 +403,9 @@ class AnearMessaging {
     // this can be just a temporary leave (refresh browser for example), so we don't do anything
     // for now
     const userId = message.clientId
-    logger.debug(`**** LEAVE PARTICIPANT ****  participantLeaveMessagingCallback(user: ${userId})`)
+    const participantId = message.data.participantId
+
+    logger.debug(`**** LEAVE PARTICIPANT ****  participantLeaveMessagingCallback(user: ${participantId})`)
   }
 
   async closeParticipant(anearEvent, participantId, callback) {
@@ -431,6 +434,7 @@ class AnearMessaging {
       delete this.eventChannels[eventId].privates[userId]
     }
   }
+
   async participantActionMessagingCallback(anearEvent, message) {
     // e.g. message.data
     //   {
@@ -460,10 +464,9 @@ class AnearMessaging {
     })
   }
 
-  async eventBroadcastMessagingCallback(eventId, message) {
-    logger.debug(`eventBroadcaseMessagingCallback(${eventId}`)
+  async eventBroadcastMessagingCallback(anearEvent, message) {
+    logger.debug(`eventBroadcaseMessagingCallback(${anearEvent.id}`)
 
-    const anearEvent = await this.getAnearEventFromStorage(eventId)
     await anearEvent.eventBroadcast(message)
     await anearEvent.update()
   }
@@ -524,7 +527,8 @@ class AnearMessaging {
     }
   }
 
-  async publishEventParticipantsMessage(eventId, participants, css, message, timeoutMilliseconds=0, timeoutCallback=null) {
+  async publishEventParticipantsMessage(anearEvent, participants, css, message, timeoutMilliseconds=0, timeoutCallback=null) {
+    const eventId = anearEvent.id
     const channel = this.eventChannels[eventId].participants
 
     const setTimerFunction = () => this.setMultipleParticipantTimers(eventId, participants, timeoutMilliseconds)
@@ -540,16 +544,16 @@ class AnearMessaging {
     )
   }
 
-  setMultipleParticipantTimers(eventId, participants, timeoutMilliseconds) {
+  setMultipleParticipantTimers(anearEvent, participants, timeoutMilliseconds) {
     if (timeoutMilliseconds === 0) return
 
     participants.forEach(
-      participant => this.setParticipantTimer(eventId, participant, timeoutMilliseconds)
+      participant => this.setParticipantTimer(anearEvent, participant, timeoutMilliseconds)
     )
   }
 
-  async publishEventSpectatorsMessage(eventId, css, message, messageType = PublicDisplayMessageType) {
-    const channel = this.eventChannels[eventId].spectators
+  async publishEventSpectatorsMessage(anearEvent, css, message, messageType = PublicDisplayMessageType) {
+    const channel = this.eventChannels[anearEvent.id].spectators
     const payload = {
       css: css,
       content: message
@@ -559,7 +563,7 @@ class AnearMessaging {
   }
 
   async publishEventPrivateMessage(
-          eventId,
+          anearEvent,
           participant,
           messageType,
           css,
@@ -568,10 +572,10 @@ class AnearMessaging {
           timeoutCallback=null) {
 
     const userId = participant.userId
-    const channel = this.eventChannels[eventId].privates[userId]
+    const channel = this.eventChannels[anearEvent.id].privates[userId]
     if (!channel) throw new Error(`private channel not found.  invalid user id ${userId}`)
 
-    const setTimerFunction = () => this.setParticipantTimer(eventId, participant, timeoutMilliseconds)
+    const setTimerFunction = () => this.setParticipantTimer(anearEvent, participant, timeoutMilliseconds)
 
     await this.publishChannelMessageWithTimeout(
       channel,
@@ -612,11 +616,11 @@ class AnearMessaging {
     await timerCallback()
   }
 
-  async publishEventTransitionMessage(eventId, newState) {
-    const channel = this.eventChannels[eventId].events
+  async publishEventTransitionMessage(anearEvent, newState) {
+    const channel = this.eventChannels[anearEvent.id].events
     const payload = {content: {state: newState}}
 
-    logger.debug(`publishEventTransitionMessage: event ${eventId} transitioning to ${newState}`)
+    logger.debug(`publishEventTransitionMessage: event ${anearEvent.id} transitioning to ${newState}`)
 
     await this.publishChannelMessage(channel, EventTransitionMessageType, payload)
   }
@@ -644,6 +648,8 @@ class AnearMessaging {
       await this.detachChannel(channel)
     }
     delete this.eventChannels[eventId]
+
+    delete this.anearEvents[eventId]
   }
 
   async detachChannel (channel) {

package/lib/models/AnearEvent.js

@@ -165,7 +165,7 @@ class AnearEvent extends JsonApiResource {
 
   async publishEventParticipantsMessage(message, timeoutMilliseconds=0, timeoutCallback=null) {
     await this.messaging.publishEventParticipantsMessage(
-      this.id,
+      this,
       this.activeParticipants,
       this.css,
       message,
@@ -175,12 +175,12 @@ class AnearEvent extends JsonApiResource {
   }
 
   async publishEventSpectatorsMessage(message) {
-    await this.messaging.publishEventSpectatorsMessage(this.id, this.css, message)
+    await this.messaging.publishEventSpectatorsMessage(this, this.css, message)
   }
 
   async publishEventPrivateMessage(participant, message, timeoutMilliseconds=0, timeoutCallback=null) {
     await this.messaging.publishEventPrivateMessage(
-      this.id,
+      this,
       participant,
       PrivateDisplayMessageType,
       this.css,
@@ -192,7 +192,7 @@ class AnearEvent extends JsonApiResource {
 
   async publishEventTransitionMessage(newState) {
     await this.messaging.publishEventTransitionMessage(
-      this.id,
+      this,
       newState
     )
   }
@@ -207,13 +207,13 @@ class AnearEvent extends JsonApiResource {
 
       this.participants.add(this, participant) // update the participants entry
 
-      this.anearStateMachine.sendRefreshEvent({participant: participant})
+      this.anearStateMachine.sendRefreshEvent({ participant })
 
       await participant.update()
     } else {
       this.participants.add(this, participant) // add the participants entry
 
-      this.anearStateMachine.sendJoinEvent({participant: participant})
+      this.anearStateMachine.sendJoinEvent({ participant })
 
       await participant.persist()
     }
@@ -252,9 +252,9 @@ class AnearEvent extends JsonApiResource {
     logger.debug(`AnearEvent: transitionEvent(${eventName})`)
 
     try {
-      const responseAttributes = await this.messaging.api.transitionEvent(this.id, eventName)
+      const responseAttributes = await this.messaging.api.transitionEvent(this, eventName)
       const newState = responseAttributes.state
-      await this.messaging.publishEventTransitionMessage(this.id, newState)
+      await this.messaging.publishEventTransitionMessage(this, newState)
     } catch(err) {
       logger.error(`AnearEvent: transitionEvent error: ${err}`)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anear-js-api",
-  "version": "0.3.2",
+  "version": "0.3.5",
   "description": "Javascript Developer API for Anear Apps",
   "main": "lib/index.js",
   "scripts": {
@@ -17,7 +17,7 @@
   },
   "homepage": "https://github.com/machvee/anear-js-api#readme",
   "dependencies": {
-    "ably": "^1.2.15",
+    "ably": "^1.2.18",
     "async-mutex": "^0.3.2",
     "async-redis": "^2.0.0",
     "cross-fetch": "^3.1.5",