ObjectMiddleware.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. */
  4. "use strict";
  5. const { DEFAULTS } = require("../config/defaults");
  6. const createHash = require("../util/createHash");
  7. const AggregateErrorSerializer = require("./AggregateErrorSerializer");
  8. const ArraySerializer = require("./ArraySerializer");
  9. const DateObjectSerializer = require("./DateObjectSerializer");
  10. const ErrorObjectSerializer = require("./ErrorObjectSerializer");
  11. const MapObjectSerializer = require("./MapObjectSerializer");
  12. const NullPrototypeObjectSerializer = require("./NullPrototypeObjectSerializer");
  13. const PlainObjectSerializer = require("./PlainObjectSerializer");
  14. const RegExpObjectSerializer = require("./RegExpObjectSerializer");
  15. const SerializerMiddleware = require("./SerializerMiddleware");
  16. const SetObjectSerializer = require("./SetObjectSerializer");
  17. /** @typedef {import("../logging/Logger").Logger} Logger */
  18. /** @typedef {typeof import("../util/Hash")} Hash */
  19. /** @typedef {import("./SerializerMiddleware").LazyOptions} LazyOptions */
  20. /** @typedef {import("./types").ComplexSerializableType} ComplexSerializableType */
  21. /** @typedef {import("./types").PrimitiveSerializableType} PrimitiveSerializableType */
  22. /** @typedef {new (...params: EXPECTED_ANY[]) => EXPECTED_ANY} Constructor */
  23. /*
  24. Format:
  25. File -> Section*
  26. Section -> ObjectSection | ReferenceSection | EscapeSection | OtherSection
  27. ObjectSection -> ESCAPE (
  28. number:relativeOffset (number > 0) |
  29. string:request (string|null):export
  30. ) Section:value* ESCAPE ESCAPE_END_OBJECT
  31. ReferenceSection -> ESCAPE number:relativeOffset (number < 0)
  32. EscapeSection -> ESCAPE ESCAPE_ESCAPE_VALUE (escaped value ESCAPE)
  33. EscapeSection -> ESCAPE ESCAPE_UNDEFINED (escaped value ESCAPE)
  34. OtherSection -> any (except ESCAPE)
  35. Why using null as escape value?
  36. Multiple null values can merged by the BinaryMiddleware, which makes it very efficient
  37. Technically any value can be used.
  38. */
  39. /**
  40. * @typedef {object} ObjectSerializerSnapshot
  41. * @property {number} length
  42. * @property {number} cycleStackSize
  43. * @property {number} referenceableSize
  44. * @property {number} currentPos
  45. * @property {number} objectTypeLookupSize
  46. * @property {number} currentPosTypeLookup
  47. */
  48. /** @typedef {EXPECTED_OBJECT | string} ReferenceableItem */
  49. /**
  50. * @typedef {object} ObjectSerializerContext
  51. * @property {(value: EXPECTED_ANY) => void} write
  52. * @property {(value: ReferenceableItem) => void} setCircularReference
  53. * @property {() => ObjectSerializerSnapshot} snapshot
  54. * @property {(snapshot: ObjectSerializerSnapshot) => void} rollback
  55. * @property {((item: EXPECTED_ANY | (() => EXPECTED_ANY)) => void)=} writeLazy
  56. * @property {((item: (EXPECTED_ANY | (() => EXPECTED_ANY)), obj: LazyOptions | undefined) => import("./SerializerMiddleware").LazyFunction<EXPECTED_ANY, EXPECTED_ANY, EXPECTED_ANY, LazyOptions>)=} writeSeparate
  57. */
  58. /**
  59. * @typedef {object} ObjectDeserializerContext
  60. * @property {() => EXPECTED_ANY} read
  61. * @property {(value: ReferenceableItem) => void} setCircularReference
  62. */
  63. /**
  64. * @typedef {object} ObjectSerializer
  65. * @property {(value: EXPECTED_ANY, context: ObjectSerializerContext) => void} serialize
  66. * @property {(context: ObjectDeserializerContext) => EXPECTED_ANY} deserialize
  67. */
  68. /**
  69. * @template T
  70. * @param {Set<T>} set set
  71. * @param {number} size count of items to keep
  72. */
  73. const setSetSize = (set, size) => {
  74. let i = 0;
  75. for (const item of set) {
  76. if (i++ >= size) {
  77. set.delete(item);
  78. }
  79. }
  80. };
  81. /**
  82. * @template K, X
  83. * @param {Map<K, X>} map map
  84. * @param {number} size count of items to keep
  85. */
  86. const setMapSize = (map, size) => {
  87. let i = 0;
  88. for (const item of map.keys()) {
  89. if (i++ >= size) {
  90. map.delete(item);
  91. }
  92. }
  93. };
  94. /**
  95. * @param {Buffer} buffer buffer
  96. * @param {string | Hash} hashFunction hash function to use
  97. * @returns {string} hash
  98. */
  99. const toHash = (buffer, hashFunction) => {
  100. const hash = createHash(hashFunction);
  101. hash.update(buffer);
  102. return hash.digest("latin1");
  103. };
  104. const ESCAPE = null;
  105. const ESCAPE_ESCAPE_VALUE = null;
  106. const ESCAPE_END_OBJECT = true;
  107. const ESCAPE_UNDEFINED = false;
  108. const CURRENT_VERSION = 2;
  109. /** @typedef {{ request?: string, name?: string | number | null, serializer?: ObjectSerializer }} SerializerConfig */
  110. /** @typedef {{ request?: string, name?: string | number | null, serializer: ObjectSerializer }} SerializerConfigWithSerializer */
  111. /** @type {Map<Constructor | null, SerializerConfig>} */
  112. const serializers = new Map();
  113. /** @type {Map<string | number, ObjectSerializer>} */
  114. const serializerInversed = new Map();
  115. /** @type {Set<string>} */
  116. const loadedRequests = new Set();
  117. const NOT_SERIALIZABLE = {};
  118. /** @type {Map<Constructor | null, ObjectSerializer>} */
  119. const jsTypes = new Map();
  120. jsTypes.set(Object, new PlainObjectSerializer());
  121. jsTypes.set(Array, new ArraySerializer());
  122. jsTypes.set(null, new NullPrototypeObjectSerializer());
  123. jsTypes.set(Map, new MapObjectSerializer());
  124. jsTypes.set(Set, new SetObjectSerializer());
  125. jsTypes.set(Date, new DateObjectSerializer());
  126. jsTypes.set(RegExp, new RegExpObjectSerializer());
  127. jsTypes.set(Error, new ErrorObjectSerializer(Error));
  128. jsTypes.set(EvalError, new ErrorObjectSerializer(EvalError));
  129. jsTypes.set(RangeError, new ErrorObjectSerializer(RangeError));
  130. jsTypes.set(ReferenceError, new ErrorObjectSerializer(ReferenceError));
  131. jsTypes.set(SyntaxError, new ErrorObjectSerializer(SyntaxError));
  132. jsTypes.set(TypeError, new ErrorObjectSerializer(TypeError));
  133. // eslint-disable-next-line n/no-unsupported-features/es-builtins, n/no-unsupported-features/es-syntax
  134. if (typeof AggregateError !== "undefined") {
  135. jsTypes.set(
  136. // eslint-disable-next-line n/no-unsupported-features/es-builtins, n/no-unsupported-features/es-syntax
  137. AggregateError,
  138. new AggregateErrorSerializer()
  139. );
  140. }
  141. // If in a sandboxed environment (e.g. jest), this escapes the sandbox and registers
  142. // real Object and Array types to. These types may occur in the wild too, e.g. when
  143. // using Structured Clone in postMessage.
  144. // eslint-disable-next-line n/exports-style
  145. if (exports.constructor !== Object) {
  146. // eslint-disable-next-line n/exports-style
  147. const Obj = /** @type {ObjectConstructor} */ (exports.constructor);
  148. const Fn = /** @type {FunctionConstructor} */ (Obj.constructor);
  149. for (const [type, config] of jsTypes) {
  150. if (type) {
  151. const Type = new Fn(`return ${type.name};`)();
  152. jsTypes.set(Type, config);
  153. }
  154. }
  155. }
  156. {
  157. let i = 1;
  158. for (const [type, serializer] of jsTypes) {
  159. serializers.set(type, {
  160. request: "",
  161. name: i++,
  162. serializer
  163. });
  164. }
  165. }
  166. for (const { request, name, serializer } of serializers.values()) {
  167. serializerInversed.set(
  168. `${request}/${name}`,
  169. /** @type {ObjectSerializer} */ (serializer)
  170. );
  171. }
  172. /** @type {Map<RegExp, (request: string) => boolean>} */
  173. const loaders = new Map();
  174. /** @typedef {ComplexSerializableType[]} DeserializedType */
  175. /** @typedef {PrimitiveSerializableType[]} SerializedType */
  176. /** @typedef {{ logger: Logger }} Context */
  177. /**
  178. * @extends {SerializerMiddleware<DeserializedType, SerializedType, Context>}
  179. */
  180. class ObjectMiddleware extends SerializerMiddleware {
  181. /**
  182. * @param {(context: ObjectSerializerContext | ObjectDeserializerContext) => void} extendContext context extensions
  183. * @param {string | Hash} hashFunction hash function to use
  184. */
  185. constructor(extendContext, hashFunction = DEFAULTS.HASH_FUNCTION) {
  186. super();
  187. this.extendContext = extendContext;
  188. this._hashFunction = hashFunction;
  189. }
  190. /**
  191. * @param {RegExp} regExp RegExp for which the request is tested
  192. * @param {(request: string) => boolean} loader loader to load the request, returns true when successful
  193. * @returns {void}
  194. */
  195. static registerLoader(regExp, loader) {
  196. loaders.set(regExp, loader);
  197. }
  198. /**
  199. * @param {Constructor} Constructor the constructor
  200. * @param {string} request the request which will be required when deserializing
  201. * @param {string | null} name the name to make multiple serializer unique when sharing a request
  202. * @param {ObjectSerializer} serializer the serializer
  203. * @returns {void}
  204. */
  205. static register(Constructor, request, name, serializer) {
  206. const key = `${request}/${name}`;
  207. if (serializers.has(Constructor)) {
  208. throw new Error(
  209. `ObjectMiddleware.register: serializer for ${Constructor.name} is already registered`
  210. );
  211. }
  212. if (serializerInversed.has(key)) {
  213. throw new Error(
  214. `ObjectMiddleware.register: serializer for ${key} is already registered`
  215. );
  216. }
  217. serializers.set(Constructor, {
  218. request,
  219. name,
  220. serializer
  221. });
  222. serializerInversed.set(key, serializer);
  223. }
  224. /**
  225. * @param {Constructor} Constructor the constructor
  226. * @returns {void}
  227. */
  228. static registerNotSerializable(Constructor) {
  229. if (serializers.has(Constructor)) {
  230. throw new Error(
  231. `ObjectMiddleware.registerNotSerializable: serializer for ${Constructor.name} is already registered`
  232. );
  233. }
  234. serializers.set(Constructor, NOT_SERIALIZABLE);
  235. }
  236. /**
  237. * @param {Constructor} object for serialization
  238. * @returns {SerializerConfigWithSerializer} Serializer config
  239. */
  240. static getSerializerFor(object) {
  241. const proto = Object.getPrototypeOf(object);
  242. let c;
  243. if (proto === null) {
  244. // Object created with Object.create(null)
  245. c = null;
  246. } else {
  247. c = proto.constructor;
  248. if (!c) {
  249. throw new Error(
  250. "Serialization of objects with prototype without valid constructor property not possible"
  251. );
  252. }
  253. }
  254. const config = serializers.get(c);
  255. if (!config) throw new Error(`No serializer registered for ${c.name}`);
  256. if (config === NOT_SERIALIZABLE) throw NOT_SERIALIZABLE;
  257. return /** @type {SerializerConfigWithSerializer} */ (config);
  258. }
  259. /**
  260. * @param {string} request request
  261. * @param {string} name name
  262. * @returns {ObjectSerializer} serializer
  263. */
  264. static getDeserializerFor(request, name) {
  265. const key = `${request}/${name}`;
  266. const serializer = serializerInversed.get(key);
  267. if (serializer === undefined) {
  268. throw new Error(`No deserializer registered for ${key}`);
  269. }
  270. return serializer;
  271. }
  272. /**
  273. * @param {string} request request
  274. * @param {string} name name
  275. * @returns {ObjectSerializer | undefined} serializer
  276. */
  277. static _getDeserializerForWithoutError(request, name) {
  278. const key = `${request}/${name}`;
  279. const serializer = serializerInversed.get(key);
  280. return serializer;
  281. }
  282. /**
  283. * @param {DeserializedType} data data
  284. * @param {Context} context context object
  285. * @returns {SerializedType | Promise<SerializedType> | null} serialized data
  286. */
  287. serialize(data, context) {
  288. /** @type {PrimitiveSerializableType[]} */
  289. let result = [CURRENT_VERSION];
  290. let currentPos = 0;
  291. /** @type {Map<ReferenceableItem, number>} */
  292. let referenceable = new Map();
  293. /**
  294. * @param {ReferenceableItem} item referenceable item
  295. */
  296. const addReferenceable = (item) => {
  297. referenceable.set(item, currentPos++);
  298. };
  299. let bufferDedupeMap = new Map();
  300. /**
  301. * @param {Buffer} buf buffer
  302. * @returns {Buffer} deduped buffer
  303. */
  304. const dedupeBuffer = (buf) => {
  305. const len = buf.length;
  306. const entry = bufferDedupeMap.get(len);
  307. if (entry === undefined) {
  308. bufferDedupeMap.set(len, buf);
  309. return buf;
  310. }
  311. if (Buffer.isBuffer(entry)) {
  312. if (len < 32) {
  313. if (buf.equals(entry)) {
  314. return entry;
  315. }
  316. bufferDedupeMap.set(len, [entry, buf]);
  317. return buf;
  318. }
  319. const hash = toHash(entry, this._hashFunction);
  320. const newMap = new Map();
  321. newMap.set(hash, entry);
  322. bufferDedupeMap.set(len, newMap);
  323. const hashBuf = toHash(buf, this._hashFunction);
  324. if (hash === hashBuf) {
  325. return entry;
  326. }
  327. return buf;
  328. } else if (Array.isArray(entry)) {
  329. if (entry.length < 16) {
  330. for (const item of entry) {
  331. if (buf.equals(item)) {
  332. return item;
  333. }
  334. }
  335. entry.push(buf);
  336. return buf;
  337. }
  338. const newMap = new Map();
  339. const hash = toHash(buf, this._hashFunction);
  340. let found;
  341. for (const item of entry) {
  342. const itemHash = toHash(item, this._hashFunction);
  343. newMap.set(itemHash, item);
  344. if (found === undefined && itemHash === hash) found = item;
  345. }
  346. bufferDedupeMap.set(len, newMap);
  347. if (found === undefined) {
  348. newMap.set(hash, buf);
  349. return buf;
  350. }
  351. return found;
  352. }
  353. const hash = toHash(buf, this._hashFunction);
  354. const item = entry.get(hash);
  355. if (item !== undefined) {
  356. return item;
  357. }
  358. entry.set(hash, buf);
  359. return buf;
  360. };
  361. let currentPosTypeLookup = 0;
  362. let objectTypeLookup = new Map();
  363. const cycleStack = new Set();
  364. /**
  365. * @param {ComplexSerializableType} item item to stack
  366. * @returns {string} stack
  367. */
  368. const stackToString = (item) => {
  369. const arr = [...cycleStack];
  370. arr.push(item);
  371. return arr
  372. .map((item) => {
  373. if (typeof item === "string") {
  374. if (item.length > 100) {
  375. return `String ${JSON.stringify(item.slice(0, 100)).slice(
  376. 0,
  377. -1
  378. )}..."`;
  379. }
  380. return `String ${JSON.stringify(item)}`;
  381. }
  382. try {
  383. const { request, name } = ObjectMiddleware.getSerializerFor(item);
  384. if (request) {
  385. return `${request}${name ? `.${name}` : ""}`;
  386. }
  387. } catch (_err) {
  388. // ignore -> fallback
  389. }
  390. if (typeof item === "object" && item !== null) {
  391. if (item.constructor) {
  392. if (item.constructor === Object) {
  393. return `Object { ${Object.keys(item).join(", ")} }`;
  394. }
  395. if (item.constructor === Map) return `Map { ${item.size} items }`;
  396. if (item.constructor === Array) {
  397. return `Array { ${item.length} items }`;
  398. }
  399. if (item.constructor === Set) return `Set { ${item.size} items }`;
  400. if (item.constructor === RegExp) return item.toString();
  401. return `${item.constructor.name}`;
  402. }
  403. return `Object [null prototype] { ${Object.keys(item).join(
  404. ", "
  405. )} }`;
  406. }
  407. if (typeof item === "bigint") {
  408. return `BigInt ${item}n`;
  409. }
  410. try {
  411. return `${item}`;
  412. } catch (err) {
  413. return `(${/** @type {Error} */ (err).message})`;
  414. }
  415. })
  416. .join(" -> ");
  417. };
  418. /** @type {WeakSet<Error>} */
  419. let hasDebugInfoAttached;
  420. /** @type {ObjectSerializerContext} */
  421. let ctx = {
  422. write(value) {
  423. try {
  424. process(value);
  425. } catch (err) {
  426. if (err !== NOT_SERIALIZABLE) {
  427. if (hasDebugInfoAttached === undefined) {
  428. hasDebugInfoAttached = new WeakSet();
  429. }
  430. if (!hasDebugInfoAttached.has(/** @type {Error} */ (err))) {
  431. /** @type {Error} */
  432. (err).message += `\nwhile serializing ${stackToString(value)}`;
  433. hasDebugInfoAttached.add(/** @type {Error} */ (err));
  434. }
  435. }
  436. throw err;
  437. }
  438. },
  439. setCircularReference(ref) {
  440. addReferenceable(ref);
  441. },
  442. snapshot() {
  443. return {
  444. length: result.length,
  445. cycleStackSize: cycleStack.size,
  446. referenceableSize: referenceable.size,
  447. currentPos,
  448. objectTypeLookupSize: objectTypeLookup.size,
  449. currentPosTypeLookup
  450. };
  451. },
  452. rollback(snapshot) {
  453. result.length = snapshot.length;
  454. setSetSize(cycleStack, snapshot.cycleStackSize);
  455. setMapSize(referenceable, snapshot.referenceableSize);
  456. currentPos = snapshot.currentPos;
  457. setMapSize(objectTypeLookup, snapshot.objectTypeLookupSize);
  458. currentPosTypeLookup = snapshot.currentPosTypeLookup;
  459. },
  460. ...context
  461. };
  462. this.extendContext(ctx);
  463. /**
  464. * @param {ComplexSerializableType} item item to serialize
  465. */
  466. const process = (item) => {
  467. if (Buffer.isBuffer(item)) {
  468. // check if we can emit a reference
  469. const ref = referenceable.get(item);
  470. if (ref !== undefined) {
  471. result.push(ESCAPE, ref - currentPos);
  472. return;
  473. }
  474. const alreadyUsedBuffer = dedupeBuffer(item);
  475. if (alreadyUsedBuffer !== item) {
  476. const ref = referenceable.get(alreadyUsedBuffer);
  477. if (ref !== undefined) {
  478. referenceable.set(item, ref);
  479. result.push(ESCAPE, ref - currentPos);
  480. return;
  481. }
  482. item = alreadyUsedBuffer;
  483. }
  484. addReferenceable(item);
  485. result.push(/** @type {Buffer} */ (item));
  486. } else if (item === ESCAPE) {
  487. result.push(ESCAPE, ESCAPE_ESCAPE_VALUE);
  488. } else if (
  489. typeof item === "object"
  490. // We don't have to check for null as ESCAPE is null and this has been checked before
  491. ) {
  492. // check if we can emit a reference
  493. const ref = referenceable.get(item);
  494. if (ref !== undefined) {
  495. result.push(ESCAPE, ref - currentPos);
  496. return;
  497. }
  498. if (cycleStack.has(item)) {
  499. throw new Error(
  500. "This is a circular references. To serialize circular references use 'setCircularReference' somewhere in the circle during serialize and deserialize."
  501. );
  502. }
  503. const { request, name, serializer } = ObjectMiddleware.getSerializerFor(
  504. /** @type {Constructor} */
  505. (item)
  506. );
  507. const key = `${request}/${name}`;
  508. const lastIndex = objectTypeLookup.get(key);
  509. if (lastIndex === undefined) {
  510. objectTypeLookup.set(key, currentPosTypeLookup++);
  511. result.push(ESCAPE, request, name);
  512. } else {
  513. result.push(ESCAPE, currentPosTypeLookup - lastIndex);
  514. }
  515. cycleStack.add(item);
  516. try {
  517. serializer.serialize(item, ctx);
  518. } finally {
  519. cycleStack.delete(item);
  520. }
  521. result.push(ESCAPE, ESCAPE_END_OBJECT);
  522. addReferenceable(item);
  523. } else if (typeof item === "string") {
  524. if (item.length > 1) {
  525. // short strings are shorter when not emitting a reference (this saves 1 byte per empty string)
  526. // check if we can emit a reference
  527. const ref = referenceable.get(item);
  528. if (ref !== undefined) {
  529. result.push(ESCAPE, ref - currentPos);
  530. return;
  531. }
  532. addReferenceable(item);
  533. }
  534. if (item.length > 102400 && context.logger) {
  535. context.logger.warn(
  536. `Serializing big strings (${Math.round(
  537. item.length / 1024
  538. )}kiB) impacts deserialization performance (consider using Buffer instead and decode when needed)`
  539. );
  540. }
  541. result.push(item);
  542. } else if (typeof item === "function") {
  543. if (!SerializerMiddleware.isLazy(item)) {
  544. throw new Error(`Unexpected function ${item}`);
  545. }
  546. /** @type {SerializedType | undefined} */
  547. const serializedData =
  548. SerializerMiddleware.getLazySerializedValue(item);
  549. if (serializedData !== undefined) {
  550. if (typeof serializedData === "function") {
  551. result.push(serializedData);
  552. } else {
  553. throw new Error("Not implemented");
  554. }
  555. } else if (SerializerMiddleware.isLazy(item, this)) {
  556. throw new Error("Not implemented");
  557. } else {
  558. const data =
  559. /** @type {() => PrimitiveSerializableType[] | Promise<PrimitiveSerializableType[]>} */
  560. (
  561. SerializerMiddleware.serializeLazy(item, (data) =>
  562. this.serialize([data], context)
  563. )
  564. );
  565. SerializerMiddleware.setLazySerializedValue(item, data);
  566. result.push(data);
  567. }
  568. } else if (item === undefined) {
  569. result.push(ESCAPE, ESCAPE_UNDEFINED);
  570. } else {
  571. result.push(item);
  572. }
  573. };
  574. try {
  575. for (const item of data) {
  576. process(item);
  577. }
  578. return result;
  579. } catch (err) {
  580. if (err === NOT_SERIALIZABLE) return null;
  581. throw err;
  582. } finally {
  583. // Get rid of these references to avoid leaking memory
  584. // This happens because the optimized code v8 generates
  585. // is optimized for our "ctx.write" method so it will reference
  586. // it from e. g. Dependency.prototype.serialize -(IC)-> ctx.write
  587. data =
  588. result =
  589. referenceable =
  590. bufferDedupeMap =
  591. objectTypeLookup =
  592. ctx =
  593. /** @type {EXPECTED_ANY} */
  594. (undefined);
  595. }
  596. }
  597. /**
  598. * @param {SerializedType} data data
  599. * @param {Context} context context object
  600. * @returns {DeserializedType | Promise<DeserializedType>} deserialized data
  601. */
  602. deserialize(data, context) {
  603. let currentDataPos = 0;
  604. const read = () => {
  605. if (currentDataPos >= data.length) {
  606. throw new Error("Unexpected end of stream");
  607. }
  608. return data[currentDataPos++];
  609. };
  610. if (read() !== CURRENT_VERSION) {
  611. throw new Error("Version mismatch, serializer changed");
  612. }
  613. let currentPos = 0;
  614. /** @type {ReferenceableItem[]} */
  615. let referenceable = [];
  616. /**
  617. * @param {ReferenceableItem} item referenceable item
  618. */
  619. const addReferenceable = (item) => {
  620. referenceable.push(item);
  621. currentPos++;
  622. };
  623. let currentPosTypeLookup = 0;
  624. /** @type {ObjectSerializer[]} */
  625. let objectTypeLookup = [];
  626. /** @type {ComplexSerializableType[]} */
  627. let result = [];
  628. /** @type {ObjectDeserializerContext} */
  629. let ctx = {
  630. read() {
  631. return decodeValue();
  632. },
  633. setCircularReference(ref) {
  634. addReferenceable(ref);
  635. },
  636. ...context
  637. };
  638. this.extendContext(ctx);
  639. /**
  640. * @returns {ComplexSerializableType} deserialize value
  641. */
  642. const decodeValue = () => {
  643. const item = read();
  644. if (item === ESCAPE) {
  645. const nextItem = read();
  646. if (nextItem === ESCAPE_ESCAPE_VALUE) {
  647. return ESCAPE;
  648. } else if (nextItem === ESCAPE_UNDEFINED) {
  649. // Nothing
  650. } else if (nextItem === ESCAPE_END_OBJECT) {
  651. throw new Error(
  652. `Unexpected end of object at position ${currentDataPos - 1}`
  653. );
  654. } else {
  655. const request = nextItem;
  656. let serializer;
  657. if (typeof request === "number") {
  658. if (request < 0) {
  659. // relative reference
  660. return referenceable[currentPos + request];
  661. }
  662. serializer = objectTypeLookup[currentPosTypeLookup - request];
  663. } else {
  664. if (typeof request !== "string") {
  665. throw new Error(
  666. `Unexpected type (${typeof request}) of request ` +
  667. `at position ${currentDataPos - 1}`
  668. );
  669. }
  670. const name = /** @type {string} */ (read());
  671. serializer = ObjectMiddleware._getDeserializerForWithoutError(
  672. request,
  673. name
  674. );
  675. if (serializer === undefined) {
  676. if (request && !loadedRequests.has(request)) {
  677. let loaded = false;
  678. for (const [regExp, loader] of loaders) {
  679. if (regExp.test(request) && loader(request)) {
  680. loaded = true;
  681. break;
  682. }
  683. }
  684. if (!loaded) {
  685. require(request);
  686. }
  687. loadedRequests.add(request);
  688. }
  689. serializer = ObjectMiddleware.getDeserializerFor(request, name);
  690. }
  691. objectTypeLookup.push(serializer);
  692. currentPosTypeLookup++;
  693. }
  694. try {
  695. const item = serializer.deserialize(ctx);
  696. const end1 = read();
  697. if (end1 !== ESCAPE) {
  698. throw new Error("Expected end of object");
  699. }
  700. const end2 = read();
  701. if (end2 !== ESCAPE_END_OBJECT) {
  702. throw new Error("Expected end of object");
  703. }
  704. addReferenceable(item);
  705. return item;
  706. } catch (err) {
  707. // As this is only for error handling, we omit creating a Map for
  708. // faster access to this information, as this would affect performance
  709. // in the good case
  710. let serializerEntry;
  711. for (const entry of serializers) {
  712. if (entry[1].serializer === serializer) {
  713. serializerEntry = entry;
  714. break;
  715. }
  716. }
  717. const name = !serializerEntry
  718. ? "unknown"
  719. : !serializerEntry[1].request
  720. ? /** @type {Constructor[]} */ (serializerEntry)[0].name
  721. : serializerEntry[1].name
  722. ? `${serializerEntry[1].request} ${serializerEntry[1].name}`
  723. : serializerEntry[1].request;
  724. /** @type {Error} */
  725. (err).message += `\n(during deserialization of ${name})`;
  726. throw err;
  727. }
  728. }
  729. } else if (typeof item === "string") {
  730. if (item.length > 1) {
  731. addReferenceable(item);
  732. }
  733. return item;
  734. } else if (Buffer.isBuffer(item)) {
  735. addReferenceable(item);
  736. return item;
  737. } else if (typeof item === "function") {
  738. return SerializerMiddleware.deserializeLazy(
  739. item,
  740. (data) =>
  741. /** @type {[DeserializedType]} */
  742. (this.deserialize(data, context))[0]
  743. );
  744. } else {
  745. return item;
  746. }
  747. };
  748. try {
  749. while (currentDataPos < data.length) {
  750. result.push(decodeValue());
  751. }
  752. return result;
  753. } finally {
  754. // Get rid of these references to avoid leaking memory
  755. // This happens because the optimized code v8 generates
  756. // is optimized for our "ctx.read" method so it will reference
  757. // it from e. g. Dependency.prototype.deserialize -(IC)-> ctx.read
  758. result =
  759. referenceable =
  760. data =
  761. objectTypeLookup =
  762. ctx =
  763. /** @type {EXPECTED_ANY} */
  764. (undefined);
  765. }
  766. }
  767. }
  768. module.exports = ObjectMiddleware;
  769. module.exports.NOT_SERIALIZABLE = NOT_SERIALIZABLE;