prebid.js 7.51.0 → 7.52.0

package/test/spec/activities/rules_spec.js

@@ -0,0 +1,135 @@
+import {ruleRegistry} from '../../../src/activities/rules.js';
+
+describe('Activity control rules', () => {
+  const MOCK_ACTIVITY = 'mockActivity';
+  const MOCK_RULE = 'mockRule';
+
+  let registerRule, isAllowed, logger;
+
+  beforeEach(() => {
+    logger = {
+      logInfo: sinon.stub(),
+      logWarn: sinon.stub(),
+      logError: sinon.stub(),
+    };
+    [registerRule, isAllowed] = ruleRegistry(logger);
+  });
+
+  it('allows by default', () => {
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.true;
+  });
+
+  it('denies if a rule throws', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => {
+      throw new Error('argh');
+    });
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.false;
+  });
+
+  it('denies if a rule denies', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}));
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.false;
+  });
+
+  it('partitions rules by activity', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}));
+    expect(isAllowed('other', {})).to.be.true;
+  });
+
+  it('passes params to rules', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, (params) => ({allow: params.foo !== 'bar'}));
+    expect(isAllowed(MOCK_ACTIVITY, {foo: 'notbar'})).to.be.true;
+    expect(isAllowed(MOCK_ACTIVITY, {foo: 'bar'})).to.be.false;
+  });
+
+  it('allows if rules do not opine', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => null);
+    expect(isAllowed(MOCK_ACTIVITY, {foo: 'bar'})).to.be.true;
+  });
+
+  it('denies if any rule denies', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => null);
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true}));
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}));
+    expect(isAllowed(MOCK_ACTIVITY, {foo: 'bar'})).to.be.false;
+  });
+
+  it('allows if higher priority allow rule trumps a lower priority deny rule', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}));
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true}), 0);
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.true;
+  });
+
+  it('denies if a higher priority deny rule trumps a lower priority allow rule', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true}));
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}), 0);
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.false;
+  });
+
+  it('can unregister rules', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true}));
+    const r = registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}), 0);
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.false;
+    r();
+    expect(isAllowed(MOCK_ACTIVITY, {})).to.be.true;
+  })
+
+  it('logs INFO when explicit allow is found', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true}));
+    isAllowed(MOCK_ACTIVITY, {});
+    sinon.assert.calledWithMatch(logger.logInfo, new RegExp(MOCK_RULE));
+  });
+
+  it('logs INFO with reason if the rule provides one', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: true, reason: 'because'}));
+    isAllowed(MOCK_ACTIVITY, {});
+    sinon.assert.calledWithMatch(logger.logInfo, new RegExp(MOCK_RULE), /because/);
+  });
+
+  it('logs WARN when a deny is found', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false}));
+    isAllowed(MOCK_ACTIVITY, {});
+    sinon.assert.calledWithMatch(logger.logWarn, new RegExp(MOCK_RULE));
+  });
+
+  it('logs WARN with reason if the rule provides one', () => {
+    registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({allow: false, reason: 'fail'}));
+    isAllowed(MOCK_ACTIVITY, {});
+    sinon.assert.calledWithMatch(logger.logWarn, new RegExp(MOCK_RULE), /fail/);
+  });
+
+  describe('log message deduping', () => {
+    let clock, allow;
+    beforeEach(() => {
+      allow = false;
+      registerRule(MOCK_ACTIVITY, MOCK_RULE, () => ({ allow }));
+      clock = sinon.useFakeTimers();
+    });
+    afterEach(() => {
+      clock.restore();
+    });
+
+    it('is applied to identical messages that are close in time', () => {
+      isAllowed(MOCK_ACTIVITY, {});
+      clock.tick(100);
+      isAllowed(MOCK_ACTIVITY, {});
+      expect(logger.logWarn.callCount).to.equal(1);
+    });
+
+    it('not to messages that show different results', () => {
+      isAllowed(MOCK_ACTIVITY, {});
+      allow = true;
+      clock.tick(100);
+      isAllowed(MOCK_ACTIVITY, {});
+      expect(logger.logWarn.callCount).to.equal(1);
+      expect(logger.logInfo.callCount).to.equal(1);
+    });
+
+    it('not to messages that are further apart in time', () => {
+      isAllowed(MOCK_ACTIVITY, {});
+      clock.tick(2000);
+      isAllowed(MOCK_ACTIVITY, {});
+      expect(logger.logWarn.callCount).to.equal(2);
+    })
+  })
+});

package/test/spec/modules/adgenerationBidAdapter_spec.js

@@ -117,7 +117,7 @@ describe('AdgenerationAdapter', function () {
           criteoId: 'criteo-id-test-1234567890'
         }
       },
-      { // bannerWithAdgextId5Id
+      { // bannerWithAdgextIds
         bidder: 'adg',
         params: {
           id: '58278', // banner
@@ -134,8 +134,48 @@ describe('AdgenerationAdapter', function () {
               linkType: 2
             },
             uid: 'id5-id-test-1234567890'
+          },
+          imuid: 'i.KrAH6ZAZTJOnH5S4N2sogA',
+          uid2: {id: 'AgAAAAVacu1uAxgAxH+HJ8+nWlS2H4uVqr6i+HBDCNREHD8WKsio/x7D8xXFuq1cJycUU86yXfTH9Xe/4C8KkH+7UCiU7uQxhyD7Qxnv251pEs6K8oK+BPLYR+8BLY/sJKesa/koKwx1FHgUzIBum582tSy2Oo+7C6wYUaaV4QcLr/4LPA='},
+        },
+        ortb2Imp: {ext: {gpid: '/1111/homepage#300x250'}},
+        ortb2: {
+          site: {
+            domain: 'localhost:9999',
+            publisher: {'domain': 'localhost:9999'},
+            page: 'http://localhost:9999/integrationExamples/gpt/hello_world.html',
+            ref: 'http://localhost:9999/integrationExamples/gpt/hello_world.html'
+          },
+          device: {
+            w: 570,
+            h: 969,
+            dnt: 0,
+            ua: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML,like Gecko)Chrome / 112.0.0.0Safari / 537.36',
+            language: 'ja',
+            sua: {
+              source: 2,
+              platform: {
+                brand: 'macOS'
+              },
+              browsers: [
+                {
+                  brand: 'Chromium',
+                  version: ['112']
+                },
+                {
+                  brand: 'Google Chrome',
+                  version: ['112']
+                },
+                {
+                  brand: 'Not:A-Brand',
+                  version: ['99']
+                }
+              ],
+              mobile: 0
+            }
           }
-        }
+        },
+        schain: {ver: '1.0', complete: 1, nodes: [{asi: 'indirectseller.com', sid: '00001', hp: 1}]}
       }
     ];
     const bidderRequest = {
@@ -144,12 +184,12 @@ describe('AdgenerationAdapter', function () {
       }
     };
     const data = {
-      banner: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&imark=1&tp=https%3A%2F%2Fexample.com`,
-      bannerUSD: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=USD&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&imark=1&tp=https%3A%2F%2Fexample.com`,
-      native: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=1x1&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&tp=https%3A%2F%2Fexample.com`,
-      bannerWithHyperId: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&imark=1&tp=https%3A%2F%2Fexample.com&hyper_id=novatiqId`,
-      bannerWithAdgextCriteoId: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&adgext_criteo_id=criteo-id-test-1234567890&imark=1&tp=https%3A%2F%2Fexample.com`,
-      bannerWithAdgextId5Id: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.5.0&adgext_id5_id=id5-id-test-1234567890&adgext_id5_id_link_type=2&imark=1&tp=https%3A%2F%2Fexample.com`,
+      banner: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&imark=1&tp=https%3A%2F%2Fexample.com`,
+      bannerUSD: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=USD&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&imark=1&tp=https%3A%2F%2Fexample.com`,
+      native: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=1x1&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&tp=https%3A%2F%2Fexample.com`,
+      bannerWithHyperId: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&imark=1&tp=https%3A%2F%2Fexample.com&hyper_id=novatiqId`,
+      bannerWithAdgextCriteoId: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&adgext_criteo_id=criteo-id-test-1234567890&imark=1&tp=https%3A%2F%2Fexample.com`,
+      bannerWithAdgextIds: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=320x100&currency=JPY&pbver=${prebid.version}&sdkname=prebidjs&adapterver=1.6.0&adgext_id5_id=id5-id-test-1234567890&adgext_id5_id_link_type=2&adgext_imuid=i.KrAH6ZAZTJOnH5S4N2sogA&adgext_uid2=%5Bobject%20Object%5D&gpid=%252F1111%252Fhomepage%2523300x250&uach=%7B%22source%22%3A2%2C%22platform%22%3A%7B%22brand%22%3A%22macOS%22%7D%2C%22browsers%22%3A%5B%7B%22brand%22%3A%22Chromium%22%2C%22version%22%3A%5B%22112%22%5D%7D%2C%7B%22brand%22%3A%22Google%20Chrome%22%2C%22version%22%3A%5B%22112%22%5D%7D%2C%7B%22brand%22%3A%22Not%3AA-Brand%22%2C%22version%22%3A%5B%2299%22%5D%7D%5D%2C%22mobile%22%3A0%7D&schain=%257B%2522ver%2522%253A%25221.0%2522%252C%2522complete%2522%253A1%252C%2522nodes%2522%253A%255B%257B%2522asi%2522%253A%2522indirectseller.com%2522%252C%2522sid%2522%253A%252200001%2522%252C%2522hp%2522%253A1%257D%255D%257D&imark=1&tp=https%3A%2F%2Fexample.com`,
     };
     it('sends bid request to ENDPOINT via GET', function () {
       const request = spec.buildRequests(bidRequests, bidderRequest)[0];
@@ -176,12 +216,12 @@ describe('AdgenerationAdapter', function () {
 
     it('should attache params to the bannerWithHyperId request', function () {
       const defaultUA = window.navigator.userAgent;
-      window.navigator.__defineGetter__('userAgent', function() {
+      window.navigator.__defineGetter__('userAgent', function () {
         return 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1';
       });
       const request = spec.buildRequests(bidRequests, bidderRequest)[2];
 
-      window.navigator.__defineGetter__('userAgent', function() {
+      window.navigator.__defineGetter__('userAgent', function () {
         return defaultUA;
       });
       expect(request.data).to.equal(data.bannerWithHyperId);
@@ -192,9 +232,9 @@ describe('AdgenerationAdapter', function () {
       expect(request.data).to.equal(data.bannerWithAdgextCriteoId);
     });
 
-    it('should attache params to the bannerWithAdgextId5Id request', function () {
+    it('should attache params to the bannerWithAdgextIds request', function () {
       const request = spec.buildRequests(bidRequests, bidderRequest)[4];
-      expect(request.data).to.equal(data.bannerWithAdgextId5Id);
+      expect(request.data).to.equal(data.bannerWithAdgextIds);
     });
 
     it('allows setConfig to set bidder currency for JPY', function () {