@dxos/plugin-observability 0.8.4-main.b97322e → 0.8.4-main.bc2380dfbc

package/package.json

@@ -1,79 +1,125 @@
 {
   "name": "@dxos/plugin-observability",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.bc2380dfbc",
   "description": "DXOS app framework plugin for hooking up app observability",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#capabilities": {
+      "source": "./src/capabilities/index.ts",
+      "types": "./dist/types/src/capabilities/index.d.ts",
+      "default": "./dist/lib/neutral/capabilities/index.mjs"
+    },
+    "#components": {
+      "source": "./src/components/index.ts",
+      "types": "./dist/types/src/components/index.d.ts",
+      "default": "./dist/lib/neutral/components/index.mjs"
+    },
+    "#meta": {
+      "source": "./src/meta.ts",
+      "types": "./dist/types/src/meta.d.ts",
+      "default": "./dist/lib/neutral/meta.mjs"
+    },
+    "#operations": {
+      "source": "./src/operations/index.ts",
+      "types": "./dist/types/src/operations/index.d.ts",
+      "default": "./dist/lib/neutral/operations/index.mjs"
+    },
+    "#plugin": {
+      "source": {
+        "workerd": "./src/ObservabilityPlugin.workerd.ts",
+        "node": "./src/ObservabilityPlugin.node.ts",
+        "default": "./src/ObservabilityPlugin.ts"
+      },
+      "types": "./dist/types/src/ObservabilityPlugin.d.ts",
+      "workerd": "./dist/lib/neutral/ObservabilityPlugin.workerd.mjs",
+      "node": "./dist/lib/neutral/ObservabilityPlugin.node.mjs",
+      "default": "./dist/lib/neutral/ObservabilityPlugin.mjs"
+    },
+    "#translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
+    },
+    "#types": {
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "default": "./dist/lib/neutral/types/index.mjs"
+    }
+  },
   "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"
+      "default": "./dist/lib/neutral/index.mjs"
     },
-    "./types": {
-      "types": "./dist/types/src/types/index.d.ts",
-      "browser": "./dist/lib/browser/types/index.mjs",
-      "node": "./dist/lib/node-esm/types/index.mjs"
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "default": "./dist/lib/neutral/plugin.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "types": [
-        "dist/types/src/types/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
-    "effect": "3.17.0",
+    "@effect-atom/atom": "^0.5.1",
+    "@effect-atom/atom-react": "^0.5.0",
+    "effect": "3.20.0",
     "localforage": "^1.10.0",
-    "@dxos/app-framework": "0.8.4-main.b97322e",
-    "@dxos/async": "0.8.4-main.b97322e",
-    "@dxos/context": "0.8.4-main.b97322e",
-    "@dxos/echo": "0.8.4-main.b97322e",
-    "@dxos/echo-schema": "0.8.4-main.b97322e",
-    "@dxos/invariant": "0.8.4-main.b97322e",
-    "@dxos/live-object": "0.8.4-main.b97322e",
-    "@dxos/local-storage": "0.8.4-main.b97322e",
-    "@dxos/log": "0.8.4-main.b97322e",
-    "@dxos/observability": "0.8.4-main.b97322e",
-    "@dxos/protocols": "0.8.4-main.b97322e",
-    "@dxos/plugin-graph": "0.8.4-main.b97322e",
-    "@dxos/react-client": "0.8.4-main.b97322e",
-    "@dxos/react-ui-stack": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e",
-    "@dxos/react-ui-form": "0.8.4-main.b97322e"
+    "@dxos/app-toolkit": "0.8.4-main.bc2380dfbc",
+    "@dxos/app-framework": "0.8.4-main.bc2380dfbc",
+    "@dxos/async": "0.8.4-main.bc2380dfbc",
+    "@dxos/client": "0.8.4-main.bc2380dfbc",
+    "@dxos/context": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo": "0.8.4-main.bc2380dfbc",
+    "@dxos/effect": "0.8.4-main.bc2380dfbc",
+    "@dxos/invariant": "0.8.4-main.bc2380dfbc",
+    "@dxos/log": "0.8.4-main.bc2380dfbc",
+    "@dxos/plugin-graph": "0.8.4-main.bc2380dfbc",
+    "@dxos/observability": "0.8.4-main.bc2380dfbc",
+    "@dxos/protocols": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-client": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-hooks": "0.8.4-main.bc2380dfbc",
+    "@dxos/compute": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-attention": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-stack": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-form": "0.8.4-main.bc2380dfbc",
+    "@dxos/util": "0.8.4-main.bc2380dfbc"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "0.38.0",
-    "@effect/platform": "0.89.0",
-    "@types/react": "~18.2.0",
-    "react": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/storybook-utils": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "@types/react": "~19.2.7",
+    "react": "~19.2.3",
+    "vite": "^8.0.13",
+    "@dxos/plugin-testing": "0.8.4-main.bc2380dfbc",
+    "@dxos/storybook-utils": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "^0.80.12",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
-  },
-  "publishConfig": {
-    "access": "public"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc"
   }
 }

package/src/ObservabilityPlugin.node.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Operation, OperationHandlerSet } from '@dxos/compute';
+
+import { meta } from '#meta';
+import { ObservabilityOperation } from '#types';
+
+// TODO(wittjosiah): Hook up.
+export const ObservabilityPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addOperationHandlerModule({
+    activate: Capability.lazy('OperationHandler', () =>
+      Promise.resolve({
+        default: Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+          Effect.fnUntraced(function* () {
+            return Capability.contributes(
+              Capabilities.OperationHandler,
+              OperationHandlerSet.make(Operation.withHandler(ObservabilityOperation.SendEvent, () => Effect.void)),
+            );
+          }),
+        ),
+      }),
+    ),
+  }),
+  Plugin.make,
+);
+
+export default ObservabilityPlugin;

package/src/ObservabilityPlugin.test.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { createComposerTestApp } from '@dxos/plugin-testing/harness';
+
+import { ObservabilityPlugin } from '#plugin';
+
+import { meta } from './meta';
+
+const moduleId = (name: string) => `${meta.id}.module.${name}`;
+
+describe('ObservabilityPlugin', () => {
+  test('modules activate on the expected events', async ({ expect }) => {
+    await using harness = await createComposerTestApp({
+      // TODO(wittjosiah): Align browser and node variant option types.
+      plugins: [ObservabilityPlugin({} as any)],
+    });
+
+    // OperationHandler fires automatically (OperationPlugin fires SetupOperationHandler during Startup).
+    expect(harness.manager.getActive()).toContain(moduleId('OperationHandler'));
+  });
+});

package/src/ObservabilityPlugin.ts

@@ -2,66 +2,85 @@
 // Copyright 2025 DXOS.org
 //
 
-import { allOf, Capabilities, contributes, defineModule, definePlugin, Events } from '@dxos/app-framework';
+import * as Effect from 'effect/Effect';
+
+import { ActivationEvent, ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
+import { AppActivationEvents, AppPlugin } from '@dxos/app-toolkit';
 import { type Observability } from '@dxos/observability';
 
 import {
   AppGraphBuilder,
   ClientReady,
-  IntentResolver,
-  ObservabilityCapabilities,
   ObservabilitySettings,
   ObservabilityState,
+  OperationHandler,
   ReactSurface,
-} from './capabilities';
-import { ObservabilityEvents, ClientReadyEvent } from './events';
-import { meta } from './meta';
-import { translations } from './translations';
+} from '#capabilities';
+import { meta } from '#meta';
+import { translations } from '#translations';
+import { ObservabilityCapabilities, ObservabilityEvents } from '#types';
+
+export type ObservabilityPluginOptions = {
+  namespace: string;
+  observability: () => Promise<Observability.Observability>;
+  /**
+   * Optional callback invoked by the help/feedback UI to download captured logs.
+   * When omitted the "Download logs" action is hidden.
+   */
+  downloadLogs?: () => void | Promise<void>;
+};
+
+export const ObservabilityPlugin = Plugin.define<ObservabilityPluginOptions>(meta).pipe(
+  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule(({ observability }) => ({
+    id: 'observability',
+    activatesOn: ActivationEvents.Startup,
+    activate: () =>
+      Effect.gen(function* () {
+        const obs = yield* Effect.tryPromise(() => observability());
+        return Capability.contributes(ObservabilityCapabilities.Observability, obs);
+      }),
+  })),
+  Plugin.addModule({
+    activatesOn: AppActivationEvents.SetupSettings,
+    activate: ObservabilitySettings,
+  }),
+  Plugin.addModule(({ namespace }) => ({
+    id: Capability.getModuleTag(ObservabilityState),
+    activatesOn: ActivationEvents.Startup,
+    firesAfterActivation: [ObservabilityEvents.StateReady],
+    activate: () => ObservabilityState({ namespace }),
+  })),
+  Plugin.addModule(({ namespace }) => ({
+    id: 'namespace',
+    activatesOn: ActivationEvents.Startup,
+    activate: () => Effect.succeed(Capability.contributes(ObservabilityCapabilities.Namespace, namespace)),
+  })),
+  Plugin.addModule(({ downloadLogs }) => ({
+    id: 'log-downloader',
+    activatesOn: ActivationEvents.Startup,
+    activate: () =>
+      Effect.succeed(
+        downloadLogs !== undefined ? Capability.contributes(ObservabilityCapabilities.LogDownloader, downloadLogs) : [],
+      ),
+  })),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  Plugin.addModule(({ namespace, observability }) => ({
+    id: Capability.getModuleTag(ClientReady),
+    activatesOn: ActivationEvent.allOf(
+      ActivationEvents.OperationInvokerReady,
+      ObservabilityEvents.StateReady,
+      ObservabilityEvents.ClientReadyEvent,
+    ),
+    activate: () =>
+      Effect.gen(function* () {
+        const obs = yield* Effect.tryPromise(() => observability());
+        return yield* ClientReady({ namespace, observability: obs });
+      }),
+  })),
+  Plugin.make,
+);
 
-export const ObservabilityPlugin = (options: { namespace: string; observability: () => Promise<Observability> }) =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/observability`,
-      activatesOn: Events.Startup,
-      activate: async () => contributes(ObservabilityCapabilities.Observability, await options.observability()),
-    }),
-    defineModule({
-      id: `${meta.id}/module/settings`,
-      activatesOn: Events.SetupSettings,
-      activate: ObservabilitySettings,
-    }),
-    defineModule({
-      id: `${meta.id}/module/state`,
-      activatesOn: Events.Startup,
-      activatesAfter: [ObservabilityEvents.StateReady],
-      activate: () => ObservabilityState({ namespace: options.namespace }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: (context) => IntentResolver({ context, namespace: options.namespace }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-    defineModule({
-      id: `${meta.id}/module/app-graph-builder`,
-      activatesOn: Events.SetupAppGraph,
-      activate: AppGraphBuilder,
-    }),
-    defineModule({
-      id: `${meta.id}/module/client-ready`,
-      activatesOn: allOf(Events.DispatcherReady, ObservabilityEvents.StateReady, ClientReadyEvent),
-      activate: async (context) => {
-        const observability = await options.observability();
-        return ClientReady({ context, observability, namespace: options.namespace });
-      },
-    }),
-  ]);
+export default ObservabilityPlugin;

package/src/ObservabilityPlugin.workerd.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Operation, OperationHandlerSet } from '@dxos/compute';
+
+import { meta } from '#meta';
+import { ObservabilityOperation } from '#types';
+
+export const ObservabilityPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addOperationHandlerModule({
+    activate: Capability.lazy('OperationHandler', () =>
+      Promise.resolve({
+        default: Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+          Effect.fnUntraced(function* () {
+            return Capability.contributes(
+              Capabilities.OperationHandler,
+              OperationHandlerSet.make(Operation.withHandler(ObservabilityOperation.SendEvent, () => Effect.void)),
+            );
+          }),
+        ),
+      }),
+    ),
+  }),
+  Plugin.make,
+);
+
+export default ObservabilityPlugin;

package/src/capabilities/app-graph-builder.ts

@@ -2,44 +2,35 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { Capabilities, contributes, type PluginContext } from '@dxos/app-framework';
-import { createExtension, ROOT_ID } from '@dxos/plugin-graph';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode } from '@dxos/app-toolkit';
+import { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
+import { linkedSegment } from '@dxos/react-ui-attention';
 
-import { OBSERVABILITY_PLUGIN } from '../meta';
+import { meta } from '#meta';
 
-// NOTE: Copied from @dxos/plugin-deck to break circular dependency.
-const ATTENDABLE_PATH_SEPARATOR = '~';
-const DECK_COMPANION_TYPE = 'dxos.org/plugin/deck/deck-companion';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.AppGraphBuilder, [
-    createExtension({
-      id: `${OBSERVABILITY_PLUGIN}/help`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map((node) => {
-              return [
-                {
-                  id: [node.id, 'help'].join(ATTENDABLE_PATH_SEPARATOR),
-                  type: DECK_COMPANION_TYPE,
-                  data: null,
-                  properties: {
-                    label: ['help label', { ns: OBSERVABILITY_PLUGIN }],
-                    icon: 'ph--question--regular',
-                    disposition: 'hidden',
-                    position: 'hoist',
-                  },
-                },
-              ];
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* Effect.all([
+      GraphBuilder.createExtension({
+        id: 'help',
+        match: NodeMatcher.whenRoot,
+        connector: (node) =>
+          Effect.succeed([
+            AppNode.makeDeckCompanion({
+              id: linkedSegment('help'),
+              label: ['help.label', { ns: meta.id }],
+              icon: 'ph--question--regular',
+              data: null,
+              position: 'hoist',
+              joyride: 'welcome/feedback',
             }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  ]);
+          ]),
+      }),
+    ]);
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);