Prebid core: improve library support; make AnalyticsAdapter a library

.gitignore

@@ -15,7 +15,7 @@ selenium*.log
 integrationExamples/gpt/gpt.html
 integrationExamples/gpt/*-test.html
 integrationExamples/implementations/
-src/adapters/analytics/libraries
+libraries/analyticsAdapter/examples/libraries
 
 # Coverage reports
 build/coverage/

allowedModules.js

@@ -15,5 +15,8 @@ module.exports = {
     'just-clone',
     'dlv',
     'dset'
+  ],
+  'libraries': [
+    ...sharedWhiteList // empty for now, but keep it to enable linting
   ]
 };

gulpHelpers.js

@@ -6,12 +6,9 @@ const MANIFEST = 'package.json';
 const through = require('through2');
 const _ = require('lodash');
 const gutil = require('gulp-util');
-const dependencyMap = require('./modules/.submodules.json');
-const submodules = dependencyMap.parentModules;
-const libraries = dependencyMap.libraries;
+const submodules = require('./modules/.submodules.json').parentModules;
 
 const MODULE_PATH = './modules';
-const LIBRARY_PATH = './libraries';
 const BUILD_PATH = './build/dist';
 const DEV_PATH = './build/dev';
 const ANALYTICS_PATH = '../analytics';
@@ -71,68 +68,34 @@ module.exports = {
       }
     });
 
-    Object.keys(libraries).forEach(library => {
-      if (!modules.includes(library) && modules.some(module => libraries[library].dependants.includes(module))) {
-        modules.unshift(library);
-      }
-    });
-
     return modules;
   },
-  getParentLibraries(moduleName) {
-    const libraryNames = [];
-    Object.keys(libraries).forEach(libraryName => {
-      const library = libraries[libraryName];
-      if (library.dependants.includes(moduleName)) {
-        libraryNames.push(libraryName);
-      }
-    });
-    return libraryNames;
-  },
-  getLibraryFiles(name) {
-    const library = libraries[name];
-    const files = library.files.map((file) => path.resolve('./libraries/', name, file))
-    return files;
-  },
-  isLibrary(name) {
-    return !!libraries[name];
-  },
   getModules: _.memoize(function(externalModules) {
     externalModules = externalModules || [];
     var internalModules;
     try {
-      var getInternalModules = function(absolutePath) {
-        return fs.readdirSync(absolutePath)
-          .filter(file => (/^[^\.]+(\.js)?$/).test(file))
-          .reduce((memo, file) => {
-            var moduleName = file.split(new RegExp('[.\\' + path.sep + ']'))[0];
-            var modulePath = path.join(absolutePath, file);
-            if (fs.lstatSync(modulePath).isDirectory()) {
-              modulePath = path.join(modulePath, 'index.js')
-            }
-            if (fs.existsSync(modulePath)) {
-              memo[modulePath] = moduleName;
-            }
-            return memo;
-          }, {});
-      };
-
       var absoluteModulePath = path.join(__dirname, MODULE_PATH);
-      var absoluteLibraryPath = path.join(__dirname, LIBRARY_PATH);
-
-      internalModules = getInternalModules(absoluteModulePath);
-      var internalLibraries = getInternalModules(absoluteLibraryPath);
-      Object.assign(internalModules, internalLibraries);
+      internalModules = fs.readdirSync(absoluteModulePath)
+        .filter(file => (/^[^\.]+(\.js)?$/).test(file))
+        .reduce((memo, file) => {
+          var moduleName = file.split(new RegExp('[.\\' + path.sep + ']'))[0];
+          var modulePath = path.join(absoluteModulePath, file);
+          if (fs.lstatSync(modulePath).isDirectory()) {
+            modulePath = path.join(modulePath, 'index.js')
+          }
+          if (fs.existsSync(modulePath)) {
+            memo[modulePath] = moduleName;
+          }
+          return memo;
+        }, {});
     } catch (err) {
       internalModules = {};
     }
     return Object.assign(externalModules.reduce((memo, module) => {
       try {
         // prefer internal project modules before looking at project dependencies
-        var modulePath = require.resolve(module, {paths: [MODULE_PATH, LIBRARY_PATH]});
-        if (modulePath === '') {
-          modulePath = require.resolve(module);
-        }
+        var modulePath = require.resolve(module, {paths: ['./modules']});
+        if (modulePath === '') modulePath = require.resolve(module);
 
         memo[modulePath] = module;
       } catch (err) {
@@ -142,16 +105,20 @@ module.exports = {
     }, internalModules));
   }),
 
+  getBuiltPath(dev, assetPath) {
+    return path.join(__dirname, dev ? DEV_PATH : BUILD_PATH, assetPath)
+  },
+
   getBuiltModules: function(dev, externalModules) {
     var modules = this.getModuleNames(externalModules);
     if (Array.isArray(externalModules)) {
       modules = _.intersection(modules, externalModules);
     }
-    return modules.map(name => path.join(__dirname, dev ? DEV_PATH : BUILD_PATH, name + '.js'));
+    return modules.map(name => this.getBuiltPath(dev, name + '.js'));
   },
 
   getBuiltPrebidCoreFile: function(dev) {
-    return path.join(__dirname, dev ? DEV_PATH : BUILD_PATH, 'prebid-core' + '.js');
+    return this.getBuiltPath(dev, 'prebid-core.js')
   },
 
   getModulePaths: function(externalModules) {

gulpfile.js

@@ -240,8 +240,15 @@ function bundle(dev, moduleArr) {
       });
     }
   }
+  const coreFile = helpers.getBuiltPrebidCoreFile(dev);
+  const moduleFiles = helpers.getBuiltModules(dev, modules);
+  const depGraph = require(helpers.getBuiltPath(dev, 'dependencies.json'));
+  const dependencies = new Set();
+  [coreFile].concat(moduleFiles).map(name => path.basename(name)).forEach((file) => {
+    (depGraph[file] || []).forEach((dep) => dependencies.add(helpers.getBuiltPath(dev, dep)));
+  })
 
-  var entries = [helpers.getBuiltPrebidCoreFile(dev)].concat(helpers.getBuiltModules(dev, modules));
+  const entries = [coreFile].concat(Array.from(dependencies), moduleFiles);
 
   var outputFileName = argv.bundleName ? argv.bundleName : 'prebid.js';
 

libraries/LIBRARIES.md

@@ -0,0 +1,5 @@
+## Cross-module libraries
+
+Each directory under this one is packaged into a "library" during the build. 
+
+Modules may share code by simply importing from a common library file; if the module is included in the build, any libraries they import from will also be included.

src/AnalyticsAdapter.js → libraries/analyticsAdapter/AnalyticsAdapter.js

@@ -1,7 +1,7 @@
-import CONSTANTS from './constants.json';
-import { ajax } from './ajax.js';
-import { logMessage, _each } from './utils.js';
-import * as events from './events.js'
+import CONSTANTS from '../../src/constants.json';
+import { ajax } from '../../src/ajax.js';
+import { logMessage, _each } from '../../src/utils.js';
+import * as events from '../../src/events.js'
 
 export const _internal = {
   ajax
@@ -31,14 +31,13 @@ const {
 const ENDPOINT = 'endpoint';
 const BUNDLE = 'bundle';
 
-var _sampled = true;
-
 export default function AnalyticsAdapter({ url, analyticsType, global, handler }) {
   const _queue = [];
   let _eventCount = 0;
   let _enableCheck = true;
   let _handlers;
   let _enabled = false;
+  let _sampled = true;
 
   if (analyticsType === ENDPOINT || BUNDLE) {
     _emptyQueue();

src/adapters/analytics/example.js → libraries/analyticsAdapter/examples/example.js

@@ -2,7 +2,7 @@
  * example.js - analytics adapter for Example Analytics Library example
  */
 
-import adapter from '../../AnalyticsAdapter.js';
+import adapter from '../AnalyticsAdapter.js';
 
 export default adapter(
   {

src/adapters/analytics/example2.js → libraries/analyticsAdapter/examples/example2.js

@@ -5,7 +5,7 @@ import { ajax } from '../../../src/ajax.js';
  * example2.js - analytics adapter for Example2 Analytics Endpoint example
  */
 
-import adapter from '../../AnalyticsAdapter.js';
+import adapter from '../AnalyticsAdapter.js';
 
 const url = 'https://httpbin.org/post';
 const analyticsType = 'endpoint';

modules/.submodules.json

@@ -72,17 +72,5 @@
       "enrichmentFpdModule",
       "validationFpdModule"
     ]
-  },
-  "libraries": {
-    "getOrigin": {
-      "files": [
-        "./index.js"
-      ],
-      "dependants": [
-        "ooloAnalyticsAdapter",
-        "resetdigitalBidAdapter",
-        "rtbhouseBidAdapter.js"
-      ]
-    }
   }
 }

modules/adWMGAnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 import { ajax } from '../src/ajax.js';

modules/adagioAnalyticsAdapter.js

@@ -2,7 +2,7 @@
  * Analytics Adapter for Adagio
  */
 
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 import { getWindowTop } from '../src/utils.js';

modules/adkernelAdnAnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { logError, parseUrl, _each } from '../src/utils.js';

modules/adlooxAnalyticsAdapter.js

@@ -5,7 +5,7 @@
  */
 
 import adapterManager from '../src/adapterManager.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import {loadExternalScript} from '../src/adloader.js';
 import {auctionManager} from '../src/auctionManager.js';
 import {AUCTION_COMPLETED} from '../src/auction.js';

modules/adomikAnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import {logInfo} from '../src/utils.js';

modules/adxcgAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { parseSizesInput, uniques, buildUrl, logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 

modules/adxpremiumAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import {deepClone, logError, logInfo} from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 import {includes} from '../src/polyfill.js';

modules/appierAnalyticsAdapter.js

@@ -1,5 +1,5 @@
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import {getGlobal} from '../src/prebidGlobal.js';

modules/atsAnalyticsAdapter.js

@@ -1,5 +1,5 @@
 import { logError, logInfo } from '../src/utils.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adaptermanager from '../src/adapterManager.js';
 import {ajax} from '../src/ajax.js';

modules/bidwatchAnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 import { ajax } from '../src/ajax.js';

modules/byDataAnalyticsAdapter.js

@@ -2,7 +2,7 @@ import { deepClone, logInfo, logError } from '../src/utils.js';
 import Base64 from 'crypto-js/enc-base64';
 import hmacSHA512 from 'crypto-js/hmac-sha512';
 import enc from 'crypto-js/enc-utf8';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { getStorageManager } from '../src/storageManager.js';

modules/concertAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { logMessage } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 

modules/datablocksAnalyticsAdapter.js

@@ -2,7 +2,7 @@
  * Analytics Adapter for Datablocks
  */
 
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 
 var datablocksAdapter = adapter({

modules/eplanningAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { logError } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 

modules/fintezaAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { parseUrl, logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import { getStorageManager } from '../src/storageManager.js';
 import CONSTANTS from '../src/constants.json';

modules/hadronAnalyticsAdapter.js

@@ -1,5 +1,5 @@
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import * as utils from '../src/utils.js';
 import CONSTANTS from '../src/constants.json';

modules/id5AnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import buildAdapter from '../src/AnalyticsAdapter.js';
+import buildAdapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { ajax } from '../src/ajax.js';

modules/invisiblyAnalyticsAdapter.js

@@ -2,7 +2,7 @@
  * invisiblyAdapterAdapter.js - analytics adapter for Invisibly
  */
 import { ajaxBuilder } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 
 import { generateUUID, logInfo } from '../src/utils.js';

modules/kargoAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 

modules/konduitAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { parseSizesInput, logError, uniques } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import { targeting } from '../src/targeting.js';
 import { config } from '../src/config.js';

modules/livewrappedAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { timestamp, logInfo, getWindowTop } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { getGlobal } from '../src/prebidGlobal.js';

modules/liveyieldAnalyticsAdapter.js

@@ -1,5 +1,5 @@
 import { logError } from '../src/utils.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';