PubxAI Rtd module update: Make the endpoint call optional; read from …

…local storage. (prebid#12064) * Made RTD endpoint optional. Read the floors from local storage in case dynamic endpoint is not provided. * Updated specs to include localStorage tests * fix import error * use sessionStorage to fetchfloorData * updated tests * Fix the example code in the documentation * fix unit tests --------- Co-authored-by: tej656 <tej@pubx.ai>
gumgum · Jul 31, 2024 · 0d021fe · 0d021fe
1 parent 39fa308
commit 0d021fe
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 25 deletions.
diff --git a/modules/pubxaiRtdProvider.js b/modules/pubxaiRtdProvider.js
@@ -2,6 +2,8 @@ import { ajax } from '../src/ajax.js';
 import { config } from '../src/config.js';
 import { submodule } from '../src/hook.js';
 import { deepAccess } from '../src/utils.js';
+import { MODULE_TYPE_RTD } from '../src/activities/modules.js';
+import { getStorageManager } from '../src/storageManager.js';
 /**
  * This RTD module has a dependency on the priceFloors module.
  * We utilize the createFloorsDataForAuction function from the priceFloors module to incorporate price floors data into the current auction.
@@ -16,6 +18,7 @@ export const FloorsApiStatus = Object.freeze({
   SUCCESS: 'SUCCESS',
   ERROR: 'ERROR',
 });
+export const storage = getStorageManager({ moduleType: MODULE_TYPE_RTD, moduleName: SUBMODULE_NAME });
 export const FLOORS_EVENT_HANDLE = 'floorsApi';
 export const FLOORS_END_POINT = 'https://floor.pbxai.com/';
 export const FLOOR_PROVIDER = 'PubxFloorProvider';
@@ -80,31 +83,48 @@ export const setFloorsApiStatus = (status) => {
 
 export const getUrl = (provider) => {
   const { pubxId, endpoint } = deepAccess(provider, 'params');
-  return `${endpoint || FLOORS_END_POINT}?pubxId=${pubxId}&page=${
-    window.location.href
-  }`;
+  if (!endpoint) {
+    return null; // Indicate that no endpoint is provided
+  }
+  return `${endpoint || FLOORS_END_POINT}?pubxId=${pubxId}&page=${window.location.href}`;
 };
 
 export const fetchFloorRules = async (provider) => {
   return new Promise((resolve, reject) => {
     setFloorsApiStatus(FloorsApiStatus.IN_PROGRESS);
-    ajax(getUrl(provider), {
-      success: (responseText, response) => {
-        try {
-          if (response && response.response) {
-            const floorsResponse = JSON.parse(response.response);
-            resolve(floorsResponse);
-          } else {
-            resolve(null);
+    const url = getUrl(provider);
+    if (url) {
+      // Fetch from remote endpoint
+      ajax(url, {
+        success: (responseText, response) => {
+          try {
+            if (response && response.response) {
+              const floorsResponse = JSON.parse(response.response);
+              resolve(floorsResponse);
+            } else {
+              resolve(null);
+            }
+          } catch (error) {
+            reject(error);
           }
-        } catch (error) {
-          reject(error);
+        },
+        error: (responseText, response) => {
+          reject(response);
+        },
+      });
+    } else {
+      // Fetch from local storage
+      try {
+        const localData = storage.getDataFromSessionStorage('pubx:dynamicFloors') || window.__pubxDynamicFloors__;
+        if (localData) {
+          resolve(JSON.parse(localData));
+        } else {
+          resolve(null);
         }
-      },
-      error: (responseText, response) => {
-        reject(response);
-      },
-    });
+      } catch (error) {
+        reject(error);
+      }
+    }
   });
 };
 

diff --git a/modules/pubxaiRtdProvider.md b/modules/pubxaiRtdProvider.md
@@ -32,7 +32,7 @@ pbjs.setConfig({
 	...,
 	realTimeData: {
 		auctionDelay: AUCTION_DELAY,
-		dataProviders: {
+		dataProviders: [{
 			name: "pubxai",
 			waitForIt: true,
 			params: {
@@ -42,7 +42,7 @@ pbjs.setConfig({
 				enforcement: `<enforcement>`, // (optional)
 				data: `<defaultConfig>` // (optional)
 			}
-		}
+		}]
 	}
 	// rest of the config
 	...,

diff --git a/test/spec/modules/pubxaiRtdProvider_spec.js b/test/spec/modules/pubxaiRtdProvider_spec.js
@@ -1,6 +1,7 @@
 import * as priceFloors from '../../../modules/priceFloors';
 import {
   FLOORS_END_POINT,
+  storage,
   FLOORS_EVENT_HANDLE,
   FloorsApiStatus,
   beforeInit,
@@ -45,6 +46,7 @@ const resetGlobals = () => {
   window.__pubxFloorsConfig__ = undefined;
   window.__pubxFloorsApiStatus__ = undefined;
   window.__pubxFloorRulesPromise__ = null;
+  localStorage.removeItem('pubx:dynamicFloors');
 };
 
 const fakeServer = (
@@ -119,7 +121,7 @@ describe('pubxaiRtdProvider', () => {
       stub.restore();
     });
     it('createFloorsDataForAuction called once before and once after __pubxFloorRulesPromise__. Also getBidRequestData executed only once', async () => {
-      pubxaiSubmodule.getBidRequestData(reqBidsConfigObj, () => {});
+      pubxaiSubmodule.getBidRequestData(reqBidsConfigObj, () => { });
       assert(priceFloors.createFloorsDataForAuction.calledOnce);
       await window.__pubxFloorRulesPromise__;
       assert(priceFloors.createFloorsDataForAuction.calledTwice);
@@ -129,14 +131,24 @@ describe('pubxaiRtdProvider', () => {
           reqBidsConfigObj.auctionId
         )
       );
-      pubxaiSubmodule.getBidRequestData(reqBidsConfigObj, () => {});
+      pubxaiSubmodule.getBidRequestData(reqBidsConfigObj, () => { });
       await window.__pubxFloorRulesPromise__;
       assert(priceFloors.createFloorsDataForAuction.calledTwice);
     });
   });
   describe('fetchFloorRules', () => {
     const providerConfig = getConfig();
     const floorsResponse = getFloorsResponse();
+    let storageStub;
+
+    beforeEach(() => {
+      storageStub = sinon.stub(storage, 'getDataFromSessionStorage');
+    });
+
+    afterEach(() => {
+      storageStub.restore();
+    });
+
     it('success with floors response', (done) => {
       const promise = fetchFloorRules(providerConfig);
       fakeServer(floorsResponse);
@@ -145,6 +157,7 @@ describe('pubxaiRtdProvider', () => {
         done();
       });
     });
+
     it('success with no floors response', (done) => {
       const promise = fetchFloorRules(providerConfig);
       fakeServer(undefined);
@@ -153,6 +166,7 @@ describe('pubxaiRtdProvider', () => {
         done();
       });
     });
+
     it('API call error', (done) => {
       const promise = fetchFloorRules(providerConfig);
       fakeServer(undefined, undefined, 404);
@@ -167,6 +181,7 @@ describe('pubxaiRtdProvider', () => {
           done();
         });
     });
+
     it('Wrong API response', (done) => {
       const promise = fetchFloorRules(providerConfig);
       fakeServer('floorsResponse');
@@ -181,6 +196,25 @@ describe('pubxaiRtdProvider', () => {
           done();
         });
     });
+
+    it('success with local data response', (done) => {
+      const localFloorsResponse = getFloorsResponse();
+      storageStub.withArgs('pubx:dynamicFloors').returns(JSON.stringify(localFloorsResponse));
+      const promise = fetchFloorRules({ params: {} });
+      promise.then((res) => {
+        expect(res).to.deep.equal(localFloorsResponse);
+        done();
+      });
+    });
+
+    it('no local data response', (done) => {
+      storageStub.withArgs('pubx:dynamicFloors').returns(null);
+      const promise = fetchFloorRules({ params: {} });
+      promise.then((res) => {
+        expect(res).to.deep.equal(null);
+        done();
+      });
+    });
   });
   describe('setPriceFloors', () => {
     const providerConfig = getConfig();
@@ -383,9 +417,7 @@ describe('pubxaiRtdProvider', () => {
       expect(FLOORS_END_POINT).to.equal('https://floor.pbxai.com/');
     });
     it('standard case', () => {
-      expect(getUrl(provider)).to.equal(
-        `https://floor.pbxai.com/?pubxId=12345&page=${window.location.href}`
-      );
+      expect(getUrl(provider)).to.equal(null);
     });
     it('custom url provided', () => {
       provider.params.endpoint = 'https://custom.floor.com/';