@dxos/effect 0.8.4-main.406dc2a → 0.8.4-main.59c2e9b

package/src/errors.ts

@@ -8,6 +8,7 @@ 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 * as Runtime from 'effect/Runtime';
 import type * as Tracer from 'effect/Tracer';
 
 const spanSymbol = Symbol.for('effect/SpanAnnotation');
@@ -21,6 +22,10 @@ const locationRegex = /\((.*)\)/g;
  * Unwraps error proxy.
  */
 const prettyErrorStack = (error: any, appendStacks: string[] = []): any => {
+  if (typeof error !== 'object' || error === null) {
+    return error;
+  }
+
   const span = error[spanSymbol];
 
   const lines = typeof error.stack === 'string' ? error.stack.split('\n') : [];
@@ -118,9 +123,10 @@ export const causeToError = (cause: Cause.Cause<any>): Error => {
     const errors = [...Chunk.toArray(Cause.failures(cause)), ...Chunk.toArray(Cause.defects(cause))];
 
     const getStackFrames = (): string[] => {
-      const o: { stack: string } = {} as any;
+      // Bun requies the target object for `captureStackTrace` to be an Error.
+      const o = new Error();
       Error.captureStackTrace(o, getStackFrames);
-      return o.stack.split('\n').slice(1);
+      return o.stack!.split('\n').slice(1);
     };
 
     const stackFrames = getStackFrames();
@@ -174,6 +180,15 @@ export const runAndForwardErrors = async <A, E>(
   return unwrapExit(exit);
 };
 
+export const runInRuntime = async <A, E, R>(
+  runtime: Runtime.Runtime<R>,
+  effect: Effect.Effect<A, E, R>,
+  options?: { signal?: AbortSignal },
+): Promise<A> => {
+  const exit = await Runtime.runPromiseExit(runtime, effect, options);
+  return unwrapExit(exit);
+};
+
 /**
  * Like `Effect.promise` but also caputes spans for defects.
  * Workaround for: https://github.com/Effect-TS/effect/issues/5436

package/src/index.ts

@@ -3,9 +3,11 @@
 //
 
 export * from './ast';
-export * from './jsonPath';
-export * from './url';
+export * from './atom-kvs';
 export * from './context';
+export * as DynamicRuntime from './dynamic-runtime';
 export * from './errors';
-export * from './testing';
+export * from './json-path';
 export * from './resource';
+export * from './url';
+export * as RuntimeProvider from './RuntimeProvider';

package/src/interrupt.test.ts

@@ -7,6 +7,8 @@ import * as Cause from 'effect/Cause';
 import * as Effect from 'effect/Effect';
 import * as Fiber from 'effect/Fiber';
 
+import { runAndForwardErrors } from './errors';
+
 const doWork = Effect.fn('doWork')(function* () {
   yield* Effect.sleep('1 minute');
   return 'work done';
@@ -18,7 +20,7 @@ it.effect.skip(
     function* (_) {
       const resultFiber = yield* doWork().pipe(Effect.fork);
       setTimeout(() => {
-        void Effect.runPromise(Fiber.interrupt(resultFiber));
+        void runAndForwardErrors(Fiber.interrupt(resultFiber));
       }, 2_000);
 
       const result = yield* resultFiber;

package/src/{jsonPath.test.ts → json-path.test.ts}

@@ -4,7 +4,7 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { type JsonPath, createJsonPath, getField, isJsonPath, splitJsonPath } from './jsonPath';
+import { type JsonPath, createJsonPath, getField, getValue, isJsonPath, setValue, splitJsonPath } from './json-path';
 
 describe('createJsonPath', () => {
   test('supported path subset', () => {
@@ -32,9 +32,9 @@ describe('createJsonPath', () => {
 
   test('path splitting', () => {
     const cases = [
-      ['foo.bar[0].baz', ['foo', 'bar', '0', 'baz']],
-      ['users[1].name', ['users', '1', 'name']],
-      ['data[0][1]', ['data', '0', '1']],
+      ['foo.bar[0].baz', ['foo', 'bar', 0, 'baz']],
+      ['users[1].name', ['users', 1, 'name']],
+      ['data[0][1]', ['data', 0, 1]],
       ['simple.path', ['simple', 'path']],
       ['root', ['root']],
     ] as const;
@@ -47,15 +47,15 @@ describe('createJsonPath', () => {
   test('path splitting - extended cases', () => {
     const cases = [
       // Multiple consecutive array indices.
-      ['matrix[0][1][2]', ['matrix', '0', '1', '2']],
+      ['matrix[0][1][2]', ['matrix', 0, 1, 2]],
       // Properties with underscores and $.
       ['$_foo.bar_baz', ['$_foo', 'bar_baz']],
       // Deep nesting.
-      ['very.deep.nested[0].property.path[5]', ['very', 'deep', 'nested', '0', 'property', 'path', '5']],
+      ['very.deep.nested[0].property.path[5]', ['very', 'deep', 'nested', 0, 'property', 'path', 5]],
       // Single character properties.
-      ['a[0].b.c', ['a', '0', 'b', 'c']],
+      ['a[0].b.c', ['a', 0, 'b', 'c']],
       // Properties containing numbers.
-      ['prop123.item456[7]', ['prop123', 'item456', '7']],
+      ['prop123.item456[7]', ['prop123', 'item456', 7]],
     ] as const;
 
     cases.forEach(([input, expected]) => {
@@ -99,3 +99,42 @@ describe('createJsonPath', () => {
     expect(getField({ a: 'foo' }, 'a' as JsonPath)).toBe('foo');
   });
 });
+
+describe('Types', () => {
+  test('checks sanity', async ({ expect }) => {
+    const obj = {};
+    expect(obj).to.exist;
+  });
+});
+
+describe('get/set deep', () => {
+  test('get/set operations', ({ expect }) => {
+    const obj = {
+      name: 'test',
+      items: ['a', 'b', 'c'],
+      nested: {
+        prop: 'value',
+        arr: [1, 2, 3],
+      },
+    };
+
+    // Basic property access.
+    expect(getValue(obj, 'name' as JsonPath)).toBe('test');
+
+    // Array index access.
+    expect(getValue(obj, 'items[1]' as JsonPath)).toBe('b');
+
+    // Nested property access.
+    expect(getValue(obj, 'nested.prop' as JsonPath)).toBe('value');
+
+    // Nested array access.
+    expect(getValue(obj, 'nested.arr[2]' as JsonPath)).toBe(3);
+
+    // Setting values.
+    const updated1 = setValue(obj, 'items[1]' as JsonPath, 'x');
+    expect(updated1.items[1]).toBe('x');
+
+    const updated2 = setValue(obj, 'nested.arr[0]' as JsonPath, 99);
+    expect(updated2.nested.arr[0]).toBe(99);
+  });
+});

package/src/{jsonPath.ts → json-path.ts}

@@ -7,16 +7,21 @@ import * as Schema from 'effect/Schema';
 import { JSONPath } from 'jsonpath-plus';
 
 import { invariant } from '@dxos/invariant';
+import { getDeep, setDeep } from '@dxos/util';
 
 export type JsonProp = string & { __JsonPath: true; __JsonProp: true };
 export type JsonPath = string & { __JsonPath: true };
 
+// TODO(burdon): Start with "$."?
+
 const PATH_REGEX = /^($|[a-zA-Z_$][\w$]*(?:\.[a-zA-Z_$][\w$]*|\[\d+\](?:\.)?)*$)/;
+
 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',
@@ -50,7 +55,7 @@ export const isJsonPath = (value: unknown): value is JsonPath => {
  * @param path Array of string or number segments
  * @returns Valid JsonPath or undefined if invalid
  */
-export const createJsonPath = (path: (string | number)[]): JsonPath => {
+export const createJsonPath = (path: readonly (string | number)[]): JsonPath => {
   const candidatePath = path
     .map((p, i) => {
       if (typeof p === 'number') {
@@ -80,7 +85,7 @@ export const fromEffectValidationPath = (effectPath: string): JsonPath => {
  * Splits a JsonPath into its constituent parts.
  * Handles property access and array indexing.
  */
-export const splitJsonPath = (path: JsonPath): string[] => {
+export const splitJsonPath = (path: JsonPath): (string | number)[] => {
   if (!isJsonPath(path)) {
     return [];
   }
@@ -88,14 +93,33 @@ export const splitJsonPath = (path: JsonPath): string[] => {
   return (
     path
       .match(/[a-zA-Z_$][\w$]*|\[\d+\]/g)
-      ?.map((part) => (part.startsWith('[') ? part.replace(/[[\]]/g, '') : part)) ?? []
+      ?.map((part) => part.replace(/[[\]]/g, ''))
+      .map((part) => {
+        const parsed = Number.parseInt(part, 10);
+        return Number.isNaN(parsed) ? part : parsed;
+      }) ?? []
   );
 };
 
 /**
  * Applies a JsonPath to an object.
  */
+// TODO(burdon): Reconcile with getValue.
 export const getField = (object: any, path: JsonPath): any => {
   // By default, JSONPath returns an array of results.
   return JSONPath({ path, json: object })[0];
 };
+
+/**
+ * Get value from object using JsonPath.
+ */
+export const getValue = <T extends object>(obj: T, path: JsonPath): any => {
+  return getDeep(obj, splitJsonPath(path));
+};
+
+/**
+ * Set value on object using JsonPath.
+ */
+export const setValue = <T extends object>(obj: T, path: JsonPath, value: any): T => {
+  return setDeep(obj, splitJsonPath(path), value);
+};

package/src/layers.test.ts

@@ -10,6 +10,8 @@ import * as Layer from 'effect/Layer';
 import * as ManagedRuntime from 'effect/ManagedRuntime';
 import { test } from 'vitest';
 
+import { runAndForwardErrors } from './errors';
+
 class ClientConfig extends Context.Tag('ClientConfig')<ClientConfig, { endpoint: string }>() {}
 
 class Client extends Context.Tag('Client')<Client, { call: () => Effect.Effect<void> }>() {
@@ -76,7 +78,7 @@ class ClientPlugin {
   async run() {
     const layer = Layer.provide(Client.layer, this._serverPlugin.clientConfigLayer);
 
-    await Effect.runPromise(
+    await runAndForwardErrors(
       Effect.gen(function* () {
         const client = yield* Client;
         yield* client.call();
@@ -89,7 +91,7 @@ test.skip('plugins', async () => {
   const serverPlugin = new ServerPlugin();
   console.log('ServerPlugin created');
 
-  await Effect.runPromise(Effect.sleep(Duration.millis(500)));
+  await runAndForwardErrors(Effect.sleep(Duration.millis(500)));
   console.log('wake up');
 
   {

package/src/otel.test.ts

@@ -76,6 +76,7 @@ const makeOtelLogProcessor = (logger: Logger): LogProcessor => {
     });
   };
 };
+
 log.addProcessor(makeOtelLogProcessor(logger));
 
 beforeAll(() => {

package/src/resource.ts

@@ -3,23 +3,28 @@
 //
 
 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 acquireReleaseResource = <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();
       yield* Effect.promise(async () => {
-        resource.open?.();
+        await resource.open?.();
         return undefined;
       });
       return resource;
     }),
     (resource) =>
       Effect.promise(async () => {
-        resource.close?.();
+        await resource.close?.();
         return undefined;
       }),
   );

package/src/sanity.test.ts

@@ -8,6 +8,8 @@ import { describe, test } from 'vitest';
 
 import { log } from '@dxos/log';
 
+import { runAndForwardErrors } from './errors';
+
 describe('sanity tests', () => {
   test('function pipeline', async ({ expect }) => {
     const result = Function.pipe(
@@ -19,35 +21,47 @@ describe('sanity tests', () => {
   });
 
   test('effect pipeline (mixing types)', async ({ expect }) => {
-    const result = await Effect.runPromise(
+    const result = await runAndForwardErrors(
       Function.pipe(
         Effect.promise(() => Promise.resolve(100)),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
         Effect.map((value: number) => String(value)),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
         Effect.map((value: string) => value.length),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
       ),
     );
     expect(result).to.eq(3);
   });
 
   test('effect pipeline (mixing sync/async)', async ({ expect }) => {
-    const result = await Effect.runPromise(
+    const result = await runAndForwardErrors(
       Function.pipe(
         Effect.succeed(100),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
         Effect.flatMap((value) => Effect.promise(() => Promise.resolve(String(value)))),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
         Effect.map((value) => value.length),
-        Effect.tap((value) => log('tap', { value })),
+        Effect.tap((value) => {
+          log('tap', { value });
+        }),
       ),
     );
     expect(result).to.eq(3);
   });
 
   test('error handling', async ({ expect }) => {
-    Effect.runPromise(
+    runAndForwardErrors(
       Function.pipe(
         Effect.succeed(10),
         Effect.map((value) => value * 2),
@@ -63,7 +77,7 @@ describe('sanity tests', () => {
       ),
     )
       .then(() => expect.fail())
-      .catch((error) => {
+      .catch((error: any) => {
         expect(error).to.be.instanceOf(Error);
       });
   });

package/dist/types/src/jsonPath.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonPath.d.ts","sourceRoot":"","sources":["../../../src/jsonPath.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAKxC,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC;AACvE,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC;AAKrD;;GAEG;AACH,eAAO,MAAM,QAAQ,EAGR,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACrC,eAAO,MAAM,QAAQ,EAIT,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAEpC,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,QAEpD,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAG,QAa1D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,YAAY,MAAM,KAAG,QAK7D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,QAAQ,KAAG,MAAM,EAUpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,GAAG,EAAE,MAAM,QAAQ,KAAG,GAGtD,CAAC"}

package/dist/types/src/jsonPath.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=jsonPath.test.d.ts.map

package/dist/types/src/jsonPath.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonPath.test.d.ts","sourceRoot":"","sources":["../../../src/jsonPath.test.ts"],"names":[],"mappings":""}