prebid.js 7.10.0 → 7.13.0

package/test/spec/modules/oneKeyIdSystem_spec.js

@@ -0,0 +1,107 @@
+import { oneKeyIdSubmodule } from 'modules/oneKeyIdSystem'
+
+const defaultConf = {
+  params: {
+    proxyHostName: 'proxy.com'
+  }
+};
+
+const defaultIdsAndPreferences = {
+  identifiers: [
+    {
+      version: '0.1',
+      type: 'paf_browser_id',
+      value: 'df0a5664-987d-4074-bbd9-e9b12ebae6ef',
+      source: {
+        domain: 'crto-poc-1.onekey.network',
+        timestamp: 1657100291,
+        signature: 'ikjV6WwpcroNB5XyLOr3MgYHLpS6UjICEOuv/jEr00uVrjZm0zluDSWh11OeGDZrMhxMBPeTabtQ4U2rNk3IzQ=='
+      }
+    }
+  ],
+  preferences: {
+    version: '0.1',
+    data: {
+      use_browsing_for_personalization: true
+    },
+    source: {
+      domain: 'cmp.pafdemopublisher.com',
+      timestamp: 1657100294,
+      signature: 'aAbMThxyeKpe/EgT5ARI1xecjCwwh0uRagsTuPXNY2fzh7foeW31qljDZf6h8UwOd9M2bAN7XNtM2LYBbJzskQ=='
+    }
+  }
+};
+
+const defaultIdsAndPreferencesResult = {
+  status: 'PARTICIPATING',
+  data: defaultIdsAndPreferences
+};
+
+describe('oneKeyData module', () => {
+  describe('getId function', () => {
+    beforeEach(() => {
+      setUpOneKey();
+    });
+
+    it('return a callback for handling asynchron results', () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      expect(moduleIdResponse.callback).to.be.an('function');
+    });
+
+    it(`return a callback that waits for OneKey to be loaded`, () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      moduleIdResponse.callback(function() {})
+
+      expect(window.OneKey.queue.length).to.equal(1);
+    });
+
+    it('return a callback that gets ids and prefs', () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      // Act
+      return new Promise((resolve) => {
+        moduleIdResponse.callback(resolve);
+        executeOneKeyQueue();
+      })
+
+      // Assert
+        .then((idsAndPrefs) => {
+          expect(idsAndPrefs).to.equal(defaultIdsAndPreferences);
+        });
+    });
+
+    it('return a callback with undefined if impossible to get ids and prefs', () => {
+      window.OneKey.getIdsAndPreferences = () => {
+        return Promise.reject(new Error(`Impossible to get ids and prefs`));
+      };
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      // Act
+      return new Promise((resolve) => {
+        moduleIdResponse.callback(resolve);
+        executeOneKeyQueue();
+      })
+
+      // Assert
+        .then((idsAndPrefs) => {
+          expect(idsAndPrefs).to.be.undefined;
+        });
+    });
+  });
+});
+
+const setUpOneKey = () => {
+  window.OneKey.queue = [];
+  window.OneKey.getIdsAndPreferences = () => {
+    return Promise.resolve(defaultIdsAndPreferencesResult);
+  };
+}
+
+const executeOneKeyQueue = () => {
+  while (window.OneKey.queue.length > 0) {
+    window.OneKey.queue[0]();
+    window.OneKey.queue.shift();
+  }
+}

package/test/spec/modules/oneKeyRtdProvider_spec.js

@@ -0,0 +1,152 @@
+import {oneKeyDataSubmodule} from 'modules/oneKeyRtdProvider.js';
+import {getAdUnits} from '../../fixtures/fixtures.js';
+
+const defaultSeed = {
+  version: '0.1',
+  transaction_ids: [
+    'd566b02a-a6e2-4c87-98dc-f5623cd9e828',
+    'f7ffe3cc-0d58-4ec4-b687-1d3d410a48fe'
+  ],
+  publisher: 'cmp.pafdemopublisher.com',
+  source: {
+    domain: 'cmp.pafdemopublisher.com',
+    timestamp: 1657116880,
+    signature: '6OmdrSGwagPpugGFuQ4VGjzqYadHxWIXPaLItk0vA1lmi/EQyRvNF5seXStfwKWRnC7HZlOIGSjA6g7HAuofWw=='
+
+  }
+};
+
+const defaultOrb2WithTransmission = {
+  user: {
+    ext: {
+      paf: {
+        transmission: {
+          seed: defaultSeed
+        }
+      }
+    }
+  }
+};
+
+const defaultRtdConfig = {
+  params: {
+    proxyHostName: 'host'
+  }
+};
+
+describe('oneKeyDataSubmodule', () => {
+  var bidsConfig;
+  beforeEach(() => {
+    // Fresh bidsConfig because it can be altered
+    // during the tests.
+    bidsConfig = getReqBidsConfig();
+    setUpOneKey();
+  });
+
+  it('successfully instantiates', () => {
+    expect(oneKeyDataSubmodule.init()).to.equal(true);
+  });
+
+  it('call OneKey API once it is loaded', () => {
+    const done = sinon.spy();
+
+    oneKeyDataSubmodule.getBidRequestData(bidsConfig, done, defaultRtdConfig);
+
+    expect(bidsConfig).to.eql(getReqBidsConfig());
+    expect(done.callCount).to.equal(0);
+    expect(window.OneKey.queue.length).to.equal(1);
+  });
+
+  it('don\'t change anything without a seed', () => {
+    window.OneKey.generateSeed = (_transactionIds) => {
+      return Promise.resolve(undefined);
+    };
+
+    // Act
+    return new Promise(resolve => {
+      oneKeyDataSubmodule.getBidRequestData(bidsConfig, resolve, defaultRtdConfig);
+      executeOneKeyQueue();
+    })
+
+    // Assert
+      .then(() => {
+        expect(bidsConfig).to.eql(getReqBidsConfig());
+      });
+  });
+
+  [ // Test cases
+    {
+      description: 'global orb2',
+      rtdConfig: defaultRtdConfig,
+      expectedFragment: {
+        global: {
+          ...defaultOrb2WithTransmission
+        },
+        bidder: {}
+      }
+    },
+
+    {
+      description: 'bidder-specific orb2',
+      rtdConfig: {
+        params: {
+          proxyHostName: 'host',
+          bidders: [ 'bidder42', 'bidder24' ]
+        }
+      },
+      expectedFragment: {
+        global: { },
+        bidder: {
+          bidder42: {
+            ...defaultOrb2WithTransmission
+          },
+          bidder24: {
+            ...defaultOrb2WithTransmission
+          }
+        }
+      }
+    }
+  ].forEach(testCase => {
+    it(`update adUnits with transaction-ids and transmission in ${testCase.description}`, () => {
+      // Act
+      return new Promise(resolve => {
+        oneKeyDataSubmodule.getBidRequestData(bidsConfig, resolve, testCase.rtdConfig);
+        executeOneKeyQueue();
+      })
+
+      // Assert
+        .then(() => {
+        // Verify transaction-ids without equality
+        // because they are generated UUID.
+          bidsConfig.adUnits.forEach((adUnit) => {
+            expect(adUnit.ortb2Imp.ext.data.paf.transaction_id).to.not.be.undefined;
+          });
+          expect(bidsConfig.ortb2Fragments).to.eql(testCase.expectedFragment);
+        });
+    });
+  });
+});
+
+const getReqBidsConfig = () => {
+  return {
+    adUnits: getAdUnits(),
+    ortb2Fragments: {
+      global: {},
+      bidder: {}
+    }
+  }
+}
+
+const setUpOneKey = () => {
+  window.OneKey.queue = [];
+  OneKey.generateSeed = (_transactionIds) => {
+    return Promise.resolve(defaultSeed);
+  };
+}
+
+const executeOneKeyQueue = () => {
+  while (window.OneKey.queue.length > 0) {
+    window.OneKey.queue[0]();
+    window.OneKey.queue.shift();
+  }
+}