feat: add create actor input

Author: NathanFlurry

packages/actor-core-cli/src/commands/deploy.tsx

@@ -336,6 +336,43 @@ export const deploy = new Command()
 									export default createActorHandler({ app });
 								`,
 								);
+								//console.log('Hello world');
+								//export default {
+								//	async start() {
+								//		console.log('Start');
+								//		await new Promise(resolve => {})
+								//	}
+								//};
+//								yield fs.writeFile(
+//									entrypoint,
+//									dedent`
+//console.log(Deno.env.toObject());
+//
+//export default {
+//	async start(ctx) {
+//		let server = Deno.serve({
+//			handler,
+//			port: 80,
+//		});
+//
+//		await server.finished;
+//	},
+//};
+//
+//function handler(req) {
+//	console.log("req", req);
+//
+//	let url = new URL(req.url);
+//
+//	if (url.pathname == "/exit") Deno.exit(parseInt(req.body));
+//
+//	return new Response(req.body, {
+//		status: 200,
+//		headers: { "Content-Type": "application/json" },
+//	});
+//}
+//								`,
+//								);
 
 								const buildTags = {
 									role: "actor",

packages/actor-core/fixtures/driver-test-suite/action-inputs.ts

@@ -0,0 +1,35 @@
+import { actor, setup } from "actor-core";
+
+interface State {
+	initialInput?: unknown;
+	onCreateInput?: unknown;
+}
+
+// Test actor that can capture input during creation
+const inputActor = actor({
+	createState: (c, { input }): State => {
+		return {
+			initialInput: input,
+			onCreateInput: undefined,
+		};
+	},
+
+	onCreate: (c, { input }) => {
+		c.state.onCreateInput = input;
+	},
+
+	actions: {
+		getInputs: (c) => {
+			return {
+				initialInput: c.state.initialInput,
+				onCreateInput: c.state.onCreateInput,
+			};
+		},
+	},
+});
+
+export const app = setup({
+	actors: { inputActor },
+});
+
+export type App = typeof app;

packages/actor-core/src/actor/config.ts

@@ -74,6 +74,14 @@ export const ActorConfigSchema = z
 		},
 	);
 
+export interface OnCreateOptions {
+	input?: unknown;
+}
+
+export interface CreateStateOptions {
+	input?: unknown;
+}
+
 export interface OnConnectOptions<CP> {
 	/**
 	 * The request object associated with the connection.
@@ -92,6 +100,7 @@ type CreateState<S, CP, CS, V> =
 	| {
 			createState: (
 				c: ActorContext<undefined, undefined, undefined, undefined>,
+				opts: CreateStateOptions,
 			) => S | Promise<S>;
 	  }
 	| Record<never, never>;
@@ -149,7 +158,10 @@ interface BaseActorConfig<S, CP, CS, V, R extends Actions<S, CP, CS, V>> {
 	 * Use this hook to initialize your actor's state.
 	 * This is called before any other lifecycle hooks.
 	 */
-	onCreate?: (c: ActorContext<S, CP, CS, V>) => void | Promise<void>;
+	onCreate?: (
+		c: ActorContext<S, CP, CS, V>,
+		opts: OnCreateOptions,
+	) => void | Promise<void>;
 
 	/**
 	 * Called when the actor is started and ready to receive connections and action.

packages/actor-core/src/actor/driver.ts

@@ -9,6 +9,8 @@ export interface ActorDriver {
 	//load(): Promise<LoadOutput>;
 	getContext(actorId: string): unknown;
 
+	readInput(actorId: string): Promise<unknown | undefined>;
+
 	readPersistedData(actorId: string): Promise<unknown | undefined>;
 	writePersistedData(actorId: string, unknown: unknown): Promise<void>;
 

packages/actor-core/src/actor/instance.ts

@@ -498,9 +498,7 @@ export class ActorInstance<S, CP, CS, V> {
 		} else {
 			logger().info("actor creating");
 
-			if (this.#config.onCreate) {
-				await this.#config.onCreate(this.actorContext);
-			}
+			const input = await this.#actorDriver.readInput(this.#actorId);
 
 			// Initialize actor state
 			let stateData: unknown = undefined;
@@ -518,6 +516,7 @@ export class ActorInstance<S, CP, CS, V> {
 							undefined,
 							undefined
 						>,
+						{ input },
 					);
 				} else if ("state" in this.#config) {
 					stateData = structuredClone(this.#config.state);
@@ -539,6 +538,11 @@ export class ActorInstance<S, CP, CS, V> {
 			await this.#actorDriver.writePersistedData(this.#actorId, persist);
 
 			this.#setPersist(persist);
+
+			// Notify creation
+			if (this.#config.onCreate) {
+				await this.#config.onCreate(this.actorContext, { input });
+			}
 		}
 	}
 
@@ -846,7 +850,7 @@ export class ActorInstance<S, CP, CS, V> {
 
 		// Prevent calling private or reserved methods
 		if (!(actionName in this.#config.actions)) {
-			logger().warn("action does not exist", {  actionName });
+			logger().warn("action does not exist", { actionName });
 			throw new errors.ActionNotFound();
 		}
 

packages/actor-core/src/client/client.ts

@@ -41,7 +41,10 @@ export interface ActorAccessor<AD extends AnyActorDefinition> {
 	 * @param {GetOptions} [opts] - Options for getting the actor.
 	 * @returns {ActorHandle<AD>} - A handle to the actor.
 	 */
-	getOrCreate(key?: string | string[], opts?: GetOptions): ActorHandle<AD>;
+	getOrCreate(
+		key?: string | string[],
+		opts?: GetOrCreateOptions,
+	): ActorHandle<AD>;
 
 	/**
 	 * Gets a stateless handle to an actor by its ID.
@@ -63,7 +66,7 @@ export interface ActorAccessor<AD extends AnyActorDefinition> {
 	 * @returns {Promise<ActorHandle<AD>>} - A promise that resolves to a handle to the actor.
 	 */
 	create(
-		key: string | string[],
+		key?: string | string[],
 		opts?: CreateOptions,
 	): Promise<ActorHandle<AD>>;
 }
@@ -104,9 +107,11 @@ export interface GetOptions extends QueryOptions {}
  * @typedef {QueryOptions} GetOrCreateOptions
  * @property {string} [createInRegion] - Region to create the actor in if it doesn't exist.
  */
-export interface GetOptions extends QueryOptions {
+export interface GetOrCreateOptions extends QueryOptions {
 	/** Region to create the actor in if it doesn't exist. */
 	createInRegion?: string;
+	/** Input data to pass to the actor. */
+	createWithInput?: unknown;
 }
 
 /**
@@ -117,6 +122,8 @@ export interface GetOptions extends QueryOptions {
 export interface CreateOptions extends QueryOptions {
 	/** The region to create the actor in. */
 	region?: string;
+	/** Input data to pass to the actor. */
+	input?: unknown;
 }
 
 /**
@@ -258,7 +265,7 @@ export class ClientRaw {
 	getOrCreate<AD extends AnyActorDefinition>(
 		name: string,
 		key?: string | string[],
-		opts?: GetOptions,
+		opts?: GetOrCreateOptions,
 	): ActorHandle<AD> {
 		// Convert string to array of strings
 		const keyArray: string[] = typeof key === "string" ? [key] : key || [];
@@ -274,6 +281,7 @@ export class ClientRaw {
 			getOrCreateForKey: {
 				name,
 				key: keyArray,
+				input: opts?.createWithInput,
 				region: opts?.createInRegion,
 			},
 		};
@@ -299,31 +307,29 @@ export class ClientRaw {
 	 */
 	async create<AD extends AnyActorDefinition>(
 		name: string,
-		key: string | string[],
-		opts: CreateOptions = {},
+		key?: string | string[],
+		opts?: CreateOptions,
 	): Promise<ActorHandle<AD>> {
 		// Convert string to array of strings
-		const keyArray: string[] = typeof key === "string" ? [key] : key;
+		const keyArray: string[] = typeof key === "string" ? [key] : key || [];
 
-		// Build create config
-		const create = {
-			...opts,
-			// Do these last to override `opts`
-			name,
-			key: keyArray,
-		};
+		const createQuery = {
+			create: {
+				...opts,
+				// Do these last to override `opts`
+				name,
+				key: keyArray,
+			},
+		} satisfies ActorQuery;
 
 		logger().debug("create actor handle", {
 			name,
 			key: keyArray,
 			parameters: opts?.params,
-			create,
+			create: createQuery.create,
 		});
 
 		// Create the actor
-		const createQuery = {
-			create,
-		} satisfies ActorQuery;
 		const actorId = await resolveActorId(
 			this.#managerEndpoint,
 			createQuery,

packages/actor-core/src/driver-test-suite/test-apps.ts

@@ -10,6 +10,7 @@ export type { App as VarsApp } from "../../fixtures/driver-test-suite/vars";
 export type { App as ConnStateApp } from "../../fixtures/driver-test-suite/conn-state";
 export type { App as MetadataApp } from "../../fixtures/driver-test-suite/metadata";
 export type { App as ErrorHandlingApp } from "../../fixtures/driver-test-suite/error-handling";
+export type { App as ActionInputsApp } from "../../fixtures/driver-test-suite/action-inputs";
 
 export const COUNTER_APP_PATH = resolve(
 	__dirname,
@@ -50,4 +51,8 @@ export const METADATA_APP_PATH = resolve(
 export const ERROR_HANDLING_APP_PATH = resolve(
 	__dirname,
 	"../../fixtures/driver-test-suite/error-handling.ts",
+);
+export const ACTION_INPUTS_APP_PATH = resolve(
+	__dirname,
+	"../../fixtures/driver-test-suite/action-inputs.ts",
 );

packages/actor-core/src/driver-test-suite/tests/manager-driver.ts

@@ -1,7 +1,12 @@
 import { describe, test, expect, vi } from "vitest";
 import { setupDriverTest } from "../utils";
 import { ActorError } from "@/client/mod";
-import { COUNTER_APP_PATH, type CounterApp } from "../test-apps";
+import {
+	COUNTER_APP_PATH,
+	ACTION_INPUTS_APP_PATH,
+	type CounterApp,
+	type ActionInputsApp,
+} from "../test-apps";
 import { DriverTestConfig } from "../mod";
 
 export function runManagerDriverTests(driverTestConfig: DriverTestConfig) {
@@ -135,6 +140,96 @@ export function runManagerDriverTests(driverTestConfig: DriverTestConfig) {
 				expect(count).toBe(10);
 			});
 
+			test("passes input to actor during creation", async (c) => {
+				const { client } = await setupDriverTest<ActionInputsApp>(
+					c,
+					driverTestConfig,
+					ACTION_INPUTS_APP_PATH,
+				);
+
+				// Test data to pass as input
+				const testInput = {
+					name: "test-actor",
+					value: 42,
+					nested: { foo: "bar" },
+				};
+
+				// Create actor with input
+				const actor = await client.inputActor.create(undefined, {
+					input: testInput,
+				});
+
+				// Verify both createState and onCreate received the input
+				const inputs = await actor.getInputs();
+
+				// Input should be available in createState
+				expect(inputs.initialInput).toEqual(testInput);
+
+				// Input should also be available in onCreate lifecycle hook
+				expect(inputs.onCreateInput).toEqual(testInput);
+			});
+
+			test("input is undefined when not provided", async (c) => {
+				const { client } = await setupDriverTest<ActionInputsApp>(
+					c,
+					driverTestConfig,
+					ACTION_INPUTS_APP_PATH,
+				);
+
+				// Create actor without providing input
+				const actor = await client.inputActor.create();
+
+				// Get inputs and verify they're undefined
+				const inputs = await actor.getInputs();
+
+				// Should be undefined in createState
+				expect(inputs.initialInput).toBeUndefined();
+
+				// Should be undefined in onCreate lifecycle hook too
+				expect(inputs.onCreateInput).toBeUndefined();
+			});
+
+			test("getOrCreate passes input to actor during creation", async (c) => {
+				const { client } = await setupDriverTest<ActionInputsApp>(
+					c,
+					driverTestConfig,
+					ACTION_INPUTS_APP_PATH,
+				);
+
+				// Create a unique key for this test
+				const uniqueKey = [`input-test-${crypto.randomUUID()}`];
+
+				// Test data to pass as input
+				const testInput = {
+					name: "getorcreate-test",
+					value: 100,
+					nested: { baz: "qux" },
+				};
+
+				// Use getOrCreate with input
+				const actor = client.inputActor.getOrCreate(uniqueKey, {
+					createWithInput: testInput,
+				});
+
+				// Verify both createState and onCreate received the input
+				const inputs = await actor.getInputs();
+
+				// Input should be available in createState
+				expect(inputs.initialInput).toEqual(testInput);
+
+				// Input should also be available in onCreate lifecycle hook
+				expect(inputs.onCreateInput).toEqual(testInput);
+
+				// Verify that calling getOrCreate again with the same key
+				// returns the existing actor and doesn't create a new one
+				const existingActor = client.inputActor.getOrCreate(uniqueKey);
+				const existingInputs = await existingActor.getInputs();
+
+				// Should still have the original inputs
+				expect(existingInputs.initialInput).toEqual(testInput);
+				expect(existingInputs.onCreateInput).toEqual(testInput);
+			});
+
 			// TODO: Correctly test region for each provider
 			//test("creates and retrieves actors with region", async (c) => {
 			//	const { client } = await setupDriverTest<CounterApp>(c,