ContextDependencyHelpers.js 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { parseResource } = require("../util/identifier");
  7. /** @typedef {import("estree").Node} EsTreeNode */
  8. /** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
  9. /** @typedef {import("../../declarations/WebpackOptions").ModuleOptionsNormalized} ModuleOptions */
  10. /** @typedef {import("../javascript/BasicEvaluatedExpression")} BasicEvaluatedExpression */
  11. /** @typedef {import("../javascript/JavascriptParser")} JavascriptParser */
  12. /** @typedef {import("./ContextDependency")} ContextDependency */
  13. /** @typedef {import("./ContextDependency").ContextDependencyOptions} ContextDependencyOptions */
  14. /**
  15. * Escapes regular expression metacharacters
  16. * @param {string} str String to quote
  17. * @returns {string} Escaped string
  18. */
  19. const quoteMeta = str => {
  20. return str.replace(/[-[\]\\/{}()*+?.^$|]/g, "\\$&");
  21. };
  22. const splitContextFromPrefix = prefix => {
  23. const idx = prefix.lastIndexOf("/");
  24. let context = ".";
  25. if (idx >= 0) {
  26. context = prefix.slice(0, idx);
  27. prefix = `.${prefix.slice(idx)}`;
  28. }
  29. return {
  30. context,
  31. prefix
  32. };
  33. };
  34. /** @typedef {Partial<Omit<ContextDependencyOptions, "resource">>} PartialContextDependencyOptions */
  35. /** @typedef {import("../javascript/JavascriptParser").Range} Range */
  36. /** @typedef {{ new(options: ContextDependencyOptions, range: Range, valueRange: [number, number], ...args: any[]): ContextDependency }} ContextDependencyConstructor */
  37. /**
  38. * @param {ContextDependencyConstructor} Dep the Dependency class
  39. * @param {Range} range source range
  40. * @param {BasicEvaluatedExpression} param context param
  41. * @param {EsTreeNode} expr expr
  42. * @param {Pick<JavascriptParserOptions, `${"expr"|"wrapped"}Context${"Critical"|"Recursive"|"RegExp"}` | "exprContextRequest">} options options for context creation
  43. * @param {PartialContextDependencyOptions} contextOptions options for the ContextModule
  44. * @param {JavascriptParser} parser the parser
  45. * @param {...any} depArgs depArgs
  46. * @returns {ContextDependency} the created Dependency
  47. */
  48. exports.create = (
  49. Dep,
  50. range,
  51. param,
  52. expr,
  53. options,
  54. contextOptions,
  55. parser,
  56. ...depArgs
  57. ) => {
  58. if (param.isTemplateString()) {
  59. let prefixRaw = param.quasis[0].string;
  60. let postfixRaw =
  61. param.quasis.length > 1
  62. ? param.quasis[param.quasis.length - 1].string
  63. : "";
  64. const valueRange = param.range;
  65. const { context, prefix } = splitContextFromPrefix(prefixRaw);
  66. const {
  67. path: postfix,
  68. query,
  69. fragment
  70. } = parseResource(postfixRaw, parser);
  71. // When there are more than two quasis, the generated RegExp can be more precise
  72. // We join the quasis with the expression regexp
  73. const innerQuasis = param.quasis.slice(1, param.quasis.length - 1);
  74. const innerRegExp =
  75. options.wrappedContextRegExp.source +
  76. innerQuasis
  77. .map(q => quoteMeta(q.string) + options.wrappedContextRegExp.source)
  78. .join("");
  79. // Example: `./context/pre${e}inner${e}inner2${e}post?query#frag`
  80. // context: "./context"
  81. // prefix: "./pre"
  82. // innerQuasis: [BEE("inner"), BEE("inner2")]
  83. // (BEE = BasicEvaluatedExpression)
  84. // postfix: "post"
  85. // query: "?query"
  86. // fragment: "#frag"
  87. // regExp: /^\.\/pre.*inner.*inner2.*post$/
  88. const regExp = new RegExp(
  89. `^${quoteMeta(prefix)}${innerRegExp}${quoteMeta(postfix)}$`
  90. );
  91. const dep = new Dep(
  92. {
  93. request: context + query + fragment,
  94. recursive: options.wrappedContextRecursive,
  95. regExp,
  96. mode: "sync",
  97. ...contextOptions
  98. },
  99. range,
  100. valueRange,
  101. ...depArgs
  102. );
  103. dep.loc = expr.loc;
  104. const replaces = [];
  105. param.parts.forEach((part, i) => {
  106. if (i % 2 === 0) {
  107. // Quasis or merged quasi
  108. let range = part.range;
  109. let value = part.string;
  110. if (param.templateStringKind === "cooked") {
  111. value = JSON.stringify(value);
  112. value = value.slice(1, value.length - 1);
  113. }
  114. if (i === 0) {
  115. // prefix
  116. value = prefix;
  117. range = [param.range[0], part.range[1]];
  118. value =
  119. (param.templateStringKind === "cooked" ? "`" : "String.raw`") +
  120. value;
  121. } else if (i === param.parts.length - 1) {
  122. // postfix
  123. value = postfix;
  124. range = [part.range[0], param.range[1]];
  125. value = value + "`";
  126. } else if (
  127. part.expression &&
  128. part.expression.type === "TemplateElement" &&
  129. part.expression.value.raw === value
  130. ) {
  131. // Shortcut when it's a single quasi and doesn't need to be replaced
  132. return;
  133. }
  134. replaces.push({
  135. range,
  136. value
  137. });
  138. } else {
  139. // Expression
  140. parser.walkExpression(part.expression);
  141. }
  142. });
  143. dep.replaces = replaces;
  144. dep.critical =
  145. options.wrappedContextCritical &&
  146. "a part of the request of a dependency is an expression";
  147. return dep;
  148. } else if (
  149. param.isWrapped() &&
  150. ((param.prefix && param.prefix.isString()) ||
  151. (param.postfix && param.postfix.isString()))
  152. ) {
  153. let prefixRaw =
  154. param.prefix && param.prefix.isString() ? param.prefix.string : "";
  155. let postfixRaw =
  156. param.postfix && param.postfix.isString() ? param.postfix.string : "";
  157. const prefixRange =
  158. param.prefix && param.prefix.isString() ? param.prefix.range : null;
  159. const postfixRange =
  160. param.postfix && param.postfix.isString() ? param.postfix.range : null;
  161. const valueRange = param.range;
  162. const { context, prefix } = splitContextFromPrefix(prefixRaw);
  163. const {
  164. path: postfix,
  165. query,
  166. fragment
  167. } = parseResource(postfixRaw, parser);
  168. const regExp = new RegExp(
  169. `^${quoteMeta(prefix)}${options.wrappedContextRegExp.source}${quoteMeta(
  170. postfix
  171. )}$`
  172. );
  173. const dep = new Dep(
  174. {
  175. request: context + query + fragment,
  176. recursive: options.wrappedContextRecursive,
  177. regExp,
  178. mode: "sync",
  179. ...contextOptions
  180. },
  181. range,
  182. valueRange,
  183. ...depArgs
  184. );
  185. dep.loc = expr.loc;
  186. const replaces = [];
  187. if (prefixRange) {
  188. replaces.push({
  189. range: prefixRange,
  190. value: JSON.stringify(prefix)
  191. });
  192. }
  193. if (postfixRange) {
  194. replaces.push({
  195. range: postfixRange,
  196. value: JSON.stringify(postfix)
  197. });
  198. }
  199. dep.replaces = replaces;
  200. dep.critical =
  201. options.wrappedContextCritical &&
  202. "a part of the request of a dependency is an expression";
  203. if (parser && param.wrappedInnerExpressions) {
  204. for (const part of param.wrappedInnerExpressions) {
  205. if (part.expression) parser.walkExpression(part.expression);
  206. }
  207. }
  208. return dep;
  209. } else {
  210. const dep = new Dep(
  211. {
  212. request: options.exprContextRequest,
  213. recursive: options.exprContextRecursive,
  214. regExp: /** @type {RegExp} */ (options.exprContextRegExp),
  215. mode: "sync",
  216. ...contextOptions
  217. },
  218. range,
  219. param.range,
  220. ...depArgs
  221. );
  222. dep.loc = expr.loc;
  223. dep.critical =
  224. options.exprContextCritical &&
  225. "the request of a dependency is an expression";
  226. parser.walkExpression(param.expression);
  227. return dep;
  228. }
  229. };