anear-js-api 0.4.3 → 0.4.5

package/lib/api/AnearApi.js

@@ -4,6 +4,10 @@ const ApiService = require('./ApiService')
 
 class AnearApi extends ApiService {
 
+  constructor(apiKey, apiVersion) {
+    super(apiKey, apiVersion)
+  }
+
   async getAccount() {
     logger.debug("API: GET /accounts")
 
@@ -42,14 +46,10 @@ class AnearApi extends ApiService {
     logger.debug(`API: POST transition event ${eventName}`)
 
     const relationships = {event: eventId}
-    try {
-      const json = await this.post("transitions", {event_name: eventName}, relationships)
-      const attrs = json.data.attributes
-      logger.info(`API: newState is ${attrs.state}`)
-      return attrs
-    } catch(err) {
-      logger.error(err)
-    }
+    const json = await this.post("transitions", {event_name: eventName}, relationships)
+    const attrs = json.data.attributes
+    logger.debug(`API: newState is ${attrs.state}`)
+    return attrs
   }
 
   async getEventParticipantJson(participantId, geoLocation) {

package/lib/api/ApiService.js

@@ -1,18 +1,18 @@
 "use strict"
+
 const ErrorResponse = require('./ErrorResponse')
 const qs = require('qs')
 const fetch = require('cross-fetch')
 
-const DeveloperApiURL = "https://api.anearapp.com/developer/v1"
+const DeveloperApiURL = 'https://api.anearapp.com/developer/'
 
 class ApiService {
-
-  constructor() {
-    this.api_base_url = DeveloperApiURL
+  constructor(apiKey, apiVersion) {
+    this.api_base_url = DeveloperApiURL + apiVersion
     this.defaultHeaderObject = {
       'Accept': 'application/json',
       'Content-Type': 'application/json',
-      'X-Api-Key': process.env.ANEARAPP_API_KEY
+      'X-Api-Key': apiKey
     }
     this.default_headers = new fetch.Headers(this.defaultHeaderObject)
   }
@@ -39,12 +39,12 @@ class ApiService {
     )
   }
 
-  async get(resource, params={}) {
+  get(resource, params={}) {
     const request = this.prepareGetRequest(resource, params)
-    return await this.issueRequest(request)
+    return this.issueRequest(request)
   }
 
-  async post(resource, attributes, relationships={}) {
+  post(resource, attributes, relationships={}) {
     const payload = this.formatPayload(resource, attributes, relationships)
     const request = new fetch.Request(
       `${this.api_base_url}/${resource}`, {
@@ -53,10 +53,10 @@ class ApiService {
         body: JSON.stringify(payload)
       }
     )
-    return await this.issueRequest(request)
+    return this.issueRequest(request)
   }
 
-  async put(resource, id, attributes, relationships={}) {
+  put(resource, id, attributes, relationships={}) {
     const payload = this.formatPayload(resource, attributes, relationships)
     const urlString = `${this.api_base_url}/${resource}/${id}`
     const request = new fetch.Request(
@@ -66,10 +66,10 @@ class ApiService {
         body: JSON.stringify(payload)
       }
     )
-    return await this.issueRequest(request)
+    return this.issueRequest(request)
   }
 
-  async httpDelete(resource, id=null) {
+  httpDelete(resource, id=null) {
     const idStr = (id ? `/${id}` : '')
     const urlString = `${this.api_base_url}/${resource}${idStr}`
     const request = new fetch.Request(
@@ -78,12 +78,12 @@ class ApiService {
         headers: this.default_headers
       }
     )
-    return await this.issueRequest(request)
+    return this.issueRequest(request)
   }
 
   async issueRequest(request) {
     const resp = await fetch(request)
-    return await this.checkStatus(resp)
+    return this.checkStatus(resp)
   }
 
   formatPayload(resource, attributes, relationships) {

package/lib/messaging/AnearMessaging.js

@@ -19,15 +19,21 @@ const ALREADY_PRESENT = 'present'
 const ChannelParams = {params: {rewind: "5s"}}
 
 
-const AblyLogLevel = process.env.ANEARAPP_ABLY_LOG_LEVEL || 0 // 0 - no logging, 4 - verbose logging
+// 0 - no logging, 4 - verbose logging
+const AblyLogLevel = process.env.ANEARAPP_ABLY_LOG_LEVEL || 0
+
 const AnearCreateEventChannelName = `anear:${AppId}:e`
 
 class AnearMessaging {
   constructor(AnearEventClass, AnearParticipantClass) {
-    this.api = new AnearApi()
+    this.api = new AnearApi(
+      process.env.ANEARAPP_API_KEY,
+      process.env.ANEARAPP_API_VERSION
+    )
     this.AnearEventClass = AnearEventClass
     this.AnearParticipantClass = AnearParticipantClass
     this.anearEvents = {}
+    this.eventChannels = {}
 
     const baseUrl          = this.api.api_base_url
     const authUrl          = `${baseUrl}/messaging_auth`
@@ -49,8 +55,6 @@ class AnearMessaging {
       }
     }
 
-    this.eventChannels = {}
-
     this.initRealtime(clientOptions)
   }
 
@@ -59,34 +63,35 @@ class AnearMessaging {
 
     this.realtime = new Ably.Realtime(clientOptions)
 
-    this.realtime.connection.on(
-      "connected",
-      async () => {
-        await this.getAppInfo(AppId)
-        logger.info("Ably connected!")
-        await this.setupCreateEventChannel()
-        await this.reloadAnyEventsInProgress(AppId)
-      }
-    )
+    const connectedCallback = async () => {
+      await this.getAppInfo(AppId)
+      logger.debug("Ably connected!")
+      await this.setupCreateEventChannel()
+      await this.reloadAnyEventsInProgress(AppId)
+    }
+
+    this.realtime.connection.on("connected", connectedCallback)
   }
 
   async getAppInfo(appId) {
+    // fetch the App info from the Anear API
     const anearApp = await this.api.getApp(appId)
-    logger.info("================")
-    logger.info(`STARTING APP ${anearApp.data.attributes['short-name']}`)
-    logger.info("================")
+
+    logger.debug("================")
+    logger.debug(`STARTING APP ${anearApp.data.attributes['short-name']}`)
+    logger.debug("================")
   }
 
   getChannel(channelName, channelParams = ChannelParams) {
     return this.realtime.channels.get(channelName, channelParams)
   }
 
-  async getAnearEventFromStorage(eventId) {
-    return await this.AnearEventClass.getFromStorage(eventId, this)
+  getAnearEventFromStorage(eventId) {
+    return this.AnearEventClass.getFromStorage(eventId, this)
   }
 
-  async getAnearParticipantFromStorage(participantId) {
-    return await this.AnearParticipantClass.getFromStorage(participantId, this)
+  getAnearParticipantFromStorage(participantId) {
+    return this.AnearParticipantClass.getFromStorage(participantId, this)
   }
 
   async initEventRealtimeMessaging(anearEvent) {
@@ -98,14 +103,10 @@ class AnearMessaging {
 
     this.eventChannels[anearEvent.id] = {privates: {}}
 
-    try {
-      await this.setupSpectatorsChannel(anearEvent)
-      this.setupEventsChannel(anearEvent)
-      await this.setupParticipantsChannel(anearEvent)
-      await this.setupActionsChannel(anearEvent)
-    } catch(error) {
-      logger.error(`initEventRealtimeMessaging(${anearEvent.id}): `, error)
-    }
+    await this.setupSpectatorsChannel(anearEvent)
+    this.setupEventsChannel(anearEvent)
+    await this.setupParticipantsChannel(anearEvent)
+    await this.setupActionsChannel(anearEvent)
 
     logger.debug(`initEventRealtimeMessaging(${anearEvent.id}) is complete`)
 
@@ -117,76 +118,75 @@ class AnearMessaging {
     // create the AnearEvent subclass, persist it in storage, and
     // initialize its realtime messaging
     //
-    logger.info(`createEventMessagingCallback(${message.name})`)
-
-    try {
-      const eventJson = JSON.parse(message.data)
-      const anearEvent = new this.AnearEventClass(eventJson, this)
-
-      //
-      // if we are getting this event create message from history after a quick restart,
-      // we just return if the event already exists
-      //
-      const eventExists = await anearEvent.exists()
-
-      logger.info(`Event ${anearEvent.id} ${eventExists ? "already exists" : "does not exist"} in Storage`)
-
-      let loadedEvent = anearEvent
-
-      if (!eventExists) {
-        await anearEvent.runExclusive(`createEventCallback ${anearEvent.id}`, 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)
-        })
-      } else {
-        loadedEvent = await this.getAnearEventFromStorage(anearEvent.id)
-        await this.initEventRealtimeMessaging(loadedEvent)
-        loadedEvent.startStateMachine()
-      }
+    logger.debug(`createEventMessagingCallback(${message.name})`)
+
+    const eventJson = JSON.parse(message.data)
+    const anearEvent = new this.AnearEventClass(eventJson, this)
+
+    //
+    // if we are getting this event create message from history after a quick restart,
+    // we just return if the event already exists
+    //
+    const eventExists = await anearEvent.exists()
 
-      logger.info(`New ${loadedEvent.constructor.name} Event: `, loadedEvent.toJSON())
+    logger.debug(
+      `Event ${anearEvent.id} ${eventExists ? "already exists" : "does not exist"} in Storage`
+    )
 
-      this.anearEvents[loadedEvent.id] = loadedEvent
+    let loadedEvent = anearEvent
+
+    if (!eventExists) {
+      const messagingInitializedCallback = async () => {
+        await anearEvent.createdEventCallback()
+        await anearEvent.persist()
+        // start the state machine before initializing 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)
+      }
 
-    } catch(err) {
-      logger.error(err)
+      await anearEvent.runExclusive(
+        `createEventCallback ${anearEvent.id}`,
+        messagingInitializedCallback
+      )
+    } else {
+      loadedEvent = await this.getAnearEventFromStorage(anearEvent.id)
+      await this.initEventRealtimeMessaging(loadedEvent)
+      loadedEvent.startStateMachine()
     }
+
+    logger.debug(`New ${loadedEvent.constructor.name} Event: `, loadedEvent.toJSON())
+
+    this.anearEvents[loadedEvent.id] = loadedEvent
   }
 
   async reloadAnyEventsInProgress(appId) {
-    try {
-      const anearApp = await this.api.getAppZones(appId)
-      for (const zone of anearApp.data.relationships.zones.data) {
-        const zoneEvents = await this.api.getZoneEvents(zone.id)
-        const events = zoneEvents.data.relationships.events.data
-
-        for (const eventData of events) {
-          const eventJson = await this.api.getEvent(eventData.id)
-          const anearEvent = new this.AnearEventClass(eventJson, this)
-          await this.initEventRealtimeMessaging(anearEvent)
-
-          const attachedParticipants = this.getPresentParticipants(anearEvent)
-          // TBD: might want to change the attach and presence logic on
-          // the actions channel.   The Ably docs show subscribing to the
-          // presence events on the actions channel, and instead of using History,
-          // it does a get() to fetch all of the current members.   This behavior
-          // is useful for both event start, and event restart within this function
-          // anearEvent.startStateMachine()
-          //
-        }
+    const anearApp = await this.api.getAppZones(appId)
+
+    for (const zone of anearApp.data.relationships.zones.data) {
+      const zoneEvents = await this.api.getZoneEvents(zone.id)
+      const events = zoneEvents.data.relationships.events.data
+
+      for (const eventData of events) {
+        const eventJson = await this.api.getEvent(eventData.id)
+        const anearEvent = new this.AnearEventClass(eventJson, this)
+        await this.initEventRealtimeMessaging(anearEvent)
+
+        const attachedParticipants = await this.getPresentParticipants(anearEvent)
+        // TBD: might want to change the attach and presence logic on
+        // the actions channel.   The Ably docs show subscribing to the
+        // presence events on the actions channel, and instead of using History,
+        // it does a get() to fetch all of the current members.   This behavior
+        // is useful for both event start, and event restart within this function
+        // anearEvent.startStateMachine()
+        //
       }
-    } catch (err) {
-      logger.error(err)
     }
   }
 
   async setupCreateEventChannel() {
-    logger.info(`attaching to channel ${AnearCreateEventChannelName}`)
+    logger.debug(`attaching to channel ${AnearCreateEventChannelName}`)
 
     const createEventsChannel = this.getChannel(AnearCreateEventChannelName)
 
@@ -232,11 +232,11 @@ class AnearMessaging {
     return members.length
   }
 
-  async getPresentParticipants(anearEvent) {
+  getPresentParticipants(anearEvent) {
     // returns the participant presence data for each member who is present on
     // the event's actions channel
     const channel = this.eventChannels[anearEvent.id].actions
-    return await channel.presence.get()
+    return channel.presence.get() // returns Promise
   }
 
   async setupActionsChannel(anearEvent) {
@@ -333,29 +333,22 @@ class AnearMessaging {
     // check if the participant is already in storage, and if so, instantiate, else
     // instantiate from API response
     //
-    try {
-      const participantJson = await this.api.getEventParticipantJson(participantId)
-      const participant = new this.AnearParticipantClass(participantJson, anearEvent)
+    const participantJson = await this.api.getEventParticipantJson(participantId)
+    const participant = new this.AnearParticipantClass(participantJson, anearEvent)
 
-      const persistedAnearParticipant = await this.AnearParticipantClass.getFromStorage(participantId, anearEvent)
+    const persistedAnearParticipant = await this.AnearParticipantClass.getFromStorage(participantId, anearEvent)
 
-      if (persistedAnearParticipant) {
-        participant.context = persistedAnearParticipant.context
-      }
+    if (persistedAnearParticipant) {
+      participant.context = persistedAnearParticipant.context
+    }
 
-      await anearEvent.runExclusive(`participantEnterCallback ${participant.id}`, async () => {
-        participant.geoLocation = geoLocation
+    await anearEvent.runExclusive(`participantEnterCallback ${participant.id}`, async () => {
+      participant.geoLocation = geoLocation
 
-        await this.setupPrivatePublishingChannel(participant)
-        await anearEvent.participantEnter(participant)
-        await anearEvent.update()
-      })
-    } catch(error) {
-      // participant not found or is not currently marked active at the API service
-      // don't allow participation.  FIX: we need to publish to the private channel
-      // with an error message type.
-      logger.error(`processParticipanEnter(${anearEvent.id}, ${participantId}) error: `, error)
-    }
+      await this.setupPrivatePublishingChannel(participant)
+      await anearEvent.participantEnter(participant)
+      await anearEvent.update()
+    })
   }
 
   async spectatorEnterMessagingCallback(anearEvent, message) {
@@ -458,11 +451,7 @@ class AnearMessaging {
   }
 
   async attachChannel(channel) {
-    try {
-      return await channel.attach()
-    } catch(err) {
-      this.logErrorInfo(err)
-    }
+    return await channel.attach()
   }
 
   subscribeEventMessages(channel, messageType, callback) {
@@ -475,22 +464,18 @@ class AnearMessaging {
   }
 
   async subscribePresenceEventWithHistory(channel, action, callback) {
-    logger.info(`subscribePresenceEvents(${action}) for channel ${channel.name}`)
+    logger.debug(`subscribePresenceEvents(${action}) for channel ${channel.name}`)
 
     this.subscribePresenceEvent(channel, action, callback)
 
-    try {
-      const history = await channel.presence.history({limit: 25})
+    const history = await channel.presence.history({limit: 25})
 
-      history.items.filter(message => message.action === action).forEach(
-        async message => {
-          logger.info(`presence history ${action} event received`, message)
-          await callback(message)
-        }
-      )
-    } catch(err) {
-      logger.error('Unable to get presence history; err = ' + err.message)
-    }
+    history.items.filter(message => message.action === action).forEach(
+      async message => {
+        logger.debug(`presence history ${action} event received`, message)
+        await callback(message)
+      }
+    )
   }
 
   async publishEventSpectatorsMessage(anearEvent, css, message, messageType = PublicDisplayMessageType) {
@@ -596,14 +581,10 @@ class AnearMessaging {
   }
 
   async publishChannelMessage(channel, messageType, payload) {
-    try {
-      await channel.publish(
-        messageType,
-        payload
-      )
-    } catch(err) {
-      this.logErrorInfo(err)
-    }
+    await channel.publish(
+      messageType,
+      payload
+    )
   }
 
   async detachAll(eventId) {
@@ -625,17 +606,13 @@ class AnearMessaging {
   async detachChannel (channel) {
     if (!channel || channel.state !== 'attached') return
 
-    try {
-      await channel.detach(this.logErrorInfo)
-      logger.info(`channel ${channel.name} detached`)
-    } catch(err) {
-      this.logErrorInfo(err)
-    }
+    await channel.detach(this.logErrorInfo)
+    logger.debug(`channel ${channel.name} detached`)
   }
 
   logErrorInfo(errInfo) {
     if (errInfo) {
-      logger.error(`Ably ERROR (${errInfo.code}):  ${errInfo.message}`)
+      logger.error("Ably ERROR:", errInfo)
     }
   }
 }

package/lib/models/AnearEvent.js

@@ -11,6 +11,8 @@ const logger = require('../utils/Logger')
 
 const PrivateDisplayMessageType  = 'private_display'
 
+const PlayableStates = ['closing', 'closed', 'canceled']
+
 class AnearEvent extends JsonApiResource {
 
   constructor(json, messaging) {
@@ -64,7 +66,7 @@ class AnearEvent extends JsonApiResource {
   }
 
   async getClonedEvent() {
-    // if the current event was a clone of previous event, try to fetch if from
+    // if the current event was a clone of previous event, fetch if from
     // Peristence and return
     const clonedEventData = this.relationships["cloned-event"].data
     if (!clonedEventData) return null
@@ -221,13 +223,13 @@ class AnearEvent extends JsonApiResource {
     if (this.participants.exists(participant)) {
       logger.info(`AnearEvent: participant ${participant.id} exists.  Refreshing...`)
 
-      this.participants.add(participant) // update the participants entry
+      this.participants.add(participant) // update the participants record
 
       this.anearStateMachine.sendRefreshEvent({ participant })
 
       await participant.update()
     } else {
-      this.participants.add(participant) // add the participants entry
+      this.participants.add(participant) // add the participants record
 
       this.anearStateMachine.sendJoinEvent({ participant })
 
@@ -271,18 +273,14 @@ class AnearEvent extends JsonApiResource {
     //
     logger.debug(`AnearEvent: transitionEvent(${eventName})`)
 
-    try {
-      const responseAttributes = await this.messaging.api.transitionEvent(this.id, eventName)
-      const newState = responseAttributes.state
-      this.attributes.state = newState
-      await this.messaging.publishEventTransitionMessage(this, newState)
-    } catch(err) {
-      logger.error(`AnearEvent: transitionEvent error: ${err}`)
-    }
+    const responseAttributes = await this.messaging.api.transitionEvent(this.id, eventName)
+    const newState = responseAttributes.state
+    this.attributes.state = newState
+    await this.messaging.publishEventTransitionMessage(this, newState)
   }
 
   isPlayable() {
-    return !['closing', 'closed', 'canceled'].includes(this.eventState)
+    return !PlayableStates.includes(this.eventState)
   }
 
   async transitionToAnnounce() {

package/lib/utils/AnearXstate.js

@@ -11,7 +11,12 @@ const TimeoutEvent = 'TIMEOUT'
 
 class AnearXstate {
   constructor(machineConfig, machineOptions, previousState, anearEventContext) {
-    this.machine = createMachine(machineConfig, machineOptions).withContext(anearEventContext)
+    const config = {predictableActionArguments: true, ...machineConfig}
+
+    this.machine = createMachine(
+      config,
+      machineOptions
+    ).withContext(anearEventContext)
 
     this._currentState = previousState ? State.create(previousState) : this.machine.initialState
     this._currentContext = anearEventContext

package/package.json

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