posthog-node 4.1.0 → 4.2.0

package/lib/index.d.ts

@@ -40,6 +40,8 @@ declare type PostHogCoreOptions = {
     /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'form' */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
+    /** Special flag to indicate ingested data is for a historical migration. */
+    historicalMigration?: boolean;
 };
 declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
@@ -137,6 +139,7 @@ declare abstract class PostHogCoreStateless {
     private captureMode;
     private removeDebugCallback?;
     private disableGeoip;
+    private historicalMigration;
     disabled: boolean;
     private defaultOptIn;
     private pendingPromises;

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { createHash } from 'rusha';
 
-var version = "4.1.0";
+var version = "4.2.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -948,6 +948,7 @@ class PostHogCoreStateless {
     constructor(apiKey, options) {
         this.flushPromise = null;
         this.disableGeoip = true;
+        this.historicalMigration = false;
         this.disabled = false;
         this.defaultOptIn = true;
         this.pendingPromises = {};
@@ -973,6 +974,7 @@ class PostHogCoreStateless {
         this.featureFlagsRequestTimeoutMs = options?.featureFlagsRequestTimeoutMs ?? 3000; // 3 seconds
         this.disableGeoip = options?.disableGeoip ?? true;
         this.disabled = options?.disabled ?? false;
+        this.historicalMigration = options?.historicalMigration ?? false;
         // Init promise allows the derived class to block calls until it is ready
         this._initPromise = Promise.resolve();
         this._isInitialized = true;
@@ -1287,6 +1289,9 @@ class PostHogCoreStateless {
             batch: messages,
             sent_at: currentISOTime(),
         };
+        if (this.historicalMigration) {
+            data.historical_migration = true;
+        }
         const payload = JSON.stringify(data);
         const url = this.captureMode === 'form'
             ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
@@ -1430,6 +1435,7 @@ if (!_fetch) {
 var fetch$1 = _fetch;
 
 const LONG_SCALE = 0xfffffffffffffff;
+const NULL_VALUES_ALLOWED_OPERATORS = ['is_not'];
 
 class ClientError extends Error {
   constructor(message) {
@@ -1676,6 +1682,12 @@ class FeatureFlagsPoller {
   isConditionMatch(flag, distinctId, condition, properties) {
     const rolloutPercentage = condition.rollout_percentage;
 
+    const warnFunction = msg => {
+      if (this.debugMode) {
+        console.warn(msg);
+      }
+    };
+
     if ((condition.properties || []).length > 0) {
       for (const prop of condition.properties) {
         const propertyType = prop.type;
@@ -1684,7 +1696,7 @@ class FeatureFlagsPoller {
         if (propertyType === 'cohort') {
           matches = matchCohort(prop, properties, this.cohorts, this.debugMode);
         } else {
-          matches = matchProperty(prop, properties);
+          matches = matchProperty(prop, properties, warnFunction);
         }
 
         if (!matches) {
@@ -1826,7 +1838,7 @@ function _hash(key, distinctId, salt = '') {
   return parseInt(sha1Hash.digest('hex').slice(0, 15), 16) / LONG_SCALE;
 }
 
-function matchProperty(property, propertyValues) {
+function matchProperty(property, propertyValues, warnFunction) {
   const key = property.key;
   const value = property.value;
   const operator = property.operator || 'exact';
@@ -1839,6 +1851,16 @@ function matchProperty(property, propertyValues) {
 
   const overrideValue = propertyValues[key];
 
+  if (overrideValue == null && !NULL_VALUES_ALLOWED_OPERATORS.includes(operator)) {
+    // if the value is null, just fail the feature flag comparison
+    // this isn't an InconclusiveMatchError because the property value was provided.
+    if (warnFunction) {
+      warnFunction(`Property ${key} cannot have a value of null/undefined with the ${operator} operator`);
+    }
+
+    return false;
+  }
+
   function computeExactMatch(value, overrideValue) {
     if (Array.isArray(value)) {
       return value.map(val => String(val).toLowerCase()).includes(String(overrideValue).toLowerCase());