posthog-node 4.0.0-beta.3 → 4.0.1

package/lib/index.d.ts

@@ -8,6 +8,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. */
@@ -33,7 +37,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;
 };
@@ -125,6 +129,7 @@ declare abstract class PostHogCoreStateless {
     host: string;
     private flushAt;
     private maxBatchSize;
+    private maxQueueSize;
     private flushInterval;
     private flushPromise;
     private requestTimeout;

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { createHash } from 'rusha';
 
-var version = "4.0.0-beta.3";
+var version = "4.0.1";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -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
@@ -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);
@@ -1534,11 +1540,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 = {}) {
@@ -1672,7 +1682,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);
         }
@@ -1928,7 +1938,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)) {
@@ -1936,10 +1946,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;
   }
@@ -1958,7 +1968,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) {
@@ -1972,7 +1982,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;
@@ -1992,7 +2005,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);
         }
@@ -2020,7 +2033,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;
@@ -2369,11 +2385,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) {