@effect-agent/sandbox-local 0.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,20 @@
1
+ import { Sandbox, SandboxImplementation } from "@effect-agent/sandbox";
2
+ import { Layer } from "effect";
3
+ import { ChildProcessSpawner } from "effect/unstable/process/ChildProcessSpawner";
4
+ //#region src/local-sandbox.d.ts
5
+ /**
6
+ * The only implementation identity produced by this package. It deliberately states that local
7
+ * process execution is unisolated development tooling, not a security sandbox.
8
+ */
9
+ declare const unisolatedImplementation: SandboxImplementation;
10
+ /**
11
+ * Development-only local process adapter with its `ChildProcessSpawner` requirement kept visible
12
+ * so composition roots and tests can inject a spawner double. It is unisolated and must never be
13
+ * used as a security boundary for untrusted code or commands.
14
+ */
15
+ declare const sandboxLayer: Layer.Layer<Sandbox, never, ChildProcessSpawner>;
16
+ /** A scoped Node process implementation whose events are always labeled `unisolated`. */
17
+ declare const layer: Layer.Layer<Sandbox>;
18
+ //#endregion
19
+ export { layer, sandboxLayer, unisolatedImplementation };
20
+ //# sourceMappingURL=index.d.mts.map
package/dist/index.mjs ADDED
@@ -0,0 +1,151 @@
1
+ import { Sandbox, SandboxExitError, SandboxExited, SandboxImplementation, SandboxOutput, SandboxOutputLimitError, SandboxResourceUse, SandboxSpawnError, SandboxStarted, SandboxTimeoutError, SandboxUnsupportedRequestError } from "@effect-agent/sandbox";
2
+ import { NodeServices } from "@effect/platform-node";
3
+ import { Clock, Config, Duration, Effect, Layer, Option, Ref, Stream } from "effect";
4
+ import { ChildProcess } from "effect/unstable/process";
5
+ import { ChildProcessSpawner } from "effect/unstable/process/ChildProcessSpawner";
6
+ //#region src/local-sandbox.ts
7
+ /**
8
+ * The only implementation identity produced by this package. It deliberately states that local
9
+ * process execution is unisolated development tooling, not a security sandbox.
10
+ */
11
+ const unisolatedImplementation = SandboxImplementation.make({
12
+ isolation: "unisolated",
13
+ identity: "local-process"
14
+ });
15
+ const zeroOutput = {
16
+ stdout: 0,
17
+ stderr: 0
18
+ };
19
+ const unsupported = (feature, message) => SandboxUnsupportedRequestError.make({
20
+ implementation: unisolatedImplementation,
21
+ feature,
22
+ message
23
+ });
24
+ const validateRequest = (request) => {
25
+ if (request.runtime.kind !== "unisolated-process") return Effect.fail(unsupported("runtime", "The local process runner only accepts runtime.kind 'unisolated-process'."));
26
+ if (request.mounts.length > 0) return Effect.fail(unsupported("mounts", "The unisolated local process runner cannot enforce mount access modes."));
27
+ if (request.network._tag !== "NetworkDisabled") return Effect.fail(unsupported("network", "The unisolated local process runner cannot enforce workload network policy."));
28
+ if (request.limits.cpuCores !== void 0) return Effect.fail(unsupported("cpu-limit", "The unisolated local process runner cannot enforce CPU limits."));
29
+ if (request.limits.memoryBytes !== void 0) return Effect.fail(unsupported("memory-limit", "The unisolated local process runner cannot enforce memory limits."));
30
+ if (request.secretHandles.length > 0) return Effect.fail(unsupported("secret-handles", "The unisolated local process runner does not resolve secret handles into an environment."));
31
+ if (request.artifactRules.length > 0) return Effect.fail(unsupported("artifacts", "The unisolated local process runner does not collect artifacts."));
32
+ return Effect.void;
33
+ };
34
+ const spawnError = (request, message, cause) => SandboxSpawnError.make({
35
+ implementation: unisolatedImplementation,
36
+ command: request.command,
37
+ message,
38
+ ...cause === void 0 ? {} : { cause }
39
+ });
40
+ const environmentFromAllowlist = Effect.fn("LocalSandbox.environmentFromAllowlist")(function* (request) {
41
+ const environment = {};
42
+ for (const name of request.environment.allow) {
43
+ const value = yield* Config.option(Config.string(name)).pipe(Effect.mapError((error) => spawnError(request, `Could not read allowed environment variable '${name}': ${error.message}`, error)));
44
+ if (Option.isSome(value)) environment[name] = value.value;
45
+ }
46
+ return environment;
47
+ });
48
+ const outputEvent = (counts, stream, bytes, decoder, limit) => Ref.modify(counts, (current) => {
49
+ const streamBytes = current[stream] + bytes.byteLength;
50
+ const next = {
51
+ ...current,
52
+ [stream]: streamBytes
53
+ };
54
+ return [next.stdout + next.stderr, next];
55
+ }).pipe(Effect.flatMap((observed) => observed > limit ? Effect.fail(SandboxOutputLimitError.make({
56
+ implementation: unisolatedImplementation,
57
+ stream,
58
+ limit,
59
+ observed
60
+ })) : Effect.succeed(SandboxOutput.make({
61
+ eventVersion: 1,
62
+ implementation: unisolatedImplementation,
63
+ stream,
64
+ text: decoder.decode(bytes, { stream: true }),
65
+ bytes: bytes.byteLength
66
+ }))));
67
+ /**
68
+ * Emits any text the streaming decoder still holds once its source stream ends. The final decode
69
+ * must run at end-of-stream, not at pipeline construction, so the flush is suspended; a trailing
70
+ * incomplete UTF-8 sequence surfaces as replacement text. Its raw bytes were already counted when
71
+ * the chunk arrived, so the flush event carries zero bytes.
72
+ */
73
+ const flushDecoder = (stream, decoder) => Stream.suspend(() => {
74
+ const text = decoder.decode();
75
+ return text.length === 0 ? Stream.empty : Stream.succeed(SandboxOutput.make({
76
+ eventVersion: 1,
77
+ implementation: unisolatedImplementation,
78
+ stream,
79
+ text,
80
+ bytes: 0
81
+ }));
82
+ });
83
+ const makeExecute = (spawner) => (request) => Stream.unwrap(Effect.gen(function* () {
84
+ yield* validateRequest(request);
85
+ const startedAt = yield* Clock.currentTimeMillis;
86
+ const counts = yield* Ref.make(zeroOutput);
87
+ const stdoutDecoder = new TextDecoder();
88
+ const stderrDecoder = new TextDecoder();
89
+ const environment = yield* environmentFromAllowlist(request);
90
+ const command = ChildProcess.make(request.command, request.args, {
91
+ cwd: request.cwd,
92
+ env: environment,
93
+ extendEnv: false,
94
+ stdout: "pipe",
95
+ stderr: "pipe"
96
+ });
97
+ const child = yield* spawner.spawn(command).pipe(Effect.mapError((error) => spawnError(request, error.message, error)));
98
+ const streamOutput = (stream, decoder) => {
99
+ return (stream === "stdout" ? child.stdout : child.stderr).pipe(Stream.mapError((error) => spawnError(request, error.message, error)), Stream.mapEffect((bytes) => outputEvent(counts, stream, bytes, decoder, request.limits.maxOutputBytes)), Stream.concat(flushDecoder(stream, decoder)));
100
+ };
101
+ const terminal = Stream.unwrap(Effect.gen(function* () {
102
+ const exitCode = yield* child.exitCode.pipe(Effect.mapError((error) => SandboxExitError.make({
103
+ cause: error,
104
+ implementation: unisolatedImplementation,
105
+ exitCode: -1,
106
+ message: error.message
107
+ })));
108
+ const endedAt = yield* Clock.currentTimeMillis;
109
+ const output = yield* Ref.get(counts);
110
+ const resourceUse = SandboxResourceUse.make({
111
+ wallTime: Duration.millis(endedAt - startedAt),
112
+ stdoutBytes: output.stdout,
113
+ stderrBytes: output.stderr
114
+ });
115
+ const exited = SandboxExited.make({
116
+ eventVersion: 1,
117
+ implementation: unisolatedImplementation,
118
+ exitCode,
119
+ resourceUse,
120
+ artifacts: []
121
+ });
122
+ return exitCode === 0 ? Stream.succeed(exited) : Stream.concat(Stream.succeed(exited), Stream.fail(SandboxExitError.make({
123
+ implementation: unisolatedImplementation,
124
+ exitCode,
125
+ message: `Unisolated local process exited with code ${exitCode}.`
126
+ })));
127
+ }));
128
+ return Stream.concat(Stream.succeed(SandboxStarted.make({
129
+ eventVersion: 1,
130
+ implementation: unisolatedImplementation,
131
+ runtime: request.runtime
132
+ })), Stream.concat(Stream.merge(streamOutput("stdout", stdoutDecoder), streamOutput("stderr", stderrDecoder)), terminal)).pipe(Stream.interruptWhen(Effect.sleep(request.limits.maxWallTime).pipe(Effect.andThen(Effect.fail(SandboxTimeoutError.make({
133
+ implementation: unisolatedImplementation,
134
+ maxWallTime: request.limits.maxWallTime
135
+ }))))));
136
+ })).pipe(Stream.withSpan("LocalSandbox.execute"));
137
+ /**
138
+ * Development-only local process adapter with its `ChildProcessSpawner` requirement kept visible
139
+ * so composition roots and tests can inject a spawner double. It is unisolated and must never be
140
+ * used as a security boundary for untrusted code or commands.
141
+ */
142
+ const sandboxLayer = Layer.effect(Sandbox)(Effect.gen(function* () {
143
+ const spawner = yield* ChildProcessSpawner;
144
+ return Sandbox.of({ execute: makeExecute(spawner) });
145
+ }));
146
+ /** A scoped Node process implementation whose events are always labeled `unisolated`. */
147
+ const layer = sandboxLayer.pipe(Layer.provide(NodeServices.layer));
148
+ //#endregion
149
+ export { layer, sandboxLayer, unisolatedImplementation };
150
+
151
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../src/local-sandbox.ts"],"sourcesContent":["import {\n Sandbox,\n SandboxExited,\n SandboxExitError,\n SandboxImplementation,\n SandboxOutput,\n SandboxOutputLimitError,\n SandboxResourceUse,\n SandboxSpawnError,\n SandboxStarted,\n SandboxTimeoutError,\n SandboxUnsupportedRequestError,\n type SandboxError,\n type SandboxEvent,\n type SandboxExecute,\n type SandboxRequest,\n} from \"@effect-agent/sandbox\";\nimport { NodeServices } from \"@effect/platform-node\";\nimport { Clock, Config, Duration, Effect, Layer, Option, Ref, Stream } from \"effect\";\nimport { ChildProcess } from \"effect/unstable/process\";\nimport { ChildProcessSpawner } from \"effect/unstable/process/ChildProcessSpawner\";\n\n/**\n * The only implementation identity produced by this package. It deliberately states that local\n * process execution is unisolated development tooling, not a security sandbox.\n */\nexport const unisolatedImplementation = SandboxImplementation.make({\n isolation: \"unisolated\",\n identity: \"local-process\",\n});\n\ntype OutputStream = \"stdout\" | \"stderr\";\ntype OutputCounts = Readonly<Record<OutputStream, number>>;\n\nconst zeroOutput: OutputCounts = { stdout: 0, stderr: 0 };\n\nconst unsupported = (\n feature: Parameters<typeof SandboxUnsupportedRequestError.make>[0][\"feature\"],\n message: string,\n) =>\n SandboxUnsupportedRequestError.make({\n implementation: unisolatedImplementation,\n feature,\n message,\n });\n\nconst validateRequest = (request: SandboxRequest): Effect.Effect<void, SandboxError> => {\n if (request.runtime.kind !== \"unisolated-process\") {\n return Effect.fail(\n unsupported(\n \"runtime\",\n \"The local process runner only accepts runtime.kind 'unisolated-process'.\",\n ),\n );\n }\n if (request.mounts.length > 0) {\n return Effect.fail(\n unsupported(\n \"mounts\",\n \"The unisolated local process runner cannot enforce mount access modes.\",\n ),\n );\n }\n if (request.network._tag !== \"NetworkDisabled\") {\n return Effect.fail(\n unsupported(\n \"network\",\n \"The unisolated local process runner cannot enforce workload network policy.\",\n ),\n );\n }\n if (request.limits.cpuCores !== undefined) {\n return Effect.fail(\n unsupported(\"cpu-limit\", \"The unisolated local process runner cannot enforce CPU limits.\"),\n );\n }\n if (request.limits.memoryBytes !== undefined) {\n return Effect.fail(\n unsupported(\n \"memory-limit\",\n \"The unisolated local process runner cannot enforce memory limits.\",\n ),\n );\n }\n if (request.secretHandles.length > 0) {\n return Effect.fail(\n unsupported(\n \"secret-handles\",\n \"The unisolated local process runner does not resolve secret handles into an environment.\",\n ),\n );\n }\n if (request.artifactRules.length > 0) {\n return Effect.fail(\n unsupported(\"artifacts\", \"The unisolated local process runner does not collect artifacts.\"),\n );\n }\n return Effect.void;\n};\n\nconst spawnError = (request: SandboxRequest, message: string, cause?: unknown) =>\n SandboxSpawnError.make({\n implementation: unisolatedImplementation,\n command: request.command,\n message,\n ...(cause === undefined ? {} : { cause }),\n });\n\nconst environmentFromAllowlist = Effect.fn(\"LocalSandbox.environmentFromAllowlist\")(function* (\n request: SandboxRequest,\n) {\n const environment: Record<string, string> = {};\n for (const name of request.environment.allow) {\n const value = yield* Config.option(Config.string(name)).pipe(\n Effect.mapError((error) =>\n spawnError(\n request,\n `Could not read allowed environment variable '${name}': ${error.message}`,\n error,\n ),\n ),\n );\n if (Option.isSome(value)) {\n environment[name] = value.value;\n }\n }\n return environment;\n});\n\nconst outputEvent = (\n counts: Ref.Ref<OutputCounts>,\n stream: OutputStream,\n bytes: Uint8Array,\n decoder: TextDecoder,\n limit: number,\n): Effect.Effect<SandboxOutput, SandboxOutputLimitError> =>\n Ref.modify(counts, (current) => {\n const streamBytes = current[stream] + bytes.byteLength;\n const next = { ...current, [stream]: streamBytes };\n return [next.stdout + next.stderr, next] as const;\n }).pipe(\n Effect.flatMap((observed) =>\n observed > limit\n ? Effect.fail(\n SandboxOutputLimitError.make({\n implementation: unisolatedImplementation,\n stream,\n limit,\n observed,\n }),\n )\n : Effect.succeed(\n SandboxOutput.make({\n eventVersion: 1,\n implementation: unisolatedImplementation,\n stream,\n text: decoder.decode(bytes, { stream: true }),\n bytes: bytes.byteLength,\n }),\n ),\n ),\n );\n\n/**\n * Emits any text the streaming decoder still holds once its source stream ends. The final decode\n * must run at end-of-stream, not at pipeline construction, so the flush is suspended; a trailing\n * incomplete UTF-8 sequence surfaces as replacement text. Its raw bytes were already counted when\n * the chunk arrived, so the flush event carries zero bytes.\n */\nconst flushDecoder = (stream: OutputStream, decoder: TextDecoder): Stream.Stream<SandboxOutput> =>\n Stream.suspend(() => {\n const text = decoder.decode();\n return text.length === 0\n ? Stream.empty\n : Stream.succeed(\n SandboxOutput.make({\n eventVersion: 1,\n implementation: unisolatedImplementation,\n stream,\n text,\n bytes: 0,\n }),\n );\n });\n\nconst makeExecute =\n (spawner: ChildProcessSpawner[\"Service\"]): SandboxExecute =>\n (request) =>\n Stream.unwrap(\n Effect.gen(function* () {\n yield* validateRequest(request);\n const startedAt = yield* Clock.currentTimeMillis;\n const counts = yield* Ref.make(zeroOutput);\n const stdoutDecoder = new TextDecoder();\n const stderrDecoder = new TextDecoder();\n const environment = yield* environmentFromAllowlist(request);\n const command = ChildProcess.make(request.command, request.args, {\n cwd: request.cwd,\n env: environment,\n extendEnv: false,\n stdout: \"pipe\",\n stderr: \"pipe\",\n });\n const child = yield* spawner\n .spawn(command)\n .pipe(Effect.mapError((error) => spawnError(request, error.message, error)));\n\n const streamOutput = (stream: OutputStream, decoder: TextDecoder) => {\n const source = stream === \"stdout\" ? child.stdout : child.stderr;\n return source.pipe(\n Stream.mapError((error) => spawnError(request, error.message, error)),\n Stream.mapEffect((bytes) =>\n outputEvent(counts, stream, bytes, decoder, request.limits.maxOutputBytes),\n ),\n Stream.concat(flushDecoder(stream, decoder)),\n );\n };\n\n const terminal = Stream.unwrap(\n Effect.gen(function* () {\n const exitCode = yield* child.exitCode.pipe(\n Effect.mapError((error) =>\n SandboxExitError.make({\n cause: error,\n implementation: unisolatedImplementation,\n exitCode: -1,\n message: error.message,\n }),\n ),\n );\n const endedAt = yield* Clock.currentTimeMillis;\n const output = yield* Ref.get(counts);\n const resourceUse = SandboxResourceUse.make({\n wallTime: Duration.millis(endedAt - startedAt),\n stdoutBytes: output.stdout,\n stderrBytes: output.stderr,\n });\n const exited = SandboxExited.make({\n eventVersion: 1,\n implementation: unisolatedImplementation,\n exitCode,\n resourceUse,\n artifacts: [],\n });\n return exitCode === 0\n ? Stream.succeed<SandboxEvent>(exited)\n : Stream.concat(\n Stream.succeed<SandboxEvent>(exited),\n Stream.fail(\n SandboxExitError.make({\n implementation: unisolatedImplementation,\n exitCode,\n message: `Unisolated local process exited with code ${exitCode}.`,\n }),\n ),\n );\n }),\n );\n\n const execution = Stream.concat(\n Stream.succeed<SandboxEvent>(\n SandboxStarted.make({\n eventVersion: 1,\n implementation: unisolatedImplementation,\n runtime: request.runtime,\n }),\n ),\n Stream.concat(\n Stream.merge(\n streamOutput(\"stdout\", stdoutDecoder),\n streamOutput(\"stderr\", stderrDecoder),\n ),\n terminal,\n ),\n );\n\n return execution.pipe(\n Stream.interruptWhen(\n Effect.sleep(request.limits.maxWallTime).pipe(\n Effect.andThen(\n Effect.fail(\n SandboxTimeoutError.make({\n implementation: unisolatedImplementation,\n maxWallTime: request.limits.maxWallTime,\n }),\n ),\n ),\n ),\n ),\n );\n }),\n ).pipe(Stream.withSpan(\"LocalSandbox.execute\"));\n\n/**\n * Development-only local process adapter with its `ChildProcessSpawner` requirement kept visible\n * so composition roots and tests can inject a spawner double. It is unisolated and must never be\n * used as a security boundary for untrusted code or commands.\n */\nexport const sandboxLayer: Layer.Layer<Sandbox, never, ChildProcessSpawner> = Layer.effect(Sandbox)(\n Effect.gen(function* () {\n const spawner = yield* ChildProcessSpawner;\n return Sandbox.of({ execute: makeExecute(spawner) });\n }),\n);\n\n/** A scoped Node process implementation whose events are always labeled `unisolated`. */\nexport const layer: Layer.Layer<Sandbox> = sandboxLayer.pipe(Layer.provide(NodeServices.layer));\n"],"mappings":";;;;;;;;;;AA0BA,MAAa,2BAA2B,sBAAsB,KAAK;CACjE,WAAW;CACX,UAAU;AACZ,CAAC;AAKD,MAAM,aAA2B;CAAE,QAAQ;CAAG,QAAQ;AAAE;AAExD,MAAM,eACJ,SACA,YAEA,+BAA+B,KAAK;CAClC,gBAAgB;CAChB;CACA;AACF,CAAC;AAEH,MAAM,mBAAmB,YAA+D;CACtF,IAAI,QAAQ,QAAQ,SAAS,sBAC3B,OAAO,OAAO,KACZ,YACE,WACA,0EACF,CACF;CAEF,IAAI,QAAQ,OAAO,SAAS,GAC1B,OAAO,OAAO,KACZ,YACE,UACA,wEACF,CACF;CAEF,IAAI,QAAQ,QAAQ,SAAS,mBAC3B,OAAO,OAAO,KACZ,YACE,WACA,6EACF,CACF;CAEF,IAAI,QAAQ,OAAO,aAAa,KAAA,GAC9B,OAAO,OAAO,KACZ,YAAY,aAAa,gEAAgE,CAC3F;CAEF,IAAI,QAAQ,OAAO,gBAAgB,KAAA,GACjC,OAAO,OAAO,KACZ,YACE,gBACA,mEACF,CACF;CAEF,IAAI,QAAQ,cAAc,SAAS,GACjC,OAAO,OAAO,KACZ,YACE,kBACA,0FACF,CACF;CAEF,IAAI,QAAQ,cAAc,SAAS,GACjC,OAAO,OAAO,KACZ,YAAY,aAAa,iEAAiE,CAC5F;CAEF,OAAO,OAAO;AAChB;AAEA,MAAM,cAAc,SAAyB,SAAiB,UAC5D,kBAAkB,KAAK;CACrB,gBAAgB;CAChB,SAAS,QAAQ;CACjB;CACA,GAAI,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,MAAM;AACzC,CAAC;AAEH,MAAM,2BAA2B,OAAO,GAAG,uCAAuC,CAAC,CAAC,WAClF,SACA;CACA,MAAM,cAAsC,CAAC;CAC7C,KAAK,MAAM,QAAQ,QAAQ,YAAY,OAAO;EAC5C,MAAM,QAAQ,OAAO,OAAO,OAAO,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,KACtD,OAAO,UAAU,UACf,WACE,SACA,gDAAgD,KAAK,KAAK,MAAM,WAChE,KACF,CACF,CACF;EACA,IAAI,OAAO,OAAO,KAAK,GACrB,YAAY,QAAQ,MAAM;CAE9B;CACA,OAAO;AACT,CAAC;AAED,MAAM,eACJ,QACA,QACA,OACA,SACA,UAEA,IAAI,OAAO,SAAS,YAAY;CAC9B,MAAM,cAAc,QAAQ,UAAU,MAAM;CAC5C,MAAM,OAAO;EAAE,GAAG;GAAU,SAAS;CAAY;CACjD,OAAO,CAAC,KAAK,SAAS,KAAK,QAAQ,IAAI;AACzC,CAAC,CAAC,CAAC,KACD,OAAO,SAAS,aACd,WAAW,QACP,OAAO,KACL,wBAAwB,KAAK;CAC3B,gBAAgB;CAChB;CACA;CACA;AACF,CAAC,CACH,IACA,OAAO,QACL,cAAc,KAAK;CACjB,cAAc;CACd,gBAAgB;CAChB;CACA,MAAM,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;CAC5C,OAAO,MAAM;AACf,CAAC,CACH,CACN,CACF;;;;;;;AAQF,MAAM,gBAAgB,QAAsB,YAC1C,OAAO,cAAc;CACnB,MAAM,OAAO,QAAQ,OAAO;CAC5B,OAAO,KAAK,WAAW,IACnB,OAAO,QACP,OAAO,QACL,cAAc,KAAK;EACjB,cAAc;EACd,gBAAgB;EAChB;EACA;EACA,OAAO;CACT,CAAC,CACH;AACN,CAAC;AAEH,MAAM,eACH,aACA,YACC,OAAO,OACL,OAAO,IAAI,aAAa;CACtB,OAAO,gBAAgB,OAAO;CAC9B,MAAM,YAAY,OAAO,MAAM;CAC/B,MAAM,SAAS,OAAO,IAAI,KAAK,UAAU;CACzC,MAAM,gBAAgB,IAAI,YAAY;CACtC,MAAM,gBAAgB,IAAI,YAAY;CACtC,MAAM,cAAc,OAAO,yBAAyB,OAAO;CAC3D,MAAM,UAAU,aAAa,KAAK,QAAQ,SAAS,QAAQ,MAAM;EAC/D,KAAK,QAAQ;EACb,KAAK;EACL,WAAW;EACX,QAAQ;EACR,QAAQ;CACV,CAAC;CACD,MAAM,QAAQ,OAAO,QAClB,MAAM,OAAO,CAAC,CACd,KAAK,OAAO,UAAU,UAAU,WAAW,SAAS,MAAM,SAAS,KAAK,CAAC,CAAC;CAE7E,MAAM,gBAAgB,QAAsB,YAAyB;EAEnE,QADe,WAAW,WAAW,MAAM,SAAS,MAAM,OAAA,CAC5C,KACZ,OAAO,UAAU,UAAU,WAAW,SAAS,MAAM,SAAS,KAAK,CAAC,GACpE,OAAO,WAAW,UAChB,YAAY,QAAQ,QAAQ,OAAO,SAAS,QAAQ,OAAO,cAAc,CAC3E,GACA,OAAO,OAAO,aAAa,QAAQ,OAAO,CAAC,CAC7C;CACF;CAEA,MAAM,WAAW,OAAO,OACtB,OAAO,IAAI,aAAa;EACtB,MAAM,WAAW,OAAO,MAAM,SAAS,KACrC,OAAO,UAAU,UACf,iBAAiB,KAAK;GACpB,OAAO;GACP,gBAAgB;GAChB,UAAU;GACV,SAAS,MAAM;EACjB,CAAC,CACH,CACF;EACA,MAAM,UAAU,OAAO,MAAM;EAC7B,MAAM,SAAS,OAAO,IAAI,IAAI,MAAM;EACpC,MAAM,cAAc,mBAAmB,KAAK;GAC1C,UAAU,SAAS,OAAO,UAAU,SAAS;GAC7C,aAAa,OAAO;GACpB,aAAa,OAAO;EACtB,CAAC;EACD,MAAM,SAAS,cAAc,KAAK;GAChC,cAAc;GACd,gBAAgB;GAChB;GACA;GACA,WAAW,CAAC;EACd,CAAC;EACD,OAAO,aAAa,IAChB,OAAO,QAAsB,MAAM,IACnC,OAAO,OACL,OAAO,QAAsB,MAAM,GACnC,OAAO,KACL,iBAAiB,KAAK;GACpB,gBAAgB;GAChB;GACA,SAAS,6CAA6C,SAAS;EACjE,CAAC,CACH,CACF;CACN,CAAC,CACH;CAmBA,OAjBkB,OAAO,OACvB,OAAO,QACL,eAAe,KAAK;EAClB,cAAc;EACd,gBAAgB;EAChB,SAAS,QAAQ;CACnB,CAAC,CACH,GACA,OAAO,OACL,OAAO,MACL,aAAa,UAAU,aAAa,GACpC,aAAa,UAAU,aAAa,CACtC,GACA,QACF,CAGa,CAAC,CAAC,KACf,OAAO,cACL,OAAO,MAAM,QAAQ,OAAO,WAAW,CAAC,CAAC,KACvC,OAAO,QACL,OAAO,KACL,oBAAoB,KAAK;EACvB,gBAAgB;EAChB,aAAa,QAAQ,OAAO;CAC9B,CAAC,CACH,CACF,CACF,CACF,CACF;AACF,CAAC,CACH,CAAC,CAAC,KAAK,OAAO,SAAS,sBAAsB,CAAC;;;;;;AAOlD,MAAa,eAAiE,MAAM,OAAO,OAAO,CAAC,CACjG,OAAO,IAAI,aAAa;CACtB,MAAM,UAAU,OAAO;CACvB,OAAO,QAAQ,GAAG,EAAE,SAAS,YAAY,OAAO,EAAE,CAAC;AACrD,CAAC,CACH;;AAGA,MAAa,QAA8B,aAAa,KAAK,MAAM,QAAQ,aAAa,KAAK,CAAC"}
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@effect-agent/sandbox-local",
3
+ "version": "0.0.1-beta.0",
4
+ "description": "Node-local child-process Sandbox adapter for Effect Agent; honestly labeled unisolated development tooling, not a security boundary.",
5
+ "license": "UNLICENSED",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/danieljvdm/effect-agent.git",
9
+ "directory": "packages/sandbox-local"
10
+ },
11
+ "files": [
12
+ "dist",
13
+ "src"
14
+ ],
15
+ "type": "module",
16
+ "exports": {
17
+ ".": {
18
+ "types": "./dist/index.d.mts",
19
+ "default": "./dist/index.mjs"
20
+ }
21
+ },
22
+ "publishConfig": {
23
+ "access": "public"
24
+ },
25
+ "scripts": {
26
+ "build": "vp pack",
27
+ "check": "tsc --noEmit -p tsconfig.json",
28
+ "test": "vp test --passWithNoTests"
29
+ },
30
+ "dependencies": {
31
+ "@effect-agent/sandbox": "0.0.0",
32
+ "@effect/platform-node": "4.0.0-beta.102",
33
+ "effect": "4.0.0-beta.102"
34
+ },
35
+ "devDependencies": {
36
+ "@effect/vitest": "4.0.0-beta.102",
37
+ "@types/node": "26.1.2",
38
+ "typescript": "7.0.2",
39
+ "vite-plus": "0.2.6"
40
+ }
41
+ }
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from "./local-sandbox.ts";
@@ -0,0 +1,307 @@
1
+ import {
2
+ Sandbox,
3
+ SandboxExited,
4
+ SandboxExitError,
5
+ SandboxImplementation,
6
+ SandboxOutput,
7
+ SandboxOutputLimitError,
8
+ SandboxResourceUse,
9
+ SandboxSpawnError,
10
+ SandboxStarted,
11
+ SandboxTimeoutError,
12
+ SandboxUnsupportedRequestError,
13
+ type SandboxError,
14
+ type SandboxEvent,
15
+ type SandboxExecute,
16
+ type SandboxRequest,
17
+ } from "@effect-agent/sandbox";
18
+ import { NodeServices } from "@effect/platform-node";
19
+ import { Clock, Config, Duration, Effect, Layer, Option, Ref, Stream } from "effect";
20
+ import { ChildProcess } from "effect/unstable/process";
21
+ import { ChildProcessSpawner } from "effect/unstable/process/ChildProcessSpawner";
22
+
23
+ /**
24
+ * The only implementation identity produced by this package. It deliberately states that local
25
+ * process execution is unisolated development tooling, not a security sandbox.
26
+ */
27
+ export const unisolatedImplementation = SandboxImplementation.make({
28
+ isolation: "unisolated",
29
+ identity: "local-process",
30
+ });
31
+
32
+ type OutputStream = "stdout" | "stderr";
33
+ type OutputCounts = Readonly<Record<OutputStream, number>>;
34
+
35
+ const zeroOutput: OutputCounts = { stdout: 0, stderr: 0 };
36
+
37
+ const unsupported = (
38
+ feature: Parameters<typeof SandboxUnsupportedRequestError.make>[0]["feature"],
39
+ message: string,
40
+ ) =>
41
+ SandboxUnsupportedRequestError.make({
42
+ implementation: unisolatedImplementation,
43
+ feature,
44
+ message,
45
+ });
46
+
47
+ const validateRequest = (request: SandboxRequest): Effect.Effect<void, SandboxError> => {
48
+ if (request.runtime.kind !== "unisolated-process") {
49
+ return Effect.fail(
50
+ unsupported(
51
+ "runtime",
52
+ "The local process runner only accepts runtime.kind 'unisolated-process'.",
53
+ ),
54
+ );
55
+ }
56
+ if (request.mounts.length > 0) {
57
+ return Effect.fail(
58
+ unsupported(
59
+ "mounts",
60
+ "The unisolated local process runner cannot enforce mount access modes.",
61
+ ),
62
+ );
63
+ }
64
+ if (request.network._tag !== "NetworkDisabled") {
65
+ return Effect.fail(
66
+ unsupported(
67
+ "network",
68
+ "The unisolated local process runner cannot enforce workload network policy.",
69
+ ),
70
+ );
71
+ }
72
+ if (request.limits.cpuCores !== undefined) {
73
+ return Effect.fail(
74
+ unsupported("cpu-limit", "The unisolated local process runner cannot enforce CPU limits."),
75
+ );
76
+ }
77
+ if (request.limits.memoryBytes !== undefined) {
78
+ return Effect.fail(
79
+ unsupported(
80
+ "memory-limit",
81
+ "The unisolated local process runner cannot enforce memory limits.",
82
+ ),
83
+ );
84
+ }
85
+ if (request.secretHandles.length > 0) {
86
+ return Effect.fail(
87
+ unsupported(
88
+ "secret-handles",
89
+ "The unisolated local process runner does not resolve secret handles into an environment.",
90
+ ),
91
+ );
92
+ }
93
+ if (request.artifactRules.length > 0) {
94
+ return Effect.fail(
95
+ unsupported("artifacts", "The unisolated local process runner does not collect artifacts."),
96
+ );
97
+ }
98
+ return Effect.void;
99
+ };
100
+
101
+ const spawnError = (request: SandboxRequest, message: string, cause?: unknown) =>
102
+ SandboxSpawnError.make({
103
+ implementation: unisolatedImplementation,
104
+ command: request.command,
105
+ message,
106
+ ...(cause === undefined ? {} : { cause }),
107
+ });
108
+
109
+ const environmentFromAllowlist = Effect.fn("LocalSandbox.environmentFromAllowlist")(function* (
110
+ request: SandboxRequest,
111
+ ) {
112
+ const environment: Record<string, string> = {};
113
+ for (const name of request.environment.allow) {
114
+ const value = yield* Config.option(Config.string(name)).pipe(
115
+ Effect.mapError((error) =>
116
+ spawnError(
117
+ request,
118
+ `Could not read allowed environment variable '${name}': ${error.message}`,
119
+ error,
120
+ ),
121
+ ),
122
+ );
123
+ if (Option.isSome(value)) {
124
+ environment[name] = value.value;
125
+ }
126
+ }
127
+ return environment;
128
+ });
129
+
130
+ const outputEvent = (
131
+ counts: Ref.Ref<OutputCounts>,
132
+ stream: OutputStream,
133
+ bytes: Uint8Array,
134
+ decoder: TextDecoder,
135
+ limit: number,
136
+ ): Effect.Effect<SandboxOutput, SandboxOutputLimitError> =>
137
+ Ref.modify(counts, (current) => {
138
+ const streamBytes = current[stream] + bytes.byteLength;
139
+ const next = { ...current, [stream]: streamBytes };
140
+ return [next.stdout + next.stderr, next] as const;
141
+ }).pipe(
142
+ Effect.flatMap((observed) =>
143
+ observed > limit
144
+ ? Effect.fail(
145
+ SandboxOutputLimitError.make({
146
+ implementation: unisolatedImplementation,
147
+ stream,
148
+ limit,
149
+ observed,
150
+ }),
151
+ )
152
+ : Effect.succeed(
153
+ SandboxOutput.make({
154
+ eventVersion: 1,
155
+ implementation: unisolatedImplementation,
156
+ stream,
157
+ text: decoder.decode(bytes, { stream: true }),
158
+ bytes: bytes.byteLength,
159
+ }),
160
+ ),
161
+ ),
162
+ );
163
+
164
+ /**
165
+ * Emits any text the streaming decoder still holds once its source stream ends. The final decode
166
+ * must run at end-of-stream, not at pipeline construction, so the flush is suspended; a trailing
167
+ * incomplete UTF-8 sequence surfaces as replacement text. Its raw bytes were already counted when
168
+ * the chunk arrived, so the flush event carries zero bytes.
169
+ */
170
+ const flushDecoder = (stream: OutputStream, decoder: TextDecoder): Stream.Stream<SandboxOutput> =>
171
+ Stream.suspend(() => {
172
+ const text = decoder.decode();
173
+ return text.length === 0
174
+ ? Stream.empty
175
+ : Stream.succeed(
176
+ SandboxOutput.make({
177
+ eventVersion: 1,
178
+ implementation: unisolatedImplementation,
179
+ stream,
180
+ text,
181
+ bytes: 0,
182
+ }),
183
+ );
184
+ });
185
+
186
+ const makeExecute =
187
+ (spawner: ChildProcessSpawner["Service"]): SandboxExecute =>
188
+ (request) =>
189
+ Stream.unwrap(
190
+ Effect.gen(function* () {
191
+ yield* validateRequest(request);
192
+ const startedAt = yield* Clock.currentTimeMillis;
193
+ const counts = yield* Ref.make(zeroOutput);
194
+ const stdoutDecoder = new TextDecoder();
195
+ const stderrDecoder = new TextDecoder();
196
+ const environment = yield* environmentFromAllowlist(request);
197
+ const command = ChildProcess.make(request.command, request.args, {
198
+ cwd: request.cwd,
199
+ env: environment,
200
+ extendEnv: false,
201
+ stdout: "pipe",
202
+ stderr: "pipe",
203
+ });
204
+ const child = yield* spawner
205
+ .spawn(command)
206
+ .pipe(Effect.mapError((error) => spawnError(request, error.message, error)));
207
+
208
+ const streamOutput = (stream: OutputStream, decoder: TextDecoder) => {
209
+ const source = stream === "stdout" ? child.stdout : child.stderr;
210
+ return source.pipe(
211
+ Stream.mapError((error) => spawnError(request, error.message, error)),
212
+ Stream.mapEffect((bytes) =>
213
+ outputEvent(counts, stream, bytes, decoder, request.limits.maxOutputBytes),
214
+ ),
215
+ Stream.concat(flushDecoder(stream, decoder)),
216
+ );
217
+ };
218
+
219
+ const terminal = Stream.unwrap(
220
+ Effect.gen(function* () {
221
+ const exitCode = yield* child.exitCode.pipe(
222
+ Effect.mapError((error) =>
223
+ SandboxExitError.make({
224
+ cause: error,
225
+ implementation: unisolatedImplementation,
226
+ exitCode: -1,
227
+ message: error.message,
228
+ }),
229
+ ),
230
+ );
231
+ const endedAt = yield* Clock.currentTimeMillis;
232
+ const output = yield* Ref.get(counts);
233
+ const resourceUse = SandboxResourceUse.make({
234
+ wallTime: Duration.millis(endedAt - startedAt),
235
+ stdoutBytes: output.stdout,
236
+ stderrBytes: output.stderr,
237
+ });
238
+ const exited = SandboxExited.make({
239
+ eventVersion: 1,
240
+ implementation: unisolatedImplementation,
241
+ exitCode,
242
+ resourceUse,
243
+ artifacts: [],
244
+ });
245
+ return exitCode === 0
246
+ ? Stream.succeed<SandboxEvent>(exited)
247
+ : Stream.concat(
248
+ Stream.succeed<SandboxEvent>(exited),
249
+ Stream.fail(
250
+ SandboxExitError.make({
251
+ implementation: unisolatedImplementation,
252
+ exitCode,
253
+ message: `Unisolated local process exited with code ${exitCode}.`,
254
+ }),
255
+ ),
256
+ );
257
+ }),
258
+ );
259
+
260
+ const execution = Stream.concat(
261
+ Stream.succeed<SandboxEvent>(
262
+ SandboxStarted.make({
263
+ eventVersion: 1,
264
+ implementation: unisolatedImplementation,
265
+ runtime: request.runtime,
266
+ }),
267
+ ),
268
+ Stream.concat(
269
+ Stream.merge(
270
+ streamOutput("stdout", stdoutDecoder),
271
+ streamOutput("stderr", stderrDecoder),
272
+ ),
273
+ terminal,
274
+ ),
275
+ );
276
+
277
+ return execution.pipe(
278
+ Stream.interruptWhen(
279
+ Effect.sleep(request.limits.maxWallTime).pipe(
280
+ Effect.andThen(
281
+ Effect.fail(
282
+ SandboxTimeoutError.make({
283
+ implementation: unisolatedImplementation,
284
+ maxWallTime: request.limits.maxWallTime,
285
+ }),
286
+ ),
287
+ ),
288
+ ),
289
+ ),
290
+ );
291
+ }),
292
+ ).pipe(Stream.withSpan("LocalSandbox.execute"));
293
+
294
+ /**
295
+ * Development-only local process adapter with its `ChildProcessSpawner` requirement kept visible
296
+ * so composition roots and tests can inject a spawner double. It is unisolated and must never be
297
+ * used as a security boundary for untrusted code or commands.
298
+ */
299
+ export const sandboxLayer: Layer.Layer<Sandbox, never, ChildProcessSpawner> = Layer.effect(Sandbox)(
300
+ Effect.gen(function* () {
301
+ const spawner = yield* ChildProcessSpawner;
302
+ return Sandbox.of({ execute: makeExecute(spawner) });
303
+ }),
304
+ );
305
+
306
+ /** A scoped Node process implementation whose events are always labeled `unisolated`. */
307
+ export const layer: Layer.Layer<Sandbox> = sandboxLayer.pipe(Layer.provide(NodeServices.layer));