feat: remoteConfig.fetchConfig can specify analyticsUserProperties

Fixes firebase#8662
derrickbeining · Dec 18, 2024 · 2f77e36 · 2f77e36
1 parent 46c91bc
commit 2f77e36
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 8 deletions.
diff --git a/.yarnrc b/.yarnrc
@@ -1,2 +1,7 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
 registry "https://registry.npmjs.org/"
 save-prefix ""
+yarn-path ".yarn/releases/yarn-1.22.11.cjs"
diff --git a/common/api-review/remote-config.api.md b/common/api-review/remote-config.api.md
@@ -13,10 +13,14 @@ export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
 export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
 
 // @public
-export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
+export function fetchAndActivate(remoteConfig: RemoteConfig, options?: {
+    analyticsUserProperties?: Record<string, unknown>;
+}): Promise<boolean>;
 
 // @public
-export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
+export function fetchConfig(remoteConfig: RemoteConfig, options?: {
+    analyticsUserProperties?: Record<string, unknown>;
+}): Promise<void>;
 
 // @public
 export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json
@@ -61,7 +61,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/src/index.d.ts",
+  "typings": "./dist/remote-config-public.d.ts",
   "nyc": {
     "extension": [
       ".ts"

diff --git a/packages/remote-config/src/api.ts b/packages/remote-config/src/api.ts
@@ -93,9 +93,13 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void> {
 /**
  * Fetches and caches configuration from the Remote Config service.
  * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param options - Additional configuration for the request
  * @public
  */
-export async function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
+export async function fetchConfig(
+  remoteConfig: RemoteConfig,
+  options?: { analyticsUserProperties?: Record<string, unknown> }
+): Promise<void> {
   const rc = getModularInstance(remoteConfig) as RemoteConfigImpl;
   // Aborts the request after the given timeout, causing the fetch call to
   // reject with an `AbortError`.
@@ -118,7 +122,8 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
   try {
     await rc._client.fetch({
       cacheMaxAgeMillis: rc.settings.minimumFetchIntervalMillis,
-      signal: abortSignal
+      signal: abortSignal,
+      body: { analyticsUserProperties: options?.analyticsUserProperties }
     });
 
     await rc._storageCache.setLastFetchStatus('success');

diff --git a/packages/remote-config/src/api2.ts b/packages/remote-config/src/api2.ts
@@ -37,10 +37,11 @@ import {
  * @public
  */
 export async function fetchAndActivate(
-  remoteConfig: RemoteConfig
+  remoteConfig: RemoteConfig,
+  options?: { analyticsUserProperties?: Record<string, unknown> }
 ): Promise<boolean> {
   remoteConfig = getModularInstance(remoteConfig);
-  await fetchConfig(remoteConfig);
+  await fetchConfig(remoteConfig, options);
   return activate(remoteConfig);
 }
 

diff --git a/packages/remote-config/src/client/remote_config_fetch_client.ts b/packages/remote-config/src/client/remote_config_fetch_client.ts
@@ -99,6 +99,11 @@ export interface FetchRequest {
    * <p>Comparable to passing `headers = { 'If-None-Match': <eTag> }` to the native Fetch API.
    */
   eTag?: string;
+
+  /**
+   * Appends the request body with any key-value pairs you define
+   */
+  body?: Record<string, unknown>;
 }
 
 /**

diff --git a/packages/remote-config/src/client/rest_client.ts b/packages/remote-config/src/client/rest_client.ts
@@ -92,8 +92,9 @@ export class RestClient implements RemoteConfigFetchClient {
       app_instance_id: installationId,
       app_instance_id_token: installationToken,
       app_id: this.appId,
-      language_code: getUserLanguage()
+      language_code: getUserLanguage(),
       /* eslint-enable camelcase */
+      ...(request.body || {})
     };
 
     const options = {