@firebase/remote-config 0.7.0 → 0.8.0-20260114160934

package/dist/esm/src/abt/experiment.d.ts

@@ -0,0 +1,13 @@
+import { FirebaseExperimentDescription } from '../public_types';
+import { RemoteConfig } from '../remote_config';
+export declare class Experiment {
+    private storage;
+    private logger;
+    private analyticsProvider;
+    constructor(rc: RemoteConfig);
+    updateActiveExperiments(latestExperiments: FirebaseExperimentDescription[]): Promise<void>;
+    private createExperimentInfoMap;
+    private addActiveExperiments;
+    private removeInactiveExperiments;
+    private addExperimentToAnalytics;
+}

package/dist/esm/src/errors.d.ts

@@ -35,7 +35,8 @@ export declare const enum ErrorCode {
     CONFIG_UPDATE_STREAM_ERROR = "stream-error",
     CONFIG_UPDATE_UNAVAILABLE = "realtime-unavailable",
     CONFIG_UPDATE_MESSAGE_INVALID = "update-message-invalid",
-    CONFIG_UPDATE_NOT_FETCHED = "update-not-fetched"
+    CONFIG_UPDATE_NOT_FETCHED = "update-not-fetched",
+    ANALYTICS_UNAVAILABLE = "analytics-unavailable"
 }
 interface ErrorParams {
     [ErrorCode.STORAGE_OPEN]: {
@@ -77,6 +78,9 @@ interface ErrorParams {
     [ErrorCode.CONFIG_UPDATE_NOT_FETCHED]: {
         originalErrorMessage: string;
     };
+    [ErrorCode.ANALYTICS_UNAVAILABLE]: {
+        originalErrorMessage: string;
+    };
 }
 export declare const ERROR_FACTORY: ErrorFactory<ErrorCode, ErrorParams>;
 export declare function hasErrorCode(e: Error, errorCode: ErrorCode): boolean;

package/dist/esm/src/public_types.d.ts

@@ -54,6 +54,19 @@ export interface RemoteConfig {
 export interface FirebaseRemoteConfigObject {
     [key: string]: string;
 }
+/**
+ * Defines experiment and variant attached to a config parameter.
+ *
+ * @public
+ */
+export interface FirebaseExperimentDescription {
+    experimentId: string;
+    variantId: string;
+    experimentStartTime: string;
+    triggerTimeoutMillis: string;
+    timeToLiveMillis: string;
+    affectedParameterKeys?: string[];
+}
 /**
  * Defines a successful response (200 or 304).
  *
@@ -90,6 +103,12 @@ export interface FetchResponse {
      * The version number of the config template fetched from the server.
      */
     templateVersion?: number;
+    /**
+     * Metadata for A/B testing and Remote Config Rollout experiments.
+     *
+     * @remarks Only defined for 200 responses.
+     */
+    experiments?: FirebaseExperimentDescription[];
 }
 /**
  * Options for Remote Config initialization.

package/dist/esm/src/remote_config.d.ts

@@ -20,6 +20,8 @@ import { StorageCache } from './storage/storage_cache';
 import { RemoteConfigFetchClient } from './client/remote_config_fetch_client';
 import { Storage } from './storage/storage';
 import { Logger } from '@firebase/logger';
+import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
+import { Provider } from '@firebase/component';
 import { RealtimeHandler } from './client/realtime_handler';
 /**
  * Encapsulates business logic mapping network and storage dependencies to the public SDK API.
@@ -48,6 +50,10 @@ export declare class RemoteConfig implements RemoteConfigType {
      * @internal
      */
     readonly _realtimeHandler: RealtimeHandler;
+    /**
+     * @internal
+     */
+    readonly _analyticsProvider: Provider<FirebaseAnalyticsInternalName>;
     /**
      * Tracks completion of initialization promise.
      * @internal
@@ -84,5 +90,9 @@ export declare class RemoteConfig implements RemoteConfigType {
     /**
      * @internal
      */
-    _realtimeHandler: RealtimeHandler);
+    _realtimeHandler: RealtimeHandler, 
+    /**
+     * @internal
+     */
+    _analyticsProvider: Provider<FirebaseAnalyticsInternalName>);
 }

package/dist/esm/src/storage/storage.d.ts

@@ -43,7 +43,7 @@ export interface RealtimeBackoffMetadata {
  *
  * <p>This seems like a small price to avoid potentially subtle bugs caused by a typo.
  */
-type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata' | 'custom_signals' | 'realtime_backoff_metadata' | 'last_known_template_version';
+type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'active_experiments' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata' | 'custom_signals' | 'realtime_backoff_metadata' | 'last_known_template_version';
 export declare function openDatabase(): Promise<IDBDatabase>;
 /**
  * Abstracts data persistence.
@@ -59,6 +59,8 @@ export declare abstract class Storage {
     setActiveConfig(config: FirebaseRemoteConfigObject): Promise<void>;
     getActiveConfigEtag(): Promise<string | undefined>;
     setActiveConfigEtag(etag: string): Promise<void>;
+    getActiveExperiments(): Promise<Set<string> | undefined>;
+    setActiveExperiments(experiments: Set<string>): Promise<void>;
     getThrottleMetadata(): Promise<ThrottleMetadata | undefined>;
     setThrottleMetadata(metadata: ThrottleMetadata): Promise<void>;
     deleteThrottleMetadata(): Promise<void>;

package/dist/index.cjs.js

@@ -9,7 +9,7 @@ var logger = require('@firebase/logger');
 require('@firebase/installations');
 
 const name = "@firebase/remote-config";
-const version = "0.7.0";
+const version = "0.8.0-20260114160934";
 
 /**
  * @license
@@ -109,7 +109,8 @@ const ERROR_DESCRIPTION_MAP = {
     ["stream-error" /* ErrorCode.CONFIG_UPDATE_STREAM_ERROR */]: 'The stream was not able to connect to the backend: {$originalErrorMessage}.',
     ["realtime-unavailable" /* ErrorCode.CONFIG_UPDATE_UNAVAILABLE */]: 'The Realtime service is unavailable: {$originalErrorMessage}',
     ["update-message-invalid" /* ErrorCode.CONFIG_UPDATE_MESSAGE_INVALID */]: 'The stream invalidation message was unparsable: {$originalErrorMessage}',
-    ["update-not-fetched" /* ErrorCode.CONFIG_UPDATE_NOT_FETCHED */]: 'Unable to fetch the latest config: {$originalErrorMessage}'
+    ["update-not-fetched" /* ErrorCode.CONFIG_UPDATE_NOT_FETCHED */]: 'Unable to fetch the latest config: {$originalErrorMessage}',
+    ["analytics-unavailable" /* ErrorCode.ANALYTICS_UNAVAILABLE */]: 'Connection to Firebase Analytics failed: {$originalErrorMessage}'
 };
 const ERROR_FACTORY = new util.ErrorFactory('remoteconfig' /* service */, 'Remote Config' /* service name */, ERROR_DESCRIPTION_MAP);
 // Note how this is like typeof/instanceof, but for ErrorCode.
@@ -166,6 +167,64 @@ class Value {
     }
 }
 
+class Experiment {
+    constructor(rc) {
+        this.storage = rc._storage;
+        this.logger = rc._logger;
+        this.analyticsProvider = rc._analyticsProvider;
+    }
+    async updateActiveExperiments(latestExperiments) {
+        const currentActiveExperiments = (await this.storage.getActiveExperiments()) || new Set();
+        const experimentInfoMap = this.createExperimentInfoMap(latestExperiments);
+        this.addActiveExperiments(experimentInfoMap);
+        this.removeInactiveExperiments(currentActiveExperiments, experimentInfoMap);
+        return this.storage.setActiveExperiments(new Set(experimentInfoMap.keys()));
+    }
+    createExperimentInfoMap(latestExperiments) {
+        const experimentInfoMap = new Map();
+        for (const experiment of latestExperiments) {
+            experimentInfoMap.set(experiment.experimentId, experiment);
+        }
+        return experimentInfoMap;
+    }
+    addActiveExperiments(experimentInfoMap) {
+        const customProperty = {};
+        for (const [experimentId, experimentInfo] of experimentInfoMap.entries()) {
+            customProperty[`firebase${experimentId}`] = experimentInfo.variantId;
+        }
+        this.addExperimentToAnalytics(customProperty);
+    }
+    removeInactiveExperiments(currentActiveExperiments, experimentInfoMap) {
+        const customProperty = {};
+        for (const experimentId of currentActiveExperiments) {
+            if (!experimentInfoMap.has(experimentId)) {
+                customProperty[`firebase${experimentId}`] = null;
+            }
+        }
+        this.addExperimentToAnalytics(customProperty);
+    }
+    addExperimentToAnalytics(customProperty) {
+        if (Object.keys(customProperty).length === 0) {
+            return;
+        }
+        try {
+            const analytics = this.analyticsProvider.getImmediate({ optional: true });
+            if (analytics) {
+                analytics.setUserProperties(customProperty);
+                analytics.logEvent(`set_firebase_experiment_state`);
+            }
+            else {
+                this.logger.warn(`Analytics import failed. Verify if you have imported Firebase Analytics in your app code.`);
+            }
+        }
+        catch (error) {
+            throw ERROR_FACTORY.create("analytics-unavailable" /* ErrorCode.ANALYTICS_UNAVAILABLE */, {
+                originalErrorMessage: error?.message
+            });
+        }
+    }
+}
+
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -243,10 +302,15 @@ async function activate(remoteConfig) {
         // config.
         return false;
     }
+    const experiment = new Experiment(rc);
+    const updateActiveExperiments = lastSuccessfulFetchResponse.experiments
+        ? experiment.updateActiveExperiments(lastSuccessfulFetchResponse.experiments)
+        : Promise.resolve();
     await Promise.all([
         rc._storageCache.setActiveConfig(lastSuccessfulFetchResponse.config),
         rc._storage.setActiveConfigEtag(lastSuccessfulFetchResponse.eTag),
-        rc._storage.setActiveConfigTemplateVersion(lastSuccessfulFetchResponse.templateVersion)
+        rc._storage.setActiveConfigTemplateVersion(lastSuccessfulFetchResponse.templateVersion),
+        updateActiveExperiments
     ]);
     return true;
 }
@@ -701,6 +765,7 @@ class RestClient {
         let config;
         let state;
         let templateVersion;
+        let experiments;
         // JSON parsing throws SyntaxError if the response body isn't a JSON string.
         // Requesting application/json and checking for a 200 ensures there's JSON data.
         if (response.status === 200) {
@@ -716,6 +781,7 @@ class RestClient {
             config = responseBody['entries'];
             state = responseBody['state'];
             templateVersion = responseBody['templateVersion'];
+            experiments = responseBody['experimentDescriptions'];
         }
         // Normalizes based on legacy state.
         if (state === 'INSTANCE_STATE_UNSPECIFIED') {
@@ -727,6 +793,7 @@ class RestClient {
         else if (state === 'NO_TEMPLATE' || state === 'EMPTY_CONFIG') {
             // These cases can be fixed remotely, so normalize to safe value.
             config = {};
+            experiments = [];
         }
         // Normalize to exception-based control flow for non-success cases.
         // Encapsulates HTTP specifics in this class as much as possible. Status is still the best for
@@ -737,7 +804,7 @@ class RestClient {
                 httpStatus: status
             });
         }
-        return { status, eTag: responseEtag, config, templateVersion };
+        return { status, eTag: responseEtag, config, templateVersion, experiments };
     }
 }
 
@@ -903,13 +970,18 @@ class RemoteConfig {
     /**
      * @internal
      */
-    _realtimeHandler) {
+    _realtimeHandler, 
+    /**
+     * @internal
+     */
+    _analyticsProvider) {
         this.app = app;
         this._client = _client;
         this._storageCache = _storageCache;
         this._storage = _storage;
         this._logger = _logger;
         this._realtimeHandler = _realtimeHandler;
+        this._analyticsProvider = _analyticsProvider;
         /**
          * Tracks completion of initialization promise.
          * @internal
@@ -1030,6 +1102,12 @@ class Storage {
     setActiveConfigEtag(etag) {
         return this.set('active_config_etag', etag);
     }
+    getActiveExperiments() {
+        return this.get('active_experiments');
+    }
+    setActiveExperiments(experiments) {
+        return this.set('active_experiments', experiments);
+    }
     getThrottleMetadata() {
         return this.get('throttle_metadata');
     }
@@ -2020,6 +2098,7 @@ function registerRemoteConfig() {
         const installations = container
             .getProvider('installations-internal')
             .getImmediate();
+        const analyticsProvider = container.getProvider('analytics-internal');
         // Normalizes optional inputs.
         const { projectId, apiKey, appId } = app$1.options;
         if (!projectId) {
@@ -2046,7 +2125,7 @@ function registerRemoteConfig() {
         const retryingClient = new RetryingClient(restClient, storage);
         const cachingClient = new CachingClient(retryingClient, storage, storageCache, logger$1);
         const realtimeHandler = new RealtimeHandler(installations, storage, app.SDK_VERSION, namespace, projectId, apiKey, appId, logger$1, storageCache, cachingClient);
-        const remoteConfigInstance = new RemoteConfig(app$1, cachingClient, storageCache, storage, logger$1, realtimeHandler);
+        const remoteConfigInstance = new RemoteConfig(app$1, cachingClient, storageCache, storage, logger$1, realtimeHandler, analyticsProvider);
         // Starts warming cache.
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         ensureInitialized(remoteConfigInstance);