@dxos/effect 0.8.4-main.f9ba587 → 0.8.4-main.fd6878d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/effect",
-  "version": "0.8.4-main.f9ba587",
+  "version": "0.8.4-main.fd6878d",
   "description": "Effect utils.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -9,6 +9,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -24,14 +25,14 @@
   ],
   "dependencies": {
     "jsonpath-plus": "10.2.0",
-    "@dxos/context": "0.8.4-main.f9ba587",
-    "@dxos/invariant": "0.8.4-main.f9ba587",
-    "@dxos/node-std": "0.8.4-main.f9ba587",
-    "@dxos/util": "0.8.4-main.f9ba587"
+    "@dxos/context": "0.8.4-main.fd6878d",
+    "@dxos/invariant": "0.8.4-main.fd6878d",
+    "@dxos/node-std": "0.8.4-main.fd6878d",
+    "@dxos/util": "0.8.4-main.fd6878d"
   },
   "devDependencies": {
-    "effect": "3.16.13",
-    "@dxos/log": "0.8.4-main.f9ba587"
+    "effect": "3.17.7",
+    "@dxos/log": "0.8.4-main.fd6878d"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/ast.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { SchemaAST, Schema } from 'effect';
+import { Schema, SchemaAST } from 'effect';
 import { describe, test } from 'vitest';
 
 import { invariant } from '@dxos/invariant';
@@ -12,13 +12,13 @@ import {
   findNode,
   findProperty,
   getAnnotation,
-  getDiscriminatingProps,
   getDiscriminatedType,
+  getDiscriminatingProps,
   getSimpleType,
+  isArrayType,
   isOption,
   isSimpleType,
   visit,
-  isArrayType,
 } from './ast';
 import { type JsonPath, type JsonProp } from './jsonPath';
 

package/src/ast.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Option, pipe, SchemaAST, Schema } from 'effect';
+import { Option, Schema, SchemaAST, pipe } from 'effect';
 import { isUndefinedKeyword } from 'effect/SchemaAST';
 
 import { invariant } from '@dxos/invariant';

package/src/errors.ts

@@ -6,14 +6,16 @@ import { Cause, Chunk, Effect, Exit, GlobalValue, Option } from 'effect';
 import type { AnySpan, Span } from 'effect/Tracer';
 
 const spanSymbol = Symbol.for('effect/SpanAnnotation');
+const originalSymbol = Symbol.for('effect/OriginalAnnotation');
 const spanToTrace = GlobalValue.globalValue('effect/Tracer/spanToTrace', () => new WeakMap());
 const locationRegex = /\((.*)\)/g;
 
 /**
  * Adds effect spans.
  * Removes effect internal functions.
+ * Unwraps error proxy.
  */
-const prettyErrorStack = (error: any, appendStacks: string[] = []): void => {
+const prettyErrorStack = (error: any, appendStacks: string[] = []): any => {
   const span = error[spanSymbol];
 
   const lines = typeof error.stack === 'string' ? error.stack.split('\n') : [];
@@ -75,12 +77,21 @@ const prettyErrorStack = (error: any, appendStacks: string[] = []): void => {
 
   out.push(...appendStacks);
 
+  if (error[originalSymbol]) {
+    error = error[originalSymbol];
+  }
+  if (error.cause) {
+    error.cause = prettyErrorStack(error.cause);
+  }
+
   Object.defineProperty(error, 'stack', {
     value: out.join('\n'),
     writable: true,
     enumerable: false,
     configurable: true,
   });
+
+  return error;
 };
 
 /**
@@ -116,14 +127,12 @@ export const runAndForwardErrors = async <A, E>(
     };
 
     const stackFrames = getStackFrames();
-    for (const error of errors) {
-      prettyErrorStack(error, stackFrames);
-    }
+    const newErrors = errors.map((error) => prettyErrorStack(error, stackFrames));
 
-    if (errors.length === 1) {
-      throw errors[0];
+    if (newErrors.length === 1) {
+      throw newErrors[0];
     } else {
-      throw new AggregateError(errors);
+      throw new AggregateError(newErrors);
     }
   }
 };

package/src/index.ts

@@ -7,3 +7,5 @@ export * from './jsonPath';
 export * from './url';
 export * from './context';
 export * from './errors';
+export * from './testing';
+export * from './resource';

package/src/jsonPath.test.ts

@@ -4,7 +4,7 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { createJsonPath, getField, isJsonPath, type JsonPath, splitJsonPath } from './jsonPath';
+import { type JsonPath, createJsonPath, getField, isJsonPath, splitJsonPath } from './jsonPath';
 
 describe('createJsonPath', () => {
   test('supported path subset', () => {

package/src/jsonPath.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema, Option } from 'effect';
+import { Option, Schema } from 'effect';
 import { JSONPath } from 'jsonpath-plus';
 
 import { invariant } from '@dxos/invariant';

package/src/layers.test.ts

@@ -0,0 +1,106 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { it } from '@effect/vitest';
+import { Context, Duration, Effect, Layer, ManagedRuntime } from 'effect';
+import { test } from 'vitest';
+
+class ClientConfig extends Context.Tag('ClientConfig')<ClientConfig, { endpoint: string }>() {}
+
+class Client extends Context.Tag('Client')<Client, { call: () => Effect.Effect<void> }>() {
+  static layer = Layer.effect(
+    Client,
+    Effect.gen(function* () {
+      const config = yield* ClientConfig;
+      return {
+        call: () => {
+          console.log('called', config.endpoint);
+          return Effect.void;
+        },
+      };
+    }),
+  );
+}
+
+const ServerLive = Layer.scoped(
+  ClientConfig,
+  Effect.gen(function* () {
+    console.log('start server');
+
+    yield* Effect.sleep(Duration.millis(100));
+
+    yield* Effect.addFinalizer(
+      Effect.fn(function* () {
+        yield* Effect.sleep(Duration.millis(100));
+        console.log('stop server');
+      }),
+    );
+
+    return {
+      endpoint: 'http://localhost:8080',
+    };
+  }),
+);
+
+it.effect.skip(
+  'test',
+  Effect.fn(
+    function* ({ expect: _ }) {
+      const client = yield* Client;
+      yield* client.call();
+    },
+    Effect.provide(Layer.provide(Client.layer, ServerLive)),
+  ),
+);
+
+class ServerPlugin {
+  #runtime = ManagedRuntime.make(ServerLive);
+
+  readonly clientConfigLayer = Layer.effectContext(
+    this.#runtime.runtimeEffect.pipe(Effect.map((rt) => rt.context.pipe(Context.pick(ClientConfig)))),
+  );
+
+  async dispose() {
+    await this.#runtime.dispose();
+  }
+}
+
+class ClientPlugin {
+  constructor(private readonly _serverPlugin: ServerPlugin) {}
+
+  async run() {
+    const layer = Layer.provide(Client.layer, this._serverPlugin.clientConfigLayer);
+
+    await Effect.runPromise(
+      Effect.gen(function* () {
+        const client = yield* Client;
+        yield* client.call();
+      }).pipe(Effect.provide(layer)),
+    );
+  }
+}
+
+test.skip('plugins', async () => {
+  const serverPlugin = new ServerPlugin();
+  console.log('ServerPlugin created');
+
+  await Effect.runPromise(Effect.sleep(Duration.millis(500)));
+  console.log('wake up');
+
+  {
+    const clientPlugin1 = new ClientPlugin(serverPlugin);
+    console.log('ClientPlugin1 created');
+    await clientPlugin1.run();
+    console.log('client1 run');
+  }
+
+  {
+    const clientPlugin2 = new ClientPlugin(serverPlugin);
+    console.log('ClientPlugin2 created');
+    await clientPlugin2.run();
+    console.log('client2 run');
+  }
+
+  await serverPlugin.dispose();
+});

package/src/resource.test.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { it } from '@effect/vitest';
+import { Effect } from 'effect';
+
+import { accuireReleaseResource } from './resource';
+
+it.effect(
+  'acquire-release',
+  Effect.fn(function* ({ expect }) {
+    const events: string[] = [];
+    const makeResource = accuireReleaseResource(() => ({
+      open: () => {
+        events.push('open');
+      },
+      close: () => {
+        events.push('close');
+      },
+    }));
+
+    yield* Effect.gen(function* () {
+      events.push('1');
+      const _resource = yield* makeResource;
+      events.push('2');
+    }).pipe(Effect.scoped);
+
+    events.push('3');
+    expect(events).to.deep.equal(['1', 'open', '2', 'close', '3']);
+  }),
+);

package/src/resource.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Effect } from 'effect';
+
+import type { Lifecycle } from '@dxos/context';
+
+// TODO(dmaretskyi): Extract to effect-utils.
+export const accuireReleaseResource = <T extends Lifecycle>(getResource: () => T) =>
+  Effect.acquireRelease(
+    Effect.gen(function* () {
+      const resource = getResource();
+      yield* Effect.promise(async () => {
+        resource.open?.();
+        return undefined;
+      });
+      return resource;
+    }),
+    (resource) =>
+      Effect.promise(async () => {
+        resource.close?.();
+        return undefined;
+      }),
+  );

package/src/testing.ts

@@ -0,0 +1,79 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Effect } from 'effect';
+import type { TestContext } from 'vitest';
+
+// TODO(dmaretskyi): Add all different test tags here.
+export type TestTag = 'flaky' | 'llm';
+
+export namespace TestHelpers {
+  /**
+   * Skip the test if the condition is false.
+   *
+   * Exmaple:
+   * ```ts
+   * it.effect(
+   *   'should process an agentic loop using Claude',
+   *   Effect.fn(function* ({ expect }) {
+   *     // ...
+   *   }),
+   *   TestHelpers.runIf(process.env.ANTHROPIC_API_KEY),
+   * );
+   * ```
+   */
+  export const runIf =
+    (condition: unknown) =>
+    <A, E, R>(effect: Effect.Effect<A, E, R>, ctx: TestContext): Effect.Effect<A, E, R> =>
+      Effect.gen(function* () {
+        if (!condition) {
+          ctx.skip();
+        } else {
+          return yield* effect;
+        }
+      });
+
+  /**
+   * Skip the test if the condition is true.
+   *
+   * Exmaple:
+   * ```ts
+   * it.effect(
+   *   'should process an agentic loop using Claude',
+   *   Effect.fn(function* ({ expect }) {
+   *     // ...
+   *   }),
+   *   TestHelpers.skipIf(!process.env.ANTHROPIC_API_KEY),
+   * );
+   * ```
+   */
+  export const skipIf =
+    (condition: unknown) =>
+    <A, E, R>(effect: Effect.Effect<A, E, R>, ctx: TestContext): Effect.Effect<A, E, R> =>
+      Effect.gen(function* () {
+        if (condition) {
+          ctx.skip();
+        } else {
+          return yield* effect;
+        }
+      });
+
+  /**
+   * Skips this test if the tag is not in the list of tags to run.
+   * Tags are specified in the `DX_TEST_TAGS` environment variable.
+   *
+   * @param tag
+   * @returns
+   */
+  export const taggedTest =
+    (tag: TestTag) =>
+    <A, E, R>(effect: Effect.Effect<A, E, R>, ctx: TestContext): Effect.Effect<A, E, R> =>
+      Effect.gen(function* () {
+        if (!process.env.DX_TEST_TAGS?.includes(tag)) {
+          ctx.skip();
+        } else {
+          return yield* effect;
+        }
+      });
+}

package/src/url.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { SchemaAST, type Schema, Option, pipe } from 'effect';
+import { Option, type Schema, SchemaAST, pipe } from 'effect';
 
 import { decamelize } from '@dxos/util';