@yuanze_dev/tracker 0.4.0 → 0.6.0

package/dist/autocapture.js

@@ -39,9 +39,9 @@ export function setupAutocapture(tracker, options = {}) {
         return;
     const { captureClicks = true, allow = DEFAULT_ALLOW, deny = DEFAULT_DENY, sampleRate = 1, maxTextLength = 64, } = options;
     const sendPageview = () => tracker.track("$pageview", {
-        url: redactUrl(location.pathname + location.search),
-        title: document.title,
-        referrer: redactUrl(document.referrer),
+        $url: redactUrl(location.pathname + location.search),
+        $title: document.title,
+        $referrer: redactUrl(document.referrer),
     });
     sendPageview();
     const patch = (key) => {
@@ -82,16 +82,16 @@ export function setupAutocapture(tracker, options = {}) {
         if (sampleRate < 1 && Math.random() >= sampleRate)
             return;
         const props = {
-            tag: el.tagName.toLowerCase(),
-            selector: elementSelector(el),
-            url: location.pathname,
+            $tag: el.tagName.toLowerCase(),
+            $selector: elementSelector(el),
+            $url: location.pathname,
         };
         const text = sanitizeText(el.textContent || "", maxTextLength);
         if (text)
-            props.text = text;
+            props.$text = text;
         const href = el.getAttribute("href");
         if (href && !href.startsWith("javascript:"))
-            props.href = redactUrl(href);
+            props.$href = redactUrl(href);
         tracker.trackUnsafe("$autocapture", props);
     }, true);
 }

package/dist/context.js

@@ -38,18 +38,18 @@ export function collectEnvContext() {
     if (typeof navigator === "undefined")
         return ctx;
     const ua = navigator.userAgent || "";
-    ctx.os = detectOS(ua);
-    ctx.browser = detectBrowser(ua);
+    ctx["$os"] = detectOS(ua);
+    ctx["$browser"] = detectBrowser(ua);
     if (navigator.language)
-        ctx.language = navigator.language;
+        ctx["$language"] = navigator.language;
     if (typeof screen !== "undefined" && screen.width) {
-        ctx.screen_width = screen.width;
-        ctx.screen_height = screen.height;
+        ctx["$screen_width"] = screen.width;
+        ctx["$screen_height"] = screen.height;
     }
     if (typeof document !== "undefined" && document.referrer) {
-        ctx.referrer = document.referrer;
+        ctx["$referrer"] = document.referrer;
         try {
-            ctx.referrer_domain = new URL(document.referrer).hostname;
+            ctx["$referrer_domain"] = new URL(document.referrer).hostname;
         }
         catch {
         }
@@ -60,7 +60,7 @@ export function collectEnvContext() {
             for (const k of UTM_KEYS) {
                 const v = params.get(k);
                 if (v)
-                    ctx[k] = v;
+                    ctx[`$${k}`] = v;
             }
         }
         catch {

package/dist/events.d.ts

@@ -1,15 +1,15 @@
 export interface SystemEvents {
     $pageview: {
-        url: string;
-        title?: string;
-        referrer?: string;
+        $url: string;
+        $title?: string;
+        $referrer?: string;
     };
     $autocapture: {
-        tag: string;
-        selector: string;
-        url: string;
-        text?: string;
-        href?: string;
+        $tag: string;
+        $selector: string;
+        $url: string;
+        $text?: string;
+        $href?: string;
     };
     $experiment_exposure: {
         experiment: string;

package/dist/node.js

@@ -13,7 +13,7 @@ export function machineDistinctId(salt = "yuanze-tracker") {
     }
 }
 export function nodeEnvContext() {
-    return { os: platform(), runtime: `node/${process.versions.node}` };
+    return { $os: platform(), $runtime: `node/${process.versions.node}` };
 }
 export function createTracker(options) {
     const { envContext = true, flushOnExit = true, ...rest } = options;

package/dist/react.js

@@ -49,9 +49,9 @@ export function useRouteTracking(path) {
             return;
         last.current = path;
         tracker.track("$pageview", {
-            url: path,
-            title: typeof document !== "undefined" ? document.title : undefined,
-            referrer: typeof document !== "undefined" ? document.referrer : undefined,
+            $url: path,
+            $title: typeof document !== "undefined" ? document.title : undefined,
+            $referrer: typeof document !== "undefined" ? document.referrer : undefined,
         });
     }, [tracker, path]);
 }

package/dist/tracker.d.ts

@@ -10,6 +10,7 @@ export type TrackerOptions = {
     flushMs?: number;
     autocapture?: boolean;
     sender?: Sender;
+    maxQueueSize?: number;
 };
 export declare class Tracker {
     private queue;
@@ -23,6 +24,9 @@ export declare class Tracker {
     readonly appVersion?: string;
     readonly maxBatch: number;
     readonly flushMs: number;
+    readonly maxQueueSize: number;
+    private flushing;
+    private retryCount;
     constructor(opts: TrackerOptions);
     private anonId;
     register(props: Record<string, unknown>): void;
@@ -32,6 +36,7 @@ export declare class Tracker {
     track<K extends EventName>(name: K, properties?: EventProps<K>): void;
     trackUnsafe(name: string, properties?: Record<string, unknown>): void;
     private enqueue;
+    private trim;
     private schedule;
     flush(unloading?: boolean): Promise<void>;
 }

package/dist/tracker.js

@@ -1,3 +1,5 @@
+const MAX_BATCH_SIZE = 50;
+const MAX_BACKOFF_MS = 30_000;
 function uuid() {
     return globalThis.crypto.randomUUID();
 }
@@ -13,6 +15,9 @@ export class Tracker {
     appVersion;
     maxBatch;
     flushMs;
+    maxQueueSize;
+    flushing = false;
+    retryCount = 0;
     constructor(opts) {
         this.endpoint = opts.endpoint;
         this.writeKey = opts.writeKey;
@@ -20,6 +25,7 @@ export class Tracker {
         this.appVersion = opts.appVersion;
         this.maxBatch = opts.maxBatch ?? 5;
         this.flushMs = opts.flushMs ?? 5000;
+        this.maxQueueSize = opts.maxQueueSize ?? 500;
         this.send = opts.sender ?? defaultFetchSender;
         this.distinctId = opts.distinctId || this.anonId();
         if (typeof document !== "undefined") {
@@ -80,34 +86,55 @@ export class Tracker {
             clientTime: new Date().toISOString(),
             properties: { ...this.superProps, ...properties },
         });
+        this.trim();
         if (this.queue.length >= this.maxBatch)
             this.flush();
         else
             this.schedule();
     }
-    schedule() {
+    trim() {
+        const overflow = this.queue.length - this.maxQueueSize;
+        if (overflow > 0) {
+            this.queue.splice(0, overflow);
+            console.warn(`[tracker] 队列超过 ${this.maxQueueSize} 条,丢弃最旧的 ${overflow} 条`);
+        }
+    }
+    schedule(delayMs = this.flushMs) {
         if (this.timer)
             return;
-        this.timer = setTimeout(() => this.flush(), this.flushMs);
+        this.timer = setTimeout(() => this.flush(), delayMs);
     }
     async flush(unloading = false) {
         if (this.timer) {
             clearTimeout(this.timer);
             this.timer = null;
         }
-        if (this.queue.length === 0)
+        if (this.queue.length === 0 || (this.flushing && !unloading))
             return;
-        const batch = this.queue.splice(0, this.queue.length);
+        this.flushing = true;
+        const batch = this.queue.splice(0, Math.min(MAX_BATCH_SIZE, this.queue.length));
         const body = JSON.stringify({ events: batch });
         const headers = { "Content-Type": "application/json", "x-write-key": this.writeKey };
         try {
             await this.send(this.endpoint, body, headers, unloading);
+            this.retryCount = 0;
         }
         catch (err) {
-            if (err?.retryable !== false)
+            if (err?.retryable !== false) {
                 this.queue.unshift(...batch);
-            else
+                this.trim();
+                this.retryCount += 1;
+            }
+            else {
                 console.warn("[tracker] 丢弃一批(不可重试):", err?.status);
+                this.retryCount = 0;
+            }
+        }
+        finally {
+            this.flushing = false;
+        }
+        if (this.queue.length > 0 && !unloading) {
+            this.schedule(Math.min(this.flushMs * 2 ** this.retryCount, MAX_BACKOFF_MS));
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuanze_dev/tracker",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "原则数据埋点 SDK",
   "license": "UNLICENSED",
   "type": "module",