@flagsmith/flagsmith 11.0.0-internal.7 → 12.0.0

package/src/flagsmith-core.ts

@@ -9,8 +9,6 @@ import {
     IFlagsmithResponse,
     IFlagsmithTrait,
     IInitConfig,
-    IPipelineEvent,
-    IPipelineEventBatch,
     ISentryClient,
     IState,
     ITraits,
@@ -36,11 +34,6 @@ export enum FlagSource {
     "SERVER" = "SERVER",
 }
 
-export enum PipelineEventType {
-    FLAG_EVALUATION = 'flag_evaluation',
-    CUSTOM_EVENT = 'custom_event',
-}
-
 export type LikeFetch = (input: Partial<RequestInfo>, init?: Partial<RequestInit>) => Promise<Partial<Response>>
 let _fetch: LikeFetch;
 
@@ -71,7 +64,6 @@ type Config = {
 const FLAGSMITH_CONFIG_ANALYTICS_KEY = "flagsmith_value_";
 const FLAGSMITH_FLAG_ANALYTICS_KEY = "flagsmith_enabled_";
 const FLAGSMITH_TRAIT_ANALYTICS_KEY = "flagsmith_trait_";
-const DEFAULT_PIPELINE_FLUSH_INTERVAL = 10000;
 
 const Flagsmith = class {
     _trigger?:(()=>void)|null= null
@@ -273,46 +265,6 @@ const Flagsmith = class {
         }
     };
 
-    flushPipelineAnalytics = async () => {
-        const isEvaluationEnabled = this.evaluationAnalyticsUrl && this.evaluationContext.environment;
-        const isReadyToFlush = this.pipelineEvents.length > 0 && (!this.isPipelineFlushing || this.pipelineFlushInterval === 0);
-        if (!isEvaluationEnabled || !isReadyToFlush) {
-            return;
-        }
-
-        const environmentKey = this.evaluationContext.environment!.apiKey;
-        this.isPipelineFlushing = true;
-        const eventsToSend = this.pipelineEvents.slice(0, this.evaluationAnalyticsMaxBuffer);
-        this.pipelineEvents = this.pipelineEvents.slice(this.evaluationAnalyticsMaxBuffer);
-        this.pipelineRecordedKeys.clear();
-
-        const batch: IPipelineEventBatch = {
-            events: eventsToSend,
-            environment_key: environmentKey,
-        };
-
-        try {
-            const res = await _fetch(this.evaluationAnalyticsUrl + 'v1/analytics/batch', {
-                method: 'POST',
-                body: JSON.stringify(batch),
-                headers: {
-                    'Content-Type': 'application/json; charset=utf-8',
-                    'X-Environment-Key': environmentKey,
-                    ...(SDK_VERSION ? { 'Flagsmith-SDK-User-Agent': `flagsmith-js-sdk/${SDK_VERSION}` } : {}),
-                },
-            });
-            if (!res.status || res.status < 200 || res.status >= 300) {
-                throw new Error(`Pipeline analytics: unexpected status ${res.status}`);
-            }
-            this.log('Pipeline analytics: flush successful');
-        } catch (err) {
-            this.pipelineEvents = eventsToSend.concat(this.pipelineEvents);
-            this.log('Pipeline analytics: flush failed, events re-queued', err);
-        } finally {
-            this.isPipelineFlushing = false;
-        }
-    };
-
     datadogRum: IDatadogRum | null = null;
     loadingState: LoadingState = {isLoading: true, isFetching: true, error: null, source: FlagSource.NONE}
     canUseStorage = false
@@ -338,12 +290,6 @@ const Flagsmith = class {
     sentryClient: ISentryClient | null = null
     withTraits?: ITraits|null= null
     cacheOptions = {ttl:0, skipAPI: false, loadStale: false, storageKey: undefined as string|undefined}
-    private evaluationAnalyticsUrl: string | null = null
-    private evaluationAnalyticsMaxBuffer: number = 1000
-    private pipelineEvents: IPipelineEvent[] = []
-    private pipelineAnalyticsInterval: ReturnType<typeof setInterval> | null = null
-    private isPipelineFlushing = false
-    private pipelineRecordedKeys: Map<string, string> = new Map()
     async init(config: IInitConfig) {
         const evaluationContext = toEvaluationContext(config.evaluationContext || this.evaluationContext);
         try {
@@ -362,7 +308,6 @@ const Flagsmith = class {
                 enableDynatrace,
                 enableLogs,
                 environmentID,
-                evaluationAnalyticsConfig,
                 eventSourceUrl= "https://realtime.flagsmith.com/",
                 fetch: fetchImplementation,
                 headers,
@@ -496,12 +441,6 @@ const Flagsmith = class {
                 }
             }
 
-            if (evaluationAnalyticsConfig) {
-                this.initPipelineAnalytics(evaluationAnalyticsConfig);
-            } else {
-                this.stopPipelineAnalytics();
-            }
-
             //If the user specified default flags emit a changed event immediately
             if (cacheFlags) {
                 if (AsyncStorage && this.canUseStorage) {
@@ -684,6 +623,13 @@ const Flagsmith = class {
             this.evaluationEvent = state.evaluationEvent || this.evaluationEvent;
             this.identity = this.getContext()?.identity?.identifier
             this.log("setState called", this)
+            // Hydration from server state (e.g. <FlagsmithProvider serverState={...}>
+            // without an options prop) must flip loadingState to loaded. Guarded on
+            // source===NONE so we never clobber a loaded state already set by
+            // init()/getFlags()/cache paths that also call setState internally.
+            if (this.loadingState.source === FlagSource.NONE && this.flags && Object.keys(this.flags).length > 0) {
+                this.setLoadingState(this._loadedState(null, FlagSource.SERVER));
+            }
         }
     }
 
@@ -977,118 +923,9 @@ const Flagsmith = class {
             }
             this.evaluationEvent[this.evaluationContext.environment.apiKey][key] += 1;
         }
-
-        if (this.evaluationAnalyticsUrl) {
-            this.recordPipelineEvent(key);
-        }
-
         this.updateEventStorage();
     };
 
-    private pipelineFlushInterval: number = DEFAULT_PIPELINE_FLUSH_INTERVAL;
-
-    private initPipelineAnalytics(config: NonNullable<IInitConfig['evaluationAnalyticsConfig']>) {
-        this.stopPipelineAnalytics();
-        this.evaluationAnalyticsUrl = ensureTrailingSlash(config.analyticsServerUrl);
-        this.evaluationAnalyticsMaxBuffer = config.maxBuffer ?? 1000;
-        this.pipelineFlushInterval = config.flushInterval ?? DEFAULT_PIPELINE_FLUSH_INTERVAL;
-        this.pipelineEvents = [];
-        if (this.pipelineFlushInterval > 0) {
-            this.pipelineAnalyticsInterval = setInterval(
-                this.flushPipelineAnalytics,
-                this.pipelineFlushInterval,
-            );
-            this.pipelineAnalyticsInterval?.unref?.();
-        }
-    }
-
-    private stopPipelineAnalytics() {
-        if (this.pipelineAnalyticsInterval) {
-            clearInterval(this.pipelineAnalyticsInterval);
-            this.pipelineAnalyticsInterval = null;
-        }
-        this.evaluationAnalyticsUrl = null;
-        this.pipelineEvents = [];
-        this.pipelineRecordedKeys.clear();
-    }
-
-    private currentTraitsSnapshot() {
-        return this.evaluationContext.identity?.traits
-            ? { ...this.evaluationContext.identity.traits }
-            : null;
-    }
-
-    private getPageUrl(): string | null {
-        return typeof window !== 'undefined' && window.location ? window.location.href : null;
-    }
-
-    private getEventMetadata(extra?: Record<string, unknown>): Record<string, unknown> {
-        const pageUrl = this.getPageUrl();
-        return {
-            ...(extra || {}),
-            ...(pageUrl ? { page_url: pageUrl } : {}),
-            ...(SDK_VERSION ? { sdk_version: SDK_VERSION } : {}),
-        };
-    }
-
-    // Pipeline event schema — must match the pipeline server's Event struct.
-    // To update: 1) IPipelineEvent in types.d.ts  2) event object below  3) tests in test/analytics-pipeline.test.ts
-    private buildAnalyticEvent(
-        eventType: PipelineEventType,
-        eventId: string,
-        options?: {
-            enabled?: boolean | null;
-            value?: any;
-            extraMetadata?: Record<string, unknown>;
-            timestamp?: number;
-        },
-    ): IPipelineEvent {
-        return {
-            event_id: eventId,
-            event_type: eventType,
-            evaluated_at: options?.timestamp ?? Date.now(),
-            identity_identifier: this.evaluationContext.identity?.identifier ?? null,
-            enabled: options?.enabled ?? null,
-            value: options?.value ?? null,
-            traits: this.currentTraitsSnapshot(),
-            metadata: this.getEventMetadata(options?.extraMetadata),
-        };
-    }
-
-    private recordPipelineEvent(key: string) {
-        const flagKey = key.toLowerCase().replace(/ /g, '_');
-        const flag = this.flags && this.flags[flagKey];
-        const fingerprint = `${this.evaluationContext.identity?.identifier ?? 'none'}|${flag?.enabled ?? false}|${flag?.value ?? 'null'}`;
-        if (this.pipelineRecordedKeys.get(flagKey) === fingerprint) {
-            return;
-        }
-        this.pipelineRecordedKeys.set(flagKey, fingerprint);
-        const event = this.buildAnalyticEvent(PipelineEventType.FLAG_EVALUATION, flagKey, {
-            enabled: flag ? flag.enabled : null,
-            value: flag ? flag.value : null,
-            extraMetadata: flag ? { id: flag.id } : undefined,
-        });
-        this.pipelineEvents.push(event);
-
-        if (this.pipelineFlushInterval === 0 || this.pipelineEvents.length >= this.evaluationAnalyticsMaxBuffer) {
-            this.flushPipelineAnalytics();
-        }
-    }
-
-    trackEvent = (eventName: string, metadata?: Record<string, unknown>) => {
-        if (!this.evaluationAnalyticsUrl || !eventName) {
-            return;
-        }
-        const event = this.buildAnalyticEvent(PipelineEventType.CUSTOM_EVENT, eventName, {
-            extraMetadata: metadata,
-        });
-        this.pipelineEvents.push(event);
-
-        if (this.pipelineFlushInterval === 0 || this.pipelineEvents.length >= this.evaluationAnalyticsMaxBuffer) {
-            this.flushPipelineAnalytics();
-        }
-    }
-
     private setLoadingState(loadingState: LoadingState) {
         if (!deepEqual(loadingState, this.loadingState)) {
             this.loadingState = { ...loadingState };

package/src/index.ts

@@ -19,4 +19,4 @@ export default flagsmith;
 export const createFlagsmithInstance = ():IFlagsmith=>{
     return core({ AsyncStorage, fetch:_fetch, eventSource:_EventSource})
 }
-export { FlagSource, PipelineEventType } from './flagsmith-core';
+export { FlagSource } from './flagsmith-core';

package/src/react.tsx

@@ -1,4 +1,4 @@
-import React, { createContext, FC, useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react'
+import React, { createContext, FC, useContext, useEffect, useMemo, useRef, useState } from 'react'
 import Emitter from './utils/emitter'
 const events = new Emitter()
 
@@ -87,28 +87,17 @@ const getRenderKey = (flagsmith: IFlagsmith, flags: string[], traits: string[] =
 export function useFlagsmithLoading() {
     const flagsmith = useContext(FlagsmithContext)
     const [loadingState, setLoadingState] = useState(flagsmith?.loadingState)
-    const [subscribed, setSubscribed] = useState(false)
-    const refSubscribed = useRef(subscribed)
-
-    const eventListener = useCallback(() => {
-        setLoadingState(flagsmith?.loadingState)
-    }, [flagsmith])
-    if (!refSubscribed.current) {
-        events.on('loading_event', eventListener)
-        refSubscribed.current = true
-    }
 
     useEffect(() => {
-        if (!subscribed && flagsmith?.initialised) {
-            events.on('loading_event', eventListener)
-            setSubscribed(true)
-        }
+        if (!flagsmith) return
+        setLoadingState(flagsmith.loadingState)
+        const unsubscribe = events.on('loading_event', () => {
+            setLoadingState(flagsmith.loadingState)
+        })
         return () => {
-            if (subscribed) {
-                events.off('loading_event', eventListener)
-            }
+            unsubscribe()
         }
-    }, [flagsmith, subscribed, eventListener])
+    }, [flagsmith])
 
     return loadingState
 }
@@ -142,32 +131,27 @@ export function useFlags<F extends string | Record<string, any>, T extends strin
     _flags: readonly (F | keyof F)[],
     _traits: readonly T[] = []
 ) {
-    const firstRender = useRef(true)
     const flags = useConstant<string[]>(flagsAsArray(_flags))
     const traits = useConstant<string[]>(flagsAsArray(_traits))
     const flagsmith = useContext(FlagsmithContext)
     const [renderRef, setRenderRef] = useState(getRenderKey(flagsmith as IFlagsmith, flags, traits))
-    const eventListener = useCallback(() => {
-        const newRenderKey = getRenderKey(flagsmith as IFlagsmith, flags, traits)
-        if (newRenderKey !== renderRef) {
-            // @ts-expect-error using internal function, consumers would never call this
-            flagsmith?.log('React - useFlags flags and traits have changed')
-            setRenderRef(newRenderKey)
-        }
-    }, [renderRef])
-    const emitterRef = useRef(events.once('event', eventListener))
-
-    if (firstRender.current) {
-        firstRender.current = false
-        // @ts-expect-error using internal function, consumers would never call this
-        flagsmith?.log('React - Initialising event listeners')
-    }
 
     useEffect(() => {
+        if (!flagsmith) return
+        setRenderRef(getRenderKey(flagsmith, flags, traits))
+        const unsubscribe = events.on('event', () => {
+            setRenderRef((prev) => {
+                const next = getRenderKey(flagsmith, flags, traits)
+                if (prev === next) return prev
+                // @ts-expect-error using internal function, consumers would never call this
+                flagsmith?.log('React - useFlags flags and traits have changed')
+                return next
+            })
+        })
         return () => {
-            emitterRef.current?.()
+            unsubscribe()
         }
-    }, [])
+    }, [flagsmith, flags, traits])
 
     const res = useMemo(() => {
         const res: any = {}

package/src/types.d.ts

@@ -1,5 +1,5 @@
 import { EvaluationContext, IdentityEvaluationContext, TraitEvaluationContext } from "./evaluation-context";
-import { FlagSource, PipelineEventType } from "./flagsmith-core";
+import { FlagSource } from "./flagsmith-core";
 
 type IFlagsmithValue<T = string | number | boolean | null> = T
 
@@ -85,7 +85,7 @@ export type ISentryClient = {
 } | undefined;
 
 
-export { FlagSource, PipelineEventType };
+export { FlagSource };
 
 export declare type LoadingState = {
     error: Error | null, // Current error, resets on next attempt to fetch flags
@@ -131,34 +131,6 @@ export interface IInitConfig<F extends string | Record<string, any> = string, T
      * Customer application metadata
      */
     applicationMetadata?: ApplicationMetadata;
-    /**
-     * @experimental Internal use only — API may change without notice.
-     * Configuration for the evaluation analytics pipeline. When provided,
-     * individual flag evaluation events are buffered and sent to the pipeline endpoint.
-     * @hidden
-     */
-    /** @internal */
-    evaluationAnalyticsConfig?: {
-        analyticsServerUrl: string;
-        maxBuffer?: number;
-        flushInterval?: number;
-    };
-}
-
-export interface IPipelineEvent {
-    event_id: string; // flag_name or event_name
-    event_type: PipelineEventType;
-    evaluated_at: number;
-    identity_identifier: string | null;
-    enabled?: boolean | null;
-    value: IFlagsmithValue;
-    traits?: { [key: string]: null | TraitEvaluationContext } | null;
-    metadata?: Record<string, any> | null;
-}
-
-export interface IPipelineEventBatch {
-    events: IPipelineEvent[];
-    environment_key: string;
 }
 
 export interface IFlagsmithResponse {
@@ -299,15 +271,6 @@ T extends string = string
      * Set a key value set of traits for a given user, triggers a call to get flags
      */
     setTraits: (traits: ITraits) => Promise<void>;
-    /**
-     * Track a custom event through the evaluation analytics pipeline.
-     * Requires `evaluationAnalyticsConfig` to be set; no-op otherwise.
-     * Events are sent with the current identity (or null if anonymous).
-     * @experimental Internal use only — API may change without notice.
-     * @internal
-     * @hidden
-     */
-    trackEvent: (eventName: string, metadata?: Record<string, unknown>) => void;
     /**
      * The stored identity of the user
     */

package/src/utils/version.ts

@@ -1,2 +1,2 @@
 // Auto-generated by write-version.js
-export const SDK_VERSION = "11.0.0-internal.7";
+export const SDK_VERSION = "12.0.0";

package/types.d.ts

@@ -1,5 +1,5 @@
 import { EvaluationContext, IdentityEvaluationContext, TraitEvaluationContext } from "./evaluation-context";
-import { FlagSource, PipelineEventType } from "./flagsmith-core";
+import { FlagSource } from "./flagsmith-core";
 
 type IFlagsmithValue<T = string | number | boolean | null> = T
 
@@ -85,7 +85,7 @@ export type ISentryClient = {
 } | undefined;
 
 
-export { FlagSource, PipelineEventType };
+export { FlagSource };
 
 export declare type LoadingState = {
     error: Error | null, // Current error, resets on next attempt to fetch flags
@@ -131,34 +131,6 @@ export interface IInitConfig<F extends string | Record<string, any> = string, T
      * Customer application metadata
      */
     applicationMetadata?: ApplicationMetadata;
-    /**
-     * @experimental Internal use only — API may change without notice.
-     * Configuration for the evaluation analytics pipeline. When provided,
-     * individual flag evaluation events are buffered and sent to the pipeline endpoint.
-     * @hidden
-     */
-    /** @internal */
-    evaluationAnalyticsConfig?: {
-        analyticsServerUrl: string;
-        maxBuffer?: number;
-        flushInterval?: number;
-    };
-}
-
-export interface IPipelineEvent {
-    event_id: string; // flag_name or event_name
-    event_type: PipelineEventType;
-    evaluated_at: number;
-    identity_identifier: string | null;
-    enabled?: boolean | null;
-    value: IFlagsmithValue;
-    traits?: { [key: string]: null | TraitEvaluationContext } | null;
-    metadata?: Record<string, any> | null;
-}
-
-export interface IPipelineEventBatch {
-    events: IPipelineEvent[];
-    environment_key: string;
 }
 
 export interface IFlagsmithResponse {
@@ -299,15 +271,6 @@ T extends string = string
      * Set a key value set of traits for a given user, triggers a call to get flags
      */
     setTraits: (traits: ITraits) => Promise<void>;
-    /**
-     * Track a custom event through the evaluation analytics pipeline.
-     * Requires `evaluationAnalyticsConfig` to be set; no-op otherwise.
-     * Events are sent with the current identity (or null if anonymous).
-     * @experimental Internal use only — API may change without notice.
-     * @internal
-     * @hidden
-     */
-    trackEvent: (eventName: string, metadata?: Record<string, unknown>) => void;
     /**
      * The stored identity of the user
     */

package/utils/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "11.0.0-internal.7";
+export declare const SDK_VERSION = "12.0.0";