Merge branch 'master' of https://github.com/prebid/Prebid.js

.circleci/config.yml

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

.nvmrc

@@ -1 +1 @@
-8.9
+12.16.1

CONTRIBUTING.md

@@ -6,6 +6,8 @@ master branch.
 Pull requests must have 80% code coverage before beign considered for merge.
 Additional details about the process can be found [here](./PR_REVIEW.md).
 
+There are more details available if you'd like to contribute a [bid adapter](https://docs.prebid.org/dev-docs/bidder-adaptor.html) or [analytics adapter](https://docs.prebid.org/dev-docs/integrate-with-the-prebid-analytics-api.html).
+
 ## Issues
 [prebid.org](http://prebid.org/) contains documentation that may help answer questions you have about using Prebid.js.
 If you can't find the answer there, try searching for a similar issue on the [issues page](https://github.com/prebid/Prebid.js/issues).

PR_REVIEW.md

@@ -14,13 +14,16 @@ For modules and core platform updates, the initial reviewer should request an ad
 - Review for obvious errors or bad coding practice / use best judgement here.
 - If the change is a new feature / change to core prebid.js - review the change with a Tech Lead on the project and make sure they agree with the nature of change.
 - If the change results in needing updates to docs (such as public API change, module interface etc), add a label for "needs docs" and inform the submitter they must submit a docs PR to update the appropriate area of Prebid.org **before the PR can merge**. Help them with finding where the docs are located on prebid.org if needed. 
- - Below are some examples of bidder specific updates that should require docs update (in their dev-docs/bidders/bidder.md file):
- - Add support for GDPR consentManagement module > add `gdpr_supported: true`
- - Add support for US Privacy consentManagement module > add `usp_supported: true`
- - Add support for userId module > add `userId: pubCommon, digitrust, newProviderHere`
- - Add support for video and/or native mediaTypes > add `media_types: video, native`
- - Add support for COPPA > add `coppa_supported: true`
- - Add support for SChain > add `schain_supported: true`
+ - Below are some examples of bidder specific updates that should require docs update (in their dev-docs/bidders/BIDDER.md file):
+ - If they support the GDPR consentManagement module and TCF1, add `gdpr_supported: true`
+ - If they support the GDPR consentManagement module and TCF2, add `tcf2_supported: true`
+ - If they support the US Privacy consentManagementUsp module, add `usp_supported: true`
+ - If they support one or more userId modules, add `userId: (list of supported vendors)`
+ - If they support video and/or native mediaTypes add `media_types: video, native`. Note that display is added by default. If you don't support display, add "no-display" as the first entry, e.g. `media_types: no-display, native`
+ - If they support COPPA, add `coppa_supported: true`
+ - If they support SChain, add `schain_supported: true`
+ - If their bidder doesn't work well with safeframed creatives, add `safeframes_ok: false`. This will alert publishers to not use safeframed creatives when creating the ad server entries for their bidder.
+ - If they're setting a deal ID in some scenarios, add `bidder_supports_deals: true`
 - If all above is good, add a `LGTM` comment and request 1 additional core member to review.
 - Once there is 2 `LGTM` on the PR, merge to master
 - Ask the submitter to add a PR for documentation if applicable.
@@ -31,17 +34,17 @@ For modules and core platform updates, the initial reviewer should request an ad
 - Follow steps above for general review process. In addition, please verify the following:
 - Verify that bidder has submitted valid bid params and that bids are being received.
 - Verify that bidder is not manipulating the prebid.js auction in any way or doing things that go against the principles of the project. If unsure check with the Tech Lead.
-- Verify that the bidder is being as efficient as possible, ideally not loading an external library, however if they do load a library it should be cached.
 - Verify that code re-use is being done properly and that changes introduced by a bidder don't impact other bidders.
 - If the adapter being submitted is an alias type, check with the bidder contact that is being aliased to make sure it's allowed.
-- If the adapter is triggering any user syncs make sure they are using the user sync module in the Prebid.js core.
-- Requests to the bidder should support HTTPS
-- Responses from the bidder should be compressed (such as gzip, compress, deflate)
-- Bid responses may not use JSONP: All requests must be AJAX with JSON responses
-- All user-sync (aka pixel) activity must be registered via the provided functions
-- Adapters may not use the $$PREBID_GLOBAL$$ variable
-- All adapters must support the creation of multiple concurrent instances. This means, for example, that adapters cannot rely on mutable global variables.
-- Adapters may not globally override or default the standard ad server targeting values: hb_adid, hb_bidder, hb_pb, hb_deal, or hb_size, hb_source, hb_format.
+- All required global and bidder-adapter rules defined in the [Module Rules](https://docs.prebid.org/dev-docs/module-rules.html) must be followed. Please review these rules often - we depend on reviewers to enforce them.
+- All bidder parameter conventions must be followed:
+ - Video params must be read from AdUnit.mediaTypes.video when available; however bidder config can override the ad unit. 
+ - First party data must be read from [`fpd.context` and `fpd.user`](https://docs.prebid.org/dev-docs/publisher-api-reference.html#setConfig-fpd).
+ - Adapters that accept a floor parameter must also support the [floors module](https://docs.prebid.org/dev-docs/modules/floors.html) -- look for a call to the `getFloors()` function.
+ - Adapters cannot accept an schain parameter. Rather, they must look for the schain parameter at bidRequest.schain.
+ - The bidRequest page referrer must checked in addition to any bidder-specific parameter.
+ - If they're getting the COPPA flag, it must come from config.getConfig('coppa');
+
 - After a new adapter is approved, let the submitter know they may open a PR in the [headerbid-expert repository](https://github.com/prebid/headerbid-expert) to have their adapter recognized by the [Headerbid Expert extension](https://chrome.google.com/webstore/detail/headerbid-expert/cgfkddgbnfplidghapbbnngaogeldmop). The PR should be to the [bidder patterns file](https://github.com/prebid/headerbid-expert/blob/master/bidderPatterns.js), adding an entry with their adapter's name and the url the adapter uses to send and receive bid responses.
 
 ## Ticket Coordinator

README.md

@@ -14,6 +14,8 @@ This README is for developers who want to contribute to Prebid.js.
 Additional documentation can be found at [the Prebid homepage](http://prebid.org).
 Working examples can be found in [the developer docs](http://prebid.org/dev-docs/getting-started.html).
 
+Prebid.js is open source software that is offered for free as a convenience. While it is designed to help companies address legal requirements associated with header bidding, we cannot and do not warrant that your use of Prebid.js will satisfy legal requirements. You are solely responsible for ensuring that your use of Prebid.js complies with all applicable laws. We strongly encourage you to obtain legal advice when using Prebid.js to ensure your implementation complies with all laws where you operate.
+
 **Table of Contents**
 
 - [Usage](#Usage)
@@ -112,7 +114,7 @@ prebid.requestBids({
  $ cd Prebid.js
  $ npm install
 
-*Note:* You need to have `NodeJS` 8.9.x or greater installed.
+*Note:* You need to have `NodeJS` 12.16.1 or greater installed.
 
 *Note:* In the 1.24.0 release of Prebid.js we have transitioned to using gulp 4.0 from using gulp 3.9.1. To comply with gulp's recommended setup for 4.0, you'll need to have `gulp-cli` installed globally prior to running the general `npm install`. This shouldn't impact any other projects you may work on that use an earlier version of gulp in its setup.
 
@@ -266,17 +268,15 @@ As you make code changes, the bundles will be rebuilt and the page reloaded auto
 
 ## Contribute
 
-Many SSPs, bidders, and publishers have contributed to this project. [60+ Bidders](https://github.com/prebid/Prebid.js/tree/master/src/adapters) are supported by Prebid.js.
+Many SSPs, bidders, and publishers have contributed to this project. [Hundreds of bidders](https://github.com/prebid/Prebid.js/tree/master/src/adapters) are supported by Prebid.js.
 
 For guidelines, see [Contributing](./CONTRIBUTING.md).
 
 Our PR review process can be found [here](https://github.com/prebid/Prebid.js/tree/master/PR_REVIEW.md).
 
 ### Add a Bidder Adapter
 
-To add a bidder adapter module, see the instructions in [How to add a bidder adaptor](http://prebid.org/dev-docs/bidder-adaptor.html).
-
-Please **do NOT load Prebid.js inside your adapter**. If you do this, we will reject or remove your adapter as appropriate.
+To add a bidder adapter module, see the instructions in [How to add a bidder adapter](https://docs.prebid.org/dev-docs/bidder-adaptor.html).
 
 ### Code Quality
 

allowedModules.js

@@ -21,7 +21,6 @@ module.exports = {
  'fun-hooks/no-eval',
  'just-clone',
  'dlv',
- 'dset',
- 'deep-equal'
+ 'dset'
  ]
 };

gulpfile.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 'use strict';
 
 var _ = require('lodash');
@@ -32,8 +33,8 @@ var prebid = require('./package.json');
 var dateString = 'Updated : ' + (new Date()).toISOString().substring(0, 10);
 var banner = '/* <%= prebid.name %> v<%= prebid.version %>\n' + dateString + ' */\n';
 var port = 9999;
-const mockServerPort = 4444;
-const host = argv.host ? argv.host : 'localhost';
+const FAKE_SERVER_HOST = argv.host ? argv.host : 'localhost';
+const FAKE_SERVER_PORT = 4444;
 const { spawn } = require('child_process');
 
 // these modules must be explicitly listed in --modules to be included in the build, won't be part of "all" modules
@@ -238,25 +239,25 @@ function test(done) {
  ];
  }
 
- //run mock-server
- const mockServer = spawn('node', ['./test/mock-server/index.js', '--port=' + mockServerPort]);
- mockServer.stdout.on('data', (data) => {
+ // run fake-server
+ const fakeServer = spawn('node', ['./test/fake-server/index.js', `--port=${FAKE_SERVER_PORT}`]);
+ fakeServer.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
  });
- mockServer.stderr.on('data', (data) => {
+ fakeServer.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
  });
 
  execa(wdioCmd, wdioOpts, { stdio: 'inherit' })
  .then(stdout => {
- // kill mock server
- mockServer.kill('SIGINT');
+ // kill fake server
+ fakeServer.kill('SIGINT');
  done();
  process.exit(0);
  })
  .catch(err => {
- // kill mock server
- mockServer.kill('SIGINT');
+ // kill fake server
+ fakeServer.kill('SIGINT');
  done(new Error(`Tests failed with error: ${err}`));
  process.exit(1);
  });
@@ -326,11 +327,27 @@ function setupE2e(done) {
  done();
 }
 
-gulp.task('updatepath', function () {
+function injectFakeServerEndpoint() {
  return gulp.src(['build/dist/*.js'])
- .pipe(replace('https://ib.adnxs.com/ut/v3/prebid', 'http://' + host + ':' + mockServerPort + '/'))
+ .pipe(replace('https://ib.adnxs.com/ut/v3/prebid', `http://${FAKE_SERVER_HOST}:${FAKE_SERVER_PORT}`))
  .pipe(gulp.dest('build/dist'));
-});
+}
+
+function injectFakeServerEndpointDev() {
+ return gulp.src(['build/dev/*.js'])
+ .pipe(replace('https://ib.adnxs.com/ut/v3/prebid', `http://${FAKE_SERVER_HOST}:${FAKE_SERVER_PORT}`))
+ .pipe(gulp.dest('build/dev'));
+}
+
+function startFakeServer() {
+ const fakeServer = spawn('node', ['./test/fake-server/index.js', `--port=${FAKE_SERVER_PORT}`]);
+ fakeServer.stdout.on('data', (data) => {
+ console.log(`stdout: ${data}`);
+ });
+ fakeServer.stderr.on('data', (data) => {
+ console.log(`stderr: ${data}`);
+ });
+}
 
 // support tasks
 gulp.task(lint);
@@ -355,9 +372,12 @@ gulp.task('build', gulp.series(clean, 'build-bundle-prod'));
 gulp.task('build-postbid', gulp.series(escapePostbidConfig, buildPostbid));
 
 gulp.task('serve', gulp.series(clean, lint, gulp.parallel('build-bundle-dev', watch, test)));
+gulp.task('serve-fast', gulp.series(clean, gulp.parallel('build-bundle-dev', watch)));
+gulp.task('serve-fake', gulp.series(clean, gulp.parallel('build-bundle-dev', watch), injectFakeServerEndpointDev, test, startFakeServer));
+
 gulp.task('default', gulp.series(clean, makeWebpackPkg));
 
-gulp.task('e2e-test', gulp.series(clean, setupE2e, gulp.parallel('build-bundle-prod', watch), 'updatepath', test));
+gulp.task('e2e-test', gulp.series(clean, setupE2e, gulp.parallel('build-bundle-prod', watch), injectFakeServerEndpoint, test));
 // other tasks
 gulp.task(bundleToStdout);
 gulp.task('bundle', gulpBundle.bind(null, false)); // used for just concatenating pre-built files with no build step

integrationExamples/gpt/responsiveAds_sizeMappingV2.html → integrationExamples/gpt/advanced_size_mapping.html

@@ -1,3 +1,6 @@
+<!-- Test page for Size Mapping V2 module. Don't forget to include that module in the build before you run this page!
+Feel free to play around with different settings and configurations for size mapping v2 -->
+
 <!DOCTYPE html>
 <html>
 
@@ -8,15 +11,16 @@
  const FAILSAFE_TIMEOUT = 3300;
  const PREBID_TIMEOUT = 1000;
 
+ // Example of a multi-format ad unit setup with uses the module `sizeMappingV2.js`.
  const adUnits = [{
  code: 'div-gpt-ad-1460505748561-0',
  mediaTypes: {
  banner: {
  sizeConfig: [
  { minViewPort: [0, 0], sizes: [] }, // remove if < 750px
- { minViewPort: [750, 0], sizes: [[300, 250], [300, 600]] }, // between 750px and 1199px
- { minViewPort: [1200, 0], sizes: [[970, 90], [728, 90], [300, 250]] }, // between 1200px and 1599px
- { minViewPort: [1600, 0], sizes: [[1000, 300], [970, 90], [728, 90], [300, 250]] } // greater than 1600px
+ { minViewPort: [750, 0], sizes: [[300, 250], [300, 600]] }, // between 750px and 1199px, use sizes: [[300, 250], [300, 600]]
+ { minViewPort: [1200, 0], sizes: [[970, 90], [728, 90], [300, 250]] }, // between 1200px and 1599px, use sizes: [[970, 90], [728, 90], [300, 250]]
+ { minViewPort: [1600, 0], sizes: [[1000, 300], [970, 90], [728, 90], [300, 250]] } // greater than 1600px, use sizes: [[1000, 300], [970, 90], [728, 90], [300, 250]]
  ]
  },
  video: {
@@ -31,9 +35,9 @@
  required: true,
  sizes: [150, 50]
  },
-
+ // native media type enters auction only if device width is > 600px
  sizeConfig: [
- { minViewPort: [0, 0], active: false },
+ { minViewPort: [0, 0], active: false }, 
  { minViewPort: [600, 0], active: true }
  ]
  }
@@ -54,12 +58,33 @@
  siteId: 70608,
  zoneId: 498816
  },
+ // example of a bidder level size config. In the scenario below, bidder 'rubicon' enters auction only if the device width
+ // is between 850-1200 and it'll only send request for the 'native' media type.
  sizeConfig: [
  { minViewPort: [0, 0], relevantMediaTypes: ['none'] },
  { minViewPort: [850, 0], relevantMediaTypes: ['native'] },
  { minViewPort: [1200, 0], relevantMediaTypes: ['none'] }
  ]
  }]
+ }, {
+ // Example of an 'Identical Ad Unit' (same 'code' as previous ad unit but different 'mediaTypes' object)
+ // Ad Unit makes use of the 'labelAll' operator. (the label operators can be applied at the bidder lever as well)
+ code: 'div-gpt-ad-1460505748561-0',
+ labelAll: ['tablet'], // Label check fails since labels passed to pbjs.requestBids() equals ['mobile']. This disables the entire ad unit.
+ mediaTypes: {
+ banner: {
+ sizeConfig: [
+ { minViewPort: [800, 0], sizes: [[360, 400], [640, 200]] },
+ { minViewPort: [1000, 0], sizes: [] }
+ ]
+ }
+ },
+ bids: [{
+ bidder: 'appnexus',
+ params: {
+ placementId: 4232323
+ }
+ }]
  }];
  var pbjs = pbjs || {};
  pbjs.que = pbjs.que || [];
@@ -75,9 +100,11 @@
 
  pbjs.que.push(function () {
  pbjs.addAdUnits(adUnits);
+ pbjs.setConfig({debug: true});
  pbjs.requestBids({
  bidsBackHandler: sendAdserverRequest,
- timeout: PREBID_TIMEOUT
+ timeout: PREBID_TIMEOUT,
+ labels: ['mobile']
  });
  });
 

integrationExamples/gpt/audigentSegments_example.html

@@ -162,11 +162,6 @@
  params: {
  // change to Parrable Partner Client ID(s) you received from the Parrable Partners you are using
  partner: '30182847-e426-4ff9-b2b5-9ca1324ea09b'
- },
- storage: {
- type: "cookie",
- name: "_parrable_eid", // create a cookie with this name
- expires: 365 // cookie can last for a year
  }
  }, {
  name: "pubCommonId",