effect-cf 0.29.0 → 0.31.0

package/src/Vitest.ts

@@ -1,5 +1,5 @@
 /**
- * Effect-native helpers for tests running in Cloudflare's Vitest Workers pool.
+ * Effect-native helpers for tests running in Cloudflare's Workers Vitest plugin.
  *
  * Import this module through the `effect-cf/vitest` subpath. It is intended to
  * run inside the Workers test runtime, where `cloudflare:test` is available.
@@ -37,7 +37,7 @@ import type { WorkflowInstanceStatusName } from "./WorkflowBinding";
 const currentEnv: WorkerEnv = env;
 
 /**
- * Provides the Workers pool environment as both {@link WorkerEnvironment} and
+ * Provides the Workers test environment as both {@link WorkerEnvironment} and
  * the active Effect `ConfigProvider`.
  */
 export const layer: Layer.Layer<WorkerEnvironment> = Layer.mergeAll(
@@ -134,7 +134,7 @@ type PagesEventContextInitData<Context> =
       : { readonly data: Data }
     : never;
 
-/** Initialization accepted by Pool Workers for a Pages Function. */
+/** Initialization accepted by the Workers Vitest plugin for a Pages Function. */
 export type PagesEventContextInit<Function extends AnyPagesFunction> = PagesEventContextInitBase &
   PagesEventContextInitParams<Parameters<Function>[0]> &
   PagesEventContextInitData<Parameters<Function>[0]>;
@@ -162,14 +162,14 @@ interface QueueWorker {
   queue(batch: globalThis.MessageBatch): Promise<void>;
 }
 
-/** Input message accepted by Pool Workers' `createMessageBatch` helper. */
+/** Input message accepted by the Workers Vitest plugin's `createMessageBatch` helper. */
 export type QueueMessage<Body> = {
   readonly id: string;
   readonly timestamp: Date;
   readonly attempts: number;
 } & ({ readonly body: Body } | { readonly serializedBody: ArrayBuffer | ArrayBufferView });
 
-/** Acknowledgement and retry result returned by Pool Workers. */
+/** Acknowledgement and retry result returned by the Workers Vitest plugin. */
 export type QueueResult = Awaited<ReturnType<typeof getQueueResult>>;
 
 /** Result of invoking a queue consumer through {@link queue}. */
@@ -180,7 +180,7 @@ export interface QueueRunResult<Body> {
 
 /**
  * Invokes an Effect-backed queue consumer, drains its `waitUntil` work, and
- * returns Pool Workers' acknowledgement and retry result.
+ * returns the Workers Vitest plugin's acknowledgement and retry result.
  */
 export const queue = Effect.fn("effect-cf/vitest/queue")(function* <
   Body,
@@ -280,7 +280,7 @@ export const evictAllDurableObjects = Effect.fn("effect-cf/vitest/evictAllDurabl
   },
 );
 
-/** A D1 migration accepted by Pool Workers. */
+/** A D1 migration accepted by the Workers Vitest plugin. */
 export interface D1Migration {
   readonly name: string;
   readonly queries: ReadonlyArray<string>;
@@ -310,7 +310,7 @@ export interface SecretsStoreSecret {
   readonly metadata?: { readonly uuid: string };
 }
 
-/** Effect-native wrapper around Pool Workers' Secrets Store admin API. */
+/** Effect-native wrapper around the Workers Vitest plugin's Secrets Store admin API. */
 export interface SecretsStoreAdmin {
   readonly raw: NativeSecretsStoreAdmin;
   readonly create: (value: string) => Effect.Effect<string>;
@@ -445,7 +445,7 @@ const runWorkflowModifier = Effect.fnUntraced(function* <A, E, R>(
     }
 
     if (callbackExit === undefined) {
-      throw new Error("Pool Workers did not invoke the Workflow modifier callback");
+      throw new Error("The Workers Vitest plugin did not invoke the Workflow modifier callback");
     }
 
     return callbackExit;

package/src/Worker.ts

@@ -46,6 +46,8 @@ export interface WorkerContextService {
     options?: Omit<WorkerContextWaitUntilOptions<E, R2>, "mode">,
   ): Effect.Effect<void, never, R | R2>;
   readonly passThroughOnException: Effect.Effect<void>;
+  /** Abort the current stateless Worker invocation (`ExecutionContext.abort`). */
+  abort(reason?: string): Effect.Effect<void>;
 }
 
 /**

package/src/WorkflowBinding.ts

@@ -3,7 +3,9 @@ import type {
   Workflow as CloudflareWorkflow,
   WorkflowInstance as CloudflareWorkflowInstance,
   WorkflowInstanceCreateOptions as CloudflareWorkflowInstanceCreateOptions,
+  WorkflowInstanceLocationHint as CloudflareWorkflowInstanceLocationHint,
   WorkflowInstanceRestartOptions as CloudflareWorkflowInstanceRestartOptions,
+  WorkflowInstanceTerminateOptions as CloudflareWorkflowInstanceTerminateOptions,
 } from "@cloudflare/workers-types";
 import { type Context, Data, Effect, Option, Predicate, Schema as S } from "effect";
 
@@ -23,6 +25,8 @@ export type WorkflowInstanceCreateBatchOptions<Payload, EncodedPayload = unknown
 >;
 
 export type WorkflowInstanceRestartOptions = CloudflareWorkflowInstanceRestartOptions;
+export type WorkflowInstanceTerminateOptions = CloudflareWorkflowInstanceTerminateOptions;
+export type WorkflowInstanceLocationHint = CloudflareWorkflowInstanceLocationHint;
 
 export type WorkflowInstanceStatusName = CloudflareInstanceStatus["status"];
 
@@ -40,10 +44,13 @@ export interface WorkflowInstance<Result> {
   readonly id: string;
   readonly pause: Effect.Effect<void, WorkflowOperationError>;
   readonly resume: Effect.Effect<void, WorkflowOperationError>;
-  readonly terminate: Effect.Effect<void, WorkflowOperationError>;
+  readonly terminate: (
+    options?: WorkflowInstanceTerminateOptions,
+  ) => Effect.Effect<void, WorkflowOperationError>;
   readonly restart: (
     options?: WorkflowInstanceRestartOptions,
   ) => Effect.Effect<void, WorkflowOperationError>;
+  readonly delete: Effect.Effect<void, WorkflowOperationError>;
   readonly status: Effect.Effect<
     WorkflowInstanceStatus<Result>,
     WorkflowOperationError | WorkflowResultDecodeError
@@ -165,8 +172,9 @@ export const makeClient = <
       id: raw.id,
       pause: operation("pause", () => raw.pause()),
       resume: operation("resume", () => raw.resume()),
-      terminate: operation("terminate", () => raw.terminate()),
+      terminate: (options) => operation("terminate", () => raw.terminate(options)),
       restart: (options) => operation("restart", () => raw.restart(options)),
+      delete: operation("delete", () => raw.delete()),
       status: operation("status", () => raw.status()).pipe(
         Effect.flatMap((status) =>
           Effect.gen(function* () {

package/src/internal/WorkerContext.ts

@@ -101,5 +101,6 @@ export const fromExecutionContext = (
       options?: Omit<WorkerContextWaitUntilOptions<E, R2>, "mode">,
     ) => schedule(effect, options, "propagate"),
     passThroughOnException: Effect.sync(() => ctx.passThroughOnException()),
+    abort: (reason?: string) => Effect.sync(() => ctx.abort(reason)),
   };
 };