Feat/dailymotion adaptor metadata

.circleci/config.yml

@@ -7,7 +7,7 @@ aliases:
   - &environment
       docker:
         # specify the version you desire here
-        - image: circleci/node:12.16.1-browsers
+        - image: cimg/node:16.20-browsers
       resource_class: xlarge
         # Specify service dependencies here if necessary
         # CircleCI maintains a library of pre-built images

README.md

@@ -255,6 +255,12 @@ gulp test-coverage
 gulp view-coverage
 ```
 
+Local end-to-end testing can be done with:
+
+```bash
+gulp e2e-test --local
+```
+
 For Prebid.org members with access to BrowserStack, additional end-to-end testing can be done with:
 
 ```bash

gulpfile.js

@@ -52,6 +52,18 @@ function clean() {
     .pipe(gulpClean());
 }
 
+function requireNodeVersion(version) {
+  return (done) => {
+    const [major] = process.versions.node.split('.');
+
+    if (major < version) {
+      throw new Error(`This task requires Node v${version}`)
+    }
+
+    done();
+  }
+}
+
 // Dependant task for building postbid. It escapes postbid-config file.
 function escapePostbidConfig() {
   gulp.src('./integrationExamples/postbid/oas/postbid-config.js')
@@ -293,7 +305,7 @@ function bundle(dev, moduleArr) {
 // If --notest is given, it will immediately skip the test task (useful for developing changes with `gulp serve --notest`)
 
 function testTaskMaker(options = {}) {
-  ['watch', 'e2e', 'file', 'browserstack', 'notest'].forEach(opt => {
+  ['watch', 'file', 'browserstack', 'notest'].forEach(opt => {
     options[opt] = options.hasOwnProperty(opt) ? options[opt] : argv[opt];
   })
 
@@ -302,22 +314,6 @@ function testTaskMaker(options = {}) {
   return function test(done) {
     if (options.notest) {
       done();
-    } else if (options.e2e) {
-      const integ = startIntegServer();
-      startLocalServer();
-      runWebdriver(options)
-        .then(stdout => {
-          // kill fake server
-          integ.kill('SIGINT');
-          done();
-          process.exit(0);
-        })
-        .catch(err => {
-          // kill fake server
-          integ.kill('SIGINT');
-          done(new Error(`Tests failed with error: ${err}`));
-          process.exit(1);
-        });
     } else {
       runKarma(options, done)
     }
@@ -326,10 +322,34 @@ function testTaskMaker(options = {}) {
 
 const test = testTaskMaker();
 
+function e2eTestTaskMaker() {
+  return function test(done) {
+    const integ = startIntegServer();
+    startLocalServer();
+    runWebdriver({})
+      .then(stdout => {
+        // kill fake server
+        integ.kill('SIGINT');
+        done();
+        process.exit(0);
+      })
+      .catch(err => {
+        // kill fake server
+        integ.kill('SIGINT');
+        done(new Error(`Tests failed with error: ${err}`));
+        process.exit(1);
+      });
+  }
+}
+
 function runWebdriver({file}) {
   process.env.TEST_SERVER_HOST = argv.host || 'localhost';
+
+  let local = argv.local || false;
+
+  let wdioConfFile = local === true ? 'wdio.local.conf.js' : 'wdio.conf.js';
   let wdioCmd = path.join(__dirname, 'node_modules/.bin/wdio');
-  let wdioConf = path.join(__dirname, 'wdio.conf.js');
+  let wdioConf = path.join(__dirname, wdioConfFile);
   let wdioOpts;
 
   if (file) {
@@ -486,8 +506,9 @@ gulp.task('serve-e2e-dev', gulp.series(clean, 'build-bundle-dev', gulp.parallel(
 
 gulp.task('default', gulp.series(clean, 'build-bundle-prod'));
 
-gulp.task('e2e-test-only', () => runWebdriver({file: argv.file}));
-gulp.task('e2e-test', gulp.series(clean, 'build-bundle-prod', testTaskMaker({e2e: true})));
+gulp.task('e2e-test-only', gulp.series(requireNodeVersion(16), () => runWebdriver({file: argv.file})));
+gulp.task('e2e-test', gulp.series(requireNodeVersion(16), clean, 'build-bundle-prod', e2eTestTaskMaker()));
+
 // other tasks
 gulp.task(bundleToStdout);
 gulp.task('bundle', gulpBundle.bind(null, false)); // used for just concatenating pre-built files with no build step

libraries/creativeRender/direct.js

@@ -52,7 +52,7 @@ export function renderAdDirect(doc, adId, options) {
           message: `renderAd was prevented from writing to the main document.`
         })
       } else {
-        handleRender(renderFn, {adId, options: {clickUrl: options?.clickThrough}, bidResponse: bid});
+        handleRender(renderFn, {adId, options: {clickUrl: options?.clickThrough}, bidResponse: bid, doc});
       }
     }
   } catch (e) {

modules/33acrossIdSystem.js

@@ -10,6 +10,12 @@ import { ajaxBuilder } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
 import { uspDataHandler, coppaDataHandler, gppDataHandler } from '../src/adapterManager.js';
 
+/**
+ * @typedef {import('../modules/userId/index.js').Submodule} Submodule
+ * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig
+ * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse
+ */
+
 const MODULE_NAME = '33acrossId';
 const API_URL = 'https://lexicon.33across.com/v1/envelope';
 const AJAX_TIMEOUT = 10000;

modules/a1MediaRtdProvider.js

@@ -4,6 +4,10 @@ import { submodule } from '../src/hook.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { isEmptyStr, mergeDeep } from '../src/utils.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const REAL_TIME_MODULE = 'realTimeData';
 const MODULE_NAME = 'a1Media';
 const SCRIPT_URL = 'https://linkback.contentsfeed.com/src';

modules/ablidaBidAdapter.js

@@ -3,6 +3,12 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse
+ */
+
 const BIDDER_CODE = 'ablida';
 const ENDPOINT_URL = 'https://bidder.ablida.net/prebid';
 

modules/adfusionBidAdapter.js

@@ -5,6 +5,7 @@ import * as utils from '../src/utils.js';
 
 const adpterVersion = '1.0';
 export const REQUEST_URL = 'https://spicyrtb.com/auction/prebid';
+export const DEFAULT_CURRENCY = 'USD';
 
 export const spec = {
   code: 'adfusion',
@@ -23,6 +24,17 @@ const converter = ortbConverter({
   context: {
     netRevenue: true,
     ttl: 300,
+    currency: DEFAULT_CURRENCY,
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    const floor = getBidFloor(bidRequest);
+    if (floor) {
+      imp.bidfloor = floor;
+      imp.bidfloorcur = DEFAULT_CURRENCY;
+    }
+
+    return imp;
   },
   request(buildRequest, imps, bidderRequest, context) {
     const req = buildRequest(imps, bidderRequest, context);
@@ -88,3 +100,21 @@ function isBannerBid(bid) {
 function interpretResponse(resp, req) {
   return converter.fromORTB({ request: req.data, response: resp.body });
 }
+
+function getBidFloor(bid) {
+  if (utils.isFn(bid.getFloor)) {
+    let floor = bid.getFloor({
+      currency: DEFAULT_CURRENCY,
+      mediaType: '*',
+      size: '*',
+    });
+    if (
+      utils.isPlainObject(floor) &&
+      !isNaN(floor.floor) &&
+      floor.currency === DEFAULT_CURRENCY
+    ) {
+      return floor.floor;
+    }
+  }
+  return null;
+}

modules/adgenerationBidAdapter.js

@@ -6,6 +6,14 @@ import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 import {tryAppendQueryString} from '../libraries/urlUtils/urlUtils.js';
 import {escapeUnsafeChars} from '../libraries/htmlEscape/htmlEscape.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse
+ * @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions
+ * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync
+ */
+
 const ADG_BIDDER_CODE = 'adgeneration';
 
 export const spec = {

modules/adkernelBidAdapter.js

@@ -23,12 +23,16 @@ import {config} from '../src/config.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 import {getAdUnitSizes} from '../libraries/sizeUtils/sizeUtils.js';
 
-/*
+/**
  * In case you're AdKernel whitelable platform's client who needs branded adapter to
  * work with Adkernel platform - DO NOT COPY THIS ADAPTER UNDER NEW NAME
  *
- * Please contact prebid@adkernel.com and we'll add your adapter as an alias.
+ * Please contact prebid@adkernel.com and we'll add your adapter as an alias
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync
  */
+
 const VIDEO_PARAMS = ['pos', 'context', 'placement', 'plcmt', 'api', 'mimes', 'protocols', 'playbackmethod', 'minduration', 'maxduration',
   'startdelay', 'linearity', 'skip', 'skipmin', 'skipafter', 'minbitrate', 'maxbitrate', 'delivery', 'playbackend', 'boxingallowed'];
 const VIDEO_FPD = ['battr', 'pos'];

modules/admaticBidAdapter.js

@@ -2,6 +2,13 @@ import {getValue, formatQS, logError, deepAccess, isArray, getBidIdParameter} fr
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, VIDEO, NATIVE } from '../src/mediaTypes.js';
+
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ */
+
 export const OPENRTB = {
   NATIVE: {
     IMAGE_TYPE: {

modules/admediaBidAdapter.js

@@ -1,6 +1,12 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse
+ */
+
 const BIDDER_CODE = 'admedia';
 const ENDPOINT_URL = 'https://prebid.admedia.com/bidder/';
 

modules/admixerIdSystem.js

@@ -11,6 +11,13 @@ import { submodule } from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/userId/index.js').Submodule} Submodule
+ * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig
+ * @typedef {import('../modules/userId/index.js').ConsentData} ConsentData
+ * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse
+ */
+
 const NAME = 'admixerId';
 export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: NAME});
 

modules/adnowBidAdapter.js

@@ -9,6 +9,10 @@ const ENDPOINT = 'https://n.ads3-adnow.com/a';
 
 /**
  * @typedef {object} CommonBidData
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').BidderSpec} BidderSpec
  *
  * @property {string} requestId The specific BidRequest which this bid is aimed at.
  *   This should match the BidRequest.bidId which this Bid targets.

modules/adnuntiusRtdProvider.js

@@ -5,6 +5,10 @@ import { ajax } from '../src/ajax.js';
 
 import { config as sourceConfig } from '../src/config.js';
 
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
+
 const GVLID = 855;
 
 function init(config, userConsent) {

modules/adotBidAdapter.js

@@ -9,6 +9,7 @@ import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
 
 const BIDDER_CODE = 'adot';
 const ADAPTER_VERSION = 'v2.0.0';
+const GVLID = 272;
 const BID_METHOD = 'POST';
 const BIDDER_URL = 'https://dsp.adotmob.com/headerbidding{PUBLISHER_PATH}/bidrequest';
 const REQUIRED_VIDEO_PARAMS = ['mimes', 'protocols'];
@@ -635,7 +636,8 @@ export const spec = {
   isBidRequestValid,
   buildRequests,
   interpretResponse,
-  getFloor
+  getFloor,
+  gvlid: GVLID
 };
 
 registerBidder(spec);

modules/adqueryBidAdapter.js

@@ -2,6 +2,14 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
 import {buildUrl, logInfo, parseSizesInput, triggerPixel} from '../src/utils.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').BidderSpec} BidderSpec
+ * @typedef {import('../src/adapters/bidderFactory.js').TimedOutBid} TimedOutBid
+ */
+
 const ADQUERY_GVLID = 902;
 const ADQUERY_BIDDER_CODE = 'adquery';
 const ADQUERY_BIDDER_DOMAIN_PROTOCOL = 'https';

modules/adqueryIdSystem.js

@@ -11,6 +11,12 @@ import {submodule} from '../src/hook.js';
 import {isFn, isPlainObject, isStr, logError, logInfo} from '../src/utils.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/userId/index.js').Submodule} Submodule
+ * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig
+ * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse
+ */
+
 const MODULE_NAME = 'qid';
 const AU_GVLID = 902;
 

modules/adrelevantisBidAdapter.js

@@ -23,6 +23,11 @@ import {convertCamelToUnderscore} from '../libraries/appnexusUtils/anUtils.js';
 import {convertTypes} from '../libraries/transformParamsUtils/convertTypes.js';
 import {chunk} from '../libraries/chunk/chunk.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ */
+
 const BIDDER_CODE = 'adrelevantis';
 const URL = 'https://ssp.adrelevantis.com/prebid';
 const VIDEO_TARGETING = ['id', 'mimes', 'minduration', 'maxduration',

modules/adriverIdSystem.js

@@ -11,6 +11,13 @@ import { submodule } from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
+/**
+ * @typedef {import('../modules/userId/index.js').Submodule} Submodule
+ * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig
+ * @typedef {import('../modules/userId/index.js').ConsentData} ConsentData
+ * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse
+ */
+
 const MODULE_NAME = 'adriverId';
 
 export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});

modules/adtelligentBidAdapter.js

@@ -7,6 +7,10 @@ import {find} from '../src/polyfill.js';
 import {convertTypes} from '../libraries/transformParamsUtils/convertTypes.js';
 import {chunk} from '../libraries/chunk/chunk.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ */
+
 const subdomainSuffixes = ['', 1, 2];
 const AUCTION_PATH = '/v2/auction/';
 const PROTOCOL = 'https://';