@dxos/plugin-observability 0.8.4-main.c4373fc → 0.8.4-main.d05673bc65

package/dist/types/src/capabilities/intent-resolver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent-resolver.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/intent-resolver.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAgB,KAAK,aAAa,EAA+B,MAAM,qBAAqB,CAAC;yBAUlG,wBAAwB;IAAE,OAAO,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AAArF,wBAsDK"}

package/dist/types/src/capabilities/react-surface.d.ts

@@ -1,4 +0,0 @@
-import { Capabilities } from '@dxos/app-framework';
-declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<Capabilities.ReactSurface>>;
-export default _default;
-//# sourceMappingURL=react-surface.d.ts.map

package/dist/types/src/capabilities/react-surface.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"react-surface.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-surface.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAA8B,MAAM,qBAAqB,CAAC;;AAM/E,wBAcK"}

package/dist/types/src/capabilities/settings.d.ts

@@ -1,4 +0,0 @@
-import { Capabilities } from '@dxos/app-framework';
-declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<Capabilities.Settings>>;
-export default _default;
-//# sourceMappingURL=settings.d.ts.map

package/dist/types/src/capabilities/settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/settings.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;;AAMhE,wBAUE"}

package/dist/types/src/capabilities/state.d.ts

@@ -1,6 +0,0 @@
-import { ObservabilityCapabilities } from './capabilities';
-declare const _default: ({ namespace }: {
-    namespace: string;
-}) => Promise<import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<ObservabilityCapabilities.State>>>;
-export default _default;
-//# sourceMappingURL=state.d.ts.map

package/dist/types/src/capabilities/state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/state.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;yBAErC,eAAe;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE;AAA1D,wBASE"}

package/dist/types/src/components/FeedbackForm.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-import { UserFeedback } from '../types';
-export declare const FeedbackForm: ({ onSave }: {
-    onSave: (values: UserFeedback) => void;
-}) => React.JSX.Element;
-//# sourceMappingURL=FeedbackForm.d.ts.map

package/dist/types/src/components/FeedbackForm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeedbackForm.d.ts","sourceRoot":"","sources":["../../../../src/components/FeedbackForm.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAwC,MAAM,OAAO,CAAC;AAO7D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AA+CxC,eAAO,MAAM,YAAY,GAAI,YAAY;IAAE,MAAM,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;CAAE,sBAuBlF,CAAC"}

package/dist/types/src/components/HelpContainer.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-export declare const HelpContainer: () => React.JSX.Element;
-//# sourceMappingURL=HelpContainer.d.ts.map

package/dist/types/src/components/HelpContainer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HelpContainer.d.ts","sourceRoot":"","sources":["../../../../src/components/HelpContainer.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAsB,MAAM,OAAO,CAAC;AAS3C,eAAO,MAAM,aAAa,yBA0BzB,CAAC"}

package/dist/types/src/components/ObservabilitySettings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ObservabilitySettings.d.ts","sourceRoot":"","sources":["../../../../src/components/ObservabilitySettings.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,OAAO,CAAC;AAS1B,eAAO,MAAM,2BAA2B;;GAQvC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhG,eAAO,MAAM,qBAAqB,GAAI,cAAc;IAAE,QAAQ,EAAE,0BAA0B,CAAA;CAAE,sBAqB3F,CAAC"}

package/dist/types/src/events.d.ts

@@ -1,5 +0,0 @@
-export declare namespace ObservabilityEvents {
-    const StateReady: import("@dxos/app-framework").ActivationEvent;
-}
-export declare const ClientReadyEvent: import("@dxos/app-framework").ActivationEvent;
-//# sourceMappingURL=events.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/events.ts"],"names":[],"mappings":"AAQA,yBAAiB,mBAAmB,CAAC;IAC5B,MAAM,UAAU,+CAAmC,CAAC;CAC5D;AAGD,eAAO,MAAM,gBAAgB,+CAA2D,CAAC"}

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

@@ -1,47 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Rx } from '@effect-rx/rx-react';
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-import { ROOT_ID, createExtension } from '@dxos/plugin-graph';
-
-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: `${meta.id}/help`,
-      connector: (node) =>
-        Rx.make((get) =>
-          Function.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: meta.id }],
-                    icon: 'ph--question--regular',
-                    disposition: 'hidden',
-                    position: 'hoist',
-                  },
-                },
-              ];
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  ]);

package/src/capabilities/capabilities.ts

@@ -1,23 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability } from '@dxos/app-framework';
-import { type Client } from '@dxos/client';
-import { type Observability } from '@dxos/observability';
-
-import { meta } from '../meta';
-
-export namespace ObservabilityCapabilities {
-  export type State = {
-    group?: string;
-    notified?: boolean;
-  };
-  export const State = defineCapability<State>(`${meta.id}/capability/state`);
-
-  export const Observability = defineCapability<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 = defineCapability<Client>('dxos.org/plugin/client/capability/client');

package/src/capabilities/client-ready.ts

@@ -1,98 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import {
-  Capabilities,
-  LayoutAction,
-  type PluginContext,
-  SettingsAction,
-  contributes,
-  createIntent,
-} from '@dxos/app-framework';
-import { type Observability, setupTelemetryListeners } from '@dxos/observability';
-
-import { meta } from '../meta';
-import { ObservabilityAction } from '../types';
-
-import { ClientCapability, ObservabilityCapabilities } from './capabilities';
-
-type ClientReadyOptions = {
-  context: PluginContext;
-  namespace: string;
-  observability: Observability;
-};
-
-export default async ({ context, namespace, observability }: ClientReadyOptions) => {
-  const manager = context.getCapability(Capabilities.PluginManager);
-  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-  const state = context.getCapability(ObservabilityCapabilities.State);
-  const client = context.getCapability(ClientCapability);
-
-  const sendPrivacyNotice = async () => {
-    const environment = client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
-    const notify =
-      environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');
-    if (!state.notified && notify) {
-      await dispatch(
-        createIntent(LayoutAction.AddToast, {
-          part: 'toast',
-          subject: {
-            id: `${meta.id}/notice`,
-            title: ['observability toast label', { ns: meta.id }],
-            description: ['observability toast description', { ns: meta.id }],
-            duration: Infinity,
-            icon: 'ph--info--regular',
-            actionLabel: ['observability toast action label', { ns: meta.id }],
-            actionAlt: ['observability toast action alt', { ns: meta.id }],
-            closeLabel: ['observability toast close label', { ns: meta.id }],
-            onAction: () => dispatch(createIntent(SettingsAction.Open, { plugin: meta.id })),
-          },
-        }),
-      );
-
-      state.notified = true;
-    }
-  };
-
-  // Ensure errors are tagged with enabled plugins to help with reproductions.
-  manager.enabled.map((plugin) => observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'));
-
-  await dispatch(
-    createIntent(ObservabilityAction.SendEvent, {
-      name: 'page.load',
-      properties: {
-        // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
-        loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,
-      },
-    }),
-  );
-
-  // Start client observability (i.e. not running as shared worker)
-  // TODO(nf): how to prevent multiple instances for single shared worker?
-  const cleanup = setupTelemetryListeners(namespace, client, observability);
-
-  await Promise.all([
-    observability.setIdentityTags(client.services.services),
-    observability.startRuntimeMetrics(client),
-    observability.startNetworkMetrics(client.services.services),
-    observability.startSpacesMetrics(client, namespace),
-  ]);
-
-  if (client.halo.identity.get()) {
-    await sendPrivacyNotice();
-  } else {
-    const subscription = client.halo.identity.subscribe(async (identity) => {
-      if (identity && observability) {
-        await sendPrivacyNotice();
-        await observability.setIdentityTags(client.services.services);
-        subscription.unsubscribe();
-      }
-    });
-  }
-
-  return contributes(ObservabilityCapabilities.Observability, observability, async () => {
-    cleanup();
-    await observability.close();
-  });
-};

package/src/capabilities/intent-resolver.ts

@@ -1,69 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, IntentAction, type PluginContext, contributes, createResolver } from '@dxos/app-framework';
-import { log } from '@dxos/log';
-import { getTelemetryIdentity, storeObservabilityDisabled } from '@dxos/observability';
-
-import { type ObservabilitySettingsProps } from '../components';
-import { meta } from '../meta';
-import { ObservabilityAction } from '../types';
-
-import { ClientCapability, ObservabilityCapabilities } from './capabilities';
-
-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>(meta.id)!.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/capabilities/react-surface.tsx

@@ -1,27 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { SettingsStore } from '@dxos/local-storage';
-
-import { HelpContainer, ObservabilitySettings, type ObservabilitySettingsProps } from '../components';
-import { meta } from '../meta';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: meta.id,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<ObservabilitySettingsProps> } =>
-        data.subject instanceof SettingsStore && data.subject.prefix === meta.id,
-      component: ({ data: { subject } }) => <ObservabilitySettings settings={subject.value} />,
-    }),
-    createSurface({
-      id: `${meta.id}/help`,
-      role: 'deck-companion--help',
-      component: () => <HelpContainer />,
-    }),
-  ]);

package/src/capabilities/settings.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { live } from '@dxos/live-object';
-
-import { type ObservabilitySettingsProps, ObservabilitySettingsSchema } from '../components';
-import { meta } from '../meta';
-
-export default () => {
-  const settings = live<ObservabilitySettingsProps>({
-    enabled: true,
-  });
-
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: ObservabilitySettingsSchema,
-    value: settings,
-  });
-};

package/src/capabilities/state.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
-import { getObservabilityGroup } from '@dxos/observability';
-
-import { meta } from '../meta';
-
-import { ObservabilityCapabilities } from './capabilities';
-
-export default async ({ namespace }: { namespace: string }) => {
-  const state = new LocalStorageStore<ObservabilityCapabilities.State>(meta.id);
-
-  state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
-
-  // NOTE: This is not stored in local storage such that it can be accessed by workers.
-  state.values.group = await getObservabilityGroup(namespace);
-
-  return contributes(ObservabilityCapabilities.State, state.values, () => state.close());
-};

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/internal';
-import { IconButton, Input, useTranslation } from '@dxos/react-ui';
-import { FormProvider, useFormContext, useInputProps } from '@dxos/react-ui-form';
-
-import { meta } from '../meta';
-import { UserFeedback } from '../types';
-
-const defaultValues: UserFeedback = { message: '' };
-
-const FormContent = () => {
-  const { t } = useTranslation(meta.id);
-  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,41 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-import React, { useCallback } from 'react';
-
-import { LayoutAction, chain, createIntent, useIntentDispatcher } from '@dxos/app-framework';
-
-import { meta } from '../meta';
-import { ObservabilityAction, type UserFeedback } from '../types';
-
-import { FeedbackForm } from './FeedbackForm';
-
-export const HelpContainer = () => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  const handleSave = useCallback(
-    (values: UserFeedback) =>
-      dispatch(
-        Function.pipe(
-          createIntent(ObservabilityAction.CaptureUserFeedback, values),
-          chain(LayoutAction.UpdateComplementary, { part: 'complementary', options: { state: 'collapsed' } }),
-          chain(LayoutAction.AddToast, {
-            part: 'toast',
-            subject: {
-              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: 'os' }],
-            },
-          }),
-        ),
-      ),
-    [dispatch],
-  );
-
-  return <FeedbackForm onSave={handleSave} />;
-};

package/src/components/ObservabilitySettings.tsx

@@ -1,48 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-import React from 'react';
-
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { Input, Message, useTranslation } from '@dxos/react-ui';
-import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
-
-import { meta } 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(meta.id);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  return (
-    <ControlPage>
-      <ControlSection title={t('settings title', { ns: meta.id })}>
-        <Message.Root valence='info' classNames='container-max-width mbe-cardSpacingBlock'>
-          <Message.Content>{t('observability description')}</Message.Content>
-        </Message.Root>
-        <ControlGroup>
-          <ControlItemInput title={t('observability enabled label')}>
-            <Input.Switch
-              checked={settings.enabled}
-              onCheckedChange={(checked) => dispatch(createIntent(ObservabilityAction.Toggle, { state: !!checked }))}
-            />
-          </ControlItemInput>
-        </ControlGroup>
-      </ControlSection>
-    </ControlPage>
-  );
-};

package/src/events.ts

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