Skip to content

Commit

Permalink
refactor for less duplication
Browse files Browse the repository at this point in the history
  • Loading branch information
@oberhamsi
oberhamsi committed Jun 5, 2024
1 parent 1374644 commit 7fd8cab
Showing 1 changed file with 103 additions and 125 deletions.
228 changes: 103 additions & 125 deletions src/util/web_worker_transfer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ type Registry = {
klass: {
new (...args: any): any;
deserialize?: (input: Serialized) => unknown;
serialize?: (input: any, transferables: Transferable[]) => SerializedObject;
};
omit: ReadonlyArray<string>;
shallow: ReadonlyArray<string>;
Expand Down Expand Up @@ -91,20 +92,43 @@ function isArrayBuffer(value: any): value is ArrayBuffer {
(value instanceof ArrayBuffer || (value.constructor && value.constructor.name === 'ArrayBuffer'));
}

function getClassRegistryKey(input: Object|SerializedObject) {
const klass = (input.constructor as any);
return (input as SerializedObject).$name || klass._classRegistryKey;
}

function isRegistered(input: unknown) {
if (input === null || typeof input !== 'object') {
return false;
}
const klass = (input.constructor as any);
if (klass._classRegistryKey && klass._classRegistryKey !== 'Object') {
return true;
}
if ((input as SerializedObject).$name) {
const classRegistryKey = getClassRegistryKey(input);
if (classRegistryKey && classRegistryKey !== 'Object') {
return true;
}
return false;
}

function isSerializeHandledByBuiltin(input: unknown) {
return (!isRegistered(input) && (
input === null ||
input === undefined ||
typeof input === 'boolean' ||
typeof input === 'number' ||
typeof input === 'string' ||
input instanceof Boolean ||
input instanceof Number ||
input instanceof String ||
input instanceof Date ||
input instanceof RegExp ||
input instanceof Blob ||
input instanceof Error ||
isArrayBuffer(input) ||
isImageBitmap(input) ||
ArrayBuffer.isView(input) ||
input instanceof ImageData)
);
}

/**
* Serialize the given object for transfer to or from a web worker.
*
Expand All @@ -118,48 +142,22 @@ function isRegistered(input: unknown) {
* this should happen in the client code, before using serialize().)
*/
export function serialize(input: unknown, transferables?: Array<Transferable> | null): Serialized {
if (!isRegistered(input) && (
input === null ||
input === undefined ||
typeof input === 'boolean' ||
typeof input === 'number' ||
typeof input === 'string' ||
input instanceof Boolean ||
input instanceof Number ||
input instanceof String ||
input instanceof Date ||
input instanceof RegExp ||
input instanceof Blob ||
input instanceof Error)
) {
return input;
}

if (isArrayBuffer(input)) {
if (transferables) {
transferables.push(input);
}
return input;
}

if (isImageBitmap(input)) {
if (transferables) {
transferables.push(input);
if (isSerializeHandledByBuiltin(input)) {
if (isArrayBuffer(input) || isImageBitmap(input)) {
if (transferables) {
transferables.push(input);
}
}
return input;
}

if (ArrayBuffer.isView(input)) {
const view = input;
if (transferables) {
transferables.push(view.buffer);
if (ArrayBuffer.isView(input)) {
const view = input;
if (transferables) {
transferables.push(view.buffer);
}
}
return view;
}

if (input instanceof ImageData) {
if (transferables) {
transferables.push(input.data.buffer);
if (input instanceof ImageData) {
if (transferables) {
transferables.push(input.data.buffer);
}
}
return input;
}
Expand All @@ -172,105 +170,85 @@ export function serialize(input: unknown, transferables?: Array<Transferable> |
return serialized;
}

if (typeof input === 'object') {
const klass = (input.constructor as any);
const name = klass._classRegistryKey;
if (!name) {
throw new Error(`can't serialize object of unregistered class ${klass.name}`);
}
if (!registry[name]) throw new Error(`${name} is not registered.`);

const properties: SerializedObject = klass.serialize ?
// (Temporary workaround) allow a class to provide static
// `serialize()` and `deserialize()` methods to bypass the generic
// approach.
// This temporary workaround lets us use the generic serialization
// approach for objects whose members include instances of dynamic
// StructArray types. Once we refactor StructArray to be static,
// we can remove this complexity.
(klass.serialize(input, transferables) as SerializedObject) : {};

if (!klass.serialize) {
for (const key in input) {
if (!input.hasOwnProperty(key)) continue; // eslint-disable-line no-prototype-builtins
if (registry[name].omit.indexOf(key) >= 0) continue;
const property = input[key];
properties[key] = registry[name].shallow.indexOf(key) >= 0 ?
property :
serialize(property, transferables);
}
if (input instanceof Error) {
properties.message = input.message;
}
} else {
if (transferables && properties === transferables[transferables.length - 1]) {
throw new Error('statically serialized object won\'t survive transfer of $name property');
}
if (typeof input !== 'object') {
throw new Error(`can't serialize object of type ${typeof input}`);
}
const classRegistryKey = getClassRegistryKey(input);
if (!classRegistryKey) {
throw new Error(`can't serialize object of unregistered class ${input.constructor.name}`);
}
if (!registry[classRegistryKey]) throw new Error(`${classRegistryKey} is not registered.`);
const {klass} = registry[classRegistryKey];
const properties: SerializedObject = klass.serialize ?
// (Temporary workaround) allow a class to provide static
// `serialize()` and `deserialize()` methods to bypass the generic
// approach.
// This temporary workaround lets us use the generic serialization
// approach for objects whose members include instances of dynamic
// StructArray types. Once we refactor StructArray to be static,
// we can remove this complexity.
(klass.serialize(input, transferables) as SerializedObject) : {};

if (!klass.serialize) {
for (const key in input) {
if (!input.hasOwnProperty(key)) continue; // eslint-disable-line no-prototype-builtins
if (registry[classRegistryKey].omit.indexOf(key) >= 0) continue;
const property = input[key];
properties[key] = registry[classRegistryKey].shallow.indexOf(key) >= 0 ?
property :
serialize(property, transferables);
}

if (properties.$name) {
throw new Error('$name property is reserved for worker serialization logic.');
if (input instanceof Error) {
properties.message = input.message;
}
if (name !== 'Object') {
properties.$name = name;
} else {
if (transferables && properties === transferables[transferables.length - 1]) {
throw new Error('statically serialized object won\'t survive transfer of $name property');
}
}

return properties;
if (properties.$name) {
throw new Error('$name property is reserved for worker serialization logic.');
}
if (classRegistryKey !== 'Object') {
properties.$name = classRegistryKey;
}

throw new Error(`can't serialize object of type ${typeof input}`);
return properties;
}

export function deserialize(input: Serialized): unknown {
if (!isRegistered(input) && (
input === null ||
input === undefined ||
typeof input === 'boolean' ||
typeof input === 'number' ||
typeof input === 'string' ||
input instanceof Boolean ||
input instanceof Number ||
input instanceof String ||
input instanceof Date ||
input instanceof RegExp ||
input instanceof Blob ||
isArrayBuffer(input) ||
isImageBitmap(input) ||
ArrayBuffer.isView(input) ||
input instanceof ImageData ||
input instanceof Error
)) {
if (isSerializeHandledByBuiltin(input)) {
return input;
}

if (Array.isArray(input)) {
return input.map(deserialize);
}

if (typeof input === 'object') {
const name = (<SerializedObject>input).$name || 'Object';
if (!registry[name]) {
throw new Error(`can't deserialize unregistered class ${name}`);
}
const {klass} = registry[name];
if (!klass) {
throw new Error(`can't deserialize unregistered class ${name}`);
}

if (klass.deserialize) {
return klass.deserialize(input);
}
if (typeof input !== 'object') {
throw new Error(`can't deserialize object of type ${typeof input}`);
}
const classRegistryKey = getClassRegistryKey(input) || 'Object';
if (!registry[classRegistryKey]) {
throw new Error(`can't deserialize unregistered class ${classRegistryKey}`);
}
const {klass} = registry[classRegistryKey];
if (!klass) {
throw new Error(`can't deserialize unregistered class ${classRegistryKey}`);
}

const result = Object.create(klass.prototype);
if (klass.deserialize) {
return klass.deserialize(input);
}

for (const key of Object.keys(input)) {
if (key === '$name') continue;
const value = (input as SerializedObject)[key];
result[key] = registry[name].shallow.indexOf(key) >= 0 ? value : deserialize(value);
}
const result = Object.create(klass.prototype);

return result;
for (const key of Object.keys(input)) {
if (key === '$name') continue;
const value = (input as SerializedObject)[key];
result[key] = registry[classRegistryKey].shallow.indexOf(key) >= 0 ? value : deserialize(value);
}

throw new Error(`can't deserialize object of type ${typeof input}`);
return result;
}

0 comments on commit 7fd8cab

Please sign in to comment.