feat: expose workflow console api and RPC service with @effect/rpc
- Replace manual JSON-RPC protocol handling with @effect/rpc typed RPCs - Add evidence capture layer (per-call Ref, response body buffering/reconstruction) - Add service module with typed dispatch and layer composition via Layer.mergeAll - Add Hono API with /api/health, /api/connect, /api/rpc routes - Add browser DTO contracts, error mapping, body size limits - Add 13 Hono route tests and 12 target-policy tests passing - Delete old protocol.ts and protocol.test.ts (replaced by rpcs.ts/service.ts)
This commit is contained in:
@@ -0,0 +1,240 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { createApp, type RunOperation } from "./app.js";
|
||||
import type { OperationExchange } from "@lda/workflow-rpc";
|
||||
|
||||
const makeExchange = (
|
||||
overrides: Partial<OperationExchange> = {},
|
||||
): OperationExchange => ({
|
||||
operation: "workflow.health",
|
||||
label: "Health check",
|
||||
interpreted: { status: "ok", store_root: "/tmp/store" },
|
||||
exchange: { request: {}, response: { status: "ok" } },
|
||||
equivalentCli: "uv run wf status",
|
||||
durationMs: 12,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
const okRunner: RunOperation = vi.fn(async (operation) =>
|
||||
makeExchange({ operation }),
|
||||
);
|
||||
|
||||
const failRunner =
|
||||
(code: string, message: string): RunOperation =>
|
||||
async () => {
|
||||
throw Object.assign(new Error(message), { _tag: code });
|
||||
};
|
||||
|
||||
const app = createApp({ runOperation: okRunner });
|
||||
|
||||
describe("GET /api/health", () => {
|
||||
it("returns 200 with ok status", async () => {
|
||||
const res = await app.request("/api/health");
|
||||
expect(res.status).toBe(200);
|
||||
const body = await res.json();
|
||||
expect(body).toEqual({ ok: true, status: "ok" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("POST /api/connect", () => {
|
||||
it("calls workflow.health and returns connected DTO", async () => {
|
||||
const res = await app.request("/api/connect", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ target: "http://127.0.0.1:8000/rpc" }),
|
||||
});
|
||||
expect(res.status).toBe(200);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(true);
|
||||
expect(body.connection.status).toBe("connected");
|
||||
expect(body.connection.target).toBe("http://127.0.0.1:8000/rpc");
|
||||
expect(body.connection.serverStatus).toBe("ok");
|
||||
expect(okRunner).toHaveBeenCalledWith(
|
||||
"workflow.health",
|
||||
"http://127.0.0.1:8000/rpc",
|
||||
{},
|
||||
);
|
||||
});
|
||||
|
||||
it("returns 400 when target is missing", async () => {
|
||||
const res = await app.request("/api/connect", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({}),
|
||||
});
|
||||
expect(res.status).toBe(400);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("invalid_target");
|
||||
});
|
||||
});
|
||||
|
||||
describe("POST /api/rpc", () => {
|
||||
it("invokes the requested operation", async () => {
|
||||
const res = await app.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.sources.list",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
params: { limit: 10 },
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(200);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(true);
|
||||
expect(body.operation).toBe("workflow.sources.list");
|
||||
});
|
||||
|
||||
it("returns 400 for unknown operation", async () => {
|
||||
const res = await app.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "foo.bar",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(400);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("unknown_operation");
|
||||
});
|
||||
|
||||
it("returns 400 for invalid JSON body", async () => {
|
||||
const res = await app.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: "not json",
|
||||
});
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe("POST body size limit", () => {
|
||||
it("returns 413 when body exceeds 256 KiB", async () => {
|
||||
const bigBody = JSON.stringify({ data: "x".repeat(257 * 1024) });
|
||||
const res = await app.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: bigBody,
|
||||
});
|
||||
expect(res.status).toBe(413);
|
||||
});
|
||||
});
|
||||
|
||||
describe("error mapping", () => {
|
||||
it("maps upstream timeout to 504", async () => {
|
||||
const timeoutApp = createApp({
|
||||
runOperation: failRunner("UpstreamTimeoutError", "timed out"),
|
||||
});
|
||||
const res = await timeoutApp.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(504);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("upstream_timeout");
|
||||
expect(body.error.stack).toBeUndefined();
|
||||
});
|
||||
|
||||
it("maps upstream connection error to 502", async () => {
|
||||
const connApp = createApp({
|
||||
runOperation: failRunner("UpstreamConnectionError", "connection refused"),
|
||||
});
|
||||
const res = await connApp.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(502);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("upstream_unreachable");
|
||||
expect(body.error.stack).toBeUndefined();
|
||||
});
|
||||
|
||||
it("maps RpcRemoteError to 502 with rpc_remote_error", async () => {
|
||||
const remoteApp = createApp({
|
||||
runOperation: failRunner("RpcRemoteError", "method not found"),
|
||||
});
|
||||
const res = await remoteApp.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(502);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("rpc_remote_error");
|
||||
expect(body.error.stack).toBeUndefined();
|
||||
});
|
||||
|
||||
it("maps InvalidTargetError to 400", async () => {
|
||||
const invalidApp = createApp({
|
||||
runOperation: failRunner("InvalidTargetError", "bad target"),
|
||||
});
|
||||
const res = await invalidApp.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "not-a-url",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(400);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("invalid_target");
|
||||
expect(body.error.stack).toBeUndefined();
|
||||
});
|
||||
|
||||
it("maps UnknownOperationError to 400", async () => {
|
||||
const unknownApp = createApp({
|
||||
runOperation: failRunner("UnknownOperationError", "no such op"),
|
||||
});
|
||||
const res = await unknownApp.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
expect(res.status).toBe(400);
|
||||
const body = await res.json();
|
||||
expect(body.ok).toBe(false);
|
||||
expect(body.error.code).toBe("unknown_operation");
|
||||
});
|
||||
|
||||
it("never includes stack in error DTOs", async () => {
|
||||
const apps = [
|
||||
createApp({ runOperation: failRunner("UpstreamTimeoutError", "t") }),
|
||||
createApp({ runOperation: failRunner("UpstreamConnectionError", "c") }),
|
||||
createApp({ runOperation: failRunner("RpcRemoteError", "r") }),
|
||||
createApp({ runOperation: failRunner("InvalidTargetError", "i") }),
|
||||
];
|
||||
for (const a of apps) {
|
||||
const res = await a.request("/api/rpc", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
operation: "workflow.health",
|
||||
target: "http://127.0.0.1:8000/rpc",
|
||||
}),
|
||||
});
|
||||
const body = await res.json();
|
||||
expect(body.error?.stack).toBeUndefined();
|
||||
}
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user