Submodule system using hooks

gulpHelpers.js

@@ -6,12 +6,14 @@ const MANIFEST = 'package.json';
 const through = require('through2');
 const _ = require('lodash');
 const gutil = require('gulp-util');
+const submodules = require('./modules/.submodules.json');
 
 const MODULE_PATH = './modules';
 const BUILD_PATH = './build/dist';
 const DEV_PATH = './build/dev';
 const ANALYTICS_PATH = '../analytics';
 
+
 // get only subdirectories that contain package.json with 'main' property
 function isModuleDirectory(filePath) {
   try {
@@ -39,7 +41,18 @@ module.exports = {
       .replace(/\/>/g, '\\/>');
   },
   getArgModules() {
-    var modules = (argv.modules || '').split(',').filter(module => !!module);
+    var modules = (argv.modules || '')
+      .split(',')
+      .filter(module => !!module);
+
+    Object.keys(submodules).forEach(parentModule => {
+      if (
+        !modules.includes(parentModule) &&
+        modules.some(module => submodules[parentModule].includes(module))
+      ) {
+        modules.unshift(parentModule);
+      }
+    });
 
     try {
       if (modules.length === 1 && path.extname(modules[0]).toLowerCase() === '.json') {

modules/.submodules.json

@@ -0,0 +1,7 @@
+{
+  "userId": [
+    "digiTrustIdSystem",
+    "pubCommonIdSystem",
+    "unifiedIdSystem"
+  ]
+}

modules/digiTrustIdSystem.js

@@ -12,7 +12,7 @@
 // import { config } from 'src/config';
 import * as utils from '../src/utils'
 import { ajax } from '../src/ajax';
-import { attachIdSystem } from '../modules/userId';
+import { submodule } from '../src/hook';
 // import { getGlobal } from 'src/prebidGlobal';
 
 /**
@@ -336,4 +336,4 @@ export const digiTrustIdSubmodule = {
   _testInit: surfaceTestHook
 };
 
-attachIdSystem(digiTrustIdSubmodule);
+submodule('userId', digiTrustIdSubmodule);

modules/pubCommonIdSystem.js

@@ -5,7 +5,8 @@
  * @requires module:modules/userId
  */
 
-import * as utils from '../src/utils.js'
+import * as utils from '../src/utils.js';
+import { submodule } from '../src/hook';
 
 /** @type {Submodule} */
 export const pubCommonIdSubmodule = {
@@ -40,3 +41,5 @@ export const pubCommonIdSubmodule = {
     return (pubcid) || utils.generateUUID();
   }
 };
+
+submodule('userId', pubCommonIdSubmodule);

modules/unifiedIdSystem.js

@@ -7,6 +7,7 @@
 
 import * as utils from '../src/utils.js'
 import {ajax} from '../src/ajax.js';
+import { submodule } from '../src/hook';
 
 /** @type {Submodule} */
 export const unifiedIdSubmodule = {
@@ -53,3 +54,5 @@ export const unifiedIdSubmodule = {
     }
   }
 };
+
+submodule('userId', unifiedIdSubmodule);

modules/userId.js

@@ -13,15 +13,15 @@
  * @name Submodule#getId
  * @param {SubmoduleParams} configParams
  * @param {ConsentData} consentData
- * @return {(Object|function} id data or a callback, the callback is called on the auction end event
+ * @return {(Object|function)} id data or a callback, the callback is called on the auction end event
  */
 
 /**
  * @function
  * @summary decode a stored value for passing to bid requests
  * @name Submodule#decode
  * @param {Object|string} value
- * @return {(Object|undefined}
+ * @return {(Object|undefined)}
  */
 
 /**
@@ -73,9 +73,8 @@ import events from '../src/events.js';
 import * as utils from '../src/utils.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 import {gdprDataHandler} from '../src/adapterManager.js';
-import {unifiedIdSubmodule} from './unifiedIdSystem.js';
-import {pubCommonIdSubmodule} from './pubCommonIdSystem.js';
 import CONSTANTS from '../src/constants.json';
+import { module } from '../src/hook'
 
 const MODULE_NAME = 'User ID';
 const COOKIE = 'cookie';
@@ -419,6 +418,4 @@ export function init(config) {
 // init config update listener to start the application
 init(config);
 
-// add submodules after init has been called
-attachIdSystem(pubCommonIdSubmodule);
-attachIdSystem(unifiedIdSubmodule);
+module('userId', attachIdSystem);

src/hook.js

@@ -13,3 +13,16 @@ export function setupBeforeHookFnOnce(baseFn, hookFn, priority = 15) {
     baseFn.before(hookFn, priority);
   }
 }
+
+export function module(name, install) {
+  hook('async', function (submodules) {
+    submodules.forEach(args => install(...args));
+  }, name)([]); // will be queued until hook.ready() called in pbjs.processQueue();
+}
+
+export function submodule(name, ...args) {
+  getHook(name).before((next, modules) => {
+    modules.push(args);
+    next(modules);
+  });
+}

webpack.conf.js

@@ -25,8 +25,14 @@ plugins.push(  // this plugin must be last so it can be easily removed for karma
   new webpack.optimize.CommonsChunkPlugin({
     name: 'prebid',
     filename: 'prebid-core.js',
-    minChunks: function(module, count) {
-      return !(count < 2 || neverBundle.indexOf(path.basename(module.resource)) !== -1)
+    minChunks: function(module) {
+      return (
+        (
+          module.context && module.context === path.resolve('./src') &&
+          !(module.resource && neverBundle.some(name => module.resource.includes(name)))
+        ) ||
+        module.resource && module.resource.includes(path.resolve('./node_modules/core-js'))
+      );
     }
   })
 );