Using Prebid.js as npm dependency (prebid#3435)

* added babel plugin to replace webpack StringReplacementPlugin * remove ignore-loader in favor of filtering non .js files as modules * make all imports relative for projects not using our resolver * refactor adaptermanager to adapterManager * convert adapterManager to be compatible with latest version of babel * refactored utils with es6 exports * fixing tests * fixing stubs and tests * babelrc updated to be used externally from parent project * remove $prebid.version$ from gulp and add to babel plugin * fix tests to use actual prebid.version rather than string literal * refactor all modules to use relative imports w/o webpack resolver * fix test in old safari * update package-lock.json * remove unnecessary json-loader * update babel plugin to use same @babel/core * add instructions for using prebid as npm depenedency added to readme * remove unused variable in global babel plugin * fixed missing internal.createTrackPixelIframeHtml * fix relative pathing for new modules
Marfeel · Mar 18, 2019 · d75b0b0 · d75b0b0
1 parent 4ca83c5
commit d75b0b0
Show file tree

Hide file tree

Showing 255 changed files with 4,082 additions and 3,051 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.babelrc.js b/.babelrc.js
@@ -0,0 +1,34 @@
+
+let path = require('path');
+
+function useLocal(module) {
+  return require.resolve(module, {
+    paths: [
+      __dirname
+    ]
+  })
+}
+
+module.exports = {
+  "presets": [
+    [
+      useLocal('@babel/preset-env'),
+      {
+        "targets": {
+          "browsers": [
+            "chrome >= 61",
+            "safari >=8",
+            "edge >= 14",
+            "ff >= 57",
+            "ie >= 10",
+            "ios >= 8"
+          ]
+        }
+      }
+    ]
+  ],
+  "plugins": [
+    path.resolve(__dirname, './plugins/pbjsGlobals.js'),
+    useLocal('babel-plugin-transform-object-assign')
+  ]
+};
diff --git a/README.md b/README.md
@@ -16,11 +16,94 @@ Working examples can be found in [the developer docs](http://prebid.org/dev-docs
 
 **Table of Contents**
 
+- [Usage](#Usage)
 - [Install](#Install)
 - [Build](#Build)
 - [Run](#Run)
 - [Contribute](#Contribute)
 
+<a name="Usage"></a>
+
+## Usage (as a npm dependency)
+
+*Note:* Requires Prebid.js v1.38.0+
+
+Prebid.js depends on Babel and some Babel Plugins in order to run correctly in the browser.  Here are some examples for 
+configuring webpack to work with Prebid.js.
+
+With Babel 7:
+```javascript
+// webpack.conf.js
+let path = require('path');
+module.exports = {
+  mode: 'production',
+  module: {
+    rules: [
+
+      // this rule can be excluded if you don't require babel-loader for your other application files
+      {
+        test: /\.m?js$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+        }
+      },
+
+      // this separate rule is required to make sure that the Prebid.js files are babel-ified.  this rule will
+      // override the regular exclusion from above (for being inside node_modules).
+      {
+        test: /.js$/,
+        include: new RegExp(`\\${path.sep}prebid\.js`),
+        use: {
+          loader: 'babel-loader',
+          // presets and plugins for Prebid.js must be manually specified separate from your other babel rule.
+          // this can be accomplished by requiring prebid's .babelrc.js file (requires Babel 7 and Node v8.9.0+)
+          options: require('prebid.js/.babelrc.js')
+        }
+      }
+    ]
+  }
+}
+```
+
+Or for Babel 6 and/or Node v8.6.0 and less:
+```javascript
+            // you must manually install and specify the presets and plugins yourself
+            options: {
+              plugins: [
+                "transform-object-assign", // required (for IE support) and "babel-plugin-transform-object-assign" 
+                                           // must be installed as part of your package.
+                require('prebid.js/plugins/pbjsGlobals.js') // required!
+              ],
+              presets: [
+                ["env", {                 // you can use other presets if you wish.
+                  "targets": {            // this example is using "babel-presets-env", which must be installed if you
+                    "browsers": [         // follow this example.
+                      ... // your browser targets. they should probably match the targets you're using for the rest 
+                          // of your application
+                    ]
+                  }
+                }]
+              ]
+            }
+```
+
+Then you can use Prebid.js as any other npm depedendency
+
+```javascript
+import prebid 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
+
+prebid.requestBids({
+  ...
+})
+
+```
+
+
+
 <a name="Install"></a>
 
 ## Install

diff --git a/gulpHelpers.js b/gulpHelpers.js
@@ -66,7 +66,7 @@ module.exports = {
     try {
       var absoluteModulePath = path.join(__dirname, MODULE_PATH);
       internalModules = fs.readdirSync(absoluteModulePath)
-        .filter(file => !(/(^|\/)\.[^\/\.]/g).test(file))
+        .filter(file => (/^[^\.]+(\.js)?$/).test(file))
         .reduce((memo, file) => {
           var moduleName = file.split(new RegExp('[.\\' + path.sep + ']'))[0];
           var modulePath = path.join(absoluteModulePath, file);

diff --git a/gulpfile.js b/gulpfile.js
@@ -141,7 +141,6 @@ function makeDevpackPkg() {
   return gulp.src([].concat(moduleSources, analyticsSources, 'src/prebid.js'))
     .pipe(helpers.nameModules(externalModules))
     .pipe(webpackStream(cloned, webpack))
-    .pipe(replace('$prebid.version$', prebid.version))
     .pipe(gulp.dest('build/dev'))
     .pipe(connect.reload());
 }
@@ -159,7 +158,6 @@ function makeWebpackPkg() {
   return gulp.src([].concat(moduleSources, analyticsSources, 'src/prebid.js'))
     .pipe(helpers.nameModules(externalModules))
     .pipe(webpackStream(cloned, webpack))
-    .pipe(replace('$prebid.version$', prebid.version))
     .pipe(uglify())
     .pipe(gulpif(file => file.basename === 'prebid-core.js', header(banner, { prebid: prebid })))
     .pipe(optimizejs())

diff --git a/modules/33acrossBidAdapter.js b/modules/33acrossBidAdapter.js
@@ -1,4 +1,4 @@
-import * as utils from 'src/utils';
+import * as utils from '../src/utils';
 
 const { registerBidder } = require('../src/adapters/bidderFactory');
 const { config } = require('../src/config');

diff --git a/modules/a4gBidAdapter.js b/modules/a4gBidAdapter.js
@@ -1,5 +1,5 @@
-import {registerBidder} from 'src/adapters/bidderFactory';
-import * as utils from 'src/utils';
+import {registerBidder} from '../src/adapters/bidderFactory';
+import * as utils from '../src/utils';
 
 const A4G_BIDDER_CODE = 'a4g';
 const A4G_CURRENCY = 'USD';

diff --git a/modules/aardvarkBidAdapter.js b/modules/aardvarkBidAdapter.js
@@ -1,5 +1,5 @@
-import * as utils from 'src/utils';
-import {registerBidder} from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import {registerBidder} from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'aardvark';
 const DEFAULT_ENDPOINT = 'bidder.rtk.io';

diff --git a/modules/adagioAnalyticsAdapter.js b/modules/adagioAnalyticsAdapter.js
@@ -2,8 +2,8 @@
  * Analytics Adapter for Adagio
  */
 
-import adapter from 'src/AnalyticsAdapter';
-import adaptermanager from 'src/adaptermanager';
+import adapter from '../src/AnalyticsAdapter';
+import adapterManager from '../src/adapterManager';
 
 // This config makes Prebid.js call this function on each event:
 //   `window['AdagioPrebidAnalytics']('on', eventType, args)`
@@ -15,7 +15,7 @@ var adagioAdapter = adapter({
   analyticsType: 'bundle'
 });
 
-adaptermanager.registerAnalyticsAdapter({
+adapterManager.registerAnalyticsAdapter({
   adapter: adagioAdapter,
   code: 'adagio'
 });

diff --git a/modules/adagioBidAdapter.js b/modules/adagioBidAdapter.js
@@ -1,6 +1,6 @@
 import find from 'core-js/library/fn/array/find';
-import * as utils from 'src/utils';
-import { registerBidder } from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import { registerBidder } from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'adagio';
 const VERSION = '1.0.0';

diff --git a/modules/adbutlerBidAdapter.js b/modules/adbutlerBidAdapter.js
@@ -1,8 +1,8 @@
 'use strict';
 
-import * as utils from 'src/utils';
-import {config} from 'src/config';
-import {registerBidder} from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import {config} from '../src/config';
+import {registerBidder} from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'adbutler';
 

diff --git a/modules/adformBidAdapter.js b/modules/adformBidAdapter.js
@@ -1,7 +1,7 @@
 'use strict';
 
-import {registerBidder} from 'src/adapters/bidderFactory';
-import { BANNER, VIDEO } from 'src/mediaTypes';
+import {registerBidder} from '../src/adapters/bidderFactory';
+import { BANNER, VIDEO } from '../src/mediaTypes';
 
 const BIDDER_CODE = 'adform';
 export const spec = {

diff --git a/modules/adformOpenRTBBidAdapter.js b/modules/adformOpenRTBBidAdapter.js
@@ -3,11 +3,11 @@
 
 import {
   registerBidder
-} from 'src/adapters/bidderFactory';
+} from '../src/adapters/bidderFactory';
 import {
   NATIVE
-} from 'src/mediaTypes';
-import * as utils from 'src/utils';
+} from '../src/mediaTypes';
+import * as utils from '../src/utils';
 
 const BIDDER_CODE = 'adformOpenRTB';
 const NATIVE_ASSET_IDS = { 0: 'title', 2: 'icon', 3: 'image', 5: 'sponsoredBy', 4: 'body', 1: 'cta' };

diff --git a/modules/adgenerationBidAdapter.js b/modules/adgenerationBidAdapter.js
@@ -1,7 +1,7 @@
-import * as utils from 'src/utils';
-import {registerBidder} from 'src/adapters/bidderFactory';
-import {BANNER, NATIVE} from 'src/mediaTypes';
-import { config } from 'src/config';
+import * as utils from '../src/utils';
+import {registerBidder} from '../src/adapters/bidderFactory';
+import {BANNER, NATIVE} from '../src/mediaTypes';
+import { config } from '../src/config';
 const ADG_BIDDER_CODE = 'adgeneration';
 
 export const spec = {

diff --git a/modules/adheseBidAdapter.js b/modules/adheseBidAdapter.js
@@ -1,7 +1,7 @@
 'use strict';
 
-import { registerBidder } from 'src/adapters/bidderFactory';
-import { BANNER, VIDEO } from 'src/mediaTypes';
+import { registerBidder } from '../src/adapters/bidderFactory';
+import { BANNER, VIDEO } from '../src/mediaTypes';
 
 const BIDDER_CODE = 'adhese';
 const USER_SYNC_BASE_URL = 'https://user-sync.adhese.com/iframe/user_sync.html';

diff --git a/modules/adikteevBidAdapter.js b/modules/adikteevBidAdapter.js
@@ -1,7 +1,7 @@
-import {registerBidder} from 'src/adapters/bidderFactory';
-import {BANNER} from 'src/mediaTypes';
+import {registerBidder} from '../src/adapters/bidderFactory';
+import {BANNER} from '../src/mediaTypes';
 import * as utils from '../src/utils';
-import {config} from 'src/config';
+import {config} from '../src/config';
 
 export const BIDDER_CODE = 'adikteev';
 export const ENDPOINT_URL = 'https://serve-adserver.adikteev.com/api/prebid/bid';

diff --git a/modules/adkernelAdnAnalyticsAdapter.js b/modules/adkernelAdnAnalyticsAdapter.js
@@ -1,9 +1,9 @@
-import adapter from 'src/AnalyticsAdapter';
-import CONSTANTS from 'src/constants.json';
-import adaptermanager from 'src/adaptermanager';
-import {parse} from 'src/url';
-import * as utils from 'src/utils';
-import {ajax} from 'src/ajax';
+import adapter from '../src/AnalyticsAdapter';
+import CONSTANTS from '../src/constants.json';
+import adapterManager from '../src/adapterManager';
+import {parse} from '../src/url';
+import * as utils from '../src/utils';
+import {ajax} from '../src/ajax';
 
 const ANALYTICS_VERSION = '1.0.0';
 const DEFAULT_QUEUE_TIMEOUT = 4000;
@@ -99,7 +99,7 @@ analyticsAdapter.enableAnalytics = (config) => {
   analyticsAdapter.originEnableAnalytics(config);
 };
 
-adaptermanager.registerAnalyticsAdapter({
+adapterManager.registerAnalyticsAdapter({
   adapter: analyticsAdapter,
   code: 'adkernelAdn'
 });
@@ -110,11 +110,15 @@ function sendAll() {
   let events = analyticsAdapter.context.queue.popAll();
   if (events.length !== 0) {
     let req = Object.assign({}, analyticsAdapter.context.requestTemplate, {hb_ev: events});
-    ajax(`//${analyticsAdapter.context.host}/hb-analytics`, () => {
-    }, JSON.stringify(req));
+    analyticsAdapter.ajaxCall(JSON.stringify(req));
   }
 }
 
+analyticsAdapter.ajaxCall = function ajaxCall(data) {
+  ajax(`//${analyticsAdapter.context.host}/hb-analytics`, () => {
+  }, data);
+};
+
 function trackAuctionInit() {
   analyticsAdapter.context.auctionTimeStart = Date.now();
   const event = createHbEvent(undefined, ADK_HB_EVENTS.AUCTION_INIT);

diff --git a/modules/adkernelAdnBidAdapter.js b/modules/adkernelAdnBidAdapter.js
@@ -1,6 +1,6 @@
-import * as utils from 'src/utils';
-import {registerBidder} from 'src/adapters/bidderFactory';
-import {BANNER, VIDEO} from 'src/mediaTypes';
+import * as utils from '../src/utils';
+import {registerBidder} from '../src/adapters/bidderFactory';
+import {BANNER, VIDEO} from '../src/mediaTypes';
 import includes from 'core-js/library/fn/array/includes';
 
 const DEFAULT_ADKERNEL_DSP_DOMAIN = 'tag.adkernel.com';

diff --git a/modules/adkernelBidAdapter.js b/modules/adkernelBidAdapter.js
@@ -1,9 +1,9 @@
-import * as utils from 'src/utils';
-import { BANNER, VIDEO } from 'src/mediaTypes';
-import {registerBidder} from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import { BANNER, VIDEO } from '../src/mediaTypes';
+import {registerBidder} from '../src/adapters/bidderFactory';
 import find from 'core-js/library/fn/array/find';
 import includes from 'core-js/library/fn/array/includes';
-import {parse as parseUrl} from 'src/url'
+import {parse as parseUrl} from '../src/url'
 
 const VIDEO_TARGETING = ['mimes', 'minduration', 'maxduration', 'protocols',
   'startdelay', 'linearity', 'boxingallowed', 'playbackmethod', 'delivery',

diff --git a/modules/adliveBidAdapter.js b/modules/adliveBidAdapter.js
@@ -1,6 +1,6 @@
-import * as utils from 'src/utils';
-import { registerBidder } from 'src/adapters/bidderFactory';
-import { BANNER } from 'src/mediaTypes';
+import * as utils from '../src/utils';
+import { registerBidder } from '../src/adapters/bidderFactory';
+import { BANNER } from '../src/mediaTypes';
 
 const BIDDER_CODE = 'adlive';
 const ENDPOINT_URL = 'https://api.publishers.adlive.io/get?pbjs=1';

diff --git a/modules/admaticBidAdapter.js b/modules/admaticBidAdapter.js
@@ -1,5 +1,5 @@
-import * as utils from 'src/utils';
-import { registerBidder } from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import { registerBidder } from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'admatic';
 const ENDPOINT_URL = '//ads4.admatic.com.tr/prebid/v3/bidrequest';

diff --git a/modules/admixerBidAdapter.js b/modules/admixerBidAdapter.js
@@ -1,5 +1,5 @@
-import * as utils from 'src/utils';
-import {registerBidder} from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import {registerBidder} from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'admixer';
 const ENDPOINT_URL = '//inv-nets.admixer.net/prebid.1.0.aspx';

diff --git a/modules/adoceanBidAdapter.js b/modules/adoceanBidAdapter.js
@@ -1,5 +1,5 @@
-import * as utils from 'src/utils';
-import { registerBidder } from 'src/adapters/bidderFactory';
+import * as utils from '../src/utils';
+import { registerBidder } from '../src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'adocean';