npm - api-observe - Versions diffs - 1.1.0 → 1.1.2 - Mend

api-observe 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/lib/adapters/express.js CHANGED Viewed

@@ -30,6 +30,7 @@ const { parse: parseUrl } = require('url');
 const { FailureStore } = require('../failure-store');
 const { attachInterceptor, attachToAll, defaultSanitize } = require('../interceptor');
 const { createRouter } = require('../router');
+const { requestContext } = require('../request-context');
 /**
  * Create an Express middleware that captures errors and serves the observe dashboard.
@@ -54,7 +55,7 @@ function expressMiddleware(opts = {}) {
     // Only handle /observe routes
     if (!pathname.startsWith('/observe')) {
-      next();
+      requestContext.run({ captured: false, startedAt: Date.now(), inboundRequest: req }, next);
       return;
     }

package/lib/dashboard/index.js CHANGED Viewed

@@ -12,7 +12,7 @@ function getDashboardHtml() {
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>ps-observe | API Failure Tracker</title>
+  <title>observe | API Failure Tracker</title>
   <style>
     * { margin: 0; padding: 0; box-sizing: border-box; }
@@ -306,7 +306,7 @@ function getDashboardHtml() {
 </head>
 <body>
   <header>
-    <h1>ps-observe</h1>
+    <h1>observe</h1>
     <div class="stats">
       <span class="count" id="totalCount">0</span> failures tracked
     </div>
@@ -329,6 +329,7 @@ function getDashboardHtml() {
     </select>
     <input type="number" id="filterStatus" placeholder="Status code..." min="100" max="599" />
     <input type="text" id="filterUrl" placeholder="URL contains..." />
+    <input type="text" id="filterCorrelationId" placeholder="Correlation ID..." />
     <button class="refresh-btn" onclick="loadFailures()">Refresh</button>
     <button class="danger" onclick="clearAll()">Clear All</button>
   </div>
@@ -373,12 +374,14 @@ function getDashboardHtml() {
       const method = document.getElementById('filterMethod').value;
       const statusCode = document.getElementById('filterStatus').value;
       const url = document.getElementById('filterUrl').value;
+      const correlationId = document.getElementById('filterCorrelationId').value.trim();
       if (type) params.set('type', type);
       if (service) params.set('service', service);
       if (method) params.set('method', method);
       if (statusCode) params.set('statusCode', statusCode);
       if (url) params.set('url', url);
+      if (correlationId) params.set('correlationId', correlationId);
       params.set('limit', PAGE_SIZE);
       params.set('offset', currentOffset);
@@ -499,24 +502,46 @@ function getDashboardHtml() {
           : ''
         ) +
-        '<div class="detail-section"><h3>Request Headers</h3>' +
+        '<div class="detail-section"><h3>Inbound Request Headers</h3>' +
         '<pre class="json-block">' + escHtml(formatJson(f.request?.headers)) + '</pre></div>' +
         (f.request?.query
-          ? '<div class="detail-section"><h3>Request Query Params</h3>' +
+          ? '<div class="detail-section"><h3>Inbound Query Params</h3>' +
             '<pre class="json-block">' + escHtml(formatJson(f.request?.query)) + '</pre></div>'
           : ''
         ) +
-        '<div class="detail-section"><h3>Request Body</h3>' +
+        '<div class="detail-section"><h3>Inbound Request Body</h3>' +
         '<pre class="json-block">' + escHtml(formatJson(f.request?.body)) + '</pre></div>' +
-        (f.response
-          ? '<div class="detail-section"><h3>Response Headers</h3>' +
-            '<pre class="json-block">' + escHtml(formatJson(f.response?.headers)) + '</pre></div>' +
-            '<div class="detail-section"><h3>Response Body</h3>' +
-            '<pre class="json-block">' + escHtml(formatJson(f.response?.body)) + '</pre></div>'
-          : '<div class="detail-section"><h3>Response</h3><p>No response received (timeout / network error)</p></div>'
+        (f.upstreamCall
+          ? '<div class="detail-section"><h3>Upstream Call \u2014 ' + escHtml(f.upstreamCall.service) + '</h3>' +
+            '<dl class="detail-grid">' +
+              '<dt>Method</dt><dd><span class="method-badge method-' + escHtml(f.upstreamCall.method) + '">' + escHtml(f.upstreamCall.method) + '</span></dd>' +
+              '<dt>URL</dt><dd>' + escHtml(f.upstreamCall.url || '') + '</dd>' +
+              '<dt>Status Code</dt><dd>' + (f.upstreamCall.statusCode || 'N/A') + '</dd>' +
+              '<dt>Duration</dt><dd>' + (f.upstreamCall.durationMs != null ? f.upstreamCall.durationMs + 'ms' : 'N/A') + '</dd>' +
+              '<dt>Error</dt><dd>' + escHtml(f.upstreamCall.errorMessage || '') + '</dd>' +
+              (f.upstreamCall.errorCode ? '<dt>Error Code</dt><dd>' + escHtml(f.upstreamCall.errorCode) + '</dd>' : '') +
+            '</dl></div>' +
+            '<div class="detail-section"><h3>Upstream Request Headers</h3>' +
+            '<pre class="json-block">' + escHtml(formatJson(f.upstreamCall.request?.headers)) + '</pre></div>' +
+            '<div class="detail-section"><h3>Upstream Request Body</h3>' +
+            '<pre class="json-block">' + escHtml(formatJson(f.upstreamCall.request?.body)) + '</pre></div>' +
+            (f.upstreamCall.response
+              ? '<div class="detail-section"><h3>Upstream Response Headers</h3>' +
+                '<pre class="json-block">' + escHtml(formatJson(f.upstreamCall.response?.headers)) + '</pre></div>' +
+                '<div class="detail-section"><h3>Upstream Response Body</h3>' +
+                '<pre class="json-block">' + escHtml(formatJson(f.upstreamCall.response?.body)) + '</pre></div>'
+              : '<div class="detail-section"><h3>Upstream Response</h3><p>No response received (timeout / network error)</p></div>'
+            )
+          : (f.response
+              ? '<div class="detail-section"><h3>Response Headers</h3>' +
+                '<pre class="json-block">' + escHtml(formatJson(f.response?.headers)) + '</pre></div>' +
+                '<div class="detail-section"><h3>Response Body</h3>' +
+                '<pre class="json-block">' + escHtml(formatJson(f.response?.body)) + '</pre></div>'
+              : '<div class="detail-section"><h3>Response</h3><p>No response received (timeout / network error)</p></div>'
+            )
         );
       document.getElementById('modalOverlay').classList.add('active');

package/lib/failure-store.js CHANGED Viewed

@@ -46,7 +46,7 @@ class FailureStore {
   /**
    * Query failures with optional filters.
-   * @param {{ service?: string, statusCode?: number, from?: string, to?: string, method?: string, url?: string, limit?: number, offset?: number }} [filters]
+   * @param {{ service?: string, statusCode?: number, from?: string, to?: string, method?: string, url?: string, correlationId?: string, limit?: number, offset?: number }} [filters]
    * @returns {{ data: object[], total: number }}
    */
   query(filters = {}) {
@@ -81,6 +81,10 @@ class FailureStore {
       const url = filters.url.toLowerCase();
       results = results.filter(e => e.url?.toLowerCase().includes(url));
     }
+    if (filters.correlationId) {
+      const cid = String(filters.correlationId).toLowerCase();
+      results = results.filter(e => e.correlationId?.toLowerCase().includes(cid));
+    }
     if (filters.from) {
       const from = new Date(filters.from).getTime();
       results = results.filter(e => new Date(e.timestamp).getTime() >= from);

package/lib/interceptor.js CHANGED Viewed

@@ -63,39 +63,75 @@ function attachInterceptor(client, store, opts = {}) {
       const response = error.response;
       const durationMs = Date.now() - (config.metadata?.startMs ?? Date.now());
-      const record = {
-        type: 'upstream',
+      const ctx = requestContext.getStore();
+      const inboundReq = ctx?.inboundRequest ?? null;
+      // ── Downstream call details ────────────────────────────────────────────
+      const upstreamCall = {
         service: client.serviceName,
         method: config.method?.toUpperCase() ?? 'UNKNOWN',
         url: buildFullUrl(config),
-        correlationId: config.correlationId ?? config.headers?.['x-correlation-id'] ?? null,
         durationMs,
+        statusCode: response?.status ?? null,
         errorMessage: error.message,
         errorCode: error.code ?? null,
-        // Request details
         request: {
           headers: sanitize(config.headers),
           params: config.params ?? null,
           body: sanitize(config.data),
         },
-        // Response details (null if no response, e.g. timeout/network error)
-        statusCode: response?.status ?? null,
         response: response
-          ? {
-              headers: response.headers ?? null,
-              body: sanitize(response.data),
-            }
+          ? { headers: response.headers ?? null, body: sanitize(response.data) }
           : null,
       };
+      let record;
+      if (inboundReq) {
+        // Top-level = the inbound request that triggered this failure.
+        // The downstream call details are nested under upstreamCall.
+        record = {
+          type: 'upstream',
+          service: inboundReq.routeOptions?.url ?? inboundReq.originalUrl ?? inboundReq.url ?? 'unknown',
+          method: inboundReq.method ?? 'UNKNOWN',
+          url: inboundReq.originalUrl ?? inboundReq.url ?? 'unknown',
+          correlationId: inboundReq.correlationId ?? inboundReq.headers?.['x-correlation-id'] ?? config.correlationId ?? config.headers?.['x-correlation-id'] ?? null,
+          durationMs,
+          errorMessage: error.message,
+          errorCode: error.code ?? null,
+          statusCode: response?.status ?? null,
+          request: {
+            headers: sanitize(inboundReq.headers),
+            params: inboundReq.params ?? null,
+            query: inboundReq.query ?? null,
+            body: sanitize(inboundReq.body),
+          },
+          response: null,
+          upstreamCall,
+        };
+      } else {
+        // No inbound context (standalone / direct interceptor usage) —
+        // keep the downstream call as the top-level record.
+        record = {
+          type: 'upstream',
+          service: client.serviceName,
+          method: upstreamCall.method,
+          url: upstreamCall.url,
+          correlationId: config.correlationId ?? config.headers?.['x-correlation-id'] ?? null,
+          durationMs,
+          errorMessage: error.message,
+          errorCode: error.code ?? null,
+          statusCode: response?.status ?? null,
+          request: upstreamCall.request,
+          response: upstreamCall.response,
+          upstreamCall: null,
+        };
+      }
       store.add(record);
       // Mark the in-flight Fastify request (if any) so the response-level
       // hook in plugin.js does not record a duplicate when the controller
       // catches this error and replies with its own 4xx/5xx.
-      const ctx = requestContext.getStore();
       if (ctx) ctx.captured = true;
       // Re-throw the original error so BaseHttpClient's handler still works

package/lib/plugin.js CHANGED Viewed

@@ -88,7 +88,7 @@ async function observerPlugin(fastify, opts) {
   // interceptor records a capture deep in the call stack, it can reach back
   // and mark this request as already captured.
   fastify.addHook('onRequest', (request, reply, done) => {
-    const ctx = { captured: false, startedAt: Date.now() };
+    const ctx = { captured: false, startedAt: Date.now(), inboundRequest: request };
     request[CTX_KEY] = ctx;
     requestContext.enterWith(ctx);
     done();

package/lib/router.js CHANGED Viewed

@@ -42,8 +42,8 @@ function createRouter(store) {
     // ── List failures ──────────────────────────────────────────────────────
     if (method === 'GET' && path === '/observe/api/failures') {
-      const { service, statusCode, method: m, url, from, to, limit, offset, type } = query || {};
-      const result = store.query({ service, statusCode, method: m, url, from, to, limit, offset, type });
+      const { service, statusCode, method: m, url, from, to, limit, offset, type, correlationId } = query || {};
+      const result = store.query({ service, statusCode, method: m, url, from, to, limit, offset, type, correlationId });
       return { status: 200, headers: { 'content-type': 'application/json' }, body: result };
     }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "api-observe",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Framework-agnostic plugin that captures and displays API failure details — works with Fastify, Express, NestJS, Koa, or plain Node.js HTTP",
   "main": "lib/index.js",
   "files": [