@edraj/sauron-node 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to `@edraj/sauron-node` are documented here.
 
+## 1.4.0
+
+### Fixed
+
+- **`trackTransaction` shipped transactions with no duration, silently.** This
+  SDK's input field is `duration_ms`; the browser SDK's is `durationMs`. A
+  snippet moved between the two — or any plain-JavaScript caller, where the type
+  checker is not there to object — produced a transaction item missing the one
+  field it exists to carry, and nothing anywhere complained: the item validated,
+  shipped, and looked delivered.
+
+  `durationMs` is now accepted as an alias, and a transaction with no usable
+  duration is **dropped with a debug log line rather than sent**. Refusing is the
+  point: sending it anyway is what let the misspelling survive unnoticed.
+  `duration_ms: 0` is a legitimate duration and is still sent.
+
+### Changed
+
+- `TransactionInput.duration_ms` is now optional, since `durationMs` may supply
+  it instead. Supply exactly one — `duration_ms` wins if both are present.
+  Supplying neither is the drop above, not a compile error.
+
 ## 1.3.0
 
 ### Added

package/dist/client.js

@@ -179,12 +179,25 @@ export class SauronClient {
     trackTransaction(input) {
         if (typeof input?.name !== 'string' || input.name.length === 0)
             return;
+        // `durationMs` accepted as an alias — see TransactionInput. Without it, a
+        // caller using the browser SDK's spelling shipped a transaction with the
+        // duration field absent and no complaint from anywhere.
+        const duration = input.duration_ms ?? input.durationMs;
+        if (typeof duration !== 'number' || !Number.isFinite(duration)) {
+            // Refused loudly rather than sent. A transaction whose whole purpose is
+            // to record a duration is not worth persisting without one, and silence
+            // here is what let the mis-spelling survive: the item looked delivered.
+            this.debugLog(`dropped transaction "${input.name}": duration_ms must be a finite number ` +
+                `(got ${typeof duration === 'number' ? duration : typeof duration}). ` +
+                `Use duration_ms, or durationMs if you are porting from the browser SDK.`);
+            return;
+        }
         const distinctId = input.distinct_id ?? getCurrentScope().data.user?.id ?? undefined;
         const item = {
             type: 'transaction',
             name: input.name,
             op: input.op ?? 'custom',
-            duration_ms: input.duration_ms,
+            duration_ms: duration,
             timestamp: isoNow(),
         };
         if (input.status !== undefined)

package/dist/transport.js

@@ -1,7 +1,7 @@
 import { maybeGzip } from './gzip.js';
 import { BoundedQueue } from './queue.js';
 const SDK_NAME = 'sauron-node';
-const SDK_VERSION = '1.3.0';
+const SDK_VERSION = '1.4.0';
 /** Default exponential-backoff base (ms) for the first retry. */
 const DEFAULT_RETRY_BASE_MS = 200;
 /** Hard cap on any single backoff delay (ms). */

package/dist/types.d.ts

@@ -167,7 +167,20 @@ export interface TransactionInput {
     name: string;
     /** Operation class: `navigation | http | resource | screen_load | custom`. Default `custom`. */
     op?: string;
-    duration_ms: number;
+    duration_ms?: number;
+    /**
+     * Accepted alias for {@link duration_ms}.
+     *
+     * The browser SDK's equivalent input takes `durationMs` (`sdks/js`), so a
+     * snippet moved between the two — or any plain-JavaScript caller, where the
+     * type checker is not there to object — used to produce a transaction with no
+     * duration at all. The item still validated and still shipped, just without
+     * the one field it exists to carry, which is the worst possible outcome: no
+     * error anywhere and a silently useless performance record.
+     *
+     * Supply exactly one. `duration_ms` wins if both are present.
+     */
+    durationMs?: number;
     status?: string;
     http_method?: string;
     http_status?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edraj/sauron-node",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Sauron server-side Node/TypeScript SDK: product-analytics events + exception capture for Node backends.",
   "homepage": "https://github.com/edraj/sauron/tree/main/sdks/node#readme",
   "repository": {