ObjectMiddleware.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877
  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 {import("../util/Hash").HashFunction} HashFunction */
  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 {HashFunction} 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. /** @typedef {(context: ObjectSerializerContext | ObjectDeserializerContext) => void} ExtendContext */
  178. /**
  179. * @extends {SerializerMiddleware<DeserializedType, SerializedType, Context>}
  180. */
  181. class ObjectMiddleware extends SerializerMiddleware {
  182. /**
  183. * @param {ExtendContext} extendContext context extensions
  184. * @param {HashFunction} hashFunction hash function to use
  185. */
  186. constructor(extendContext, hashFunction = DEFAULTS.HASH_FUNCTION) {
  187. super();
  188. /** @type {ExtendContext} */
  189. this.extendContext = extendContext;
  190. /** @type {HashFunction} */
  191. this._hashFunction = hashFunction;
  192. }
  193. /**
  194. * @param {RegExp} regExp RegExp for which the request is tested
  195. * @param {(request: string) => boolean} loader loader to load the request, returns true when successful
  196. * @returns {void}
  197. */
  198. static registerLoader(regExp, loader) {
  199. loaders.set(regExp, loader);
  200. }
  201. /**
  202. * @param {Constructor} Constructor the constructor
  203. * @param {string} request the request which will be required when deserializing
  204. * @param {string | null} name the name to make multiple serializer unique when sharing a request
  205. * @param {ObjectSerializer} serializer the serializer
  206. * @returns {void}
  207. */
  208. static register(Constructor, request, name, serializer) {
  209. const key = `${request}/${name}`;
  210. if (serializers.has(Constructor)) {
  211. throw new Error(
  212. `ObjectMiddleware.register: serializer for ${Constructor.name} is already registered`
  213. );
  214. }
  215. if (serializerInversed.has(key)) {
  216. throw new Error(
  217. `ObjectMiddleware.register: serializer for ${key} is already registered`
  218. );
  219. }
  220. serializers.set(Constructor, {
  221. request,
  222. name,
  223. serializer
  224. });
  225. serializerInversed.set(key, serializer);
  226. }
  227. /**
  228. * @param {Constructor} Constructor the constructor
  229. * @returns {void}
  230. */
  231. static registerNotSerializable(Constructor) {
  232. if (serializers.has(Constructor)) {
  233. throw new Error(
  234. `ObjectMiddleware.registerNotSerializable: serializer for ${Constructor.name} is already registered`
  235. );
  236. }
  237. serializers.set(Constructor, NOT_SERIALIZABLE);
  238. }
  239. /**
  240. * @param {EXPECTED_ANY} object for serialization
  241. * @returns {SerializerConfigWithSerializer} Serializer config
  242. */
  243. static getSerializerFor(object) {
  244. const proto = Object.getPrototypeOf(object);
  245. /** @type {null | Constructor} */
  246. let c;
  247. if (proto === null) {
  248. // Object created with Object.create(null)
  249. c = null;
  250. } else {
  251. c = proto.constructor;
  252. if (!c) {
  253. throw new Error(
  254. "Serialization of objects with prototype without valid constructor property not possible"
  255. );
  256. }
  257. }
  258. const config = serializers.get(c);
  259. if (!config) {
  260. throw new Error(
  261. `No serializer registered for ${/** @type {Constructor} */ (c).name}`
  262. );
  263. }
  264. if (config === NOT_SERIALIZABLE) throw NOT_SERIALIZABLE;
  265. return /** @type {SerializerConfigWithSerializer} */ (config);
  266. }
  267. /**
  268. * @param {string} request request
  269. * @param {string} name name
  270. * @returns {ObjectSerializer} serializer
  271. */
  272. static getDeserializerFor(request, name) {
  273. const key = `${request}/${name}`;
  274. const serializer = serializerInversed.get(key);
  275. if (serializer === undefined) {
  276. throw new Error(`No deserializer registered for ${key}`);
  277. }
  278. return serializer;
  279. }
  280. /**
  281. * @param {string} request request
  282. * @param {string} name name
  283. * @returns {ObjectSerializer | undefined} serializer
  284. */
  285. static _getDeserializerForWithoutError(request, name) {
  286. const key = `${request}/${name}`;
  287. const serializer = serializerInversed.get(key);
  288. return serializer;
  289. }
  290. /**
  291. * @param {DeserializedType} data data
  292. * @param {Context} context context object
  293. * @returns {SerializedType | Promise<SerializedType> | null} serialized data
  294. */
  295. serialize(data, context) {
  296. /** @type {PrimitiveSerializableType[]} */
  297. let result = [CURRENT_VERSION];
  298. let currentPos = 0;
  299. /** @type {Map<ReferenceableItem, number>} */
  300. let referenceable = new Map();
  301. /**
  302. * @param {ReferenceableItem} item referenceable item
  303. */
  304. const addReferenceable = (item) => {
  305. referenceable.set(item, currentPos++);
  306. };
  307. /** @type {Map<number, Buffer | [Buffer, Buffer] | Map<string, Buffer>>} */
  308. let bufferDedupeMap = new Map();
  309. /**
  310. * @param {Buffer} buf buffer
  311. * @returns {Buffer} deduped buffer
  312. */
  313. const dedupeBuffer = (buf) => {
  314. const len = buf.length;
  315. const entry = bufferDedupeMap.get(len);
  316. if (entry === undefined) {
  317. bufferDedupeMap.set(len, buf);
  318. return buf;
  319. }
  320. if (Buffer.isBuffer(entry)) {
  321. if (len < 32) {
  322. if (buf.equals(entry)) {
  323. return entry;
  324. }
  325. bufferDedupeMap.set(len, [entry, buf]);
  326. return buf;
  327. }
  328. const hash = toHash(entry, this._hashFunction);
  329. /** @type {Map<string, Buffer>} */
  330. const newMap = new Map();
  331. newMap.set(hash, entry);
  332. bufferDedupeMap.set(len, newMap);
  333. const hashBuf = toHash(buf, this._hashFunction);
  334. if (hash === hashBuf) {
  335. return entry;
  336. }
  337. return buf;
  338. } else if (Array.isArray(entry)) {
  339. if (entry.length < 16) {
  340. for (const item of entry) {
  341. if (buf.equals(item)) {
  342. return item;
  343. }
  344. }
  345. entry.push(buf);
  346. return buf;
  347. }
  348. /** @type {Map<string, Buffer>} */
  349. const newMap = new Map();
  350. const hash = toHash(buf, this._hashFunction);
  351. /** @type {undefined | Buffer} */
  352. let found;
  353. for (const item of entry) {
  354. const itemHash = toHash(item, this._hashFunction);
  355. newMap.set(itemHash, item);
  356. if (found === undefined && itemHash === hash) found = item;
  357. }
  358. bufferDedupeMap.set(len, newMap);
  359. if (found === undefined) {
  360. newMap.set(hash, buf);
  361. return buf;
  362. }
  363. return found;
  364. }
  365. const hash = toHash(buf, this._hashFunction);
  366. const item = entry.get(hash);
  367. if (item !== undefined) {
  368. return item;
  369. }
  370. entry.set(hash, buf);
  371. return buf;
  372. };
  373. let currentPosTypeLookup = 0;
  374. /** @type {Map<ComplexSerializableType, number>} */
  375. let objectTypeLookup = new Map();
  376. /** @type {Set<ComplexSerializableType>} */
  377. const cycleStack = new Set();
  378. /**
  379. * @param {ComplexSerializableType} item item to stack
  380. * @returns {string} stack
  381. */
  382. const stackToString = (item) => {
  383. const arr = [...cycleStack];
  384. arr.push(item);
  385. return arr
  386. .map((item) => {
  387. if (typeof item === "string") {
  388. if (item.length > 100) {
  389. return `String ${JSON.stringify(item.slice(0, 100)).slice(
  390. 0,
  391. -1
  392. )}..."`;
  393. }
  394. return `String ${JSON.stringify(item)}`;
  395. }
  396. try {
  397. const { request, name } = ObjectMiddleware.getSerializerFor(item);
  398. if (request) {
  399. return `${request}${name ? `.${name}` : ""}`;
  400. }
  401. } catch (_err) {
  402. // ignore -> fallback
  403. }
  404. if (typeof item === "object" && item !== null) {
  405. if (item.constructor) {
  406. if (item.constructor === Object) {
  407. return `Object { ${Object.keys(item).join(", ")} }`;
  408. }
  409. if (item.constructor === Map) {
  410. return `Map { ${/** @type {Map<EXPECTED_ANY, EXPECTED_ANY>} */ (item).size} items }`;
  411. }
  412. if (item.constructor === Array) {
  413. return `Array { ${/** @type {EXPECTED_ANY[]} */ (item).length} items }`;
  414. }
  415. if (item.constructor === Set) {
  416. return `Set { ${/** @type {Set<EXPECTED_ANY>} */ (item).size} items }`;
  417. }
  418. if (item.constructor === RegExp) {
  419. return /** @type {RegExp} */ (item).toString();
  420. }
  421. return `${item.constructor.name}`;
  422. }
  423. return `Object [null prototype] { ${Object.keys(item).join(
  424. ", "
  425. )} }`;
  426. }
  427. if (typeof item === "bigint") {
  428. return `BigInt ${item}n`;
  429. }
  430. try {
  431. return `${item}`;
  432. } catch (err) {
  433. return `(${/** @type {Error} */ (err).message})`;
  434. }
  435. })
  436. .join(" -> ");
  437. };
  438. /** @type {undefined | WeakSet<Error>} */
  439. let hasDebugInfoAttached;
  440. /** @type {ObjectSerializerContext} */
  441. let ctx = {
  442. write(value) {
  443. try {
  444. process(value);
  445. } catch (err) {
  446. if (err !== NOT_SERIALIZABLE) {
  447. if (hasDebugInfoAttached === undefined) {
  448. hasDebugInfoAttached = new WeakSet();
  449. }
  450. if (!hasDebugInfoAttached.has(/** @type {Error} */ (err))) {
  451. /** @type {Error} */
  452. (err).message += `\nwhile serializing ${stackToString(value)}`;
  453. hasDebugInfoAttached.add(/** @type {Error} */ (err));
  454. }
  455. }
  456. throw err;
  457. }
  458. },
  459. setCircularReference(ref) {
  460. addReferenceable(ref);
  461. },
  462. snapshot() {
  463. return {
  464. length: result.length,
  465. cycleStackSize: cycleStack.size,
  466. referenceableSize: referenceable.size,
  467. currentPos,
  468. objectTypeLookupSize: objectTypeLookup.size,
  469. currentPosTypeLookup
  470. };
  471. },
  472. rollback(snapshot) {
  473. result.length = snapshot.length;
  474. setSetSize(cycleStack, snapshot.cycleStackSize);
  475. setMapSize(referenceable, snapshot.referenceableSize);
  476. currentPos = snapshot.currentPos;
  477. setMapSize(objectTypeLookup, snapshot.objectTypeLookupSize);
  478. currentPosTypeLookup = snapshot.currentPosTypeLookup;
  479. },
  480. ...context
  481. };
  482. this.extendContext(ctx);
  483. /**
  484. * @param {ComplexSerializableType} item item to serialize
  485. */
  486. const process = (item) => {
  487. if (Buffer.isBuffer(item)) {
  488. // check if we can emit a reference
  489. const ref = referenceable.get(item);
  490. if (ref !== undefined) {
  491. result.push(ESCAPE, ref - currentPos);
  492. return;
  493. }
  494. const alreadyUsedBuffer = dedupeBuffer(item);
  495. if (alreadyUsedBuffer !== item) {
  496. const ref = referenceable.get(alreadyUsedBuffer);
  497. if (ref !== undefined) {
  498. referenceable.set(item, ref);
  499. result.push(ESCAPE, ref - currentPos);
  500. return;
  501. }
  502. item = alreadyUsedBuffer;
  503. }
  504. addReferenceable(item);
  505. result.push(/** @type {Buffer} */ (item));
  506. } else if (item === ESCAPE) {
  507. result.push(ESCAPE, ESCAPE_ESCAPE_VALUE);
  508. } else if (
  509. typeof item === "object"
  510. // We don't have to check for null as ESCAPE is null and this has been checked before
  511. ) {
  512. // check if we can emit a reference
  513. const ref = referenceable.get(item);
  514. if (ref !== undefined) {
  515. result.push(ESCAPE, ref - currentPos);
  516. return;
  517. }
  518. if (cycleStack.has(item)) {
  519. throw new Error(
  520. "This is a circular references. To serialize circular references use 'setCircularReference' somewhere in the circle during serialize and deserialize."
  521. );
  522. }
  523. const { request, name, serializer } = ObjectMiddleware.getSerializerFor(
  524. /** @type {Constructor} */
  525. (item)
  526. );
  527. const key = `${request}/${name}`;
  528. const lastIndex = objectTypeLookup.get(key);
  529. if (lastIndex === undefined) {
  530. objectTypeLookup.set(key, currentPosTypeLookup++);
  531. result.push(ESCAPE, request, name);
  532. } else {
  533. result.push(ESCAPE, currentPosTypeLookup - lastIndex);
  534. }
  535. cycleStack.add(item);
  536. try {
  537. serializer.serialize(item, ctx);
  538. } finally {
  539. cycleStack.delete(item);
  540. }
  541. result.push(ESCAPE, ESCAPE_END_OBJECT);
  542. addReferenceable(item);
  543. } else if (typeof item === "string") {
  544. if (item.length > 1) {
  545. // short strings are shorter when not emitting a reference (this saves 1 byte per empty string)
  546. // check if we can emit a reference
  547. const ref = referenceable.get(item);
  548. if (ref !== undefined) {
  549. result.push(ESCAPE, ref - currentPos);
  550. return;
  551. }
  552. addReferenceable(item);
  553. }
  554. if (item.length > 102400 && context.logger) {
  555. context.logger.warn(
  556. `Serializing big strings (${Math.round(
  557. item.length / 1024
  558. )}kiB) impacts deserialization performance (consider using Buffer instead and decode when needed)`
  559. );
  560. }
  561. result.push(item);
  562. } else if (typeof item === "function") {
  563. if (!SerializerMiddleware.isLazy(item)) {
  564. throw new Error(`Unexpected function ${item}`);
  565. }
  566. /** @type {SerializedType | undefined} */
  567. const serializedData =
  568. SerializerMiddleware.getLazySerializedValue(item);
  569. if (serializedData !== undefined) {
  570. if (typeof serializedData === "function") {
  571. result.push(serializedData);
  572. } else {
  573. throw new Error("Not implemented");
  574. }
  575. } else if (SerializerMiddleware.isLazy(item, this)) {
  576. throw new Error("Not implemented");
  577. } else {
  578. const data =
  579. /** @type {() => PrimitiveSerializableType[] | Promise<PrimitiveSerializableType[]>} */
  580. (
  581. SerializerMiddleware.serializeLazy(item, (data) =>
  582. this.serialize([data], context)
  583. )
  584. );
  585. SerializerMiddleware.setLazySerializedValue(item, data);
  586. result.push(data);
  587. }
  588. } else if (item === undefined) {
  589. result.push(ESCAPE, ESCAPE_UNDEFINED);
  590. } else {
  591. result.push(item);
  592. }
  593. };
  594. try {
  595. for (const item of data) {
  596. process(item);
  597. }
  598. return result;
  599. } catch (err) {
  600. if (err === NOT_SERIALIZABLE) return null;
  601. throw err;
  602. } finally {
  603. // Get rid of these references to avoid leaking memory
  604. // This happens because the optimized code v8 generates
  605. // is optimized for our "ctx.write" method so it will reference
  606. // it from e. g. Dependency.prototype.serialize -(IC)-> ctx.write
  607. data =
  608. result =
  609. referenceable =
  610. bufferDedupeMap =
  611. objectTypeLookup =
  612. ctx =
  613. /** @type {EXPECTED_ANY} */
  614. (undefined);
  615. }
  616. }
  617. /**
  618. * @param {SerializedType} data data
  619. * @param {Context} context context object
  620. * @returns {DeserializedType | Promise<DeserializedType>} deserialized data
  621. */
  622. deserialize(data, context) {
  623. let currentDataPos = 0;
  624. const read = () => {
  625. if (currentDataPos >= data.length) {
  626. throw new Error("Unexpected end of stream");
  627. }
  628. return data[currentDataPos++];
  629. };
  630. if (read() !== CURRENT_VERSION) {
  631. throw new Error("Version mismatch, serializer changed");
  632. }
  633. let currentPos = 0;
  634. /** @type {ReferenceableItem[]} */
  635. let referenceable = [];
  636. /**
  637. * @param {ReferenceableItem} item referenceable item
  638. */
  639. const addReferenceable = (item) => {
  640. referenceable.push(item);
  641. currentPos++;
  642. };
  643. let currentPosTypeLookup = 0;
  644. /** @type {ObjectSerializer[]} */
  645. let objectTypeLookup = [];
  646. /** @type {ComplexSerializableType[]} */
  647. let result = [];
  648. /** @type {ObjectDeserializerContext} */
  649. let ctx = {
  650. read() {
  651. return decodeValue();
  652. },
  653. setCircularReference(ref) {
  654. addReferenceable(ref);
  655. },
  656. ...context
  657. };
  658. this.extendContext(ctx);
  659. /**
  660. * @returns {ComplexSerializableType} deserialize value
  661. */
  662. const decodeValue = () => {
  663. const item = read();
  664. if (item === ESCAPE) {
  665. const nextItem = read();
  666. if (nextItem === ESCAPE_ESCAPE_VALUE) {
  667. return ESCAPE;
  668. } else if (nextItem === ESCAPE_UNDEFINED) {
  669. // Nothing
  670. } else if (nextItem === ESCAPE_END_OBJECT) {
  671. throw new Error(
  672. `Unexpected end of object at position ${currentDataPos - 1}`
  673. );
  674. } else {
  675. const request = nextItem;
  676. /** @type {undefined | ObjectSerializer} */
  677. let serializer;
  678. if (typeof request === "number") {
  679. if (request < 0) {
  680. // relative reference
  681. return referenceable[currentPos + request];
  682. }
  683. serializer = objectTypeLookup[currentPosTypeLookup - request];
  684. } else {
  685. if (typeof request !== "string") {
  686. throw new Error(
  687. `Unexpected type (${typeof request}) of request ` +
  688. `at position ${currentDataPos - 1}`
  689. );
  690. }
  691. const name = /** @type {string} */ (read());
  692. serializer = ObjectMiddleware._getDeserializerForWithoutError(
  693. request,
  694. name
  695. );
  696. if (serializer === undefined) {
  697. if (request && !loadedRequests.has(request)) {
  698. let loaded = false;
  699. for (const [regExp, loader] of loaders) {
  700. if (regExp.test(request) && loader(request)) {
  701. loaded = true;
  702. break;
  703. }
  704. }
  705. if (!loaded) {
  706. require(request);
  707. }
  708. loadedRequests.add(request);
  709. }
  710. serializer = ObjectMiddleware.getDeserializerFor(request, name);
  711. }
  712. objectTypeLookup.push(serializer);
  713. currentPosTypeLookup++;
  714. }
  715. try {
  716. const item = serializer.deserialize(ctx);
  717. const end1 = read();
  718. if (end1 !== ESCAPE) {
  719. throw new Error("Expected end of object");
  720. }
  721. const end2 = read();
  722. if (end2 !== ESCAPE_END_OBJECT) {
  723. throw new Error("Expected end of object");
  724. }
  725. addReferenceable(item);
  726. return item;
  727. } catch (err) {
  728. // As this is only for error handling, we omit creating a Map for
  729. // faster access to this information, as this would affect performance
  730. // in the good case
  731. /** @type {undefined | [Constructor | null, SerializerConfig]} */
  732. let serializerEntry;
  733. for (const entry of serializers) {
  734. if (entry[1].serializer === serializer) {
  735. serializerEntry = entry;
  736. break;
  737. }
  738. }
  739. const name = !serializerEntry
  740. ? "unknown"
  741. : !serializerEntry[1].request
  742. ? /** @type {Constructor[]} */ (serializerEntry)[0].name
  743. : serializerEntry[1].name
  744. ? `${serializerEntry[1].request} ${serializerEntry[1].name}`
  745. : serializerEntry[1].request;
  746. /** @type {Error} */
  747. (err).message += `\n(during deserialization of ${name})`;
  748. throw err;
  749. }
  750. }
  751. } else if (typeof item === "string") {
  752. if (item.length > 1) {
  753. addReferenceable(item);
  754. }
  755. return item;
  756. } else if (Buffer.isBuffer(item)) {
  757. addReferenceable(item);
  758. return item;
  759. } else if (typeof item === "function") {
  760. return SerializerMiddleware.deserializeLazy(
  761. item,
  762. (data) =>
  763. /** @type {[DeserializedType]} */
  764. (this.deserialize(data, context))[0]
  765. );
  766. } else {
  767. return item;
  768. }
  769. };
  770. try {
  771. while (currentDataPos < data.length) {
  772. result.push(decodeValue());
  773. }
  774. return result;
  775. } finally {
  776. // Get rid of these references to avoid leaking memory
  777. // This happens because the optimized code v8 generates
  778. // is optimized for our "ctx.read" method so it will reference
  779. // it from e. g. Dependency.prototype.deserialize -(IC)-> ctx.read
  780. result =
  781. referenceable =
  782. data =
  783. objectTypeLookup =
  784. ctx =
  785. /** @type {EXPECTED_ANY} */
  786. (undefined);
  787. }
  788. }
  789. }
  790. module.exports = ObjectMiddleware;
  791. module.exports.NOT_SERIALIZABLE = NOT_SERIALIZABLE;