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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/effect",
-  "version": "0.8.4-main.fd6878d",
+  "version": "0.8.4-main.fffef41",
   "description": "Effect utils.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -24,15 +24,23 @@
     "src"
   ],
   "dependencies": {
+    "@effect/opentelemetry": "^0.58.0",
+    "@opentelemetry/api": "^1.9.0",
     "jsonpath-plus": "10.2.0",
-    "@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"
+    "@dxos/context": "0.8.4-main.fffef41",
+    "@dxos/invariant": "0.8.4-main.fffef41",
+    "@dxos/node-std": "0.8.4-main.fffef41",
+    "@dxos/util": "0.8.4-main.fffef41"
   },
   "devDependencies": {
-    "effect": "3.17.7",
-    "@dxos/log": "0.8.4-main.fd6878d"
+    "@opentelemetry/api-logs": "^0.203.0",
+    "@opentelemetry/resources": "^2.1.0",
+    "@opentelemetry/sdk-logs": "^0.203.0",
+    "@opentelemetry/sdk-node": "^0.203.0",
+    "@opentelemetry/sdk-trace-node": "^2.1.0",
+    "@opentelemetry/semantic-conventions": "^1.37.0",
+    "effect": "3.18.3",
+    "@dxos/log": "0.8.4-main.fffef41"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/ast.test.ts

@@ -2,7 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema, SchemaAST } from 'effect';
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
 import { describe, test } from 'vitest';
 
 import { invariant } from '@dxos/invariant';

package/src/ast.ts

@@ -2,8 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Option, Schema, SchemaAST, pipe } from 'effect';
-import { isUndefinedKeyword } from 'effect/SchemaAST';
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
 
 import { invariant } from '@dxos/invariant';
 import { isNonNullable } from '@dxos/util';
@@ -17,8 +19,14 @@ import { type JsonPath, type JsonProp } from './jsonPath';
 // https://effect-ts.github.io/effect/schema/SchemaAST.ts.html
 //
 
+// TODO(wittjosiah): What is a "simple type"?
 export type SimpleType = 'object' | 'string' | 'number' | 'boolean' | 'enum' | 'literal';
 
+const isTupleType = (node: SchemaAST.AST): boolean => {
+  // NOTE: Arrays are represented as tuples with no elements and a rest part.
+  return SchemaAST.isTupleType(node) && node.elements.length > 0;
+};
+
 /**
  * Get the base type; e.g., traverse through refinements.
  */
@@ -27,6 +35,8 @@ export const getSimpleType = (node: SchemaAST.AST): SimpleType | undefined => {
     SchemaAST.isDeclaration(node) ||
     SchemaAST.isObjectKeyword(node) ||
     SchemaAST.isTypeLiteral(node) ||
+    // TODO(wittjosiah): Tuples are actually arrays.
+    isTupleType(node) ||
     isDiscriminatedUnion(node)
   ) {
     return 'object';
@@ -127,15 +137,15 @@ const visitNode = (
   path: Path = [],
   depth = 0,
 ): VisitResult | undefined => {
-  const _result = test?.(node, path, depth);
+  const $result = test?.(node, path, depth);
   const result: VisitResult =
-    _result === undefined
+    $result === undefined
       ? VisitResult.CONTINUE
-      : typeof _result === 'boolean'
-        ? _result
+      : typeof $result === 'boolean'
+        ? $result
           ? VisitResult.CONTINUE
           : VisitResult.SKIP
-        : _result;
+        : $result;
 
   if (result === VisitResult.EXIT) {
     return result;
@@ -204,6 +214,12 @@ export const findNode = (node: SchemaAST.AST, test: (node: SchemaAST.AST) => boo
         return child;
       }
     }
+    for (const prop of getIndexSignatures(node)) {
+      const child = findNode(prop.type, test);
+      if (child) {
+        return child;
+      }
+    }
   }
 
   // Tuple.
@@ -218,12 +234,14 @@ export const findNode = (node: SchemaAST.AST, test: (node: SchemaAST.AST) => boo
 
   // Branching union (e.g., optional, discriminated unions).
   else if (SchemaAST.isUnion(node)) {
-    if (isOption(node)) {
-      for (const type of node.types) {
-        const child = findNode(type, test);
-        if (child) {
-          return child;
-        }
+    if (isLiteralUnion(node)) {
+      return undefined;
+    }
+
+    for (const type of node.types) {
+      const child = findNode(type, test);
+      if (child) {
+        return child;
       }
     }
   }
@@ -279,8 +297,8 @@ export const getAnnotation =
   <T>(annotationId: symbol, noDefault = true) =>
   (node: SchemaAST.AST): T | undefined => {
     // Title fallback seems to be the identifier.
-    const id = pipe(SchemaAST.getIdentifierAnnotation(node), Option.getOrUndefined);
-    const value = pipe(SchemaAST.getAnnotation<T>(annotationId)(node), Option.getOrUndefined);
+    const id = Function.pipe(SchemaAST.getIdentifierAnnotation(node), Option.getOrUndefined);
+    const value = Function.pipe(SchemaAST.getAnnotation<T>(annotationId)(node), Option.getOrUndefined);
     if (noDefault && (value === defaultAnnotations[node._tag]?.annotations[annotationId] || value === id)) {
       return undefined;
     }
@@ -432,6 +450,7 @@ export const mapAst = (
             ),
         ),
         ast.indexSignatures,
+        ast.annotations,
       );
     }
     case 'Union': {
@@ -464,7 +483,23 @@ export const isArrayType = (node: SchemaAST.AST): boolean => {
     SchemaAST.isTupleType(node) ||
     (SchemaAST.isUnion(node) &&
       node.types.some(isArrayType) &&
-      node.types.some(isUndefinedKeyword) &&
+      node.types.some(SchemaAST.isUndefinedKeyword) &&
       node.types.length === 2)
   );
 };
+
+const getIndexSignatures = (ast: SchemaAST.AST): Array<SchemaAST.IndexSignature> => {
+  const annotation = SchemaAST.getSurrogateAnnotation(ast);
+  if (Option.isSome(annotation)) {
+    return getIndexSignatures(annotation.value);
+  }
+  switch (ast._tag) {
+    case 'TypeLiteral':
+      return ast.indexSignatures.slice();
+    case 'Suspend':
+      return getIndexSignatures(ast.f());
+    case 'Refinement':
+      return getIndexSignatures(ast.from);
+  }
+  return [];
+};

package/src/context.ts

@@ -2,7 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Effect, type Scope } from 'effect';
+import * as Effect from 'effect/Effect';
+import type * as Scope from 'effect/Scope';
 
 import { Context } from '@dxos/context';
 

package/src/errors.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Data } from 'effect';
+import * as Data from 'effect/Data';
 import { test } from 'vitest';
 
 class MyError extends Data.TaggedError('MyError')<{

package/src/errors.ts

@@ -2,8 +2,13 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Cause, Chunk, Effect, Exit, GlobalValue, Option } from 'effect';
-import type { AnySpan, Span } from 'effect/Tracer';
+import * as Cause from 'effect/Cause';
+import * as Chunk from 'effect/Chunk';
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+import * as GlobalValue from 'effect/GlobalValue';
+import * as Option from 'effect/Option';
+import type * as Tracer from 'effect/Tracer';
 
 const spanSymbol = Symbol.for('effect/SpanAnnotation');
 const originalSymbol = Symbol.for('effect/OriginalAnnotation');
@@ -48,7 +53,7 @@ const prettyErrorStack = (error: any, appendStacks: string[] = []): any => {
   }
 
   if (span) {
-    let current: Span | AnySpan | undefined = span;
+    let current: Tracer.Span | Tracer.AnySpan | undefined = span;
     let i = 0;
     while (current && current._tag === 'Span' && i < 10) {
       const stackFn = spanToTrace.get(current);
@@ -95,7 +100,7 @@ const prettyErrorStack = (error: any, appendStacks: string[] = []): any => {
 };
 
 /**
- * Runs the embedded effect asynchronously and throws any failures and defects as errors.
+ * Converts a cause to an error.
  * Inserts effect spans as stack frames.
  * The error will have stack frames of where the effect was run (if stack trace limit allows).
  * Removes effect runtime internal stack frames.
@@ -104,21 +109,13 @@ const prettyErrorStack = (error: any, appendStacks: string[] = []): any => {
  *
  * @throws AggregateError if there are multiple errors.
  */
-export const runAndForwardErrors = async <A, E>(
-  effect: Effect.Effect<A, E, never>,
-  options?: { signal?: AbortSignal },
-): Promise<A> => {
-  const exit = await Effect.runPromiseExit(effect, options);
-  if (Exit.isSuccess(exit)) {
-    return exit.value;
-  }
-
-  if (Cause.isEmpty(exit.cause)) {
-    throw new Error('Fiber failed without a cause');
-  } else if (Cause.isInterrupted(exit.cause)) {
-    throw new Error('Fiber was interrupted');
+export const causeToError = (cause: Cause.Cause<any>): Error => {
+  if (Cause.isEmpty(cause)) {
+    return new Error('Fiber failed without a cause');
+  } else if (Cause.isInterruptedOnly(cause)) {
+    return new Error('Fiber was interrupted');
   } else {
-    const errors = [...Chunk.toArray(Cause.failures(exit.cause)), ...Chunk.toArray(Cause.defects(exit.cause))];
+    const errors = [...Chunk.toArray(Cause.failures(cause)), ...Chunk.toArray(Cause.defects(cause))];
 
     const getStackFrames = (): string[] => {
       const o: { stack: string } = {} as any;
@@ -130,9 +127,65 @@ export const runAndForwardErrors = async <A, E>(
     const newErrors = errors.map((error) => prettyErrorStack(error, stackFrames));
 
     if (newErrors.length === 1) {
-      throw newErrors[0];
+      return newErrors[0];
     } else {
-      throw new AggregateError(newErrors);
+      return new AggregateError(newErrors);
     }
   }
 };
+
+/**
+ * Throws an error based on the cause.
+ * Inserts effect spans as stack frames.
+ * The error will have stack frames of where the effect was run (if stack trace limit allows).
+ * Removes effect runtime internal stack frames.
+ *
+ * To be used in place of `Effect.runPromise`.
+ *
+ * @throws AggregateError if there are multiple errors.
+ */
+export const throwCause = (cause: Cause.Cause<any>): never => {
+  throw causeToError(cause);
+};
+
+export const unwrapExit = <A>(exit: Exit.Exit<A, any>): A => {
+  if (Exit.isSuccess(exit)) {
+    return exit.value;
+  }
+
+  return throwCause(exit.cause);
+};
+
+/**
+ * Runs the embedded effect asynchronously and throws any failures and defects as errors.
+ * Inserts effect spans as stack frames.
+ * The error will have stack frames of where the effect was run (if stack trace limit allows).
+ * Removes effect runtime internal stack frames.
+ *
+ * To be used in place of `Effect.runPromise`.
+ *
+ * @throws AggregateError if there are multiple errors.
+ */
+export const runAndForwardErrors = async <A, E>(
+  effect: Effect.Effect<A, E, never>,
+  options?: { signal?: AbortSignal },
+): Promise<A> => {
+  const exit = await Effect.runPromiseExit(effect, options);
+  return unwrapExit(exit);
+};
+
+/**
+ * Like `Effect.promise` but also caputes spans for defects.
+ * Workaround for: https://github.com/Effect-TS/effect/issues/5436
+ */
+export const promiseWithCauseCapture: <A>(evaluate: (signal: AbortSignal) => PromiseLike<A>) => Effect.Effect<A> = (
+  evaluate,
+) =>
+  Effect.promise(async (signal) => {
+    try {
+      const result = await evaluate(signal);
+      return Effect.succeed(result);
+    } catch (err) {
+      return Effect.die(err);
+    }
+  }).pipe(Effect.flatten);

package/src/interrupt.test.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { it } from '@effect/vitest';
+import * as Cause from 'effect/Cause';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+
+const doWork = Effect.fn('doWork')(function* () {
+  yield* Effect.sleep('1 minute');
+  return 'work done';
+});
+
+it.effect.skip(
+  'call a function to generate a research report',
+  Effect.fnUntraced(
+    function* (_) {
+      const resultFiber = yield* doWork().pipe(Effect.fork);
+      setTimeout(() => {
+        void Effect.runPromise(Fiber.interrupt(resultFiber));
+      }, 2_000);
+
+      const result = yield* resultFiber;
+      console.log({ result });
+    },
+    Effect.catchAllCause((cause) => {
+      // console.log(inspect(cause, { depth: null, colors: true }));
+      console.log(Cause.pretty(cause));
+      return Effect.failCause(cause);
+    }),
+  ),
+);

package/src/jsonPath.ts

@@ -2,7 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Option, Schema } from 'effect';
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
 import { JSONPath } from 'jsonpath-plus';
 
 import { invariant } from '@dxos/invariant';
@@ -16,6 +17,7 @@ const PROP_REGEX = /^\w+$/;
 /**
  * https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html
  */
+// TODO(burdon): Keys could be arbitrary strings.
 export const JsonPath = Schema.String.pipe(Schema.pattern(PATH_REGEX)).annotations({
   title: 'JSON path',
   description: 'JSON path to a property',

package/src/layers.test.ts

@@ -3,7 +3,11 @@
 //
 
 import { it } from '@effect/vitest';
-import { Context, Duration, Effect, Layer, ManagedRuntime } from 'effect';
+import * as Context from 'effect/Context';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as ManagedRuntime from 'effect/ManagedRuntime';
 import { test } from 'vitest';
 
 class ClientConfig extends Context.Tag('ClientConfig')<ClientConfig, { endpoint: string }>() {}
@@ -46,7 +50,7 @@ const ServerLive = Layer.scoped(
 it.effect.skip(
   'test',
   Effect.fn(
-    function* ({ expect: _ }) {
+    function* (_) {
       const client = yield* Client;
       yield* client.call();
     },

package/src/otel.test.ts

@@ -0,0 +1,126 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { afterAll, beforeAll, it } from '@effect/vitest';
+import { SpanStatusCode, trace } from '@opentelemetry/api';
+import { type Logger, SeverityNumber, logs } from '@opentelemetry/api-logs';
+import { resourceFromAttributes } from '@opentelemetry/resources';
+import { ConsoleLogRecordExporter, LoggerProvider, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-node';
+import {
+  ATTR_CODE_FILE_PATH,
+  ATTR_CODE_LINE_NUMBER,
+  ATTR_CODE_STACKTRACE,
+  ATTR_SERVICE_NAME,
+} from '@opentelemetry/semantic-conventions';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import { beforeEach } from 'vitest';
+
+import { LogLevel, type LogProcessor, log } from '@dxos/log';
+
+import { layerOtel } from './otel';
+
+const resource = resourceFromAttributes({
+  [ATTR_SERVICE_NAME]: 'test',
+});
+
+const sdk = new NodeSDK({
+  traceExporter: new ConsoleSpanExporter(),
+  resource,
+});
+
+// and add a processor to export log record
+const loggerProvider = new LoggerProvider({
+  processors: [new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())],
+  resource,
+});
+logs.setGlobalLoggerProvider(loggerProvider);
+
+// You can also use global singleton
+const logger = logs.getLogger('test');
+
+const makeOtelLogProcessor = (logger: Logger): LogProcessor => {
+  return (config, entry) => {
+    let severity: SeverityNumber = SeverityNumber.UNSPECIFIED;
+    switch (entry.level) {
+      case LogLevel.DEBUG:
+        severity = SeverityNumber.DEBUG;
+        break;
+      case LogLevel.INFO:
+        severity = SeverityNumber.INFO;
+        break;
+      case LogLevel.WARN:
+        severity = SeverityNumber.WARN;
+        break;
+      case LogLevel.ERROR:
+        severity = SeverityNumber.ERROR;
+        break;
+    }
+
+    logger.emit({
+      body: entry.error ? ('stack' in entry.error ? entry.error.stack : String(entry.error)) : entry.message,
+      severityNumber: severity,
+      attributes: {
+        [ATTR_CODE_FILE_PATH]: entry.meta?.F,
+        [ATTR_CODE_LINE_NUMBER]: entry.meta?.L,
+        [ATTR_CODE_STACKTRACE]: entry.error?.stack,
+        ...(typeof entry.context === 'object'
+          ? entry.context
+          : {
+              ctx: entry.context,
+            }),
+      },
+    });
+  };
+};
+
+log.addProcessor(makeOtelLogProcessor(logger));
+
+beforeAll(() => {
+  sdk.start();
+});
+
+afterAll(async () => {
+  await loggerProvider.shutdown();
+  await sdk.shutdown();
+});
+
+beforeEach((ctx) => {
+  const span = trace.getTracer('testing-framework').startSpan(ctx.task.name);
+  ctx.onTestFailed((ctx) => {
+    // TODO(dmaretskyi): Record result.
+    span.setStatus({ code: SpanStatusCode.ERROR });
+    span.end();
+  });
+  ctx.onTestFinished((ctx) => {
+    span.setStatus({ code: SpanStatusCode.OK });
+    span.end();
+  });
+});
+
+const foo = Effect.fn('foo')(function* () {
+  yield* Effect.sleep(Duration.millis(100));
+
+  log('log inside foo', { detail: 123 });
+});
+
+const bar = Effect.fn('bar')(function* () {
+  yield* foo();
+});
+
+const baz = Effect.fn('baz')(function* () {
+  yield* bar();
+});
+
+it.live(
+  'Test Suite One',
+  Effect.fnUntraced(
+    function* () {
+      yield* baz();
+    },
+    Effect.provide(layerOtel(Effect.succeed({}))),
+  ),
+);

package/src/otel.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Resource from '@effect/opentelemetry/Resource';
+import * as Tracer from '@effect/opentelemetry/Tracer';
+import { type Attributes, trace } from '@opentelemetry/api';
+import * as Effect from 'effect/Effect';
+import type * as Function from 'effect/Function';
+import * as Layer from 'effect/Layer';
+
+export interface Configuration {
+  readonly resource?:
+    | {
+        readonly serviceName: string;
+        readonly serviceVersion?: string;
+        readonly attributes?: Attributes;
+      }
+    | undefined;
+}
+
+// Based on https://github.com/Effect-TS/effect/blob/main/packages/opentelemetry/src/NodeSdk.ts
+export const layerOtel: {
+  (evaluate: Function.LazyArg<Configuration>): Layer.Layer<Resource.Resource>;
+  <R, E>(evaluate: Effect.Effect<Configuration, E, R>): Layer.Layer<Resource.Resource, E, R>;
+} = (
+  evaluate: Function.LazyArg<Configuration> | Effect.Effect<Configuration, any, any>,
+): Layer.Layer<Resource.Resource> =>
+  Layer.unwrapEffect(
+    Effect.map(
+      Effect.isEffect(evaluate) ? (evaluate as Effect.Effect<Configuration>) : Effect.sync(evaluate),
+      (config) => {
+        const ResourceLive = Resource.layerFromEnv(config.resource && Resource.configToAttributes(config.resource));
+
+        const provider = trace.getTracerProvider();
+        const TracerLive = Layer.provide(Tracer.layer, Layer.succeed(Tracer.OtelTracerProvider, provider));
+
+        // TODO(wittjosiah): Add metrics and logger layers.
+        const MetricsLive = Layer.empty;
+        const LoggerLive = Layer.empty;
+
+        return Layer.mergeAll(TracerLive, MetricsLive, LoggerLive).pipe(Layer.provideMerge(ResourceLive));
+      },
+    ),
+  );

package/src/resource.test.ts

@@ -3,15 +3,15 @@
 //
 
 import { it } from '@effect/vitest';
-import { Effect } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { accuireReleaseResource } from './resource';
+import { acquireReleaseResource } from './resource';
 
 it.effect(
   'acquire-release',
   Effect.fn(function* ({ expect }) {
     const events: string[] = [];
-    const makeResource = accuireReleaseResource(() => ({
+    const makeResource = acquireReleaseResource(() => ({
       open: () => {
         events.push('open');
       },

package/src/resource.ts

@@ -2,12 +2,17 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Effect } from 'effect';
+import * as Effect from 'effect/Effect';
+import type * as Scope from 'effect/Scope';
 
 import type { Lifecycle } from '@dxos/context';
 
-// TODO(dmaretskyi): Extract to effect-utils.
-export const accuireReleaseResource = <T extends Lifecycle>(getResource: () => T) =>
+/**
+ * Acquires a resource and releases it when the scope is closed.
+ */
+export const acquireReleaseResource = <T extends Lifecycle>(
+  getResource: () => T,
+): Effect.Effect<T, never, Scope.Scope> =>
   Effect.acquireRelease(
     Effect.gen(function* () {
       const resource = getResource();