deprecation.js 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const util = require("util");
  7. /** @type {Map<string, () => void>} */
  8. const deprecationCache = new Map();
  9. /**
  10. * @typedef {object} FakeHookMarker
  11. * @property {true} _fakeHook it's a fake hook
  12. */
  13. /**
  14. * @template T
  15. * @typedef {T & FakeHookMarker} FakeHook<T>
  16. */
  17. /**
  18. * @param {string} message deprecation message
  19. * @param {string} code deprecation code
  20. * @returns {() => void} function to trigger deprecation
  21. */
  22. const createDeprecation = (message, code) => {
  23. const cached = deprecationCache.get(message);
  24. if (cached !== undefined) return cached;
  25. const fn = util.deprecate(
  26. () => {},
  27. message,
  28. `DEP_WEBPACK_DEPRECATION_${code}`
  29. );
  30. deprecationCache.set(message, fn);
  31. return fn;
  32. };
  33. /** @typedef {"concat" | "entry" | "filter" | "find" | "findIndex" | "includes" | "indexOf" | "join" | "lastIndexOf" | "map" | "reduce" | "reduceRight" | "slice" | "some"} COPY_METHODS_NAMES */
  34. /** @type {COPY_METHODS_NAMES[]} */
  35. const COPY_METHODS = [
  36. "concat",
  37. "entry",
  38. "filter",
  39. "find",
  40. "findIndex",
  41. "includes",
  42. "indexOf",
  43. "join",
  44. "lastIndexOf",
  45. "map",
  46. "reduce",
  47. "reduceRight",
  48. "slice",
  49. "some"
  50. ];
  51. /** @typedef {"copyWithin" | "entries" | "fill" | "keys" | "pop" | "reverse" | "shift" | "splice" | "sort" | "unshift"} DISABLED_METHODS_NAMES */
  52. /** @type {DISABLED_METHODS_NAMES[]} */
  53. const DISABLED_METHODS = [
  54. "copyWithin",
  55. "entries",
  56. "fill",
  57. "keys",
  58. "pop",
  59. "reverse",
  60. "shift",
  61. "splice",
  62. "sort",
  63. "unshift"
  64. ];
  65. /**
  66. * @template T
  67. * @typedef {Set<T> & {[Symbol.isConcatSpreadable]?: boolean} & { push?: (...items: T[]) => void } & { [P in DISABLED_METHODS_NAMES]?: () => void } & { [P in COPY_METHODS_NAMES]?: () => TODO }} SetWithDeprecatedArrayMethods
  68. */
  69. /**
  70. * @template T
  71. * @param {SetWithDeprecatedArrayMethods<T>} set new set
  72. * @param {string} name property name
  73. * @returns {void}
  74. */
  75. module.exports.arrayToSetDeprecation = (set, name) => {
  76. for (const method of COPY_METHODS) {
  77. if (set[method]) continue;
  78. const d = createDeprecation(
  79. `${name} was changed from Array to Set (using Array method '${method}' is deprecated)`,
  80. "ARRAY_TO_SET"
  81. );
  82. /**
  83. * @deprecated
  84. * @this {Set<T>}
  85. * @returns {number} count
  86. */
  87. set[method] = function () {
  88. d();
  89. const array = Array.from(this);
  90. return Array.prototype[/** @type {keyof COPY_METHODS} */ (method)].apply(
  91. array,
  92. // eslint-disable-next-line prefer-rest-params
  93. arguments
  94. );
  95. };
  96. }
  97. const dPush = createDeprecation(
  98. `${name} was changed from Array to Set (using Array method 'push' is deprecated)`,
  99. "ARRAY_TO_SET_PUSH"
  100. );
  101. const dLength = createDeprecation(
  102. `${name} was changed from Array to Set (using Array property 'length' is deprecated)`,
  103. "ARRAY_TO_SET_LENGTH"
  104. );
  105. const dIndexer = createDeprecation(
  106. `${name} was changed from Array to Set (indexing Array is deprecated)`,
  107. "ARRAY_TO_SET_INDEXER"
  108. );
  109. /**
  110. * @deprecated
  111. * @this {Set<T>}
  112. * @returns {number} count
  113. */
  114. set.push = function () {
  115. dPush();
  116. // eslint-disable-next-line prefer-rest-params
  117. for (const item of Array.from(arguments)) {
  118. this.add(item);
  119. }
  120. return this.size;
  121. };
  122. for (const method of DISABLED_METHODS) {
  123. if (set[method]) continue;
  124. set[method] = () => {
  125. throw new Error(
  126. `${name} was changed from Array to Set (using Array method '${method}' is not possible)`
  127. );
  128. };
  129. }
  130. /**
  131. * @param {number} index index
  132. * @returns {() => T | undefined} value
  133. */
  134. const createIndexGetter = index => {
  135. /**
  136. * @this {Set<T>} a Set
  137. * @returns {T | undefined} the value at this location
  138. */
  139. // eslint-disable-next-line func-style
  140. const fn = function () {
  141. dIndexer();
  142. let i = 0;
  143. for (const item of this) {
  144. if (i++ === index) return item;
  145. }
  146. };
  147. return fn;
  148. };
  149. /**
  150. * @param {number} index index
  151. */
  152. const defineIndexGetter = index => {
  153. Object.defineProperty(set, index, {
  154. get: createIndexGetter(index),
  155. set(value) {
  156. throw new Error(
  157. `${name} was changed from Array to Set (indexing Array with write is not possible)`
  158. );
  159. }
  160. });
  161. };
  162. defineIndexGetter(0);
  163. let indexerDefined = 1;
  164. Object.defineProperty(set, "length", {
  165. get() {
  166. dLength();
  167. const length = this.size;
  168. for (indexerDefined; indexerDefined < length + 1; indexerDefined++) {
  169. defineIndexGetter(indexerDefined);
  170. }
  171. return length;
  172. },
  173. set(value) {
  174. throw new Error(
  175. `${name} was changed from Array to Set (writing to Array property 'length' is not possible)`
  176. );
  177. }
  178. });
  179. set[Symbol.isConcatSpreadable] = true;
  180. };
  181. /**
  182. * @template T
  183. * @param {string} name name
  184. * @returns {{ new <T = any>(values?: readonly T[] | null): SetDeprecatedArray<T> }} SetDeprecatedArray
  185. */
  186. module.exports.createArrayToSetDeprecationSet = name => {
  187. let initialized = false;
  188. /**
  189. * @template T
  190. */
  191. class SetDeprecatedArray extends Set {
  192. /**
  193. * @param {readonly T[] | null=} items items
  194. */
  195. constructor(items) {
  196. super(items);
  197. if (!initialized) {
  198. initialized = true;
  199. module.exports.arrayToSetDeprecation(
  200. SetDeprecatedArray.prototype,
  201. name
  202. );
  203. }
  204. }
  205. }
  206. return SetDeprecatedArray;
  207. };
  208. /**
  209. * @template {object} T
  210. * @param {T} obj object
  211. * @param {string} name property name
  212. * @param {string} code deprecation code
  213. * @param {string} note additional note
  214. * @returns {T} frozen object with deprecation when modifying
  215. */
  216. module.exports.soonFrozenObjectDeprecation = (obj, name, code, note = "") => {
  217. const message = `${name} will be frozen in future, all modifications are deprecated.${
  218. note && `\n${note}`
  219. }`;
  220. return /** @type {T} */ (
  221. new Proxy(obj, {
  222. set: util.deprecate(
  223. /**
  224. * @param {object} target target
  225. * @param {string | symbol} property property
  226. * @param {EXPECTED_ANY} value value
  227. * @param {EXPECTED_ANY} receiver receiver
  228. * @returns {boolean} result
  229. */
  230. (target, property, value, receiver) =>
  231. Reflect.set(target, property, value, receiver),
  232. message,
  233. code
  234. ),
  235. defineProperty: util.deprecate(
  236. /**
  237. * @param {object} target target
  238. * @param {string | symbol} property property
  239. * @param {PropertyDescriptor} descriptor descriptor
  240. * @returns {boolean} result
  241. */
  242. (target, property, descriptor) =>
  243. Reflect.defineProperty(target, property, descriptor),
  244. message,
  245. code
  246. ),
  247. deleteProperty: util.deprecate(
  248. /**
  249. * @param {object} target target
  250. * @param {string | symbol} property property
  251. * @returns {boolean} result
  252. */
  253. (target, property) => Reflect.deleteProperty(target, property),
  254. message,
  255. code
  256. ),
  257. setPrototypeOf: util.deprecate(
  258. /**
  259. * @param {object} target target
  260. * @param {EXPECTED_OBJECT | null} proto proto
  261. * @returns {boolean} result
  262. */
  263. (target, proto) => Reflect.setPrototypeOf(target, proto),
  264. message,
  265. code
  266. )
  267. })
  268. );
  269. };
  270. /**
  271. * @template T
  272. * @param {T} obj object
  273. * @param {string} message deprecation message
  274. * @param {string} code deprecation code
  275. * @returns {T} object with property access deprecated
  276. */
  277. const deprecateAllProperties = (obj, message, code) => {
  278. const newObj = {};
  279. const descriptors = Object.getOwnPropertyDescriptors(obj);
  280. for (const name of Object.keys(descriptors)) {
  281. const descriptor = descriptors[name];
  282. if (typeof descriptor.value === "function") {
  283. Object.defineProperty(newObj, name, {
  284. ...descriptor,
  285. value: util.deprecate(descriptor.value, message, code)
  286. });
  287. } else if (descriptor.get || descriptor.set) {
  288. Object.defineProperty(newObj, name, {
  289. ...descriptor,
  290. get: descriptor.get && util.deprecate(descriptor.get, message, code),
  291. set: descriptor.set && util.deprecate(descriptor.set, message, code)
  292. });
  293. } else {
  294. let value = descriptor.value;
  295. Object.defineProperty(newObj, name, {
  296. configurable: descriptor.configurable,
  297. enumerable: descriptor.enumerable,
  298. get: util.deprecate(() => value, message, code),
  299. set: descriptor.writable
  300. ? util.deprecate(
  301. /**
  302. * @template T
  303. * @param {T} v value
  304. * @returns {T} result
  305. */
  306. v => (value = v),
  307. message,
  308. code
  309. )
  310. : undefined
  311. });
  312. }
  313. }
  314. return /** @type {T} */ (newObj);
  315. };
  316. module.exports.deprecateAllProperties = deprecateAllProperties;
  317. /**
  318. * @template {object} T
  319. * @param {T} fakeHook fake hook implementation
  320. * @param {string=} message deprecation message (not deprecated when unset)
  321. * @param {string=} code deprecation code (not deprecated when unset)
  322. * @returns {FakeHook<T>} fake hook which redirects
  323. */
  324. module.exports.createFakeHook = (fakeHook, message, code) => {
  325. if (message && code) {
  326. fakeHook = deprecateAllProperties(fakeHook, message, code);
  327. }
  328. return Object.freeze(
  329. Object.assign(fakeHook, { _fakeHook: /** @type {true} */ (true) })
  330. );
  331. };