posthog-node 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Next
 
+# 4.2.0 - 2024-08-26
+
+1. Added `historicalMigration` option for use in tools that are migrating large data to PostHog
+
+# 4.1.1 - 2024-08-20
+
+1. Local evaluation returns correct results on `undefined/null` values
+
 # 4.1.0 - 2024-08-14
 
 1. chore: change host to new address.

package/lib/index.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var rusha = require('rusha');
 
-var version = "4.1.0";
+var version = "4.2.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -952,6 +952,7 @@ class PostHogCoreStateless {
     constructor(apiKey, options) {
         this.flushPromise = null;
         this.disableGeoip = true;
+        this.historicalMigration = false;
         this.disabled = false;
         this.defaultOptIn = true;
         this.pendingPromises = {};
@@ -977,6 +978,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;
@@ -1291,6 +1293,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()}`
@@ -1434,6 +1439,7 @@ if (!_fetch) {
 var fetch$1 = _fetch;
 
 const LONG_SCALE = 0xfffffffffffffff;
+const NULL_VALUES_ALLOWED_OPERATORS = ['is_not'];
 
 class ClientError extends Error {
   constructor(message) {
@@ -1680,6 +1686,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;
@@ -1688,7 +1700,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) {
@@ -1830,7 +1842,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';
@@ -1843,6 +1855,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());