@react-native-firebase/remote-config 21.7.4 → 21.8.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [21.8.0](https://github.com/invertase/react-native-firebase/compare/v21.7.4...v21.8.0) (2025-02-10)
+
+### Features
+
+- **remote-config:** support for custom signals ([#8274](https://github.com/invertase/react-native-firebase/issues/8274)) ([94c6a27](https://github.com/invertase/react-native-firebase/commit/94c6a27e6692138cd32394218a492d17d68de0f0))
+
+### Bug Fixes
+
+- do not ship unit tests in released packages ([e71dadf](https://github.com/invertase/react-native-firebase/commit/e71dadfc1c0cad2e89c94100913af31ddf7d9c91))
+
 ## [21.7.4](https://github.com/invertase/react-native-firebase/compare/v21.7.3...v21.7.4) (2025-02-08)
 
 ### Bug Fixes

package/android/src/main/java/io/invertase/firebase/config/UniversalFirebaseConfigModule.java

@@ -25,8 +25,10 @@ import android.content.res.Resources;
 import android.content.res.XmlResourceParser;
 import android.os.Bundle;
 import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
+import com.google.firebase.remoteconfig.CustomSignals;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfig;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigInfo;
 import com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings;
@@ -199,6 +201,40 @@ public class UniversalFirebaseConfigModule extends UniversalFirebaseModule {
     return convertedConfigBundle;
   }
 
+  Task<Void> setCustomSignals(String appName, HashMap<String, Object> customSignalsMap) {
+    TaskCompletionSource<Void> taskCompletionSource = new TaskCompletionSource<>();
+
+    FirebaseApp firebaseApp = FirebaseApp.getInstance(appName);
+
+    getExecutor().execute(
+      () -> {
+        try {
+          CustomSignals.Builder customSignals = new CustomSignals.Builder();
+          for (Map.Entry<String, Object> entry : customSignalsMap.entrySet()) {
+            Object value = entry.getValue();
+            if (value instanceof String) {
+              customSignals.put(entry.getKey(), (String) value);
+            } else if (value instanceof Long) {
+              customSignals.put(entry.getKey(), (Long) value);
+            } else if (value instanceof Integer) {
+              customSignals.put(entry.getKey(), ((Integer) value).longValue());
+            } else if (value instanceof Double) {
+              customSignals.put(entry.getKey(), (Double) value);
+            } else if (value == null) {
+              customSignals.put(entry.getKey(), null);
+            }
+          }
+
+          Tasks.await(FirebaseRemoteConfig.getInstance(firebaseApp).setCustomSignals(customSignals.build()));
+          taskCompletionSource.setResult(null);
+        } catch (Exception e) {
+          taskCompletionSource.setException(e);
+        }
+      });
+
+    return taskCompletionSource.getTask();
+  }
+
   public Map<String, Object> getConstantsForApp(String appName) {
     Map<String, Object> appConstants = new HashMap<>();
     FirebaseRemoteConfigInfo remoteConfigInfo =

package/android/src/reactnative/java/io/invertase/firebase/config/ReactNativeFirebaseConfigModule.java

@@ -255,6 +255,20 @@ public class ReactNativeFirebaseConfigModule extends ReactNativeFirebaseModule {
     }
   }
 
+  @ReactMethod
+  public void setCustomSignals(String appName, ReadableMap customSignals, Promise promise) {
+    module
+      .setCustomSignals(appName, customSignals.toHashMap())
+      .addOnCompleteListener(
+        task -> {
+          if (task.isSuccessful()) {
+            promise.resolve(resultWithConstants(task.getResult()));
+          } else {
+            rejectPromiseWithExceptionMap(promise, task.getException());
+          }
+        });
+  }
+
   private WritableMap resultWithConstants(Object result) {
     Map<String, Object> responseMap = new HashMap<>(2);
     responseMap.put("result", result);

package/ios/RNFBConfig/RNFBConfigModule.m

@@ -305,6 +305,24 @@ RCT_EXPORT_METHOD(removeConfigUpdateRegistration : (FIRApp *)firebaseApp) {
   }
 }
 
+RCT_EXPORT_METHOD(setCustomSignals
+                  : (FIRApp *)firebaseApp
+                  : (NSDictionary *)customSignals
+                  : (RCTPromiseResolveBlock)resolve
+                  : (RCTPromiseRejectBlock)reject) {
+  [[FIRRemoteConfig remoteConfigWithApp:firebaseApp]
+      setCustomSignals:customSignals
+        withCompletion:^(NSError *_Nullable error) {
+          if (error != nil) {
+            [RNFBSharedUtils rejectPromiseWithNSError:reject error:error];
+          } else {
+            resolve(nil);
+          }
+        }];
+
+  resolve([self resultWithConstants:[NSNull null] firebaseApp:firebaseApp]);
+}
+
 #pragma mark -
 #pragma mark Internal Helper Methods
 

package/lib/modular/index.d.ts

@@ -207,3 +207,26 @@ export function onConfigUpdated(
   remoteConfig: RemoteConfig,
   callback: (config: ConfigValues) => void,
 ): () => void;
+
+/**
+ * Defines the type for representing custom signals and their values.
+ * The values in CustomSignals must be one of the following types: string, number, or null.
+ * There are additional limitations on key and value length, for a full description see https://firebase.google.com/docs/remote-config/parameters?template_type=client#custom_signal_conditions
+ * Failing to stay within these limitations will result in a silent API failure with only a warning in device logs
+ */
+
+export interface CustomSignals {
+  [key: string]: string | number | null;
+}
+
+/**
+ * Sets the custom signals for the app instance.
+ * @param {RemoteConfig} remoteConfig - RemoteConfig instance
+ * @param {CustomSignals} customSignals - CustomSignals
+ * @returns {Promise<void>}
+ */
+
+export declare function setCustomSignals(
+  remoteConfig: RemoteConfig,
+  customSignals: CustomSignals,
+): Promise<void>;

package/lib/modular/index.js

@@ -26,6 +26,7 @@ import { getApp } from '@react-native-firebase/app';
  * @typedef {import('..').FirebaseRemoteConfigTypes.ConfigValues} ConfigValues
  * @typedef {import('..').FirebaseRemoteConfigTypes.LastFetchStatusType} LastFetchStatusType
  * @typedef {import('..').FirebaseRemoteConfigTypes.RemoteConfigLogLevel} RemoteConfigLogLevel
+ * @typedef {import('.').CustomSignals} CustomSignals
  */
 
 /**
@@ -243,3 +244,20 @@ export function setDefaultsFromResource(remoteConfig, resourceName) {
 export function onConfigUpdated(remoteConfig, callback) {
   return remoteConfig.onConfigUpdated(callback);
 }
+
+/**
+ * Sets the custom signals for the app instance.
+ * @param {RemoteConfig} remoteConfig - RemoteConfig instance
+ * @param {CustomSignals} customSignals - CustomSignals
+ * @returns {Promise<void>}
+ */
+export async function setCustomSignals(remoteConfig, customSignals) {
+  for (const [key, value] of Object.entries(customSignals)) {
+    if (typeof value !== 'string' && typeof value !== 'number' && value !== null) {
+      throw new Error(
+        `firebase.remoteConfig().setCustomSignals(): Invalid type for custom signal '${key}': ${typeof value}. Expected 'string', 'number', or 'null'.`,
+      );
+    }
+  }
+  return remoteConfig._promiseWithConstants(remoteConfig.native.setCustomSignals(customSignals));
+}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '21.7.4';
+module.exports = '21.8.0';

package/lib/web/RNFBConfigModule.js

@@ -7,6 +7,7 @@ import {
   fetchConfig,
   getAll,
   makeIDBAvailable,
+  setCustomSignals,
 } from '@react-native-firebase/app/lib/internal/web/firebaseRemoteConfig';
 import { guard } from '@react-native-firebase/app/lib/internal/web/utils';
 
@@ -113,4 +114,11 @@ export default {
       return resultAndConstants(remoteConfig, null);
     });
   },
+  setCustomSignals(appName, customSignals) {
+    return guard(async () => {
+      const remoteConfig = getRemoteConfigInstanceForApp(appName);
+      await setCustomSignals(remoteConfig, customSignals);
+      return resultAndConstants(remoteConfig, null);
+    });
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/remote-config",
-  "version": "21.7.4",
+  "version": "21.8.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration with Remote Config, allowing you to change the appearance and/or functionality of your app without requiring an app update.",
   "main": "lib/index.js",
@@ -24,11 +24,11 @@
     "remote-config"
   ],
   "peerDependencies": {
-    "@react-native-firebase/analytics": "21.7.4",
-    "@react-native-firebase/app": "21.7.4"
+    "@react-native-firebase/analytics": "21.8.0",
+    "@react-native-firebase/app": "21.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "82c4c7391fee6597726e5363d78400f11a644e47"
+  "gitHead": "14ebd5c2d2e0f284397c331f909e533c47f2ec62"
 }

package/__tests__/remote-config.test.ts

@@ -1,220 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-import { describe, expect, it } from '@jest/globals';
-
-import {
-  firebase,
-  getRemoteConfig,
-  activate,
-  ensureInitialized,
-  fetchAndActivate,
-  fetchConfig,
-  getAll,
-  getBoolean,
-  getNumber,
-  getString,
-  getValue,
-  setLogLevel,
-  isSupported,
-  fetchTimeMillis,
-  settings,
-  lastFetchStatus,
-  reset,
-  setConfigSettings,
-  fetch,
-  setDefaults,
-  setDefaultsFromResource,
-  onConfigUpdated,
-} from '../lib';
-
-describe('remoteConfig()', function () {
-  describe('namespace', function () {
-    it('accessible from firebase.app()', function () {
-      const app = firebase.app();
-      expect(app.remoteConfig()).toBeDefined();
-      expect(app.remoteConfig().app).toEqual(app);
-    });
-
-    it('supports multiple apps', async function () {
-      expect(firebase.remoteConfig().app.name).toEqual('[DEFAULT]');
-      expect(firebase.app('secondaryFromNative').remoteConfig().app.name).toEqual(
-        'secondaryFromNative',
-      );
-    });
-  });
-
-  describe('statics', function () {
-    it('LastFetchStatus', function () {
-      expect(firebase.remoteConfig.LastFetchStatus).toBeDefined();
-      expect(firebase.remoteConfig.LastFetchStatus.FAILURE).toEqual('failure');
-      expect(firebase.remoteConfig.LastFetchStatus.SUCCESS).toEqual('success');
-      expect(firebase.remoteConfig.LastFetchStatus.NO_FETCH_YET).toEqual('no_fetch_yet');
-      expect(firebase.remoteConfig.LastFetchStatus.THROTTLED).toEqual('throttled');
-    });
-
-    it('ValueSource', function () {
-      expect(firebase.remoteConfig.ValueSource).toBeDefined();
-      expect(firebase.remoteConfig.ValueSource.REMOTE).toEqual('remote');
-      expect(firebase.remoteConfig.ValueSource.STATIC).toEqual('static');
-      expect(firebase.remoteConfig.ValueSource.DEFAULT).toEqual('default');
-    });
-  });
-
-  describe('fetch()', function () {
-    it('it throws if expiration is not a number', function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().fetch('foo');
-      }).toThrow('must be a number value');
-    });
-  });
-
-  describe('setConfigSettings()', function () {
-    it('it throws if arg is not an object', async function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().setConfigSettings('not an object');
-      }).toThrow('must set an object');
-    });
-
-    it('throws if minimumFetchIntervalMillis is not a number', async function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().setConfigSettings({ minimumFetchIntervalMillis: 'potato' });
-      }).toThrow('must be a number type in milliseconds.');
-    });
-
-    it('throws if fetchTimeMillis is not a number', function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().setConfigSettings({ fetchTimeMillis: 'potato' });
-      }).toThrow('must be a number type in milliseconds.');
-    });
-  });
-
-  describe('setDefaults()', function () {
-    it('it throws if defaults object not provided', function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().setDefaults('not an object');
-      }).toThrow('must be an object.');
-    });
-  });
-
-  describe('setDefaultsFromResource()', function () {
-    it('throws if resourceName is not a string', function () {
-      expect(() => {
-        // @ts-ignore - incorrect argument on purpose to check validation
-        firebase.remoteConfig().setDefaultsFromResource(1337);
-      }).toThrow('must be a string value');
-    });
-  });
-
-  describe('getAll() should not crash', function () {
-    it('should return an empty object pre-fetch, pre-defaults', function () {
-      const config = firebase.remoteConfig().getAll();
-      expect(config).toBeDefined();
-      expect(config).toEqual({});
-    });
-  });
-
-  describe('modular', function () {
-    it('`getRemoteConfig` function is properly exposed to end user', function () {
-      expect(getRemoteConfig).toBeDefined();
-    });
-
-    it('`activate` function is properly exposed to end user', function () {
-      expect(activate).toBeDefined();
-    });
-
-    it('`ensureInitialized` function is properly exposed to end user', function () {
-      expect(ensureInitialized).toBeDefined();
-    });
-
-    it('`fetchAndActivate` function is properly exposed to end user', function () {
-      expect(fetchAndActivate).toBeDefined();
-    });
-
-    it('`fetchConfig` function is properly exposed to end user', function () {
-      expect(fetchConfig).toBeDefined();
-    });
-
-    it('`getAll` function is properly exposed to end user', function () {
-      expect(getAll).toBeDefined();
-    });
-
-    it('`getBoolean` function is properly exposed to end user', function () {
-      expect(getBoolean).toBeDefined();
-    });
-
-    it('`getNumber` function is properly exposed to end user', function () {
-      expect(getNumber).toBeDefined();
-    });
-
-    it('`getString` function is properly exposed to end user', function () {
-      expect(getString).toBeDefined();
-    });
-
-    it('`getValue` function is properly exposed to end user', function () {
-      expect(getValue).toBeDefined();
-    });
-
-    it('`setLogLevel` function is properly exposed to end user', function () {
-      expect(setLogLevel).toBeDefined();
-    });
-
-    it('`isSupported` function is properly exposed to end user', function () {
-      expect(isSupported).toBeDefined();
-    });
-
-    it('`fetchTimeMillis` function is properly exposed to end user', function () {
-      expect(fetchTimeMillis).toBeDefined();
-    });
-
-    it('`settings` function is properly exposed to end user', function () {
-      expect(settings).toBeDefined();
-    });
-
-    it('`lastFetchStatus` function is properly exposed to end user', function () {
-      expect(lastFetchStatus).toBeDefined();
-    });
-
-    it('`reset` function is properly exposed to end user', function () {
-      expect(reset).toBeDefined();
-    });
-
-    it('`setConfigSettings` function is properly exposed to end user', function () {
-      expect(setConfigSettings).toBeDefined();
-    });
-
-    it('`fetch` function is properly exposed to end user', function () {
-      expect(fetch).toBeDefined();
-    });
-
-    it('`setDefaults` function is properly exposed to end user', function () {
-      expect(setDefaults).toBeDefined();
-    });
-
-    it('`setDefaultsFromResource` function is properly exposed to end user', function () {
-      expect(setDefaultsFromResource).toBeDefined();
-    });
-
-    it('`onConfigUpdated` function is properly exposed to end user', function () {
-      expect(onConfigUpdated).toBeDefined();
-    });
-  });
-});