CORE: allow to disable setting the pbjs global variable

.eslintrc.js

@@ -20,6 +20,7 @@ module.exports = {
   ],
   globals: {
     '$$PREBID_GLOBAL$$': false,
+    '$$DEFINE_PREBID_GLOBAL$$': false,
     'BROWSERSTACK_USERNAME': false,
     'BROWSERSTACK_KEY': false,
     'FEATURES': 'readonly',

package.json

@@ -28,6 +28,7 @@
     "prebid"
   ],
   "globalVarName": "pbjs",
+  "defineGlobal": true,
   "author": "the prebid.js contributors",
   "license": "Apache-2.0",
   "engines": {

plugins/pbjsGlobals.js

@@ -28,10 +28,12 @@ function getNpmVersion(version) {
 
 module.exports = function(api, options) {
   const pbGlobal = options.globalVarName || prebid.globalVarName;
+  const defineGlobal = typeof (options.defineGlobal) !== 'undefined' ? options.defineGlobal : prebid.defineGlobal;
   const features = featureMap(options.disableFeatures);
   let replace = {
     '$prebid.version$': prebid.version,
     '$$PREBID_GLOBAL$$': pbGlobal,
+    '$$DEFINE_PREBID_GLOBAL$$': defineGlobal,
     '$$REPO_AND_VERSION$$': `${prebid.repository.url.split('/')[3]}_prebid_${prebid.version}`,
     '$$PREBID_DIST_URL_BASE$$': options.prebidDistUrlBase || `https://cdn.jsdelivr.net/npm/prebid.js@${getNpmVersion(prebid.version)}/dist/`
   };
@@ -58,21 +60,42 @@ module.exports = function(api, options) {
     return null;
   }
 
+  function hasGetGlobalsImport(body) {
+    for (let i = 0; i < body.length; i++) {
+      if (body[i].type === 'ImportDeclaration' && body[i].source.value.match(/prebidGlobal(\.js)?$/)) {
+        for (let j = 0; j < body[i].specifiers.length; j++) {
+          if (body[i].specifiers[j].local.name === 'getGlobal') {
+            return true;
+          }
+        }
+      }
+    }
+    return false;
+  }
+
   return {
     visitor: {
       Program(path, state) {
         const modName = getModuleName(state.filename);
         if (modName != null) {
           // append "registration" of module file to $$PREBID_GLOBAL$$.installedModules
-          path.node.body.push(...api.parse(`window.${pbGlobal}.installedModules.push('${modName}');`, {filename: state.filename}).program.body);
+
+          if (defineGlobal) {
+            path.node.body.push(...api.parse(`window.${pbGlobal}.installedModules.push('${modName}');`, {filename: state.filename}).program.body);
+          } else {
+            if (!hasGetGlobalsImport(path.node.body)) {
+              path.node.body.unshift(...api.parse(`import {getGlobal} from '../src/prebidGlobal.js';const ${pbGlobal} = getGlobal();`, {filename: state.filename}).program.body);
+            }
+            path.node.body.push(...api.parse(`${pbGlobal}.installedModules.push('${modName}');`, {filename: state.filename}).program.body);
+          }
         }
       },
       StringLiteral(path) {
         Object.keys(replace).forEach(name => {
           if (path.node.value.includes(name)) {
             path.node.value = path.node.value.replace(
               new RegExp(escapeRegExp(name), 'g'),
-              replace[name]
+              replace[name].toString()
             );
           }
         });
@@ -102,7 +125,7 @@ module.exports = function(api, options) {
               );
             } else {
               path.replaceWith(
-                t.Identifier(replace[name])
+                t.Identifier(replace[name].toString())
               );
             }
           }

src/Renderer.js

@@ -3,6 +3,9 @@ import {
   logError, logWarn, logMessage, deepAccess
 } from './utils.js';
 import {find} from './polyfill.js';
+import {getGlobal} from './prebidGlobal.js';
+
+const $$PREBID_GLOBAL$$ = getGlobal();
 const moduleCode = 'outstream';
 
 /**

src/auction.js

@@ -94,6 +94,7 @@ import {GreedyPromise} from './utils/promise.js';
 import {useMetrics} from './utils/perfMetrics.js';
 import {createBid} from './bidfactory.js';
 import {adjustCpm} from './utils/cpm.js';
+import {getGlobal} from './prebidGlobal.js';
 
 const { syncUsers } = userSync;
 
@@ -111,6 +112,8 @@ const outstandingRequests = {};
 const sourceInfo = {};
 const queuedCalls = [];
 
+const $$PREBID_GLOBAL$$ = getGlobal();
+
 /**
  * Clear global state for tests
  */

src/prebidGlobal.js

@@ -1,13 +1,16 @@
 // if $$PREBID_GLOBAL$$ already exists in global document scope, use it, if not, create the object
 // global defination should happen BEFORE imports to avoid global undefined errors.
-window.$$PREBID_GLOBAL$$ = (window.$$PREBID_GLOBAL$$ || {});
-window.$$PREBID_GLOBAL$$.cmd = window.$$PREBID_GLOBAL$$.cmd || [];
-window.$$PREBID_GLOBAL$$.que = window.$$PREBID_GLOBAL$$.que || [];
+const scope = !$$DEFINE_PREBID_GLOBAL$$ ? {} : window;
+scope.$$PREBID_GLOBAL$$ = (scope.$$PREBID_GLOBAL$$ || {});
+scope.$$PREBID_GLOBAL$$.cmd = scope.$$PREBID_GLOBAL$$.cmd || [];
+scope.$$PREBID_GLOBAL$$.que = scope.$$PREBID_GLOBAL$$.que || [];
 
 // create a pbjs global pointer
-window._pbjsGlobals = window._pbjsGlobals || [];
-window._pbjsGlobals.push('$$PREBID_GLOBAL$$');
+if (scope === window) {
+  scope._pbjsGlobals = scope._pbjsGlobals || [];
+  scope._pbjsGlobals.push('$$PREBID_GLOBAL$$');
+}
 
 export function getGlobal() {
-  return window.$$PREBID_GLOBAL$$;
+  return scope.$$PREBID_GLOBAL$$;
 }

src/utils.js

@@ -3,6 +3,7 @@ import clone from 'just-clone';
 import {find, includes} from './polyfill.js';
 import CONSTANTS from './constants.json';
 import {GreedyPromise} from './utils/promise.js';
+import {getGlobal} from './prebidGlobal.js';
 export { default as deepAccess } from 'dlv/index.js';
 export { dset as deepSetValue } from 'dset';
 
@@ -21,6 +22,8 @@ let consoleErrorExists = Boolean(consoleExists && window.console.error);
 
 let eventEmitter;
 
+const $$PREBID_GLOBAL$$ = getGlobal();
+
 export function _setEventEmitter(emitFn) {
   // called from events.js - this hoop is to avoid circular imports
   eventEmitter = emitFn;