posthog-node 4.8.1 → 4.10.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Next
 
+# 4.10.0 – 2025-03-06
+
+1. Attach requestId to $feature_flag_called if present in /decide response
+
+# 4.9.0 – 2025-03-04
+
+1. Allow feature flags to be evaluated individually when local evaluation is not being used
+
 # 4.8.1 – 2025-02-26
 
 1. Supports gracefully handling quotaLimited responses from the PostHog API for feature flag evaluation

package/lib/index.cjs.js

@@ -7,7 +7,7 @@ var node_fs = require('node:fs');
 var node_readline = require('node:readline');
 var node_path = require('node:path');
 
-var version = "4.8.1";
+var version = "4.10.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -1155,10 +1155,14 @@ class PostHogCoreStateless {
     }
     async getFeatureFlagStateless(key, distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
         await this._initPromise;
-        const featureFlags = await this.getFeatureFlagsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip);
+        const decideResponse = await this.getFeatureFlagsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip, [key]);
+        const featureFlags = decideResponse.flags;
         if (!featureFlags) {
             // If we haven't loaded flags yet, or errored out, we respond with undefined
-            return undefined;
+            return {
+                response: undefined,
+                requestId: undefined,
+            };
         }
         let response = featureFlags[key];
         // `/decide` v3 returns all flags
@@ -1167,11 +1171,14 @@ class PostHogCoreStateless {
             response = false;
         }
         // If we have flags we either return the value (true or string) or false
-        return response;
+        return {
+            response,
+            requestId: decideResponse.requestId,
+        };
     }
     async getFeatureFlagPayloadStateless(key, distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
         await this._initPromise;
-        const payloads = await this.getFeatureFlagPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip);
+        const payloads = await this.getFeatureFlagPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip, [key]);
         if (!payloads) {
             return undefined;
         }
@@ -1182,9 +1189,9 @@ class PostHogCoreStateless {
         }
         return response;
     }
-    async getFeatureFlagPayloadsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
+    async getFeatureFlagPayloadsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip, flagKeysToEvaluate) {
         await this._initPromise;
-        const payloads = (await this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)).payloads;
+        const payloads = (await this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip, flagKeysToEvaluate)).payloads;
         return payloads;
     }
     _parsePayload(response) {
@@ -1195,16 +1202,19 @@ class PostHogCoreStateless {
             return response;
         }
     }
-    async getFeatureFlagsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
+    async getFeatureFlagsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip, flagKeysToEvaluate) {
         await this._initPromise;
-        return (await this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)).flags;
+        return await this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip, flagKeysToEvaluate);
     }
-    async getFeatureFlagsAndPayloadsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip) {
+    async getFeatureFlagsAndPayloadsStateless(distinctId, groups = {}, personProperties = {}, groupProperties = {}, disableGeoip, flagKeysToEvaluate) {
         await this._initPromise;
         const extraPayload = {};
         if (disableGeoip ?? this.disableGeoip) {
             extraPayload['geoip_disable'] = true;
         }
+        if (flagKeysToEvaluate) {
+            extraPayload['flag_keys_to_evaluate'] = flagKeysToEvaluate;
+        }
         const decideResponse = await this.getDecide(distinctId, groups, personProperties, groupProperties, extraPayload);
         // Add check for quota limitation on feature flags
         if (decideResponse?.quotaLimited?.includes(QuotaLimitedFeature.FeatureFlags)) {
@@ -1212,6 +1222,7 @@ class PostHogCoreStateless {
             return {
                 flags: undefined,
                 payloads: undefined,
+                requestId: decideResponse?.requestId,
             };
         }
         const flags = decideResponse?.featureFlags;
@@ -1223,6 +1234,7 @@ class PostHogCoreStateless {
         return {
             flags,
             payloads: parsedPayloads,
+            requestId: decideResponse?.requestId,
         };
     }
     /***
@@ -3063,8 +3075,8 @@ class PostHog extends PostHogCoreStateless {
         uuid
       });
     };
-    const _getFlags = (distinctId, groups, disableGeoip) => {
-      return super.getFeatureFlagsStateless(distinctId, groups, undefined, undefined, disableGeoip);
+    const _getFlags = async (distinctId, groups, disableGeoip) => {
+      return (await super.getFeatureFlagsStateless(distinctId, groups, undefined, undefined, disableGeoip)).flags;
     };
     // :TRICKY: If we flush, or need to shut down, to not lose events we want this promise to resolve before we flush
     const capturePromise = Promise.resolve().then(async () => {
@@ -3162,8 +3174,11 @@ class PostHog extends PostHogCoreStateless {
     }
     let response = await this.featureFlagsPoller?.getFeatureFlag(key, distinctId, groups, personProperties, groupProperties);
     const flagWasLocallyEvaluated = response !== undefined;
+    let requestId = undefined;
     if (!flagWasLocallyEvaluated && !onlyEvaluateLocally) {
-      response = await super.getFeatureFlagStateless(key, distinctId, groups, personProperties, groupProperties, disableGeoip);
+      const remoteResponse = await super.getFeatureFlagStateless(key, distinctId, groups, personProperties, groupProperties, disableGeoip);
+      response = remoteResponse.response;
+      requestId = remoteResponse.requestId;
     }
     const featureFlagReportedKey = `${key}_${response}`;
     if (sendFeatureFlagEvents && (!(distinctId in this.distinctIdHasSentFlagCalls) || !this.distinctIdHasSentFlagCalls[distinctId].includes(featureFlagReportedKey))) {
@@ -3182,7 +3197,8 @@ class PostHog extends PostHogCoreStateless {
           $feature_flag: key,
           $feature_flag_response: response,
           locally_evaluated: flagWasLocallyEvaluated,
-          [`$feature/${key}`]: response
+          [`$feature/${key}`]: response,
+          $feature_flag_request_id: requestId
         },
         groups,
         disableGeoip