fix: SDKE-319 - Add Events to Event Queue when Kit is not ready (#46)

Author: alexs-mparticle

src/Rokt-Kit.js

@@ -30,6 +30,7 @@ var constructor = function () {
     self.userAttributes = {};
     self.testHelpers = null;
     self.placementEventMappingLookup = {};
+    self.eventQueue = [];
 
     /**
      * Generates the Rokt launcher script URL with optional domain override and extensions
@@ -276,9 +277,20 @@ var constructor = function () {
         window.Rokt.setExtensionData(partnerExtensionData);
     }
 
+    function processEventQueue() {
+        self.eventQueue.forEach(function (event) {
+            processEvent(event);
+        });
+        self.eventQueue = [];
+    }
+
     function processEvent(event) {
+        if (!isKitReady()) {
+            self.eventQueue.push(event);
+            return;
+        }
+
         if (
-            !isKitReady() ||
             isEmpty(self.placementEventMappingLookup) ||
             typeof window.mParticle.Rokt.setLocalSessionAttribute !== 'function'
         ) {
@@ -342,6 +354,7 @@ var constructor = function () {
                 self.isInitialized = true;
                 // Attaches the kit to the Rokt manager
                 window.mParticle.Rokt.attachKit(self);
+                processEventQueue();
             })
             .catch(function (err) {
                 console.error('Error creating Rokt launcher:', err);

test/src/tests.js

@@ -1995,6 +1995,12 @@ describe('Rokt Forwarder', () => {
             };
         });
 
+        afterEach(() => {
+            window.mParticle.forwarder.eventQueue = [];
+            window.mParticle.forwarder.isInitialized = false;
+            window.mParticle.Rokt.attachKitCalled = false;
+        });
+
         it('set a local session selection attribute if the event is a mapped placement event', async () => {
             // Mocks hashed values for testing
             const placementEventMapping = JSON.stringify([
@@ -2035,6 +2041,62 @@ describe('Rokt Forwarder', () => {
                 'foo-mapped-flag': true,
             });
         });
+
+        it('should add the event to the event queue if the kit is not initialized', async () => {
+            await window.mParticle.forwarder.init(
+                {
+                    accountId: '123456',
+                },
+                reportService.cb,
+                true,
+                null,
+                {}
+            );
+
+            window.mParticle.forwarder.process({
+                EventName: 'Video Watched A',
+                EventCategory: EventType.Other,
+                EventDataType: MessageType.PageEvent,
+            });
+
+            window.mParticle.forwarder.eventQueue.should.deepEqual([
+                {
+                    EventName: 'Video Watched A',
+                    EventCategory: EventType.Other,
+                    EventDataType: MessageType.PageEvent,
+                },
+            ]);
+        });
+
+        it('should process queued events once the kit is ready', async () => {
+            await window.mParticle.forwarder.init(
+                {
+                    accountId: '123456',
+                },
+                reportService.cb,
+                true,
+                null,
+                {}
+            );
+
+            window.mParticle.forwarder.process({
+                EventName: 'Video Watched B',
+                EventCategory: EventType.Other,
+                EventDataType: MessageType.PageEvent,
+            });
+
+            window.mParticle.forwarder.eventQueue.should.deepEqual([
+                {
+                    EventName: 'Video Watched B',
+                    EventCategory: EventType.Other,
+                    EventDataType: MessageType.PageEvent,
+                },
+            ]);
+
+            await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);
+
+            window.mParticle.forwarder.eventQueue.should.deepEqual([]);
+        });
     });
 
     describe('#parseSettingsString', () => {