@dxos/plugin-observability 0.6.8-main.046e6cf

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @dxos/plugin-observability
+
+DXOS app framework plugin for hooking up app observability.
+
+## DXOS Resources
+
+- [Website](https://dxos.org)
+- [Developer Documentation](https://docs.dxos.org)
+- Talk to us on [Discord](https://dxos.org/discord)
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2023 © DXOS

package/dist/lib/browser/chunk-2ENNFNHI.mjs

@@ -0,0 +1,20 @@
+// packages/plugins/plugin-observability/src/meta.ts
+var OBSERVABILITY_PLUGIN = "dxos.org/plugin/observability";
+var meta_default = {
+  id: OBSERVABILITY_PLUGIN,
+  name: "Telemetry"
+};
+var OBSERVABILITY_ACTION = "dxos.org/plugin/observability";
+var ObservabilityAction;
+(function(ObservabilityAction2) {
+  ObservabilityAction2[ObservabilityAction2["TOGGLE"] = `${OBSERVABILITY_ACTION}/toggle`] = "TOGGLE";
+  ObservabilityAction2[ObservabilityAction2["SEND_EVENT"] = `${OBSERVABILITY_ACTION}/send-event`] = "SEND_EVENT";
+  ObservabilityAction2[ObservabilityAction2["CAPTURE_USER_FEEDBACK"] = `${OBSERVABILITY_ACTION}/capture-feedback`] = "CAPTURE_USER_FEEDBACK";
+})(ObservabilityAction || (ObservabilityAction = {}));
+
+export {
+  OBSERVABILITY_PLUGIN,
+  meta_default,
+  ObservabilityAction
+};
+//# sourceMappingURL=chunk-2ENNFNHI.mjs.map

package/dist/lib/browser/chunk-2ENNFNHI.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/meta.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nexport const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';\n\nexport default {\n  id: OBSERVABILITY_PLUGIN,\n  name: 'Telemetry',\n};\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": ";AAIO,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/dist/lib/browser/index.mjs

@@ -0,0 +1,245 @@
+import {
+  OBSERVABILITY_PLUGIN,
+  ObservabilityAction,
+  meta_default
+} from "./chunk-2ENNFNHI.mjs";
+
+// packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx
+import { Info } from "@phosphor-icons/react";
+import { effect } from "@preact/signals-core";
+import React2 from "react";
+import { resolvePlugin, parseIntentPlugin as parseIntentPlugin2, parseNavigationPlugin, LayoutAction, SettingsAction, parsePluginHost } from "@dxos/app-framework";
+import { EventSubscriptions } from "@dxos/async";
+import { create } from "@dxos/echo-schema";
+import { LocalStorageStore } from "@dxos/local-storage";
+import { getTelemetryIdentifier, setupTelemetryListeners, isObservabilityDisabled, storeObservabilityDisabled, getObservabilityGroup } from "@dxos/observability";
+import { parseClientPlugin } from "@dxos/plugin-client";
+import { getSize, mx } from "@dxos/react-ui-theme";
+
+// packages/plugins/plugin-observability/src/components/ObservabilitySettings.tsx
+import React from "react";
+import { parseIntentPlugin, useResolvePlugin } from "@dxos/app-framework";
+import { SettingsValue } from "@dxos/plugin-settings";
+import { Input, Message, useTranslation } from "@dxos/react-ui";
+var ObservabilitySettings = ({ settings }) => {
+  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
+  const intentPlugin = useResolvePlugin(parseIntentPlugin);
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, intentPlugin && /* @__PURE__ */ React.createElement(SettingsValue, {
+    label: t("observability enabled label"),
+    secondary: /* @__PURE__ */ React.createElement(Message.Root, {
+      valence: "info"
+    }, /* @__PURE__ */ React.createElement(Message.Body, null, t("observability description")))
+  }, /* @__PURE__ */ React.createElement(Input.Switch, {
+    checked: settings.enabled,
+    onCheckedChange: (checked) => intentPlugin.provides.intent.dispatch({
+      plugin: OBSERVABILITY_PLUGIN,
+      action: ObservabilityAction.TOGGLE,
+      data: {
+        state: !!checked
+      }
+    })
+  })));
+};
+
+// packages/plugins/plugin-observability/src/translations.ts
+var translations_default = [
+  {
+    "en-US": {
+      [OBSERVABILITY_PLUGIN]: {
+        "plugin name": "Telemetry",
+        "observability toast label": "Privacy Notice",
+        "observability toast description": "Composer collects usage and performance metrics to improve the product. No user data is collected.",
+        "observability toast action label": "Settings",
+        "observability toast action alt": "Open settings to learn more or to disable.",
+        "observability toast close label": "Okay",
+        "observability enabled label": "Enable telemetry",
+        // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.
+        "observability description": "When enabled, basic usage data will be sent to the DXOS team in order to improve the product. This may include performance metrics, error logs, and usage data. No personally identifiable information, other than your public key, is included with this data and no private data ever leaves your devices."
+      }
+    }
+  }
+];
+
+// packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx
+var parseObservabilityPlugin = (plugin) => (plugin?.provides).observability ? plugin : void 0;
+var ObservabilityPlugin = (options) => {
+  const settings = create({});
+  const state = new LocalStorageStore(OBSERVABILITY_PLUGIN);
+  const subscriptions = new EventSubscriptions();
+  let observability;
+  return {
+    meta: meta_default,
+    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 navigationPlugin = resolvePlugin(plugins, parseNavigationPlugin);
+      const clientPlugin = resolvePlugin(plugins, parseClientPlugin);
+      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin2);
+      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 !== "circleci" && !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_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast label"],
+                description: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast description"],
+                duration: Infinity,
+                icon: (props) => /* @__PURE__ */ React2.createElement(Info, {
+                  className: mx(getSize(5), props.className),
+                  weight: "duotone",
+                  ...props
+                }),
+                iconSymbol: "ph--info--duotone",
+                actionLabel: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast action label"],
+                actionAlt: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast action alt"],
+                closeLabel: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast close label"],
+                onAction: () => dispatch({
+                  action: SettingsAction.OPEN,
+                  data: {
+                    plugin: OBSERVABILITY_PLUGIN
+                  }
+                })
+              }
+            }
+          });
+          state.values.notified = true;
+        }
+      };
+      void options.observability().then(async (obs) => {
+        observability = obs;
+        pluginHost?.provides?.plugins?.enabled?.map((plugin) => observability?.setTag(`pluginEnabled-${plugin}`, "true", "errors"));
+        const client = clientPlugin?.provides?.client;
+        if (!client) {
+          return;
+        }
+        subscriptions.add(effect(() => {
+          const _ = navigationPlugin?.provides?.location?.active;
+          observability?.page({
+            identityId: getTelemetryIdentifier(client)
+          });
+        }));
+        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;
+              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;
+              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_default.id ? /* @__PURE__ */ React2.createElement(ObservabilitySettings, {
+                settings
+              }) : null;
+          }
+          return null;
+        }
+      },
+      translations: translations_default
+    }
+  };
+};
+
+// packages/plugins/plugin-observability/src/index.ts
+var src_default = ObservabilityPlugin;
+export {
+  ObservabilityPlugin,
+  src_default as default,
+  parseObservabilityPlugin
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/ObservabilityPlugin.tsx", "../../../src/components/ObservabilitySettings.tsx", "../../../src/translations.ts", "../../../src/index.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type IconProps, Info } from '@phosphor-icons/react';\nimport { effect } from '@preact/signals-core';\nimport React from 'react';\n\nimport {\n  type Plugin,\n  type PluginDefinition,\n  type IntentResolverProvides,\n  type SettingsProvides,\n  type SurfaceProvides,\n  type TranslationsProvides,\n  resolvePlugin,\n  parseIntentPlugin,\n  parseNavigationPlugin,\n  LayoutAction,\n  SettingsAction,\n  parsePluginHost,\n} from '@dxos/app-framework';\nimport { EventSubscriptions } from '@dxos/async';\nimport { create } from '@dxos/echo-schema';\nimport { LocalStorageStore } from '@dxos/local-storage';\nimport {\n  type Observability,\n  getTelemetryIdentifier,\n  setupTelemetryListeners,\n  isObservabilityDisabled,\n  storeObservabilityDisabled,\n  getObservabilityGroup,\n} from '@dxos/observability';\nimport type { EventOptions } from '@dxos/observability/segment';\nimport { parseClientPlugin } from '@dxos/plugin-client';\nimport { getSize, mx } from '@dxos/react-ui-theme';\n\nimport { ObservabilitySettings, type ObservabilitySettingsProps } from './components';\nimport meta, { OBSERVABILITY_PLUGIN, ObservabilityAction, type UserFeedback } from './meta';\nimport translations from './translations';\n\nexport type ObservabilityPluginState = {\n  group?: string;\n  notified?: boolean;\n};\n\nexport type ObservabilityPluginProvides = IntentResolverProvides &\n  SurfaceProvides &\n  SettingsProvides &\n  TranslationsProvides & {\n    observability: ObservabilityPluginState;\n  };\n\nexport const parseObservabilityPlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any).observability ? (plugin as Plugin<ObservabilityPluginProvides>) : undefined;\n\nexport const ObservabilityPlugin = (options: {\n  namespace: string;\n  observability: () => Promise<Observability>;\n}): PluginDefinition<ObservabilityPluginProvides> => {\n  const settings = create<ObservabilitySettingsProps>({});\n  const state = new LocalStorageStore<ObservabilityPluginState>(OBSERVABILITY_PLUGIN);\n  const subscriptions = new EventSubscriptions();\n  let observability: Observability | undefined;\n\n  return {\n    meta,\n    initialize: async () => {\n      settings.enabled = !(await isObservabilityDisabled(options.namespace));\n      state.values.group = await getObservabilityGroup(options.namespace);\n\n      state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });\n    },\n    ready: async (plugins) => {\n      const pluginHost = resolvePlugin(plugins, parsePluginHost);\n      const navigationPlugin = resolvePlugin(plugins, parseNavigationPlugin);\n      const clientPlugin = resolvePlugin(plugins, parseClientPlugin);\n      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);\n\n      const dispatch = intentPlugin?.provides?.intent?.dispatch;\n      if (!dispatch) {\n        return;\n      }\n\n      const sendPrivacyNotice = async () => {\n        const environment = clientPlugin?.provides?.client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;\n        const notify =\n          environment && environment !== 'circleci' && !environment.endsWith('.local') && !environment.endsWith('.lan');\n        if (!state.values.notified && notify) {\n          await dispatch({\n            action: LayoutAction.SET_LAYOUT,\n            data: {\n              element: 'toast',\n              subject: {\n                id: `${OBSERVABILITY_PLUGIN}/notice`,\n                // TODO(wittjosiah): Non-react translation utils.\n                title: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast label'],\n                description: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast description'],\n                duration: Infinity,\n                icon: (props: IconProps) => (\n                  <Info className={mx(getSize(5), props.className)} weight='duotone' {...props} />\n                ),\n                iconSymbol: 'ph--info--duotone',\n                actionLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action label'],\n                actionAlt: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action alt'],\n                closeLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast close label'],\n                onAction: () => dispatch({ action: SettingsAction.OPEN, data: { plugin: OBSERVABILITY_PLUGIN } }),\n              },\n            },\n          });\n\n          state.values.notified = true;\n        }\n      };\n\n      // Initialize asynchronously in the background, not in plugin initialization.\n      // Should not block application startup.\n      void options.observability().then(async (obs) => {\n        observability = obs;\n\n        // Ensure errors are tagged with enabled plugins to help with reproductions.\n        pluginHost?.provides?.plugins?.enabled?.map((plugin) =>\n          observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'),\n        );\n\n        // Start client observability (i.e. not running as shared worker)\n        // TODO(nf): how to prevent multiple instances for single shared worker?\n        const client = clientPlugin?.provides?.client;\n        if (!client) {\n          return;\n        }\n\n        subscriptions.add(\n          effect(() => {\n            // Read active to subscribe to changes.\n            const _ = navigationPlugin?.provides?.location?.active;\n\n            observability?.page({\n              identityId: getTelemetryIdentifier(client),\n            });\n          }),\n        );\n\n        await dispatch({\n          action: ObservabilityAction.SEND_EVENT,\n          data: {\n            name: 'page.load',\n            properties: {\n              href: window.location.href,\n              // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?\n              loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,\n            },\n          },\n        });\n\n        setupTelemetryListeners(options.namespace, client, observability);\n\n        await Promise.all([\n          observability.setIdentityTags(client.services.services),\n          observability.startRuntimeMetrics(client),\n          observability.startNetworkMetrics(client.services.services),\n          observability.startSpacesMetrics(client, options.namespace),\n        ]);\n\n        if (client.halo.identity.get()) {\n          await sendPrivacyNotice();\n        } else {\n          const subscription = client.halo.identity.subscribe(async (identity) => {\n            if (identity && observability) {\n              await sendPrivacyNotice();\n              await observability.setIdentityTags(client.services.services);\n              subscription.unsubscribe();\n            }\n          });\n        }\n      });\n    },\n    unload: async () => {\n      subscriptions.clear();\n      await observability?.close();\n    },\n    provides: {\n      intent: {\n        resolver: async (intent, plugins) => {\n          const client = resolvePlugin(plugins, parseClientPlugin)?.provides?.client;\n          if (!client || !observability) {\n            return;\n          }\n\n          switch (intent.action) {\n            case ObservabilityAction.TOGGLE:\n              settings.enabled = !settings.enabled;\n              observability.event({\n                identityId: getTelemetryIdentifier(client),\n                name: `${options.namespace}.observability.toggle`,\n                properties: {\n                  enabled: settings.enabled,\n                },\n              });\n              observability.setMode(settings.enabled ? 'basic' : 'disabled');\n              await storeObservabilityDisabled(options.namespace, !settings.enabled);\n              return { data: settings.enabled };\n\n            case ObservabilityAction.SEND_EVENT: {\n              const data = intent.data as EventOptions;\n              const event = {\n                identityId: getTelemetryIdentifier(client),\n                name: `${options.namespace}.${data.name}`,\n                properties: {\n                  ...data.properties,\n                },\n              };\n              observability.event(event);\n              return { data: event };\n            }\n\n            case ObservabilityAction.CAPTURE_USER_FEEDBACK: {\n              const feedback = intent.data as UserFeedback;\n\n              observability.captureUserFeedback(feedback.email, feedback.name, feedback.message);\n              return { data: true };\n            }\n          }\n        },\n      },\n      observability: state.values,\n      settings,\n      surface: {\n        component: ({ role, data }) => {\n          switch (role) {\n            case 'settings':\n              return data.plugin === meta.id ? <ObservabilitySettings settings={settings} /> : null;\n          }\n\n          return null;\n        },\n      },\n      translations,\n    },\n  };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { parseIntentPlugin, useResolvePlugin } from '@dxos/app-framework';\nimport { SettingsValue } from '@dxos/plugin-settings';\nimport { Input, Message, useTranslation } from '@dxos/react-ui';\n\nimport { OBSERVABILITY_PLUGIN, ObservabilityAction } from '../meta';\n\nexport type ObservabilitySettingsProps = {\n  enabled?: boolean;\n  // TODO(wittjosiah): Separate settings for each observability feature.\n  // metrics?: boolean;\n  // telemetry?: boolean;\n  // errors?: boolean;\n};\n\nexport const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {\n  const { t } = useTranslation(OBSERVABILITY_PLUGIN);\n  const intentPlugin = useResolvePlugin(parseIntentPlugin);\n\n  return (\n    <>\n      {intentPlugin && (\n        <SettingsValue\n          label={t('observability enabled label')}\n          secondary={\n            <Message.Root valence='info'>\n              <Message.Body>{t('observability description')}</Message.Body>\n            </Message.Root>\n          }\n        >\n          <Input.Switch\n            checked={settings.enabled}\n            onCheckedChange={(checked) =>\n              intentPlugin.provides.intent.dispatch({\n                plugin: OBSERVABILITY_PLUGIN,\n                action: ObservabilityAction.TOGGLE,\n                data: { state: !!checked },\n              })\n            }\n          />\n        </SettingsValue>\n      )}\n    </>\n  );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { OBSERVABILITY_PLUGIN } from './meta';\n\nexport default [\n  {\n    'en-US': {\n      [OBSERVABILITY_PLUGIN]: {\n        'plugin name': 'Telemetry',\n        'observability toast label': 'Privacy Notice',\n        'observability toast description':\n          'Composer collects usage and performance metrics to improve the product. No user data is collected.',\n        'observability toast action label': 'Settings',\n        'observability toast action alt': 'Open settings to learn more or to disable.',\n        'observability toast close label': 'Okay',\n        'observability enabled label': 'Enable telemetry',\n        // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.\n        'observability description':\n          'When enabled, basic usage data will be sent to the DXOS team in order to improve the product. This may include performance metrics, error logs, and usage data. No personally identifiable information, other than your public key, is included with this data and no private data ever leaves your devices.',\n      },\n    },\n  },\n];\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { ObservabilityPlugin } from './ObservabilityPlugin';\n\nexport default ObservabilityPlugin;\n\nexport * from './ObservabilityPlugin';\n"],
+  "mappings": ";;;;;;;AAIA,SAAyBA,YAAY;AACrC,SAASC,cAAc;AACvB,OAAOC,YAAW;AAElB,SAOEC,eACAC,qBAAAA,oBACAC,uBACAC,cACAC,gBACAC,uBACK;AACP,SAASC,0BAA0B;AACnC,SAASC,cAAc;AACvB,SAASC,yBAAyB;AAClC,SAEEC,wBACAC,yBACAC,yBACAC,4BACAC,6BACK;AAEP,SAASC,yBAAyB;AAClC,SAASC,SAASC,UAAU;;;AC/B5B,OAAOC,WAAW;AAElB,SAASC,mBAAmBC,wBAAwB;AACpD,SAASC,qBAAqB;AAC9B,SAASC,OAAOC,SAASC,sBAAsB;AAYxC,IAAMC,wBAAwB,CAAC,EAAEC,SAAQ,MAA4C;AAC1F,QAAM,EAAEC,EAAC,IAAKC,eAAeC,oBAAAA;AAC7B,QAAMC,eAAeC,iBAAiBC,iBAAAA;AAEtC,SACE,sBAAA,cAAA,MAAA,UAAA,MACGF,gBACC,sBAAA,cAACG,eAAAA;IACCC,OAAOP,EAAE,6BAAA;IACTQ,WACE,sBAAA,cAACC,QAAQC,MAAI;MAACC,SAAQ;OACpB,sBAAA,cAACF,QAAQG,MAAI,MAAEZ,EAAE,2BAAA,CAAA,CAAA;KAIrB,sBAAA,cAACa,MAAMC,QAAM;IACXC,SAAShB,SAASiB;IAClBC,iBAAiB,CAACF,YAChBZ,aAAae,SAASC,OAAOC,SAAS;MACpCC,QAAQnB;MACRoB,QAAQC,oBAAoBC;MAC5BC,MAAM;QAAEC,OAAO,CAAC,CAACX;MAAQ;IAC3B,CAAA;;AAOd;;;AC3CA,IAAA,uBAAe;EACb;IACE,SAAS;MACP,CAACY,oBAAAA,GAAuB;QACtB,eAAe;QACf,6BAA6B;QAC7B,mCACE;QACF,oCAAoC;QACpC,kCAAkC;QAClC,mCAAmC;QACnC,+BAA+B;;QAE/B,6BACE;MACJ;IACF;EACF;;;;AF8BK,IAAMC,2BAA2B,CAACC,YACtCA,QAAQC,UAAiBC,gBAAiBF,SAAiDG;AAEvF,IAAMC,sBAAsB,CAACC,YAAAA;AAIlC,QAAMC,WAAWC,OAAmC,CAAC,CAAA;AACrD,QAAMC,QAAQ,IAAIC,kBAA4CC,oBAAAA;AAC9D,QAAMC,gBAAgB,IAAIC,mBAAAA;AAC1B,MAAIV;AAEJ,SAAO;IACLW;IACAC,YAAY,YAAA;AACVR,eAASS,UAAU,CAAE,MAAMC,wBAAwBX,QAAQY,SAAS;AACpET,YAAMU,OAAOC,QAAQ,MAAMC,sBAAsBf,QAAQY,SAAS;AAElET,YAAMa,KAAK;QAAEC,KAAK;QAAYC,MAAMd,kBAAkBe,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MAAG,CAAA;IACvF;IACAC,OAAO,OAAOC,YAAAA;AACZ,YAAMC,aAAaC,cAAcF,SAASG,eAAAA;AAC1C,YAAMC,mBAAmBF,cAAcF,SAASK,qBAAAA;AAChD,YAAMC,eAAeJ,cAAcF,SAASO,iBAAAA;AAC5C,YAAMC,eAAeN,cAAcF,SAASS,kBAAAA;AAE5C,YAAMC,WAAWF,cAAclC,UAAUqC,QAAQD;AACjD,UAAI,CAACA,UAAU;AACb;MACF;AAEA,YAAME,oBAAoB,YAAA;AACxB,cAAMC,cAAcP,cAAchC,UAAUwC,QAAQC,QAAQxB,OAAOyB,SAASC,KAAKC,KAAKC;AACtF,cAAMC,SACJP,eAAeA,gBAAgB,cAAc,CAACA,YAAYQ,SAAS,QAAA,KAAa,CAACR,YAAYQ,SAAS,MAAA;AACxG,YAAI,CAACxC,MAAMU,OAAO+B,YAAYF,QAAQ;AACpC,gBAAMV,SAAS;YACba,QAAQC,aAAaC;YACrBC,MAAM;cACJC,SAAS;cACTC,SAAS;gBACPC,IAAI,GAAG9C,oBAAAA;;gBAEP+C,OAAOC,qBAAa,CAAA,EAAG,OAAA,EAAShD,oBAAAA,EAAsB,2BAAA;gBACtDiD,aAAaD,qBAAa,CAAA,EAAG,OAAA,EAAShD,oBAAAA,EAAsB,iCAAA;gBAC5DkD,UAAUC;gBACVC,MAAM,CAACC,UACL,gBAAAC,OAAA,cAACC,MAAAA;kBAAKC,WAAWC,GAAGC,QAAQ,CAAA,GAAIL,MAAMG,SAAS;kBAAGG,QAAO;kBAAW,GAAGN;;gBAEzEO,YAAY;gBACZC,aAAab,qBAAa,CAAA,EAAG,OAAA,EAAShD,oBAAAA,EAAsB,kCAAA;gBAC5D8D,WAAWd,qBAAa,CAAA,EAAG,OAAA,EAAShD,oBAAAA,EAAsB,gCAAA;gBAC1D+D,YAAYf,qBAAa,CAAA,EAAG,OAAA,EAAShD,oBAAAA,EAAsB,iCAAA;gBAC3DgE,UAAU,MAAMrC,SAAS;kBAAEa,QAAQyB,eAAeC;kBAAMvB,MAAM;oBAAErD,QAAQU;kBAAqB;gBAAE,CAAA;cACjG;YACF;UACF,CAAA;AAEAF,gBAAMU,OAAO+B,WAAW;QAC1B;MACF;AAIA,WAAK5C,QAAQH,cAAa,EAAG2E,KAAK,OAAOC,QAAAA;AACvC5E,wBAAgB4E;AAGhBlD,oBAAY3B,UAAU0B,SAASZ,SAASgE,IAAI,CAAC/E,WAC3CE,eAAe8E,OAAO,iBAAiBhF,MAAAA,IAAU,QAAQ,QAAA,CAAA;AAK3D,cAAMyC,SAASR,cAAchC,UAAUwC;AACvC,YAAI,CAACA,QAAQ;AACX;QACF;AAEA9B,sBAAcsE,IACZC,OAAO,MAAA;AAEL,gBAAMC,IAAIpD,kBAAkB9B,UAAUmF,UAAUC;AAEhDnF,yBAAeoF,KAAK;YAClBC,YAAYC,uBAAuB/C,MAAAA;UACrC,CAAA;QACF,CAAA,CAAA;AAGF,cAAMJ,SAAS;UACba,QAAQuC,oBAAoBC;UAC5BrC,MAAM;YACJsC,MAAM;YACNC,YAAY;cACVC,MAAMC,OAAOV,SAASS;;cAEtBE,cAAcD,OAAOE,YAAYC,OAAOC,eAAeJ,OAAOE,YAAYC,OAAOE;YACnF;UACF;QACF,CAAA;AAEAC,gCAAwB/F,QAAQY,WAAWwB,QAAQvC,aAAAA;AAEnD,cAAMmG,QAAQC,IAAI;UAChBpG,cAAcqG,gBAAgB9D,OAAO+D,SAASA,QAAQ;UACtDtG,cAAcuG,oBAAoBhE,MAAAA;UAClCvC,cAAcwG,oBAAoBjE,OAAO+D,SAASA,QAAQ;UAC1DtG,cAAcyG,mBAAmBlE,QAAQpC,QAAQY,SAAS;SAC3D;AAED,YAAIwB,OAAOmE,KAAKC,SAASC,IAAG,GAAI;AAC9B,gBAAMvE,kBAAAA;QACR,OAAO;AACL,gBAAMwE,eAAetE,OAAOmE,KAAKC,SAASG,UAAU,OAAOH,aAAAA;AACzD,gBAAIA,YAAY3G,eAAe;AAC7B,oBAAMqC,kBAAAA;AACN,oBAAMrC,cAAcqG,gBAAgB9D,OAAO+D,SAASA,QAAQ;AAC5DO,2BAAaE,YAAW;YAC1B;UACF,CAAA;QACF;MACF,CAAA;IACF;IACAC,QAAQ,YAAA;AACNvG,oBAAcwG,MAAK;AACnB,YAAMjH,eAAekH,MAAAA;IACvB;IACAnH,UAAU;MACRqC,QAAQ;QACN+E,UAAU,OAAO/E,QAAQX,YAAAA;AACvB,gBAAMc,SAASZ,cAAcF,SAASO,iBAAAA,GAAoBjC,UAAUwC;AACpE,cAAI,CAACA,UAAU,CAACvC,eAAe;AAC7B;UACF;AAEA,kBAAQoC,OAAOY,QAAM;YACnB,KAAKuC,oBAAoB6B;AACvBhH,uBAASS,UAAU,CAACT,SAASS;AAC7Bb,4BAAcqH,MAAM;gBAClBhC,YAAYC,uBAAuB/C,MAAAA;gBACnCkD,MAAM,GAAGtF,QAAQY,SAAS;gBAC1B2E,YAAY;kBACV7E,SAAST,SAASS;gBACpB;cACF,CAAA;AACAb,4BAAcsH,QAAQlH,SAASS,UAAU,UAAU,UAAA;AACnD,oBAAM0G,2BAA2BpH,QAAQY,WAAW,CAACX,SAASS,OAAO;AACrE,qBAAO;gBAAEsC,MAAM/C,SAASS;cAAQ;YAElC,KAAK0E,oBAAoBC,YAAY;AACnC,oBAAMrC,OAAOf,OAAOe;AACpB,oBAAMkE,QAAQ;gBACZhC,YAAYC,uBAAuB/C,MAAAA;gBACnCkD,MAAM,GAAGtF,QAAQY,SAAS,IAAIoC,KAAKsC,IAAI;gBACvCC,YAAY;kBACV,GAAGvC,KAAKuC;gBACV;cACF;AACA1F,4BAAcqH,MAAMA,KAAAA;AACpB,qBAAO;gBAAElE,MAAMkE;cAAM;YACvB;YAEA,KAAK9B,oBAAoBiC,uBAAuB;AAC9C,oBAAMC,WAAWrF,OAAOe;AAExBnD,4BAAc0H,oBAAoBD,SAASE,OAAOF,SAAShC,MAAMgC,SAASG,OAAO;AACjF,qBAAO;gBAAEzE,MAAM;cAAK;YACtB;UACF;QACF;MACF;MACAnD,eAAeM,MAAMU;MACrBZ;MACAyH,SAAS;QACPC,WAAW,CAAC,EAAEC,MAAM5E,KAAI,MAAE;AACxB,kBAAQ4E,MAAAA;YACN,KAAK;AACH,qBAAO5E,KAAKrD,WAAWa,aAAK2C,KAAK,gBAAAQ,OAAA,cAACkE,uBAAAA;gBAAsB5H;mBAAyB;UACrF;AAEA,iBAAO;QACT;MACF;MACAoD;IACF;EACF;AACF;;;AG1OA,IAAA,cAAeyE;",
+  "names": ["Info", "effect", "React", "resolvePlugin", "parseIntentPlugin", "parseNavigationPlugin", "LayoutAction", "SettingsAction", "parsePluginHost", "EventSubscriptions", "create", "LocalStorageStore", "getTelemetryIdentifier", "setupTelemetryListeners", "isObservabilityDisabled", "storeObservabilityDisabled", "getObservabilityGroup", "parseClientPlugin", "getSize", "mx", "React", "parseIntentPlugin", "useResolvePlugin", "SettingsValue", "Input", "Message", "useTranslation", "ObservabilitySettings", "settings", "t", "useTranslation", "OBSERVABILITY_PLUGIN", "intentPlugin", "useResolvePlugin", "parseIntentPlugin", "SettingsValue", "label", "secondary", "Message", "Root", "valence", "Body", "Input", "Switch", "checked", "enabled", "onCheckedChange", "provides", "intent", "dispatch", "plugin", "action", "ObservabilityAction", "TOGGLE", "data", "state", "OBSERVABILITY_PLUGIN", "parseObservabilityPlugin", "plugin", "provides", "observability", "undefined", "ObservabilityPlugin", "options", "settings", "create", "state", "LocalStorageStore", "OBSERVABILITY_PLUGIN", "subscriptions", "EventSubscriptions", "meta", "initialize", "enabled", "isObservabilityDisabled", "namespace", "values", "group", "getObservabilityGroup", "prop", "key", "type", "bool", "allowUndefined", "ready", "plugins", "pluginHost", "resolvePlugin", "parsePluginHost", "navigationPlugin", "parseNavigationPlugin", "clientPlugin", "parseClientPlugin", "intentPlugin", "parseIntentPlugin", "dispatch", "intent", "sendPrivacyNotice", "environment", "client", "config", "runtime", "app", "env", "DX_ENVIRONMENT", "notify", "endsWith", "notified", "action", "LayoutAction", "SET_LAYOUT", "data", "element", "subject", "id", "title", "translations", "description", "duration", "Infinity", "icon", "props", "React", "Info", "className", "mx", "getSize", "weight", "iconSymbol", "actionLabel", "actionAlt", "closeLabel", "onAction", "SettingsAction", "OPEN", "then", "obs", "map", "setTag", "add", "effect", "_", "location", "active", "page", "identityId", "getTelemetryIdentifier", "ObservabilityAction", "SEND_EVENT", "name", "properties", "href", "window", "loadDuration", "performance", "timing", "loadEventEnd", "loadEventStart", "setupTelemetryListeners", "Promise", "all", "setIdentityTags", "services", "startRuntimeMetrics", "startNetworkMetrics", "startSpacesMetrics", "halo", "identity", "get", "subscription", "subscribe", "unsubscribe", "unload", "clear", "close", "resolver", "TOGGLE", "event", "setMode", "storeObservabilityDisabled", "CAPTURE_USER_FEEDBACK", "feedback", "captureUserFeedback", "email", "message", "surface", "component", "role", "ObservabilitySettings", "ObservabilityPlugin"]
+}

package/dist/lib/browser/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/plugins/plugin-observability/src/meta.ts":{"bytes":2193,"imports":[],"format":"esm"},"packages/plugins/plugin-observability/src/components/ObservabilitySettings.tsx":{"bytes":5012,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/plugin-settings","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-observability/src/meta.ts","kind":"import-statement","original":"../meta"}],"format":"esm"},"packages/plugins/plugin-observability/src/components/index.ts":{"bytes":553,"imports":[{"path":"packages/plugins/plugin-observability/src/components/ObservabilitySettings.tsx","kind":"import-statement","original":"./ObservabilitySettings"}],"format":"esm"},"packages/plugins/plugin-observability/src/translations.ts":{"bytes":3430,"imports":[{"path":"packages/plugins/plugin-observability/src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx":{"bytes":31417,"imports":[{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"@preact/signals-core","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"@dxos/observability","kind":"import-statement","external":true},{"path":"@dxos/plugin-client","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"packages/plugins/plugin-observability/src/components/index.ts","kind":"import-statement","original":"./components"},{"path":"packages/plugins/plugin-observability/src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"packages/plugins/plugin-observability/src/translations.ts","kind":"import-statement","original":"./translations"}],"format":"esm"},"packages/plugins/plugin-observability/src/index.ts":{"bytes":869,"imports":[{"path":"packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx","kind":"import-statement","original":"./ObservabilityPlugin"},{"path":"packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx","kind":"import-statement","original":"./ObservabilityPlugin"}],"format":"esm"}},"outputs":{"packages/plugins/plugin-observability/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":19736},"packages/plugins/plugin-observability/dist/lib/browser/index.mjs":{"imports":[{"path":"packages/plugins/plugin-observability/dist/lib/browser/chunk-2ENNFNHI.mjs","kind":"import-statement"},{"path":"@phosphor-icons/react","kind":"import-statement","external":true},{"path":"@preact/signals-core","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/local-storage","kind":"import-statement","external":true},{"path":"@dxos/observability","kind":"import-statement","external":true},{"path":"@dxos/plugin-client","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/plugin-settings","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true}],"exports":["ObservabilityPlugin","default","parseObservabilityPlugin"],"entryPoint":"packages/plugins/plugin-observability/src/index.ts","inputs":{"packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx":{"bytesInOutput":7622},"packages/plugins/plugin-observability/src/components/ObservabilitySettings.tsx":{"bytesInOutput":1055},"packages/plugins/plugin-observability/src/components/index.ts":{"bytesInOutput":0},"packages/plugins/plugin-observability/src/translations.ts":{"bytesInOutput":1031},"packages/plugins/plugin-observability/src/index.ts":{"bytesInOutput":39}},"bytes":10312},"packages/plugins/plugin-observability/dist/lib/browser/meta.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"packages/plugins/plugin-observability/dist/lib/browser/meta.mjs":{"imports":[{"path":"packages/plugins/plugin-observability/dist/lib/browser/chunk-2ENNFNHI.mjs","kind":"import-statement"}],"exports":["OBSERVABILITY_PLUGIN","ObservabilityAction","default"],"entryPoint":"packages/plugins/plugin-observability/src/meta.ts","inputs":{},"bytes":221},"packages/plugins/plugin-observability/dist/lib/browser/chunk-2ENNFNHI.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":970},"packages/plugins/plugin-observability/dist/lib/browser/chunk-2ENNFNHI.mjs":{"imports":[],"exports":["OBSERVABILITY_PLUGIN","ObservabilityAction","meta_default"],"inputs":{"packages/plugins/plugin-observability/src/meta.ts":{"bytesInOutput":664}},"bytes":836}}}

package/dist/lib/browser/meta.mjs

@@ -0,0 +1,11 @@
+import {
+  OBSERVABILITY_PLUGIN,
+  ObservabilityAction,
+  meta_default
+} from "./chunk-2ENNFNHI.mjs";
+export {
+  OBSERVABILITY_PLUGIN,
+  ObservabilityAction,
+  meta_default as default
+};
+//# sourceMappingURL=meta.mjs.map

package/dist/lib/browser/meta.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

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

@@ -0,0 +1,15 @@
+import { type Plugin, type PluginDefinition, type IntentResolverProvides, type SettingsProvides, type SurfaceProvides, type TranslationsProvides } from '@dxos/app-framework';
+import { type Observability } from '@dxos/observability';
+export type ObservabilityPluginState = {
+    group?: string;
+    notified?: boolean;
+};
+export type ObservabilityPluginProvides = IntentResolverProvides & SurfaceProvides & SettingsProvides & TranslationsProvides & {
+    observability: ObservabilityPluginState;
+};
+export declare const parseObservabilityPlugin: (plugin?: Plugin) => Plugin<ObservabilityPluginProvides> | undefined;
+export declare const ObservabilityPlugin: (options: {
+    namespace: string;
+    observability: () => Promise<Observability>;
+}) => PluginDefinition<ObservabilityPluginProvides>;
+//# sourceMappingURL=ObservabilityPlugin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ObservabilityPlugin.d.ts","sourceRoot":"","sources":["../../../src/ObservabilityPlugin.tsx"],"names":[],"mappings":"AAQA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAO1B,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EACL,KAAK,aAAa,EAMnB,MAAM,qBAAqB,CAAC;AAS7B,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,GAC9D,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GAAG;IACrB,aAAa,EAAE,wBAAwB,CAAC;CACzC,CAAC;AAEJ,eAAO,MAAM,wBAAwB,YAAa,MAAM,oDAC+C,CAAC;AAExG,eAAO,MAAM,mBAAmB,YAAa;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7C,KAAG,gBAAgB,CAAC,2BAA2B,CAqL/C,CAAC"}

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

@@ -0,0 +1,8 @@
+import React from 'react';
+export type ObservabilitySettingsProps = {
+    enabled?: boolean;
+};
+export declare const ObservabilitySettings: ({ settings }: {
+    settings: ObservabilitySettingsProps;
+}) => React.JSX.Element;
+//# sourceMappingURL=ObservabilitySettings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ObservabilitySettings.d.ts","sourceRoot":"","sources":["../../../../src/components/ObservabilitySettings.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAQ1B,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC;CAKnB,CAAC;AAEF,eAAO,MAAM,qBAAqB,iBAAkB;IAAE,QAAQ,EAAE,0BAA0B,CAAA;CAAE,sBA6B3F,CAAC"}

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

@@ -0,0 +1,2 @@
+export * from './ObservabilitySettings';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAIA,cAAc,yBAAyB,CAAC"}

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

@@ -0,0 +1,4 @@
+import { ObservabilityPlugin } from './ObservabilityPlugin';
+export default ObservabilityPlugin;
+export * from './ObservabilityPlugin';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,eAAe,mBAAmB,CAAC;AAEnC,cAAc,uBAAuB,CAAC"}

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

@@ -0,0 +1,17 @@
+export declare const OBSERVABILITY_PLUGIN = "dxos.org/plugin/observability";
+declare const _default: {
+    id: string;
+    name: string;
+};
+export default _default;
+export declare enum ObservabilityAction {
+    TOGGLE = "dxos.org/plugin/observability/toggle",
+    SEND_EVENT = "dxos.org/plugin/observability/send-event",
+    CAPTURE_USER_FEEDBACK = "dxos.org/plugin/observability/capture-feedback"
+}
+export type UserFeedback = {
+    name: string;
+    email: string;
+    message: string;
+};
+//# sourceMappingURL=meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,oBAAoB,kCAAkC,CAAC;;;;;AAEpE,wBAGE;AAGF,oBAAY,mBAAmB;IAC7B,MAAM,yCAAmC;IACzC,UAAU,6CAAuC;IACjD,qBAAqB,mDAA6C;CACnE;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

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

@@ -0,0 +1,16 @@
+declare const _default: {
+    'en-US': {
+        "dxos.org/plugin/observability": {
+            'plugin name': string;
+            'observability toast label': string;
+            'observability toast description': string;
+            'observability toast action label': string;
+            'observability toast action alt': string;
+            'observability toast close label': string;
+            'observability enabled label': string;
+            'observability description': string;
+        };
+    };
+}[];
+export default _default;
+//# sourceMappingURL=translations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAMA,wBAkBE"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@dxos/plugin-observability",
+  "version": "0.6.8-main.046e6cf",
+  "description": "DXOS app framework plugin for hooking up app observability",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "exports": {
+    ".": {
+      "browser": "./dist/lib/browser/index.mjs",
+      "types": "./dist/types/src/index.d.ts"
+    },
+    "./meta": {
+      "browser": "./dist/lib/browser/meta.mjs",
+      "types": "./dist/types/src/meta.d.ts"
+    }
+  },
+  "types": "dist/types/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "meta": [
+        "dist/types/src/meta.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@preact/signals-core": "^1.6.0",
+    "localforage": "^1.10.0",
+    "@dxos/async": "0.6.8-main.046e6cf",
+    "@dxos/echo-schema": "0.6.8-main.046e6cf",
+    "@dxos/app-framework": "0.6.8-main.046e6cf",
+    "@dxos/context": "0.6.8-main.046e6cf",
+    "@dxos/log": "0.6.8-main.046e6cf",
+    "@dxos/observability": "0.6.8-main.046e6cf",
+    "@dxos/local-storage": "0.6.8-main.046e6cf",
+    "@dxos/plugin-client": "0.6.8-main.046e6cf",
+    "@dxos/plugin-settings": "0.6.8-main.046e6cf",
+    "@dxos/protocols": "0.6.8-main.046e6cf",
+    "@dxos/util": "0.6.8-main.046e6cf",
+    "@dxos/react-client": "0.6.8-main.046e6cf"
+  },
+  "devDependencies": {
+    "@phosphor-icons/react": "^2.1.5",
+    "@types/react": "~18.2.0",
+    "react": "~18.2.0",
+    "vite": "^5.3.4",
+    "@dxos/react-ui": "0.6.8-main.046e6cf",
+    "@dxos/react-ui-theme": "0.6.8-main.046e6cf",
+    "@dxos/storybook-utils": "0.6.8-main.046e6cf"
+  },
+  "peerDependencies": {
+    "@phosphor-icons/react": "^2.1.5",
+    "react": "^18.0.0",
+    "@dxos/react-ui": "0.6.8-main.046e6cf",
+    "@dxos/react-ui-theme": "0.6.8-main.046e6cf"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/ObservabilityPlugin.tsx

@@ -0,0 +1,241 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type IconProps, Info } from '@phosphor-icons/react';
+import { effect } from '@preact/signals-core';
+import React from 'react';
+
+import {
+  type Plugin,
+  type PluginDefinition,
+  type IntentResolverProvides,
+  type SettingsProvides,
+  type SurfaceProvides,
+  type TranslationsProvides,
+  resolvePlugin,
+  parseIntentPlugin,
+  parseNavigationPlugin,
+  LayoutAction,
+  SettingsAction,
+  parsePluginHost,
+} from '@dxos/app-framework';
+import { EventSubscriptions } from '@dxos/async';
+import { create } from '@dxos/echo-schema';
+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 { getSize, mx } from '@dxos/react-ui-theme';
+
+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 &
+  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 navigationPlugin = resolvePlugin(plugins, parseNavigationPlugin);
+      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 !== 'circleci' && !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: (props: IconProps) => (
+                  <Info className={mx(getSize(5), props.className)} weight='duotone' {...props} />
+                ),
+                iconSymbol: 'ph--info--duotone',
+                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;
+        }
+
+        subscriptions.add(
+          effect(() => {
+            // Read active to subscribe to changes.
+            const _ = navigationPlugin?.provides?.location?.active;
+
+            observability?.page({
+              identityId: getTelemetryIdentifier(client),
+            });
+          }),
+        );
+
+        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,
+    },
+  };
+};

package/src/components/ObservabilitySettings.tsx

@@ -0,0 +1,50 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { parseIntentPlugin, useResolvePlugin } from '@dxos/app-framework';
+import { SettingsValue } from '@dxos/plugin-settings';
+import { Input, Message, useTranslation } from '@dxos/react-ui';
+
+import { OBSERVABILITY_PLUGIN, ObservabilityAction } from '../meta';
+
+export type ObservabilitySettingsProps = {
+  enabled?: boolean;
+  // TODO(wittjosiah): Separate settings for each observability feature.
+  // metrics?: boolean;
+  // telemetry?: boolean;
+  // errors?: boolean;
+};
+
+export const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {
+  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
+  const intentPlugin = useResolvePlugin(parseIntentPlugin);
+
+  return (
+    <>
+      {intentPlugin && (
+        <SettingsValue
+          label={t('observability enabled label')}
+          secondary={
+            <Message.Root valence='info'>
+              <Message.Body>{t('observability description')}</Message.Body>
+            </Message.Root>
+          }
+        >
+          <Input.Switch
+            checked={settings.enabled}
+            onCheckedChange={(checked) =>
+              intentPlugin.provides.intent.dispatch({
+                plugin: OBSERVABILITY_PLUGIN,
+                action: ObservabilityAction.TOGGLE,
+                data: { state: !!checked },
+              })
+            }
+          />
+        </SettingsValue>
+      )}
+    </>
+  );
+};

package/src/components/index.ts

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

package/src/index.ts

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

package/src/meta.ts

@@ -0,0 +1,23 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';
+
+export default {
+  id: OBSERVABILITY_PLUGIN,
+  name: 'Telemetry',
+};
+
+const OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';
+export enum ObservabilityAction {
+  TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,
+  SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,
+  CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,
+}
+
+export type UserFeedback = {
+  name: string;
+  email: string;
+  message: string;
+};

package/src/translations.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { OBSERVABILITY_PLUGIN } from './meta';
+
+export default [
+  {
+    'en-US': {
+      [OBSERVABILITY_PLUGIN]: {
+        'plugin name': 'Telemetry',
+        'observability toast label': 'Privacy Notice',
+        'observability toast description':
+          'Composer collects usage and performance metrics to improve the product. No user data is collected.',
+        'observability toast action label': 'Settings',
+        'observability toast action alt': 'Open settings to learn more or to disable.',
+        'observability toast close label': 'Okay',
+        'observability enabled label': 'Enable telemetry',
+        // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.
+        'observability description':
+          'When enabled, basic usage data will be sent to the DXOS team in order to improve the product. This may include performance metrics, error logs, and usage data. No personally identifiable information, other than your public key, is included with this data and no private data ever leaves your devices.',
+      },
+    },
+  },
+];