Add custom serialize and deserialize options to both thread seria…

…lization implementations
lemonmade · Aug 26, 2024 · f2463ec · f2463ec
1 parent b5ca2bd
commit f2463ec
Show file tree

Hide file tree

Showing 5 changed files with 130 additions and 4 deletions.
diff --git a/.changeset/seven-baboons-fetch.md b/.changeset/seven-baboons-fetch.md
@@ -0,0 +1,5 @@
+---
+'@quilted/threads': minor
+---
+
+Add custom `serialize` and `deserialize` options to both thread serialization implementations
diff --git a/packages/threads/source/Thread.ts b/packages/threads/source/Thread.ts
@@ -78,6 +78,34 @@ export interface ThreadFunctions {
   deserialize(id: string, thread: AnyThread): AnyFunction;
 }
 
+/**
+ * Options to customize the creation of a `ThreadSerialization` instance.
+ */
+export interface ThreadSerializationOptions {
+  /**
+   * A custom function to run when serializing values. If this function returns `undefined`,
+   * the default serialization will be used. You can also call the second argument to this function
+   * to apply the default serialization to subsets of the value.
+   */
+  serialize?(
+    value: object,
+    defaultSerialize: (value: unknown) => unknown,
+    thread: AnyThread,
+    transferable?: any[],
+  ): any | undefined;
+
+  /**
+   * A custom function to run when deserializing values. If this function returns `undefined`,
+   * the default deserialization will be used. You can also call the second argument to this function
+   * to apply the default deserialization to subsets of the value.
+   */
+  deserialize?(
+    value: object,
+    defaultDeserialize: (value: unknown) => unknown,
+    thread: AnyThread,
+  ): any | undefined;
+}
+
 /**
  * Options to customize the creation of a `Thread` instance.
  */

diff --git a/packages/threads/source/index.ts b/packages/threads/source/index.ts
@@ -28,6 +28,7 @@ export {
   type ThreadFunctions,
   type ThreadSerialization,
   type ThreadMessageMap,
+  type ThreadSerializationOptions,
 } from './Thread.ts';
 export {ThreadBroadcastChannel} from './threads/ThreadBroadcastChannel.ts';
 export {ThreadBrowserWebSocket} from './threads/ThreadBrowserWebSocket.ts';

diff --git a/packages/threads/source/serialization/ThreadSerializationJSON.ts b/packages/threads/source/serialization/ThreadSerializationJSON.ts
@@ -1,5 +1,9 @@
 import type {ThreadSerializable} from '../types.ts';
-import type {AnyThread, ThreadSerialization} from '../Thread.ts';
+import type {
+  AnyThread,
+  ThreadSerialization,
+  ThreadSerializationOptions,
+} from '../Thread.ts';
 import {SERIALIZE_METHOD, TRANSFERABLE} from '../constants.ts';
 
 import {isBasicObject, isIterator} from './shared.ts';
@@ -29,6 +33,14 @@ const UINT32_ARRAY = '_@u32';
  * - `Uint8Array`
  */
 export class ThreadSerializationJSON implements ThreadSerialization {
+  readonly #customSerializer?: ThreadSerializationOptions['serialize'];
+  readonly #customDeserializer?: ThreadSerializationOptions['deserialize'];
+
+  constructor(options?: ThreadSerializationOptions) {
+    this.#customSerializer = options?.serialize;
+    this.#customDeserializer = options?.deserialize;
+  }
+
   /**
    * Serializes a value into a JSON-compatible format that can be transferred between threads.
    */
@@ -41,6 +53,7 @@ export class ThreadSerializationJSON implements ThreadSerialization {
     thread: AnyThread,
     transferable?: any[],
     seen = new Map<unknown, unknown>(),
+    isApplyingDefault = false,
   ): any {
     if (value == null) return value;
 
@@ -50,6 +63,21 @@ export class ThreadSerializationJSON implements ThreadSerialization {
     seen.set(value, undefined);
 
     if (typeof value === 'object') {
+      if (this.#customSerializer && !isApplyingDefault) {
+        const customValue = this.#customSerializer(
+          value,
+          (value) =>
+            this.#serializeInternal(value, thread, transferable, seen, true),
+          thread,
+          transferable,
+        );
+
+        if (customValue !== undefined) {
+          seen.set(value, customValue);
+          return customValue;
+        }
+      }
+
       if ((value as any)[TRANSFERABLE]) {
         transferable?.push(value as any);
         seen.set(value, value);
@@ -188,8 +216,26 @@ export class ThreadSerializationJSON implements ThreadSerialization {
     return this.#deserializeInternal(value, thread);
   }
 
-  #deserializeInternal(value: unknown, thread: AnyThread): any {
+  #deserializeInternal(
+    value: unknown,
+    thread: AnyThread,
+    isApplyingDefault = false,
+  ): any {
+    if (value == null) return value;
+
     if (typeof value === 'object') {
+      if (this.#customDeserializer && !isApplyingDefault) {
+        const customValue = this.#customDeserializer(
+          value,
+          (value) => this.#deserializeInternal(value, thread, true),
+          thread,
+        );
+
+        if (customValue !== undefined) {
+          return customValue;
+        }
+      }
+
       if (value == null) {
         return value as any;
       }

diff --git a/packages/threads/source/serialization/ThreadSerializationStructuredClone.ts b/packages/threads/source/serialization/ThreadSerializationStructuredClone.ts
@@ -1,5 +1,9 @@
 import type {ThreadSerializable} from '../types.ts';
-import type {AnyThread, ThreadSerialization} from '../Thread.ts';
+import type {
+  AnyThread,
+  ThreadSerialization,
+  ThreadSerializationOptions,
+} from '../Thread.ts';
 import {SERIALIZE_METHOD, TRANSFERABLE} from '../constants.ts';
 
 import {isBasicObject, isIterator} from './shared.ts';
@@ -18,6 +22,14 @@ const ASYNC_ITERATOR = '_@i';
  * memory management system by setting the `garbageCollection: 'weak-ref'` option.
  */
 export class ThreadSerializationStructuredClone implements ThreadSerialization {
+  readonly #customSerializer?: ThreadSerializationOptions['serialize'];
+  readonly #customDeserializer?: ThreadSerializationOptions['deserialize'];
+
+  constructor(options?: ThreadSerializationOptions) {
+    this.#customSerializer = options?.serialize;
+    this.#customDeserializer = options?.deserialize;
+  }
+
   /**
    * Serializes a value into a structured cloning-compatible format that can be transferred between threads.
    */
@@ -30,6 +42,7 @@ export class ThreadSerializationStructuredClone implements ThreadSerialization {
     thread: AnyThread,
     transferable?: any[],
     seen = new Map<unknown, unknown>(),
+    isApplyingDefault = false,
   ): any {
     if (value == null) return value;
 
@@ -39,6 +52,21 @@ export class ThreadSerializationStructuredClone implements ThreadSerialization {
     seen.set(value, undefined);
 
     if (typeof value === 'object') {
+      if (this.#customSerializer && !isApplyingDefault) {
+        const customValue = this.#customSerializer(
+          value,
+          (value) =>
+            this.#serializeInternal(value, thread, transferable, seen, true),
+          thread,
+          transferable,
+        );
+
+        if (customValue !== undefined) {
+          seen.set(value, customValue);
+          return customValue;
+        }
+      }
+
       if ((value as any)[TRANSFERABLE]) {
         transferable?.push(value as any);
         seen.set(value, value);
@@ -129,8 +157,26 @@ export class ThreadSerializationStructuredClone implements ThreadSerialization {
     return this.#deserializeInternal(value, thread);
   }
 
-  #deserializeInternal(value: unknown, thread: AnyThread): any {
+  #deserializeInternal(
+    value: unknown,
+    thread: AnyThread,
+    isApplyingDefault = false,
+  ): any {
+    if (value == null) return value;
+
     if (typeof value === 'object') {
+      if (this.#customDeserializer && !isApplyingDefault) {
+        const customValue = this.#customDeserializer(
+          value,
+          (value) => this.#deserializeInternal(value, thread, true),
+          thread,
+        );
+
+        if (customValue !== undefined) {
+          return customValue;
+        }
+      }
+
       if (value == null) {
         return value as any;
       }