@dxos/observability 0.8.3 → 0.8.4-main.1068cf700f

package/dist/types/src/storage/node.test.js

@@ -0,0 +1,103 @@
+//
+// Copyright 2025 DXOS.org
+//
+import { existsSync } from 'node:fs';
+import { mkdir, readFile, rm, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import yaml from 'js-yaml';
+import { validate as validateUuid } from 'uuid';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import { getObservabilityGroup, isObservabilityDisabled, showObservabilityBanner, storeObservabilityDisabled, storeObservabilityGroup, } from './node';
+let configDir;
+beforeEach(async () => {
+    configDir = join(tmpdir(), `observability-test-${Date.now()}-${Math.random().toString(36).slice(2)}`);
+    // Clean env vars.
+    delete process.env.DX_DISABLE_OBSERVABILITY;
+    delete process.env.DX_OBSERVABILITY_GROUP;
+});
+afterEach(async () => {
+    if (existsSync(configDir)) {
+        await rm(configDir, { recursive: true, force: true });
+    }
+});
+describe('node storage', () => {
+    test('creates config directory if missing', async () => {
+        expect(existsSync(configDir)).toBe(false);
+        await isObservabilityDisabled(configDir);
+        expect(existsSync(configDir)).toBe(true);
+    });
+    test('initializes state with UUID and writes observability.yml', async () => {
+        await isObservabilityDisabled(configDir);
+        const content = await readFile(join(configDir, 'observability.yml'), 'utf-8');
+        const state = yaml.load(content);
+        expect(validateUuid(state.installationId)).toBe(true);
+        expect(state.disabled).toBe(false);
+    });
+    test('isObservabilityDisabled returns false by default', async () => {
+        const disabled = await isObservabilityDisabled(configDir);
+        expect(disabled).toBe(false);
+    });
+    test('storeObservabilityDisabled persists to file', async () => {
+        await storeObservabilityDisabled(configDir, true);
+        const content = await readFile(join(configDir, 'observability.yml'), 'utf-8');
+        const state = yaml.load(content);
+        expect(state.disabled).toBe(true);
+    });
+    test('isObservabilityDisabled reads persisted value', async () => {
+        await storeObservabilityDisabled(configDir, true);
+        const disabled = await isObservabilityDisabled(configDir);
+        expect(disabled).toBe(true);
+    });
+    test('getObservabilityGroup returns undefined by default', async () => {
+        const group = await getObservabilityGroup(configDir);
+        expect(group).toBeUndefined();
+    });
+    test('storeObservabilityGroup persists and reads back', async () => {
+        await storeObservabilityGroup(configDir, 'beta-testers');
+        const group = await getObservabilityGroup(configDir);
+        expect(group).toBe('beta-testers');
+    });
+    test('respects DX_DISABLE_OBSERVABILITY env var', async () => {
+        process.env.DX_DISABLE_OBSERVABILITY = 'true';
+        const disabled = await isObservabilityDisabled(configDir);
+        expect(disabled).toBe(true);
+    });
+    test('respects DX_OBSERVABILITY_GROUP env var on initial creation', async () => {
+        process.env.DX_OBSERVABILITY_GROUP = 'alpha';
+        const group = await getObservabilityGroup(configDir);
+        expect(group).toBe('alpha');
+    });
+    test('validates UUID in existing state file', async () => {
+        await mkdir(configDir, { recursive: true });
+        const state = {
+            installationId: '550e8400-e29b-41d4-a716-446655440000',
+            disabled: false,
+        };
+        await writeFile(join(configDir, 'observability.yml'), yaml.dump(state), 'utf-8');
+        const disabled = await isObservabilityDisabled(configDir);
+        expect(disabled).toBe(false);
+    });
+    test('reinitializes if UUID is invalid', async () => {
+        await mkdir(configDir, { recursive: true });
+        const badState = { installationId: 'not-a-uuid', disabled: true };
+        await writeFile(join(configDir, 'observability.yml'), yaml.dump(badState), 'utf-8');
+        // Should reinitialize with a fresh UUID.
+        await isObservabilityDisabled(configDir);
+        const content = await readFile(join(configDir, 'observability.yml'), 'utf-8');
+        const state = yaml.load(content);
+        expect(validateUuid(state.installationId)).toBe(true);
+        // Reinitialized state uses env var defaults, not the persisted bad state.
+        expect(state.disabled).toBe(false);
+    });
+    test('showObservabilityBanner prints once then is silent', async () => {
+        await mkdir(configDir, { recursive: true });
+        const bannerCb = vi.fn();
+        await showObservabilityBanner(configDir, bannerCb);
+        expect(bannerCb).toHaveBeenCalledTimes(1);
+        bannerCb.mockClear();
+        await showObservabilityBanner(configDir, bannerCb);
+        expect(bannerCb).not.toHaveBeenCalled();
+    });
+});
+//# sourceMappingURL=node.test.js.map

package/dist/types/src/storage/node.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.test.js","sourceRoot":"","sources":["../../../../src/storage/node.test.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE3E,OAAO,EAEL,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,QAAQ,CAAC;AAEhB,IAAI,SAAiB,CAAC;AAEtB,UAAU,CAAC,KAAK,IAAI,EAAE;IACpB,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,sBAAsB,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtG,kBAAkB;IAClB,OAAO,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,KAAK,IAAI,EAAE;IACnB,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiC,CAAC;QACjE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,0BAA0B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiC,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,0BAA0B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,uBAAuB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC3D,OAAO,CAAC,GAAG,CAAC,wBAAwB,GAAG,MAAM,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC7E,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,OAAO,CAAC;QAC7C,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAiC;YAC1C,cAAc,EAAE,sCAAsC;YACtD,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,MAAM,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAClE,MAAM,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QAEpF,yCAAyC;QACzC,MAAM,uBAAuB,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiC,CAAC;QACjE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,0EAA0E;QAC1E,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAEzB,MAAM,uBAAuB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE1C,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,uBAAuB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}