posthog-node 5.18.0 → 5.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +38 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +57 -0
- package/dist/client.mjs +57 -0
- package/dist/extensions/feature-flags/feature-flags.d.ts +11 -0
- package/dist/extensions/feature-flags/feature-flags.d.ts.map +1 -1
- package/dist/extensions/feature-flags/feature-flags.js +16 -10
- package/dist/extensions/feature-flags/feature-flags.mjs +16 -10
- package/dist/types.d.ts +50 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/package.json +1 -1
- package/src/client.ts +140 -0
- package/src/extensions/feature-flags/feature-flags.ts +35 -10
- package/src/types.ts +57 -0
- package/src/version.ts +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JsonType, PostHogCoreStateless, PostHogFetchOptions, PostHogFetchResponse, PostHogFlagsAndPayloadsResponse, PostHogPersistedProperty, PostHogCaptureOptions } from '@posthog/core';
|
|
2
|
-
import { EventMessage, GroupIdentifyMessage, IdentifyMessage, IPostHog, PostHogOptions } from './types';
|
|
2
|
+
import { EventMessage, GroupIdentifyMessage, IdentifyMessage, IPostHog, OverrideFeatureFlagsOptions, PostHogOptions } from './types';
|
|
3
3
|
import { FeatureFlagValue } from '@posthog/core';
|
|
4
4
|
import ErrorTracking from './extensions/error-tracking';
|
|
5
5
|
import { PostHogEventProperties } from '@posthog/core';
|
|
@@ -11,6 +11,8 @@ export declare abstract class PostHogBackendClient extends PostHogCoreStateless
|
|
|
11
11
|
private maxCacheSize;
|
|
12
12
|
readonly options: PostHogOptions;
|
|
13
13
|
protected readonly context?: IPostHogContext;
|
|
14
|
+
private _flagOverrides?;
|
|
15
|
+
private _payloadOverrides?;
|
|
14
16
|
distinctIdHasSentFlagCalls: Record<string, string[]>;
|
|
15
17
|
/**
|
|
16
18
|
* Initialize a new PostHog client instance.
|
|
@@ -686,6 +688,41 @@ export declare abstract class PostHogBackendClient extends PostHogCoreStateless
|
|
|
686
688
|
* @returns Promise that resolves when flags are reloaded
|
|
687
689
|
*/
|
|
688
690
|
reloadFeatureFlags(): Promise<void>;
|
|
691
|
+
/**
|
|
692
|
+
* Override feature flags locally. Useful for testing and local development.
|
|
693
|
+
* Overridden flags take precedence over both local evaluation and remote evaluation.
|
|
694
|
+
*
|
|
695
|
+
* @example
|
|
696
|
+
* ```ts
|
|
697
|
+
* // Clear all overrides
|
|
698
|
+
* client.overrideFeatureFlags(false)
|
|
699
|
+
*
|
|
700
|
+
* // Enable a list of flags (sets them to true)
|
|
701
|
+
* client.overrideFeatureFlags(['flag-a', 'flag-b'])
|
|
702
|
+
*
|
|
703
|
+
* // Set specific flag values/variants
|
|
704
|
+
* client.overrideFeatureFlags({ 'my-flag': 'variant-a', 'other-flag': true })
|
|
705
|
+
*
|
|
706
|
+
* // Set both flags and payloads
|
|
707
|
+
* client.overrideFeatureFlags({
|
|
708
|
+
* flags: { 'my-flag': 'variant-a' },
|
|
709
|
+
* payloads: { 'my-flag': { discount: 20 } }
|
|
710
|
+
* })
|
|
711
|
+
* ```
|
|
712
|
+
*
|
|
713
|
+
* {@label Feature flags}
|
|
714
|
+
*
|
|
715
|
+
* @param overrides - Flag overrides configuration
|
|
716
|
+
*/
|
|
717
|
+
overrideFeatureFlags(overrides: OverrideFeatureFlagsOptions): void;
|
|
718
|
+
/**
|
|
719
|
+
* Type guard to check if overrides is a FeatureFlagOverrideOptions object.
|
|
720
|
+
*
|
|
721
|
+
* This distinguishes between:
|
|
722
|
+
* - { flags: { 'flag-a': true } } -> FeatureFlagOverrideOptions (flags is an object/array/false)
|
|
723
|
+
* - { flags: true } -> Record<string, FeatureFlagValue> (a flag named "flags" with value true)
|
|
724
|
+
*/
|
|
725
|
+
private _isFeatureFlagOverrideOptions;
|
|
689
726
|
protected abstract initializeContext(): IPostHogContext | undefined;
|
|
690
727
|
/**
|
|
691
728
|
* Run a function with specific context that will be applied to all events captured within that context.
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,oBAAoB,EAEpB,mBAAmB,EACnB,oBAAoB,EACpB,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EAGtB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,YAAY,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,oBAAoB,EAEpB,mBAAmB,EACnB,oBAAoB,EACpB,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EAGtB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,YAAY,EAIZ,oBAAoB,EACpB,eAAe,EACf,QAAQ,EACR,2BAA2B,EAC3B,cAAc,EAEf,MAAM,SAAS,CAAA;AAChB,OAAO,EAAqB,gBAAgB,EAAuB,MAAM,eAAe,CAAA;AAMxF,OAAO,aAAa,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAkB,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAGtE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AASzF,8BAAsB,oBAAqB,SAAQ,oBAAqB,YAAW,QAAQ;IACzF,OAAO,CAAC,cAAc,CAA6B;IAEnD,OAAO,CAAC,kBAAkB,CAAC,CAAoB;IAC/C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;IACtC,OAAO,CAAC,YAAY,CAAQ;IAC5B,SAAgB,OAAO,EAAE,cAAc,CAAA;IACvC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,CAAA;IAG5C,OAAO,CAAC,cAAc,CAAC,CAAkC;IACzD,OAAO,CAAC,iBAAiB,CAAC,CAA0B;IAEpD,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB;IA8CxD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,GAAG,SAAS;IAIpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI;IAI5E;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI/E;;;;;;;;;;;;;OAaG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;;;;;;;;;;;;OAaG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;;;;;;;;;;OAaG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB;;;;;;;;;;;;;OAaG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,OAAO,GAAE,OAAc,GAAG,IAAI;IAKpC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAqBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,UAAe,EAAE,YAAY,EAAE,EAAE,eAAe,GAAG,IAAI;IAc9E;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,EAAE,UAAU,EAAE,UAAe,EAAE,YAAY,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IActG;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAIhF;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;;;;;;;;;;;;;;;;;OAkBG;IACH,sBAAsB,IAAI,OAAO;IAIjC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,2BAA2B,CAAC,SAAS,GAAE,MAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,cAAc,CAClB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;QAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GACA,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IA+HxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,qBAAqB,CACzB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,gBAAgB,EAC7B,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,4FAA4F;QAC5F,qBAAqB,CAAC,EAAE,OAAO,CAAA;QAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GACA,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAwEhC;;;;;;;;;;;;;;;;;OAiBG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IA0B5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,gBAAgB,CACpB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;QAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GACA,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQ/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,WAAW,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB,GACA,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,sBAAsB,CAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB,GACA,OAAO,CAAC,+BAA+B,CAAC;IAwE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,oBAAoB,GAAG,IAAI;IAIxG;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,oBAAoB,CAAC,SAAS,EAAE,2BAA2B,GAAG,IAAI;IAyClE;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAoCrC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,IAAI,eAAe,GAAG,SAAS;IAEnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,CAAC;IASpF;;;;;;;;;;;;;;;OAeG;IACH,UAAU,IAAI,WAAW,GAAG,SAAS;IAIrC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAM5C,2BAA2B;IAqCzC,OAAO,CAAC,0BAA0B;YA+BpB,uBAAuB;IAiErC,OAAO,CAAC,gCAAgC;IAqBxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAShH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,yBAAyB,CAC7B,KAAK,EAAE,OAAO,EACd,UAAU,CAAC,EAAE,MAAM,EACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC;IASH,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;QAC7D,UAAU,EAAE,MAAM,CAAA;QAClB,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,sBAAsB,CAAA;QAClC,OAAO,EAAE,qBAAqB,CAAA;KAC/B,CAAC;IAiHF,OAAO,CAAC,cAAc;CAuBvB"}
|
package/dist/client.js
CHANGED
|
@@ -175,6 +175,7 @@ class PostHogBackendClient extends core_namespaceObject.PostHogCoreStateless {
|
|
|
175
175
|
});
|
|
176
176
|
}
|
|
177
177
|
async getFeatureFlag(key, distinctId, options) {
|
|
178
|
+
if (void 0 !== this._flagOverrides && key in this._flagOverrides) return this._flagOverrides[key];
|
|
178
179
|
const { groups, disableGeoip } = options || {};
|
|
179
180
|
let { onlyEvaluateLocally, sendFeatureFlagEvents, personProperties, groupProperties } = options || {};
|
|
180
181
|
const adjustedProperties = this.addLocalPersonAndGroupProperties(distinctId, groups, personProperties, groupProperties);
|
|
@@ -235,6 +236,7 @@ class PostHogBackendClient extends core_namespaceObject.PostHogCoreStateless {
|
|
|
235
236
|
return response;
|
|
236
237
|
}
|
|
237
238
|
async getFeatureFlagPayload(key, distinctId, matchValue, options) {
|
|
239
|
+
if (void 0 !== this._payloadOverrides && key in this._payloadOverrides) return this._payloadOverrides[key];
|
|
238
240
|
const { groups, disableGeoip } = options || {};
|
|
239
241
|
let { onlyEvaluateLocally, personProperties, groupProperties } = options || {};
|
|
240
242
|
const adjustedProperties = this.addLocalPersonAndGroupProperties(distinctId, groups, personProperties, groupProperties);
|
|
@@ -307,6 +309,14 @@ class PostHogBackendClient extends core_namespaceObject.PostHogCoreStateless {
|
|
|
307
309
|
...remoteEvaluationResult.payloads || {}
|
|
308
310
|
};
|
|
309
311
|
}
|
|
312
|
+
if (void 0 !== this._flagOverrides) featureFlags = {
|
|
313
|
+
...featureFlags,
|
|
314
|
+
...this._flagOverrides
|
|
315
|
+
};
|
|
316
|
+
if (void 0 !== this._payloadOverrides) featureFlagPayloads = {
|
|
317
|
+
...featureFlagPayloads,
|
|
318
|
+
...this._payloadOverrides
|
|
319
|
+
};
|
|
310
320
|
return {
|
|
311
321
|
featureFlags,
|
|
312
322
|
featureFlagPayloads
|
|
@@ -320,6 +330,53 @@ class PostHogBackendClient extends core_namespaceObject.PostHogCoreStateless {
|
|
|
320
330
|
async reloadFeatureFlags() {
|
|
321
331
|
await this.featureFlagsPoller?.loadFeatureFlags(true);
|
|
322
332
|
}
|
|
333
|
+
overrideFeatureFlags(overrides) {
|
|
334
|
+
const flagArrayToRecord = (flags)=>Object.fromEntries(flags.map((f)=>[
|
|
335
|
+
f,
|
|
336
|
+
true
|
|
337
|
+
]));
|
|
338
|
+
if (false === overrides) {
|
|
339
|
+
this._flagOverrides = void 0;
|
|
340
|
+
this._payloadOverrides = void 0;
|
|
341
|
+
return;
|
|
342
|
+
}
|
|
343
|
+
if (Array.isArray(overrides)) {
|
|
344
|
+
this._flagOverrides = flagArrayToRecord(overrides);
|
|
345
|
+
return;
|
|
346
|
+
}
|
|
347
|
+
if (this._isFeatureFlagOverrideOptions(overrides)) {
|
|
348
|
+
if ('flags' in overrides) {
|
|
349
|
+
if (false === overrides.flags) this._flagOverrides = void 0;
|
|
350
|
+
else if (Array.isArray(overrides.flags)) this._flagOverrides = flagArrayToRecord(overrides.flags);
|
|
351
|
+
else if (void 0 !== overrides.flags) this._flagOverrides = {
|
|
352
|
+
...overrides.flags
|
|
353
|
+
};
|
|
354
|
+
}
|
|
355
|
+
if ('payloads' in overrides) {
|
|
356
|
+
if (false === overrides.payloads) this._payloadOverrides = void 0;
|
|
357
|
+
else if (void 0 !== overrides.payloads) this._payloadOverrides = {
|
|
358
|
+
...overrides.payloads
|
|
359
|
+
};
|
|
360
|
+
}
|
|
361
|
+
return;
|
|
362
|
+
}
|
|
363
|
+
this._flagOverrides = {
|
|
364
|
+
...overrides
|
|
365
|
+
};
|
|
366
|
+
}
|
|
367
|
+
_isFeatureFlagOverrideOptions(overrides) {
|
|
368
|
+
if ('object' != typeof overrides || null === overrides || Array.isArray(overrides)) return false;
|
|
369
|
+
const obj = overrides;
|
|
370
|
+
if ('flags' in obj) {
|
|
371
|
+
const flagsValue = obj['flags'];
|
|
372
|
+
if (false === flagsValue || Array.isArray(flagsValue) || 'object' == typeof flagsValue && null !== flagsValue) return true;
|
|
373
|
+
}
|
|
374
|
+
if ('payloads' in obj) {
|
|
375
|
+
const payloadsValue = obj['payloads'];
|
|
376
|
+
if (false === payloadsValue || 'object' == typeof payloadsValue && null !== payloadsValue) return true;
|
|
377
|
+
}
|
|
378
|
+
return false;
|
|
379
|
+
}
|
|
323
380
|
withContext(data, fn, options) {
|
|
324
381
|
if (!this.context) return fn();
|
|
325
382
|
return this.context.run(data, fn, options);
|
package/dist/client.mjs
CHANGED
|
@@ -137,6 +137,7 @@ class PostHogBackendClient extends PostHogCoreStateless {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
async getFeatureFlag(key, distinctId, options) {
|
|
140
|
+
if (void 0 !== this._flagOverrides && key in this._flagOverrides) return this._flagOverrides[key];
|
|
140
141
|
const { groups, disableGeoip } = options || {};
|
|
141
142
|
let { onlyEvaluateLocally, sendFeatureFlagEvents, personProperties, groupProperties } = options || {};
|
|
142
143
|
const adjustedProperties = this.addLocalPersonAndGroupProperties(distinctId, groups, personProperties, groupProperties);
|
|
@@ -197,6 +198,7 @@ class PostHogBackendClient extends PostHogCoreStateless {
|
|
|
197
198
|
return response;
|
|
198
199
|
}
|
|
199
200
|
async getFeatureFlagPayload(key, distinctId, matchValue, options) {
|
|
201
|
+
if (void 0 !== this._payloadOverrides && key in this._payloadOverrides) return this._payloadOverrides[key];
|
|
200
202
|
const { groups, disableGeoip } = options || {};
|
|
201
203
|
let { onlyEvaluateLocally, personProperties, groupProperties } = options || {};
|
|
202
204
|
const adjustedProperties = this.addLocalPersonAndGroupProperties(distinctId, groups, personProperties, groupProperties);
|
|
@@ -269,6 +271,14 @@ class PostHogBackendClient extends PostHogCoreStateless {
|
|
|
269
271
|
...remoteEvaluationResult.payloads || {}
|
|
270
272
|
};
|
|
271
273
|
}
|
|
274
|
+
if (void 0 !== this._flagOverrides) featureFlags = {
|
|
275
|
+
...featureFlags,
|
|
276
|
+
...this._flagOverrides
|
|
277
|
+
};
|
|
278
|
+
if (void 0 !== this._payloadOverrides) featureFlagPayloads = {
|
|
279
|
+
...featureFlagPayloads,
|
|
280
|
+
...this._payloadOverrides
|
|
281
|
+
};
|
|
272
282
|
return {
|
|
273
283
|
featureFlags,
|
|
274
284
|
featureFlagPayloads
|
|
@@ -282,6 +292,53 @@ class PostHogBackendClient extends PostHogCoreStateless {
|
|
|
282
292
|
async reloadFeatureFlags() {
|
|
283
293
|
await this.featureFlagsPoller?.loadFeatureFlags(true);
|
|
284
294
|
}
|
|
295
|
+
overrideFeatureFlags(overrides) {
|
|
296
|
+
const flagArrayToRecord = (flags)=>Object.fromEntries(flags.map((f)=>[
|
|
297
|
+
f,
|
|
298
|
+
true
|
|
299
|
+
]));
|
|
300
|
+
if (false === overrides) {
|
|
301
|
+
this._flagOverrides = void 0;
|
|
302
|
+
this._payloadOverrides = void 0;
|
|
303
|
+
return;
|
|
304
|
+
}
|
|
305
|
+
if (Array.isArray(overrides)) {
|
|
306
|
+
this._flagOverrides = flagArrayToRecord(overrides);
|
|
307
|
+
return;
|
|
308
|
+
}
|
|
309
|
+
if (this._isFeatureFlagOverrideOptions(overrides)) {
|
|
310
|
+
if ('flags' in overrides) {
|
|
311
|
+
if (false === overrides.flags) this._flagOverrides = void 0;
|
|
312
|
+
else if (Array.isArray(overrides.flags)) this._flagOverrides = flagArrayToRecord(overrides.flags);
|
|
313
|
+
else if (void 0 !== overrides.flags) this._flagOverrides = {
|
|
314
|
+
...overrides.flags
|
|
315
|
+
};
|
|
316
|
+
}
|
|
317
|
+
if ('payloads' in overrides) {
|
|
318
|
+
if (false === overrides.payloads) this._payloadOverrides = void 0;
|
|
319
|
+
else if (void 0 !== overrides.payloads) this._payloadOverrides = {
|
|
320
|
+
...overrides.payloads
|
|
321
|
+
};
|
|
322
|
+
}
|
|
323
|
+
return;
|
|
324
|
+
}
|
|
325
|
+
this._flagOverrides = {
|
|
326
|
+
...overrides
|
|
327
|
+
};
|
|
328
|
+
}
|
|
329
|
+
_isFeatureFlagOverrideOptions(overrides) {
|
|
330
|
+
if ('object' != typeof overrides || null === overrides || Array.isArray(overrides)) return false;
|
|
331
|
+
const obj = overrides;
|
|
332
|
+
if ('flags' in obj) {
|
|
333
|
+
const flagsValue = obj['flags'];
|
|
334
|
+
if (false === flagsValue || Array.isArray(flagsValue) || 'object' == typeof flagsValue && null !== flagsValue) return true;
|
|
335
|
+
}
|
|
336
|
+
if ('payloads' in obj) {
|
|
337
|
+
const payloadsValue = obj['payloads'];
|
|
338
|
+
if (false === payloadsValue || 'object' == typeof payloadsValue && null !== payloadsValue) return true;
|
|
339
|
+
}
|
|
340
|
+
return false;
|
|
341
|
+
}
|
|
285
342
|
withContext(data, fn, options) {
|
|
286
343
|
if (!this.context) return fn();
|
|
287
344
|
return this.context.run(data, fn, options);
|
|
@@ -48,6 +48,7 @@ declare class FeatureFlagsPoller {
|
|
|
48
48
|
private cacheProvider?;
|
|
49
49
|
private loadingPromise?;
|
|
50
50
|
private flagsEtag?;
|
|
51
|
+
private nextFetchAllowedAt?;
|
|
51
52
|
constructor({ pollingInterval, personalApiKey, projectApiKey, timeout, host, customHeaders, ...options }: FeatureFlagsPollerOptions);
|
|
52
53
|
debug(enabled?: boolean): void;
|
|
53
54
|
private logMsgIfDebug;
|
|
@@ -95,6 +96,16 @@ declare class FeatureFlagsPoller {
|
|
|
95
96
|
* @returns The polling interval to use for the next request.
|
|
96
97
|
*/
|
|
97
98
|
private getPollingInterval;
|
|
99
|
+
/**
|
|
100
|
+
* Enter backoff state after receiving an error response (401, 403, 429).
|
|
101
|
+
* This enables exponential backoff for the poller and blocks on-demand fetches.
|
|
102
|
+
*/
|
|
103
|
+
private beginBackoff;
|
|
104
|
+
/**
|
|
105
|
+
* Clear backoff state after a successful response (200, 304).
|
|
106
|
+
* This resets the polling interval and allows on-demand fetches immediately.
|
|
107
|
+
*/
|
|
108
|
+
private clearBackoff;
|
|
98
109
|
_loadFeatureFlags(): Promise<void>;
|
|
99
110
|
private getPersonalApiKeyRequestOptions;
|
|
100
111
|
_requestFeatureFlagDefinitions(): Promise<PostHogFetchResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../../../src/extensions/feature-flags/feature-flags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAmC,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AACtH,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAG1G,OAAO,EAAE,2BAA2B,EAA2B,MAAM,SAAS,CAAA;AAQ9E,cAAM,WAAY,SAAQ,KAAK;gBACjB,OAAO,EAAE,MAAM;CAO5B;AAED,cAAM,sBAAuB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAS5B;AAED,cAAM,wBAAyB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAS5B;AAED,KAAK,yBAAyB,GAAG;IAC/B,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACpF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACzC,aAAa,CAAC,EAAE,2BAA2B,CAAA;CAC5C,CAAA;AAED,cAAM,kBAAkB;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAA;IACvC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IACrD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACtC,sBAAsB,EAAE,OAAO,CAAA;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;IACvB,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACnF,SAAS,EAAE,OAAO,CAAQ;IAC1B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACzC,6BAA6B,EAAE,OAAO,CAAQ;IAC9C,YAAY,EAAE,MAAM,CAAI;IACxB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,OAAO,CAAC,aAAa,CAAC,CAA6B;IACnD,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,SAAS,CAAC,CAAQ;
|
|
1
|
+
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../../../src/extensions/feature-flags/feature-flags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAmC,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AACtH,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAG1G,OAAO,EAAE,2BAA2B,EAA2B,MAAM,SAAS,CAAA;AAQ9E,cAAM,WAAY,SAAQ,KAAK;gBACjB,OAAO,EAAE,MAAM;CAO5B;AAED,cAAM,sBAAuB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAS5B;AAED,cAAM,wBAAyB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAS5B;AAED,KAAK,yBAAyB,GAAG;IAC/B,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACpF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACzC,aAAa,CAAC,EAAE,2BAA2B,CAAA;CAC5C,CAAA;AAED,cAAM,kBAAkB;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAA;IACvC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IACrD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACtC,sBAAsB,EAAE,OAAO,CAAA;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;IACvB,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACnF,SAAS,EAAE,OAAO,CAAQ;IAC1B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACzC,6BAA6B,EAAE,OAAO,CAAQ;IAC9C,YAAY,EAAE,MAAM,CAAI;IACxB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,OAAO,CAAC,aAAa,CAAC,CAA6B;IACnD,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,kBAAkB,CAAC,CAAQ;gBAEvB,EACV,eAAe,EACf,cAAc,EACd,aAAa,EACb,OAAO,EACP,IAAI,EACJ,aAAa,EACb,GAAG,OAAO,EACX,EAAE,yBAAyB;IAoB5B,KAAK,CAAC,OAAO,GAAE,OAAc,GAAG,IAAI;IAIpC,OAAO,CAAC,aAAa;IAMf,cAAc,CAClB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACnC,gBAAgB,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAC7C,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM,GAC3D,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAmClC,sBAAsB,CAC1B,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACnC,gBAAgB,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAC7C,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM,EAC5D,4BAA4B,CAAC,EAAE,MAAM,EAAE,GACtC,OAAO,CAAC;QACT,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QAC1C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAClC,eAAe,EAAE,OAAO,CAAA;KACzB,CAAC;IA4CI,4BAA4B,CAChC,IAAI,EAAE,kBAAkB,EACxB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACnC,gBAAgB,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAC7C,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM,EAC5D,UAAU,CAAC,EAAE,gBAAgB,EAC7B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAClD,aAAa,GAAE,OAAe,GAC7B,OAAO,CAAC;QACT,KAAK,EAAE,gBAAgB,CAAA;QACvB,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAA;KACzB,CAAC;YAgCY,uBAAuB;IA6CrC,OAAO,CAAC,qBAAqB;YA+Bf,sBAAsB;IAyEpC,OAAO,CAAC,4BAA4B;IAkB9B,0BAA0B,CAC9B,IAAI,EAAE,kBAAkB,EACxB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAM,GACrD,OAAO,CAAC,gBAAgB,CAAC;IA2CtB,gBAAgB,CACpB,IAAI,EAAE,kBAAkB,EACxB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,oBAAoB,EAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAM,GACrD,OAAO,CAAC,OAAO,CAAC;IAmCb,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAY7G,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE;IAkBnG;;OAEG;IACH,OAAO,CAAC,eAAe;IAWvB;;;OAGG;YACW,aAAa;IAoBrB,gBAAgB,CAAC,WAAW,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB1D;;;OAGG;IACH,sBAAsB,IAAI,OAAO;IAIjC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAQ1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAQpB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAMd,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2JxC,OAAO,CAAC,+BAA+B;IAoBvC,8BAA8B,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAyBzD,UAAU,CAAC,SAAS,GAAE,MAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAuB3D;AAWD,iBAAS,aAAa,CACpB,QAAQ,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EACpD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnC,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GACnC,OAAO,CA6GT;AAkKD,iBAAS,uCAAuC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAmC3E;AAED,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,uCAAuC,EACvC,sBAAsB,EACtB,wBAAwB,EACxB,WAAW,GACZ,CAAA"}
|
|
@@ -296,6 +296,7 @@ class FeatureFlagsPoller {
|
|
|
296
296
|
}
|
|
297
297
|
async loadFeatureFlags(forceReload = false) {
|
|
298
298
|
if (this.loadedSuccessfullyOnce && !forceReload) return;
|
|
299
|
+
if (!forceReload && this.nextFetchAllowedAt && Date.now() < this.nextFetchAllowedAt) return void this.logMsgIfDebug(()=>console.debug('[FEATURE FLAGS] Skipping fetch, in backoff period'));
|
|
299
300
|
if (!this.loadingPromise) this.loadingPromise = this._loadFeatureFlags().catch((err)=>this.logMsgIfDebug(()=>console.debug(`[FEATURE FLAGS] Failed to load feature flags: ${err}`))).finally(()=>{
|
|
300
301
|
this.loadingPromise = void 0;
|
|
301
302
|
});
|
|
@@ -308,6 +309,16 @@ class FeatureFlagsPoller {
|
|
|
308
309
|
if (!this.shouldBeginExponentialBackoff) return this.pollingInterval;
|
|
309
310
|
return Math.min(SIXTY_SECONDS, this.pollingInterval * 2 ** this.backOffCount);
|
|
310
311
|
}
|
|
312
|
+
beginBackoff() {
|
|
313
|
+
this.shouldBeginExponentialBackoff = true;
|
|
314
|
+
this.backOffCount += 1;
|
|
315
|
+
this.nextFetchAllowedAt = Date.now() + this.getPollingInterval();
|
|
316
|
+
}
|
|
317
|
+
clearBackoff() {
|
|
318
|
+
this.shouldBeginExponentialBackoff = false;
|
|
319
|
+
this.backOffCount = 0;
|
|
320
|
+
this.nextFetchAllowedAt = void 0;
|
|
321
|
+
}
|
|
311
322
|
async _loadFeatureFlags() {
|
|
312
323
|
if (this.poller) {
|
|
313
324
|
clearTimeout(this.poller);
|
|
@@ -333,12 +344,10 @@ class FeatureFlagsPoller {
|
|
|
333
344
|
this.logMsgIfDebug(()=>console.debug('[FEATURE FLAGS] Flags not modified (304), using cached data'));
|
|
334
345
|
this.flagsEtag = res.headers?.get('ETag') ?? this.flagsEtag;
|
|
335
346
|
this.loadedSuccessfullyOnce = true;
|
|
336
|
-
this.
|
|
337
|
-
this.backOffCount = 0;
|
|
347
|
+
this.clearBackoff();
|
|
338
348
|
return;
|
|
339
349
|
case 401:
|
|
340
|
-
this.
|
|
341
|
-
this.backOffCount += 1;
|
|
350
|
+
this.beginBackoff();
|
|
342
351
|
throw new ClientError(`Your project key or personal API key is invalid. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`);
|
|
343
352
|
case 402:
|
|
344
353
|
console.warn('[FEATURE FLAGS] Feature flags quota limit exceeded - unsetting all local flags. Learn more about billing limits at https://posthog.com/docs/billing/limits-alerts');
|
|
@@ -348,12 +357,10 @@ class FeatureFlagsPoller {
|
|
|
348
357
|
this.cohorts = {};
|
|
349
358
|
return;
|
|
350
359
|
case 403:
|
|
351
|
-
this.
|
|
352
|
-
this.backOffCount += 1;
|
|
360
|
+
this.beginBackoff();
|
|
353
361
|
throw new ClientError(`Your personal API key does not have permission to fetch feature flag definitions for local evaluation. Setting next polling interval to ${this.getPollingInterval()}ms. Are you sure you're using the correct personal and Project API key pair? More information: https://posthog.com/docs/api/overview`);
|
|
354
362
|
case 429:
|
|
355
|
-
this.
|
|
356
|
-
this.backOffCount += 1;
|
|
363
|
+
this.beginBackoff();
|
|
357
364
|
throw new ClientError(`You are being rate limited. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`);
|
|
358
365
|
case 200:
|
|
359
366
|
{
|
|
@@ -366,8 +373,7 @@ class FeatureFlagsPoller {
|
|
|
366
373
|
cohorts: responseJson.cohorts || {}
|
|
367
374
|
};
|
|
368
375
|
this.updateFlagState(flagData);
|
|
369
|
-
this.
|
|
370
|
-
this.backOffCount = 0;
|
|
376
|
+
this.clearBackoff();
|
|
371
377
|
if (this.cacheProvider && shouldFetch) try {
|
|
372
378
|
await this.cacheProvider.onFlagDefinitionsReceived(flagData);
|
|
373
379
|
} catch (err) {
|
|
@@ -263,6 +263,7 @@ class FeatureFlagsPoller {
|
|
|
263
263
|
}
|
|
264
264
|
async loadFeatureFlags(forceReload = false) {
|
|
265
265
|
if (this.loadedSuccessfullyOnce && !forceReload) return;
|
|
266
|
+
if (!forceReload && this.nextFetchAllowedAt && Date.now() < this.nextFetchAllowedAt) return void this.logMsgIfDebug(()=>console.debug('[FEATURE FLAGS] Skipping fetch, in backoff period'));
|
|
266
267
|
if (!this.loadingPromise) this.loadingPromise = this._loadFeatureFlags().catch((err)=>this.logMsgIfDebug(()=>console.debug(`[FEATURE FLAGS] Failed to load feature flags: ${err}`))).finally(()=>{
|
|
267
268
|
this.loadingPromise = void 0;
|
|
268
269
|
});
|
|
@@ -275,6 +276,16 @@ class FeatureFlagsPoller {
|
|
|
275
276
|
if (!this.shouldBeginExponentialBackoff) return this.pollingInterval;
|
|
276
277
|
return Math.min(SIXTY_SECONDS, this.pollingInterval * 2 ** this.backOffCount);
|
|
277
278
|
}
|
|
279
|
+
beginBackoff() {
|
|
280
|
+
this.shouldBeginExponentialBackoff = true;
|
|
281
|
+
this.backOffCount += 1;
|
|
282
|
+
this.nextFetchAllowedAt = Date.now() + this.getPollingInterval();
|
|
283
|
+
}
|
|
284
|
+
clearBackoff() {
|
|
285
|
+
this.shouldBeginExponentialBackoff = false;
|
|
286
|
+
this.backOffCount = 0;
|
|
287
|
+
this.nextFetchAllowedAt = void 0;
|
|
288
|
+
}
|
|
278
289
|
async _loadFeatureFlags() {
|
|
279
290
|
if (this.poller) {
|
|
280
291
|
clearTimeout(this.poller);
|
|
@@ -300,12 +311,10 @@ class FeatureFlagsPoller {
|
|
|
300
311
|
this.logMsgIfDebug(()=>console.debug('[FEATURE FLAGS] Flags not modified (304), using cached data'));
|
|
301
312
|
this.flagsEtag = res.headers?.get('ETag') ?? this.flagsEtag;
|
|
302
313
|
this.loadedSuccessfullyOnce = true;
|
|
303
|
-
this.
|
|
304
|
-
this.backOffCount = 0;
|
|
314
|
+
this.clearBackoff();
|
|
305
315
|
return;
|
|
306
316
|
case 401:
|
|
307
|
-
this.
|
|
308
|
-
this.backOffCount += 1;
|
|
317
|
+
this.beginBackoff();
|
|
309
318
|
throw new ClientError(`Your project key or personal API key is invalid. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`);
|
|
310
319
|
case 402:
|
|
311
320
|
console.warn('[FEATURE FLAGS] Feature flags quota limit exceeded - unsetting all local flags. Learn more about billing limits at https://posthog.com/docs/billing/limits-alerts');
|
|
@@ -315,12 +324,10 @@ class FeatureFlagsPoller {
|
|
|
315
324
|
this.cohorts = {};
|
|
316
325
|
return;
|
|
317
326
|
case 403:
|
|
318
|
-
this.
|
|
319
|
-
this.backOffCount += 1;
|
|
327
|
+
this.beginBackoff();
|
|
320
328
|
throw new ClientError(`Your personal API key does not have permission to fetch feature flag definitions for local evaluation. Setting next polling interval to ${this.getPollingInterval()}ms. Are you sure you're using the correct personal and Project API key pair? More information: https://posthog.com/docs/api/overview`);
|
|
321
329
|
case 429:
|
|
322
|
-
this.
|
|
323
|
-
this.backOffCount += 1;
|
|
330
|
+
this.beginBackoff();
|
|
324
331
|
throw new ClientError(`You are being rate limited. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`);
|
|
325
332
|
case 200:
|
|
326
333
|
{
|
|
@@ -333,8 +340,7 @@ class FeatureFlagsPoller {
|
|
|
333
340
|
cohorts: responseJson.cohorts || {}
|
|
334
341
|
};
|
|
335
342
|
this.updateFlagState(flagData);
|
|
336
|
-
this.
|
|
337
|
-
this.backOffCount = 0;
|
|
343
|
+
this.clearBackoff();
|
|
338
344
|
if (this.cacheProvider && shouldFetch) try {
|
|
339
345
|
await this.cacheProvider.onFlagDefinitionsReceived(flagData);
|
|
340
346
|
} catch (err) {
|
package/dist/types.d.ts
CHANGED
|
@@ -40,6 +40,31 @@ export type FlagProperty = {
|
|
|
40
40
|
dependency_chain?: string[];
|
|
41
41
|
};
|
|
42
42
|
export type FlagPropertyValue = string | number | (string | number)[] | boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Options for overriding feature flags.
|
|
45
|
+
*
|
|
46
|
+
* Supports multiple formats:
|
|
47
|
+
* - `false` - Clear all overrides
|
|
48
|
+
* - `string[]` - Enable a list of flags (sets them to `true`)
|
|
49
|
+
* - `Record<string, FeatureFlagValue>` - Set specific flag values/variants
|
|
50
|
+
* - `FeatureFlagOverrideOptions` - Set both flag values and payloads
|
|
51
|
+
*/
|
|
52
|
+
export type OverrideFeatureFlagsOptions = false | string[] | Record<string, FeatureFlagValue> | FeatureFlagOverrideOptions;
|
|
53
|
+
export type FeatureFlagOverrideOptions = {
|
|
54
|
+
/**
|
|
55
|
+
* Flag overrides. Can be:
|
|
56
|
+
* - `false` to clear flag overrides
|
|
57
|
+
* - `string[]` to enable a list of flags
|
|
58
|
+
* - `Record<string, FeatureFlagValue>` to set specific values/variants
|
|
59
|
+
*/
|
|
60
|
+
flags?: false | string[] | Record<string, FeatureFlagValue>;
|
|
61
|
+
/**
|
|
62
|
+
* Payload overrides for flags.
|
|
63
|
+
* - `false` to clear payload overrides
|
|
64
|
+
* - `Record<string, JsonType>` to set specific payloads
|
|
65
|
+
*/
|
|
66
|
+
payloads?: false | Record<string, JsonType>;
|
|
67
|
+
};
|
|
43
68
|
export type FeatureFlagCondition = {
|
|
44
69
|
properties: FlagProperty[];
|
|
45
70
|
rollout_percentage?: number;
|
|
@@ -316,6 +341,31 @@ export interface IPostHog {
|
|
|
316
341
|
* already polled automatically at a regular interval.
|
|
317
342
|
*/
|
|
318
343
|
reloadFeatureFlags(): Promise<void>;
|
|
344
|
+
/**
|
|
345
|
+
* @description Override feature flags locally. Useful for testing and local development.
|
|
346
|
+
* Overridden flags take precedence over both local evaluation and remote evaluation.
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* ```ts
|
|
350
|
+
* // Clear all overrides
|
|
351
|
+
* posthog.overrideFeatureFlags(false)
|
|
352
|
+
*
|
|
353
|
+
* // Enable a list of flags (sets them to true)
|
|
354
|
+
* posthog.overrideFeatureFlags(['flag-a', 'flag-b'])
|
|
355
|
+
*
|
|
356
|
+
* // Set specific flag values/variants
|
|
357
|
+
* posthog.overrideFeatureFlags({ 'my-flag': 'variant-a', 'other-flag': true })
|
|
358
|
+
*
|
|
359
|
+
* // Set both flags and payloads
|
|
360
|
+
* posthog.overrideFeatureFlags({
|
|
361
|
+
* flags: { 'my-flag': 'variant-a' },
|
|
362
|
+
* payloads: { 'my-flag': { discount: 20 } }
|
|
363
|
+
* })
|
|
364
|
+
* ```
|
|
365
|
+
*
|
|
366
|
+
* @param overrides - Flag overrides configuration
|
|
367
|
+
*/
|
|
368
|
+
overrideFeatureFlags(overrides: OverrideFeatureFlagsOptions): void;
|
|
319
369
|
/**
|
|
320
370
|
* @description Run a function with specific context that will be applied to all events captured within that context.
|
|
321
371
|
* @param data Context data to apply (sessionId, distinctId, properties, enableExceptionAutocapture)
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAExE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAEnF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;IACzC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACrD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,GAAG;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA;IACxC,gBAAgB,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAA;IACpD,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,KAAK,GAAG,IAAI,CAAA;IAClB,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,iBAAiB,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAA;AAE/E,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,YAAY,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,KAAK,YAAY,GAAG,IAAI,CAAA;AAE9E,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG;IAChD,WAAW,CAAC,EAAE,QAAQ,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC,2BAA2B,CAAC,EAAE,MAAM,CAAA;IAEpC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAGpF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,2BAA2B,CAAC,EAAE,2BAA2B,CAAA;IACzD;;;;OAIG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,YAAY,EAAE,CAAA;IAC3C;;;;;;;;;OASG;IACH,sBAAsB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAA;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE;QACR,4BAA4B,CAAC,EAAE,MAAM,CAAA;QACrC,MAAM,CAAC,EAAE,oBAAoB,EAAE,CAAA;QAC/B,YAAY,CAAC,EAAE;YACb,QAAQ,EAAE;gBACR,GAAG,EAAE,MAAM,CAAA;gBACX,kBAAkB,EAAE,MAAM,CAAA;aAC3B,EAAE,CAAA;SACJ,CAAA;QACD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAClC,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,kBAAkB,EAAE,IAAI,GAAG,MAAM,CAAA;IACjC,4BAA4B,EAAE,OAAO,CAAA;IACrC,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB;;;;;CAKnB,CAAA;AAEV,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,GAAG,MAAM,CAAA;AAEpG,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,YAAY,GAAG,IAAI,CAAA;IAExF;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1G;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,IAAI,CAAA;IAE3D;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAExD;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1E;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAChC,GACA,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAChC,GACA,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,qBAAqB,CACnB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,gBAAgB,EAC7B,OAAO,CAAC,EAAE;QACR,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAC9B,GACA,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IAEhC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAE9E;;;OAGG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,CAAC,CAAA;IAEpF;;;OAGG;IACH,UAAU,IAAI,WAAW,GAAG,SAAS,CAAA;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1C;;;;OAIG;IACH,2BAA2B,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjE;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAA;CAClC"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAExE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAEnF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;IACzC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACrD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,GAAG;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA;IACxC,gBAAgB,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAA;IACpD,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,KAAK,GAAG,IAAI,CAAA;IAClB,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,iBAAiB,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAA;AAE/E;;;;;;;;GAQG;AACH,MAAM,MAAM,2BAA2B,GACnC,KAAK,GACL,MAAM,EAAE,GACR,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAChC,0BAA0B,CAAA;AAE9B,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,YAAY,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,KAAK,YAAY,GAAG,IAAI,CAAA;AAE9E,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG;IAChD,WAAW,CAAC,EAAE,QAAQ,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC,2BAA2B,CAAC,EAAE,MAAM,CAAA;IAEpC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAGpF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,2BAA2B,CAAC,EAAE,2BAA2B,CAAA;IACzD;;;;OAIG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,YAAY,EAAE,CAAA;IAC3C;;;;;;;;;OASG;IACH,sBAAsB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAA;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE;QACR,4BAA4B,CAAC,EAAE,MAAM,CAAA;QACrC,MAAM,CAAC,EAAE,oBAAoB,EAAE,CAAA;QAC/B,YAAY,CAAC,EAAE;YACb,QAAQ,EAAE;gBACR,GAAG,EAAE,MAAM,CAAA;gBACX,kBAAkB,EAAE,MAAM,CAAA;aAC3B,EAAE,CAAA;SACJ,CAAA;QACD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAClC,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,kBAAkB,EAAE,IAAI,GAAG,MAAM,CAAA;IACjC,4BAA4B,EAAE,OAAO,CAAA;IACrC,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB;;;;;CAKnB,CAAA;AAEV,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,GAAG,MAAM,CAAA;AAEpG,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,YAAY,GAAG,IAAI,CAAA;IAExF;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1G;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,IAAI,CAAA;IAE3D;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAExD;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1E;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAChC,GACA,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,mBAAmB,CAAC,EAAE,OAAO,CAAA;QAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAChC,GACA,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,qBAAqB,CACnB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,gBAAgB,EAC7B,OAAO,CAAC,EAAE;QACR,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAC9B,GACA,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IAEhC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAE9E;;;OAGG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,oBAAoB,CAAC,SAAS,EAAE,2BAA2B,GAAG,IAAI,CAAA;IAElE;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,CAAC,CAAA;IAEpF;;;OAGG;IACH,UAAU,IAAI,WAAW,GAAG,SAAS,CAAA;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1C;;;;OAIG;IACH,2BAA2B,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjE;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAA;CAClC"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "5.
|
|
1
|
+
export declare const version = "5.19.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -26,7 +26,7 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
26
26
|
__webpack_require__.d(__webpack_exports__, {
|
|
27
27
|
version: ()=>version
|
|
28
28
|
});
|
|
29
|
-
const version = '5.
|
|
29
|
+
const version = '5.19.0';
|
|
30
30
|
exports.version = __webpack_exports__.version;
|
|
31
31
|
for(var __webpack_i__ in __webpack_exports__)if (-1 === [
|
|
32
32
|
"version"
|
package/dist/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
const version = '5.
|
|
1
|
+
const version = '5.19.0';
|
|
2
2
|
export { version };
|
package/package.json
CHANGED
package/src/client.ts
CHANGED
|
@@ -16,9 +16,11 @@ import {
|
|
|
16
16
|
EventMessage,
|
|
17
17
|
FeatureFlagError,
|
|
18
18
|
FeatureFlagErrorType,
|
|
19
|
+
FeatureFlagOverrideOptions,
|
|
19
20
|
GroupIdentifyMessage,
|
|
20
21
|
IdentifyMessage,
|
|
21
22
|
IPostHog,
|
|
23
|
+
OverrideFeatureFlagsOptions,
|
|
22
24
|
PostHogOptions,
|
|
23
25
|
SendFeatureFlagsOptions,
|
|
24
26
|
} from './types'
|
|
@@ -50,6 +52,10 @@ export abstract class PostHogBackendClient extends PostHogCoreStateless implemen
|
|
|
50
52
|
public readonly options: PostHogOptions
|
|
51
53
|
protected readonly context?: IPostHogContext
|
|
52
54
|
|
|
55
|
+
// Feature flag overrides for local testing/development
|
|
56
|
+
private _flagOverrides?: Record<string, FeatureFlagValue>
|
|
57
|
+
private _payloadOverrides?: Record<string, JsonType>
|
|
58
|
+
|
|
53
59
|
distinctIdHasSentFlagCalls: Record<string, string[]>
|
|
54
60
|
|
|
55
61
|
/**
|
|
@@ -645,6 +651,11 @@ export abstract class PostHogBackendClient extends PostHogCoreStateless implemen
|
|
|
645
651
|
disableGeoip?: boolean
|
|
646
652
|
}
|
|
647
653
|
): Promise<FeatureFlagValue | undefined> {
|
|
654
|
+
// Check for overrides first - they take precedence over all evaluation
|
|
655
|
+
if (this._flagOverrides !== undefined && key in this._flagOverrides) {
|
|
656
|
+
return this._flagOverrides[key]
|
|
657
|
+
}
|
|
658
|
+
|
|
648
659
|
const { groups, disableGeoip } = options || {}
|
|
649
660
|
let { onlyEvaluateLocally, sendFeatureFlagEvents, personProperties, groupProperties } = options || {}
|
|
650
661
|
|
|
@@ -815,6 +826,11 @@ export abstract class PostHogBackendClient extends PostHogCoreStateless implemen
|
|
|
815
826
|
disableGeoip?: boolean
|
|
816
827
|
}
|
|
817
828
|
): Promise<JsonType | undefined> {
|
|
829
|
+
// Check for payload overrides first - they take precedence over all evaluation
|
|
830
|
+
if (this._payloadOverrides !== undefined && key in this._payloadOverrides) {
|
|
831
|
+
return this._payloadOverrides[key]
|
|
832
|
+
}
|
|
833
|
+
|
|
818
834
|
const { groups, disableGeoip } = options || {}
|
|
819
835
|
let { onlyEvaluateLocally, personProperties, groupProperties } = options || {}
|
|
820
836
|
|
|
@@ -1123,6 +1139,20 @@ export abstract class PostHogBackendClient extends PostHogCoreStateless implemen
|
|
|
1123
1139
|
}
|
|
1124
1140
|
}
|
|
1125
1141
|
|
|
1142
|
+
// Apply overrides last - they take precedence over all evaluation
|
|
1143
|
+
if (this._flagOverrides !== undefined) {
|
|
1144
|
+
featureFlags = {
|
|
1145
|
+
...featureFlags,
|
|
1146
|
+
...this._flagOverrides,
|
|
1147
|
+
}
|
|
1148
|
+
}
|
|
1149
|
+
if (this._payloadOverrides !== undefined) {
|
|
1150
|
+
featureFlagPayloads = {
|
|
1151
|
+
...featureFlagPayloads,
|
|
1152
|
+
...this._payloadOverrides,
|
|
1153
|
+
}
|
|
1154
|
+
}
|
|
1155
|
+
|
|
1126
1156
|
return { featureFlags, featureFlagPayloads }
|
|
1127
1157
|
}
|
|
1128
1158
|
|
|
@@ -1190,6 +1220,116 @@ export abstract class PostHogBackendClient extends PostHogCoreStateless implemen
|
|
|
1190
1220
|
await this.featureFlagsPoller?.loadFeatureFlags(true)
|
|
1191
1221
|
}
|
|
1192
1222
|
|
|
1223
|
+
/**
|
|
1224
|
+
* Override feature flags locally. Useful for testing and local development.
|
|
1225
|
+
* Overridden flags take precedence over both local evaluation and remote evaluation.
|
|
1226
|
+
*
|
|
1227
|
+
* @example
|
|
1228
|
+
* ```ts
|
|
1229
|
+
* // Clear all overrides
|
|
1230
|
+
* client.overrideFeatureFlags(false)
|
|
1231
|
+
*
|
|
1232
|
+
* // Enable a list of flags (sets them to true)
|
|
1233
|
+
* client.overrideFeatureFlags(['flag-a', 'flag-b'])
|
|
1234
|
+
*
|
|
1235
|
+
* // Set specific flag values/variants
|
|
1236
|
+
* client.overrideFeatureFlags({ 'my-flag': 'variant-a', 'other-flag': true })
|
|
1237
|
+
*
|
|
1238
|
+
* // Set both flags and payloads
|
|
1239
|
+
* client.overrideFeatureFlags({
|
|
1240
|
+
* flags: { 'my-flag': 'variant-a' },
|
|
1241
|
+
* payloads: { 'my-flag': { discount: 20 } }
|
|
1242
|
+
* })
|
|
1243
|
+
* ```
|
|
1244
|
+
*
|
|
1245
|
+
* {@label Feature flags}
|
|
1246
|
+
*
|
|
1247
|
+
* @param overrides - Flag overrides configuration
|
|
1248
|
+
*/
|
|
1249
|
+
overrideFeatureFlags(overrides: OverrideFeatureFlagsOptions): void {
|
|
1250
|
+
const flagArrayToRecord = (flags: string[]) => Object.fromEntries(flags.map((f) => [f, true]))
|
|
1251
|
+
|
|
1252
|
+
if (overrides === false) {
|
|
1253
|
+
this._flagOverrides = undefined
|
|
1254
|
+
this._payloadOverrides = undefined
|
|
1255
|
+
return
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
// Array syntax: ['flag-a', 'flag-b'] -> { 'flag-a': true, 'flag-b': true }
|
|
1259
|
+
if (Array.isArray(overrides)) {
|
|
1260
|
+
this._flagOverrides = flagArrayToRecord(overrides)
|
|
1261
|
+
return
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
if (this._isFeatureFlagOverrideOptions(overrides)) {
|
|
1265
|
+
if ('flags' in overrides) {
|
|
1266
|
+
if (overrides.flags === false) {
|
|
1267
|
+
this._flagOverrides = undefined
|
|
1268
|
+
} else if (Array.isArray(overrides.flags)) {
|
|
1269
|
+
this._flagOverrides = flagArrayToRecord(overrides.flags)
|
|
1270
|
+
} else if (overrides.flags !== undefined) {
|
|
1271
|
+
this._flagOverrides = { ...overrides.flags }
|
|
1272
|
+
}
|
|
1273
|
+
}
|
|
1274
|
+
|
|
1275
|
+
if ('payloads' in overrides) {
|
|
1276
|
+
if (overrides.payloads === false) {
|
|
1277
|
+
this._payloadOverrides = undefined
|
|
1278
|
+
} else if (overrides.payloads !== undefined) {
|
|
1279
|
+
this._payloadOverrides = { ...overrides.payloads }
|
|
1280
|
+
}
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
return
|
|
1284
|
+
}
|
|
1285
|
+
|
|
1286
|
+
// Fallback: treat as Record<string, FeatureFlagValue>
|
|
1287
|
+
this._flagOverrides = { ...overrides }
|
|
1288
|
+
}
|
|
1289
|
+
|
|
1290
|
+
/**
|
|
1291
|
+
* Type guard to check if overrides is a FeatureFlagOverrideOptions object.
|
|
1292
|
+
*
|
|
1293
|
+
* This distinguishes between:
|
|
1294
|
+
* - { flags: { 'flag-a': true } } -> FeatureFlagOverrideOptions (flags is an object/array/false)
|
|
1295
|
+
* - { flags: true } -> Record<string, FeatureFlagValue> (a flag named "flags" with value true)
|
|
1296
|
+
*/
|
|
1297
|
+
private _isFeatureFlagOverrideOptions(overrides: unknown): overrides is FeatureFlagOverrideOptions {
|
|
1298
|
+
if (typeof overrides !== 'object' || overrides === null || Array.isArray(overrides)) {
|
|
1299
|
+
return false
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
const obj = overrides as Record<string, unknown>
|
|
1303
|
+
|
|
1304
|
+
// Check if 'flags' key exists and has a valid structure for FeatureFlagOverrideOptions
|
|
1305
|
+
// Valid values: false, string[], or Record<string, FeatureFlagValue> (an object)
|
|
1306
|
+
if ('flags' in obj) {
|
|
1307
|
+
const flagsValue = obj['flags']
|
|
1308
|
+
// If flags is false, an array, or a plain object - it's FeatureFlagOverrideOptions
|
|
1309
|
+
// If flags is a boolean true or a string - it's a flag named "flags" with that value
|
|
1310
|
+
if (
|
|
1311
|
+
flagsValue === false ||
|
|
1312
|
+
Array.isArray(flagsValue) ||
|
|
1313
|
+
(typeof flagsValue === 'object' && flagsValue !== null)
|
|
1314
|
+
) {
|
|
1315
|
+
return true
|
|
1316
|
+
}
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
// Check if 'payloads' key exists and has a valid structure for FeatureFlagOverrideOptions
|
|
1320
|
+
// Valid values: false or Record<string, JsonType> (an object)
|
|
1321
|
+
if ('payloads' in obj) {
|
|
1322
|
+
const payloadsValue = obj['payloads']
|
|
1323
|
+
// If payloads is false or a plain object - it's FeatureFlagOverrideOptions
|
|
1324
|
+
// If payloads is a string or boolean true - it's a flag named "payloads" with that value
|
|
1325
|
+
if (payloadsValue === false || (typeof payloadsValue === 'object' && payloadsValue !== null)) {
|
|
1326
|
+
return true
|
|
1327
|
+
}
|
|
1328
|
+
}
|
|
1329
|
+
|
|
1330
|
+
return false
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1193
1333
|
protected abstract initializeContext(): IPostHogContext | undefined
|
|
1194
1334
|
|
|
1195
1335
|
/**
|
|
@@ -79,6 +79,7 @@ class FeatureFlagsPoller {
|
|
|
79
79
|
private cacheProvider?: FlagDefinitionCacheProvider
|
|
80
80
|
private loadingPromise?: Promise<void>
|
|
81
81
|
private flagsEtag?: string
|
|
82
|
+
private nextFetchAllowedAt?: number
|
|
82
83
|
|
|
83
84
|
constructor({
|
|
84
85
|
pollingInterval,
|
|
@@ -586,6 +587,13 @@ class FeatureFlagsPoller {
|
|
|
586
587
|
return
|
|
587
588
|
}
|
|
588
589
|
|
|
590
|
+
// Respect backoff for on-demand fetches (e.g., from getFeatureFlag calls).
|
|
591
|
+
// The poller uses forceReload=true and has already waited the backoff period.
|
|
592
|
+
if (!forceReload && this.nextFetchAllowedAt && Date.now() < this.nextFetchAllowedAt) {
|
|
593
|
+
this.logMsgIfDebug(() => console.debug('[FEATURE FLAGS] Skipping fetch, in backoff period'))
|
|
594
|
+
return
|
|
595
|
+
}
|
|
596
|
+
|
|
589
597
|
if (!this.loadingPromise) {
|
|
590
598
|
this.loadingPromise = this._loadFeatureFlags()
|
|
591
599
|
.catch((err) => this.logMsgIfDebug(() => console.debug(`[FEATURE FLAGS] Failed to load feature flags: ${err}`)))
|
|
@@ -619,6 +627,28 @@ class FeatureFlagsPoller {
|
|
|
619
627
|
return Math.min(SIXTY_SECONDS, this.pollingInterval * 2 ** this.backOffCount)
|
|
620
628
|
}
|
|
621
629
|
|
|
630
|
+
/**
|
|
631
|
+
* Enter backoff state after receiving an error response (401, 403, 429).
|
|
632
|
+
* This enables exponential backoff for the poller and blocks on-demand fetches.
|
|
633
|
+
*/
|
|
634
|
+
private beginBackoff(): void {
|
|
635
|
+
this.shouldBeginExponentialBackoff = true
|
|
636
|
+
this.backOffCount += 1
|
|
637
|
+
// Use the same backoff interval as the poller to avoid overwhelming
|
|
638
|
+
// the server with on-demand requests while polling is backed off.
|
|
639
|
+
this.nextFetchAllowedAt = Date.now() + this.getPollingInterval()
|
|
640
|
+
}
|
|
641
|
+
|
|
642
|
+
/**
|
|
643
|
+
* Clear backoff state after a successful response (200, 304).
|
|
644
|
+
* This resets the polling interval and allows on-demand fetches immediately.
|
|
645
|
+
*/
|
|
646
|
+
private clearBackoff(): void {
|
|
647
|
+
this.shouldBeginExponentialBackoff = false
|
|
648
|
+
this.backOffCount = 0
|
|
649
|
+
this.nextFetchAllowedAt = undefined
|
|
650
|
+
}
|
|
651
|
+
|
|
622
652
|
async _loadFeatureFlags(): Promise<void> {
|
|
623
653
|
if (this.poller) {
|
|
624
654
|
clearTimeout(this.poller)
|
|
@@ -690,14 +720,12 @@ class FeatureFlagsPoller {
|
|
|
690
720
|
// Update ETag if server sent one (304 can include updated ETag per HTTP spec)
|
|
691
721
|
this.flagsEtag = res.headers?.get('ETag') ?? this.flagsEtag
|
|
692
722
|
this.loadedSuccessfullyOnce = true
|
|
693
|
-
this.
|
|
694
|
-
this.backOffCount = 0
|
|
723
|
+
this.clearBackoff()
|
|
695
724
|
return
|
|
696
725
|
|
|
697
726
|
case 401:
|
|
698
727
|
// Invalid API key
|
|
699
|
-
this.
|
|
700
|
-
this.backOffCount += 1
|
|
728
|
+
this.beginBackoff()
|
|
701
729
|
throw new ClientError(
|
|
702
730
|
`Your project key or personal API key is invalid. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`
|
|
703
731
|
)
|
|
@@ -715,16 +743,14 @@ class FeatureFlagsPoller {
|
|
|
715
743
|
|
|
716
744
|
case 403:
|
|
717
745
|
// Permissions issue
|
|
718
|
-
this.
|
|
719
|
-
this.backOffCount += 1
|
|
746
|
+
this.beginBackoff()
|
|
720
747
|
throw new ClientError(
|
|
721
748
|
`Your personal API key does not have permission to fetch feature flag definitions for local evaluation. Setting next polling interval to ${this.getPollingInterval()}ms. Are you sure you're using the correct personal and Project API key pair? More information: https://posthog.com/docs/api/overview`
|
|
722
749
|
)
|
|
723
750
|
|
|
724
751
|
case 429:
|
|
725
752
|
// Rate limited
|
|
726
|
-
this.
|
|
727
|
-
this.backOffCount += 1
|
|
753
|
+
this.beginBackoff()
|
|
728
754
|
throw new ClientError(
|
|
729
755
|
`You are being rate limited. Setting next polling interval to ${this.getPollingInterval()}ms. More information: https://posthog.com/docs/api#rate-limiting`
|
|
730
756
|
)
|
|
@@ -748,8 +774,7 @@ class FeatureFlagsPoller {
|
|
|
748
774
|
}
|
|
749
775
|
|
|
750
776
|
this.updateFlagState(flagData)
|
|
751
|
-
this.
|
|
752
|
-
this.backOffCount = 0
|
|
777
|
+
this.clearBackoff()
|
|
753
778
|
|
|
754
779
|
if (this.cacheProvider && shouldFetch) {
|
|
755
780
|
// Only notify the cache if it's actually expecting new data
|
package/src/types.ts
CHANGED
|
@@ -55,6 +55,37 @@ export type FlagProperty = {
|
|
|
55
55
|
|
|
56
56
|
export type FlagPropertyValue = string | number | (string | number)[] | boolean
|
|
57
57
|
|
|
58
|
+
/**
|
|
59
|
+
* Options for overriding feature flags.
|
|
60
|
+
*
|
|
61
|
+
* Supports multiple formats:
|
|
62
|
+
* - `false` - Clear all overrides
|
|
63
|
+
* - `string[]` - Enable a list of flags (sets them to `true`)
|
|
64
|
+
* - `Record<string, FeatureFlagValue>` - Set specific flag values/variants
|
|
65
|
+
* - `FeatureFlagOverrideOptions` - Set both flag values and payloads
|
|
66
|
+
*/
|
|
67
|
+
export type OverrideFeatureFlagsOptions =
|
|
68
|
+
| false
|
|
69
|
+
| string[]
|
|
70
|
+
| Record<string, FeatureFlagValue>
|
|
71
|
+
| FeatureFlagOverrideOptions
|
|
72
|
+
|
|
73
|
+
export type FeatureFlagOverrideOptions = {
|
|
74
|
+
/**
|
|
75
|
+
* Flag overrides. Can be:
|
|
76
|
+
* - `false` to clear flag overrides
|
|
77
|
+
* - `string[]` to enable a list of flags
|
|
78
|
+
* - `Record<string, FeatureFlagValue>` to set specific values/variants
|
|
79
|
+
*/
|
|
80
|
+
flags?: false | string[] | Record<string, FeatureFlagValue>
|
|
81
|
+
/**
|
|
82
|
+
* Payload overrides for flags.
|
|
83
|
+
* - `false` to clear payload overrides
|
|
84
|
+
* - `Record<string, JsonType>` to set specific payloads
|
|
85
|
+
*/
|
|
86
|
+
payloads?: false | Record<string, JsonType>
|
|
87
|
+
}
|
|
88
|
+
|
|
58
89
|
export type FeatureFlagCondition = {
|
|
59
90
|
properties: FlagProperty[]
|
|
60
91
|
rollout_percentage?: number
|
|
@@ -359,6 +390,32 @@ export interface IPostHog {
|
|
|
359
390
|
*/
|
|
360
391
|
reloadFeatureFlags(): Promise<void>
|
|
361
392
|
|
|
393
|
+
/**
|
|
394
|
+
* @description Override feature flags locally. Useful for testing and local development.
|
|
395
|
+
* Overridden flags take precedence over both local evaluation and remote evaluation.
|
|
396
|
+
*
|
|
397
|
+
* @example
|
|
398
|
+
* ```ts
|
|
399
|
+
* // Clear all overrides
|
|
400
|
+
* posthog.overrideFeatureFlags(false)
|
|
401
|
+
*
|
|
402
|
+
* // Enable a list of flags (sets them to true)
|
|
403
|
+
* posthog.overrideFeatureFlags(['flag-a', 'flag-b'])
|
|
404
|
+
*
|
|
405
|
+
* // Set specific flag values/variants
|
|
406
|
+
* posthog.overrideFeatureFlags({ 'my-flag': 'variant-a', 'other-flag': true })
|
|
407
|
+
*
|
|
408
|
+
* // Set both flags and payloads
|
|
409
|
+
* posthog.overrideFeatureFlags({
|
|
410
|
+
* flags: { 'my-flag': 'variant-a' },
|
|
411
|
+
* payloads: { 'my-flag': { discount: 20 } }
|
|
412
|
+
* })
|
|
413
|
+
* ```
|
|
414
|
+
*
|
|
415
|
+
* @param overrides - Flag overrides configuration
|
|
416
|
+
*/
|
|
417
|
+
overrideFeatureFlags(overrides: OverrideFeatureFlagsOptions): void
|
|
418
|
+
|
|
362
419
|
/**
|
|
363
420
|
* @description Run a function with specific context that will be applied to all events captured within that context.
|
|
364
421
|
* @param data Context data to apply (sessionId, distinctId, properties, enableExceptionAutocapture)
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '5.
|
|
1
|
+
export const version = '5.19.0'
|