Remove getOutput

Author: igalshilman

packages/restate-sdk/src/common_api.ts

@@ -22,7 +22,7 @@ export type {
   InvocationHandle,
   InvocationPromise,
 } from "./context.js";
-export { CombineablePromise } from "./context.js";
+export { InvocationIdParser, CombineablePromise } from "./context.js";
 
 export type { Serde } from "@restatedev/restate-sdk-core";
 export { serde } from "@restatedev/restate-sdk-core";

packages/restate-sdk/src/context.ts

@@ -554,19 +554,16 @@ export interface Context extends RestateContext {
    */
   cancel(invocationId: InvocationId): void;
 
-  /**
-   * Get the output of an invocation
-   *
-   * @param invocationId the invocation id to get the output for
-   */
-  getOutput<T>(invocationId: InvocationId): CombineablePromise<T>;
-
   /**
    * Attach to an invocation
    *
    * @param invocationId the invocation id to attach to
+   * @param serde the serde to use for the result, default to JSON serde.
    */
-  attach<T>(invocationId: InvocationId): CombineablePromise<T>;
+  attach<T>(
+    invocationId: InvocationId,
+    serde?: Serde<T>
+  ): CombineablePromise<T>;
 }
 
 /**
@@ -654,8 +651,27 @@ export type CombineablePromise<T> = Promise<T> & {
   orTimeout(millis: number): CombineablePromise<T>;
 };
 
+/**
+ * Represents an invocation id.
+ * @see {@link InvocationIdParser}
+ */
 export type InvocationId = string & { __brand: "InvocationId" };
 
+export const InvocationIdParser = {
+  /**
+   * Creates an invocation id from a string.
+   * @param id the string to use as invocation id.
+   */
+  fromString(id: string): InvocationId {
+    if (!id.startsWith("inv")) {
+      throw new Error(
+        `Expected invocation id to start with 'inv' but got ${id}`
+      );
+    }
+    return id as InvocationId;
+  },
+};
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export type InvocationHandle = {
   invocationId(): Promise<InvocationId>;

packages/restate-sdk/src/context_impl.ts

@@ -141,13 +141,6 @@ export class ContextImpl implements ObjectContext, WorkflowContext {
     );
   }
 
-  getOutput<T>(invocationId: InvocationId): CombineablePromise<T> {
-    return this.processCompletableEntry(
-      (vm) => vm.sys_get_invocation_output(invocationId),
-      completeUsing(SuccessWithSerde(defaultSerde()), Failure)
-    );
-  }
-
   public get key(): string {
     switch (this.handlerKind) {
       case HandlerKind.EXCLUSIVE:

packages/restate-sdk/src/endpoint/handlers/vm/sdk_shared_core_wasm_bindings.d.ts

@@ -17,34 +17,45 @@ export enum LogLevel {
   ERROR = 4,
 }
 export interface WasmFailure {
-    code: number;
-    message: string;
+  code: number;
+  message: string;
 }
 
 export interface WasmExponentialRetryConfig {
-    initial_interval: number | undefined;
-    factor: number;
-    max_interval: number | undefined;
-    max_attempts: number | undefined;
-    max_duration: number | undefined;
+  initial_interval: number | undefined;
+  factor: number;
+  max_interval: number | undefined;
+  max_attempts: number | undefined;
+  max_duration: number | undefined;
 }
 
 export interface WasmAwakeable {
-    id: string;
-    handle: number;
+  id: string;
+  handle: number;
 }
 
-export type WasmAsyncResultValue = "NotReady" | "Empty" | { Success: Uint8Array } | { Failure: WasmFailure } | { StateKeys: string[] } | { InvocationId: string };
+export type WasmAsyncResultValue =
+  | "NotReady"
+  | "Empty"
+  | { Success: Uint8Array }
+  | { Failure: WasmFailure }
+  | { StateKeys: string[] }
+  | { InvocationId: string };
 
-export type WasmDoProgressResult = "AnyCompleted" | "ReadFromInput" | "WaitingPendingRun" | { ExecuteRun: number } | "CancelSignalReceived";
+export type WasmDoProgressResult =
+  | "AnyCompleted"
+  | "ReadFromInput"
+  | "WaitingPendingRun"
+  | { ExecuteRun: number }
+  | "CancelSignalReceived";
 
 export interface WasmCallHandle {
-    invocation_id_completion_id: number;
-    call_completion_id: number;
+  invocation_id_completion_id: number;
+  call_completion_id: number;
 }
 
 export interface WasmSendHandle {
-    invocation_id_completion_id: number;
+  invocation_id_completion_id: number;
 }
 
 export class WasmHeader {
@@ -93,8 +104,21 @@ export class WasmVM {
   sys_sleep(millis: bigint): number;
   sys_attach_invocation(invocation_id: string): number;
   sys_get_invocation_output(invocation_id: string): number;
-  sys_call(service: string, handler: string, buffer: Uint8Array, key: string | null | undefined, headers: WasmHeader[]): WasmCallHandle;
-  sys_send(service: string, handler: string, buffer: Uint8Array, key: string | null | undefined, headers: WasmHeader[], delay?: bigint | null): WasmSendHandle;
+  sys_call(
+    service: string,
+    handler: string,
+    buffer: Uint8Array,
+    key: string | null | undefined,
+    headers: WasmHeader[]
+  ): WasmCallHandle;
+  sys_send(
+    service: string,
+    handler: string,
+    buffer: Uint8Array,
+    key: string | null | undefined,
+    headers: WasmHeader[],
+    delay?: bigint | null
+  ): WasmSendHandle;
   sys_awakeable(): WasmAwakeable;
   sys_complete_awakeable_success(id: string, buffer: Uint8Array): void;
   sys_complete_awakeable_failure(id: string, value: WasmFailure): void;
@@ -105,11 +129,16 @@ export class WasmVM {
   sys_run(name: string): number;
   propose_run_completion_success(handle: number, buffer: Uint8Array): void;
   propose_run_completion_failure(handle: number, value: WasmFailure): void;
-  propose_run_completion_failure_transient(handle: number, error_message: string, error_stacktrace: string | null | undefined, attempt_duration: bigint, config: WasmExponentialRetryConfig): void;
+  propose_run_completion_failure_transient(
+    handle: number,
+    error_message: string,
+    error_stacktrace: string | null | undefined,
+    attempt_duration: bigint,
+    config: WasmExponentialRetryConfig
+  ): void;
   sys_cancel_invocation(target_invocation_id: string): void;
   sys_write_output_success(buffer: Uint8Array): void;
   sys_write_output_failure(value: WasmFailure): void;
   sys_end(): void;
   is_processing(): boolean;
 }
-