webpack/lib/serialization/ObjectMiddleware.js

857 lines
24 KiB
JavaScript
Raw Normal View History

2018-10-09 20:30:59 +08:00
/*
MIT License http://www.opensource.org/licenses/mit-license.php
*/
"use strict";
const { DEFAULTS } = require("../config/defaults");
2020-12-14 06:31:28 +08:00
const createHash = require("../util/createHash");
const AggregateErrorSerializer = require("./AggregateErrorSerializer");
2020-01-28 15:55:22 +08:00
const ArraySerializer = require("./ArraySerializer");
const DateObjectSerializer = require("./DateObjectSerializer");
const ErrorObjectSerializer = require("./ErrorObjectSerializer");
2018-10-09 20:30:59 +08:00
const MapObjectSerializer = require("./MapObjectSerializer");
const NullPrototypeObjectSerializer = require("./NullPrototypeObjectSerializer");
2018-10-09 20:30:59 +08:00
const PlainObjectSerializer = require("./PlainObjectSerializer");
2018-10-18 18:34:54 +08:00
const RegExpObjectSerializer = require("./RegExpObjectSerializer");
2018-10-09 20:30:59 +08:00
const SerializerMiddleware = require("./SerializerMiddleware");
const SetObjectSerializer = require("./SetObjectSerializer");
2025-04-16 22:04:11 +08:00
/** @typedef {import("../logging/Logger").Logger} Logger */
/** @typedef {typeof import("../util/Hash")} Hash */
2025-04-16 22:04:11 +08:00
/** @typedef {import("./SerializerMiddleware").LazyOptions} LazyOptions */
/** @typedef {import("./types").ComplexSerializableType} ComplexSerializableType */
/** @typedef {import("./types").PrimitiveSerializableType} PrimitiveSerializableType */
2025-03-11 08:28:01 +08:00
/** @typedef {new (...params: EXPECTED_ANY[]) => EXPECTED_ANY} Constructor */
2018-10-09 20:30:59 +08:00
/*
Format:
File -> Section*
Section -> ObjectSection | ReferenceSection | EscapeSection | OtherSection
ObjectSection -> ESCAPE (
2018-10-10 15:55:06 +08:00
number:relativeOffset (number > 0) |
2018-10-09 20:30:59 +08:00
string:request (string|null):export
) Section:value* ESCAPE ESCAPE_END_OBJECT
2018-10-10 15:55:06 +08:00
ReferenceSection -> ESCAPE number:relativeOffset (number < 0)
2018-10-09 20:30:59 +08:00
EscapeSection -> ESCAPE ESCAPE_ESCAPE_VALUE (escaped value ESCAPE)
EscapeSection -> ESCAPE ESCAPE_UNDEFINED (escaped value ESCAPE)
OtherSection -> any (except ESCAPE)
Why using null as escape value?
Multiple null values can merged by the BinaryMiddleware, which makes it very efficient
Technically any value can be used.
*/
2025-03-07 21:12:22 +08:00
/**
* @typedef {object} ObjectSerializerSnapshot
* @property {number} length
* @property {number} cycleStackSize
* @property {number} referenceableSize
* @property {number} currentPos
* @property {number} objectTypeLookupSize
* @property {number} currentPosTypeLookup
*/
2025-08-22 01:45:11 +08:00
2025-04-16 22:04:11 +08:00
/** @typedef {EXPECTED_OBJECT | string} ReferenceableItem */
2025-03-07 21:12:22 +08:00
2018-10-09 20:30:59 +08:00
/**
2024-06-11 21:09:50 +08:00
* @typedef {object} ObjectSerializerContext
2025-08-22 01:45:11 +08:00
* @property {(value: EXPECTED_ANY) => void} write
2025-04-16 22:04:11 +08:00
* @property {(value: ReferenceableItem) => void} setCircularReference
* @property {() => ObjectSerializerSnapshot} snapshot
* @property {(snapshot: ObjectSerializerSnapshot) => void} rollback
2025-08-22 01:45:11 +08:00
* @property {((item: EXPECTED_ANY | (() => EXPECTED_ANY)) => void)=} writeLazy
* @property {((item: (EXPECTED_ANY | (() => EXPECTED_ANY)), obj: LazyOptions | undefined) => import("./SerializerMiddleware").LazyFunction<EXPECTED_ANY, EXPECTED_ANY, EXPECTED_ANY, LazyOptions>)=} writeSeparate
2018-10-09 20:30:59 +08:00
*/
/**
2024-06-11 21:09:50 +08:00
* @typedef {object} ObjectDeserializerContext
2025-08-22 01:45:11 +08:00
* @property {() => EXPECTED_ANY} read
2025-04-16 22:04:11 +08:00
* @property {(value: ReferenceableItem) => void} setCircularReference
2018-10-09 20:30:59 +08:00
*/
/**
2024-06-11 21:09:50 +08:00
* @typedef {object} ObjectSerializer
2025-08-22 01:45:11 +08:00
* @property {(value: EXPECTED_ANY, context: ObjectSerializerContext) => void} serialize
* @property {(context: ObjectDeserializerContext) => EXPECTED_ANY} deserialize
2018-10-09 20:30:59 +08:00
*/
2023-05-23 02:32:23 +08:00
/**
* @template T
* @param {Set<T>} set set
* @param {number} size count of items to keep
*/
2018-10-23 17:31:20 +08:00
const setSetSize = (set, size) => {
let i = 0;
for (const item of set) {
if (i++ >= size) {
set.delete(item);
}
}
};
2023-05-23 02:32:23 +08:00
/**
* @template K, X
* @param {Map<K, X>} map map
* @param {number} size count of items to keep
*/
2018-10-23 17:31:20 +08:00
const setMapSize = (map, size) => {
let i = 0;
for (const item of map.keys()) {
if (i++ >= size) {
map.delete(item);
}
}
};
/**
* @param {Buffer} buffer buffer
* @param {string | Hash} hashFunction hash function to use
* @returns {string} hash
*/
const toHash = (buffer, hashFunction) => {
const hash = createHash(hashFunction);
2020-12-14 06:31:28 +08:00
hash.update(buffer);
2025-10-07 22:40:59 +08:00
return hash.digest("latin1");
2020-12-14 06:31:28 +08:00
};
2018-10-09 20:30:59 +08:00
const ESCAPE = null;
2018-10-10 15:55:06 +08:00
const ESCAPE_ESCAPE_VALUE = null;
const ESCAPE_END_OBJECT = true;
const ESCAPE_UNDEFINED = false;
2018-10-09 20:30:59 +08:00
const CURRENT_VERSION = 2;
2018-10-09 20:30:59 +08:00
2025-03-07 21:12:22 +08:00
/** @typedef {{ request?: string, name?: string | number | null, serializer?: ObjectSerializer }} SerializerConfig */
/** @typedef {{ request?: string, name?: string | number | null, serializer: ObjectSerializer }} SerializerConfigWithSerializer */
2025-08-22 01:45:11 +08:00
/** @type {Map<Constructor | null, SerializerConfig>} */
2018-10-09 20:30:59 +08:00
const serializers = new Map();
2023-05-23 02:32:23 +08:00
/** @type {Map<string | number, ObjectSerializer>} */
2018-10-09 20:30:59 +08:00
const serializerInversed = new Map();
2023-05-23 02:32:23 +08:00
/** @type {Set<string>} */
2018-10-09 20:30:59 +08:00
const loadedRequests = new Set();
const NOT_SERIALIZABLE = {};
2025-08-22 01:45:11 +08:00
/** @type {Map<Constructor | null, ObjectSerializer>} */
2018-10-25 04:23:35 +08:00
const jsTypes = new Map();
2020-01-28 15:55:22 +08:00
jsTypes.set(Object, new PlainObjectSerializer());
jsTypes.set(Array, new ArraySerializer());
jsTypes.set(null, new NullPrototypeObjectSerializer());
2018-10-25 04:23:35 +08:00
jsTypes.set(Map, new MapObjectSerializer());
jsTypes.set(Set, new SetObjectSerializer());
jsTypes.set(Date, new DateObjectSerializer());
2018-10-25 04:23:35 +08:00
jsTypes.set(RegExp, new RegExpObjectSerializer());
jsTypes.set(Error, new ErrorObjectSerializer(Error));
jsTypes.set(EvalError, new ErrorObjectSerializer(EvalError));
jsTypes.set(RangeError, new ErrorObjectSerializer(RangeError));
jsTypes.set(ReferenceError, new ErrorObjectSerializer(ReferenceError));
jsTypes.set(SyntaxError, new ErrorObjectSerializer(SyntaxError));
jsTypes.set(TypeError, new ErrorObjectSerializer(TypeError));
2025-04-23 06:27:18 +08:00
// @ts-expect-error ES2018 doesn't `AggregateError`, but it can be used by developers
// eslint-disable-next-line n/no-unsupported-features/es-builtins, n/no-unsupported-features/es-syntax
if (typeof AggregateError !== "undefined") {
jsTypes.set(
2025-04-23 06:27:18 +08:00
// @ts-expect-error ES2018 doesn't `AggregateError`, but it can be used by developers
// eslint-disable-next-line n/no-unsupported-features/es-builtins, n/no-unsupported-features/es-syntax
AggregateError,
new AggregateErrorSerializer()
);
}
2025-03-14 00:34:04 +08:00
// If in a sandboxed environment (e.g. jest), this escapes the sandbox and registers
// real Object and Array types to. These types may occur in the wild too, e.g. when
2020-01-28 15:42:49 +08:00
// using Structured Clone in postMessage.
2024-07-31 04:54:55 +08:00
// eslint-disable-next-line n/exports-style
2020-01-28 15:42:49 +08:00
if (exports.constructor !== Object) {
2025-03-14 00:34:04 +08:00
// eslint-disable-next-line n/exports-style
const Obj = /** @type {ObjectConstructor} */ (exports.constructor);
const Fn = /** @type {FunctionConstructor} */ (Obj.constructor);
2025-07-03 17:06:45 +08:00
for (const [type, config] of jsTypes) {
2020-01-28 15:42:49 +08:00
if (type) {
const Type = new Fn(`return ${type.name};`)();
jsTypes.set(Type, config);
}
}
}
2018-10-25 04:23:35 +08:00
{
let i = 1;
for (const [type, serializer] of jsTypes) {
serializers.set(type, {
request: "",
name: i++,
serializer
});
}
}
2018-10-09 20:30:59 +08:00
for (const { request, name, serializer } of serializers.values()) {
2023-06-12 22:21:21 +08:00
serializerInversed.set(
`${request}/${name}`,
/** @type {ObjectSerializer} */ (serializer)
);
2018-10-09 20:30:59 +08:00
}
/** @type {Map<RegExp, (request: string) => boolean>} */
const loaders = new Map();
2025-04-16 22:04:11 +08:00
/** @typedef {ComplexSerializableType[]} DeserializedType */
/** @typedef {PrimitiveSerializableType[]} SerializedType */
/** @typedef {{ logger: Logger }} Context */
/**
2025-04-16 22:04:11 +08:00
* @extends {SerializerMiddleware<DeserializedType, SerializedType, Context>}
*/
2018-10-09 20:30:59 +08:00
class ObjectMiddleware extends SerializerMiddleware {
/**
* @param {(context: ObjectSerializerContext | ObjectDeserializerContext) => void} extendContext context extensions
* @param {string | Hash} hashFunction hash function to use
*/
constructor(extendContext, hashFunction = DEFAULTS.HASH_FUNCTION) {
super();
this.extendContext = extendContext;
this._hashFunction = hashFunction;
}
2024-07-31 12:23:44 +08:00
/**
* @param {RegExp} regExp RegExp for which the request is tested
* @param {(request: string) => boolean} loader loader to load the request, returns true when successful
* @returns {void}
*/
static registerLoader(regExp, loader) {
loaders.set(regExp, loader);
}
2018-10-09 20:30:59 +08:00
/**
* @param {Constructor} Constructor the constructor
* @param {string} request the request which will be required when deserializing
2023-06-12 22:21:21 +08:00
* @param {string | null} name the name to make multiple serializer unique when sharing a request
2018-10-09 20:30:59 +08:00
* @param {ObjectSerializer} serializer the serializer
* @returns {void}
*/
static register(Constructor, request, name, serializer) {
2024-07-31 10:39:30 +08:00
const key = `${request}/${name}`;
2018-10-09 20:30:59 +08:00
if (serializers.has(Constructor)) {
throw new Error(
2019-06-13 16:51:12 +08:00
`ObjectMiddleware.register: serializer for ${Constructor.name} is already registered`
2018-10-09 20:30:59 +08:00
);
}
2018-10-09 20:30:59 +08:00
if (serializerInversed.has(key)) {
throw new Error(
`ObjectMiddleware.register: serializer for ${key} is already registered`
);
}
2018-10-09 20:30:59 +08:00
serializers.set(Constructor, {
request,
name,
serializer
});
2018-10-09 20:30:59 +08:00
serializerInversed.set(key, serializer);
}
/**
* @param {Constructor} Constructor the constructor
* @returns {void}
*/
static registerNotSerializable(Constructor) {
if (serializers.has(Constructor)) {
throw new Error(
2019-06-13 16:51:12 +08:00
`ObjectMiddleware.registerNotSerializable: serializer for ${Constructor.name} is already registered`
);
}
serializers.set(Constructor, NOT_SERIALIZABLE);
}
2025-03-07 21:12:22 +08:00
/**
2025-04-16 22:04:11 +08:00
* @param {Constructor} object for serialization
2025-03-07 21:12:22 +08:00
* @returns {SerializerConfigWithSerializer} Serializer config
*/
2018-10-09 20:30:59 +08:00
static getSerializerFor(object) {
const proto = Object.getPrototypeOf(object);
let c;
if (proto === null) {
// Object created with Object.create(null)
c = null;
} else {
c = proto.constructor;
if (!c) {
throw new Error(
"Serialization of objects with prototype without valid constructor property not possible"
);
}
}
2018-10-09 20:30:59 +08:00
const config = serializers.get(c);
2018-10-09 20:30:59 +08:00
if (!config) throw new Error(`No serializer registered for ${c.name}`);
if (config === NOT_SERIALIZABLE) throw NOT_SERIALIZABLE;
2025-03-07 21:12:22 +08:00
return /** @type {SerializerConfigWithSerializer} */ (config);
2018-10-09 20:30:59 +08:00
}
2023-05-23 02:32:23 +08:00
/**
* @param {string} request request
2025-03-07 21:12:22 +08:00
* @param {string} name name
2023-05-23 02:32:23 +08:00
* @returns {ObjectSerializer} serializer
*/
2018-10-09 20:30:59 +08:00
static getDeserializerFor(request, name) {
2024-07-31 10:39:30 +08:00
const key = `${request}/${name}`;
2018-10-09 20:30:59 +08:00
const serializer = serializerInversed.get(key);
2018-10-09 20:30:59 +08:00
if (serializer === undefined) {
throw new Error(`No deserializer registered for ${key}`);
}
2018-10-09 20:30:59 +08:00
return serializer;
}
2023-05-23 02:32:23 +08:00
/**
* @param {string} request request
2024-10-02 05:18:10 +08:00
* @param {string} name name
* @returns {ObjectSerializer | undefined} serializer
2023-05-23 02:32:23 +08:00
*/
static _getDeserializerForWithoutError(request, name) {
2024-07-31 10:39:30 +08:00
const key = `${request}/${name}`;
const serializer = serializerInversed.get(key);
return serializer;
}
2018-10-09 20:30:59 +08:00
/**
* @param {DeserializedType} data data
2025-03-07 21:12:22 +08:00
* @param {Context} context context object
2025-03-11 08:28:01 +08:00
* @returns {SerializedType | Promise<SerializedType> | null} serialized data
2018-10-09 20:30:59 +08:00
*/
serialize(data, context) {
2025-08-22 01:45:11 +08:00
/** @type {PrimitiveSerializableType[]} */
let result = [CURRENT_VERSION];
2018-10-09 20:30:59 +08:00
let currentPos = 0;
2025-04-16 22:04:11 +08:00
/** @type {Map<ReferenceableItem, number>} */
let referenceable = new Map();
2025-03-07 21:12:22 +08:00
/**
2025-04-16 22:04:11 +08:00
* @param {ReferenceableItem} item referenceable item
2025-03-07 21:12:22 +08:00
*/
const addReferenceable = (item) => {
2018-10-09 20:30:59 +08:00
referenceable.set(item, currentPos++);
};
let bufferDedupeMap = new Map();
2024-10-24 11:02:20 +08:00
/**
* @param {Buffer} buf buffer
* @returns {Buffer} deduped buffer
*/
const dedupeBuffer = (buf) => {
2020-12-14 06:31:28 +08:00
const len = buf.length;
const entry = bufferDedupeMap.get(len);
if (entry === undefined) {
bufferDedupeMap.set(len, buf);
return buf;
}
if (Buffer.isBuffer(entry)) {
if (len < 32) {
if (buf.equals(entry)) {
return entry;
}
bufferDedupeMap.set(len, [entry, buf]);
return buf;
}
2024-07-31 04:21:27 +08:00
const hash = toHash(entry, this._hashFunction);
const newMap = new Map();
newMap.set(hash, entry);
bufferDedupeMap.set(len, newMap);
const hashBuf = toHash(buf, this._hashFunction);
if (hash === hashBuf) {
return entry;
}
return buf;
2020-12-14 06:31:28 +08:00
} else if (Array.isArray(entry)) {
if (entry.length < 16) {
for (const item of entry) {
if (buf.equals(item)) {
return item;
}
}
entry.push(buf);
return buf;
}
2024-07-31 04:21:27 +08:00
const newMap = new Map();
const hash = toHash(buf, this._hashFunction);
2024-07-31 04:21:27 +08:00
let found;
for (const item of entry) {
const itemHash = toHash(item, this._hashFunction);
newMap.set(itemHash, item);
if (found === undefined && itemHash === hash) found = item;
2020-12-14 06:31:28 +08:00
}
2024-07-31 04:21:27 +08:00
bufferDedupeMap.set(len, newMap);
if (found === undefined) {
newMap.set(hash, buf);
return buf;
}
return found;
}
const hash = toHash(buf, this._hashFunction);
const item = entry.get(hash);
if (item !== undefined) {
return item;
2020-12-14 06:31:28 +08:00
}
2024-07-31 04:21:27 +08:00
entry.set(hash, buf);
return buf;
2020-12-14 06:31:28 +08:00
};
2018-10-09 20:30:59 +08:00
let currentPosTypeLookup = 0;
let objectTypeLookup = new Map();
const cycleStack = new Set();
2025-03-07 21:12:22 +08:00
/**
2025-08-22 01:45:11 +08:00
* @param {ComplexSerializableType} item item to stack
2025-03-07 21:12:22 +08:00
* @returns {string} stack
*/
const stackToString = (item) => {
2025-07-03 17:06:45 +08:00
const arr = [...cycleStack];
2020-01-28 15:42:49 +08:00
arr.push(item);
return arr
.map((item) => {
if (typeof item === "string") {
if (item.length > 100) {
return `String ${JSON.stringify(item.slice(0, 100)).slice(
0,
-1
)}..."`;
}
return `String ${JSON.stringify(item)}`;
}
2020-01-28 15:42:49 +08:00
try {
const { request, name } = ObjectMiddleware.getSerializerFor(item);
if (request) {
return `${request}${name ? `.${name}` : ""}`;
}
2024-07-31 15:37:05 +08:00
} catch (_err) {
2020-01-28 15:42:49 +08:00
// ignore -> fallback
}
if (typeof item === "object" && item !== null) {
if (item.constructor) {
if (item.constructor === Object) {
return `Object { ${Object.keys(item).join(", ")} }`;
}
if (item.constructor === Map) return `Map { ${item.size} items }`;
if (item.constructor === Array) {
return `Array { ${item.length} items }`;
}
if (item.constructor === Set) return `Set { ${item.size} items }`;
if (item.constructor === RegExp) return item.toString();
return `${item.constructor.name}`;
}
return `Object [null prototype] { ${Object.keys(item).join(
", "
)} }`;
}
2023-05-30 10:18:06 +08:00
if (typeof item === "bigint") {
return `BigInt ${item}n`;
}
try {
return `${item}`;
2024-07-31 15:37:05 +08:00
} catch (err) {
2025-03-07 21:12:22 +08:00
return `(${/** @type {Error} */ (err).message})`;
}
})
.join(" -> ");
};
2024-10-02 05:18:10 +08:00
/** @type {WeakSet<Error>} */
2020-01-28 15:42:49 +08:00
let hasDebugInfoAttached;
2025-03-07 21:12:22 +08:00
/** @type {ObjectSerializerContext} */
let ctx = {
2025-03-07 21:12:22 +08:00
write(value) {
2020-01-28 15:42:49 +08:00
try {
process(value);
2024-07-31 15:37:05 +08:00
} catch (err) {
if (err !== NOT_SERIALIZABLE) {
if (hasDebugInfoAttached === undefined) {
2021-01-21 23:32:49 +08:00
hasDebugInfoAttached = new WeakSet();
}
2024-10-24 11:02:20 +08:00
if (!hasDebugInfoAttached.has(/** @type {Error} */ (err))) {
/** @type {Error} */
(err).message += `\nwhile serializing ${stackToString(value)}`;
hasDebugInfoAttached.add(/** @type {Error} */ (err));
2021-01-21 23:32:49 +08:00
}
2020-01-28 15:42:49 +08:00
}
2024-07-31 15:37:05 +08:00
throw err;
2020-01-28 15:42:49 +08:00
}
},
setCircularReference(ref) {
addReferenceable(ref);
},
snapshot() {
return {
length: result.length,
cycleStackSize: cycleStack.size,
referenceableSize: referenceable.size,
currentPos,
objectTypeLookupSize: objectTypeLookup.size,
currentPosTypeLookup
};
},
rollback(snapshot) {
result.length = snapshot.length;
setSetSize(cycleStack, snapshot.cycleStackSize);
setMapSize(referenceable, snapshot.referenceableSize);
currentPos = snapshot.currentPos;
setMapSize(objectTypeLookup, snapshot.objectTypeLookupSize);
currentPosTypeLookup = snapshot.currentPosTypeLookup;
},
...context
};
this.extendContext(ctx);
2025-03-07 21:12:22 +08:00
/**
2025-08-22 01:45:11 +08:00
* @param {ComplexSerializableType} item item to serialize
2025-03-07 21:12:22 +08:00
*/
const process = (item) => {
2018-10-18 04:16:15 +08:00
if (Buffer.isBuffer(item)) {
2021-03-23 03:28:08 +08:00
// check if we can emit a reference
const ref = referenceable.get(item);
if (ref !== undefined) {
result.push(ESCAPE, ref - currentPos);
return;
}
2020-12-14 06:31:28 +08:00
const alreadyUsedBuffer = dedupeBuffer(item);
if (alreadyUsedBuffer !== item) {
2020-12-15 06:05:40 +08:00
const ref = referenceable.get(alreadyUsedBuffer);
2020-12-14 06:31:28 +08:00
if (ref !== undefined) {
2020-12-15 06:05:40 +08:00
referenceable.set(item, ref);
2020-12-14 06:31:28 +08:00
result.push(ESCAPE, ref - currentPos);
return;
}
2020-12-15 06:05:40 +08:00
item = alreadyUsedBuffer;
2020-12-14 06:31:28 +08:00
}
2018-10-18 04:16:15 +08:00
addReferenceable(item);
2025-08-22 01:45:11 +08:00
result.push(/** @type {Buffer} */ (item));
2021-03-23 03:28:08 +08:00
} else if (item === ESCAPE) {
result.push(ESCAPE, ESCAPE_ESCAPE_VALUE);
} else if (
typeof item === "object"
// We don't have to check for null as ESCAPE is null and this has been checked before
) {
// check if we can emit a reference
const ref = referenceable.get(item);
if (ref !== undefined) {
result.push(ESCAPE, ref - currentPos);
return;
}
if (cycleStack.has(item)) {
throw new Error(
2024-07-31 12:23:44 +08:00
"This is a circular references. To serialize circular references use 'setCircularReference' somewhere in the circle during serialize and deserialize."
);
}
2025-08-22 01:45:11 +08:00
const { request, name, serializer } = ObjectMiddleware.getSerializerFor(
/** @type {Constructor} */
(item)
);
2018-10-09 20:30:59 +08:00
const key = `${request}/${name}`;
const lastIndex = objectTypeLookup.get(key);
2018-10-09 20:30:59 +08:00
if (lastIndex === undefined) {
objectTypeLookup.set(key, currentPosTypeLookup++);
2018-10-09 20:30:59 +08:00
result.push(ESCAPE, request, name);
} else {
2018-10-10 15:55:06 +08:00
result.push(ESCAPE, currentPosTypeLookup - lastIndex);
2018-10-09 20:30:59 +08:00
}
cycleStack.add(item);
2020-01-28 15:42:49 +08:00
try {
serializer.serialize(item, ctx);
} finally {
cycleStack.delete(item);
}
2018-10-09 20:30:59 +08:00
result.push(ESCAPE, ESCAPE_END_OBJECT);
2018-10-09 20:30:59 +08:00
addReferenceable(item);
} else if (typeof item === "string") {
if (item.length > 1) {
// short strings are shorter when not emitting a reference (this saves 1 byte per empty string)
2021-03-23 03:28:08 +08:00
// check if we can emit a reference
const ref = referenceable.get(item);
if (ref !== undefined) {
result.push(ESCAPE, ref - currentPos);
return;
}
2018-10-10 16:24:44 +08:00
addReferenceable(item);
}
if (item.length > 102400 && context.logger) {
context.logger.warn(
`Serializing big strings (${Math.round(
item.length / 1024
2020-01-28 15:42:49 +08:00
)}kiB) impacts deserialization performance (consider using Buffer instead and decode when needed)`
);
}
2018-10-09 20:30:59 +08:00
result.push(item);
} else if (typeof item === "function") {
if (!SerializerMiddleware.isLazy(item)) {
2024-07-31 10:39:30 +08:00
throw new Error(`Unexpected function ${item}`);
}
2025-04-16 22:04:11 +08:00
/** @type {SerializedType | undefined} */
2021-05-11 15:31:46 +08:00
const serializedData =
SerializerMiddleware.getLazySerializedValue(item);
2025-04-16 22:04:11 +08:00
if (serializedData !== undefined) {
if (typeof serializedData === "function") {
result.push(serializedData);
} else {
throw new Error("Not implemented");
}
} else if (SerializerMiddleware.isLazy(item, this)) {
throw new Error("Not implemented");
} else {
2025-08-22 01:45:11 +08:00
const data =
/** @type {() => PrimitiveSerializableType[] | Promise<PrimitiveSerializableType[]>} */
(
SerializerMiddleware.serializeLazy(item, (data) =>
this.serialize([data], context)
)
);
SerializerMiddleware.setLazySerializedValue(item, data);
result.push(data);
}
2018-10-09 20:30:59 +08:00
} else if (item === undefined) {
result.push(ESCAPE, ESCAPE_UNDEFINED);
} else {
result.push(item);
}
};
try {
for (const item of data) {
process(item);
}
return result;
2024-07-31 15:37:05 +08:00
} catch (err) {
if (err === NOT_SERIALIZABLE) return null;
2024-07-31 15:37:05 +08:00
throw err;
} finally {
// Get rid of these references to avoid leaking memory
// This happens because the optimized code v8 generates
// is optimized for our "ctx.write" method so it will reference
// it from e. g. Dependency.prototype.serialize -(IC)-> ctx.write
2021-05-11 15:31:46 +08:00
data =
result =
referenceable =
bufferDedupeMap =
objectTypeLookup =
ctx =
2024-10-24 11:02:20 +08:00
/** @type {EXPECTED_ANY} */
(undefined);
2018-10-09 20:30:59 +08:00
}
}
/**
* @param {SerializedType} data data
2025-03-07 21:12:22 +08:00
* @param {Context} context context object
* @returns {DeserializedType | Promise<DeserializedType>} deserialized data
2018-10-09 20:30:59 +08:00
*/
deserialize(data, context) {
let currentDataPos = 0;
const read = () => {
if (currentDataPos >= data.length) {
2018-10-09 20:30:59 +08:00
throw new Error("Unexpected end of stream");
}
2018-10-09 20:30:59 +08:00
return data[currentDataPos++];
};
if (read() !== CURRENT_VERSION) {
2020-03-13 00:51:26 +08:00
throw new Error("Version mismatch, serializer changed");
}
2018-10-09 20:30:59 +08:00
let currentPos = 0;
2025-04-16 22:04:11 +08:00
/** @type {ReferenceableItem[]} */
2020-12-12 20:33:29 +08:00
let referenceable = [];
2025-03-07 21:12:22 +08:00
/**
2025-08-22 01:45:11 +08:00
* @param {ReferenceableItem} item referenceable item
2025-03-07 21:12:22 +08:00
*/
const addReferenceable = (item) => {
referenceable.push(item);
currentPos++;
2018-10-09 20:30:59 +08:00
};
let currentPosTypeLookup = 0;
2025-03-07 21:12:22 +08:00
/** @type {ObjectSerializer[]} */
2020-12-12 20:33:29 +08:00
let objectTypeLookup = [];
2025-08-22 01:45:11 +08:00
/** @type {ComplexSerializableType[]} */
let result = [];
2025-03-07 21:12:22 +08:00
/** @type {ObjectDeserializerContext} */
let ctx = {
read() {
return decodeValue();
},
setCircularReference(ref) {
addReferenceable(ref);
},
...context
};
this.extendContext(ctx);
2025-08-22 01:45:11 +08:00
/**
* @returns {ComplexSerializableType} deserialize value
*/
2018-10-09 20:30:59 +08:00
const decodeValue = () => {
const item = read();
2018-10-09 20:30:59 +08:00
if (item === ESCAPE) {
const nextItem = read();
2018-10-09 20:30:59 +08:00
if (nextItem === ESCAPE_ESCAPE_VALUE) {
return ESCAPE;
} else if (nextItem === ESCAPE_UNDEFINED) {
2024-08-02 02:36:27 +08:00
// Nothing
2018-10-09 20:30:59 +08:00
} else if (nextItem === ESCAPE_END_OBJECT) {
2018-10-10 15:55:06 +08:00
throw new Error(
`Unexpected end of object at position ${currentDataPos - 1}`
);
2018-10-09 20:30:59 +08:00
} else {
2018-10-10 15:55:06 +08:00
const request = nextItem;
2018-10-09 20:30:59 +08:00
let serializer;
2018-10-10 15:55:06 +08:00
if (typeof request === "number") {
if (request < 0) {
// relative reference
return referenceable[currentPos + request];
}
serializer = objectTypeLookup[currentPosTypeLookup - request];
2018-10-09 20:30:59 +08:00
} else {
if (typeof request !== "string") {
throw new Error(
`Unexpected type (${typeof request}) of request ` +
`at position ${currentDataPos - 1}`
);
}
2024-10-02 05:18:10 +08:00
const name = /** @type {string} */ (read());
serializer = ObjectMiddleware._getDeserializerForWithoutError(
request,
name
);
if (serializer === undefined) {
if (request && !loadedRequests.has(request)) {
let loaded = false;
for (const [regExp, loader] of loaders) {
2024-08-02 02:36:27 +08:00
if (regExp.test(request) && loader(request)) {
loaded = true;
break;
}
}
if (!loaded) {
require(request);
}
loadedRequests.add(request);
}
serializer = ObjectMiddleware.getDeserializerFor(request, name);
2018-10-09 20:30:59 +08:00
}
objectTypeLookup.push(serializer);
currentPosTypeLookup++;
2018-10-09 20:30:59 +08:00
}
try {
const item = serializer.deserialize(ctx);
const end1 = read();
if (end1 !== ESCAPE) {
throw new Error("Expected end of object");
}
const end2 = read();
if (end2 !== ESCAPE_END_OBJECT) {
throw new Error("Expected end of object");
}
addReferenceable(item);
return item;
} catch (err) {
// As this is only for error handling, we omit creating a Map for
// faster access to this information, as this would affect performance
// in the good case
let serializerEntry;
for (const entry of serializers) {
if (entry[1].serializer === serializer) {
serializerEntry = entry;
break;
}
}
const name = !serializerEntry
? "unknown"
: !serializerEntry[1].request
2025-08-22 01:45:11 +08:00
? /** @type {Constructor[]} */ (serializerEntry)[0].name
2024-07-31 05:43:19 +08:00
: serializerEntry[1].name
? `${serializerEntry[1].request} ${serializerEntry[1].name}`
: serializerEntry[1].request;
2024-10-24 11:02:20 +08:00
/** @type {Error} */
(err).message += `\n(during deserialization of ${name})`;
throw err;
}
2018-10-09 20:30:59 +08:00
}
} else if (typeof item === "string") {
if (item.length > 1) {
2018-10-10 16:24:44 +08:00
addReferenceable(item);
}
2018-10-09 20:30:59 +08:00
return item;
} else if (Buffer.isBuffer(item)) {
addReferenceable(item);
2018-10-09 20:30:59 +08:00
return item;
} else if (typeof item === "function") {
return SerializerMiddleware.deserializeLazy(
2025-04-16 22:04:11 +08:00
item,
(data) =>
2025-03-11 08:28:01 +08:00
/** @type {[DeserializedType]} */
(this.deserialize(data, context))[0]
);
2018-10-09 20:30:59 +08:00
} else {
return item;
}
};
try {
while (currentDataPos < data.length) {
result.push(decodeValue());
}
return result;
} finally {
// Get rid of these references to avoid leaking memory
// This happens because the optimized code v8 generates
// is optimized for our "ctx.read" method so it will reference
// it from e. g. Dependency.prototype.deserialize -(IC)-> ctx.read
2024-10-24 11:02:20 +08:00
result =
referenceable =
data =
objectTypeLookup =
ctx =
/** @type {EXPECTED_ANY} */
(undefined);
2018-10-09 20:30:59 +08:00
}
}
}
module.exports = ObjectMiddleware;
2019-01-19 18:47:19 +08:00
module.exports.NOT_SERIALIZABLE = NOT_SERIALIZABLE;