@dxos/plugin-observability 0.8.3-staging.0fa589b → 0.8.4-main.03d5cd7b56

package/src/capabilities/intent-resolver.ts

@@ -1,68 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes, createResolver, IntentAction, type PluginContext } from '@dxos/app-framework';
-import { log } from '@dxos/log';
-import { getTelemetryIdentity, storeObservabilityDisabled } from '@dxos/observability';
-
-import { ClientCapability, ObservabilityCapabilities } from './capabilities';
-import { type ObservabilitySettingsProps } from '../components';
-import { OBSERVABILITY_PLUGIN } from '../meta';
-import { ObservabilityAction } from '../types';
-
-export default ({ context, namespace }: { context: PluginContext; namespace: string }) =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: IntentAction.Track,
-      resolve: (intent) => {
-        log.info('intent', { intent });
-      },
-    }),
-    createResolver({
-      intent: ObservabilityAction.Toggle,
-      resolve: async ({ state }) => {
-        const client = context.getCapability(ClientCapability);
-        const observability = context.getCapability(ObservabilityCapabilities.Observability);
-        const settings = context
-          .getCapability(Capabilities.SettingsStore)
-          .getStore<ObservabilitySettingsProps>(OBSERVABILITY_PLUGIN)!.value;
-        settings.enabled = state ?? !settings.enabled;
-        observability.track({
-          ...getTelemetryIdentity(client),
-          action: 'observability.toggle',
-          properties: {
-            enabled: settings.enabled,
-          },
-        });
-        observability.setMode(settings.enabled ? 'basic' : 'disabled');
-        await storeObservabilityDisabled(namespace, !settings.enabled);
-        return { data: settings.enabled };
-      },
-    }),
-    createResolver({
-      intent: ObservabilityAction.SendEvent,
-      resolve: (data) => {
-        const client = context.getCapability(ClientCapability);
-        const properties = 'properties' in data ? data.properties : {};
-
-        // NOTE: This is to ensure that events fired before observability is ready are still sent.
-        // TODO(wittjosiah): If the intent dispatcher supports concurrent actions in the future,
-        //   then this could be awaited still rather than voiding.
-        void context.waitForCapability(ObservabilityCapabilities.Observability).then((observability) => {
-          observability.track({
-            ...getTelemetryIdentity(client),
-            action: data.name,
-            properties,
-          });
-        });
-      },
-    }),
-    createResolver({
-      intent: ObservabilityAction.CaptureUserFeedback,
-      resolve: async (data) => {
-        const observability = context.getCapability(ObservabilityCapabilities.Observability);
-        observability.captureUserFeedback(data.message);
-      },
-    }),
-  ]);

package/src/components/FeedbackForm.tsx

@@ -1,82 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useRef, useState } from 'react';
-
-import { getSnapshot } from '@dxos/echo-schema';
-import { IconButton, Input, useTranslation } from '@dxos/react-ui';
-import { FormProvider, useFormContext, useInputProps } from '@dxos/react-ui-form';
-
-import { OBSERVABILITY_PLUGIN } from '../meta';
-import { UserFeedback } from '../types';
-
-const defaultValues: UserFeedback = { message: '' };
-
-const FormContent = () => {
-  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
-  const { handleSave, canSave } = useFormContext<UserFeedback>();
-
-  const messageProps = useInputProps(['message']);
-
-  return (
-    <div role='form' className='p-3 flex flex-col gap-2'>
-      <div role='none' className='space-b-1'>
-        <Input.Root validationValence={messageProps.getStatus().status}>
-          <Input.Label>{t('feedback text area label')}</Input.Label>
-          <Input.TextArea
-            classNames={'text-sm'}
-            rows={5}
-            cols={30}
-            placeholder={t('feedback text area placeholder')}
-            value={messageProps.getValue() ?? ''}
-            onChange={(e) => messageProps.onValueChange('string', e.target.value)}
-            // TODO(wittjosiah): This aggressively shows validation errors.
-            onBlur={messageProps.onBlur}
-          />
-          <Input.DescriptionAndValidation>
-            <Input.Validation>{messageProps.getStatus().error}</Input.Validation>
-          </Input.DescriptionAndValidation>
-        </Input.Root>
-      </div>
-
-      <div role='none' className='space-b-2'>
-        <IconButton
-          icon='ph--paper-plane-tilt--regular'
-          label={t('send feedback label')}
-          variant='primary'
-          type='submit'
-          classNames='is-full'
-          disabled={!canSave}
-          onClick={handleSave}
-        />
-      </div>
-    </div>
-  );
-};
-
-// TODO(wittjosiah): Use `Form`?
-export const FeedbackForm = ({ onSave }: { onSave: (values: UserFeedback) => void }) => {
-  const formRef = useRef<HTMLDivElement>(null);
-  const [_, update] = useState({});
-  const forceRender = useCallback(() => update({}), [update]);
-
-  const handleSave = useCallback(
-    (values: UserFeedback) => {
-      onSave(values);
-      // TODO(wittjosiah): Force re-render to clear the form.
-      forceRender();
-    },
-    [forceRender, onSave],
-  );
-
-  const initialValues = getSnapshot(defaultValues);
-
-  return (
-    <FormProvider formRef={formRef} schema={UserFeedback} initialValues={initialValues} onSave={handleSave}>
-      <div ref={formRef}>
-        <FormContent />
-      </div>
-    </FormProvider>
-  );
-};

package/src/components/HelpContainer.tsx

@@ -1,40 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { pipe } from 'effect';
-import React, { useCallback } from 'react';
-
-import { chain, createIntent, LayoutAction, useIntentDispatcher } from '@dxos/app-framework';
-
-import { FeedbackForm } from './FeedbackForm';
-import { OBSERVABILITY_PLUGIN } from '../meta';
-import { ObservabilityAction, type UserFeedback } from '../types';
-
-export const HelpContainer = () => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  const handleSave = useCallback(
-    (values: UserFeedback) =>
-      dispatch(
-        pipe(
-          createIntent(ObservabilityAction.CaptureUserFeedback, values),
-          chain(LayoutAction.UpdateComplementary, { part: 'complementary', options: { state: 'collapsed' } }),
-          chain(LayoutAction.AddToast, {
-            part: 'toast',
-            subject: {
-              id: `${OBSERVABILITY_PLUGIN}/feedback-success`,
-              icon: 'ph--paper-plane-tilt--regular',
-              duration: 3000,
-              title: ['feedback toast label', { ns: OBSERVABILITY_PLUGIN }],
-              description: ['feedback toast description', { ns: OBSERVABILITY_PLUGIN }],
-              closeLabel: ['close label', { ns: 'os' }],
-            },
-          }),
-        ),
-      ),
-    [dispatch],
-  );
-
-  return <FeedbackForm onSave={handleSave} />;
-};

package/src/components/ObservabilitySettings.tsx

@@ -1,48 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { Schema } from 'effect';
-import React from 'react';
-
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { Input, Message, useTranslation } from '@dxos/react-ui';
-import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
-
-import { OBSERVABILITY_PLUGIN } from '../meta';
-import { ObservabilityAction } 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 const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {
-  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  return (
-    <DeprecatedFormContainer>
-      <DeprecatedFormInput
-        label={t('observability enabled label')}
-        secondary={
-          <Message.Root valence='info'>
-            <Message.Content>{t('observability description')}</Message.Content>
-          </Message.Root>
-        }
-      >
-        <Input.Switch
-          checked={settings.enabled}
-          onCheckedChange={(checked) => dispatch(createIntent(ObservabilityAction.Toggle, { state: !!checked }))}
-        />
-      </DeprecatedFormInput>
-    </DeprecatedFormContainer>
-  );
-};

package/src/events.ts

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

package/src/types.ts

@@ -1,203 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Schema } from 'effect';
-
-import { Type } from '@dxos/echo';
-
-import { OBSERVABILITY_PLUGIN } from './meta';
-
-const nonEmpty = <S extends Schema.Schema.Any>(field: string) =>
-  Schema.nonEmptyString<S>({ message: () => `Missing field: ${field}` });
-
-const maxLength = <S extends Schema.Schema.Any>(field: string, length: number) =>
-  Schema.maxLength<S>(length, { message: () => `Exceeds max length (${length}): ${field}` });
-
-export const UserFeedback = Schema.Struct({
-  message: Schema.String.pipe(nonEmpty('Feedback'), maxLength('Feedback', 32_768)),
-});
-
-export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
-
-const OBSERVABILITY_ACTION = `${OBSERVABILITY_PLUGIN}/action`;
-
-export namespace ObservabilityAction {
-  export class Toggle extends Schema.TaggedClass<Toggle>()(`${OBSERVABILITY_ACTION}/toggle`, {
-    input: Schema.Struct({
-      state: Schema.optional(Schema.Boolean),
-    }),
-    output: Schema.Boolean,
-  }) {}
-
-  export class CaptureUserFeedback extends Schema.TaggedClass<CaptureUserFeedback>()(
-    `${OBSERVABILITY_ACTION}/capture-feedback`,
-    {
-      input: UserFeedback,
-      output: Schema.Void,
-    },
-  ) {}
-
-  /** Base intent for sending events. */
-  export class BaseSendEvent extends Schema.TaggedClass<BaseSendEvent>()(`${OBSERVABILITY_ACTION}/send-event`, {
-    input: Schema.Struct({
-      name: Schema.String,
-      properties: Schema.optional(Schema.Object),
-    }),
-    output: Schema.Void,
-  }) {}
-
-  /** Intent with strict types for first-party events. */
-  export class SendEvent extends Schema.TaggedClass<SendEvent>()(`${OBSERVABILITY_ACTION}/send-event`, {
-    // NOTE: Sort alphabetically by name.
-    input: Schema.Union(
-      Schema.Struct({
-        name: Schema.Literal('identity.create'),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('identity.join'),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('identity.recover'),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('identity.share'),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('navigation.activate'),
-        properties: Schema.Struct({
-          subjectId: Schema.String,
-          typename: Schema.optional(Schema.String),
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('page.load'),
-        properties: Schema.Struct({
-          loadDuration: Schema.Number,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('plugins.toggle'),
-        properties: Schema.Struct({
-          plugin: Schema.String,
-          enabled: Schema.Boolean,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.create'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.join'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.limit'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.lock'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.migrate'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          targetVersion: Schema.optional(Schema.String),
-          version: Schema.optional(Schema.String),
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.object.add'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          objectId: Schema.String,
-          typename: Schema.optional(Schema.String),
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.share'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('space.unlock'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.create'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.delete'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.message.add'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-          threadLength: Schema.Number,
-          messageId: Schema.String,
-          messageLength: Schema.Number,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.message.delete'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-          messageId: Schema.String,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.message.undo-delete'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-          messageId: Schema.String,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.message.update'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          messageId: Schema.String,
-          messageLength: Schema.Number,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.toggle-resolved'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-        }),
-      }),
-      Schema.Struct({
-        name: Schema.Literal('threads.undo-delete'),
-        properties: Schema.Struct({
-          spaceId: Type.SpaceId,
-          threadId: Schema.String,
-        }),
-      }),
-    ),
-    output: Schema.Void,
-  }) {}
-}