@iworkflow/temporal 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,10 @@
-# Temporary Holding Version
+# @iworkflow/temporal
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Temporal для `@iworkflow/core`. Peer: `@temporalio/{client,worker,workflow,activity}` ^1.24.
+
+- `temporalRuntime(workflowsPath).start(def)` — воркер на task queue `def.app`.
+- `temporalClient()` — старт, сигнал, query по id.
+- `@iworkflow/temporal/workflow` — только для входа песочницы модуля:
+  `export const outreach = temporalFlow(flows.outreach, ["send-twice"])`.
+
+Переменные: `TEMPORAL_URL` (по умолчанию `127.0.0.1:17233`), `TEMPORAL_NAMESPACE`.

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@iworkflow/temporal",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Temporal adapter for @iworkflow/core",
+  "keywords": [
+    "workflow",
+    "temporal"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iconicompany/iworkflow.git",
+    "directory": "packages/temporal"
+  },
+  "files": [
+    "src"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/index.ts",
+    "./workflow": "./src/workflow.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "type-check": "tsc --noEmit -p tsconfig.json",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "@iworkflow/core": "^0.2.0"
+  },
+  "peerDependencies": {
+    "@temporalio/activity": "^1.24.0",
+    "@temporalio/client": "^1.24.0",
+    "@temporalio/common": "^1.24.0",
+    "@temporalio/worker": "^1.24.0",
+    "@temporalio/workflow": "^1.24.0"
+  },
+  "devDependencies": {
+    "@temporalio/activity": "^1.24.0",
+    "@temporalio/client": "^1.24.0",
+    "@temporalio/common": "^1.24.0",
+    "@temporalio/worker": "^1.24.0",
+    "@temporalio/workflow": "^1.24.0"
+  }
+}

package/src/failure.ts

@@ -0,0 +1,48 @@
+// Отказы Temporal ↔ ошибки порта. Общее для песочницы и клиента: только @temporalio/common.
+import {
+  ActivityFailure,
+  ApplicationFailure,
+  ChildWorkflowFailure,
+  TerminatedFailure,
+  TimeoutFailure,
+  WorkflowExecutionAlreadyStartedError,
+} from "@temporalio/common";
+import { Failure, FlowError, isFlowError } from "@iworkflow/core";
+
+/** Отказ шага, дочернего процесса или процесса целиком — FlowError; прочее (отмена) — как есть. */
+export function fromTemporal(e: unknown): unknown {
+  if (e instanceof WorkflowExecutionAlreadyStartedError)
+    return new FlowError(`процесс ${e.workflowId} уже есть`, { reason: "already-started" });
+  if (e instanceof ActivityFailure) {
+    const exhausted = e.retryState === "MAXIMUM_ATTEMPTS_REACHED";
+    const f = cause(e.cause, exhausted);
+    // Срок шага целиком (scheduleToClose) Temporal отдаёт последней ошибкой попытки, а не TimeoutFailure.
+    if (f && e.retryState === "TIMEOUT") return new FlowError(f.message, { reason: "timeout", type: f.type, details: f.details });
+    return f ?? e;
+  }
+  if (e instanceof ChildWorkflowFailure) return cause(e.cause, false) ?? e;
+  return e;
+}
+
+/** Причина отказа процесса или шага — FlowError; undefined — причина не наша (отмена и т. п.). */
+export function cause(c: Error | undefined, exhausted = false): FlowError | undefined {
+  if (c instanceof TimeoutFailure) return new FlowError(c.message || "срок вышел", { reason: "timeout", exhausted });
+  if (c instanceof TerminatedFailure) return new FlowError(c.message || "процесс прерван", { reason: "terminated" });
+  if (c instanceof ApplicationFailure)
+    return new FlowError(c.message, { reason: "failed", type: c.type ?? undefined, details: c.details?.[0], exhausted });
+  return undefined;
+}
+
+/** Отказ из кода порта — ApplicationFailure: обычная ошибка в песочнице не роняет процесс, а повторяет задачу. */
+export function toTemporal(e: unknown, nonRetryable: boolean): unknown {
+  if (e instanceof Failure)
+    return ApplicationFailure.create({
+      message: e.message,
+      type: e.type,
+      details: [e.details],
+      nonRetryable: nonRetryable || e.nonRetryable,
+    });
+  if (isFlowError(e))
+    return ApplicationFailure.create({ message: e.message, type: e.type ?? e.reason, details: [e.details], nonRetryable });
+  return e;
+}

package/src/index.ts

@@ -0,0 +1,122 @@
+// Temporal: воркер на очереди модуля (task queue = имя модуля), клиент — по имени процесса.
+import { Client, Connection, WorkflowFailedError, WorkflowNotFoundError, type WorkflowHandle } from "@temporalio/client";
+import { Context } from "@temporalio/activity";
+import { NativeConnection, Worker } from "@temporalio/worker";
+import {
+  bindStepRuntime,
+  FlowError,
+  type Activity,
+  type AppDefinition,
+  type EngineClient,
+  type EngineRuntime,
+  type FlowHandle,
+  type FlowStatus,
+} from "@iworkflow/core";
+import { cause, toTemporal } from "./failure";
+
+// Те же имена, что в workflow.ts: его нельзя импортировать вне песочницы.
+const SIGNAL = "iwf.signal";
+const QUERY = "iwf.query";
+const poolQueue = (app: string, pool: string) => `${app}@${pool}`;
+
+const STATUS: Record<string, FlowStatus> = {
+  RUNNING: "running",
+  COMPLETED: "completed",
+  FAILED: "failed",
+  CANCELLED: "terminated",
+  TERMINATED: "terminated",
+  TIMED_OUT: "timed-out",
+  CONTINUED_AS_NEW: "running",
+};
+
+const notFound = (id: string) => (e: unknown): never => {
+  if (e instanceof WorkflowNotFoundError) throw new FlowError(`процесса ${id} нет`, { reason: "not-found" });
+  throw e;
+};
+
+const wrap = <T>(h: WorkflowHandle): FlowHandle<T> => ({
+  id: h.workflowId,
+  result: () =>
+    h.result().catch((e) => {
+      throw (e instanceof WorkflowFailedError && cause(e.cause)) || e;
+    }),
+  signal: (topic, value) => h.signal(SIGNAL, { topic, value }),
+  query: async <V>(key: string) => ((await h.query(QUERY, key)) ?? undefined) as V | undefined,
+  async describe() {
+    const d = await h.describe().catch(notFound(h.workflowId));
+    return { id: h.workflowId, status: STATUS[d.status.name] ?? "running", startedAt: d.startTime };
+  },
+  terminate: async (reason) => void (await h.terminate(reason).catch(notFound(h.workflowId))),
+});
+
+const address = () => process.env.TEMPORAL_URL ?? "127.0.0.1:17233";
+const namespace = () => process.env.TEMPORAL_NAMESPACE ?? "default";
+
+/** Шаги отдают Failure как ApplicationFailure: тип, детали и nonRetryable доезжают до процесса. */
+const withFailures = (activities: Record<string, Activity>) =>
+  Object.fromEntries(
+    Object.entries(activities).map(([name, fn]) => [
+      name,
+      async (...args: unknown[]) => {
+        try {
+          return await fn(...args);
+        } catch (e) {
+          throw toTemporal(e, false);
+        }
+      },
+    ]),
+  );
+
+/** workflowsPath — вход песочницы модуля: temporalFlow(...) на каждый процесс, имя экспорта = имя процесса. */
+export function temporalRuntime(workflowsPath: string): EngineRuntime {
+  let workers: Worker[] = [];
+  let running: Promise<void>[] = [];
+  let conn: NativeConnection | undefined;
+  return {
+    async start(def: AppDefinition) {
+      bindStepRuntime({
+        heartbeat: async (details) => Context.current().heartbeat(details),
+        lastHeartbeat: async () => Context.current().info.heartbeatDetails,
+      });
+      conn = await NativeConnection.connect({ address: address() });
+      const activities = withFailures(def.activities);
+      const base = { connection: conn, namespace: namespace() };
+      workers = [await Worker.create({ ...base, taskQueue: def.app, workflowsPath, activities })];
+      // Пул — своя очередь с пределом одновременных шагов в этом процессе.
+      for (const [pool, limit] of Object.entries(def.pools ?? {}))
+        workers.push(
+          await Worker.create({
+            ...base,
+            taskQueue: poolQueue(def.app, pool),
+            activities,
+            maxConcurrentActivityTaskExecutions: limit,
+          }),
+        );
+      running = workers.map((w) => w.run());
+    },
+    async stop() {
+      for (const w of workers) w.shutdown();
+      await Promise.all(running);
+      await conn?.close();
+    },
+  };
+}
+
+export async function temporalClient(): Promise<EngineClient> {
+  const connection = await Connection.connect({ address: address() });
+  const client = new Client({ connection, namespace: namespace() });
+  return {
+    async start(target, args, opts) {
+      const h = await client.workflow.start(target.flow, {
+        taskQueue: target.app,
+        workflowId: opts.id,
+        args,
+        workflowIdConflictPolicy: "USE_EXISTING",
+        ...(opts.timeoutMs ? { workflowExecutionTimeout: opts.timeoutMs } : {}),
+      });
+      return wrap(h);
+    },
+    handle: (id) => wrap(client.workflow.getHandle(id)),
+    close: () => connection.close(),
+  };
+}

package/src/workflow.ts

@@ -0,0 +1,124 @@
+// Обёртка процесса для песочницы Temporal: FlowContext поверх proxyActivities и executeChild.
+// Сигналы и query — по одному обработчику на всё: тема и ключ едут в данных.
+// Импортируется только из входа песочницы модуля: `@iworkflow/temporal/workflow`.
+import {
+  condition,
+  defineQuery,
+  defineSignal,
+  deprecatePatch,
+  executeChild,
+  getExternalWorkflowHandle,
+  ParentClosePolicy,
+  patched,
+  proxyActivities,
+  setHandler,
+  sleep,
+  startChild,
+  TemporalFailure,
+  workflowInfo,
+} from "@temporalio/workflow";
+
+import { FlowError, type ChildOptions, type Flow, type FlowContext, type StepOptions } from "@iworkflow/core";
+import { fromTemporal, toTemporal } from "./failure";
+
+export const SIGNAL = "iwf.signal";
+export const QUERY = "iwf.query";
+const signalDef = defineSignal<[{ topic: string; value: unknown }]>(SIGNAL);
+const queryDef = defineQuery<unknown, [string]>(QUERY);
+
+/** Очередь пула шагов модуля; воркер пула поднимает temporalRuntime. */
+export const poolQueue = (app: string, pool: string) => `${app}@${pool}`;
+
+const proxies = new Map<string, Record<string, (...a: unknown[]) => Promise<unknown>>>();
+
+function activitiesWith(opts: StepOptions = {}) {
+  const key = JSON.stringify(opts);
+  let p = proxies.get(key);
+  if (!p) {
+    p = proxyActivities({
+      ...(opts.pool ? { taskQueue: poolQueue(workflowInfo().taskQueue, opts.pool) } : {}),
+      startToCloseTimeout: opts.timeoutMs ?? 60_000,
+      ...(opts.totalTimeoutMs ? { scheduleToCloseTimeout: opts.totalTimeoutMs } : {}),
+      ...(opts.heartbeatTimeoutMs ? { heartbeatTimeout: opts.heartbeatTimeoutMs } : {}),
+      retry: {
+        maximumAttempts: opts.attempts ?? 3,
+        initialInterval: opts.retryIntervalMs ?? 200,
+        backoffCoefficient: opts.backoff ?? 1,
+        ...(opts.maxRetryIntervalMs ? { maximumInterval: opts.maxRetryIntervalMs } : {}),
+        ...(opts.nonRetryableTypes ? { nonRetryableErrorTypes: opts.nonRetryableTypes } : {}),
+      },
+    });
+    proxies.set(key, p);
+  }
+  return p;
+}
+
+const childOptions = (app: string, args: unknown[], opts: ChildOptions) => ({
+  taskQueue: app,
+  workflowId: opts.id,
+  args,
+  ...(opts.timeoutMs ? { workflowExecutionTimeout: opts.timeoutMs } : {}),
+  ...(opts.onExisting === "reject" ? { workflowIdReusePolicy: "REJECT_DUPLICATE" as const } : {}),
+});
+
+const rethrow = (e: unknown): never => {
+  throw fromTemporal(e);
+};
+
+/** patches — как AppDefinition.patches: необъявленный id — ошибка, как у DBOS. */
+export function temporalFlow(flow: Flow, patches: string[] = []) {
+  return async (...args: unknown[]) => {
+    // Буфер по темам: сигнал до recv ждёт в очереди, как в DBOS.
+    const inbox = new Map<string, unknown[]>();
+    const state = new Map<string, unknown>();
+    setHandler(signalDef, ({ topic, value }) => {
+      const q = inbox.get(topic) ?? [];
+      q.push(value);
+      inbox.set(topic, q);
+    });
+    setHandler(queryDef, (key) => state.get(key));
+
+    const info = workflowInfo();
+    const ctx: FlowContext = {
+      workflowId: info.workflowId,
+      parentId: info.parent?.workflowId,
+      startedAt: info.startTime,
+      step: (name, stepArgs, opts) => activitiesWith(opts)[name]!(...stepArgs).catch(rethrow) as Promise<never>,
+      child: (target, childArgs, opts) =>
+        executeChild(target.flow, childOptions(target.app, childArgs, opts)).catch(rethrow) as Promise<never>,
+      async startChild(target, childArgs, opts) {
+        // REJECT_DUPLICATE: завершённый id тоже занят — как у DBOS, где id не переиспользуется.
+        const h = await startChild(target.flow, {
+          ...childOptions(target.app, childArgs, { ...opts, onExisting: "reject" }),
+          parentClosePolicy: ParentClosePolicy.ABANDON,
+        }).catch(rethrow);
+        return { id: opts.id, result: () => h.result().catch(rethrow) as Promise<never> };
+      },
+      sleep: (ms) => sleep(ms),
+      async recv<T>(topic: string, timeoutMs: number) {
+        const ready = await condition(() => (inbox.get(topic)?.length ?? 0) > 0, timeoutMs);
+        return ready ? (inbox.get(topic)!.shift() as T) : null;
+      },
+      signal: (workflowId, topic, value) =>
+        getExternalWorkflowHandle(workflowId)
+          .signal(signalDef, { topic, value })
+          .catch((e) => {
+            if (!(e instanceof TemporalFailure)) throw e;
+            throw new FlowError(`процесса ${workflowId} нет или он завершён`, { reason: "not-found" });
+          }),
+      async setState(key, value) {
+        state.set(key, value);
+      },
+      patched: async (id) => {
+        if (!patches.includes(id)) throw new Error(`патч "${id}" не объявлен в patches процесса`);
+        return patched(id);
+      },
+      deprecatePatch: async (id) => deprecatePatch(id),
+    };
+    try {
+      return await flow(ctx, ...args);
+    } catch (e) {
+      throw toTemporal(e, true);
+    }
+  };
+}