Merge pull request #145 from chuckdumont/work2

Reduce local namespace polution in bootstrap

Author: Chuck Dumont

lib/DojoAMDMainTemplate.runtime.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
- /* globals loaderScope __webpack_require__ installedModules */
+ /* globals loaderScope __webpack_require__ installedModules globalRequireContext */
 
 module.exports = {
 	main: function() {
@@ -30,10 +30,10 @@ module.exports = {
 			return loaderScope.require.toAbsMid(name, referenceModule);
 		}
 
-		// dojo require function");
+		// dojo require function.
 		function req(config, dependencies, callback) {
 			return contextRequire(config, dependencies, callback, 0, req);
-		}
+		};
 
 		function createContextRequire(moduleId) { // eslint-disable-line no-unused-vars
 			if (typeof(moduleId) === "number") { // Number.isInteger does not work in IE
@@ -114,10 +114,10 @@ module.exports = {
 		}
 
 		function contextRequire(a1, a2, a3, referenceModule, req) { // eslint-disable-line no-shadow
-			if (!referenceModule && loaderScope.buildContext) {
+			if (!referenceModule && globalRequireContext) {
 				// No reference module means we were called by global require, so use the build context
 				// as the reference module since that's what would have been used for constructing the absMid
-				referenceModule = loaderScope.buildContext + 'x';
+				referenceModule = globalRequireContext + 'x';
 			}
 			var type = ({}.toString).call(a1);
 			if (type === '[object String]') {
@@ -151,10 +151,35 @@ module.exports = {
 			}
 		}
 	},
+
+	makeDeprecatedReq: function() {
+		(function() {
+			function warnDeprecated() {
+				console.warn('req is deprecated and will be removed in a future release.  Use __webpack_require__.dj.r instead.');
+			}
+			var req = __webpack_require__.dj.r;
+			function depReq() {
+				warnDeprecated();
+				return req.apply(this, arguments);
+			};
+			Object.keys(req).forEach(function(name) {
+				Object.defineProperty(depReq, name, {
+					get: function() {
+						warnDeprecated();
+						return req[name];
+					},
+					enumerable: true,
+					configurable: false
+				});
+			});
+			return depReq;
+		})();
+	},
+
 	undef: function() {
 		function undef(mid, referenceModule) { // eslint-disable-line no-unused-vars
-			if (!referenceModule && typeof buildContext !== 'undefined') {
-				referenceModule = loaderScope.buildContext + 'x';		// global require
+			if (!referenceModule && globalRequireContext) {
+				referenceModule = globalRequireContext + 'x';		// global require
 			}
 			var module = findModule(mid, referenceModule, true, true); // eslint-disable-line no-undef
 			if (module) {

lib/DojoAMDMainTemplatePlugin.js

@@ -46,7 +46,6 @@ module.exports = class DojoAMDMainTemplatePlugin {
 			});
 			compilation.plugin("before-chunk-assets", this.relativizeAbsoluteAbsMids.bind(context));
 			plugin(compilation.mainTemplate, {
-				"bootstrap"               : this.bootstrap,
 				"require-extensions"      : this.requireExtensions,
 				"dojo-require-extensions" : this.dojoRequireExtensions, // plugin specific event
 				"render-dojo-config-vars" : this.renderDojoConfigVars, // plugin specific event
@@ -67,11 +66,14 @@ module.exports = class DojoAMDMainTemplatePlugin {
 		this.embeddedLoaderHasConfigApi = !!scope.require.packs;
 	}
 
-	bootstrap(source, chunk) {
-		const buf = [];
+	requireExtensions(...args) {
+		return this.compilation.mainTemplate.applyPluginsWaterfall("dojo-require-extensions", ...args);	// plugin specific event
+	}
+
+	dojoRequireExtensions(source, chunk, ...rest) {
 		const {mainTemplate} = this.compilation;
 		const runtimeSource = Template.getFunctionContent(require("./DojoAMDMainTemplate.runtime.js").main);
-		buf.push(source);
+		const buf = [];
 		buf.push(runtimeSource);
 		buf.push("req.toUrl = toUrl;");
 		buf.push("req.toAbsMid = toAbsMid;");
@@ -89,22 +91,12 @@ module.exports = class DojoAMDMainTemplatePlugin {
 			buf.push(mainTemplate.indent(`(this||window)[${jsonpFn}].registerAbsMids = registerAbsMids;`));
 		}
 		buf.push("})();");
-		return mainTemplate.asString(buf);
-	}
-
-	requireExtensions(...args) {
-		return this.compilation.mainTemplate.applyPluginsWaterfall("dojo-require-extensions", ...args);	// plugin specific event
-	}
-
-	dojoRequireExtensions(source, ...rest) {
-		const {mainTemplate} = this.compilation;
-		const buf = [];
-		buf.push(source);
 		buf.push("");
 		buf.push("// expose the Dojo compatibility functions as a properties of " + mainTemplate.requireFn);
 		buf.push("var globalScope = (function(){return this||window;})();");
 		buf.push(mainTemplate.requireFn + ".dj = {");
 		buf.push(mainTemplate.indent([
+			"r: req,",
 			"c: createContextRequire,",
 			"m: dojoModuleFromWebpackModule,",
 			"h: resolveTernaryHasExpression,",
@@ -131,10 +123,8 @@ module.exports = class DojoAMDMainTemplatePlugin {
 but the loader specified at ${this.embeddedLoaderFilename} was built without the config API.  Please rebuild the embedded loader with 'dojo-config-api' feature enabled`);
 			}
 		}
-		buf.push(mainTemplate.applyPluginsWaterfall("render-dojo-config-vars", loaderScope, "", ...rest));
-		if (this.buildContext) {
-			buf.push(`loaderScope.buildContext = "${this.buildContext}"`);
-		}
+		buf.push(mainTemplate.applyPluginsWaterfall("render-dojo-config-vars", loaderScope, "", chunk, ...rest));
+		buf.push(`var globalRequireContext = "${this.globalRequireContext || 'null'}"`);
 		buf.push("var dojoLoader = " + mainTemplate.requireFn + "(" + JSON.stringify(dojoLoaderModule.id) + ");");
 		buf.push("dojoLoader.call(loaderScope, userConfig, defaultConfig, loaderScope, loaderScope);");
 		if (loaderScope) {
@@ -148,11 +138,15 @@ but the loader specified at ${this.embeddedLoaderFilename} was built without the
 		buf.push("req.signal = loaderScope.require.signal");
 		const loaderConfig = this.compiler.applyPluginsBailResult("get dojo config");
 		if (loaderConfig.has && loaderConfig.has['dojo-undef-api']) {
-			const undefSource = Template.getFunctionContent(require("./DojoAMDMainTemplate.runtime.js").undef);
-			buf.push("req.undef = " + undefSource);
+			buf.push("req.undef = " +  Template.getFunctionContent(require("./DojoAMDMainTemplate.runtime.js").undef));
 		}
-		buf.push("");
-		return mainTemplate.asString(buf);
+		return mainTemplate.asString([
+			source,
+			"(function() {",
+			mainTemplate.indent(buf),
+			"})();",
+			"var req=" + Template.getFunctionContent(require("./DojoAMDMainTemplate.runtime.js").makeDeprecatedReq)
+		]);
 	}
 
 	renderDojoConfigVars(loaderScope) {
@@ -224,20 +218,20 @@ but the loader specified at ${this.embeddedLoaderFilename} was built without the
 	 * They have the form '$$root$$/<absolute-path>' where '$$root$$' can be changed using the globalContext.varName
 	 * option.  So as not to expose absolute paths on the client for security reasons, we determine the closest common
 	 * directory for all the absolute absMids and rewrite the absMids in the form '$$root$$/<relative-path>', where the
-	 * path is relative to the buildContext path, and the buildContext path is calculated as the globalContext
+	 * path is relative to the globalRequireContext path, and the globalRequireContext path is calculated as the globalContext
 	 * directory relative to the closest common directory.  For example, if the globalContext path is '/a/b/c/d/e'
-	 * and the closest common directory is '/a/b/c', then the buildContext path would be'$$root$$/d/e', and the
+	 * and the closest common directory is '/a/b/c', then the globalRequireContext path would be'$$root$$/d/e', and the
 	 * modified absMid for the module with absolute absMid '$$root$$/a/b/c/d/f/foo' would be '$$root$$/d/f/foo'.  The
-	 * buildContext path is emitted to the client so that runtime global require calls specifying relative module ids
+	 * globalRequireContext path is emitted to the client so that runtime global require calls specifying relative module ids
 	 * can be resolved on the client.  If at runtime, the client calls global require with the module id '../f/foo',
-	 * then the absMid for the module will be computed by resolving the specified module id against the buildContext
+	 * then the absMid for the module will be computed by resolving the specified module id against the globalRequireContext
 	 * path ('$$root$$/d/e'), resulting in '$$root$$/d/f/foo' and the client will locate the module by looking
 	 * it up in the table of registered absMids.
 	 *
-	 * In the event that runtime global require calls attempt to traverse the buildContext parent hierarchy
+	 * In the event that runtime global require calls attempt to traverse the globalRequireContext parent hierarchy
 	 * beyond the level of the closest common directory, the globalContext.numParents option can be specified
 	 * to indicate the number of parent directories beyond the closest common directory to include in
-	 * the buildContext path.  In the example above, a numParents value of 1 would result in the buildContext
+	 * the globalRequireContext path.  In the example above, a numParents value of 1 would result in the globalRequireContext
 	 * path changing from '$$root$$/d/e' to '$$root$$/c/d/e' and the absMid for the module with absolute path
 	 * '/a/b/c/d/f/foo' changing from '$$root$$/d/f/foo' to '$$root$$/c/d/f/foo'.
 	 */
@@ -273,9 +267,9 @@ but the loader specified at ${this.embeddedLoaderFilename} was built without the
 			// Determine the relative path from the adjusted common root to the global context and set it
 			// as the build context that gets adorned and emitted to the client.
 			var relative = path.relative(commonRoot, context);
-			this.buildContext = path.join(rootVarName, relative).replace(/\\/g,'/');
-			if (!this.buildContext.endsWith('/')) {
-				this.buildContext += '/';
+			this.globalRequireContext = path.join(rootVarName, relative).replace(/\\/g,'/');
+			if (!this.globalRequireContext.endsWith('/')) {
+				this.globalRequireContext += '/';
 			}
 			// Now rewrite the absMids to be relative to the computed build context
 			relMods.forEach(module => {

lib/ScopedRequirePlugin.js

@@ -7,20 +7,13 @@ module.exports = class ScopedRequirePlugin {
 				return "";	// don't set global require
 			});
 
-			compilation.mainTemplate.plugin("require", function(source) {
-				// This code, together with the 'render' plugin below, defines a scoped
-				// Dojo require variable for each AMD module so that referencing 'require' from
-				// within the module will yield the Dojo function.
-				return source.replace(/__webpack_require__\);/g, "__webpack_require__, req);");
-			});
-
 			compilation.moduleTemplate.plugin("render", function(source, module) {
 				var result = source;
 				if (module.isAMD) {
 					// Define a module scoped 'require' variable for AMD modules that references the
 					// the Dojo require function.
 					result = new ConcatSource();
-					result.add("var require = arguments[3];");
+					result.add("var require = __webpack_require__.dj.r;");
 					result.add(source);
 				}
 				return result;