@firebase/remote-config 0.7.0 → 0.8.0-20260114160934

package/dist/esm/index.esm.js

@@ -5,7 +5,7 @@ import { LogLevel, Logger } from '@firebase/logger';
 import '@firebase/installations';
 
 const name = "@firebase/remote-config";
-const version = "0.7.0";
+const version = "0.8.0-20260114160934";
 
 /**
  * @license
@@ -105,7 +105,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 ErrorFactory('remoteconfig' /* service */, 'Remote Config' /* service name */, ERROR_DESCRIPTION_MAP);
 // Note how this is like typeof/instanceof, but for ErrorCode.
@@ -162,6 +163,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
@@ -239,10 +298,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;
 }
@@ -697,6 +761,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) {
@@ -712,6 +777,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') {
@@ -723,6 +789,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
@@ -733,7 +800,7 @@ class RestClient {
                 httpStatus: status
             });
         }
-        return { status, eTag: responseEtag, config, templateVersion };
+        return { status, eTag: responseEtag, config, templateVersion, experiments };
     }
 }
 
@@ -899,13 +966,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
@@ -1026,6 +1098,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');
     }
@@ -2016,6 +2094,7 @@ function registerRemoteConfig() {
         const installations = container
             .getProvider('installations-internal')
             .getImmediate();
+        const analyticsProvider = container.getProvider('analytics-internal');
         // Normalizes optional inputs.
         const { projectId, apiKey, appId } = app.options;
         if (!projectId) {
@@ -2042,7 +2121,7 @@ function registerRemoteConfig() {
         const retryingClient = new RetryingClient(restClient, storage);
         const cachingClient = new CachingClient(retryingClient, storage, storageCache, logger);
         const realtimeHandler = new RealtimeHandler(installations, storage, SDK_VERSION, namespace, projectId, apiKey, appId, logger, storageCache, cachingClient);
-        const remoteConfigInstance = new RemoteConfig(app, cachingClient, storageCache, storage, logger, realtimeHandler);
+        const remoteConfigInstance = new RemoteConfig(app, cachingClient, storageCache, storage, logger, realtimeHandler, analyticsProvider);
         // Starts warming cache.
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         ensureInitialized(remoteConfigInstance);