@reproapp/node-sdk 0.0.42 → 0.0.44

package/README.md

@@ -194,10 +194,11 @@ type ReproInitConfig = {
 ```
 
 Important options:
-- `tenantId`, `appId`, `appSecret`: Repro service credentials.
-- `appName`: Product or workspace label sent as `X-App-Name`.
+- `tenantId`, `appId`, `appSecret`: Repro application credentials.
+- `appName`: Application label sent as `X-App-Name`.
 - `serviceName`: Backend service label stored on request, trace, DB, queue, Redis,
-  and email events.
+  and email events. The SDK also registers this service with the application in
+  the background so admins can see its environments and privacy policy status.
 - `apiBase`: Repro API base URL. Used by backend live sessions and privacy policy fetches.
 - `captureHeaders`: Enables header capture. Sensitive headers are masked unless
   explicitly unmasked.

package/dist/index.d.ts

@@ -292,6 +292,7 @@ type BackendLiveTimingConfig = {
     segmentMaxDurationMs: number;
     segmentIdleMs: number;
 };
+declare function registerRuntimeService(cfg: ReproMiddlewareConfig): Promise<void>;
 declare function sanitizeTraceValueForPrivacy(value: any): any;
 declare function sanitizeMaterializedTraceValue(value: any): any;
 export declare function __materializePendingTraceEventsForWorker(payload: TraceMaterializationWorkerPayload): Promise<PendingTraceEventRecord[]>;
@@ -458,6 +459,7 @@ export declare const __reproTestHooks: {
     }): void;
     drainSdkBackgroundQueueForTest(): Promise<void>;
     resetSdkBackgroundQueuesForTest(): void;
+    registerRuntimeServiceForTest: typeof registerRuntimeService;
     setBackendLiveTimingForTest(override: Partial<BackendLiveTimingConfig> | null): void;
     runWithRequestContextForTest<T>(ctx: Partial<Ctx>, fn: () => T): T;
     getNativeMongoSuppressionCountForTest(): number;

package/dist/index.js

@@ -1813,6 +1813,47 @@ async function postLiveApiJson(cfg, liveMode, path, body) {
         return null;
     }
 }
+async function registerRuntimeService(cfg) {
+    const serviceName = typeof cfg.serviceName === 'string' ? cfg.serviceName.trim() : '';
+    const apiBase = resolveLiveApiBase(cfg, normalizeLiveModeConfig(cfg));
+    const fetchImpl = globalThis.fetch;
+    if (!serviceName ||
+        !apiBase ||
+        !cfg.appId ||
+        !cfg.appSecret ||
+        typeof fetchImpl !== 'function') {
+        return;
+    }
+    const controller = typeof AbortController === 'function' ? new AbortController() : null;
+    const timeout = setTimeout(() => controller?.abort(), 2500);
+    try {
+        timeout.unref?.();
+    }
+    catch { }
+    try {
+        await fetchImpl(`${apiBase}/v1/sdk/runtime-services`, {
+            method: 'POST',
+            headers: liveApiHeaders(cfg),
+            body: JSON.stringify({
+                serviceName,
+                environment: (0, privacy_1.normalizePrivacyEnvironment)(cfg.privacy?.environment),
+            }),
+            ...(controller ? { signal: controller.signal } : {}),
+        });
+    }
+    catch {
+        // Service discovery is best-effort and must never affect host startup.
+    }
+    finally {
+        try {
+            clearTimeout(timeout);
+        }
+        catch { }
+    }
+}
+function enqueueRuntimeServiceRegistration(cfg) {
+    scheduleSdkBackgroundWork(() => registerRuntimeService(cfg));
+}
 function enqueueLiveSessionStart(cfg, liveMode, payload) {
     scheduleSdkBackgroundWork(() => postLiveApi(cfg, liveMode, '/v1/live-sessions', payload), { priority: 'high' });
 }
@@ -3190,6 +3231,7 @@ async function ensureRuntimePrivacyPolicyLoaded(cfg) {
         appId: cfg.appId,
         appSecret: cfg.appSecret,
         appName: cfg.appName,
+        serviceName: cfg.serviceName,
         apiBase,
         environment: state.environment,
         fetchTimeoutMs: privacy?.fetchTimeoutMs,
@@ -3231,6 +3273,7 @@ async function initializeRuntimePrivacyPolicyAtStartup(cfg) {
             appId: cfg.appId,
             appSecret: cfg.appSecret,
             appName: cfg.appName,
+            serviceName: cfg.serviceName,
             apiBase,
             environment: state.environment,
             fetchTimeoutMs: privacy?.fetchTimeoutMs,
@@ -9835,6 +9878,7 @@ async function initRepro(cfg) {
     await installMongoDbImportHook();
     patchSendgridMail(integrationCfg);
     patchMongooseIntegration(reproAutoMiddlewareConfig);
+    enqueueRuntimeServiceRegistration(reproAutoMiddlewareConfig);
     await initializeRuntimePrivacyPolicyAtStartup(reproAutoMiddlewareConfig);
 }
 exports.initRepro = initRepro;
@@ -9866,6 +9910,7 @@ exports.__reproTestHooks = {
         lastClientActivityAt = 0;
         sdkBackgroundQuietUntil = 0;
     },
+    registerRuntimeServiceForTest: registerRuntimeService,
     setBackendLiveTimingForTest(override) {
         backendLiveTimingOverrideForTest = override;
     },

package/dist/privacy.d.ts

@@ -98,6 +98,7 @@ export declare function fetchApprovedRuntimePrivacyPolicy(params: {
     appId: string;
     appSecret?: string;
     appName?: string;
+    serviceName?: string;
     apiBase: string;
     environment: string;
     fetchTimeoutMs?: number;

package/dist/privacy.js

@@ -104,7 +104,13 @@ async function fetchApprovedRuntimePrivacyPolicy(params) {
             reason: !params.apiBase ? 'missing_config' : 'missing_credentials',
         };
     }
-    const url = `${params.apiBase}/v1/sdk/privacy-policy?environment=${encodeURIComponent(params.environment)}`;
+    const query = new URLSearchParams({
+        environment: params.environment,
+    });
+    if (typeof params.serviceName === 'string' && params.serviceName.trim()) {
+        query.set('serviceName', params.serviceName.trim());
+    }
+    const url = `${params.apiBase}/v1/sdk/privacy-policy?${query.toString()}`;
     const headers = {
         accept: 'application/json',
         'x-app-id': params.appId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reproapp/node-sdk",
-  "version": "0.0.42",
+  "version": "0.0.44",
   "description": "Repro Nest SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,7 @@
     "build": "tsc -p tsconfig.json",
     "dev": "tsc -p tsconfig.json --watch --preserveWatchOutput",
     "prepublishOnly": "npm run build",
-    "test": "npm run build && node test/unawaited.test.js && node test/integration-unawaited.js && node test/request-flush-timing.test.js && node test/request-capture-background.test.js && node test/init-auto-http-server.test.js && node test/backend-live-mode.test.js && node test/client-performance-regression.test.js && node test/request-manifest-priority.test.js && node test/runtime-no-double-invoke.test.js && node test/express-trace-http-args.test.js && node test/trace-batch-size.test.js && node test/sdk-background-priority.test.js && node test/ingest-queue-retention.test.js && node test/ingest-high-priority-retention.test.js && node test/ingest-critical-retention.test.js && node test/ingest-critical-retry-retention.test.js && node test/ingest-batching.test.js && node test/ingest-timeout.test.js && node -r ./tracer/register test/promise-map.test.js && node test/disable-subtree.test.js && node test/circular-capture.test.js && node test/wrap-plugin-arrow-args.test.js && node test/wrap-plugin-super-call.test.js && node test/function-arg-identity.test.js && node test/privacy-runtime-policy.test.js && node test/runtime-privacy-materialization.test.js && node test/kafka-runtime-privacy-policy.test.js && node test/amqplib-integration.test.js && node test/mongodb-integration.test.js && node test/mongodb-esm-import-hook.test.js && node test/mongodb-suppression-cleanup.test.js && node test/postgresql-integration.test.js",
+    "test": "npm run build && node test/unawaited.test.js && node test/integration-unawaited.js && node test/request-flush-timing.test.js && node test/request-capture-background.test.js && node test/init-auto-http-server.test.js && node test/backend-live-mode.test.js && node test/client-performance-regression.test.js && node test/request-manifest-priority.test.js && node test/runtime-no-double-invoke.test.js && node test/express-trace-http-args.test.js && node test/trace-batch-size.test.js && node test/sdk-background-priority.test.js && node test/runtime-service-registration.test.js && node test/ingest-queue-retention.test.js && node test/ingest-high-priority-retention.test.js && node test/ingest-critical-retention.test.js && node test/ingest-critical-retry-retention.test.js && node test/ingest-batching.test.js && node test/ingest-timeout.test.js && node -r ./tracer/register test/promise-map.test.js && node test/disable-subtree.test.js && node test/circular-capture.test.js && node test/wrap-plugin-arrow-args.test.js && node test/wrap-plugin-super-call.test.js && node test/function-arg-identity.test.js && node test/privacy-service-scope.test.js && node test/privacy-runtime-policy.test.js && node test/runtime-privacy-materialization.test.js && node test/kafka-runtime-privacy-policy.test.js && node test/amqplib-integration.test.js && node test/mongodb-integration.test.js && node test/mongodb-esm-import-hook.test.js && node test/mongodb-suppression-cleanup.test.js && node test/postgresql-integration.test.js",
     "test:containers": "npm run build && node test/runtime-no-double-invoke.testcontainers.test.js && node test/wrap-plugin-super-call.testcontainers.test.js && node test/function-arg-identity.testcontainers.test.js && node test/mongodb-mongoose-native-suppression.testcontainers.test.js && node test/postgresql-integrations.testcontainers.test.js"
   },
   "peerDependencies": {

package/src/index.ts

@@ -2250,6 +2250,55 @@ async function postLiveApiJson<T = Record<string, any>>(
     }
 }
 
+async function registerRuntimeService(
+    cfg: ReproMiddlewareConfig,
+): Promise<void> {
+    const serviceName =
+        typeof cfg.serviceName === 'string' ? cfg.serviceName.trim() : '';
+    const apiBase = resolveLiveApiBase(cfg, normalizeLiveModeConfig(cfg));
+    const fetchImpl = (globalThis as any).fetch;
+    if (
+        !serviceName ||
+        !apiBase ||
+        !cfg.appId ||
+        !cfg.appSecret ||
+        typeof fetchImpl !== 'function'
+    ) {
+        return;
+    }
+
+    const controller =
+        typeof AbortController === 'function' ? new AbortController() : null;
+    const timeout = setTimeout(() => controller?.abort(), 2_500);
+    try {
+        timeout.unref?.();
+    } catch {}
+
+    try {
+        await fetchImpl(`${apiBase}/v1/sdk/runtime-services`, {
+            method: 'POST',
+            headers: liveApiHeaders(cfg),
+            body: JSON.stringify({
+                serviceName,
+                environment: normalizePrivacyEnvironment(
+                    cfg.privacy?.environment,
+                ),
+            }),
+            ...(controller ? { signal: controller.signal } : {}),
+        });
+    } catch {
+        // Service discovery is best-effort and must never affect host startup.
+    } finally {
+        try {
+            clearTimeout(timeout);
+        } catch {}
+    }
+}
+
+function enqueueRuntimeServiceRegistration(cfg: ReproMiddlewareConfig): void {
+    scheduleSdkBackgroundWork(() => registerRuntimeService(cfg));
+}
+
 function enqueueLiveSessionStart(
     cfg: ReproMiddlewareConfig,
     liveMode: ReproLiveModeConfig | null,
@@ -3844,6 +3893,7 @@ async function ensureRuntimePrivacyPolicyLoaded(cfg: ReproMiddlewareConfig): Pro
         appId: cfg.appId,
         appSecret: cfg.appSecret,
         appName: cfg.appName,
+        serviceName: cfg.serviceName,
         apiBase,
         environment: state.environment,
         fetchTimeoutMs: privacy?.fetchTimeoutMs,
@@ -3894,6 +3944,7 @@ async function initializeRuntimePrivacyPolicyAtStartup(cfg: ReproMiddlewareConfi
             appId: cfg.appId,
             appSecret: cfg.appSecret,
             appName: cfg.appName,
+            serviceName: cfg.serviceName,
             apiBase,
             environment: state.environment,
             fetchTimeoutMs: privacy?.fetchTimeoutMs,
@@ -11365,6 +11416,7 @@ export async function initRepro(cfg: ReproInitConfig): Promise<void> {
     patchSendgridMail(integrationCfg);
     patchMongooseIntegration(reproAutoMiddlewareConfig);
 
+    enqueueRuntimeServiceRegistration(reproAutoMiddlewareConfig);
     await initializeRuntimePrivacyPolicyAtStartup(reproAutoMiddlewareConfig);
 }
 
@@ -11396,6 +11448,7 @@ export const __reproTestHooks = {
         lastClientActivityAt = 0;
         sdkBackgroundQuietUntil = 0;
     },
+    registerRuntimeServiceForTest: registerRuntimeService,
     setBackendLiveTimingForTest(override: Partial<BackendLiveTimingConfig> | null): void {
         backendLiveTimingOverrideForTest = override;
     },

package/src/privacy.ts

@@ -230,6 +230,7 @@ export async function fetchApprovedRuntimePrivacyPolicy(params: {
     appId: string;
     appSecret?: string;
     appName?: string;
+    serviceName?: string;
     apiBase: string;
     environment: string;
     fetchTimeoutMs?: number;
@@ -240,7 +241,13 @@ export async function fetchApprovedRuntimePrivacyPolicy(params: {
             reason: !params.apiBase ? 'missing_config' : 'missing_credentials',
         };
     }
-    const url = `${params.apiBase}/v1/sdk/privacy-policy?environment=${encodeURIComponent(params.environment)}`;
+    const query = new URLSearchParams({
+        environment: params.environment,
+    });
+    if (typeof params.serviceName === 'string' && params.serviceName.trim()) {
+        query.set('serviceName', params.serviceName.trim());
+    }
+    const url = `${params.apiBase}/v1/sdk/privacy-policy?${query.toString()}`;
     const headers: Record<string, string> = {
         accept: 'application/json',
         'x-app-id': params.appId,

package/test/privacy-service-scope.test.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const assert = require('node:assert');
+const {
+    fetchApprovedRuntimePrivacyPolicy,
+} = require('../dist/privacy.js');
+
+async function main() {
+    const originalFetch = global.fetch;
+    const calls = [];
+    global.fetch = async (url, init) => {
+        calls.push({ url: String(url), init });
+        return {
+            ok: true,
+            json: async () => ({ enabled: false }),
+        };
+    };
+
+    try {
+        await fetchApprovedRuntimePrivacyPolicy({
+            appId: 'APP_shared',
+            appSecret: 'secret',
+            appName: 'Shared app',
+            serviceName: ' Orders API ',
+            apiBase: 'https://repro.example/api',
+            environment: 'prod',
+        });
+        await fetchApprovedRuntimePrivacyPolicy({
+            appId: 'APP_shared',
+            appSecret: 'secret',
+            apiBase: 'https://repro.example/api',
+            environment: 'dev',
+        });
+    } finally {
+        global.fetch = originalFetch;
+    }
+
+    assert.strictEqual(calls.length, 2);
+    const serviceUrl = new URL(calls[0].url);
+    assert.strictEqual(serviceUrl.pathname, '/api/v1/sdk/privacy-policy');
+    assert.strictEqual(serviceUrl.searchParams.get('environment'), 'prod');
+    assert.strictEqual(serviceUrl.searchParams.get('serviceName'), 'Orders API');
+    assert.strictEqual(calls[0].init.headers['x-app-id'], 'APP_shared');
+    assert.strictEqual(calls[0].init.headers['x-app-secret'], 'secret');
+
+    const appWideUrl = new URL(calls[1].url);
+    assert.strictEqual(appWideUrl.searchParams.get('environment'), 'dev');
+    assert.strictEqual(appWideUrl.searchParams.has('serviceName'), false);
+
+    console.log('runtime privacy service scope OK');
+}
+
+main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+});

package/test/runtime-service-registration.test.js

@@ -0,0 +1,80 @@
+'use strict';
+
+const assert = require('node:assert/strict');
+
+const { __reproTestHooks } = require('../dist');
+
+async function main() {
+  const originalFetch = global.fetch;
+  const calls = [];
+
+  try {
+    global.fetch = async (url, options) => {
+      calls.push({ url: String(url), options });
+      return { ok: true };
+    };
+
+    await __reproTestHooks.registerRuntimeServiceForTest({
+      tenantId: 'TENANT_test',
+      appId: 'APP_test',
+      appSecret: 'secret',
+      appName: 'Acme',
+      serviceName: ' orders-api ',
+      apiBase: 'http://repro-api.test/api/',
+      privacy: {
+        environment: 'production',
+        captureRaw: true,
+      },
+      ingestBase: 'http://collector.test',
+    });
+
+    assert.equal(calls.length, 1);
+    assert.equal(
+      calls[0].url,
+      'http://repro-api.test/api/v1/sdk/runtime-services',
+    );
+    assert.equal(calls[0].options.method, 'POST');
+    assert.deepEqual(calls[0].options.headers, {
+      'Content-Type': 'application/json',
+      'X-App-Id': 'APP_test',
+      'X-App-Secret': 'secret',
+      'X-App-Name': 'Acme',
+    });
+    assert.deepEqual(JSON.parse(calls[0].options.body), {
+      serviceName: 'orders-api',
+      environment: 'prod',
+    });
+    assert.ok(calls[0].options.signal);
+
+    await __reproTestHooks.registerRuntimeServiceForTest({
+      tenantId: 'TENANT_test',
+      appId: 'APP_test',
+      appSecret: 'secret',
+      appName: 'Acme',
+      apiBase: 'http://repro-api.test/api',
+      ingestBase: 'http://collector.test',
+    });
+    assert.equal(calls.length, 1);
+
+    global.fetch = async () => {
+      throw new Error('network down');
+    };
+    await __reproTestHooks.registerRuntimeServiceForTest({
+      tenantId: 'TENANT_test',
+      appId: 'APP_test',
+      appSecret: 'secret',
+      serviceName: 'billing-api',
+      apiBase: 'http://repro-api.test/api',
+      ingestBase: 'http://collector.test',
+    });
+  } finally {
+    global.fetch = originalFetch;
+  }
+
+  console.log('runtime service registration OK');
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});