fix: Correct isInitialized check in hashAttributes and setExtensionData functions (#39)

Author: alexs-mparticle

src/Rokt-Kit.js

@@ -58,7 +58,7 @@ var constructor = function () {
      * hashed attributes from the launcher, or `null` if the kit is not initialized
      */
     function hashAttributes(attributes) {
-        if (!isInitialized()) {
+        if (!isKitReady()) {
             console.error('Rokt Kit: Not initialized');
             return null;
         }
@@ -223,7 +223,7 @@ var constructor = function () {
      * @returns {void} Nothing is returned
      */
     function setExtensionData(partnerExtensionData) {
-        if (!isInitialized()) {
+        if (!isKitReady()) {
             console.error('Rokt Kit: Not initialized');
             return;
         }
@@ -271,10 +271,11 @@ var constructor = function () {
                         );
                     }
                 }
-                // Attaches the kit to the Rokt manager
-                window.mParticle.Rokt.attachKit(self);
 
+                // Kit must be initialized before attaching to the Rokt manager
                 self.isInitialized = true;
+                // Attaches the kit to the Rokt manager
+                window.mParticle.Rokt.attachKit(self);
             })
             .catch(function (err) {
                 console.error('Error creating Rokt launcher:', err);
@@ -335,13 +336,13 @@ var constructor = function () {
     this.removeUserAttribute = removeUserAttribute;
 
     /**
-     * Checks if the kit is properly initialized and ready for use.
+     * Checks if the Rokt kit is ready to use.
      * Both conditions must be true:
      * 1. self.isInitialized - Set after successful initialization of the kit
      * 2. self.launcher - The Rokt launcher instance must be available
-     * @returns {boolean} Whether the kit is fully initialized
+     * @returns {boolean} Whether the kit is ready for use
      */
-    function isInitialized() {
+    function isKitReady() {
         return !!(self.isInitialized && self.launcher);
     }
 };

test/src/tests.js

@@ -444,6 +444,113 @@ describe('Rokt Forwarder', () => {
         });
     });
 
+    describe('#attachLauncher', () => {
+        let mockMessageQueue;
+
+        beforeEach(() => {
+            mockMessageQueue = [];
+
+            // Reset forwarder state between tests
+            window.mParticle.forwarder.isInitialized = false;
+
+            window.Rokt = new MockRoktForwarder();
+            window.mParticle.Rokt = window.Rokt;
+            window.mParticle.Rokt.attachKitCalled = false;
+
+            // Set attachKit as async to allow for await calls in the test
+            // This is necessary to simiulate a race condition between the
+            // core sdk and the Rokt forwarder
+            window.mParticle.Rokt.attachKit = async (kit) => {
+                window.mParticle.Rokt.attachKitCalled = true;
+                window.mParticle.Rokt.kit = kit;
+
+                // Call queued messages
+                mockMessageQueue.forEach((message) => message());
+                mockMessageQueue = [];
+
+                return Promise.resolve();
+            };
+            window.mParticle.Rokt.filters = {
+                userAttributesFilters: [],
+                filterUserAttributes: function (attributes) {
+                    return attributes;
+                },
+                filteredUser: {
+                    getMPID: function () {
+                        return '123';
+                    },
+                },
+            };
+        });
+
+        it('should call attachKit', async () => {
+            await window.mParticle.forwarder.init(
+                { accountId: '123456' },
+                reportService.cb,
+                true,
+                null,
+                {}
+            );
+
+            await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);
+
+            window.mParticle.Rokt.attachKitCalled.should.equal(true);
+        });
+
+        it('should set isInitialized to true', async () => {
+            await window.mParticle.forwarder.init(
+                { accountId: '123456' },
+                reportService.cb,
+                true,
+                null,
+                {}
+            );
+
+            await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);
+
+            window.mParticle.forwarder.isInitialized.should.equal(true);
+        });
+
+        // This test is to ensure the kit is initialized before attaching to the Rokt manager
+        // so we can ensure that the Rokt Manager's message queue is processed and that
+        // all the isReady() checks are properly handled in by the Rokt Manager.
+        // This is to validate in case a bug that was found in the Rokt Manager's
+        // queueing logic regresses.
+        it('should initialize the kit before calling queued messages', async () => {
+            let queuedMessageCalled = false;
+            let wasKitInitializedFirst = false;
+
+            const queuedMessage = () => {
+                wasKitInitializedFirst =
+                    window.mParticle.Rokt.kit &&
+                    window.mParticle.Rokt.kit.isInitialized;
+                queuedMessageCalled = true;
+            };
+
+            mockMessageQueue.push(queuedMessage);
+
+            await window.mParticle.forwarder.init(
+                { accountId: '123456' },
+                reportService.cb,
+                true,
+                null,
+                {}
+            );
+
+            window.mParticle.forwarder.isInitialized.should.equal(false);
+            queuedMessageCalled.should.equal(false);
+
+            await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);
+
+            window.mParticle.forwarder.isInitialized.should.equal(true);
+            queuedMessageCalled.should.equal(true);
+
+            wasKitInitializedFirst.should.equal(true);
+
+            mockMessageQueue.length.should.equal(0);
+        });
+    });
+
     describe('#selectPlacements', () => {
         beforeEach(() => {
             window.Rokt = new MockRoktForwarder();