@dxos/plugin-observability 0.7.4 → 0.7.5-labs.071a3e2

package/dist/lib/node-esm/chunk-UVEE3XZO.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';\n\nexport default {\n  id: OBSERVABILITY_PLUGIN,\n  name: 'Telemetry',\n} satisfies PluginMeta;\n\nconst OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';\nexport enum ObservabilityAction {\n  TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,\n  SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,\n  CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,\n}\n\nexport type UserFeedback = {\n  name: string;\n  email: string;\n  message: string;\n};\n"],
-  "mappings": ";;;AAMO,IAAMA,uBAAuB;AAEpC,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,uBAAuB;;UACjBC,sBAAAA;wDACD,GAAGD,oBAAAA,SAA6B,IAAA;4DAC5B,GAAGA,oBAAAA,aAAiC,IAAA;uEACzB,GAAGA,oBAAAA,mBAAuC,IAAA;GAHxDC,wBAAAA,sBAAAA,CAAAA,EAAAA;",
-  "names": ["OBSERVABILITY_PLUGIN", "id", "name", "OBSERVABILITY_ACTION", "ObservabilityAction"]
-}

package/src/ObservabilityPlugin.tsx

@@ -1,221 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import {
-  type Plugin,
-  type PluginDefinition,
-  type IntentResolverProvides,
-  type SettingsProvides,
-  type SurfaceProvides,
-  type TranslationsProvides,
-  resolvePlugin,
-  parseIntentPlugin,
-  LayoutAction,
-  SettingsAction,
-  parsePluginHost,
-} from '@dxos/app-framework';
-import { EventSubscriptions } from '@dxos/async';
-import { create } from '@dxos/live-object';
-import { LocalStorageStore } from '@dxos/local-storage';
-import {
-  type Observability,
-  getTelemetryIdentifier,
-  setupTelemetryListeners,
-  isObservabilityDisabled,
-  storeObservabilityDisabled,
-  getObservabilityGroup,
-} from '@dxos/observability';
-import type { EventOptions } from '@dxos/observability/segment';
-import { parseClientPlugin } from '@dxos/plugin-client';
-
-import { ObservabilitySettings, type ObservabilitySettingsProps } from './components';
-import meta, { OBSERVABILITY_PLUGIN, ObservabilityAction, type UserFeedback } from './meta';
-import translations from './translations';
-
-export type ObservabilityPluginState = {
-  group?: string;
-  notified?: boolean;
-};
-
-export type ObservabilityPluginProvides = IntentResolverProvides &
-  SurfaceProvides &
-  SettingsProvides<ObservabilitySettingsProps> &
-  TranslationsProvides & {
-    observability: ObservabilityPluginState;
-  };
-
-export const parseObservabilityPlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any).observability ? (plugin as Plugin<ObservabilityPluginProvides>) : undefined;
-
-export const ObservabilityPlugin = (options: {
-  namespace: string;
-  observability: () => Promise<Observability>;
-}): PluginDefinition<ObservabilityPluginProvides> => {
-  const settings = create<ObservabilitySettingsProps>({});
-  const state = new LocalStorageStore<ObservabilityPluginState>(OBSERVABILITY_PLUGIN);
-  const subscriptions = new EventSubscriptions();
-  let observability: Observability | undefined;
-
-  return {
-    meta,
-    initialize: async () => {
-      settings.enabled = !(await isObservabilityDisabled(options.namespace));
-      state.values.group = await getObservabilityGroup(options.namespace);
-      state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
-    },
-    ready: async (plugins) => {
-      const pluginHost = resolvePlugin(plugins, parsePluginHost);
-      const clientPlugin = resolvePlugin(plugins, parseClientPlugin);
-      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);
-
-      const dispatch = intentPlugin?.provides?.intent?.dispatch;
-      if (!dispatch) {
-        return;
-      }
-
-      const sendPrivacyNotice = async () => {
-        const environment = clientPlugin?.provides?.client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
-        const notify =
-          environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');
-        if (!state.values.notified && notify) {
-          await dispatch({
-            action: LayoutAction.SET_LAYOUT,
-            data: {
-              element: 'toast',
-              subject: {
-                id: `${OBSERVABILITY_PLUGIN}/notice`,
-                // TODO(wittjosiah): Non-react translation utils.
-                title: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast label'],
-                description: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast description'],
-                duration: Infinity,
-                icon: 'ph--info--regular',
-                actionLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action label'],
-                actionAlt: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action alt'],
-                closeLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast close label'],
-                onAction: () => dispatch({ action: SettingsAction.OPEN, data: { plugin: OBSERVABILITY_PLUGIN } }),
-              },
-            },
-          });
-
-          state.values.notified = true;
-        }
-      };
-
-      // Initialize asynchronously in the background, not in plugin initialization.
-      // Should not block application startup.
-      void options.observability().then(async (obs) => {
-        observability = obs;
-
-        // Ensure errors are tagged with enabled plugins to help with reproductions.
-        pluginHost?.provides?.plugins?.enabled?.map((plugin) =>
-          observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'),
-        );
-
-        // Start client observability (i.e. not running as shared worker)
-        // TODO(nf): how to prevent multiple instances for single shared worker?
-        const client = clientPlugin?.provides?.client;
-        if (!client) {
-          return;
-        }
-
-        await dispatch({
-          action: ObservabilityAction.SEND_EVENT,
-          data: {
-            name: 'page.load',
-            properties: {
-              href: window.location.href,
-              // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
-              loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,
-            },
-          },
-        });
-
-        setupTelemetryListeners(options.namespace, client, observability);
-
-        await Promise.all([
-          observability.setIdentityTags(client.services.services),
-          observability.startRuntimeMetrics(client),
-          observability.startNetworkMetrics(client.services.services),
-          observability.startSpacesMetrics(client, options.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();
-            }
-          });
-        }
-      });
-    },
-    unload: async () => {
-      subscriptions.clear();
-      await observability?.close();
-    },
-    provides: {
-      intent: {
-        resolver: async (intent, plugins) => {
-          const client = resolvePlugin(plugins, parseClientPlugin)?.provides?.client;
-          if (!client || !observability) {
-            return;
-          }
-
-          switch (intent.action) {
-            case ObservabilityAction.TOGGLE:
-              settings.enabled = !settings.enabled;
-              observability.event({
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.observability.toggle`,
-                properties: {
-                  enabled: settings.enabled,
-                },
-              });
-              observability.setMode(settings.enabled ? 'basic' : 'disabled');
-              await storeObservabilityDisabled(options.namespace, !settings.enabled);
-              return { data: settings.enabled };
-
-            case ObservabilityAction.SEND_EVENT: {
-              const data = intent.data as EventOptions;
-              const event = {
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.${data.name}`,
-                properties: {
-                  ...data.properties,
-                },
-              };
-              observability.event(event);
-              return { data: event };
-            }
-
-            case ObservabilityAction.CAPTURE_USER_FEEDBACK: {
-              const feedback = intent.data as UserFeedback;
-
-              observability.captureUserFeedback(feedback.email, feedback.name, feedback.message);
-              return { data: true };
-            }
-          }
-        },
-      },
-      observability: state.values,
-      settings,
-      surface: {
-        component: ({ role, data }) => {
-          switch (role) {
-            case 'settings':
-              return data.plugin === meta.id ? <ObservabilitySettings settings={settings} /> : null;
-          }
-
-          return null;
-        },
-      },
-      translations,
-    },
-  };
-};