@firebase/remote-config 0.8.5 → 0.9.0

package/dist/esm/src/client/realtime_handler.d.ts

@@ -95,8 +95,11 @@ export declare class RealtimeHandler {
      */
     private getChangedParams;
     private areExperimentsEqual;
+    private areRolloutsEqual;
     /** Creates a map where the key is the config key and the value is the experiment description. */
     private createExperimentsMap;
+    /** Creates a map where the key is the config key and the value is the rollout metadata. */
+    private createRolloutsMap;
     private fetchLatestConfig;
     private autoFetch;
     /**

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

@@ -67,6 +67,11 @@ export interface FirebaseExperimentDescription {
     timeToLiveMillis: string;
     affectedParameterKeys?: string[];
 }
+export interface FirebaseRolloutMetadata {
+    rolloutId: string;
+    variantId: string;
+    affectedParameterKeys: string[];
+}
 /**
  * Defines a successful response (200 or 304).
  *
@@ -109,6 +114,12 @@ export interface FetchResponse {
      * @remarks Only defined for 200 responses.
      */
     experiments?: FirebaseExperimentDescription[];
+    /**
+     * Metadata for Remote Config Rollout experiments.
+     *
+     * @remarks Only defined for 200 responses.
+     */
+    rollouts?: FirebaseRolloutMetadata[];
 }
 /**
  * Options for Remote Config initialization.

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.8.5";
+const version = "0.9.0";
 
 /**
  * @license
@@ -764,6 +764,7 @@ class RestClient {
         let state;
         let templateVersion;
         let experiments;
+        let rollouts;
         // 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) {
@@ -780,6 +781,7 @@ class RestClient {
             state = responseBody['state'];
             templateVersion = responseBody['templateVersion'];
             experiments = responseBody['experimentDescriptions'];
+            rollouts = responseBody['rolloutMetadata'];
         }
         // Normalizes based on legacy state.
         if (state === 'INSTANCE_STATE_UNSPECIFIED') {
@@ -792,6 +794,7 @@ class RestClient {
             // These cases can be fixed remotely, so normalize to safe value.
             config = {};
             experiments = [];
+            rollouts = [];
         }
         // 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
@@ -802,7 +805,14 @@ class RestClient {
                 httpStatus: status
             });
         }
-        return { status, eTag: responseEtag, config, templateVersion, experiments };
+        return {
+            status,
+            eTag: responseEtag,
+            config,
+            templateVersion,
+            experiments,
+            rollouts
+        };
     }
 }
 
@@ -1776,9 +1786,14 @@ class RealtimeHandler {
         const oldExperiments = oldFetchResponse?.experiments || [];
         const newExperimentsMap = this.createExperimentsMap(newExperiments);
         const oldExperimentsMap = this.createExperimentsMap(oldExperiments);
+        const newRollouts = newFetchResponse.rollouts || [];
+        const oldRollouts = oldFetchResponse?.rollouts || [];
+        const newRolloutsMap = this.createRolloutsMap(newRollouts);
+        const oldRolloutsMap = this.createRolloutsMap(oldRollouts);
         for (const key of newKeys) {
             if (!oldKeys.has(key) || newConfig[key] !== oldConfig[key]) {
                 changedKeys.add(key);
+                continue;
             }
             if (newExperimentsMap.has(key) !== oldExperimentsMap.has(key)) {
                 changedKeys.add(key);
@@ -1790,6 +1805,18 @@ class RealtimeHandler {
                 oldExperiment &&
                 !this.areExperimentsEqual(newExperiment, oldExperiment)) {
                 changedKeys.add(key);
+                continue;
+            }
+            if (newRolloutsMap.has(key) !== oldRolloutsMap.has(key)) {
+                changedKeys.add(key);
+                continue;
+            }
+            const newRollout = newRolloutsMap.get(key);
+            const oldRollout = oldRolloutsMap.get(key);
+            if (newRollout &&
+                oldRollout &&
+                !this.areRolloutsEqual(newRollout, oldRollout)) {
+                changedKeys.add(key);
             }
         }
         for (const key of oldKeys) {
@@ -1805,6 +1832,17 @@ class RealtimeHandler {
             newExperiment.timeToLiveMillis === oldExperiment.timeToLiveMillis &&
             newExperiment.triggerTimeoutMillis === oldExperiment.triggerTimeoutMillis);
     }
+    areRolloutsEqual(newRollout, oldRollout) {
+        if (newRollout.size !== oldRollout.size) {
+            return false;
+        }
+        for (const [key, value] of newRollout) {
+            if (oldRollout.get(key) !== value) {
+                return false;
+            }
+        }
+        return true;
+    }
     /** Creates a map where the key is the config key and the value is the experiment description. */
     createExperimentsMap(experimentDescriptions) {
         const experimentsMap = new Map();
@@ -1819,6 +1857,24 @@ class RealtimeHandler {
         }
         return experimentsMap;
     }
+    /** Creates a map where the key is the config key and the value is the rollout metadata. */
+    createRolloutsMap(rollouts) {
+        const rolloutMetadataMap = new Map();
+        for (const rollout of rollouts) {
+            const rolloutId = rollout.rolloutId;
+            const variantId = rollout.variantId;
+            const affectedParameterKeys = rollout.affectedParameterKeys || [];
+            for (const parameterKey of affectedParameterKeys) {
+                let parameterKeyRolloutMetadata = rolloutMetadataMap.get(parameterKey);
+                if (!parameterKeyRolloutMetadata) {
+                    parameterKeyRolloutMetadata = new Map();
+                    rolloutMetadataMap.set(parameterKey, parameterKeyRolloutMetadata);
+                }
+                parameterKeyRolloutMetadata.set(rolloutId, variantId);
+            }
+        }
+        return rolloutMetadataMap;
+    }
     async fetchLatestConfig(remainingAttempts, targetVersion) {
         const remainingAttemptsAfterFetch = remainingAttempts - 1;
         const currentAttempt = MAXIMUM_FETCH_ATTEMPTS - remainingAttemptsAfterFetch;