posthog-node 4.0.0-beta.3 → 4.0.1

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+
+# 4.0.1 - 2024-04-25
+
+1. Prevent double JSON parsing of feature flag payloads, which would convert the payload [1] into 1.
+
+# 4.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. Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 3 seconds, updated from the default 10s for all other API calls.
+3. `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.
+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
+6. Sets `User-Agent` headers with SDK name and version for RN
+
+## Removed
+
+1. `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
+
+## Changed
+
+1. `flush` and `shutdown` now being async methods.
+
+## Fixed
+
+1. Fixed an issue where `shutdown` would potentially exit early if a flush was already in progress
+2. Fixes some typos in types
+
+
 # 4.0.0-beta.3 - 2024-03-13
 
 1. Sets `User-Agent` headers with SDK name and version for RN

package/lib/index.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var rusha = require('rusha');
 
-var version = "4.0.0-beta.3";
+var version = "4.0.1";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -963,6 +963,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
@@ -1156,14 +1157,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) {
@@ -1187,9 +1185,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,
         };
     }
     /***
@@ -1221,6 +1223,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);
@@ -1538,11 +1544,15 @@ class FeatureFlagsPoller {
     } // Undefined means a loading or missing data issue. Null means evaluation happened and there was no match
 
 
-    if (response === undefined) {
+    if (response === undefined || response === null) {
       return null;
     }
 
-    return response;
+    try {
+      return JSON.parse(response);
+    } catch {
+      return response;
+    }
   }
 
   async getAllFlagsAndPayloads(distinctId, groups = {}, personProperties = {}, groupProperties = {}) {
@@ -1676,7 +1686,7 @@ class FeatureFlagsPoller {
         let matches = false;
 
         if (propertyType === 'cohort') {
-          matches = matchCohort(prop, properties, this.cohorts);
+          matches = matchCohort(prop, properties, this.cohorts, this.debugMode);
         } else {
           matches = matchProperty(prop, properties);
         }
@@ -1932,7 +1942,7 @@ function matchProperty(property, propertyValues) {
   }
 }
 
-function matchCohort(property, propertyValues, cohortProperties) {
+function matchCohort(property, propertyValues, cohortProperties, debugMode = false) {
   const cohortId = String(property.value);
 
   if (!(cohortId in cohortProperties)) {
@@ -1940,10 +1950,10 @@ function matchCohort(property, propertyValues, cohortProperties) {
   }
 
   const propertyGroup = cohortProperties[cohortId];
-  return matchPropertyGroup(propertyGroup, propertyValues, cohortProperties);
+  return matchPropertyGroup(propertyGroup, propertyValues, cohortProperties, debugMode);
 }
 
-function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties) {
+function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties, debugMode = false) {
   if (!propertyGroup) {
     return true;
   }
@@ -1962,7 +1972,7 @@ function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties) {
     // a nested property group
     for (const prop of properties) {
       try {
-        const matches = matchPropertyGroup(prop, propertyValues, cohortProperties);
+        const matches = matchPropertyGroup(prop, propertyValues, cohortProperties, debugMode);
 
         if (propertyGroupType === 'AND') {
           if (!matches) {
@@ -1976,7 +1986,10 @@ function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties) {
         }
       } catch (err) {
         if (err instanceof InconclusiveMatchError) {
-          console.debug(`Failed to compute property ${prop} locally: ${err}`);
+          if (debugMode) {
+            console.debug(`Failed to compute property ${prop} locally: ${err}`);
+          }
+
           errorMatchingLocally = true;
         } else {
           throw err;
@@ -1996,7 +2009,7 @@ function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties) {
         let matches;
 
         if (prop.type === 'cohort') {
-          matches = matchCohort(prop, propertyValues, cohortProperties);
+          matches = matchCohort(prop, propertyValues, cohortProperties, debugMode);
         } else {
           matches = matchProperty(prop, propertyValues);
         }
@@ -2024,7 +2037,10 @@ function matchPropertyGroup(propertyGroup, propertyValues, cohortProperties) {
         }
       } catch (err) {
         if (err instanceof InconclusiveMatchError) {
-          console.debug(`Failed to compute property ${prop} locally: ${err}`);
+          if (debugMode) {
+            console.debug(`Failed to compute property ${prop} locally: ${err}`);
+          }
+
           errorMatchingLocally = true;
         } else {
           throw err;
@@ -2373,11 +2389,7 @@ class PostHog extends PostHogCoreStateless {
       response = await super.getFeatureFlagPayloadStateless(key, distinctId, groups, personProperties, groupProperties, disableGeoip);
     }
 
-    try {
-      return JSON.parse(response);
-    } catch {
-      return response;
-    }
+    return response;
   }
 
   async isFeatureEnabled(key, distinctId, options) {