@firebase/remote-config 0.4.11 → 0.5.0-canary.144bc3709

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.4.11";
+const version = "0.5.0-canary.144bc3709";
 
 /**
  * @license
@@ -64,6 +64,9 @@ class RemoteConfigAbortSignal {
  * limitations under the License.
  */
 const RC_COMPONENT_NAME = 'remote-config';
+const RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS = 100;
+const RC_CUSTOM_SIGNAL_KEY_MAX_LENGTH = 250;
+const RC_CUSTOM_SIGNAL_VALUE_MAX_LENGTH = 500;
 
 /**
  * @license
@@ -100,7 +103,8 @@ const ERROR_DESCRIPTION_MAP = {
     ["fetch-client-parse" /* ErrorCode.FETCH_PARSE */]: 'Fetch client could not parse response.' +
         ' Original error: {$originalErrorMessage}.',
     ["fetch-status" /* ErrorCode.FETCH_STATUS */]: 'Fetch server returned an HTTP error status. HTTP status: {$httpStatus}.',
-    ["indexed-db-unavailable" /* ErrorCode.INDEXED_DB_UNAVAILABLE */]: 'Indexed DB is not supported by current browser'
+    ["indexed-db-unavailable" /* ErrorCode.INDEXED_DB_UNAVAILABLE */]: 'Indexed DB is not supported by current browser',
+    ["custom-signal-max-allowed-signals" /* ErrorCode.CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS */]: 'Setting more than {$maxSignals} custom signals is not supported.'
 };
 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.
@@ -251,11 +255,16 @@ async function fetchConfig(remoteConfig) {
         // Note a very low delay, eg < 10ms, can elapse before listeners are initialized.
         abortSignal.abort();
     }, rc.settings.fetchTimeoutMillis);
+    const customSignals = rc._storageCache.getCustomSignals();
+    if (customSignals) {
+        rc._logger.debug(`Fetching config with custom signals: ${JSON.stringify(customSignals)}`);
+    }
     // Catches *all* errors thrown by client so status can be set consistently.
     try {
         await rc._client.fetch({
             cacheMaxAgeMillis: rc.settings.minimumFetchIntervalMillis,
-            signal: abortSignal
+            signal: abortSignal,
+            customSignals
         });
         await rc._storageCache.setLastFetchStatus('success');
     }
@@ -379,6 +388,41 @@ function setLogLevel(remoteConfig, logLevel) {
 function getAllKeys(obj1 = {}, obj2 = {}) {
     return Object.keys(Object.assign(Object.assign({}, obj1), obj2));
 }
+/**
+ * Sets the custom signals for the app instance.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param customSignals - Map (key, value) of the custom signals to be set for the app instance. If
+ * a key already exists, the value is overwritten. Setting the value of a custom signal to null
+ * unsets the signal. The signals will be persisted locally on the client.
+ *
+ * @public
+ */
+async function setCustomSignals(remoteConfig, customSignals) {
+    const rc = util.getModularInstance(remoteConfig);
+    if (Object.keys(customSignals).length === 0) {
+        return;
+    }
+    // eslint-disable-next-line guard-for-in
+    for (const key in customSignals) {
+        if (key.length > RC_CUSTOM_SIGNAL_KEY_MAX_LENGTH) {
+            rc._logger.error(`Custom signal key ${key} is too long, max allowed length is ${RC_CUSTOM_SIGNAL_KEY_MAX_LENGTH}.`);
+            return;
+        }
+        const value = customSignals[key];
+        if (typeof value === 'string' &&
+            value.length > RC_CUSTOM_SIGNAL_VALUE_MAX_LENGTH) {
+            rc._logger.error(`Value supplied for custom signal ${key} is too long, max allowed length is ${RC_CUSTOM_SIGNAL_VALUE_MAX_LENGTH}.`);
+            return;
+        }
+    }
+    try {
+        await rc._storageCache.setCustomSignals(customSignals);
+    }
+    catch (error) {
+        rc._logger.error(`Error encountered while setting custom signals: ${error}`);
+    }
+}
 
 /**
  * @license
@@ -559,7 +603,8 @@ class RestClient {
             app_instance_id: installationId,
             app_instance_id_token: installationToken,
             app_id: this.appId,
-            language_code: getUserLanguage()
+            language_code: getUserLanguage(),
+            custom_signals: request.customSignals
             /* eslint-enable camelcase */
         };
         const options = {
@@ -940,10 +985,43 @@ class Storage {
     deleteThrottleMetadata() {
         return this.delete('throttle_metadata');
     }
-    async get(key) {
+    getCustomSignals() {
+        return this.get('custom_signals');
+    }
+    async setCustomSignals(customSignals) {
         const db = await this.openDbPromise;
+        const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite');
+        const storedSignals = await this.getWithTransaction('custom_signals', transaction);
+        const combinedSignals = Object.assign(Object.assign({}, storedSignals), customSignals);
+        // Filter out key-value assignments with null values since they are signals being unset
+        const updatedSignals = Object.fromEntries(Object.entries(combinedSignals)
+            .filter(([_, v]) => v !== null)
+            .map(([k, v]) => {
+            // Stringify numbers to store a map of string keys and values which can be sent
+            // as-is in a fetch call.
+            if (typeof v === 'number') {
+                return [k, v.toString()];
+            }
+            return [k, v];
+        }));
+        // Throw an error if the number of custom signals to be stored exceeds the limit
+        if (Object.keys(updatedSignals).length > RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS) {
+            throw ERROR_FACTORY.create("custom-signal-max-allowed-signals" /* ErrorCode.CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS */, {
+                maxSignals: RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS
+            });
+        }
+        await this.setWithTransaction('custom_signals', updatedSignals, transaction);
+        return updatedSignals;
+    }
+    /**
+     * Gets a value from the database using the provided transaction.
+     *
+     * @param key The key of the value to get.
+     * @param transaction The transaction to use for the operation.
+     * @returns The value associated with the key, or undefined if no such value exists.
+     */
+    async getWithTransaction(key, transaction) {
         return new Promise((resolve, reject) => {
-            const transaction = db.transaction([APP_NAMESPACE_STORE], 'readonly');
             const objectStore = transaction.objectStore(APP_NAMESPACE_STORE);
             const compositeKey = this.createCompositeKey(key);
             try {
@@ -968,10 +1046,16 @@ class Storage {
             }
         });
     }
-    async set(key, value) {
-        const db = await this.openDbPromise;
+    /**
+     * Sets a value in the database using the provided transaction.
+     *
+     * @param key The key of the value to set.
+     * @param value The value to set.
+     * @param transaction The transaction to use for the operation.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    async setWithTransaction(key, value, transaction) {
         return new Promise((resolve, reject) => {
-            const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite');
             const objectStore = transaction.objectStore(APP_NAMESPACE_STORE);
             const compositeKey = this.createCompositeKey(key);
             try {
@@ -993,6 +1077,16 @@ class Storage {
             }
         });
     }
+    async get(key) {
+        const db = await this.openDbPromise;
+        const transaction = db.transaction([APP_NAMESPACE_STORE], 'readonly');
+        return this.getWithTransaction(key, transaction);
+    }
+    async set(key, value) {
+        const db = await this.openDbPromise;
+        const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite');
+        return this.setWithTransaction(key, value, transaction);
+    }
     async delete(key) {
         const db = await this.openDbPromise;
         return new Promise((resolve, reject) => {
@@ -1056,6 +1150,9 @@ class StorageCache {
     getActiveConfig() {
         return this.activeConfig;
     }
+    getCustomSignals() {
+        return this.customSignals;
+    }
     /**
      * Read-ahead getter
      */
@@ -1063,6 +1160,7 @@ class StorageCache {
         const lastFetchStatusPromise = this.storage.getLastFetchStatus();
         const lastSuccessfulFetchTimestampMillisPromise = this.storage.getLastSuccessfulFetchTimestampMillis();
         const activeConfigPromise = this.storage.getActiveConfig();
+        const customSignalsPromise = this.storage.getCustomSignals();
         // Note:
         // 1. we consistently check for undefined to avoid clobbering defined values
         //   in memory
@@ -1081,6 +1179,10 @@ class StorageCache {
         if (activeConfig) {
             this.activeConfig = activeConfig;
         }
+        const customSignals = await customSignalsPromise;
+        if (customSignals) {
+            this.customSignals = customSignals;
+        }
     }
     /**
      * Write-through setters
@@ -1097,6 +1199,9 @@ class StorageCache {
         this.activeConfig = activeConfig;
         return this.storage.setActiveConfig(activeConfig);
     }
+    async setCustomSignals(customSignals) {
+        this.customSignals = await this.storage.setCustomSignals(customSignals);
+    }
 }
 
 /**
@@ -1244,5 +1349,6 @@ exports.getRemoteConfig = getRemoteConfig;
 exports.getString = getString;
 exports.getValue = getValue;
 exports.isSupported = isSupported;
+exports.setCustomSignals = setCustomSignals;
 exports.setLogLevel = setLogLevel;
 //# sourceMappingURL=index.cjs.js.map