Prebid Core: Library support (prebid#8527)

* adds extra utils * imports from extra utils * adds libraries to .submodules * adds libraries to build process * renames extraUtils * update userId submodules list
bwhisp · Jul 13, 2022 · d661ea2 · d661ea2
1 parent e364dda
commit d661ea2
Show file tree

Hide file tree

Showing 9 changed files with 168 additions and 100 deletions.
diff --git a/gulpHelpers.js b/gulpHelpers.js
@@ -6,9 +6,12 @@ const MANIFEST = 'package.json';
 const through = require('through2');
 const _ = require('lodash');
 const gutil = require('gulp-util');
-const submodules = require('./modules/.submodules.json');
+const dependencyMap = require('./modules/.submodules.json');
+const submodules = dependencyMap.parentModules;
+const libraries = dependencyMap.libraries;
 
 const MODULE_PATH = './modules';
+const LIBRARY_PATH = './libraries';
 const BUILD_PATH = './build/dist';
 const DEV_PATH = './build/dev';
 const ANALYTICS_PATH = '../analytics';
@@ -68,34 +71,68 @@ 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 => require.resolve(file, {paths: ['./libraries/' + name + '/']}));
+    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);
-      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;
-        }, {});
+      var absoluteLibraryPath = path.join(__dirname, LIBRARY_PATH);
+
+      internalModules = getInternalModules(absoluteModulePath);
+      var internalLibraries = getInternalModules(absoluteLibraryPath);
+      Object.assign(internalModules, internalLibraries);
     } 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: ['./modules']});
-        if (modulePath === '') modulePath = require.resolve(module);
+        var modulePath = require.resolve(module, {paths: [MODULE_PATH, LIBRARY_PATH]});
+        if (modulePath === '') {
+          modulePath = require.resolve(module);
+        }
 
         memo[modulePath] = module;
       } catch (err) {

diff --git a/gulpfile.js b/gulpfile.js
@@ -71,6 +71,7 @@ function lint(done) {
   return gulp.src([
     'src/**/*.js',
     'modules/**/*.js',
+    'libraries/**/*.js',
     'test/**/*.js',
     'plugins/**/*.js',
     '!plugins/**/node_modules/**',

diff --git a/libraries/getOrigin/index.js b/libraries/getOrigin/index.js
@@ -0,0 +1,11 @@
+/**
+ * Returns the origin
+ */
+export function getOrigin() {
+  // IE10 does not have this property. https://gist.github.com/hbogs/7908703
+  if (!window.location.origin) {
+    return window.location.protocol + '//' + window.location.hostname + (window.location.port ? ':' + window.location.port : '');
+  } else {
+    return window.location.origin;
+  }
+}
diff --git a/modules/.submodules.json b/modules/.submodules.json
@@ -1,71 +1,85 @@
 {
-  "userId": [
-    "33acrossIdSystem",
-    "admixerIdSystem",
-    "adtelligentIdSystem",
-    "amxIdSystem",
-    "britepoolIdSystem",
-    "connectIdSystem",
-    "cpexIdSystem",
-    "criteoIdSystem",
-    "dacIdSystem",
-    "deepintentDpesIdSystem",
-    "dmdIdSystem",
-    "fabrickIdSystem",
-    "hadronIdSystem",
-    "id5IdSystem",
-    "ftrackIdSystem",
-    "identityLinkIdSystem",
-    "idxIdSystem",
-    "imuIdSystem",
-    "intentIqIdSystem",
-    "justIdSystem",
-    "kinessoIdSystem",
-    "liveIntentIdSystem",
-    "lotamePanoramaIdSystem",
-    "merkleIdSystem",
-    "mwOpenLinkIdSystem",
-    "naveggIdSystem",
-    "netIdSystem",
-    "novatiqIdSystem",
-    "parrableIdSystem",
-    "pubProvidedIdSystem",
-    "publinkIdSystem",
-    "quantcastIdSystem",
-    "sharedIdSystem",
-    "tapadIdSystem",
-    "trustpidSystem",
-    "uid2IdSystem",
-    "unifiedIdSystem",
-    "verizonMediaIdSystem",
-    "zeotapIdPlusIdSystem",
-    "adqueryIdSystem", 
-    "gravitoIdSystem"
-  ],
-  "adpod": [
-    "freeWheelAdserverVideo",
-    "dfpAdServerVideo"
-  ],
-  "rtdModule": [
-    "airgridRtdProvider",
-    "akamaiDapRtdProvider",
-    "browsiRtdProvider",
-    "dgkeywordRtdProvider",
-    "geoedgeRtdProvider",
-    "hadronRtdProvider",
-    "haloRtdProvider",
-    "iasRtdProvider",
-    "jwplayerRtdProvider",
-    "medianetRtdProvider",
-    "optimeraRtdProvider",
-    "permutiveRtdProvider",
-    "reconciliationRtdProvider",
-    "sirdataRtdProvider",
-    "timeoutRtdProvider",
-    "weboramaRtdProvider"
-  ],
-  "fpdModule": [
-    "enrichmentFpdModule",
-    "validationFpdModule"
-  ]
+  "parentModules": {
+    "userId": [
+      "33acrossIdSystem",
+      "admixerIdSystem",
+      "adtelligentIdSystem",
+      "amxIdSystem",
+      "britepoolIdSystem",
+      "connectIdSystem",
+      "cpexIdSystem",
+      "criteoIdSystem",
+      "dacIdSystem",
+      "deepintentDpesIdSystem",
+      "dmdIdSystem",
+      "fabrickIdSystem",
+      "hadronIdSystem",
+      "id5IdSystem",
+      "ftrackIdSystem",
+      "identityLinkIdSystem",
+      "idxIdSystem",
+      "imuIdSystem",
+      "intentIqIdSystem",
+      "justIdSystem",
+      "kinessoIdSystem",
+      "liveIntentIdSystem",
+      "lotamePanoramaIdSystem",
+      "merkleIdSystem",
+      "mwOpenLinkIdSystem",
+      "naveggIdSystem",
+      "netIdSystem",
+      "novatiqIdSystem",
+      "parrableIdSystem",
+      "pubProvidedIdSystem",
+      "publinkIdSystem",
+      "quantcastIdSystem",
+      "sharedIdSystem",
+      "tapadIdSystem",
+      "trustpidSystem",
+      "uid2IdSystem",
+      "unifiedIdSystem",
+      "verizonMediaIdSystem",
+      "zeotapIdPlusIdSystem",
+      "adqueryIdSystem",
+      "gravitoIdSystem"
+    ],
+    "adpod": [
+      "freeWheelAdserverVideo",
+      "dfpAdServerVideo"
+    ],
+    "rtdModule": [
+      "airgridRtdProvider",
+      "akamaiDapRtdProvider",
+      "browsiRtdProvider",
+      "dgkeywordRtdProvider",
+      "geoedgeRtdProvider",
+      "hadronRtdProvider",
+      "haloRtdProvider",
+      "iasRtdProvider",
+      "jwplayerRtdProvider",
+      "medianetRtdProvider",
+      "optimeraRtdProvider",
+      "permutiveRtdProvider",
+      "reconciliationRtdProvider",
+      "sirdataRtdProvider",
+      "timeoutRtdProvider",
+      "weboramaRtdProvider"
+    ],
+    "fpdModule": [
+      "enrichmentFpdModule",
+      "validationFpdModule"
+    ]
+  },
+  "libraries": {
+    "getOrigin": {
+      "files": [
+        "./index.js"
+      ],
+      "dependants": [
+        "ooloAnalyticsAdapter",
+        "resetdigitalBidAdapter",
+        "rtbhouseBidAdapter.js"
+      ]
+    }
+  }
 }
diff --git a/modules/ooloAnalyticsAdapter.js b/modules/ooloAnalyticsAdapter.js
@@ -1,4 +1,5 @@
-import { _each, deepClone, pick, deepSetValue, getOrigin, logError, logInfo } from '../src/utils.js';
+import { _each, deepClone, pick, deepSetValue, logError, logInfo } from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import adapter from '../src/AnalyticsAdapter.js'
 import adapterManager from '../src/adapterManager.js'
 import CONSTANTS from '../src/constants.json'

diff --git a/modules/resetdigitalBidAdapter.js b/modules/resetdigitalBidAdapter.js
@@ -1,5 +1,6 @@
 
-import { timestamp, deepAccess, getOrigin } from '../src/utils.js';
+import { timestamp, deepAccess } from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import { config } from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 const BIDDER_CODE = 'resetdigital';

diff --git a/modules/rtbhouseBidAdapter.js b/modules/rtbhouseBidAdapter.js
@@ -1,4 +1,5 @@
-import {deepAccess, getOrigin, isArray, logError} from '../src/utils.js';
+import {deepAccess, isArray, logError} from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import {BANNER, NATIVE} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {includes} from '../src/polyfill.js';

diff --git a/src/utils.js b/src/utils.js
@@ -925,17 +925,6 @@ export function getUserConfiguredParams(adUnits, adUnitCode, bidder) {
     .filter((bidderData) => bidderData.bidder === bidder)
     .map((bidderData) => bidderData.params || {});
 }
-/**
- * Returns the origin
- */
-export function getOrigin() {
-  // IE10 does not have this property. https://gist.github.com/hbogs/7908703
-  if (!window.location.origin) {
-    return window.location.protocol + '//' + window.location.hostname + (window.location.port ? ':' + window.location.port : '');
-  } else {
-    return window.location.origin;
-  }
-}
 
 /**
  * Returns Do Not Track state

diff --git a/webpack.conf.js b/webpack.conf.js
@@ -32,12 +32,25 @@ module.exports = {
       }
     };
     const selectedModules = new Set(helpers.getArgModules());
+
     Object.entries(helpers.getModules()).forEach(([fn, mod]) => {
       if (selectedModules.size === 0 || selectedModules.has(mod)) {
-        entry[mod] = {
+        const moduleEntry = {
           import: fn,
           dependOn: 'prebid-core'
+        };
+
+        if (helpers.isLibrary(mod)) {
+          const libraryFiles = helpers.getLibraryFiles(mod);
+          moduleEntry.import = libraryFiles || moduleEntry.import;
         }
+
+        const libraries = helpers.getParentLibraries(mod);
+        if (libraries.length) {
+          moduleEntry.dependOn = ['prebid-core'].concat(libraries);
+        }
+
+        entry[mod] = moduleEntry;
       }
     });
     return entry;