posthog-js-lite 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Next
 
+# 3.2.0 - 2024-12-12
+
+## Changed
+
+1. Add new debugging property `$feature_flag_bootstrapped_response`, `$feature_flag_bootstrapped_payload` and `$used_bootstrap_value` to `$feature_flag_called` event
+
+
 # 3.1.0 - 2024-11-21
 
 ## Changed

package/lib/index.cjs.js

@@ -9,6 +9,8 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["Props"] = "props";
     PostHogPersistedProperty["FeatureFlags"] = "feature_flags";
     PostHogPersistedProperty["FeatureFlagPayloads"] = "feature_flag_payloads";
+    PostHogPersistedProperty["BootstrapFeatureFlags"] = "bootstrap_feature_flags";
+    PostHogPersistedProperty["BootstrapFeatureFlagPayloads"] = "bootstrap_feature_flag_payloads";
     PostHogPersistedProperty["OverrideFeatureFlags"] = "override_feature_flags";
     PostHogPersistedProperty["Queue"] = "queue";
     PostHogPersistedProperty["OptedOut"] = "opted_out";
@@ -19,6 +21,7 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["InstalledAppBuild"] = "installed_app_build";
     PostHogPersistedProperty["InstalledAppVersion"] = "installed_app_version";
     PostHogPersistedProperty["SessionReplay"] = "session_replay";
+    PostHogPersistedProperty["DecideEndpointWasHit"] = "decide_endpoint_was_hit";
 })(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
 
 function assert(truthyValue, message) {
@@ -1442,12 +1445,14 @@ class PostHogCore extends PostHogCoreStateless {
                 .filter((flag) => !!bootstrapfeatureFlags[flag])
                 .reduce((res, key) => ((res[key] = bootstrapfeatureFlags[key] || false), res), {});
             if (Object.keys(bootstrapFlags).length) {
+                this.setPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlags, bootstrapFlags);
                 const currentFlags = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlags) || {};
                 const newFeatureFlags = { ...bootstrapFlags, ...currentFlags };
                 this.setKnownFeatureFlags(newFeatureFlags);
             }
             const bootstrapFlagPayloads = bootstrap.featureFlagPayloads;
             if (bootstrapFlagPayloads && Object.keys(bootstrapFlagPayloads).length) {
+                this.setPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlagPayloads, bootstrapFlagPayloads);
                 const currentFlagPayloads = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads) || {};
                 const newFeatureFlagPayloads = { ...bootstrapFlagPayloads, ...currentFlagPayloads };
                 this.setKnownFeatureFlagPayloads(newFeatureFlagPayloads);
@@ -1763,6 +1768,8 @@ class PostHogCore extends PostHogCoreStateless {
                     }
                     this.setKnownFeatureFlags(newFeatureFlags);
                     this.setKnownFeatureFlagPayloads(Object.fromEntries(Object.entries(newFeatureFlagPayloads || {}).map(([k, v]) => [k, this._parsePayload(v)])));
+                    // Mark that we hit the /decide endpoint so we can capture this in the $feature_flag_called event
+                    this.setPersistedProperty(PostHogPersistedProperty.DecideEndpointWasHit, true);
                     const sessionReplay = res?.sessionRecording;
                     if (sessionReplay) {
                         this.setPersistedProperty(PostHogPersistedProperty.SessionReplay, sessionReplay);
@@ -1809,6 +1816,10 @@ class PostHogCore extends PostHogCoreStateless {
             this.capture('$feature_flag_called', {
                 $feature_flag: key,
                 $feature_flag_response: response,
+                $feature_flag_bootstrapped_response: this.getPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlags)?.[key],
+                $feature_flag_bootstrapped_payload: this.getPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlagPayloads)?.[key],
+                // If we haven't yet received a response from the /decide endpoint, we must have used the bootstrapped value
+                $used_bootstrap_value: !this.getPersistedProperty(PostHogPersistedProperty.DecideEndpointWasHit),
             });
         }
         // If we have flags we either return the value (true or string) or false
@@ -1906,7 +1917,7 @@ class PostHogCore extends PostHogCoreStateless {
     }
 }
 
-var version = "3.1.0";
+var version = "3.2.0";
 
 function getContext(window) {
   let context = {};