DelegatedModule.js 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { OriginalSource, RawSource } = require("webpack-sources");
  7. const Module = require("./Module");
  8. const { JS_TYPES } = require("./ModuleSourceTypesConstants");
  9. const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("./ModuleTypeConstants");
  10. const RuntimeGlobals = require("./RuntimeGlobals");
  11. const DelegatedSourceDependency = require("./dependencies/DelegatedSourceDependency");
  12. const StaticExportsDependency = require("./dependencies/StaticExportsDependency");
  13. const makeSerializable = require("./util/makeSerializable");
  14. /** @typedef {import("webpack-sources").Source} Source */
  15. /** @typedef {import("../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptions */
  16. /** @typedef {import("../declarations/plugins/DllReferencePlugin").DllReferencePluginOptions} DllReferencePluginOptions */
  17. /** @typedef {import("./ChunkGraph")} ChunkGraph */
  18. /** @typedef {import("./Compilation")} Compilation */
  19. /** @typedef {import("./Dependency").UpdateHashContext} UpdateHashContext */
  20. /** @typedef {import("./DependencyTemplates")} DependencyTemplates */
  21. /** @typedef {import("./Generator").SourceTypes} SourceTypes */
  22. /** @typedef {import("./LibManifestPlugin").ManifestModuleData} ManifestModuleData */
  23. /** @typedef {import("./Module").BuildCallback} BuildCallback */
  24. /** @typedef {import("./Module").BuildMeta} BuildMeta */
  25. /** @typedef {import("./Module").CodeGenerationContext} CodeGenerationContext */
  26. /** @typedef {import("./Module").CodeGenerationResult} CodeGenerationResult */
  27. /** @typedef {import("./Module").LibIdentOptions} LibIdentOptions */
  28. /** @typedef {import("./Module").NeedBuildCallback} NeedBuildCallback */
  29. /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
  30. /** @typedef {import("./Module").SourceContext} SourceContext */
  31. /** @typedef {import("./RequestShortener")} RequestShortener */
  32. /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
  33. /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
  34. /** @typedef {import("./WebpackError")} WebpackError */
  35. /** @typedef {import("./dependencies/ModuleDependency")} ModuleDependency */
  36. /** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
  37. /** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
  38. /** @typedef {import("./util/Hash")} Hash */
  39. /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
  40. /** @typedef {string} DelegatedModuleSourceRequest */
  41. /** @typedef {NonNullable<DllReferencePluginOptions["type"]>} DelegatedModuleType */
  42. /**
  43. * @typedef {object} DelegatedModuleData
  44. * @property {BuildMeta=} buildMeta build meta
  45. * @property {true | string[]=} exports exports
  46. * @property {number | string} id module id
  47. */
  48. const RUNTIME_REQUIREMENTS = new Set([
  49. RuntimeGlobals.module,
  50. RuntimeGlobals.require
  51. ]);
  52. class DelegatedModule extends Module {
  53. /**
  54. * @param {DelegatedModuleSourceRequest} sourceRequest source request
  55. * @param {DelegatedModuleData} data data
  56. * @param {DelegatedModuleType} type type
  57. * @param {string} userRequest user request
  58. * @param {string | Module} originalRequest original request
  59. */
  60. constructor(sourceRequest, data, type, userRequest, originalRequest) {
  61. super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, null);
  62. // Info from Factory
  63. this.sourceRequest = sourceRequest;
  64. this.request = data.id;
  65. this.delegationType = type;
  66. this.userRequest = userRequest;
  67. this.originalRequest = originalRequest;
  68. this.delegateData = data;
  69. // Build info
  70. this.delegatedSourceDependency = undefined;
  71. }
  72. /**
  73. * @returns {SourceTypes} types available (do not mutate)
  74. */
  75. getSourceTypes() {
  76. return JS_TYPES;
  77. }
  78. /**
  79. * @param {LibIdentOptions} options options
  80. * @returns {string | null} an identifier for library inclusion
  81. */
  82. libIdent(options) {
  83. return typeof this.originalRequest === "string"
  84. ? this.originalRequest
  85. : this.originalRequest.libIdent(options);
  86. }
  87. /**
  88. * @returns {string} a unique identifier of the module
  89. */
  90. identifier() {
  91. return `delegated ${JSON.stringify(this.request)} from ${
  92. this.sourceRequest
  93. }`;
  94. }
  95. /**
  96. * @param {RequestShortener} requestShortener the request shortener
  97. * @returns {string} a user readable identifier of the module
  98. */
  99. readableIdentifier(requestShortener) {
  100. return `delegated ${this.userRequest} from ${this.sourceRequest}`;
  101. }
  102. /**
  103. * @param {NeedBuildContext} context context info
  104. * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
  105. * @returns {void}
  106. */
  107. needBuild(context, callback) {
  108. return callback(null, !this.buildMeta);
  109. }
  110. /**
  111. * @param {WebpackOptions} options webpack options
  112. * @param {Compilation} compilation the compilation
  113. * @param {ResolverWithOptions} resolver the resolver
  114. * @param {InputFileSystem} fs the file system
  115. * @param {BuildCallback} callback callback function
  116. * @returns {void}
  117. */
  118. build(options, compilation, resolver, fs, callback) {
  119. const delegateData = /** @type {ManifestModuleData} */ (this.delegateData);
  120. this.buildMeta = { ...delegateData.buildMeta };
  121. this.buildInfo = {};
  122. this.dependencies.length = 0;
  123. this.delegatedSourceDependency = new DelegatedSourceDependency(
  124. this.sourceRequest
  125. );
  126. this.addDependency(this.delegatedSourceDependency);
  127. this.addDependency(
  128. new StaticExportsDependency(delegateData.exports || true, false)
  129. );
  130. callback();
  131. }
  132. /**
  133. * @param {CodeGenerationContext} context context for code generation
  134. * @returns {CodeGenerationResult} result
  135. */
  136. codeGeneration({ runtimeTemplate, moduleGraph, chunkGraph }) {
  137. const dep = /** @type {DelegatedSourceDependency} */ (this.dependencies[0]);
  138. const sourceModule = moduleGraph.getModule(dep);
  139. let str;
  140. if (!sourceModule) {
  141. str = runtimeTemplate.throwMissingModuleErrorBlock({
  142. request: this.sourceRequest
  143. });
  144. } else {
  145. str = `module.exports = (${runtimeTemplate.moduleExports({
  146. module: sourceModule,
  147. chunkGraph,
  148. request: dep.request,
  149. runtimeRequirements: new Set()
  150. })})`;
  151. switch (this.delegationType) {
  152. case "require":
  153. str += `(${JSON.stringify(this.request)})`;
  154. break;
  155. case "object":
  156. str += `[${JSON.stringify(this.request)}]`;
  157. break;
  158. }
  159. str += ";";
  160. }
  161. const sources = new Map();
  162. if (this.useSourceMap || this.useSimpleSourceMap) {
  163. sources.set("javascript", new OriginalSource(str, this.identifier()));
  164. } else {
  165. sources.set("javascript", new RawSource(str));
  166. }
  167. return {
  168. sources,
  169. runtimeRequirements: RUNTIME_REQUIREMENTS
  170. };
  171. }
  172. /**
  173. * @param {string=} type the source type for which the size should be estimated
  174. * @returns {number} the estimated size of the module (must be non-zero)
  175. */
  176. size(type) {
  177. return 42;
  178. }
  179. /**
  180. * @param {Hash} hash the hash used to track dependencies
  181. * @param {UpdateHashContext} context context
  182. * @returns {void}
  183. */
  184. updateHash(hash, context) {
  185. hash.update(this.delegationType);
  186. hash.update(JSON.stringify(this.request));
  187. super.updateHash(hash, context);
  188. }
  189. /**
  190. * @param {ObjectSerializerContext} context context
  191. */
  192. serialize(context) {
  193. const { write } = context;
  194. // constructor
  195. write(this.sourceRequest);
  196. write(this.delegateData);
  197. write(this.delegationType);
  198. write(this.userRequest);
  199. write(this.originalRequest);
  200. super.serialize(context);
  201. }
  202. /**
  203. * @param {ObjectDeserializerContext} context context\
  204. * @returns {DelegatedModule} DelegatedModule
  205. */
  206. static deserialize(context) {
  207. const { read } = context;
  208. const obj = new DelegatedModule(
  209. read(), // sourceRequest
  210. read(), // delegateData
  211. read(), // delegationType
  212. read(), // userRequest
  213. read() // originalRequest
  214. );
  215. obj.deserialize(context);
  216. return obj;
  217. }
  218. /**
  219. * Assuming this module is in the cache. Update the (cached) module with
  220. * the fresh module from the factory. Usually updates internal references
  221. * and properties.
  222. * @param {Module} module fresh module
  223. * @returns {void}
  224. */
  225. updateCacheModule(module) {
  226. super.updateCacheModule(module);
  227. const m = /** @type {DelegatedModule} */ (module);
  228. this.delegationType = m.delegationType;
  229. this.userRequest = m.userRequest;
  230. this.originalRequest = m.originalRequest;
  231. this.delegateData = m.delegateData;
  232. }
  233. /**
  234. * Assuming this module is in the cache. Remove internal references to allow freeing some memory.
  235. */
  236. cleanupForCache() {
  237. super.cleanupForCache();
  238. this.delegateData =
  239. /** @type {EXPECTED_ANY} */
  240. (undefined);
  241. }
  242. }
  243. makeSerializable(DelegatedModule, "webpack/lib/DelegatedModule");
  244. module.exports = DelegatedModule;