@tracelog/capture-web 1.2.0 → 1.3.1

package/CHANGELOG.md

@@ -18,6 +18,18 @@ patch, and neither requires reading your code.
 Entries after 1.0.0 are drafted from the commits that touched this package and
 edited before release.
 
+## [1.3.1](https://github.com/nacorga/tracelog-sdk/compare/capture-web@1.3.0...capture-web@1.3.1) (2026-09-30)
+
+
+### Fixed
+
+* **capture-core:** a send outlives the page that started it ([86faf5f](https://github.com/nacorga/tracelog-sdk/commit/86faf5f479a76d69f6413f9db82daae1482492df))
+
+## [1.3.0](https://github.com/nacorga/tracelog-sdk/compare/capture-web@1.2.0...capture-web@1.3.0) (2026-09-27)
+
+
+* **capture-web:** Synchronize tracelog-sdk versions
+
 ## [1.2.0](https://github.com/nacorga/tracelog-sdk/compare/capture-web@1.1.0...capture-web@1.2.0) (2026-09-22)
 
 

package/README.md

@@ -22,13 +22,13 @@ as they are served.
 <!-- x-release-please-start-version -->
 
 ```bash
-npm install --save-exact @tracelog/capture-web@1.2.0
+npm install --save-exact @tracelog/capture-web@1.3.1
 ```
 
 Without a build step, the same runtime as a script tag:
 
 ```html
-<script src="https://cdn.tracelog.io/v/1.2.0/tracelog.js"></script>
+<script src="https://cdn.tracelog.io/v/1.3.1/tracelog.js"></script>
 ```
 
 <!-- x-release-please-end -->
@@ -105,8 +105,10 @@ An IP address is read once when the event arrives to derive a two-letter country
 code, then discarded.
 
 Events queue locally once consent allows, batch, and deliver with retry, backoff
-and circuit breaking. Delivery failure surfaces as a diagnosable condition,
-never as silent loss.
+and circuit breaking. A step is sent when it is taken, and every send uses
+`keepalive`, so a click that leaves the page — even for another site — does not
+cancel it. Delivery failure surfaces as a diagnosable condition, never as
+silent loss.
 
 ## Where it runs
 

package/dist/tracelog.esm.js

@@ -27,6 +27,14 @@ const RETRY_BASE_MS = 1000;
 const RETRY_CAP_MS = 60 * 1000;
 const CIRCUIT_FAILURE_THRESHOLD = 5;
 const CIRCUIT_PROBE_MS = 60 * 1000;
+/**
+ * What the browser lets `keepalive` bodies in flight add up to. Every send
+ * uses `keepalive`, so no navigation cancels one, and every send fits what is
+ * left of this beside the sends already in flight ([spec/capture.md]
+ * § Delivery). It is below the contract's `MAX_BATCH_BYTES`, so it is the
+ * batch budget too.
+ */
+const KEEPALIVE_BUDGET_BYTES = 64 * 1024;
 const EVENT_NAME_PATTERN = /^[a-z][a-z0-9_]{0,63}$/;
 const PUBLIC_KEY_PATTERN = /^tl_pk_[a-z2-7]{26}$/;
 /**
@@ -171,7 +179,12 @@ function isConversionValid(options) {
 function serializedBytes(value) {
     return textEncoder.encode(JSON.stringify(value)).byteLength;
 }
-function batchFrom(events) {
+/**
+ * As many events as fit `room`, oldest first. An event that alone exceeds the
+ * whole keepalive budget can never be sent; one that only exceeds what the
+ * sends in flight leave waits for them.
+ */
+function batchFrom(events, room) {
     const selected = [];
     const unsendable = [];
     for (const event of events) {
@@ -181,8 +194,9 @@ function batchFrom(events) {
             v: EVENT_ENVELOPE_VERSION,
             events: [...selected, event],
         };
-        if (serializedBytes(candidate) > MAX_BATCH_BYTES) {
-            if (selected.length === 0) {
+        const bytes = serializedBytes(candidate);
+        if (bytes > room) {
+            if (selected.length === 0 && bytes > KEEPALIVE_BUDGET_BYTES) {
                 unsendable.push(event);
                 continue;
             }
@@ -199,11 +213,13 @@ function createCaptureEngine(ports, acquisition) {
     let pending = [];
     let lastDeclaredName;
     /**
-     * Every send in flight, by count and by the union of their event ids: a
-     * page hide sends alongside one rather than wait for it, so there can be
-     * two, and each must leave the other's events alone.
+     * Every send in flight, by count, by bytes and by the union of their event
+     * ids: a step taken and a page hide send beside one rather than wait for
+     * it, so there can be several, each must leave the others' events alone,
+     * and together they stay within the keepalive budget.
      */
     let sendsInFlight = 0;
+    let bytesInFlight = 0;
     const inFlight = new Set();
     /**
      * The conversions this page emitted and holds for their tag sighting
@@ -329,6 +345,38 @@ function createCaptureEngine(ports, acquisition) {
             return;
         }
         emit(pendingEvent);
+        sendTaken();
+    }
+    /**
+     * A step, and a conversion that is not held, leaves when it is taken: a
+     * click that navigates to another site may fire no hide event at all, and a
+     * send started by the click itself is the one that arrives ([spec/capture.md]
+     * § Delivery). An open circuit keeps it queued for the probe.
+     */
+    function sendTaken() {
+        if (circuit !== "closed" || !PUBLIC_KEY_PATTERN.test(config.key))
+            return;
+        void sendNow();
+    }
+    /**
+     * Sends at once what is queued and in no send in flight, beside any send in
+     * flight, within what the keepalive budget has left.
+     */
+    async function sendNow() {
+        const queue = readQueue(ports.storage);
+        const ready = queue.events.filter((event) => !held.has(event.eventId) && !inFlight.has(event.eventId));
+        const { batch, unsendable } = batchFrom(ready, KEEPALIVE_BUDGET_BYTES - bytesInFlight);
+        dropUnsendable(queue, unsendable);
+        if (batch.events.length > 0)
+            await deliver(batch);
+    }
+    function dropUnsendable(queue, unsendable) {
+        if (unsendable.length === 0)
+            return;
+        const dropped = new Set(unsendable.map((event) => event.eventId));
+        queue.events = queue.events.filter((event) => !dropped.has(event.eventId));
+        addDrop(queue, "invalid_event", unsendable.length);
+        writeQueue(ports.storage, queue);
     }
     /**
      * Gives each held conversion whose window has closed — or every one, at
@@ -381,11 +429,21 @@ function createCaptureEngine(ports, acquisition) {
         }
         return Math.max(0, earliest - now);
     }
-    async function flush(keepalive = false) {
-        release(keepalive);
+    async function flush(hidden = false) {
+        release(hidden);
         if (!initialized || consentState !== "granted")
             return;
-        if (sendsInFlight > 0 && !keepalive)
+        /**
+         * A page being hidden gets no later chance, so it sends what no send in
+         * flight carries at once, whatever the circuit's state, and the answer is
+         * read as any other's.
+         */
+        if (hidden) {
+            if (PUBLIC_KEY_PATTERN.test(config.key))
+                await sendNow();
+            return;
+        }
+        if (sendsInFlight > 0)
             return;
         const queue = readQueue(ports.storage);
         const ready = queue.events.filter((event) => !held.has(event.eventId) && !inFlight.has(event.eventId));
@@ -397,17 +455,6 @@ function createCaptureEngine(ports, acquisition) {
             }
             return;
         }
-        /**
-         * A page being hidden gets no later chance, so it sends what no send in
-         * flight carries at once, whatever the circuit's state, and the answer is
-         * read as any other's.
-         */
-        if (sendsInFlight > 0) {
-            const { batch } = batchFrom(ready);
-            if (batch.events.length > 0)
-                await deliver(batch, true);
-            return;
-        }
         const now = ports.clock.now().getTime();
         if (circuit === "open") {
             if (now < nextProbeAt) {
@@ -416,35 +463,32 @@ function createCaptureEngine(ports, acquisition) {
             }
             circuit = "half_open";
         }
-        const { batch, unsendable } = batchFrom(ready);
-        if (unsendable.length > 0) {
-            const dropped = new Set(unsendable.map((event) => event.eventId));
-            queue.events = queue.events.filter((event) => !dropped.has(event.eventId));
-            addDrop(queue, "invalid_event", unsendable.length);
-            writeQueue(ports.storage, queue);
-        }
+        const { batch, unsendable } = batchFrom(ready, KEEPALIVE_BUDGET_BYTES);
+        dropUnsendable(queue, unsendable);
         if (batch.events.length === 0) {
             scheduleFlush(FLUSH_INTERVAL_MS);
             return;
         }
-        await deliver(batch, keepalive);
+        await deliver(batch);
     }
     /**
      * One send, and its answer. It removes from the stored queue exactly what
      * it carried, by its own read, filter and write at the moment it settles,
      * so a send beside it keeps what it delivered.
      */
-    async function deliver(batch, keepalive) {
+    async function deliver(batch) {
         const carried = new Set(batch.events.map((event) => event.eventId));
+        const bytes = serializedBytes(batch);
         for (const eventId of carried)
             inFlight.add(eventId);
         sendsInFlight += 1;
+        bytesInFlight += bytes;
         try {
             const response = await ports.transport.send({
                 endpoint: config.endpoint,
                 key: config.key,
                 batch,
-                keepalive,
+                keepalive: true,
             });
             if (response.status >= 200 && response.status < 300) {
                 const currentQueue = readQueue(ports.storage);
@@ -496,6 +540,7 @@ function createCaptureEngine(ports, acquisition) {
             for (const eventId of carried)
                 inFlight.delete(eventId);
             sendsInFlight -= 1;
+            bytesInFlight -= bytes;
         }
     }
     const engine = {
@@ -526,6 +571,8 @@ function createCaptureEngine(ports, acquisition) {
                 pending = [];
                 for (const pendingEvent of buffered)
                     emit(pendingEvent, true);
+                if (buffered.length > 0)
+                    sendTaken();
                 scheduleFlush(FLUSH_INTERVAL_MS);
             },
             deny() {

package/dist/tracelog.iife.js

@@ -28,6 +28,14 @@ const RETRY_BASE_MS = 1000;
 const RETRY_CAP_MS = 60 * 1000;
 const CIRCUIT_FAILURE_THRESHOLD = 5;
 const CIRCUIT_PROBE_MS = 60 * 1000;
+/**
+ * What the browser lets `keepalive` bodies in flight add up to. Every send
+ * uses `keepalive`, so no navigation cancels one, and every send fits what is
+ * left of this beside the sends already in flight ([spec/capture.md]
+ * § Delivery). It is below the contract's `MAX_BATCH_BYTES`, so it is the
+ * batch budget too.
+ */
+const KEEPALIVE_BUDGET_BYTES = 64 * 1024;
 const EVENT_NAME_PATTERN = /^[a-z][a-z0-9_]{0,63}$/;
 const PUBLIC_KEY_PATTERN = /^tl_pk_[a-z2-7]{26}$/;
 /**
@@ -172,7 +180,12 @@ function isConversionValid(options) {
 function serializedBytes(value) {
     return textEncoder.encode(JSON.stringify(value)).byteLength;
 }
-function batchFrom(events) {
+/**
+ * As many events as fit `room`, oldest first. An event that alone exceeds the
+ * whole keepalive budget can never be sent; one that only exceeds what the
+ * sends in flight leave waits for them.
+ */
+function batchFrom(events, room) {
     const selected = [];
     const unsendable = [];
     for (const event of events) {
@@ -182,8 +195,9 @@ function batchFrom(events) {
             v: EVENT_ENVELOPE_VERSION,
             events: [...selected, event],
         };
-        if (serializedBytes(candidate) > MAX_BATCH_BYTES) {
-            if (selected.length === 0) {
+        const bytes = serializedBytes(candidate);
+        if (bytes > room) {
+            if (selected.length === 0 && bytes > KEEPALIVE_BUDGET_BYTES) {
                 unsendable.push(event);
                 continue;
             }
@@ -200,11 +214,13 @@ function createCaptureEngine(ports, acquisition) {
     let pending = [];
     let lastDeclaredName;
     /**
-     * Every send in flight, by count and by the union of their event ids: a
-     * page hide sends alongside one rather than wait for it, so there can be
-     * two, and each must leave the other's events alone.
+     * Every send in flight, by count, by bytes and by the union of their event
+     * ids: a step taken and a page hide send beside one rather than wait for
+     * it, so there can be several, each must leave the others' events alone,
+     * and together they stay within the keepalive budget.
      */
     let sendsInFlight = 0;
+    let bytesInFlight = 0;
     const inFlight = new Set();
     /**
      * The conversions this page emitted and holds for their tag sighting
@@ -330,6 +346,38 @@ function createCaptureEngine(ports, acquisition) {
             return;
         }
         emit(pendingEvent);
+        sendTaken();
+    }
+    /**
+     * A step, and a conversion that is not held, leaves when it is taken: a
+     * click that navigates to another site may fire no hide event at all, and a
+     * send started by the click itself is the one that arrives ([spec/capture.md]
+     * § Delivery). An open circuit keeps it queued for the probe.
+     */
+    function sendTaken() {
+        if (circuit !== "closed" || !PUBLIC_KEY_PATTERN.test(config.key))
+            return;
+        void sendNow();
+    }
+    /**
+     * Sends at once what is queued and in no send in flight, beside any send in
+     * flight, within what the keepalive budget has left.
+     */
+    async function sendNow() {
+        const queue = readQueue(ports.storage);
+        const ready = queue.events.filter((event) => !held.has(event.eventId) && !inFlight.has(event.eventId));
+        const { batch, unsendable } = batchFrom(ready, KEEPALIVE_BUDGET_BYTES - bytesInFlight);
+        dropUnsendable(queue, unsendable);
+        if (batch.events.length > 0)
+            await deliver(batch);
+    }
+    function dropUnsendable(queue, unsendable) {
+        if (unsendable.length === 0)
+            return;
+        const dropped = new Set(unsendable.map((event) => event.eventId));
+        queue.events = queue.events.filter((event) => !dropped.has(event.eventId));
+        addDrop(queue, "invalid_event", unsendable.length);
+        writeQueue(ports.storage, queue);
     }
     /**
      * Gives each held conversion whose window has closed — or every one, at
@@ -382,11 +430,21 @@ function createCaptureEngine(ports, acquisition) {
         }
         return Math.max(0, earliest - now);
     }
-    async function flush(keepalive = false) {
-        release(keepalive);
+    async function flush(hidden = false) {
+        release(hidden);
         if (!initialized || consentState !== "granted")
             return;
-        if (sendsInFlight > 0 && !keepalive)
+        /**
+         * A page being hidden gets no later chance, so it sends what no send in
+         * flight carries at once, whatever the circuit's state, and the answer is
+         * read as any other's.
+         */
+        if (hidden) {
+            if (PUBLIC_KEY_PATTERN.test(config.key))
+                await sendNow();
+            return;
+        }
+        if (sendsInFlight > 0)
             return;
         const queue = readQueue(ports.storage);
         const ready = queue.events.filter((event) => !held.has(event.eventId) && !inFlight.has(event.eventId));
@@ -398,17 +456,6 @@ function createCaptureEngine(ports, acquisition) {
             }
             return;
         }
-        /**
-         * A page being hidden gets no later chance, so it sends what no send in
-         * flight carries at once, whatever the circuit's state, and the answer is
-         * read as any other's.
-         */
-        if (sendsInFlight > 0) {
-            const { batch } = batchFrom(ready);
-            if (batch.events.length > 0)
-                await deliver(batch, true);
-            return;
-        }
         const now = ports.clock.now().getTime();
         if (circuit === "open") {
             if (now < nextProbeAt) {
@@ -417,35 +464,32 @@ function createCaptureEngine(ports, acquisition) {
             }
             circuit = "half_open";
         }
-        const { batch, unsendable } = batchFrom(ready);
-        if (unsendable.length > 0) {
-            const dropped = new Set(unsendable.map((event) => event.eventId));
-            queue.events = queue.events.filter((event) => !dropped.has(event.eventId));
-            addDrop(queue, "invalid_event", unsendable.length);
-            writeQueue(ports.storage, queue);
-        }
+        const { batch, unsendable } = batchFrom(ready, KEEPALIVE_BUDGET_BYTES);
+        dropUnsendable(queue, unsendable);
         if (batch.events.length === 0) {
             scheduleFlush(FLUSH_INTERVAL_MS);
             return;
         }
-        await deliver(batch, keepalive);
+        await deliver(batch);
     }
     /**
      * One send, and its answer. It removes from the stored queue exactly what
      * it carried, by its own read, filter and write at the moment it settles,
      * so a send beside it keeps what it delivered.
      */
-    async function deliver(batch, keepalive) {
+    async function deliver(batch) {
         const carried = new Set(batch.events.map((event) => event.eventId));
+        const bytes = serializedBytes(batch);
         for (const eventId of carried)
             inFlight.add(eventId);
         sendsInFlight += 1;
+        bytesInFlight += bytes;
         try {
             const response = await ports.transport.send({
                 endpoint: config.endpoint,
                 key: config.key,
                 batch,
-                keepalive,
+                keepalive: true,
             });
             if (response.status >= 200 && response.status < 300) {
                 const currentQueue = readQueue(ports.storage);
@@ -497,6 +541,7 @@ function createCaptureEngine(ports, acquisition) {
             for (const eventId of carried)
                 inFlight.delete(eventId);
             sendsInFlight -= 1;
+            bytesInFlight -= bytes;
         }
     }
     const engine = {
@@ -527,6 +572,8 @@ function createCaptureEngine(ports, acquisition) {
                 pending = [];
                 for (const pendingEvent of buffered)
                     emit(pendingEvent, true);
+                if (buffered.length > 0)
+                    sendTaken();
                 scheduleFlush(FLUSH_INTERVAL_MS);
             },
             deny() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tracelog/capture-web",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "The TraceLog browser capture runtime: consent-first, pinned per version.",
   "keywords": [
     "conversion",
@@ -45,8 +45,8 @@
     "access": "public"
   },
   "devDependencies": {
-    "@tracelog/capture-core": "1.2.0",
-    "@tracelog/event-contract": "1.2.0"
+    "@tracelog/capture-core": "1.3.1",
+    "@tracelog/event-contract": "1.3.1"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json && node build.mjs",