@chordcommerce/analytics 1.24.1 → 1.24.2

package/README.md

@@ -127,7 +127,7 @@ event in that order.
 
 A middleware may be synchronous or asynchronous. Synchronous middleware is never
 awaited, so it adds no delay to event delivery. Asynchronous middleware is
-awaited before the event is sent, capped at one second — a middleware that has
+awaited before the event is sent, capped at three seconds — a middleware that has
 not resolved by then is abandoned, a warning is logged, and the event is sent
 without its properties. A middleware that throws or rejects is logged and
 skipped. A middleware never prevents an event from being sent.
@@ -174,7 +174,7 @@ Useage Example
     };
   });
 
-  // Asynchronous middleware: the event waits for the lookup, up to one second.
+  // Asynchronous middleware: the event waits for the lookup, up to three seconds.
   analytics.addSourceMiddleware(async ({ payload }) => {
     if (payload.obj.event !== 'Order Completed') return;
 

package/dist/cjs/utils.d.ts

@@ -7,8 +7,17 @@ export declare const pruneNullValues: (props: EventProperties) => EventPropertie
  * Middleware runs on the path to the CDP, so an unbounded wait would let one
  * slow lookup hold up delivery indefinitely. `Order Completed` in particular
  * fires on a confirmation page shoppers close, so a late event is a lost one.
+ *
+ * The cap has to clear the work real middleware does. The case this was built
+ * for looks up an order count to decide whether a shopper is new, which costs
+ * an auth token and then the lookup itself -- two sequential round trips. That
+ * measured 811ms from a warm browser console, and an order confirmation page,
+ * still mounting and with other events in flight, is slower than a console. At
+ * one second it was dropping its properties in the field; three gives the
+ * round trips room without holding an event long enough for a shopper to
+ * navigate away from it.
  */
-export declare const MIDDLEWARE_TIMEOUT_MS = 1000;
+export declare const MIDDLEWARE_TIMEOUT_MS = 3000;
 /** Returned by {@link withTimeout} when the promise did not settle in time. */
 export declare const TIMED_OUT: unique symbol;
 export declare const isPromise: (value: unknown) => value is Promise<unknown>;

package/dist/cjs/utils.js

@@ -66,8 +66,17 @@ exports.pruneNullValues = pruneNullValues;
  * Middleware runs on the path to the CDP, so an unbounded wait would let one
  * slow lookup hold up delivery indefinitely. `Order Completed` in particular
  * fires on a confirmation page shoppers close, so a late event is a lost one.
+ *
+ * The cap has to clear the work real middleware does. The case this was built
+ * for looks up an order count to decide whether a shopper is new, which costs
+ * an auth token and then the lookup itself -- two sequential round trips. That
+ * measured 811ms from a warm browser console, and an order confirmation page,
+ * still mounting and with other events in flight, is slower than a console. At
+ * one second it was dropping its properties in the field; three gives the
+ * round trips room without holding an event long enough for a shopper to
+ * navigate away from it.
  */
-exports.MIDDLEWARE_TIMEOUT_MS = 1000;
+exports.MIDDLEWARE_TIMEOUT_MS = 3000;
 /** Returned by {@link withTimeout} when the promise did not settle in time. */
 exports.TIMED_OUT = Symbol('timed-out');
 var isPromise = function (value) {

package/dist/utils.d.ts

@@ -7,8 +7,17 @@ export declare const pruneNullValues: (props: EventProperties) => EventPropertie
  * Middleware runs on the path to the CDP, so an unbounded wait would let one
  * slow lookup hold up delivery indefinitely. `Order Completed` in particular
  * fires on a confirmation page shoppers close, so a late event is a lost one.
+ *
+ * The cap has to clear the work real middleware does. The case this was built
+ * for looks up an order count to decide whether a shopper is new, which costs
+ * an auth token and then the lookup itself -- two sequential round trips. That
+ * measured 811ms from a warm browser console, and an order confirmation page,
+ * still mounting and with other events in flight, is slower than a console. At
+ * one second it was dropping its properties in the field; three gives the
+ * round trips room without holding an event long enough for a shopper to
+ * navigate away from it.
  */
-export declare const MIDDLEWARE_TIMEOUT_MS = 1000;
+export declare const MIDDLEWARE_TIMEOUT_MS = 3000;
 /** Returned by {@link withTimeout} when the promise did not settle in time. */
 export declare const TIMED_OUT: unique symbol;
 export declare const isPromise: (value: unknown) => value is Promise<unknown>;

package/dist/utils.js

@@ -35,8 +35,17 @@ export const pruneNullValues = (props) => {
  * Middleware runs on the path to the CDP, so an unbounded wait would let one
  * slow lookup hold up delivery indefinitely. `Order Completed` in particular
  * fires on a confirmation page shoppers close, so a late event is a lost one.
+ *
+ * The cap has to clear the work real middleware does. The case this was built
+ * for looks up an order count to decide whether a shopper is new, which costs
+ * an auth token and then the lookup itself -- two sequential round trips. That
+ * measured 811ms from a warm browser console, and an order confirmation page,
+ * still mounting and with other events in flight, is slower than a console. At
+ * one second it was dropping its properties in the field; three gives the
+ * round trips room without holding an event long enough for a shopper to
+ * navigate away from it.
  */
-export const MIDDLEWARE_TIMEOUT_MS = 1000;
+export const MIDDLEWARE_TIMEOUT_MS = 3000;
 /** Returned by {@link withTimeout} when the promise did not settle in time. */
 export const TIMED_OUT = Symbol('timed-out');
 export const isPromise = (value) => typeof (value === null || value === void 0 ? void 0 : value.then) === 'function';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.24.1",
+  "version": "1.24.2",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "repository": {
     "type": "git",