@dxos/app-framework 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/src/plugin-operation/history/undo-registry.test.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { Compute, HalveCompute } from '../testing';
+
+import * as UndoMapping from './undo-mapping';
+import * as UndoRegistry from './undo-registry';
+
+describe('UndoRegistry', () => {
+  test('looks up undo mapping by operation key', ({ expect }) => {
+    const undoMapping = UndoMapping.make({
+      operation: Compute,
+      inverse: HalveCompute,
+      deriveContext: (_input, output) => ({ value: output.value }),
+    });
+    const registry = UndoRegistry.make(() => [undoMapping]);
+
+    const result = registry.lookup(Compute);
+    expect(result).not.toBe(undefined);
+    expect(result?.inverse.meta.key).toBe('test.halve-compute');
+  });
+
+  test('returns undefined for unmapped operations', ({ expect }) => {
+    const registry = UndoRegistry.make(() => []);
+
+    const result = registry.lookup(Compute);
+    expect(result).toBe(undefined);
+  });
+
+  test('deriveContext extracts correct undo input', ({ expect }) => {
+    const undoMapping = UndoMapping.make({
+      operation: Compute,
+      inverse: HalveCompute,
+      // Note: This tests that input and output types are inferred correctly.
+      deriveContext: (input, output) => ({ value: output.value + input.value }),
+    });
+    const registry = UndoRegistry.make(() => [undoMapping]);
+
+    const result = registry.lookup(Compute);
+    const context = result?.deriveContext({ value: 5 }, { value: 10 });
+    expect(context).toEqual({ value: 15 });
+  });
+});
+
+describe('resolveMessage', () => {
+  test('returns undefined for undefined message', ({ expect }) => {
+    const result = UndoMapping.resolveMessage(undefined, { value: 1 }, { value: 2 });
+    expect(result).toBe(undefined);
+  });
+
+  test('returns static label as-is', ({ expect }) => {
+    const staticMessage: [string, { ns: string }] = ['test message', { ns: 'test' }];
+    const result = UndoMapping.resolveMessage(staticMessage, { value: 1 }, { value: 2 });
+    expect(result).toEqual(staticMessage);
+  });
+
+  test('calls function message with input and output', ({ expect }) => {
+    const messageFunc = (input: { value: number }, output: { value: number }): [string, { ns: string }] => [
+      `input: ${input.value}, output: ${output.value}`,
+      { ns: 'test' },
+    ];
+    const result = UndoMapping.resolveMessage(messageFunc, { value: 5 }, { value: 10 });
+    expect(result).toEqual(['input: 5, output: 10', { ns: 'test' }]);
+  });
+
+  test('returns string label as-is', ({ expect }) => {
+    const result = UndoMapping.resolveMessage('simple string', { value: 1 }, { value: 2 });
+    expect(result).toBe('simple string');
+  });
+});

package/src/plugin-operation/history/undo-registry.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type { Operation } from '@dxos/operation';
+
+import type * as UndoMapping from './undo-mapping';
+
+//
+// Public Interface
+//
+
+/**
+ * Lookup result from UndoRegistry.
+ */
+export type UndoMappingResult = {
+  inverse: Operation.Definition<any, any>;
+  /** Returns undefined to indicate the operation is not undoable. */
+  deriveContext: (input: any, output: any) => any | undefined;
+  /** Message provider - may be a static Label or a function. */
+  message?: UndoMapping.MessageProvider<Operation.Definition<any, any>>;
+};
+
+/**
+ * UndoRegistry interface - looks up inverse operations.
+ */
+export interface UndoRegistry {
+  lookup: (operation: Operation.Definition<any, any>) => UndoMappingResult | undefined;
+}
+
+//
+// Factory
+//
+
+/**
+ * Creates an UndoRegistry that looks up inverse operations.
+ */
+export const make = (getMappings: () => UndoMapping.UndoMapping[]): UndoRegistry => {
+  const lookup = (operation: Operation.Definition<any, any>): UndoMappingResult | undefined => {
+    const mappings = getMappings();
+    const mapping = mappings.find((m) => m.operation.meta.key === operation.meta.key);
+    if (!mapping) {
+      return undefined;
+    }
+
+    return {
+      inverse: mapping.inverse,
+      deriveContext: mapping.deriveContext,
+      message: mapping.message,
+    };
+  };
+
+  return { lookup };
+};

package/src/plugin-operation/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './history';
+export * from './OperationPlugin';

package/src/plugin-operation/invoker-capability.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { OperationInvoker } from '@dxos/operation';
+
+import { ActivationEvents, Capabilities } from '../common';
+import { Capability, Plugin } from '../core';
+
+//
+// Capability Module
+//
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get the services for synchronous access in callbacks.
+    const capabilityManager = yield* Capability.Service;
+    const pluginManager = yield* Plugin.Service;
+
+    // Get the ManagedRuntime capability (should be available since we activate after ManagedRuntimeReady).
+    const managedRuntimes = yield* Capability.getAll(Capabilities.ManagedRuntime);
+    const managedRuntime = managedRuntimes.length > 0 ? managedRuntimes[0] : undefined;
+
+    const invoker = OperationInvoker.make(
+      () =>
+        Effect.gen(function* () {
+          yield* Plugin.activate(ActivationEvents.SetupOperationResolver);
+          return (yield* Capability.getAll(Capabilities.OperationResolver)).flat();
+        }).pipe(
+          Effect.provideService(Capability.Service, capabilityManager),
+          Effect.provideService(Plugin.Service, pluginManager),
+        ),
+      managedRuntime,
+    );
+
+    return Capability.contributes(Capabilities.OperationInvoker, invoker);
+  }),
+);

package/src/plugin-operation/meta.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Plugin } from '../core';
+
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/operation',
+  name: 'Operation Plugin',
+  description: 'Provides operation invocation, undo registry, and history tracking.',
+};

package/src/plugin-operation/testing.ts

@@ -0,0 +1,174 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Deferred from 'effect/Deferred';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as Ref from 'effect/Ref';
+import * as Schema from 'effect/Schema';
+import * as Stream from 'effect/Stream';
+
+import { Operation, type OperationInvoker, OperationResolver } from '@dxos/operation';
+
+//
+// Test Operations
+//
+
+export const Compute = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ value: Schema.Number }),
+  },
+  meta: { key: 'test.compute' },
+});
+
+export const HalveCompute = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ value: Schema.Number }),
+  },
+  meta: { key: 'test.halve-compute' },
+});
+
+export const ToString = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ string: Schema.String }),
+  },
+  meta: { key: 'test.to-string' },
+});
+
+export const Add = Operation.make({
+  schema: {
+    input: Schema.Tuple(Schema.Number, Schema.Number),
+    output: Schema.Number,
+  },
+  meta: { key: 'test.add' },
+});
+
+export const SideEffect = Operation.make({
+  schema: {
+    input: Schema.Void,
+    output: Schema.Void,
+  },
+  meta: { key: 'test.side-effect' },
+});
+
+//
+// Test Handlers
+//
+
+export const computeHandler = OperationResolver.make({
+  operation: Compute,
+  handler: (data) =>
+    Effect.gen(function* () {
+      yield* Effect.sleep(data.value * 10);
+      return { value: data.value * 2 };
+    }),
+});
+
+export const halveComputeHandler = OperationResolver.make({
+  operation: HalveCompute,
+  handler: (data) => Effect.succeed({ value: data.value / 2 }),
+});
+
+export const toStringHandler = OperationResolver.make({
+  operation: ToString,
+  handler: (data) => Effect.succeed({ string: data.value.toString() }),
+});
+
+export const addHandler = OperationResolver.make({
+  operation: Add,
+  handler: (data) => Effect.succeed(data[0] + data[1]),
+});
+
+export const sideEffectHandler = OperationResolver.make({
+  operation: SideEffect,
+  handler: () => Effect.succeed(undefined),
+});
+
+//
+// Test Utilities
+//
+
+/**
+ * Event collector for testing - provides deterministic event collection using Effect primitives.
+ */
+export interface EventCollector {
+  /** All collected events. */
+  readonly events: OperationInvoker.InvocationEvent[];
+  /** Wait until N events have been collected. */
+  waitForEvents: (count: number) => Effect.Effect<void>;
+  /** Clean up the subscription fiber. */
+  dispose: Effect.Effect<void>;
+}
+
+/**
+ * Creates an event collector that subscribes to invoker events.
+ * Uses Effect primitives for synchronization.
+ */
+export const createEventCollector = (invoker: OperationInvoker.OperationInvoker): Effect.Effect<EventCollector> =>
+  Effect.gen(function* () {
+    const events: OperationInvoker.InvocationEvent[] = [];
+
+    // Ref to track current waiter (waiting for N events).
+    const waiterRef = yield* Ref.make<{ count: number; deferred: Deferred.Deferred<void> } | null>(null);
+
+    // Deferred to signal when subscription is ready.
+    const subscriptionReady = yield* Deferred.make<void>();
+
+    const checkWaiter = Effect.gen(function* () {
+      const waiter = yield* Ref.get(waiterRef);
+      if (waiter && events.length >= waiter.count) {
+        yield* Deferred.succeed(waiter.deferred, undefined);
+        yield* Ref.set(waiterRef, null);
+      }
+    });
+
+    // Fork a fiber to consume the invocation stream.
+    const fiber = yield* Effect.fork(
+      Effect.gen(function* () {
+        // Signal that subscription is about to start.
+        yield* Deferred.succeed(subscriptionReady, undefined);
+        yield* Stream.fromPubSub(invoker.invocations).pipe(
+          Stream.runForEach((event) =>
+            Effect.gen(function* () {
+              events.push(event);
+              yield* checkWaiter;
+            }),
+          ),
+        );
+      }),
+    );
+
+    // Wait for the subscription to be established.
+    yield* Deferred.await(subscriptionReady);
+    // Additional yield to ensure PubSub subscription is fully registered.
+    yield* Effect.yieldNow();
+
+    const waitForEvents = (count: number): Effect.Effect<void> =>
+      Effect.gen(function* () {
+        if (events.length >= count) {
+          return;
+        }
+        const deferred = yield* Deferred.make<void>();
+        yield* Ref.set(waiterRef, { count, deferred });
+        yield* Deferred.await(deferred);
+      });
+
+    const dispose = Fiber.interrupt(fiber);
+
+    return { events, waitForEvents, dispose };
+  });
+
+/**
+ * Waits until a condition is true, yielding to the JS event loop between checks.
+ * Uses setImmediate to allow other async work to complete.
+ */
+export const waitUntil = (condition: () => boolean): Effect.Effect<void> =>
+  Effect.gen(function* () {
+    while (!condition()) {
+      yield* Effect.promise(() => new Promise((r) => setImmediate(r)));
+    }
+  });

package/src/plugin-runtime/RuntimePlugin.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvents } from '../common';
+import { Capability, Plugin } from '../core';
+
+import { meta } from './meta';
+
+const ManagedRuntimeCapability = Capability.lazy('ManagedRuntime', () => import('./capability'));
+
+export const RuntimePlugin = Plugin.define(meta).pipe(
+  Plugin.addModule({
+    activatesOn: ActivationEvents.Startup,
+    activatesBefore: [ActivationEvents.SetupLayer],
+    activatesAfter: [ActivationEvents.ManagedRuntimeReady],
+    activate: ManagedRuntimeCapability,
+  }),
+  Plugin.make,
+);

package/src/plugin-runtime/capability.ts

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as ManagedRuntime from 'effect/ManagedRuntime';
+
+import { ActivationEvents, Capabilities } from '../common';
+import { Capability, Plugin } from '../core';
+
+//
+// Capability Module
+//
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get the CapabilityManager to create a layer for it.
+    const capabilityManager = yield* Capability.Service;
+
+    // Get the PluginManager to create a layer for it.
+    const pluginManager = yield* Plugin.Service;
+
+    // Trigger setup event so plugins can contribute their layers.
+    yield* Plugin.activate(ActivationEvents.SetupLayer);
+
+    // Gather all contributed layers.
+    const layers = yield* Capability.getAll(Capabilities.Layer);
+
+    // Create layers that provide Capability.Service and Plugin.Service.
+    const capabilityServiceLayer = Layer.succeed(Capability.Service, capabilityManager);
+    const pluginServiceLayer = Layer.succeed(Plugin.Service, pluginManager);
+
+    // Merge all layers including service layers.
+    // Layer.mergeAll requires a tuple type, so we use a cast for dynamic arrays.
+    const composedLayer =
+      layers.length > 0
+        ? (Layer.mergeAll as (...args: Layer.Layer<any, any, any>[]) => Layer.Layer<any, any, never>)(
+            capabilityServiceLayer,
+            pluginServiceLayer,
+            ...layers,
+          )
+        : (Layer.mergeAll as (...args: Layer.Layer<any, any, any>[]) => Layer.Layer<any, any, never>)(
+            capabilityServiceLayer,
+            pluginServiceLayer,
+          );
+
+    // Create the managed runtime from the composed layer.
+    const runtime = ManagedRuntime.make(composedLayer) as Capabilities.ManagedRuntime;
+
+    return Capability.contributes(Capabilities.ManagedRuntime, runtime);
+  }),
+);

package/src/{playground/logger → plugin-runtime}/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './plugin';
+export * from './RuntimePlugin';

package/src/plugin-runtime/meta.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Plugin } from '../core';
+
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/runtime',
+  name: 'Runtime Plugin',
+  description: 'Provides a managed Effect runtime by composing contributed layers.',
+};

package/src/testing/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2025 DXOS.org
 //
 
+export * from './service';
 export * from './withPluginManager';

package/src/testing/service.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+
+import { invariant } from '@dxos/invariant';
+
+import { ActivationEvents, Capabilities } from '../common';
+import { Plugin, PluginManager } from '../core';
+
+/**
+ * Creates a Plugin.Service layer from a list of plugins.
+ * This is primarily used for testing.
+ */
+export const fromPlugins = (plugins: Plugin.Plugin[]) =>
+  Layer.effect(
+    Plugin.Service,
+    Effect.gen(function* () {
+      // TODO(wittjosiah): Try to dedupe logic between here, createCliApp and useApp.
+
+      const pluginLoader = (id: string) =>
+        Effect.sync(() => {
+          const plugin = plugins.find((plugin) => plugin.meta.id === id);
+          invariant(plugin, `Plugin not found: ${id}`);
+          return plugin;
+        });
+
+      const manager = PluginManager.make({
+        pluginLoader,
+        plugins,
+        core: plugins.map((plugin) => plugin.meta.id),
+      });
+
+      manager.capabilities.contribute({
+        interface: Capabilities.PluginManager,
+        implementation: manager,
+        module: 'dxos.org/app-framework/plugin-manager',
+      });
+
+      manager.capabilities.contribute({
+        interface: Capabilities.AtomRegistry,
+        implementation: manager.registry,
+        module: 'dxos.org/app-framework/atom-registry',
+      });
+
+      yield* manager.activate(ActivationEvents.Startup);
+
+      return manager;
+    }),
+  );

package/src/testing/withPluginManager.stories.tsx

@@ -7,9 +7,9 @@ import React from 'react';
 
 import { withTheme } from '@dxos/react-ui/testing';
 
-import { Capabilities, createSurface } from '../common';
-import { contributes } from '../core';
-import { Surface } from '../react';
+import { Capabilities } from '../common';
+import { Capability } from '../core';
+import { Surface } from '../ui';
 
 import { withPluginManager } from './withPluginManager';
 
@@ -18,7 +18,7 @@ const DefaultStory = () => {
   return (
     <div>
       <div>Hello</div>
-      <Surface role='main' />
+      <Surface.Surface role='main' />
     </div>
   );
 };
@@ -27,12 +27,12 @@ const meta = {
   title: 'sdk/app-framework/withPluginManager',
   render: DefaultStory,
   decorators: [
-    withTheme,
+    withTheme(),
     withPluginManager({
       capabilities: [
-        contributes(
+        Capability.contributes(
           Capabilities.ReactSurface,
-          createSurface({
+          Surface.create({
             id: 'test',
             role: 'main',
             component: ({ role }) => <span>{JSON.stringify({ role })}</span>,

package/src/testing/withPluginManager.tsx

@@ -2,24 +2,17 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type Decorator } from '@storybook/react';
+import { type Decorator, type StoryContext } from '@storybook/react';
+import * as Effect from 'effect/Effect';
 import React, { useEffect, useMemo } from 'react';
 
 import { raise } from '@dxos/debug';
 import { useAsyncEffect } from '@dxos/react-hooks';
 import { type MaybeProvider, getProviderValue } from '@dxos/util';
 
-import { Capabilities, Events } from '../common';
-import { type UseAppOptions, useApp } from '../components';
-import {
-  type ActivationEvent,
-  type AnyCapability,
-  type PluginContext,
-  PluginManager,
-  contributes,
-  defineModule,
-  definePlugin,
-} from '../core';
+import { ActivationEvents, Capabilities } from '../common';
+import { type ActivationEvent, Capability, type CapabilityManager, Plugin, PluginManager } from '../core';
+import { type UseAppOptions, useApp } from '../ui';
 
 /**
  * @internal
@@ -30,16 +23,16 @@ export const setupPluginManager = ({
   core = plugins.map(({ meta }) => meta.id),
   ...options
 }: UseAppOptions & Pick<WithPluginManagerOptions, 'capabilities'> = {}) => {
-  const pluginManager = new PluginManager({
+  const pluginManager = PluginManager.make({
     pluginLoader: () => raise(new Error('Not implemented')),
-    plugins: [StoryPlugin(), ...plugins],
+    plugins: [StoryPlugin, ...plugins],
     core: [StoryPlugin.meta.id, ...core],
     ...options,
   });
 
   if (capabilities) {
-    getProviderValue(capabilities, pluginManager.context).forEach((capability) => {
-      pluginManager.context.contributeCapability({
+    getProviderValue(capabilities, pluginManager.capabilities).forEach((capability) => {
+      pluginManager.capabilities.contribute({
         interface: capability.interface,
         implementation: capability.implementation,
         module: 'story',
@@ -52,33 +45,41 @@ export const setupPluginManager = ({
 
 export type WithPluginManagerOptions = UseAppOptions & {
   /** @deprecated */
-  capabilities?: MaybeProvider<AnyCapability[], PluginContext>;
+  capabilities?: MaybeProvider<Capability.Any[], CapabilityManager.CapabilityManager>;
   /** @deprecated */
-  fireEvents?: (ActivationEvent | string)[];
+  fireEvents?: (ActivationEvent.ActivationEvent | string)[];
 };
 
+export type WithPluginManagerInitializer<Args = void> =
+  | WithPluginManagerOptions
+  | ((context: StoryContext<Args>) => WithPluginManagerOptions);
+
 /**
  * Wraps a story with a plugin manager.
  * NOTE: This builds up and tears down the plugin manager on every render.
  */
-export const withPluginManager = (options: WithPluginManagerOptions = {}): Decorator => {
+export const withPluginManager = <Args,>(init: WithPluginManagerInitializer<Args> = {}): Decorator => {
   return (Story, context) => {
-    const pluginManager = useMemo(() => setupPluginManager(options), [options]);
+    const options = typeof init === 'function' ? init(context as any) : init;
+    const { pluginManager, setupEvents } = useMemo(
+      () => ({ pluginManager: setupPluginManager(options), setupEvents: options.setupEvents }),
+      [init],
+    );
 
     // Set-up root capability.
     useEffect(() => {
-      const capability = contributes(Capabilities.ReactRoot, {
+      const capability = Capability.contributes(Capabilities.ReactRoot, {
         id: context.id,
         root: () => <Story />,
       });
 
-      pluginManager.context.contributeCapability({
+      pluginManager.capabilities.contribute({
         ...capability,
         module: 'dxos.org/app-framework/withPluginManager',
       });
 
       return () => {
-        pluginManager.context.removeCapability(capability.interface, capability.implementation);
+        pluginManager.capabilities.remove(capability.interface, capability.implementation);
       };
     }, [pluginManager, context]);
 
@@ -88,7 +89,7 @@ export const withPluginManager = (options: WithPluginManagerOptions = {}): Decor
     }, [pluginManager]);
 
     // Create app.
-    const App = useApp({ pluginManager });
+    const App = useApp({ pluginManager, setupEvents });
 
     return <App />;
   };
@@ -101,6 +102,11 @@ const storyMeta = {
 
 // No-op plugin to ensure there exists at least one plugin for the startup event.
 // This is necessary because `createApp` expects the startup event to complete before the app is ready.
-const StoryPlugin = definePlugin(storyMeta, () => [
-  defineModule({ id: storyMeta.id, activatesOn: Events.Startup, activate: () => [] }),
-]);
+const StoryPlugin = Plugin.define(storyMeta).pipe(
+  Plugin.addModule({
+    id: 'Story',
+    activatesOn: ActivationEvents.Startup,
+    activate: () => Effect.succeed([]),
+  }),
+  Plugin.make,
+)();