Allow passing journal value codec provider, rather than built codec directly. (#582)

Author: slinkydeveloper

packages/restate-sdk/src/endpoint.ts

@@ -84,11 +84,12 @@ export interface RestateEndpointBase<E> {
   setLogger(logger: LoggerTransport): E;
 
   /**
-   * Codec to use for journal values. Check {@link JournalValueCodec} for more details
+   * Provider for the codec to use for journal values. One codec will be instantiated globally for this endpoint.
+   * Check {@link JournalValueCodec} for more details
    *
    * @experimental
    */
-  journalValueCodec(codec: JournalValueCodec): E;
+  journalValueCodecProvider(codecProvider: () => Promise<JournalValueCodec>): E;
 }
 
 /**

packages/restate-sdk/src/endpoint/endpoint.ts

@@ -85,9 +85,9 @@ export type Endpoint = {
   discoveryMetadata: Omit<discovery.Endpoint, "protocolMode">;
 
   /**
-   * Default codec for journal entries.
+   * Codec provider to use for journal values.
    */
-  journalValueCodec?: JournalValueCodec;
+  journalValueCodec?: Promise<JournalValueCodec>;
 };
 
 export class EndpointBuilder {
@@ -100,7 +100,7 @@ export class EndpointBuilder {
   private loggerTransport: LoggerTransport = defaultLoggerTransport;
   private keySet: string[] = [];
   private defaultServiceOptions: DefaultServiceOptions = {};
-  private journalValueCodec?: JournalValueCodec;
+  private journalValueCodecProvider?: () => Promise<JournalValueCodec>;
 
   public bind<P extends string, M>(
     definition:
@@ -128,8 +128,10 @@ export class EndpointBuilder {
     this.loggerTransport = newLogger;
   }
 
-  public setJournalValueCodec(codec: JournalValueCodec) {
-    this.journalValueCodec = codec;
+  public setJournalValueCodecProvider(
+    codecProvider: () => Promise<JournalValueCodec>
+  ) {
+    this.journalValueCodecProvider = codecProvider;
   }
 
   public build(): Endpoint {
@@ -196,7 +198,9 @@ export class EndpointBuilder {
       rlog,
       components,
       discoveryMetadata,
-      journalValueCodec: this.journalValueCodec,
+      journalValueCodec: this.journalValueCodecProvider
+        ? this.journalValueCodecProvider()
+        : undefined,
     };
   }
 }

packages/restate-sdk/src/endpoint/fetch_endpoint.ts

@@ -90,8 +90,10 @@ export class FetchEndpointImpl implements FetchEndpoint {
     return this;
   }
 
-  public journalValueCodec(codec: JournalValueCodec): FetchEndpoint {
-    this.builder.setJournalValueCodec(codec);
+  public journalValueCodecProvider(
+    codecProvider: () => Promise<JournalValueCodec>
+  ): FetchEndpoint {
+    this.builder.setJournalValueCodecProvider(codecProvider);
     return this;
   }
 

packages/restate-sdk/src/endpoint/handlers/generic.ts

@@ -37,7 +37,10 @@ import {
   LogSource,
   RestateLogLevel,
 } from "../../logging/logger_transport.js";
-import { millisOrDurationToMillis } from "@restatedev/restate-sdk-core";
+import {
+  type JournalValueCodec,
+  millisOrDurationToMillis,
+} from "@restatedev/restate-sdk-core";
 import type { Endpoint } from "../endpoint.js";
 
 export interface Headers {
@@ -236,10 +239,12 @@ export class GenericHandler implements RestateHandler {
     abortSignal: AbortSignal,
     additionalContext: AdditionalContext
   ): Promise<RestateResponse> {
-    const journalValueCodec = this.endpoint.journalValueCodec ?? {
-      encode: (entry) => entry,
-      decode: (entry) => Promise.resolve(entry),
-    };
+    const journalValueCodec: JournalValueCodec = this.endpoint.journalValueCodec
+      ? await this.endpoint.journalValueCodec
+      : {
+          encode: (entry) => entry,
+          decode: (entry) => Promise.resolve(entry),
+        };
     const loggerId = Math.floor(Math.random() * 4_294_967_295 /* u32::MAX */);
 
     try {

packages/restate-sdk/src/endpoint/lambda_endpoint.ts

@@ -71,8 +71,10 @@ export class LambdaEndpointImpl implements LambdaEndpoint {
     return this;
   }
 
-  journalValueCodec(codec: JournalValueCodec): LambdaEndpoint {
-    this.builder.setJournalValueCodec(codec);
+  public journalValueCodecProvider(
+    codecProvider: () => Promise<JournalValueCodec>
+  ): LambdaEndpoint {
+    this.builder.setJournalValueCodecProvider(codecProvider);
     return this;
   }
 

packages/restate-sdk/src/endpoint/node_endpoint.ts

@@ -61,8 +61,10 @@ export class NodeEndpoint implements RestateEndpoint {
     return this;
   }
 
-  public journalValueCodec(codec: JournalValueCodec): RestateEndpoint {
-    this.builder.setJournalValueCodec(codec);
+  public journalValueCodecProvider(
+    codecProvider: () => Promise<JournalValueCodec>
+  ): RestateEndpoint {
+    this.builder.setJournalValueCodecProvider(codecProvider);
     return this;
   }
 

packages/restate-sdk/src/endpoint/types.ts

@@ -58,9 +58,10 @@ export interface EndpointOptions {
   logger?: LoggerTransport;
 
   /**
-   * Codec to use for journal values. Check {@link JournalValueCodec} for more details
+   * Provider for the codec to use for journal values. One codec will be instantiated globally for this endpoint.
+   * Check {@link JournalValueCodec} for more details
    *
    * @experimental
    */
-  journalValueCodec?: JournalValueCodec;
+  journalValueCodecProvider?: () => Promise<JournalValueCodec>;
 }

packages/restate-sdk/src/endpoint/withOptions.ts

@@ -8,7 +8,7 @@ export function withOptions<E extends RestateEndpointBase<E>>(
     defaultServiceOptions,
     logger,
     services,
-    journalValueCodec,
+    journalValueCodecProvider,
   }: EndpointOptions
 ): E {
   let endpointWithOptions = endpoint;
@@ -20,9 +20,10 @@ export function withOptions<E extends RestateEndpointBase<E>>(
       defaultServiceOptions
     );
   }
-  if (journalValueCodec) {
-    endpointWithOptions =
-      endpointWithOptions.journalValueCodec(journalValueCodec);
+  if (journalValueCodecProvider) {
+    endpointWithOptions = endpointWithOptions.journalValueCodecProvider(
+      journalValueCodecProvider
+    );
   }
   if (logger) {
     endpointWithOptions = endpointWithOptions.setLogger(logger);