DefinePlugin.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { SyncWaterfallHook } = require("tapable");
  7. const {
  8. JAVASCRIPT_MODULE_TYPE_AUTO,
  9. JAVASCRIPT_MODULE_TYPE_DYNAMIC,
  10. JAVASCRIPT_MODULE_TYPE_ESM
  11. } = require("./ModuleTypeConstants");
  12. const RuntimeGlobals = require("./RuntimeGlobals");
  13. const WebpackError = require("./WebpackError");
  14. const ConstDependency = require("./dependencies/ConstDependency");
  15. const BasicEvaluatedExpression = require("./javascript/BasicEvaluatedExpression");
  16. const { VariableInfo } = require("./javascript/JavascriptParser");
  17. const {
  18. evaluateToString,
  19. toConstantDependency
  20. } = require("./javascript/JavascriptParserHelpers");
  21. const createHash = require("./util/createHash");
  22. /** @typedef {import("estree").Expression} Expression */
  23. /** @typedef {import("./Compiler")} Compiler */
  24. /** @typedef {import("./Module").BuildInfo} BuildInfo */
  25. /** @typedef {import("./Module").ValueCacheVersion} ValueCacheVersion */
  26. /** @typedef {import("./Module").ValueCacheVersions} ValueCacheVersions */
  27. /** @typedef {import("./NormalModule")} NormalModule */
  28. /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
  29. /** @typedef {import("./javascript/JavascriptParser")} JavascriptParser */
  30. /** @typedef {import("./javascript/JavascriptParser").DestructuringAssignmentProperties} DestructuringAssignmentProperties */
  31. /** @typedef {import("./javascript/JavascriptParser").Range} Range */
  32. /** @typedef {import("./logging/Logger").Logger} Logger */
  33. /** @typedef {import("./Compilation")} Compilation */
  34. /** @typedef {null | undefined | RegExp | EXPECTED_FUNCTION | string | number | boolean | bigint | undefined} CodeValuePrimitive */
  35. /** @typedef {RecursiveArrayOrRecord<CodeValuePrimitive | RuntimeValue>} CodeValue */
  36. /**
  37. * @typedef {object} RuntimeValueOptions
  38. * @property {string[]=} fileDependencies
  39. * @property {string[]=} contextDependencies
  40. * @property {string[]=} missingDependencies
  41. * @property {string[]=} buildDependencies
  42. * @property {string | (() => string)=} version
  43. */
  44. /** @typedef {(value: { module: NormalModule, key: string, readonly version: ValueCacheVersion }) => CodeValuePrimitive} GeneratorFn */
  45. class RuntimeValue {
  46. /**
  47. * @param {GeneratorFn} fn generator function
  48. * @param {true | string[] | RuntimeValueOptions=} options options
  49. */
  50. constructor(fn, options) {
  51. /** @type {GeneratorFn} */
  52. this.fn = fn;
  53. if (Array.isArray(options)) {
  54. options = {
  55. fileDependencies: options
  56. };
  57. }
  58. /** @type {true | RuntimeValueOptions} */
  59. this.options = options || {};
  60. }
  61. get fileDependencies() {
  62. return this.options === true ? true : this.options.fileDependencies;
  63. }
  64. /**
  65. * @param {JavascriptParser} parser the parser
  66. * @param {ValueCacheVersions} valueCacheVersions valueCacheVersions
  67. * @param {string} key the defined key
  68. * @returns {CodeValuePrimitive} code
  69. */
  70. exec(parser, valueCacheVersions, key) {
  71. const buildInfo = /** @type {BuildInfo} */ (parser.state.module.buildInfo);
  72. if (this.options === true) {
  73. buildInfo.cacheable = false;
  74. } else {
  75. if (this.options.fileDependencies) {
  76. for (const dep of this.options.fileDependencies) {
  77. /** @type {NonNullable<BuildInfo["fileDependencies"]>} */
  78. (buildInfo.fileDependencies).add(dep);
  79. }
  80. }
  81. if (this.options.contextDependencies) {
  82. for (const dep of this.options.contextDependencies) {
  83. /** @type {NonNullable<BuildInfo["contextDependencies"]>} */
  84. (buildInfo.contextDependencies).add(dep);
  85. }
  86. }
  87. if (this.options.missingDependencies) {
  88. for (const dep of this.options.missingDependencies) {
  89. /** @type {NonNullable<BuildInfo["missingDependencies"]>} */
  90. (buildInfo.missingDependencies).add(dep);
  91. }
  92. }
  93. if (this.options.buildDependencies) {
  94. for (const dep of this.options.buildDependencies) {
  95. /** @type {NonNullable<BuildInfo["buildDependencies"]>} */
  96. (buildInfo.buildDependencies).add(dep);
  97. }
  98. }
  99. }
  100. return this.fn({
  101. module: parser.state.module,
  102. key,
  103. get version() {
  104. return /** @type {ValueCacheVersion} */ (
  105. valueCacheVersions.get(VALUE_DEP_PREFIX + key)
  106. );
  107. }
  108. });
  109. }
  110. getCacheVersion() {
  111. return this.options === true
  112. ? undefined
  113. : (typeof this.options.version === "function"
  114. ? this.options.version()
  115. : this.options.version) || "unset";
  116. }
  117. }
  118. /**
  119. * @param {DestructuringAssignmentProperties | undefined} properties properties
  120. * @returns {Set<string> | undefined} used keys
  121. */
  122. function getObjKeys(properties) {
  123. if (!properties) return;
  124. return new Set([...properties].map((p) => p.id));
  125. }
  126. /** @typedef {Set<string> | null} ObjKeys */
  127. /** @typedef {boolean | undefined | null} AsiSafe */
  128. /**
  129. * @param {EXPECTED_ANY[] | { [k: string]: EXPECTED_ANY }} obj obj
  130. * @param {JavascriptParser} parser Parser
  131. * @param {ValueCacheVersions} valueCacheVersions valueCacheVersions
  132. * @param {string} key the defined key
  133. * @param {RuntimeTemplate} runtimeTemplate the runtime template
  134. * @param {Logger} logger the logger object
  135. * @param {AsiSafe=} asiSafe asi safe (undefined: unknown, null: unneeded)
  136. * @param {ObjKeys=} objKeys used keys
  137. * @returns {string} code converted to string that evaluates
  138. */
  139. const stringifyObj = (
  140. obj,
  141. parser,
  142. valueCacheVersions,
  143. key,
  144. runtimeTemplate,
  145. logger,
  146. asiSafe,
  147. objKeys
  148. ) => {
  149. /** @type {string} */
  150. let code;
  151. const arr = Array.isArray(obj);
  152. if (arr) {
  153. code = `[${obj
  154. .map((code) =>
  155. toCode(
  156. code,
  157. parser,
  158. valueCacheVersions,
  159. key,
  160. runtimeTemplate,
  161. logger,
  162. null
  163. )
  164. )
  165. .join(",")}]`;
  166. } else {
  167. let keys = Object.keys(obj);
  168. if (objKeys) {
  169. keys = objKeys.size === 0 ? [] : keys.filter((k) => objKeys.has(k));
  170. }
  171. code = `{${keys
  172. .map((key) => {
  173. const code = obj[key];
  174. return `${key === "__proto__" ? '["__proto__"]' : JSON.stringify(key)}:${toCode(
  175. code,
  176. parser,
  177. valueCacheVersions,
  178. key,
  179. runtimeTemplate,
  180. logger,
  181. null
  182. )}`;
  183. })
  184. .join(",")}}`;
  185. }
  186. switch (asiSafe) {
  187. case null:
  188. return code;
  189. case true:
  190. return arr ? code : `(${code})`;
  191. case false:
  192. return arr ? `;${code}` : `;(${code})`;
  193. default:
  194. return `/*#__PURE__*/Object(${code})`;
  195. }
  196. };
  197. /**
  198. * Convert code to a string that evaluates
  199. * @param {CodeValue} code Code to evaluate
  200. * @param {JavascriptParser} parser Parser
  201. * @param {ValueCacheVersions} valueCacheVersions valueCacheVersions
  202. * @param {string} key the defined key
  203. * @param {RuntimeTemplate} runtimeTemplate the runtime template
  204. * @param {Logger} logger the logger object
  205. * @param {boolean | undefined | null=} asiSafe asi safe (undefined: unknown, null: unneeded)
  206. * @param {ObjKeys=} objKeys used keys
  207. * @returns {string} code converted to string that evaluates
  208. */
  209. const toCode = (
  210. code,
  211. parser,
  212. valueCacheVersions,
  213. key,
  214. runtimeTemplate,
  215. logger,
  216. asiSafe,
  217. objKeys
  218. ) => {
  219. const transformToCode = () => {
  220. if (code === null) {
  221. return "null";
  222. }
  223. if (code === undefined) {
  224. return "undefined";
  225. }
  226. if (Object.is(code, -0)) {
  227. return "-0";
  228. }
  229. if (code instanceof RuntimeValue) {
  230. return toCode(
  231. code.exec(parser, valueCacheVersions, key),
  232. parser,
  233. valueCacheVersions,
  234. key,
  235. runtimeTemplate,
  236. logger,
  237. asiSafe
  238. );
  239. }
  240. if (code instanceof RegExp && code.toString) {
  241. return code.toString();
  242. }
  243. if (typeof code === "function" && code.toString) {
  244. return `(${code.toString()})`;
  245. }
  246. if (typeof code === "object") {
  247. return stringifyObj(
  248. code,
  249. parser,
  250. valueCacheVersions,
  251. key,
  252. runtimeTemplate,
  253. logger,
  254. asiSafe,
  255. objKeys
  256. );
  257. }
  258. if (typeof code === "bigint") {
  259. return runtimeTemplate.supportsBigIntLiteral()
  260. ? `${code}n`
  261. : `BigInt("${code}")`;
  262. }
  263. return `${code}`;
  264. };
  265. const strCode = transformToCode();
  266. logger.debug(`Replaced "${key}" with "${strCode}"`);
  267. return strCode;
  268. };
  269. /**
  270. * @param {CodeValue} code code
  271. * @returns {string | undefined} result
  272. */
  273. const toCacheVersion = (code) => {
  274. if (code === null) {
  275. return "null";
  276. }
  277. if (code === undefined) {
  278. return "undefined";
  279. }
  280. if (Object.is(code, -0)) {
  281. return "-0";
  282. }
  283. if (code instanceof RuntimeValue) {
  284. return code.getCacheVersion();
  285. }
  286. if (code instanceof RegExp && code.toString) {
  287. return code.toString();
  288. }
  289. if (typeof code === "function" && code.toString) {
  290. return `(${code.toString()})`;
  291. }
  292. if (typeof code === "object") {
  293. const items = Object.keys(code).map((key) => ({
  294. key,
  295. value: toCacheVersion(
  296. /** @type {Record<string, EXPECTED_ANY>} */
  297. (code)[key]
  298. )
  299. }));
  300. if (items.some(({ value }) => value === undefined)) return;
  301. return `{${items.map(({ key, value }) => `${key}: ${value}`).join(", ")}}`;
  302. }
  303. if (typeof code === "bigint") {
  304. return `${code}n`;
  305. }
  306. return `${code}`;
  307. };
  308. const PLUGIN_NAME = "DefinePlugin";
  309. const VALUE_DEP_PREFIX = `webpack/${PLUGIN_NAME} `;
  310. const VALUE_DEP_MAIN = `webpack/${PLUGIN_NAME}_hash`;
  311. const TYPEOF_OPERATOR_REGEXP = /^typeof\s+/;
  312. const WEBPACK_REQUIRE_FUNCTION_REGEXP = new RegExp(
  313. `${RuntimeGlobals.require}\\s*(!?\\.)`
  314. );
  315. const WEBPACK_REQUIRE_IDENTIFIER_REGEXP = new RegExp(RuntimeGlobals.require);
  316. /**
  317. * @typedef {object} DefinePluginHooks
  318. * @property {SyncWaterfallHook<[Record<string, CodeValue>]>} definitions
  319. */
  320. /** @typedef {Record<string, CodeValue>} Definitions */
  321. /** @type {WeakMap<Compilation, DefinePluginHooks>} */
  322. const compilationHooksMap = new WeakMap();
  323. class DefinePlugin {
  324. /**
  325. * @param {Compilation} compilation the compilation
  326. * @returns {DefinePluginHooks} the attached hooks
  327. */
  328. static getCompilationHooks(compilation) {
  329. let hooks = compilationHooksMap.get(compilation);
  330. if (hooks === undefined) {
  331. hooks = {
  332. definitions: new SyncWaterfallHook(["definitions"])
  333. };
  334. compilationHooksMap.set(compilation, hooks);
  335. }
  336. return hooks;
  337. }
  338. /**
  339. * Create a new define plugin
  340. * @param {Definitions} definitions A map of global object definitions
  341. */
  342. constructor(definitions) {
  343. /** @type {Definitions} */
  344. this.definitions = definitions;
  345. }
  346. /**
  347. * @param {GeneratorFn} fn generator function
  348. * @param {true | string[] | RuntimeValueOptions=} options options
  349. * @returns {RuntimeValue} runtime value
  350. */
  351. static runtimeValue(fn, options) {
  352. return new RuntimeValue(fn, options);
  353. }
  354. /**
  355. * Apply the plugin
  356. * @param {Compiler} compiler the compiler instance
  357. * @returns {void}
  358. */
  359. apply(compiler) {
  360. compiler.hooks.compilation.tap(
  361. PLUGIN_NAME,
  362. (compilation, { normalModuleFactory }) => {
  363. const definitions = this.definitions;
  364. const hooks = DefinePlugin.getCompilationHooks(compilation);
  365. hooks.definitions.tap(PLUGIN_NAME, (previousDefinitions) => ({
  366. ...previousDefinitions,
  367. ...definitions
  368. }));
  369. /**
  370. * @type {Map<string, Set<string>>}
  371. */
  372. const finalByNestedKey = new Map();
  373. /**
  374. * @type {Map<string, Set<string>>}
  375. */
  376. const nestedByFinalKey = new Map();
  377. const logger = compilation.getLogger("webpack.DefinePlugin");
  378. compilation.dependencyTemplates.set(
  379. ConstDependency,
  380. new ConstDependency.Template()
  381. );
  382. const { runtimeTemplate } = compilation;
  383. const mainHash = createHash(compilation.outputOptions.hashFunction);
  384. mainHash.update(
  385. /** @type {string} */
  386. (compilation.valueCacheVersions.get(VALUE_DEP_MAIN)) || ""
  387. );
  388. /**
  389. * Handler
  390. * @param {JavascriptParser} parser Parser
  391. * @returns {void}
  392. */
  393. const handler = (parser) => {
  394. /** @type {Set<string>} */
  395. const hooked = new Set();
  396. const mainValue =
  397. /** @type {ValueCacheVersion} */
  398. (compilation.valueCacheVersions.get(VALUE_DEP_MAIN));
  399. parser.hooks.program.tap(PLUGIN_NAME, () => {
  400. const buildInfo = /** @type {BuildInfo} */ (
  401. parser.state.module.buildInfo
  402. );
  403. if (!buildInfo.valueDependencies) {
  404. buildInfo.valueDependencies = new Map();
  405. }
  406. buildInfo.valueDependencies.set(VALUE_DEP_MAIN, mainValue);
  407. });
  408. /**
  409. * @param {string} key key
  410. */
  411. const addValueDependency = (key) => {
  412. const buildInfo =
  413. /** @type {BuildInfo} */
  414. (parser.state.module.buildInfo);
  415. /** @type {NonNullable<BuildInfo["valueDependencies"]>} */
  416. (buildInfo.valueDependencies).set(
  417. VALUE_DEP_PREFIX + key,
  418. /** @type {ValueCacheVersion} */
  419. (compilation.valueCacheVersions.get(VALUE_DEP_PREFIX + key))
  420. );
  421. };
  422. /**
  423. * @template T
  424. * @param {string} key key
  425. * @param {(expression: Expression) => T} fn fn
  426. * @returns {(expression: Expression) => T} result
  427. */
  428. const withValueDependency =
  429. (key, fn) =>
  430. (...args) => {
  431. addValueDependency(key);
  432. return fn(...args);
  433. };
  434. /**
  435. * Walk definitions
  436. * @param {Definitions} definitions Definitions map
  437. * @param {string} prefix Prefix string
  438. * @returns {void}
  439. */
  440. const walkDefinitions = (definitions, prefix) => {
  441. for (const key of Object.keys(definitions)) {
  442. const code = definitions[key];
  443. if (
  444. code &&
  445. typeof code === "object" &&
  446. !(code instanceof RuntimeValue) &&
  447. !(code instanceof RegExp)
  448. ) {
  449. walkDefinitions(
  450. /** @type {Definitions} */ (code),
  451. `${prefix + key}.`
  452. );
  453. applyObjectDefine(prefix + key, code);
  454. continue;
  455. }
  456. applyDefineKey(prefix, key);
  457. applyDefine(prefix + key, code);
  458. }
  459. };
  460. /**
  461. * Apply define key
  462. * @param {string} prefix Prefix
  463. * @param {string} key Key
  464. * @returns {void}
  465. */
  466. const applyDefineKey = (prefix, key) => {
  467. const splittedKey = key.split(".");
  468. const firstKey = splittedKey[0];
  469. for (const [i, _] of splittedKey.slice(1).entries()) {
  470. const fullKey = prefix + splittedKey.slice(0, i + 1).join(".");
  471. parser.hooks.canRename.for(fullKey).tap(PLUGIN_NAME, () => {
  472. addValueDependency(key);
  473. if (
  474. parser.scope.definitions.get(firstKey) instanceof VariableInfo
  475. ) {
  476. return false;
  477. }
  478. return true;
  479. });
  480. }
  481. if (prefix === "") {
  482. const final = splittedKey[splittedKey.length - 1];
  483. const nestedSet = nestedByFinalKey.get(final);
  484. if (!nestedSet || nestedSet.size <= 0) return;
  485. for (const nested of /** @type {Set<string>} */ (nestedSet)) {
  486. if (nested && !hooked.has(nested)) {
  487. // only detect the same nested key once
  488. hooked.add(nested);
  489. parser.hooks.collectDestructuringAssignmentProperties.tap(
  490. PLUGIN_NAME,
  491. (expr) => {
  492. const nameInfo = parser.getNameForExpression(expr);
  493. if (nameInfo && nameInfo.name === nested) return true;
  494. }
  495. );
  496. parser.hooks.expression.for(nested).tap(
  497. {
  498. name: PLUGIN_NAME,
  499. // why 100? Ensures it runs after object define
  500. stage: 100
  501. },
  502. (expr) => {
  503. const destructed =
  504. parser.destructuringAssignmentPropertiesFor(expr);
  505. if (destructed === undefined) {
  506. return;
  507. }
  508. /** @type {Definitions} */
  509. const obj = Object.create(null);
  510. const finalSet = finalByNestedKey.get(nested);
  511. for (const { id } of destructed) {
  512. const fullKey = `${nested}.${id}`;
  513. if (
  514. !finalSet ||
  515. !finalSet.has(id) ||
  516. !definitions[fullKey]
  517. ) {
  518. return;
  519. }
  520. obj[id] = definitions[fullKey];
  521. }
  522. let strCode = stringifyObj(
  523. obj,
  524. parser,
  525. compilation.valueCacheVersions,
  526. key,
  527. runtimeTemplate,
  528. logger,
  529. !parser.isAsiPosition(
  530. /** @type {Range} */ (expr.range)[0]
  531. ),
  532. getObjKeys(destructed)
  533. );
  534. if (parser.scope.inShorthand) {
  535. strCode = `${parser.scope.inShorthand}:${strCode}`;
  536. }
  537. return toConstantDependency(parser, strCode)(expr);
  538. }
  539. );
  540. }
  541. }
  542. }
  543. };
  544. /**
  545. * Apply Code
  546. * @param {string} key Key
  547. * @param {CodeValue} code Code
  548. * @returns {void}
  549. */
  550. const applyDefine = (key, code) => {
  551. const originalKey = key;
  552. const isTypeof = TYPEOF_OPERATOR_REGEXP.test(key);
  553. if (isTypeof) key = key.replace(TYPEOF_OPERATOR_REGEXP, "");
  554. let recurse = false;
  555. let recurseTypeof = false;
  556. if (!isTypeof) {
  557. parser.hooks.canRename.for(key).tap(PLUGIN_NAME, () => {
  558. addValueDependency(originalKey);
  559. return true;
  560. });
  561. parser.hooks.evaluateIdentifier
  562. .for(key)
  563. .tap(PLUGIN_NAME, (expr) => {
  564. /**
  565. * this is needed in case there is a recursion in the DefinePlugin
  566. * to prevent an endless recursion
  567. * e.g.: new DefinePlugin({
  568. * "a": "b",
  569. * "b": "a"
  570. * });
  571. */
  572. if (recurse) return;
  573. addValueDependency(originalKey);
  574. recurse = true;
  575. const res = parser.evaluate(
  576. toCode(
  577. code,
  578. parser,
  579. compilation.valueCacheVersions,
  580. key,
  581. runtimeTemplate,
  582. logger,
  583. null
  584. )
  585. );
  586. recurse = false;
  587. res.setRange(/** @type {Range} */ (expr.range));
  588. return res;
  589. });
  590. parser.hooks.expression.for(key).tap(PLUGIN_NAME, (expr) => {
  591. addValueDependency(originalKey);
  592. let strCode = toCode(
  593. code,
  594. parser,
  595. compilation.valueCacheVersions,
  596. originalKey,
  597. runtimeTemplate,
  598. logger,
  599. !parser.isAsiPosition(/** @type {Range} */ (expr.range)[0]),
  600. null
  601. );
  602. if (parser.scope.inShorthand) {
  603. strCode = `${parser.scope.inShorthand}:${strCode}`;
  604. }
  605. if (WEBPACK_REQUIRE_FUNCTION_REGEXP.test(strCode)) {
  606. return toConstantDependency(parser, strCode, [
  607. RuntimeGlobals.require
  608. ])(expr);
  609. } else if (WEBPACK_REQUIRE_IDENTIFIER_REGEXP.test(strCode)) {
  610. return toConstantDependency(parser, strCode, [
  611. RuntimeGlobals.requireScope
  612. ])(expr);
  613. }
  614. return toConstantDependency(parser, strCode)(expr);
  615. });
  616. }
  617. parser.hooks.evaluateTypeof.for(key).tap(PLUGIN_NAME, (expr) => {
  618. /**
  619. * this is needed in case there is a recursion in the DefinePlugin
  620. * to prevent an endless recursion
  621. * e.g.: new DefinePlugin({
  622. * "typeof a": "typeof b",
  623. * "typeof b": "typeof a"
  624. * });
  625. */
  626. if (recurseTypeof) return;
  627. recurseTypeof = true;
  628. addValueDependency(originalKey);
  629. const codeCode = toCode(
  630. code,
  631. parser,
  632. compilation.valueCacheVersions,
  633. originalKey,
  634. runtimeTemplate,
  635. logger,
  636. null
  637. );
  638. const typeofCode = isTypeof ? codeCode : `typeof (${codeCode})`;
  639. const res = parser.evaluate(typeofCode);
  640. recurseTypeof = false;
  641. res.setRange(/** @type {Range} */ (expr.range));
  642. return res;
  643. });
  644. parser.hooks.typeof.for(key).tap(PLUGIN_NAME, (expr) => {
  645. addValueDependency(originalKey);
  646. const codeCode = toCode(
  647. code,
  648. parser,
  649. compilation.valueCacheVersions,
  650. originalKey,
  651. runtimeTemplate,
  652. logger,
  653. null
  654. );
  655. const typeofCode = isTypeof ? codeCode : `typeof (${codeCode})`;
  656. const res = parser.evaluate(typeofCode);
  657. if (!res.isString()) return;
  658. return toConstantDependency(
  659. parser,
  660. JSON.stringify(res.string)
  661. ).bind(parser)(expr);
  662. });
  663. };
  664. /**
  665. * Apply Object
  666. * @param {string} key Key
  667. * @param {object} obj Object
  668. * @returns {void}
  669. */
  670. const applyObjectDefine = (key, obj) => {
  671. parser.hooks.canRename.for(key).tap(PLUGIN_NAME, () => {
  672. addValueDependency(key);
  673. return true;
  674. });
  675. parser.hooks.evaluateIdentifier
  676. .for(key)
  677. .tap(PLUGIN_NAME, (expr) => {
  678. addValueDependency(key);
  679. return new BasicEvaluatedExpression()
  680. .setTruthy()
  681. .setSideEffects(false)
  682. .setRange(/** @type {Range} */ (expr.range));
  683. });
  684. parser.hooks.evaluateTypeof
  685. .for(key)
  686. .tap(
  687. PLUGIN_NAME,
  688. withValueDependency(key, evaluateToString("object"))
  689. );
  690. parser.hooks.collectDestructuringAssignmentProperties.tap(
  691. PLUGIN_NAME,
  692. (expr) => {
  693. const nameInfo = parser.getNameForExpression(expr);
  694. if (nameInfo && nameInfo.name === key) return true;
  695. }
  696. );
  697. parser.hooks.expression.for(key).tap(PLUGIN_NAME, (expr) => {
  698. addValueDependency(key);
  699. let strCode = stringifyObj(
  700. obj,
  701. parser,
  702. compilation.valueCacheVersions,
  703. key,
  704. runtimeTemplate,
  705. logger,
  706. !parser.isAsiPosition(/** @type {Range} */ (expr.range)[0]),
  707. getObjKeys(parser.destructuringAssignmentPropertiesFor(expr))
  708. );
  709. if (parser.scope.inShorthand) {
  710. strCode = `${parser.scope.inShorthand}:${strCode}`;
  711. }
  712. if (WEBPACK_REQUIRE_FUNCTION_REGEXP.test(strCode)) {
  713. return toConstantDependency(parser, strCode, [
  714. RuntimeGlobals.require
  715. ])(expr);
  716. } else if (WEBPACK_REQUIRE_IDENTIFIER_REGEXP.test(strCode)) {
  717. return toConstantDependency(parser, strCode, [
  718. RuntimeGlobals.requireScope
  719. ])(expr);
  720. }
  721. return toConstantDependency(parser, strCode)(expr);
  722. });
  723. parser.hooks.typeof
  724. .for(key)
  725. .tap(
  726. PLUGIN_NAME,
  727. withValueDependency(
  728. key,
  729. toConstantDependency(parser, JSON.stringify("object"))
  730. )
  731. );
  732. };
  733. walkDefinitions(definitions, "");
  734. };
  735. normalModuleFactory.hooks.parser
  736. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  737. .tap(PLUGIN_NAME, handler);
  738. normalModuleFactory.hooks.parser
  739. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  740. .tap(PLUGIN_NAME, handler);
  741. normalModuleFactory.hooks.parser
  742. .for(JAVASCRIPT_MODULE_TYPE_ESM)
  743. .tap(PLUGIN_NAME, handler);
  744. /**
  745. * Walk definitions
  746. * @param {Definitions} definitions Definitions map
  747. * @param {string} prefix Prefix string
  748. * @returns {void}
  749. */
  750. const walkDefinitionsForValues = (definitions, prefix) => {
  751. for (const key of Object.keys(definitions)) {
  752. const code = definitions[key];
  753. const version = /** @type {string} */ (toCacheVersion(code));
  754. const name = VALUE_DEP_PREFIX + prefix + key;
  755. mainHash.update(`|${prefix}${key}`);
  756. const oldVersion = compilation.valueCacheVersions.get(name);
  757. if (oldVersion === undefined) {
  758. compilation.valueCacheVersions.set(name, version);
  759. } else if (oldVersion !== version) {
  760. const warning = new WebpackError(
  761. `${PLUGIN_NAME}\nConflicting values for '${prefix + key}'`
  762. );
  763. warning.details = `'${oldVersion}' !== '${version}'`;
  764. warning.hideStack = true;
  765. compilation.warnings.push(warning);
  766. }
  767. if (
  768. code &&
  769. typeof code === "object" &&
  770. !(code instanceof RuntimeValue) &&
  771. !(code instanceof RegExp)
  772. ) {
  773. walkDefinitionsForValues(
  774. /** @type {Definitions} */ (code),
  775. `${prefix + key}.`
  776. );
  777. }
  778. }
  779. };
  780. /**
  781. * @param {Definitions} definitions Definitions map
  782. * @returns {void}
  783. */
  784. const walkDefinitionsForKeys = (definitions) => {
  785. /**
  786. * @param {Map<string, Set<string>>} map Map
  787. * @param {string} key key
  788. * @param {string} value v
  789. * @returns {void}
  790. */
  791. const addToMap = (map, key, value) => {
  792. if (map.has(key)) {
  793. /** @type {Set<string>} */
  794. (map.get(key)).add(value);
  795. } else {
  796. map.set(key, new Set([value]));
  797. }
  798. };
  799. for (const key of Object.keys(definitions)) {
  800. const code = definitions[key];
  801. if (
  802. !code ||
  803. typeof code === "object" ||
  804. TYPEOF_OPERATOR_REGEXP.test(key)
  805. ) {
  806. continue;
  807. }
  808. const idx = key.lastIndexOf(".");
  809. if (idx <= 0 || idx >= key.length - 1) {
  810. continue;
  811. }
  812. const nested = key.slice(0, idx);
  813. const final = key.slice(idx + 1);
  814. addToMap(finalByNestedKey, nested, final);
  815. addToMap(nestedByFinalKey, final, nested);
  816. }
  817. };
  818. walkDefinitionsForKeys(definitions);
  819. walkDefinitionsForValues(definitions, "");
  820. compilation.valueCacheVersions.set(
  821. VALUE_DEP_MAIN,
  822. mainHash.digest("hex").slice(0, 8)
  823. );
  824. }
  825. );
  826. }
  827. }
  828. module.exports = DefinePlugin;