@dxos/plugin-observability 0.8.4-main.c85a9c8dae → 0.8.4-main.d9fc60f731

package/src/capabilities/operation-resolver/operation-resolver.ts

@@ -1,76 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capabilities, Capability } from '@dxos/app-framework';
-import { AppCapabilities } from '@dxos/app-toolkit';
-import { Observability } from '@dxos/observability';
-import { OperationResolver } from '@dxos/operation';
-
-import { type ObservabilitySettingsProps } from '../../containers';
-import { meta } from '../../meta';
-import { ObservabilityCapabilities, ObservabilityOperation } from '../../types';
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* ({ namespace }: { namespace: string }) {
-    const capabilities = yield* Capability.Service;
-
-    return Capability.contributes(Capabilities.OperationResolver, [
-      //
-      // Toggle
-      //
-      OperationResolver.make({
-        operation: ObservabilityOperation.Toggle,
-        handler: Effect.fnUntraced(function* (input) {
-          const observability = yield* Capability.get(ObservabilityCapabilities.Observability);
-          const registry = capabilities.get(Capabilities.AtomRegistry);
-          const allSettings = capabilities.getAll(AppCapabilities.Settings);
-          const settingsObj = allSettings.find((s: AppCapabilities.Settings) => s.prefix === meta.id);
-          if (!settingsObj) {
-            return false;
-          }
-          const settings = registry.get(settingsObj.atom) as ObservabilitySettingsProps;
-          const newEnabled = input.state ?? !settings.enabled;
-          registry.set(settingsObj.atom, { ...settings, enabled: newEnabled });
-          observability.events.captureEvent('observability.toggle', {
-            enabled: newEnabled,
-          });
-
-          if (newEnabled) {
-            yield* observability.enable();
-          } else {
-            yield* observability.disable();
-          }
-          yield* Effect.promise(() => Observability.storeObservabilityDisabled(namespace, !newEnabled));
-          return newEnabled;
-        }),
-      }),
-
-      //
-      // SendEvent
-      //
-      OperationResolver.make({
-        operation: ObservabilityOperation.SendEvent,
-        handler: Effect.fnUntraced(function* (input) {
-          // NOTE: This is to ensure that events fired before observability is ready are still sent.
-          const observability = yield* Capability.waitFor(ObservabilityCapabilities.Observability);
-          const properties = input.properties ?? {};
-          observability.events.captureEvent(input.name, properties);
-        }),
-      }),
-
-      //
-      // CaptureUserFeedback
-      //
-      OperationResolver.make({
-        operation: ObservabilityOperation.CaptureUserFeedback,
-        handler: Effect.fnUntraced(function* (input) {
-          const observability = yield* Capability.get(ObservabilityCapabilities.Observability);
-          observability.feedback.captureUserFeedback({ message: input.message, includeLogs: input.includeLogs });
-        }),
-      }),
-    ]);
-  }),
-);

package/src/capabilities/react-surface/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/react-surface/react-surface.tsx

@@ -1,35 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import React from 'react';
-
-import { Capabilities, Capability } from '@dxos/app-framework';
-import { Surface, useSettingsState } from '@dxos/app-framework/ui';
-import { AppCapabilities } from '@dxos/app-toolkit';
-
-import { HelpContainer, ObservabilitySettings, type ObservabilitySettingsProps } from '../../containers';
-import { meta } from '../../meta';
-
-export default Capability.makeModule(() =>
-  Effect.succeed(
-    Capability.contributes(Capabilities.ReactSurface, [
-      Surface.create({
-        id: meta.id,
-        role: 'article',
-        filter: (data): data is { subject: AppCapabilities.Settings } =>
-          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
-        component: ({ data: { subject } }) => {
-          const { settings, updateSettings } = useSettingsState<ObservabilitySettingsProps>(subject.atom);
-          return <ObservabilitySettings settings={settings} onSettingsChange={updateSettings} />;
-        },
-      }),
-      Surface.create({
-        id: `${meta.id}/help`,
-        role: 'deck-companion--help',
-        component: () => <HelpContainer />,
-      }),
-    ]),
-  ),
-);

package/src/capabilities/settings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ObservabilitySettings = Capability.lazy('ObservabilitySettings', () => import('./settings'));

package/src/capabilities/state/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ObservabilityState = Capability.lazy('ObservabilityState', () => import('./state'));

package/src/cli/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './plugin';

package/src/cli/plugin.ts

@@ -1,28 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capabilities, Capability, Plugin } from '@dxos/app-framework';
-import { AppPlugin } from '@dxos/app-toolkit';
-import { OperationResolver } from '@dxos/operation';
-
-import { meta } from '../meta';
-import { ObservabilityOperation } from '../types';
-
-// TODO(wittjosiah): Hook up.
-export const ObservabilityPlugin = Plugin.define(meta).pipe(
-  AppPlugin.addOperationResolverModule({
-    activate: () =>
-      Effect.succeed(
-        Capability.contributes(Capabilities.OperationResolver, [
-          OperationResolver.make({
-            operation: ObservabilityOperation.SendEvent,
-            handler: () => Effect.void,
-          }),
-        ]),
-      ),
-  }),
-  Plugin.make,
-);

package/src/components/FeedbackForm.stories.tsx

@@ -1,33 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
-
-import { translations } from '../translations';
-
-import { FeedbackForm } from './FeedbackForm';
-
-const meta = {
-  title: 'plugins/plugin-observability/components/FeedbackForm',
-  component: FeedbackForm,
-  decorators: [withTheme(), withLayout({ layout: 'column' })],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof FeedbackForm>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    onSave: (values) => {
-      console.log(values);
-    },
-  },
-};

package/src/components/FeedbackForm.tsx

@@ -1,33 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { Form, type FormRootProps, type FormSubmitProps } from '@dxos/react-ui-form';
-
-import { meta } from '../meta';
-import { UserFeedback } from '../types';
-
-export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'> & Pick<FormSubmitProps, 'disabled'>;
-
-const defaultValues: UserFeedback = {
-  message: '',
-  includeLogs: true,
-};
-
-export const FeedbackForm = ({ onSave, disabled }: FeedbackFormProps) => {
-  const { t } = useTranslation(meta.id);
-
-  return (
-    <Form.Root schema={UserFeedback} defaultValues={defaultValues} onSave={onSave}>
-      <Form.Viewport>
-        <Form.Content>
-          <Form.FieldSet />
-          <Form.Submit icon='ph--paper-plane-tilt--regular' label={t('send feedback label')} disabled={disabled} />
-        </Form.Content>
-      </Form.Viewport>
-    </Form.Root>
-  );
-};

package/src/containers/HelpContainer/HelpContainer.tsx

@@ -1,55 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import React, { useCallback, useState } from 'react';
-
-import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
-import { LayoutOperation } from '@dxos/app-toolkit';
-import { runAndForwardErrors } from '@dxos/effect';
-import { useAsyncEffect } from '@dxos/react-hooks';
-import { osTranslations } from '@dxos/ui-theme';
-
-import { FeedbackForm } from '../../components';
-import { meta } from '../../meta';
-import { ObservabilityCapabilities, ObservabilityOperation, type UserFeedback } from '../../types';
-
-/** Renders the feedback form, disabling it when the feedback survey is unavailable. */
-export const HelpContainer = () => {
-  const { invokePromise } = useOperationInvoker();
-  const observability = useCapability(ObservabilityCapabilities.Observability);
-  const [feedbackAvailable, setFeedbackAvailable] = useState(false);
-
-  useAsyncEffect(
-    async (controller) => {
-      const available = await observability.isAvailable('feedback').pipe(
-        Effect.catchAll(() => Effect.succeed(false)),
-        Effect.catchAllDefect(() => Effect.succeed(false)),
-        runAndForwardErrors,
-      );
-      if (!controller.signal.aborted) {
-        setFeedbackAvailable(available);
-      }
-    },
-    [observability],
-  );
-
-  const handleSave = useCallback(
-    async (values: UserFeedback) => {
-      await invokePromise(ObservabilityOperation.CaptureUserFeedback, values);
-      await invokePromise(LayoutOperation.UpdateComplementary, { state: 'collapsed' });
-      await invokePromise(LayoutOperation.AddToast, {
-        id: `${meta.id}/feedback-success`,
-        icon: 'ph--paper-plane-tilt--regular',
-        duration: 3000,
-        title: ['feedback toast label', { ns: meta.id }],
-        description: ['feedback toast description', { ns: meta.id }],
-        closeLabel: ['close label', { ns: osTranslations }],
-      });
-    },
-    [invokePromise],
-  );
-
-  return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} />;
-};

package/src/containers/HelpContainer/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { HelpContainer } from './HelpContainer';
-
-export default HelpContainer;

package/src/containers/ObservabilitySettings/ObservabilitySettings.tsx

@@ -1,53 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-import React from 'react';
-
-import { useOperationInvoker } from '@dxos/app-framework/ui';
-import { Input, Message, useTranslation } from '@dxos/react-ui';
-import { Settings } from '@dxos/react-ui-form';
-
-import { meta } from '../../meta';
-import { ObservabilityOperation } from '../../types';
-
-export const ObservabilitySettingsSchema = Schema.mutable(
-  Schema.Struct({
-    enabled: Schema.Boolean,
-    // TODO(wittjosiah): Separate settings for each observability feature.
-    // metrics?: boolean;
-    // telemetry?: boolean;
-    // errors?: boolean;
-  }),
-);
-
-export type ObservabilitySettingsProps = Schema.Schema.Type<typeof ObservabilitySettingsSchema>;
-
-export type ObservabilitySettingsComponentProps = {
-  settings: ObservabilitySettingsProps;
-  onSettingsChange: (fn: (current: ObservabilitySettingsProps) => ObservabilitySettingsProps) => void;
-};
-
-export const ObservabilitySettings = ({ settings }: ObservabilitySettingsComponentProps) => {
-  const { t } = useTranslation(meta.id);
-  const { invokePromise } = useOperationInvoker();
-
-  return (
-    <Settings.Root>
-      <Settings.Section title={t('settings title', { ns: meta.id })}>
-        <Message.Root valence='info' classNames=' mb-form-padding'>
-          <Message.Content>{t('observability description')}</Message.Content>
-        </Message.Root>
-        <Settings.Group>
-          <Settings.ItemInput title={t('observability enabled label')}>
-            <Input.Switch
-              checked={settings.enabled}
-              onCheckedChange={(checked) => invokePromise(ObservabilityOperation.Toggle, { state: !!checked })}
-            />
-          </Settings.ItemInput>
-        </Settings.Group>
-      </Settings.Section>
-    </Settings.Root>
-  );
-};

package/src/containers/ObservabilitySettings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { ObservabilitySettings } from './ObservabilitySettings';
-
-export default ObservabilitySettings;

package/src/containers/index.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type ComponentType, lazy } from 'react';
-
-export { ObservabilitySettingsSchema } from './ObservabilitySettings/ObservabilitySettings';
-export type {
-  ObservabilitySettingsProps,
-  ObservabilitySettingsComponentProps,
-} from './ObservabilitySettings/ObservabilitySettings';
-
-export const HelpContainer: ComponentType<any> = lazy(() => import('./HelpContainer'));
-export const ObservabilitySettings: ComponentType<any> = lazy(() => import('./ObservabilitySettings'));

package/src/types/capabilities.ts

@@ -1,34 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Atom } from '@effect-atom/atom-react';
-import * as Schema from 'effect/Schema';
-
-import { Capability } from '@dxos/app-framework';
-import { type Client } from '@dxos/client';
-import { type Observability } from '@dxos/observability';
-
-import { type ObservabilitySettingsProps } from '../containers';
-import { meta } from '../meta';
-
-export namespace ObservabilityCapabilities {
-  export const Settings = Capability.make<Atom.Writable<ObservabilitySettingsProps>>(`${meta.id}/capability/settings`);
-
-  export const StateSchema = Schema.mutable(
-    Schema.Struct({
-      group: Schema.optional(Schema.String),
-      notified: Schema.optional(Schema.Boolean),
-    }),
-  );
-
-  export type State = Schema.Schema.Type<typeof StateSchema>;
-
-  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
-
-  export const Observability = Capability.make<Observability.Observability>(`${meta.id}/capability/observability`);
-}
-
-// NOTE: This is cloned from the client plugin to avoid circular dependencies.
-// TODO(burdon): Figure out how to share defs.
-export const ClientCapability = Capability.make<Client>('dxos.org/plugin/client/capability/client');

package/src/types/events.ts

@@ -1,15 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { ActivationEvent } from '@dxos/app-framework';
-import { AppActivationEvents } from '@dxos/app-toolkit';
-
-import { meta } from '../meta';
-
-export namespace ObservabilityEvents {
-  export const StateReady: ActivationEvent.ActivationEvent = AppActivationEvents.createStateEvent(meta.id);
-}
-
-// NOTE: This is cloned from the client plugin to avoid circular dependencies.
-export const ClientReadyEvent = ActivationEvent.make('dxos.org/plugin/client/event/client-ready');

package/src/types/schema.ts

@@ -1,84 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Capability } from '@dxos/app-framework';
-import { Format } from '@dxos/echo';
-import { Operation } from '@dxos/operation';
-
-import { meta } from '../meta';
-import { translations } from '../translations';
-
-const t = translations[0]['en-US'][meta.id];
-
-export const UserFeedback = Schema.Struct({
-  message: Format.Text.pipe(
-    Schema.nonEmptyString(),
-    Schema.maxLength(4_096),
-    Schema.annotations({
-      title: t['feedback textarea label'],
-      description: t['feedback textarea placeholder'],
-    }),
-  ),
-  includeLogs: Schema.Boolean.pipe(
-    Schema.annotations({
-      title: t['include debug logs label'],
-    }),
-    Schema.optional,
-  ),
-});
-
-export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
-
-const OBSERVABILITY_OPERATION = `${meta.id}/operation`;
-
-/**
- * Operations for the Observability plugin.
- */
-export namespace ObservabilityOperation {
-  export const Toggle = Operation.make({
-    meta: {
-      key: `${OBSERVABILITY_OPERATION}/toggle`,
-      name: 'Toggle Observability',
-      description: 'Toggle observability on or off.',
-    },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        state: Schema.optional(Schema.Boolean),
-      }),
-      output: Schema.Boolean,
-    },
-  });
-
-  export const CaptureUserFeedback = Operation.make({
-    meta: {
-      key: `${OBSERVABILITY_OPERATION}/capture-feedback`,
-      name: 'Capture User Feedback',
-      description: 'Capture user feedback.',
-    },
-    services: [Capability.Service],
-    schema: {
-      input: UserFeedback,
-      output: Schema.Void,
-    },
-  });
-
-  export const SendEvent = Operation.make({
-    meta: {
-      key: `${OBSERVABILITY_OPERATION}/send-event`,
-      name: 'Send Event',
-      description: 'Send an observability event.',
-    },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        name: Schema.String.annotations({ description: 'The name of the event.' }),
-        properties: Schema.optional(Schema.Any).annotations({ description: 'Event properties.' }),
-      }),
-      output: Schema.Void,
-    },
-  });
-}