Eng prebid 4.38.0

PR_REVIEW.md

@@ -38,6 +38,10 @@ General gulp commands include separate commands for serving the codebase on a bu
 Documentation they're supposed to be following is https://docs.prebid.org/dev-docs/bidder-adaptor.html
 
 Follow steps above for general review process. In addition, please verify the following:
+- Verify the biddercode and aliases are valid:
+ - Lower case alphanumeric with the only special character allowed is underscore.
+ - The bidder code should be unique for the first 6 characters
+ - Reserved words that cannot be used as bidder names: all, context, data, general, prebid, and skadn
 - 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 code re-use is being done properly and that changes introduced by a bidder don't impact other bidders.

README.md

@@ -93,12 +93,12 @@ Or for Babel 6:
 Then you can use Prebid.js as any other npm depedendency
 
 ```javascript
-import prebid from 'prebid.js';
+import pbjs from 'prebid.js';
 import 'prebid.js/modules/rubiconBidAdapter'; // imported modules will register themselves automatically with prebid
 import 'prebid.js/modules/appnexusBidAdapter';
-prebid.processQueue(); // required to process existing pbjs.queue blocks and setup any further pbjs.queue execution
+pbjs.processQueue(); // required to process existing pbjs.queue blocks and setup any further pbjs.queue execution
 
-prebid.requestBids({
+pbjs.requestBids({
  ...
 })
 
@@ -112,11 +112,11 @@ prebid.requestBids({
 
  $ git clone https://github.com/prebid/Prebid.js.git
  $ cd Prebid.js
- $ npm install
+ $ npm ci
 
 *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.
+*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 ci`. This shouldn't impact any other projects you may work on that use an earlier version of gulp in its setup.
 
 If you have a previous version of `gulp` installed globally, you'll need to remove it before installing `gulp-cli`. You can check if this is installed by running `gulp -v` and seeing the version that's listed in the `CLI` field of the output. If you have the `gulp` package installed globally, it's likely the same version that you'll see in the `Local` field. If you already have `gulp-cli` installed, it should be a lower major version (it's at version `2.0.1` at the time of the transition).
 
@@ -202,7 +202,7 @@ To run the unit tests:
 gulp test
 ```
 
-To run the unit tests for a perticular file (example for pubmaticBidAdapter_spec.js):
+To run the unit tests for a particular file (example for pubmaticBidAdapter_spec.js):
 ```bash
 gulp test --file "test/spec/modules/pubmaticBidAdapter_spec.js"
 ```
@@ -265,7 +265,7 @@ directory you will have sourcemaps available in your browser's developer tools.
 
 To run the example file, go to:
 
-+ `http://localhost:9999/integrationExamples/gpt/pbjs_example_gpt.html`
++ `http://localhost:9999/integrationExamples/gpt/hello_world.html`
 
 As you make code changes, the bundles will be rebuilt and the page reloaded automatically.
 

browsers.json

@@ -23,11 +23,11 @@
  "device": null,
  "os": "Windows"
  },
- "bs_chrome_80_windows_10": {
+ "bs_chrome_89_windows_10": {
  "base": "BrowserStack",
  "os_version": "10",
  "browser": "chrome",
- "browser_version": "80.0",
+ "browser_version": "89.0",
  "device": null,
  "os": "Windows"
  },

gulpfile.js

@@ -31,7 +31,7 @@ const execa = require('execa');
 
 var prebid = require('./package.json');
 var dateString = 'Updated : ' + (new Date()).toISOString().substring(0, 10);
-var banner = '/* <%= prebid.name %> v<%= prebid.version %>\n' + dateString + '\nModules: <%= modules %> */\n';
+var banner = '/* <%= prebid.name %> v<%= prebid.version %>\n' + dateString + '*/\n';
 var port = 9999;
 const FAKE_SERVER_HOST = argv.host ? argv.host : 'localhost';
 const FAKE_SERVER_PORT = 4444;
@@ -134,6 +134,12 @@ function watch(done) {
  done();
 };
 
+function makeModuleList(modules) {
+ return modules.map(module => {
+ return '"' + module + '"'
+ });
+}
+
 function makeDevpackPkg() {
  var cloned = _.cloneDeep(webpackConfig);
  cloned.devtool = 'source-map';
@@ -145,6 +151,7 @@ function makeDevpackPkg() {
  return gulp.src([].concat(moduleSources, analyticsSources, 'src/prebid.js'))
  .pipe(helpers.nameModules(externalModules))
  .pipe(webpackStream(cloned, webpack))
+ .pipe(replace(/('|")v\$prebid\.modulesList\$('|")/g, makeModuleList(externalModules)))
  .pipe(gulp.dest('build/dev'))
  .pipe(connect.reload());
 }
@@ -157,13 +164,13 @@ function makeWebpackPkg() {
 
  const analyticsSources = helpers.getAnalyticsSources();
  const moduleSources = helpers.getModulePaths(externalModules);
- const modulesString = getModulesListToAddInBanner(externalModules);
 
  return gulp.src([].concat(moduleSources, analyticsSources, 'src/prebid.js'))
  .pipe(helpers.nameModules(externalModules))
  .pipe(webpackStream(cloned, webpack))
  .pipe(uglify())
- .pipe(gulpif(file => file.basename === 'prebid-core.js', header(banner, { prebid: prebid, modules: modulesString })))
+ .pipe(replace(/('|")v\$prebid\.modulesList\$('|")/g, makeModuleList(externalModules)))
+ .pipe(gulpif(file => file.basename === 'prebid-core.js', header(banner, { prebid: prebid})))
  .pipe(gulp.dest('build/dist'));
 }
 
@@ -286,7 +293,7 @@ function test(done) {
  } else {
  var karmaConf = karmaConfMaker(false, argv.browserstack, argv.watch, argv.file);
 
- var browserOverride = helpers.parseBrowserArgs(argv).map(helpers.toCapitalCase);
+ var browserOverride = helpers.parseBrowserArgs(argv);
  if (browserOverride.length > 0) {
  karmaConf.browsers = browserOverride;
  }

integrationExamples/gpt/adUnitFloors.html

@@ -0,0 +1,112 @@
+<!--
+ This page calls a single bidder for a single ad slot.
+ It is a specialized example for adding floors to bids using the priceFloors Module
+ It also makes a good test page for new adapter PR submissions. Simply set your server's Bid Params object in the
+ bids array inside the adUnits, and it will use your adapter to load an ad.
+ NOTE that many ad servers won't send back an ad if the URL is localhost... so you might need to
+ set an alias in your /etc/hosts file so that you can load this page from a different domain.
+-->
+
+<html>
+
+<head>
+ <script async src="../../build/dist/prebid.js"></script>
+ <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script>
+ <script>
+ var FAILSAFE_TIMEOUT = 3300;
+ var PREBID_TIMEOUT = 1000;
+ var adUnits = [{
+ code: 'div-gpt-ad-51545-0',
+ sizes: [[300, 250], [600, 500]],
+ mediaTypes: {
+ banner: {
+ sizes: [[300, 250], [600, 500]]
+ }
+ },
+ // Replace this object to test a new Adapter!
+ bids: [{
+ bidder: 'ix',
+ params: {
+ siteId: '300',
+ size: [300, 250]
+ }
+ }]
+ }];
+ var pbjs = pbjs || {};
+ pbjs.que = pbjs.que || [];
+ </script>
+ <script>
+ var googletag = googletag || {};
+ googletag.cmd = googletag.cmd || [];
+ googletag.cmd.push(function () {
+ googletag.pubads().disableInitialLoad();
+ });
+
+ pbjs.que.push(function () {
+ pbjs.addAdUnits(adUnits);
+ pbjs.setConfig({
+ floors: {
+ enforcement: {
+ floorDeals: false, //default to false
+ bidAdjustment: true
+ },
+ data: { // default if endpoint doesn't return in time
+ currency: 'USD',
+ skipRate: 5,
+ modelVersion: 'BlackBerryZap',
+ schema: {
+ fields: ['gptSlot', 'mediaType', 'size']
+ },
+ values: {
+ '*|banner|600x500': 6.5,
+ '*|banner|300x250': 3.25,
+ '*|video': 3.5
+ }
+ }
+ }
+ });
+ pbjs.requestBids({
+ bidsBackHandler: sendAdserverRequest,
+ timeout: PREBID_TIMEOUT
+ });
+ });
+
+ function sendAdserverRequest() {
+ if (pbjs.adserverRequestSent) return;
+ pbjs.adserverRequestSent = true;
+ googletag.cmd.push(function () {
+ pbjs.que.push(function () {
+ pbjs.setTargetingForGPTAsync();
+ googletag.pubads().refresh();
+ });
+ });
+ }
+
+ setTimeout(function () {
+ sendAdserverRequest();
+ }, FAILSAFE_TIMEOUT);
+
+ </script>
+
+ <script>
+ googletag.cmd.push(function () {
+ googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-51545-0').addService(googletag.pubads());
+
+ googletag.pubads().enableSingleRequest();
+ googletag.enableServices();
+ });
+ </script>
+</head>
+
+<body>
+ <h2>Prebid.js Test</h2>
+ <h5>Div-1</h5>
+ <div id='div-gpt-ad-51545-0'>
+ <script type='text/javascript'>
+ googletag.cmd.push(function () { googletag.display('div-gpt-ad-51545-0'); });
+ </script>
+ </div>
+</body>
+
+</html>
+