@posthog/browser-common 0.10.4 → 0.10.6

package/dist/client.d.ts

@@ -108,8 +108,14 @@ export interface Client {
     readonly isOptedOut: boolean;
     /** Whether the host currently permits data capture. */
     readonly canCapture: boolean;
-    /** Synchronously admits an analytics event to the client's normal pipeline. */
-    capture(event: string, properties?: Properties | null, options?: CaptureOptions): void;
+    /** Whether the client rate limit drops an event captured now. Reading it must not use a token. */
+    readonly isRateLimited?: boolean;
+    /**
+     * Synchronously admits an analytics event to the client's normal pipeline.
+     * Returns `false` when the client rate limit dropped the event, so the caller can send it again later.
+     * An event that is dropped for another reason, for example by `before_send`, returns `true`.
+     */
+    capture(event: string, properties?: Properties | null, options?: CaptureOptions): boolean;
     /** Registers a synchronous producer of properties merged into every captured event. */
     registerDynamicEventProperties(producer: () => Record<string, unknown>): Disposable;
     /** Returns the extension registered under a typed stable name, or `undefined` when it is not installed. */

package/dist/config.js

@@ -27,7 +27,7 @@ var __webpack_require__ = {};
 })();
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
-const packageVersion = "0.10.4";
+const packageVersion = "0.10.6";
 const Config = {
     DEBUG: false,
     LIB_VERSION: packageVersion,

package/dist/config.mjs

@@ -1,4 +1,4 @@
-const packageVersion = "0.10.4";
+const packageVersion = "0.10.6";
 const Config = {
     DEBUG: false,
     LIB_VERSION: packageVersion,

package/dist/feature-flags.d.ts

@@ -76,6 +76,8 @@ export declare class PostHogFeatureFlags implements Extension {
     private _additionalReloadRequested;
     private _reloadDebouncer;
     private _firingFeatureFlagsCallbacks;
+    private _flagCallsPendingCapture;
+    private _sendingFlagCallsPendingCapture;
     private _flagsLoadedFromRemote;
     private _staleCacheRefreshTriggered;
     private _consecutiveStatusZeroFailures;
@@ -153,6 +155,8 @@ export declare class PostHogFeatureFlags implements Extension {
     setAnonymousDistinctId(anon_distinct_id: string | undefined): void;
     setReloadingPaused(isPaused: boolean): void;
     resetFlagCallReported(): void;
+    /** Sends `$feature_flag_called` for the flags read while capture was off, once the client can capture. */
+    sendFlagCallsPendingCapture(): void;
     _callFlagsEndpoint(options?: {
         disableFlags?: boolean;
     }): void;
@@ -224,7 +228,11 @@ export declare class PostHogFeatureFlags implements Extension {
      * @returns {FeatureFlagResult | undefined} The feature flag result including key, enabled, variant, and payload.
      */
     getFeatureFlagResult(key: string, options?: FeatureFlagOptions): FeatureFlagResult | undefined;
+    /** Returns `false` when the client rate limit dropped the event. */
     private _captureFeatureFlagCalled;
+    private _holdFlagCall;
+    private _flagCallContext;
+    private _unmarkFlagCallReported;
     getRemoteConfigPayload(key: string, callback: RemoteConfigFeatureFlagCallback): void;
     private _getRemoteConfigPayload;
     /**

package/dist/feature-flags.js

@@ -190,6 +190,11 @@ const QuotaLimitedResource = {
     FeatureFlags: 'feature_flags',
     Recordings: 'recordings'
 };
+const haveSameGroups = (a, b)=>{
+    const keys = Object.keys(a);
+    return keys.length === Object.keys(b).length && keys.every((key)=>a[key] === b[key]);
+};
+const isSameFlagCallContext = (a, b)=>a.distinctId === b.distinctId && a.sessionId === b.sessionId && haveSameGroups(a.groups, b.groups);
 class PostHogFeatureFlags {
     constructor(configSource){
         this.name = 'featureFlags';
@@ -207,6 +212,8 @@ class PostHogFeatureFlags {
         this._reloadingDisabled = false;
         this._additionalReloadRequested = false;
         this._firingFeatureFlagsCallbacks = false;
+        this._flagCallsPendingCapture = new Map();
+        this._sendingFlagCallsPendingCapture = false;
         this._flagsLoadedFromRemote = false;
         this._staleCacheRefreshTriggered = false;
         this._consecutiveStatusZeroFailures = 0;
@@ -650,6 +657,27 @@ class PostHogFeatureFlags {
     }
     resetFlagCallReported() {
         this._remove(external_constants_js_namespaceObject.FLAG_CALL_REPORTED);
+        this._flagCallsPendingCapture = new Map();
+    }
+    sendFlagCallsPendingCapture() {
+        if (0 === this._flagCallsPendingCapture.size || this._sendingFlagCallsPendingCapture || !this._client?.canCapture || this._client.isRateLimited) return;
+        this._sendingFlagCallsPendingCapture = true;
+        try {
+            const flagVariants = this.getFlagVariants();
+            for (const key of Array.from(this._flagCallsPendingCapture.keys())){
+                const pending = this._flagCallsPendingCapture.get(key);
+                if (pending) {
+                    if (pending.value !== String(flagVariants[key]) || !isSameFlagCallContext(pending.context, this._flagCallContext())) {
+                        this._flagCallsPendingCapture.delete(key);
+                        continue;
+                    }
+                    this.getFeatureFlagResult(key);
+                    if (this._flagCallsPendingCapture.has(key)) break;
+                }
+            }
+        } finally{
+            this._sendingFlagCallsPendingCapture = false;
+        }
     }
     _callFlagsEndpoint(options) {
         this._clearDebouncer();
@@ -812,12 +840,17 @@ class PostHogFeatureFlags {
                 [external_constants_js_namespaceObject.FLAG_CALL_REPORTED_SESSION_ID]: sessionIdToPersist
             });
         } else {
-            const canCapture = this._client?.canCapture;
-            if (!canCapture && Object.keys(flagCallReported).length > 0) {
-                flagCallReported = {};
-                this._set({
-                    [external_constants_js_namespaceObject.FLAG_CALL_REPORTED]: flagCallReported
-                });
+            const captureOff = !this._client?.canCapture;
+            const canCapture = !captureOff && !this._client?.isRateLimited;
+            if (canCapture) this._flagCallsPendingCapture.delete(key);
+            else {
+                if (captureOff && Object.keys(flagCallReported).length > 0) {
+                    flagCallReported = {};
+                    this._set({
+                        [external_constants_js_namespaceObject.FLAG_CALL_REPORTED]: flagCallReported
+                    });
+                }
+                if (!flagCallReported[key]?.includes(flagReportValue)) this._holdFlagCall(key, flagReportValue);
             }
             if (canCapture && !flagCallReported[key]?.includes(flagReportValue)) {
                 if ((0, core_namespaceObject.isArray)(flagCallReported[key])) flagCallReported[key].push(flagReportValue);
@@ -853,7 +886,10 @@ class PostHogFeatureFlags {
                 if (!(0, core_namespaceObject.isUndefined)(flagDetails?.original_variant) || !(0, core_namespaceObject.isUndefined)(flagDetails?.original_enabled)) properties.$feature_flag_original_response = (0, core_namespaceObject.isUndefined)(flagDetails.original_variant) ? flagDetails.original_enabled : flagDetails.original_variant;
                 if (flagDetails?.metadata?.original_payload) properties.$feature_flag_original_payload = flagDetails?.metadata?.original_payload;
                 if (errors.length) properties.$feature_flag_error = errors.join(',');
-                this._captureFeatureFlagCalled(properties);
+                if (!this._captureFeatureFlagCalled(properties)) {
+                    this._unmarkFlagCallReported(key, flagReportValue);
+                    this._holdFlagCall(key, flagReportValue);
+                }
             } else if (sessionIdToPersist) this._set({
                 [external_constants_js_namespaceObject.FLAG_CALL_REPORTED]: flagCallReported,
                 [external_constants_js_namespaceObject.FLAG_CALL_REPORTED_SESSION_ID]: sessionIdToPersist
@@ -869,11 +905,36 @@ class PostHogFeatureFlags {
     }
     _captureFeatureFlagCalled(properties) {
         try {
-            this._client?.capture('$feature_flag_called', properties);
+            return this._client?.capture('$feature_flag_called', properties) !== false;
         } catch (error) {
             this._logger.error('Failed to capture feature flag call', error);
+            return true;
         }
     }
+    _holdFlagCall(key, value) {
+        this._flagCallsPendingCapture.set(key, {
+            value,
+            context: this._flagCallContext()
+        });
+    }
+    _flagCallContext() {
+        return {
+            distinctId: this._client?.distinctId,
+            groups: {
+                ...this._client?.groups
+            },
+            sessionId: this._config.deduplicateCallsPerSession ? this._client?.session?.sessionId : void 0
+        };
+    }
+    _unmarkFlagCallReported(key, flagReportValue) {
+        const flagCallReported = this._prop(external_constants_js_namespaceObject.FLAG_CALL_REPORTED) || {};
+        const reportedValues = flagCallReported[key];
+        if (!(0, core_namespaceObject.isArray)(reportedValues) || !reportedValues.includes(flagReportValue)) return;
+        flagCallReported[key] = reportedValues.filter((value)=>value !== flagReportValue);
+        this._set({
+            [external_constants_js_namespaceObject.FLAG_CALL_REPORTED]: flagCallReported
+        });
+    }
     getRemoteConfigPayload(key, callback) {
         this._getRemoteConfigPayload(key, callback);
     }
@@ -1215,6 +1276,7 @@ class PostHogFeatureFlags {
         this._clearDebouncer();
         this._override_warning = false;
         this._consecutiveStatusZeroFailures = 0;
+        this._flagCallsPendingCapture = new Map();
     }
 }
 exports.FeatureFlagError = __webpack_exports__.FeatureFlagError;

package/dist/feature-flags.mjs

@@ -154,6 +154,11 @@ const QuotaLimitedResource = {
     FeatureFlags: 'feature_flags',
     Recordings: 'recordings'
 };
+const haveSameGroups = (a, b)=>{
+    const keys = Object.keys(a);
+    return keys.length === Object.keys(b).length && keys.every((key)=>a[key] === b[key]);
+};
+const isSameFlagCallContext = (a, b)=>a.distinctId === b.distinctId && a.sessionId === b.sessionId && haveSameGroups(a.groups, b.groups);
 class PostHogFeatureFlags {
     constructor(configSource){
         this.name = 'featureFlags';
@@ -171,6 +176,8 @@ class PostHogFeatureFlags {
         this._reloadingDisabled = false;
         this._additionalReloadRequested = false;
         this._firingFeatureFlagsCallbacks = false;
+        this._flagCallsPendingCapture = new Map();
+        this._sendingFlagCallsPendingCapture = false;
         this._flagsLoadedFromRemote = false;
         this._staleCacheRefreshTriggered = false;
         this._consecutiveStatusZeroFailures = 0;
@@ -614,6 +621,27 @@ class PostHogFeatureFlags {
     }
     resetFlagCallReported() {
         this._remove(FLAG_CALL_REPORTED);
+        this._flagCallsPendingCapture = new Map();
+    }
+    sendFlagCallsPendingCapture() {
+        if (0 === this._flagCallsPendingCapture.size || this._sendingFlagCallsPendingCapture || !this._client?.canCapture || this._client.isRateLimited) return;
+        this._sendingFlagCallsPendingCapture = true;
+        try {
+            const flagVariants = this.getFlagVariants();
+            for (const key of Array.from(this._flagCallsPendingCapture.keys())){
+                const pending = this._flagCallsPendingCapture.get(key);
+                if (pending) {
+                    if (pending.value !== String(flagVariants[key]) || !isSameFlagCallContext(pending.context, this._flagCallContext())) {
+                        this._flagCallsPendingCapture.delete(key);
+                        continue;
+                    }
+                    this.getFeatureFlagResult(key);
+                    if (this._flagCallsPendingCapture.has(key)) break;
+                }
+            }
+        } finally{
+            this._sendingFlagCallsPendingCapture = false;
+        }
     }
     _callFlagsEndpoint(options) {
         this._clearDebouncer();
@@ -776,12 +804,17 @@ class PostHogFeatureFlags {
                 [FLAG_CALL_REPORTED_SESSION_ID]: sessionIdToPersist
             });
         } else {
-            const canCapture = this._client?.canCapture;
-            if (!canCapture && Object.keys(flagCallReported).length > 0) {
-                flagCallReported = {};
-                this._set({
-                    [FLAG_CALL_REPORTED]: flagCallReported
-                });
+            const captureOff = !this._client?.canCapture;
+            const canCapture = !captureOff && !this._client?.isRateLimited;
+            if (canCapture) this._flagCallsPendingCapture.delete(key);
+            else {
+                if (captureOff && Object.keys(flagCallReported).length > 0) {
+                    flagCallReported = {};
+                    this._set({
+                        [FLAG_CALL_REPORTED]: flagCallReported
+                    });
+                }
+                if (!flagCallReported[key]?.includes(flagReportValue)) this._holdFlagCall(key, flagReportValue);
             }
             if (canCapture && !flagCallReported[key]?.includes(flagReportValue)) {
                 if (isArray(flagCallReported[key])) flagCallReported[key].push(flagReportValue);
@@ -817,7 +850,10 @@ class PostHogFeatureFlags {
                 if (!isUndefined(flagDetails?.original_variant) || !isUndefined(flagDetails?.original_enabled)) properties.$feature_flag_original_response = isUndefined(flagDetails.original_variant) ? flagDetails.original_enabled : flagDetails.original_variant;
                 if (flagDetails?.metadata?.original_payload) properties.$feature_flag_original_payload = flagDetails?.metadata?.original_payload;
                 if (errors.length) properties.$feature_flag_error = errors.join(',');
-                this._captureFeatureFlagCalled(properties);
+                if (!this._captureFeatureFlagCalled(properties)) {
+                    this._unmarkFlagCallReported(key, flagReportValue);
+                    this._holdFlagCall(key, flagReportValue);
+                }
             } else if (sessionIdToPersist) this._set({
                 [FLAG_CALL_REPORTED]: flagCallReported,
                 [FLAG_CALL_REPORTED_SESSION_ID]: sessionIdToPersist
@@ -833,11 +869,36 @@ class PostHogFeatureFlags {
     }
     _captureFeatureFlagCalled(properties) {
         try {
-            this._client?.capture('$feature_flag_called', properties);
+            return this._client?.capture('$feature_flag_called', properties) !== false;
         } catch (error) {
             this._logger.error('Failed to capture feature flag call', error);
+            return true;
         }
     }
+    _holdFlagCall(key, value) {
+        this._flagCallsPendingCapture.set(key, {
+            value,
+            context: this._flagCallContext()
+        });
+    }
+    _flagCallContext() {
+        return {
+            distinctId: this._client?.distinctId,
+            groups: {
+                ...this._client?.groups
+            },
+            sessionId: this._config.deduplicateCallsPerSession ? this._client?.session?.sessionId : void 0
+        };
+    }
+    _unmarkFlagCallReported(key, flagReportValue) {
+        const flagCallReported = this._prop(FLAG_CALL_REPORTED) || {};
+        const reportedValues = flagCallReported[key];
+        if (!isArray(reportedValues) || !reportedValues.includes(flagReportValue)) return;
+        flagCallReported[key] = reportedValues.filter((value)=>value !== flagReportValue);
+        this._set({
+            [FLAG_CALL_REPORTED]: flagCallReported
+        });
+    }
     getRemoteConfigPayload(key, callback) {
         this._getRemoteConfigPayload(key, callback);
     }
@@ -1179,6 +1240,7 @@ class PostHogFeatureFlags {
         this._clearDebouncer();
         this._override_warning = false;
         this._consecutiveStatusZeroFailures = 0;
+        this._flagCallsPendingCapture = new Map();
     }
 }
 export { FeatureFlagError, PostHogFeatureFlags, QuotaLimitedResource, filterActiveFeatureFlags, parseFlagsResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@posthog/browser-common",
-  "version": "0.10.4",
+  "version": "0.10.6",
   "description": "Internal shared browser utilities and extension primitives for PostHog Browser SDKs",
   "license": "MIT",
   "repository": {
@@ -241,8 +241,8 @@
   "dependencies": {
     "dompurify": "^3.4.13",
     "preact": "^10.29.3",
-    "@posthog/types": "^1.419.0",
-    "@posthog/core": "^1.62.1"
+    "@posthog/core": "^1.63.1",
+    "@posthog/types": "^1.419.0"
   },
   "devDependencies": {
     "@rsbuild/plugin-react": "^2.1.0",