@dazn/kopytko-framework 1.4.1 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dazn/kopytko-framework",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "A modern Roku's Brightscript framework",
   "keywords": [
     "brightscript",

package/src/components/eventBus/EventBus.facade.brs

@@ -9,7 +9,7 @@ function EventBusFacade() as Object
   _global = KopytkoGlobalNode()
   if (NOT _global.hasField("eventBus"))
     _global.addFields({
-      eventBus: CreateObject("roSGNode", "Node"),
+      eventBus: CreateObject("roSGNode", "EventBus"),
     })
   end if
 
@@ -36,7 +36,7 @@ function EventBusFacade() as Object
     m._eventsMap[eventName].push({ handler: handler, context: context })
 
     m._eventBus.unobserveFieldScoped(eventName)
-    m._eventBus.observeFieldScoped(eventName, "EventBus_onEventFired")
+    m._eventBus.observeFieldScoped(eventName, "EventBus_onEventFired", ["$$payload"])
   end sub
 
   ' Detach subscriber for an event
@@ -69,15 +69,20 @@ function EventBusFacade() as Object
   ' @param {Object} [payload={}]
   prototype.trigger = sub (eventName as String, payload = {} as Object)
     m._ensureEventExistence(eventName)
-    m._eventBus[eventName] = payload
+
+    ' The event payload is stored in a separate field to avoid memory leaks.
+    ' Payload needs to be removed from the EventBus node, and if that would
+    ' be stored in the AA field of a specific event, then callbacks would be
+    ' triggered for another time after changing the value to invalid.
+    m._eventBus["$$payload"] = payload
+    m._eventBus[eventName] = true
+    m._eventBus["$$payload"] = Invalid
   end sub
 
   ' @private
   prototype._ensureEventExistence = sub (eventName as String)
     if (NOT m._eventBus.hasField(eventName))
-      fields = {}
-      fields[eventName] = {}
-      m._eventBus.addFields(fields)
+      m._eventBus.addField(eventName, "boolean", true)
     end if
   end sub
 
@@ -95,7 +100,11 @@ sub EventBus_onEventFired(event as Object)
     return
   end if
 
-  payload = event.getData()
+  payload = Invalid
+  context = event.getInfo()
+  if (context <> Invalid)
+    payload = context["$$payload"]
+  end if
 
   for each callback in callbacks
     functionCall(callback.handler, [payload], callback.context)

package/src/components/eventBus/EventBus.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+
+<component name="EventBus" extends="Node">
+  <interface>
+    <field id="$$payload" type="assocarray" /> <!-- prefixed with $$ to avoid name collision with dynamically added events -->
+  </interface>
+</component>

package/src/components/utils/_mocks/KopytkoGlobalNode.mock.brs

@@ -5,9 +5,12 @@
 
 ' @returns {Mock}
 function KopytkoGlobalNode() as Object
+  eventBusNode = createNode()
+  eventBusNode.addField("$$payload", "assocarray", false)
+
   fields = {
     cache: createNode(),
-    eventBus: createNode(),
+    eventBus: eventBusNode,
     router: createNode(),
     store: createNode(),
     theme: createNode(),