@dxos/observability 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/src/{helpers/node-observability.ts → storage/node.ts}

@@ -1,18 +1,12 @@
+import yaml from 'js-yaml';
 //
 // Copyright 2022 DXOS.org
 //
 import { existsSync, statSync } from 'node:fs';
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
-
-import yaml from 'js-yaml';
 import { v4 as uuid, validate as validateUuid } from 'uuid';
 
-import type { Config } from '@dxos/client';
-import { log } from '@dxos/log';
-
-import { type Mode, Observability } from '../observability';
-
 /**
  * Print observability banner once per installation.
  */
@@ -22,7 +16,6 @@ export const showObservabilityBanner = async (configDir: string, bannercb: (inpu
     return;
   }
   bannercb(
-    // eslint-disable-next-line no-multi-str
     'Basic observability data will be sent to the DXOS team in order to improve the product. This includes \
     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. To disable sending \
@@ -32,7 +25,43 @@ export const showObservabilityBanner = async (configDir: string, bannercb: (inpu
   await writeFile(path, '', 'utf-8');
 };
 
-export const getObservabilityState = async (configDir: string): Promise<PersistentObservabilityState> => {
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const isObservabilityDisabled = async (configDir: string): Promise<boolean> => {
+  const observabilityState = await getObservabilityState(configDir);
+  return observabilityState.disabled;
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+// NOTE: read-modify-write is not atomic; concurrent callers could overwrite each other.
+// Acceptable here because writes are infrequent and triggered by explicit user action.
+export const storeObservabilityDisabled = async (configDir: string, value: boolean) => {
+  const observabilityState = await getObservabilityState(configDir);
+  observabilityState.disabled = value;
+  await writeFile(join(configDir, 'observability.yml'), yaml.dump(observabilityState), 'utf-8');
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const getObservabilityGroup = async (configDir: string): Promise<string | undefined> => {
+  const observabilityState = await getObservabilityState(configDir);
+  return observabilityState.group;
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const storeObservabilityGroup = async (configDir: string, value: string) => {
+  const observabilityState = await getObservabilityState(configDir);
+  observabilityState.group = value;
+  await writeFile(join(configDir, 'observability.yml'), yaml.dump(observabilityState), 'utf-8');
+};
+
+const getObservabilityState = async (configDir: string): Promise<PersistentObservabilityState> => {
   // check whether configDir exists and if it's a directory
 
   if (existsSync(configDir)) {
@@ -54,8 +83,8 @@ export const getObservabilityState = async (configDir: string): Promise<Persiste
 
 export type PersistentObservabilityState = {
   installationId: string;
+  disabled: boolean;
   group?: string;
-  mode: Mode;
 };
 
 // create initial state and write to file, using environment variables to override defaults.
@@ -63,8 +92,8 @@ const initializeState = async (idPath: string): Promise<PersistentObservabilityS
   // TODO(nf): read initial values from config or seed file
   const observabilityState = {
     installationId: uuid(),
+    disabled: process.env.DX_DISABLE_OBSERVABILITY ? true : false,
     group: process.env.DX_OBSERVABILITY_GROUP ?? undefined,
-    mode: (process.env.DX_DISABLE_OBSERVABILITY ? 'disabled' : (process.env.DX_OBSERVABILITY_MODE ?? 'basic')) as Mode,
   };
 
   await writeFile(
@@ -81,66 +110,7 @@ const validate = (contextString: string) => {
   if (Boolean(context.installationId) && validateUuid(context.installationId!)) {
     return {
       ...context,
-      mode: process.env.DX_DISABLE_OBSERVABILITY ? 'disabled' : (context.mode ?? 'basic'),
+      disabled: process.env.DX_DISABLE_OBSERVABILITY ? true : (context.disabled ?? false),
     };
   }
 };
-
-export type NodeObservabilityOptions = {
-  installationId: string;
-  group?: string;
-  namespace: string;
-  version: string;
-  config: Config;
-  mode?: Mode;
-  tracingEnable?: boolean;
-  replayEnable?: boolean;
-  // TODO(nf): options for providers?
-};
-
-export const initializeNodeObservability = async ({
-  namespace,
-  version,
-  config,
-  installationId,
-  group,
-  mode = 'basic',
-  tracingEnable = true,
-  replayEnable = true,
-}: NodeObservabilityOptions): Promise<Observability> => {
-  log('initializeCliObservability', { config });
-
-  // TODO(nf): make CLI build populate runtime.app.build config?
-  const release = `${namespace}@${version}`;
-  const environment = process.env.DX_ENVIRONMENT ?? 'unknown';
-
-  const observability = new Observability({
-    mode,
-    namespace,
-    release,
-    environment,
-    group,
-    errorLog: {
-      sentryInitOptions: {
-        environment,
-        release,
-        // TODO(wittjosiah): Configure this.
-        sampleRate: 1.0,
-      },
-    },
-  });
-
-  observability.setTag('installationId', installationId);
-
-  // TODO(nf): cache ipdata to avoid repeated requests
-  const IPDATA_API_KEY = config.get('runtime.app.env.DX_IPDATA_API_KEY');
-  try {
-    const res = await fetch(`https://api.ipdata.co/?api-key=${IPDATA_API_KEY}`);
-    const ipData = await res.json();
-    ipData && observability.setIPDataTelemetryTags(ipData);
-  } catch (err) {
-    observability?.captureException(err);
-  }
-
-  return observability;
-};

package/src/vite-import-meta.d.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/**
+ * Vite replaces `import.meta.env` at build time. Aligns with `vite/client` without taking a Vite dependency.
+ * @see https://vitejs.dev/guide/env-and-mode.html
+ */
+interface ImportMetaEnv {
+  readonly DEV: boolean;
+  readonly PROD: boolean;
+  readonly MODE: string;
+  readonly SSR: boolean;
+}

package/dist/lib/browser/chunk-5ICT2XF2.mjs

@@ -1 +0,0 @@
-//# sourceMappingURL=chunk-5ICT2XF2.mjs.map

package/dist/lib/browser/chunk-LJO63BXO.mjs

@@ -1,164 +0,0 @@
-// src/sentry/browser.ts
-import { breadcrumbsIntegration, browserTracingIntegration, feedbackIntegration, httpClientIntegration, metrics, addBreadcrumb as naturalAddBreadcrumb, captureException as naturalCaptureException, captureMessage as naturalCaptureMessage, init as naturalInit, sendFeedback as naturalSendFeedback, withScope as naturalWithScope, replayIntegration, setTag, startInactiveSpan } from "@sentry/browser";
-import { log } from "@dxos/log";
-import { TRACE_PROCESSOR } from "@dxos/tracing";
-import { setTag as setTag2, setTags, setUser } from "@sentry/browser";
-var __dxlog_file = "/__w/dxos/dxos/packages/sdk/observability/src/sentry/browser.ts";
-var init = (options) => {
-  try {
-    log("sentry init", options, {
-      F: __dxlog_file,
-      L: 38,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    naturalInit({
-      enabled: options.enable ?? true,
-      dsn: options.destination,
-      release: options.release,
-      environment: options.environment,
-      integrations: [
-        breadcrumbsIntegration({
-          console: false,
-          fetch: false
-        }),
-        httpClientIntegration({
-          failedRequestStatusCodes: [
-            // 401 errors are omitted as they happen as a part of the EDGE authentication flow.
-            [
-              400,
-              400
-            ],
-            [
-              402,
-              599
-            ]
-          ]
-        }),
-        feedbackIntegration({
-          autoInject: false
-        }),
-        ...options.tracing ? [
-          browserTracingIntegration()
-        ] : [],
-        ...options.replay ? [
-          replayIntegration({
-            blockAllMedia: true,
-            maskAllText: true
-          })
-        ] : []
-      ],
-      replaysSessionSampleRate: options.replaySampleRate,
-      replaysOnErrorSampleRate: options.replaySampleRateOnError,
-      tracesSampleRate: options.sampleRate,
-      transport: options.transport,
-      beforeSend: (event) => {
-        options.onError?.(event);
-        return event;
-      }
-    });
-    if (options.tracing) {
-      TRACE_PROCESSOR.remoteMetrics.registerProcessor(metrics);
-      TRACE_PROCESSOR.remoteTracing.registerProcessor({
-        startSpan: startInactiveSpan
-      });
-    }
-    Object.entries(options.properties ?? {}).forEach(([key, value]) => {
-      setTag(key, value);
-    });
-  } catch (err) {
-    log.catch("Failed to initialize sentry", err, {
-      F: __dxlog_file,
-      L: 78,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-  }
-};
-var addBreadcrumb = (breadcrumb) => {
-  try {
-    naturalAddBreadcrumb(breadcrumb);
-    log("add breadcrumb", breadcrumb, {
-      F: __dxlog_file,
-      L: 94,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-  } catch (err) {
-    log.catch("Failed to add breadcrumb", err, {
-      F: __dxlog_file,
-      L: 96,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-  }
-};
-var captureException = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureException(exception, captureContext);
-    log("capture exception", {
-      exception,
-      eventId,
-      ...captureContext
-    }, {
-      F: __dxlog_file,
-      L: 110,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    return eventId;
-  } catch (err) {
-    log.catch("Failed to capture exception", err, {
-      F: __dxlog_file,
-      L: 113,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    return "unknown";
-  }
-};
-var captureMessage = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureMessage(exception, captureContext);
-    log("capture message", {
-      exception,
-      eventId,
-      captureContext
-    }, {
-      F: __dxlog_file,
-      L: 121,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    return eventId;
-  } catch (err) {
-    log.catch("Failed to capture message", err, {
-      F: __dxlog_file,
-      L: 124,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    return "unknown";
-  }
-};
-var captureUserFeedback = (message) => {
-  return naturalSendFeedback({
-    message
-  }, {
-    includeReplay: true
-  });
-};
-var withScope = naturalWithScope;
-
-export {
-  init,
-  addBreadcrumb,
-  captureException,
-  captureMessage,
-  captureUserFeedback,
-  withScope,
-  setTag2 as setTag,
-  setTags,
-  setUser
-};
-//# sourceMappingURL=chunk-LJO63BXO.mjs.map

package/dist/lib/browser/chunk-LJO63BXO.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/sentry/browser.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport {\n  breadcrumbsIntegration,\n  browserTracingIntegration,\n  feedbackIntegration,\n  httpClientIntegration,\n  metrics,\n  addBreadcrumb as naturalAddBreadcrumb,\n  captureException as naturalCaptureException,\n  captureMessage as naturalCaptureMessage,\n  init as naturalInit,\n  sendFeedback as naturalSendFeedback,\n  withScope as naturalWithScope,\n  replayIntegration,\n  setTag,\n  startInactiveSpan,\n} from '@sentry/browser';\n\nimport { log } from '@dxos/log';\nimport { TRACE_PROCESSOR } from '@dxos/tracing';\n\nimport { type InitOptions } from './types';\n\n// Polyfill export.\nexport { setTag, setTags, setUser } from '@sentry/browser';\n\n/**\n * To use this SDK, call the init function as early as possible when loading the web page.\n * To set context information or send manual events, use the provided methods.\n *\n * @param options {InitOptions}\n */\nexport const init = (options: InitOptions) => {\n  try {\n    log('sentry init', options);\n    naturalInit({\n      enabled: options.enable ?? true,\n      dsn: options.destination,\n      release: options.release,\n      environment: options.environment,\n      integrations: [\n        breadcrumbsIntegration({ console: false, fetch: false }),\n        httpClientIntegration({\n          failedRequestStatusCodes: [\n            // 401 errors are omitted as they happen as a part of the EDGE authentication flow.\n            [400, 400],\n            [402, 599],\n          ],\n        }),\n        feedbackIntegration({ autoInject: false }),\n        ...(options.tracing ? [browserTracingIntegration()] : []),\n        ...(options.replay ? [replayIntegration({ blockAllMedia: true, maskAllText: true })] : []),\n      ],\n      replaysSessionSampleRate: options.replaySampleRate,\n      replaysOnErrorSampleRate: options.replaySampleRateOnError,\n      tracesSampleRate: options.sampleRate,\n      transport: options.transport,\n      beforeSend: (event) => {\n        options.onError?.(event);\n        return event;\n      },\n    });\n\n    if (options.tracing) {\n      TRACE_PROCESSOR.remoteMetrics.registerProcessor(metrics);\n      TRACE_PROCESSOR.remoteTracing.registerProcessor({\n        startSpan: startInactiveSpan,\n      });\n    }\n\n    Object.entries(options.properties ?? {}).forEach(([key, value]) => {\n      setTag(key, value);\n    });\n  } catch (err) {\n    log.catch('Failed to initialize sentry', err);\n  }\n};\n\n/**\n * Records a new breadcrumb which will be attached to future events.\n *\n * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.\n *\n * https://docs.sentry.io/platforms/javascript/enriching-events/breadcrumbs/\n *\n * @param breadcrumb — The breadcrumb to record.\n */\nexport const addBreadcrumb: typeof naturalAddBreadcrumb = (breadcrumb) => {\n  try {\n    naturalAddBreadcrumb(breadcrumb);\n    log('add breadcrumb', breadcrumb);\n  } catch (err) {\n    log.catch('Failed to add breadcrumb', err);\n  }\n};\n\n/**\n * Captures an exception event and sends it to Sentry.\n *\n * @param exception — An exception-like object.\n * @param captureContext — Additional scope data to apply to exception event.\n * @returns — The generated eventId.\n */\nexport const captureException: typeof naturalCaptureException = (exception, captureContext) => {\n  try {\n    const eventId = naturalCaptureException(exception, captureContext);\n    log('capture exception', { exception, eventId, ...captureContext });\n    return eventId;\n  } catch (err) {\n    log.catch('Failed to capture exception', err);\n    return 'unknown';\n  }\n};\n\nexport const captureMessage: typeof naturalCaptureMessage = (exception, captureContext) => {\n  try {\n    const eventId = naturalCaptureMessage(exception, captureContext);\n    log('capture message', { exception, eventId, captureContext });\n    return eventId;\n  } catch (err) {\n    log.catch('Failed to capture message', err);\n    return 'unknown';\n  }\n};\n\nexport const captureUserFeedback = (message: string) => {\n  return naturalSendFeedback({ message }, { includeReplay: true });\n};\n\nexport const withScope = naturalWithScope;\n"],
-  "mappings": ";AAIA,SACEA,wBACAC,2BACAC,qBACAC,uBACAC,SACAC,iBAAiBC,sBACjBC,oBAAoBC,yBACpBC,kBAAkBC,uBAClBC,QAAQC,aACRC,gBAAgBC,qBAChBC,aAAaC,kBACbC,mBACAC,QACAC,yBACK;AAEP,SAASC,WAAW;AACpB,SAASC,uBAAuB;AAKhC,SAASH,UAAAA,SAAQI,SAASC,eAAe;;AAQlC,IAAMZ,OAAO,CAACa,YAAAA;AACnB,MAAI;AACFJ,QAAI,eAAeI,SAAAA;;;;;;AACnBZ,gBAAY;MACVa,SAASD,QAAQE,UAAU;MAC3BC,KAAKH,QAAQI;MACbC,SAASL,QAAQK;MACjBC,aAAaN,QAAQM;MACrBC,cAAc;QACZ/B,uBAAuB;UAAEgC,SAAS;UAAOC,OAAO;QAAM,CAAA;QACtD9B,sBAAsB;UACpB+B,0BAA0B;;YAExB;cAAC;cAAK;;YACN;cAAC;cAAK;;;QAEV,CAAA;QACAhC,oBAAoB;UAAEiC,YAAY;QAAM,CAAA;WACpCX,QAAQY,UAAU;UAACnC,0BAAAA;YAA+B,CAAA;WAClDuB,QAAQa,SAAS;UAACpB,kBAAkB;YAAEqB,eAAe;YAAMC,aAAa;UAAK,CAAA;YAAM,CAAA;;MAEzFC,0BAA0BhB,QAAQiB;MAClCC,0BAA0BlB,QAAQmB;MAClCC,kBAAkBpB,QAAQqB;MAC1BC,WAAWtB,QAAQsB;MACnBC,YAAY,CAACC,UAAAA;AACXxB,gBAAQyB,UAAUD,KAAAA;AAClB,eAAOA;MACT;IACF,CAAA;AAEA,QAAIxB,QAAQY,SAAS;AACnBf,sBAAgB6B,cAAcC,kBAAkB/C,OAAAA;AAChDiB,sBAAgB+B,cAAcD,kBAAkB;QAC9CE,WAAWlC;MACb,CAAA;IACF;AAEAmC,WAAOC,QAAQ/B,QAAQgC,cAAc,CAAC,CAAA,EAAGC,QAAQ,CAAC,CAACC,KAAKC,KAAAA,MAAM;AAC5DzC,aAAOwC,KAAKC,KAAAA;IACd,CAAA;EACF,SAASC,KAAK;AACZxC,QAAIyC,MAAM,+BAA+BD,KAAAA;;;;;;EAC3C;AACF;AAWO,IAAMvD,gBAA6C,CAACyD,eAAAA;AACzD,MAAI;AACFxD,yBAAqBwD,UAAAA;AACrB1C,QAAI,kBAAkB0C,YAAAA;;;;;;EACxB,SAASF,KAAK;AACZxC,QAAIyC,MAAM,4BAA4BD,KAAAA;;;;;;EACxC;AACF;AASO,IAAMrD,mBAAmD,CAACwD,WAAWC,mBAAAA;AAC1E,MAAI;AACF,UAAMC,UAAUzD,wBAAwBuD,WAAWC,cAAAA;AACnD5C,QAAI,qBAAqB;MAAE2C;MAAWE;MAAS,GAAGD;IAAe,GAAA;;;;;;AACjE,WAAOC;EACT,SAASL,KAAK;AACZxC,QAAIyC,MAAM,+BAA+BD,KAAAA;;;;;;AACzC,WAAO;EACT;AACF;AAEO,IAAMnD,iBAA+C,CAACsD,WAAWC,mBAAAA;AACtE,MAAI;AACF,UAAMC,UAAUvD,sBAAsBqD,WAAWC,cAAAA;AACjD5C,QAAI,mBAAmB;MAAE2C;MAAWE;MAASD;IAAe,GAAA;;;;;;AAC5D,WAAOC;EACT,SAASL,KAAK;AACZxC,QAAIyC,MAAM,6BAA6BD,KAAAA;;;;;;AACvC,WAAO;EACT;AACF;AAEO,IAAMM,sBAAsB,CAACC,YAAAA;AAClC,SAAOrD,oBAAoB;IAAEqD;EAAQ,GAAG;IAAEC,eAAe;EAAK,CAAA;AAChE;AAEO,IAAMrD,YAAYC;",
-  "names": ["breadcrumbsIntegration", "browserTracingIntegration", "feedbackIntegration", "httpClientIntegration", "metrics", "addBreadcrumb", "naturalAddBreadcrumb", "captureException", "naturalCaptureException", "captureMessage", "naturalCaptureMessage", "init", "naturalInit", "sendFeedback", "naturalSendFeedback", "withScope", "naturalWithScope", "replayIntegration", "setTag", "startInactiveSpan", "log", "TRACE_PROCESSOR", "setTags", "setUser", "options", "enabled", "enable", "dsn", "destination", "release", "environment", "integrations", "console", "fetch", "failedRequestStatusCodes", "autoInject", "tracing", "replay", "blockAllMedia", "maskAllText", "replaysSessionSampleRate", "replaySampleRate", "replaysOnErrorSampleRate", "replaySampleRateOnError", "tracesSampleRate", "sampleRate", "transport", "beforeSend", "event", "onError", "remoteMetrics", "registerProcessor", "remoteTracing", "startSpan", "Object", "entries", "properties", "forEach", "key", "value", "err", "catch", "breadcrumb", "exception", "captureContext", "eventId", "captureUserFeedback", "message", "includeReplay"]
-}