@faststats/web 0.2.7 → 0.2.8

package/tests/replay.test.ts

@@ -1,7 +1,13 @@
 import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { gunzipSync } from "node:zlib";
 import ReplayTracker from "../src/replay";
 import { getOrCreateSessionId } from "../src/utils/identifiers";
 
+function decodeBody(data: string | Uint8Array): string {
+	if (typeof data === "string") return data;
+	return gunzipSync(data).toString("utf8");
+}
+
 class MockStorage {
 	private readonly data = new Map<string, string>();
 
@@ -37,13 +43,14 @@ type ReplayBatch = {
 type ReplayTrackerInternals = {
 	events: ReplayEvent[];
 	pending: ReplayBatch[];
+	pendingSizeBytes: number;
 	minLengthFlushTask: ReturnType<typeof setTimeout> | null;
 	retryTask: ReturnType<typeof setTimeout> | null;
 	startTime: number;
 	onEvent: (event: ReplayEvent, isCheckout?: boolean) => void;
 	flush: (lowLatency: boolean) => Promise<void>;
 	send: (
-		data: string | Blob,
+		data: string | Uint8Array,
 		isCompressed: boolean,
 		lowLatency: boolean,
 	) => Promise<boolean>;
@@ -167,13 +174,13 @@ describe("ReplayTracker", () => {
 			minReplayLengthMs: 0,
 		});
 
-		let payload: ReplayBatch | null = null;
-		let lowLatency = false;
+		const captured: { payload: ReplayBatch | null; lowLatency: boolean } = {
+			payload: null,
+			lowLatency: false,
+		};
 		tracker.send = async (data, _isCompressed, nextLowLatency) => {
-			payload = JSON.parse(
-				typeof data === "string" ? data : await data.text(),
-			) as ReplayBatch;
-			lowLatency = nextLowLatency;
+			captured.payload = JSON.parse(decodeBody(data)) as ReplayBatch;
+			captured.lowLatency = nextLowLatency;
 			return true;
 		};
 		tracker.startTime = Date.now() - 1000;
@@ -181,11 +188,11 @@ describe("ReplayTracker", () => {
 
 		await tracker.flush(true);
 
-		expect(payload).not.toBeNull();
-		expect(payload?.token).toBe("site_test");
-		expect(payload?.sessionId).toBeTruthy();
-		expect(payload?.events).toHaveLength(1);
-		expect(lowLatency).toBe(true);
+		expect(captured.payload).not.toBeNull();
+		expect(captured.payload?.token).toBe("site_test");
+		expect(captured.payload?.sessionId).toBeTruthy();
+		expect(captured.payload?.events).toHaveLength(1);
+		expect(captured.lowLatency).toBe(true);
 		expect(tracker.pending.length).toBe(0);
 	});
 
@@ -196,11 +203,7 @@ describe("ReplayTracker", () => {
 
 		const payloads: ReplayBatch[] = [];
 		tracker.send = async (data) => {
-			payloads.push(
-				JSON.parse(
-					typeof data === "string" ? data : await data.text(),
-				) as ReplayBatch,
-			);
+			payloads.push(JSON.parse(decodeBody(data)) as ReplayBatch);
 			return true;
 		};
 
@@ -221,14 +224,16 @@ describe("ReplayTracker", () => {
 		expect(payloads[1]?.sessionId).toBe(payloads[0]?.sessionId);
 	});
 
-	test("sends replay as plain JSON by default", async () => {
+	test("sends replay as plain JSON when CompressionStream is unavailable", async () => {
 		const tracker = createTracker({
 			minReplayLengthMs: 0,
 		});
 
-		let bodyType: "string" | "blob" | null = null;
+		const captured: { bodyType: "string" | "blob" | null } = {
+			bodyType: null,
+		};
 		tracker.send = async (data) => {
-			bodyType = typeof data === "string" ? "string" : "blob";
+			captured.bodyType = typeof data === "string" ? "string" : "blob";
 			return true;
 		};
 		tracker.startTime = Date.now() - 1000;
@@ -236,7 +241,76 @@ describe("ReplayTracker", () => {
 
 		await tracker.flush(false);
 
-		expect(bodyType).toBe("string");
+		expect(captured.bodyType).toBe("string");
+	});
+
+	test("sends replay as gzip Uint8Array when CompressionStream is available", async () => {
+		setGlobal("window", {
+			...(globalThis.window as unknown as Record<string, unknown>),
+			CompressionStream: globalThis.CompressionStream,
+		});
+
+		const tracker = createTracker({
+			minReplayLengthMs: 0,
+		});
+
+		const captured: {
+			bodyType: "string" | "binary" | null;
+			compressed: boolean;
+			size: number;
+		} = { bodyType: null, compressed: false, size: 0 };
+		tracker.send = async (data, isCompressed) => {
+			captured.bodyType = typeof data === "string" ? "string" : "binary";
+			captured.compressed = isCompressed;
+			if (data instanceof Uint8Array) {
+				captured.size = data.byteLength;
+			}
+			return true;
+		};
+		tracker.startTime = Date.now() - 1000;
+		for (let i = 0; i < 10; i++) {
+			tracker.onEvent(
+				{
+					type: 2,
+					timestamp: Date.now(),
+					data: { i, payload: "x".repeat(500) },
+				},
+				false,
+			);
+		}
+
+		await tracker.flush(false);
+
+		expect(captured.bodyType).toBe("binary");
+		expect(captured.compressed).toBe(true);
+		expect(captured.size).toBeGreaterThan(0);
+		expect(captured.size).toBeLessThan(5000);
+	});
+
+	test("compresses on unload (low latency) flush", async () => {
+		setGlobal("window", {
+			...(globalThis.window as unknown as Record<string, unknown>),
+			CompressionStream: globalThis.CompressionStream,
+		});
+
+		const tracker = createTracker({
+			minReplayLengthMs: 0,
+		});
+
+		let compressedFlag = false;
+		let lowLatencyFlag = false;
+		tracker.send = async (_data, isCompressed, lowLatency) => {
+			compressedFlag = isCompressed;
+			lowLatencyFlag = lowLatency;
+			return true;
+		};
+		tracker.startTime = Date.now() - 1000;
+		tracker.onEvent({ type: 2, timestamp: Date.now(), data: {} }, false);
+
+		await tracker.flush(true);
+
+		expect(compressedFlag).toBe(true);
+		expect(lowLatencyFlag).toBe(true);
 	});
 
 	test("keeps failed batches queued for retry", async () => {
@@ -255,4 +329,59 @@ describe("ReplayTracker", () => {
 
 		if (tracker.retryTask) clearTimeout(tracker.retryTask);
 	});
+
+	test("drops replay batches that exceed the queue byte limit", async () => {
+		const tracker = createTracker({
+			minReplayLengthMs: 0,
+			maxQueueSizeBytes: 600,
+		});
+
+		let sent = 0;
+		tracker.send = async () => {
+			sent++;
+			return true;
+		};
+		tracker.startTime = Date.now() - 1000;
+		tracker.onEvent(
+			{
+				type: 2,
+				timestamp: Date.now(),
+				data: { payload: "x".repeat(1000) },
+			},
+			false,
+		);
+
+		await tracker.flush(false);
+
+		expect(sent).toBe(0);
+		expect(tracker.pending.length).toBe(0);
+		expect(tracker.pendingSizeBytes).toBe(0);
+	});
+
+	test("keeps pending replay queue under the byte limit", async () => {
+		const tracker = createTracker({
+			minReplayLengthMs: 0,
+			maxQueueSizeBytes: 900,
+		});
+
+		tracker.send = async () => false;
+		tracker.startTime = Date.now() - 1000;
+
+		for (let i = 0; i < 4; i++) {
+			tracker.onEvent(
+				{
+					type: 2,
+					timestamp: Date.now(),
+					data: { i, payload: "x".repeat(300) },
+				},
+				false,
+			);
+			await tracker.flush(false);
+		}
+
+		expect(tracker.pending.length).toBeGreaterThan(0);
+		expect(tracker.pendingSizeBytes).toBeLessThanOrEqual(900);
+
+		if (tracker.retryTask) clearTimeout(tracker.retryTask);
+	});
 });

package/tsdown.config.ts

@@ -1,7 +1,14 @@
 import { defineConfig } from "tsdown";
+import pkg from "./package.json" with { type: "json" };
 
 export default defineConfig({
-	entry: "src/module.ts",
+	entry: {
+		index: "src/entries/main.ts",
+		"feature-flags": "src/entries/feature-flags.ts",
+		replay: "src/entries/replay.ts",
+		error: "src/entries/error.ts",
+		"web-vitals": "src/entries/web-vitals.ts",
+	},
 	format: ["esm"],
 	platform: "browser",
 	outDir: "dist",
@@ -9,4 +16,12 @@ export default defineConfig({
 	minify: true,
 	deps: { onlyBundle: false },
 	checks: { pluginTimings: false },
+	define: {
+		__FASTSTATS_SDK_NAME__: JSON.stringify(pkg.name),
+		__FASTSTATS_SDK_VERSION__: JSON.stringify(pkg.version),
+	},
+	outputOptions: {
+		chunkFileNames: "chunks/[name]-[hash].js",
+		entryFileNames: "[name].js",
+	},
 });

package/dist/analytics-Ct-lghlf.js

@@ -1 +0,0 @@
-import{a as e,c as t,d as n,f as r,i,l as a,m as o,n as s,o as c,r as l,s as u,t as d,u as f}from"./types-Df70G0eM.js";async function p(e,t){if(t.projectToken&&t.projectId)throw Error(`provide either projectToken or projectId, not both`);if(t.identifier&&t.externalId)throw Error(`provide either serverId or externalId, not both`);let n=t.projectToken,r=t.projectId,i=t.identifier,o=t.externalId;if(!n&&!r)throw Error(`feature flag check requires projectToken or projectId`);if(!i&&!o)throw Error(`feature flag check requires serverId or externalId`);let s={key:e,...r?{projectId:r}:{},...i?{identifier:i}:{externalId:o}};t.attributes&&Object.keys(t.attributes).length>0&&(s.attributes=t.attributes);let c={"Content-Type":`application/json`};n&&(c.Authorization=`Bearer ${n}`);let l=a(t.baseUrl),u=await fetch(l,{method:`POST`,headers:c,body:JSON.stringify(s),credentials:`omit`,signal:t.signal});if(!u.ok){let e=``;try{let t=await u.json();typeof t.error==`string`&&t.error.length>0&&(e=` — ${t.error}`)}catch{}throw Error(`feature flag check failed: HTTP ${u.status}${e}`)}return await u.json()}function m(e){return e.replayOptions?.samplingPercentage!==void 0||e.sessionReplays?.sampling?.percentage!==void 0}function h(e,t,n){if(!(e.sessionReplays?.enabled??e.trackReplay??m(e)))return null;let r=e.replayOptions??{};return{siteKey:e.siteKey,baseUrl:t,debug:n,...r,samplingPercentage:d(r.samplingPercentage??e.sessionReplays?.sampling?.percentage)}}let g=null,_;function v(){return g}function y(e,t){typeof window>`u`||E()||g?.track(e,t??{})}function b(e,t,n){typeof window>`u`||E()||g?.identify(e,t,n??{})}function x(e=!0){typeof window>`u`||E()||g?.logout(e)}function S(e){if(g){g.setConsentMode(e);return}_=e}function C(){S(`granted`)}function w(){S(`denied`)}function T(e){typeof window>`u`||E()||g?.reportError(e)}function E(){if(typeof localStorage>`u`)return!1;let e=localStorage.getItem(`disable-faststats`);return e===`true`||e===`1`}async function D(e){let{url:t,data:n,contentType:r=`application/json`,headers:i={},debug:a=!1,debugPrefix:o=`[Analytics]`,useBeacon:s=!0,keepalive:c=!0}=e;if(s&&typeof navigator<`u`&&typeof navigator.sendBeacon==`function`)try{let e=n instanceof Blob?n:typeof Blob<`u`?new Blob([n],{type:r}):n;if(navigator.sendBeacon(t,e))return a&&console.log(`${o} Sent via beacon`),!0}catch{}if(typeof fetch!=`function`)return a&&console.warn(`${o} Failed to send`),!1;try{let e=await fetch(t,{method:`POST`,body:n,headers:{"Content-Type":r,...i},keepalive:c}),s=e.ok;return a&&(s?console.log(`${o} Sent via fetch`):console.warn(`${o} Failed: ${e.status}`)),s}catch{return a&&console.warn(`${o} Failed to send`),!1}}function O(e){for(;e;){if(e instanceof HTMLAnchorElement&&e.href)return e;e=e.parentNode}return null}function k(){let e={};if(!location.search)return e;let t=new URLSearchParams(location.search);for(let n of[`utm_source`,`utm_medium`,`utm_campaign`,`utm_term`,`utm_content`]){let r=t.get(n);r&&(e[n]=r)}return e}var A=class{webEndpoint;baseUrl;featureFlagsBaseUrl;debug;started=!1;destroyed=!1;pageKey=``;navTimer=null;heartbeatTimer=null;scrollDepth=0;pageEntryTime=0;pagePath=``;pageUrl=``;pageHash=``;hasLeftCurrentPage=!1;scrollHandler=null;consentMode;cookielessWhilePending;cleanupCallbacks=[];childTrackers=[];pendingReportedErrors=[];errorTracker=null;handleVisibilityChange=()=>{document.visibilityState===`hidden`?(this.leavePage(),this.stopHeartbeat()):this.startHeartbeat()};handlePageHide=()=>{this.leavePage()};handlePopState=()=>{this.navigate()};handleHashChange=()=>{this.navigate()};constructor(e){this.options=e,this.baseUrl=n(e.baseUrl),this.featureFlagsBaseUrl=r(e.featureFlagsBaseUrl),this.webEndpoint=o(this.baseUrl),this.debug=e.debug??!1,this.consentMode=e.consent?.mode??`granted`,this.cookielessWhilePending=e.consent?.cookielessWhilePending??!0,_!==void 0&&(this.consentMode=_,_=void 0),(e.autoTrack??!0)&&this.init()}log(e){this.debug&&console.log(`[Analytics] ${e}`)}init(){if(!(typeof window>`u`)){if(E()){this.log(`disabled`);return}g=this,t(this.isCookielessMode()),setTimeout(()=>void this.start(),0)}}registerCleanup(e){this.cleanupCallbacks.push(e)}addWindowListener(e,t){window.addEventListener(e,t),this.registerCleanup(()=>window.removeEventListener(e,t))}addDocumentListener(e,t){document.addEventListener(e,t),this.registerCleanup(()=>document.removeEventListener(e,t))}patchHistory(){let e=history.pushState.bind(history),t=history.replaceState.bind(history);history.pushState=(t,n,r)=>{e(t,n,r),this.navigate()},history.replaceState=(e,n,r)=>{t(e,n,r),this.navigate()},this.registerCleanup(()=>{history.pushState=e,history.replaceState=t})}ensureStarted(){return typeof window>`u`||this.destroyed||E()?!1:(this.started||this.start(),!0)}stopHeartbeat(){this.heartbeatTimer&&=(clearInterval(this.heartbeatTimer),null)}stopNavigationTimer(){this.navTimer&&=(clearTimeout(this.navTimer),null)}stopChildTrackers(){for(let e of this.childTrackers.splice(0))e.stop?.();this.errorTracker=null}registerChildTracker(e){return!this.started||this.destroyed||g!==this?(e.stop?.(),!1):(this.childTrackers.push(e),!0)}async startErrorTracker(){try{let{default:e}=await import(`./error-asweBGYd.js`);if(!this.started||this.destroyed||g!==this)return;let t=new e({siteKey:this.options.siteKey,baseUrl:this.baseUrl,debug:this.debug});if(t.start(),!this.registerChildTracker(t))return;for(this.errorTracker=t;this.pendingReportedErrors.length>0;){let e=this.pendingReportedErrors.shift();e&&t.captureError(e)}this.log(`error loaded`)}catch(e){this.log(`failed to initialize error tracker: ${String(e)}`)}}async startWebVitalsTracker(){try{let{default:e}=await import(`./web-vitals-gcUR-TX_.js`);if(!this.started||this.destroyed||g!==this)return;let t=new e({siteKey:this.options.siteKey,baseUrl:this.baseUrl,debug:this.debug,samplingPercentage:d(this.options.webVitals?.sampling?.percentage)});if(t.start(),!this.registerChildTracker(t))return;this.log(`web-vitals loaded`)}catch(e){this.log(`failed to initialize web-vitals tracker: ${String(e)}`)}}async startReplayTracker(e){try{let{default:t}=await import(`./replay-DUA5c3Jf.js`);if(!this.started||this.destroyed||g!==this)return;let n=new t(e);if(n.start(),!this.registerChildTracker(n))return;this.log(`replay loaded`)}catch(e){this.log(`failed to initialize replay tracker: ${String(e)}`)}}async start(){if(this.started||this.destroyed||typeof window>`u`)return;if(g&&g!==this){this.log(`already started by another instance`);return}if(E()){this.log(`disabled`);return}this.started=!0,g=this,t(this.isCookielessMode()),l();let e=this.options,n=h(e,this.baseUrl,this.debug);n&&this.startReplayTracker(n),e.trackErrors&&this.startErrorTracker(),e.trackWebVitals&&this.startWebVitalsTracker(),this.enterPage(),this.pageview({trigger:`load`}),this.links(),this.trackScroll(),this.startHeartbeat(),this.addDocumentListener(`visibilitychange`,this.handleVisibilityChange),this.addWindowListener(`pagehide`,this.handlePageHide),this.addWindowListener(`popstate`,this.handlePopState),e.trackHash&&this.addWindowListener(`hashchange`,this.handleHashChange),this.patchHistory()}destroy(){if(!this.destroyed){for(this.started&&typeof window<`u`&&this.leavePage(),this.pendingReportedErrors.length=0,this.stopNavigationTimer(),this.stopHeartbeat(),this.scrollHandler&&typeof window<`u`&&(window.removeEventListener(`scroll`,this.scrollHandler),this.scrollHandler=null);this.cleanupCallbacks.length>0;)this.cleanupCallbacks.pop()?.();this.stopChildTrackers(),g===this&&(g=null),this.started=!1,this.destroyed=!0}}pageview(e={}){if(!this.ensureStarted())return;let t=`${location.pathname}|${this.options.trackHash??!1?location.hash:``}`;t!==this.pageKey&&(this.pageKey=t,this.send(`pageview`,e))}track(e,t={}){this.ensureStarted()&&this.send(e,t)}identify(e,t,n={}){if(!this.ensureStarted()||this.isCookielessMode())return;let r=e.trim(),i=t.trim();!r||!i||D({url:f(this.baseUrl),data:JSON.stringify({token:this.options.siteKey,identifier:s(!1),externalId:r,email:i,name:n.name?.trim()||void 0,phone:n.phone?.trim()||void 0,avatarUrl:n.avatarUrl?.trim()||void 0,traits:n.traits??{}}),contentType:`text/plain`,debug:this.debug,debugPrefix:`[Analytics] identify`})}logout(e=!0){this.ensureStarted()&&(e&&c(this.isCookielessMode()),u())}setConsentMode(e){this.consentMode=e,t(this.isCookielessMode())}optIn(){this.setConsentMode(`granted`)}optOut(){this.setConsentMode(`denied`)}getConsentMode(){return this.consentMode}getAnonymousId(){return s(this.isCookielessMode())}getSessionId(){return l()}async checkFeatureFlag(e,t,n){if(typeof window>`u`||E())return{value:`false`};let r=n?.externalId?.trim();if(r)return p(e,{baseUrl:this.featureFlagsBaseUrl,projectToken:this.options.siteKey,externalId:r,attributes:t,signal:n?.signal});let i=this.getAnonymousId();return i?p(e,{baseUrl:this.featureFlagsBaseUrl,projectToken:this.options.siteKey,identifier:i,attributes:t,signal:n?.signal}):{value:`false`}}reportError(e){if(this.destroyed||typeof window>`u`||E()||!(this.options.trackErrors??!1)||!this.ensureStarted())return;let t=this.errorTracker;if(t){t.captureError(e);return}this.pendingReportedErrors.length>=50&&this.pendingReportedErrors.shift(),this.pendingReportedErrors.push(e)}isCookielessMode(){return this.options.cookieless||this.consentMode===`denied`?!0:this.consentMode===`pending`?this.cookielessWhilePending:!1}send(e,t={}){if(typeof window>`u`||this.destroyed||E())return;let n=s(this.isCookielessMode()),r=JSON.stringify({token:this.options.siteKey,...n?{userId:n}:{},sessionId:l(),data:{event:e,page:location.pathname,referrer:document.referrer||null,title:document.title||``,url:location.href,...k(),...t}});this.log(e),D({url:this.webEndpoint,data:r,contentType:`text/plain`,debug:this.debug,debugPrefix:`[Analytics] ${e}`})}enterPage(){this.pageEntryTime=Date.now(),this.pagePath=location.pathname,this.pageUrl=location.href,this.pageHash=location.hash,this.scrollDepth=0,this.hasLeftCurrentPage=!1}leavePage(){if(this.destroyed||this.hasLeftCurrentPage)return;this.hasLeftCurrentPage=!0;let e=Date.now();this.send(`page_leave`,{page:this.pagePath,url:this.pageUrl,time_on_page:e-this.pageEntryTime,scroll_depth:this.scrollDepth,session_duration:e-i()})}trackScroll(){this.scrollHandler&&window.removeEventListener(`scroll`,this.scrollHandler);let e=()=>{let e=document.documentElement,t=document.body,n=window.innerHeight,r=Math.max(e.scrollHeight,t.scrollHeight);if(r<=n){this.scrollDepth=100;return}let i=Math.min(100,Math.round(((window.scrollY||e.scrollTop)+n)/r*100));i>this.scrollDepth&&(this.scrollDepth=i)};this.scrollHandler=e,e(),window.addEventListener(`scroll`,e,{passive:!0})}startHeartbeat(){this.stopHeartbeat(),this.heartbeatTimer=setInterval(()=>{if(document.visibilityState===`hidden`){this.stopHeartbeat();return}e()},300*1e3)}navigate(){!this.started||this.destroyed||(this.stopNavigationTimer(),this.navTimer=setTimeout(()=>{this.navTimer=null;let e=location.pathname!==this.pagePath,t=(this.options.trackHash??!1)&&location.hash!==this.pageHash;!e&&!t||(this.leavePage(),this.enterPage(),this.trackScroll(),this.pageview({trigger:`navigation`}))},300))}links(){let e=e=>{let t=O(e.target);t&&t.host!==location.host&&this.track(`outbound_link`,{outbound_link:t.href})};this.addDocumentListener(`click`,e),this.addDocumentListener(`auxclick`,e)}};export{x as a,T as c,y as d,p as f,E as i,D as l,v as n,C as o,b as r,w as s,A as t,S as u};