Scattered Bid Adapter: New Adapter (#9295)

almendar · web-flow · commit 58d79e5291de · 2023-02-07T11:46:43.000-05:00
* Scattered module skeleton

* Review fixes

* Remove netRevenue check

* Fix test

* Review fixes
diff --git a/modules/scatteredBidAdapter.js b/modules/scatteredBidAdapter.js
@@ -0,0 +1,72 @@
+// jshint esversion: 6, es3: false, node: true
+'use strict';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { deepAccess, logInfo } from '../src/utils.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+
+const BIDDER_CODE = 'scattered';
+const GVLID = 1179;
+export const converter = ortbConverter({
+  context: {
+    mediaType: BANNER,
+    ttl: 360,
+    netRevenue: true
+  }
+})
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: [BANNER],
+
+  // 1.
+  isBidRequestValid: function (bid) {
+    const bidderDomain = deepAccess(bid, 'params.bidderDomain')
+    if (bidderDomain === undefined || bidderDomain === '') {
+      return false
+    }
+
+    const sizes = deepAccess(bid, 'mediaTypes.banner.sizes')
+    if (sizes === undefined || sizes.length < 1) {
+      return false
+    }
+
+    return true
+  },
+
+  // 2.
+  buildRequests: function (bidRequests, bidderRequest) {
+    return {
+      method: 'POST',
+      url: 'https://' + getKeyOnAny(bidRequests, 'params.bidderDomain'),
+      data: converter.toORTB({ bidderRequest, bidRequests }),
+      options: {
+        contentType: 'application/json'
+      },
+    };
+  },
+
+  // 3.
+  interpretResponse: function (response, request) {
+    if (!response.body) return;
+    return converter.fromORTB({ response: response.body, request: request.data }).bids;
+  },
+
+  // 4
+  onBidWon: function (bid) {
+    logInfo('onBidWon', bid)
+  }
+}
+
+function getKeyOnAny(collection, key) {
+  for (let i = 0; i < collection.length; i++) {
+    const result = deepAccess(collection[i], key);
+    if (result) {
+      return result;
+    }
+  }
+}
+
+registerBidder(spec);
diff --git a/modules/scatteredBidAdapter.md b/modules/scatteredBidAdapter.md
@@ -0,0 +1,36 @@
+# Overview
+
+```
+Module Name: Scattered Adapter
+Module Type: Bidder Adapter
+Maintainer: office@scattered.pl
+```
+
+# Description
+
+Module that connects to Scattered's demand sources. 
+It uses OpenRTB standard to communicate between the adapter and bidding servers.
+
+# Test Parameters
+
+```javascript
+    var adUnits = [
+        {
+            code: 'test-div',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250]],  // a display size
+                }
+            },
+            bids: [
+                {
+                    bidder: "scattered",
+                    params: {
+                        bidderDomain: "prebid-test.scattered.eu/bid",
+                        test: 0
+                    }
+                }
+            ]
+        }
+    ];
+```
diff --git a/test/spec/modules/scatteredBidAdapter_spec.js b/test/spec/modules/scatteredBidAdapter_spec.js
@@ -0,0 +1,210 @@
+import { spec, converter } from 'modules/scatteredBidAdapter.js';
+import { assert } from 'chai';
+import { config } from 'src/config.js';
+import { deepClone, mergeDeep } from '../../../src/utils';
+describe('Scattered adapter', function () {
+  describe('isBidRequestValid', function () {
+    // A valid bid
+    let validBid = {
+      bidder: 'scattered',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [760, 400]]
+        }
+      },
+      params: {
+        bidderDomain: 'https://prebid.scattered.eu',
+        test: 0
+      }
+    };
+
+    // Because this valid bid is modified to create invalid bids in following tests we first check it.
+    // We must be sure it is a valid one, not to get false negatives.
+    it('should accept a valid bid', function () {
+      assert.isTrue(spec.isBidRequestValid(validBid));
+    });
+
+    it('should skip if bidderDomain info is missing', function () {
+      let bid = deepClone(validBid);
+
+      delete bid.params.bidderDomain;
+      assert.isFalse(spec.isBidRequestValid(bid));
+    });
+
+    it('should expect at least one banner size', function () {
+      let bid = deepClone(validBid);
+
+      delete bid.mediaTypes.banner;
+      assert.isFalse(spec.isBidRequestValid(bid));
+
+      // empty sizes array
+      bid.mediaTypes = {
+        banner: {
+          sizes: []
+        }
+      };
+      assert.isFalse(spec.isBidRequestValid(bid));
+    });
+  });
+
+  describe('buildRequests', function () {
+    let arrayOfValidBidRequests, validBidderRequest;
+
+    beforeEach(function () {
+      arrayOfValidBidRequests = [{
+        bidder: 'scattered',
+        params: {
+          bidderDomain: 'https://prebid.scattered.eu',
+          test: 0
+        },
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250], [760, 400]]
+          },
+          adUnitCode: 'test-div',
+          transactionId: '32d09c47-c6b8-40b0-9605-2e251a472ea4',
+          bidId: '21adc5d8765aa1',
+          bidderRequestId: '130728f7662afc',
+          auctionId: 'b4a45a23-8371-4d87-9308-39146b29ca32',
+        },
+      }];
+
+      validBidderRequest = {
+        bidderCode: 'scattered',
+        auctionId: 'b4a45a23-8371-4d87-9308-39146b29ca32',
+        gdprConsent: { consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA', gdprApplies: true },
+        refererInfo: {
+          domain: 'localhost',
+          page: 'http://localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true',
+        },
+        ortb2: {
+          site: {
+            publisher: {
+              name: 'publisher1 INC.'
+            }
+          }
+        }
+      };
+    });
+
+    it('should validate request format', function () {
+      let request = spec.buildRequests(arrayOfValidBidRequests, validBidderRequest);
+      assert.equal(request.method, 'POST');
+      assert.deepEqual(request.options, { contentType: 'application/json' });
+      assert.ok(request.data);
+    });
+
+    it('has the right fields filled', function () {
+      let request = spec.buildRequests(arrayOfValidBidRequests, validBidderRequest);
+      const bidderRequest = request.data;
+      assert.equal(bidderRequest.id, validBidderRequest.auctionId);
+      assert.ok(bidderRequest.site);
+      assert.ok(bidderRequest.device);
+      assert.ok(bidderRequest.source);
+      assert.lengthOf(bidderRequest.imp, 1);
+    });
+
+    it('should configure the site object', function () {
+      let request = spec.buildRequests(arrayOfValidBidRequests, validBidderRequest);
+      const site = request.data.site;
+      assert.equal(site.domain, 'localhost');
+      assert.equal(site.page, 'http://localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true');
+    });
+
+    it('should configure site with ortb2', function () {
+      mergeDeep(validBidderRequest.ortb2.site, {
+        id: '876',
+        publisher: {
+          domain: 'publisher1.eu'
+        }
+      });
+
+      let request = spec.buildRequests(arrayOfValidBidRequests, validBidderRequest);
+      const site = request.data.site;
+      assert.deepEqual(site, {
+        domain: 'localhost',
+        id: '876',
+        page: 'http://localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true',
+        publisher: {
+          domain: 'publisher1.eu',
+          name: 'publisher1 INC.'
+        }
+      });
+    });
+
+    it('should send device info', function () {
+      it('should send info about device', function () {
+        config.setConfig({
+          device: { w: 375, h: 273 }
+        });
+
+        let request = spec.buildRequests(arrayOfValidBidRequests, validBidderRequest);
+
+        assert.equal(request.device.ua, navigator.userAgent);
+        assert.equal(request.device.w, 375);
+        assert.equal(request.device.h, 273);
+      });
+    })
+  })
+})
+
+describe('interpretResponse', function () {
+  const serverResponse = {
+    body: {
+      id: 'b4a45a23-8371-4d87-9308-39146b29ca32',
+      bidid: '11111111-2222-2222-2222-333333333333',
+      cur: 'PLN',
+      seatbid: [{
+        bid: [
+          {
+            id: '234234-234234-234234', // bidder generated
+            impid: '123',
+            price: '34.2',
+            nurl: 'https://scattered.eu/nurl',
+            adm: '<html><img src="https://some_banner.jpeg></img></html>',
+            cid: '99877',
+            crid: '2345-2345-23',
+            w: 345,
+            h: 456
+          }
+        ]
+      }],
+    }
+  };
+
+  let bidderRequest = {
+    bids: [
+      {
+        bidId: '123',
+        netRevenue: 'net',
+      }
+    ]
+
+  };
+
+  let request;
+  beforeEach(() => {
+    request = { data: converter.toORTB({ bidderRequest }) };
+  });
+
+  it('should return if no body in response', function () {
+    assert.ok(!spec.interpretResponse({}, request));
+  });
+
+  it('should set proper values', function () {
+    const results = spec.interpretResponse(serverResponse, request);
+    const expected = {
+      ad: '<html><img src="https://some_banner.jpeg></img></html><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="https://scattered.eu/nurl"></div>',
+      cpm: '34.2',
+      creativeId: '2345-2345-23',
+      currency: 'PLN',
+      height: 456,
+      width: 345,
+      mediaType: 'banner',
+      requestId: '123',
+      ttl: 360,
+    };
+    expect(results.length).to.equal(1);
+    sinon.assert.match(results[0], expected);
+  });
+});
