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

package/CHANGELOG.md

@@ -1,17 +1,46 @@
+# 3.0.1 - 2024-04-25
+
+1. Prevent double JSON parsing of feature flag payloads, which would convert the payload [1] into 1.
+
+# 3.0.0 - 2024-03-18
+
+## Added
+
+1. Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
+2. `shutdown` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
+3. Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 10 seconds.
+4. Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
+5. Queued events are limited up to `maxQueueSize` (default 1000) and the oldest events are dropped when the limit is reached
+
+## Removed
+
+1. Removes the `enable` option. You can now specify `defaultOptIn: false` to start the SDK opted out of tracking
+2. `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
+
+## Changed
+
+1. `flush` and `shutdown` now being async methods.
+2. Many methods such as `capture` and `identify` no longer return the `this` object instead returning nothing
+
+## Fixed
+
+1. Fixed an issue where `shutdown` would potentially exit early if a flush was already in progress
+2. Fixes some typos in types
+
 # 3.0.0-beta.2 - 2024-03-12
 
-- `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
-- Fixed an issue where `shutdownAsync` would potentially exit early if a flush was already in progress
-- Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
+1. `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
+2. Fixed an issue where `shutdownAsync` would potentially exit early if a flush was already in progress
+3. Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
 
 # 3.0.0-beta.1 - 2024-03-04
 
-- Removes the `enable` option. You can now specify `defaultOptIn: false` to start the SDK opted out of tracking
-- Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
-- Many methods such as `capture` and `identify` no longer return the `this` object instead returning nothing
-- Fixes some typos in types
-- `shutdown` and `shutdownAsync` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
-- Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 10 seconds.
+1. Removes the `enable` option. You can now specify `defaultOptIn: false` to start the SDK opted out of tracking
+2. Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
+3. Many methods such as `capture` and `identify` no longer return the `this` object instead returning nothing
+4. Fixes some typos in types
+5. `shutdown` and `shutdownAsync` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
+6. Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 10 seconds.
 
 # 2.6.2 - 2024-02-15
 

package/lib/index.cjs.js

@@ -959,6 +959,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
@@ -1107,7 +1108,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,
@@ -1152,14 +1153,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) {
@@ -1183,9 +1181,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,
         };
     }
     /***
@@ -1217,6 +1219,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);
@@ -1251,6 +1257,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;
@@ -1269,11 +1287,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()}`
@@ -1283,12 +1296,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 {
@@ -1692,7 +1705,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;
             });
@@ -1745,13 +1758,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() {
@@ -1830,7 +1840,7 @@ class PostHogCore extends PostHogCoreStateless {
     }
 }
 
-var version = "3.0.0-beta.2";
+var version = "3.0.1";
 
 function getContext(window) {
   let context = {};