posthog-js-lite 3.0.0-beta.2 → 3.0.1

package/lib/index.d.ts

@@ -7,6 +7,10 @@ declare type PostHogCoreOptions = {
     flushInterval?: number;
     /** The maximum number of queued messages to be flushed as part of a single batch (must be higher than `flushAt`) */
     maxBatchSize?: number;
+    /** The maximum number of cached messages either in memory or on the local storage.
+     * Defaults to 1000, (must be higher than `flushAt`)
+     */
+    maxQueueSize?: number;
     /** If set to true the SDK is essentially disabled (useful for local environments where you don't want to track anything) */
     disabled?: boolean;
     /** If set to false the SDK will not track until the `optIn` function is called. */
@@ -32,7 +36,7 @@ declare type PostHogCoreOptions = {
     featureFlagsRequestTimeoutMs?: number;
     /** For Session Analysis how long before we expire a session (defaults to 30 mins) */
     sessionExpirationTimeSeconds?: number;
-    /** Whether to post events to PostHog in JSON or compressed format */
+    /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'form' */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
 };
@@ -130,6 +134,7 @@ declare abstract class PostHogCoreStateless {
     host: string;
     private flushAt;
     private maxBatchSize;
+    private maxQueueSize;
     private flushInterval;
     private flushPromise;
     private requestTimeout;
@@ -200,6 +205,9 @@ declare abstract class PostHogCoreStateless {
      */
     private flushBackground;
     flush(): Promise<any[]>;
+    protected getCustomHeaders(): {
+        [key: string]: string;
+    };
     private _flush;
     private fetchWithRetry;
     shutdown(shutdownTimeoutMs?: number): Promise<void>;

package/lib/index.esm.js

@@ -955,6 +955,7 @@ class PostHogCoreStateless {
         this.host = removeTrailingSlash(options?.host || 'https://app.posthog.com');
         this.flushAt = options?.flushAt ? Math.max(options?.flushAt, 1) : 20;
         this.maxBatchSize = Math.max(this.flushAt, options?.maxBatchSize ?? 100);
+        this.maxQueueSize = Math.max(this.flushAt, options?.maxQueueSize ?? 1000);
         this.flushInterval = options?.flushInterval ?? 10000;
         this.captureMode = options?.captureMode || 'form';
         // If enable is explicitly set to false we override the optout
@@ -1103,7 +1104,7 @@ class PostHogCoreStateless {
         const url = `${this.host}/decide/?v=3`;
         const fetchOptions = {
             method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
+            headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
             body: JSON.stringify({
                 token: this.apiKey,
                 distinct_id: distinctId,
@@ -1148,14 +1149,11 @@ class PostHogCoreStateless {
         if (response === undefined) {
             return null;
         }
-        return this._parsePayload(response);
+        return response;
     }
     async getFeatureFlagPayloadsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
         await this._initPromise;
         const payloads = (await this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)).payloads;
-        if (payloads) {
-            return Object.fromEntries(Object.entries(payloads).map(([k, v]) => [k, this._parsePayload(v)]));
-        }
         return payloads;
     }
     _parsePayload(response) {
@@ -1179,9 +1177,13 @@ class PostHogCoreStateless {
         const decideResponse = await this.getDecide(distinctId, groups, personProperties, groupProperties, extraPayload);
         const flags = decideResponse?.featureFlags;
         const payloads = decideResponse?.featureFlagPayloads;
+        let parsedPayloads = payloads;
+        if (payloads) {
+            parsedPayloads = Object.fromEntries(Object.entries(payloads).map(([k, v]) => [k, this._parsePayload(v)]));
+        }
         return {
             flags,
-            payloads,
+            payloads: parsedPayloads,
         };
     }
     /***
@@ -1213,6 +1215,10 @@ class PostHogCoreStateless {
                 delete message.distinctId;
             }
             const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
+            if (queue.length >= this.maxQueueSize) {
+                queue.shift();
+                console.info('Queue is full, the oldest event is dropped.');
+            }
             queue.push({ message });
             this.setPersistedProperty(PostHogPersistedProperty.Queue, queue);
             this._events.emit(type, message);
@@ -1247,6 +1253,18 @@ class PostHogCoreStateless {
         }
         return this.flushPromise;
     }
+    getCustomHeaders() {
+        // Don't set the user agent if we're not on a browser. The latest spec allows
+        // the User-Agent header (see https://fetch.spec.whatwg.org/#terminology-headers
+        // and https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader),
+        // but browsers such as Chrome and Safari have not caught up.
+        const customUserAgent = this.getCustomUserAgent();
+        const headers = {};
+        if (customUserAgent && customUserAgent !== '') {
+            headers['User-Agent'] = customUserAgent;
+        }
+        return headers;
+    }
     async _flush() {
         this.clearFlushTimer();
         await this._initPromise;
@@ -1265,11 +1283,6 @@ class PostHogCoreStateless {
             batch: messages,
             sent_at: currentISOTime(),
         };
-        // Don't set the user agent if we're not on a browser. The latest spec allows
-        // the User-Agent header (see https://fetch.spec.whatwg.org/#terminology-headers
-        // and https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader),
-        // but browsers such as Chrome and Safari have not caught up.
-        this.getCustomUserAgent();
         const payload = JSON.stringify(data);
         const url = this.captureMode === 'form'
             ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
@@ -1279,12 +1292,12 @@ class PostHogCoreStateless {
                 method: 'POST',
                 mode: 'no-cors',
                 credentials: 'omit',
-                headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
                 body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
             }
             : {
                 method: 'POST',
-                headers: { 'Content-Type': 'application/json' },
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
                 body: payload,
             };
         try {
@@ -1688,7 +1701,7 @@ class PostHogCore extends PostHogCoreStateless {
                         newFeatureFlagPayloads = { ...currentFlagPayloads, ...res.featureFlagPayloads };
                     }
                     this.setKnownFeatureFlags(newFeatureFlags);
-                    this.setKnownFeatureFlagPayloads(newFeatureFlagPayloads);
+                    this.setKnownFeatureFlagPayloads(Object.fromEntries(Object.entries(newFeatureFlagPayloads || {}).map(([k, v]) => [k, this._parsePayload(v)])));
                 }
                 return res;
             });
@@ -1741,13 +1754,10 @@ class PostHogCore extends PostHogCoreStateless {
         if (response === undefined) {
             return null;
         }
-        return this._parsePayload(response);
+        return response;
     }
     getFeatureFlagPayloads() {
         const payloads = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads);
-        if (payloads) {
-            return Object.fromEntries(Object.entries(payloads).map(([k, v]) => [k, this._parsePayload(v)]));
-        }
         return payloads;
     }
     getFeatureFlags() {
@@ -1826,7 +1836,7 @@ class PostHogCore extends PostHogCoreStateless {
     }
 }
 
-var version = "3.0.0-beta.2";
+var version = "3.0.1";
 
 function getContext(window) {
   let context = {};