Add unit test + improve public API documentation

- Removed changes to firebase/compat and
remote-config-compat packages.

Author: ashish-kothari

common/api-review/remote-config.api.md

@@ -12,7 +12,7 @@ export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
 // @public
 export interface CustomSignals {
     // (undocumented)
-    [key: string]: string | number;
+    [key: string]: string | number | null;
 }
 
 // @public

docs-devsite/remote-config.customsignals.md

@@ -14,7 +14,7 @@ Defines the type for representing custom signals and their values.
 
 <p>The values in CustomSignals must be one of the following types:
 
-<ul> <li><code>string</code> <li><code>number</code> </ul>
+<ul> <li><code>string</code> <li><code>number</code> <li><code>null</code> </ul>
 
 <b>Signature:</b>
 

docs-devsite/remote-config.md

@@ -37,7 +37,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 
 |  Interface | Description |
 |  --- | --- |
-|  [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Defines the type for representing custom signals and their values.<p>The values in CustomSignals must be one of the following types:<ul> <li><code>string</code> <li><code>number</code> </ul> |
+|  [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Defines the type for representing custom signals and their values.<p>The values in CustomSignals must be one of the following types:<ul> <li><code>string</code> <li><code>number</code> <li><code>null</code> </ul> |
 |  [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The Firebase Remote Config service interface. |
 |  [RemoteConfigSettings](./remote-config.remoteconfigsettings.md#remoteconfigsettings_interface) | Defines configuration options for the Remote Config SDK. |
 |  [Value](./remote-config.value.md#value_interface) | Wraps a value with metadata and type-safe getters. |
@@ -293,7 +293,7 @@ export declare function setCustomSignals(remoteConfig: RemoteConfig, customSigna
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  remoteConfig | [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) instance. |
-|  customSignals | [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Map (key, value) of the custom signals to be set for the app instance. |
+|  customSignals | [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | 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 null unsets the signal. The signals will be persisted locally on the client. |
 
 <b>Returns:</b>
 

packages/firebase/compat/index.d.ts

@@ -1971,11 +1971,6 @@ declare namespace firebase.remoteConfig {
      * Defines the log level to use.
      */
     setLogLevel(logLevel: LogLevel): void;
-
-    /**
-     * Sets custom signals for the Remote Config instance.
-     */
-    setCustomSignals(customSignals: CustomSignals): Promise<void>;
   }
 
   /**
@@ -2052,18 +2047,6 @@ declare namespace firebase.remoteConfig {
    */
   export type LogLevel = 'debug' | 'error' | 'silent';
 
-  /**
-   * Defines the type for representing custom signals and their values.
-   *
-   * <p>The values in CustomSignals must be one of the following types:
-   *
-   * <ul>
-   *   <li><code>string</code>
-   *   <li><code>number</code>
-   * </ul>
-   */
-  export type CustomSignals = { [key: string]: string | number };
-
   /**
    * This method provides two different checks:
    *

packages/remote-config-compat/src/remoteConfig.test.ts

@@ -157,17 +157,4 @@ describe('Remote Config Compat', () => {
       'debug'
     );
   });
-
-  it('setCustomSignals() calls modular setCustomSignals()', async () => {
-    const modularSetCustomSignalsStub = stub(
-      modularApi,
-      'setCustomSignals'
-    ).callsFake(() => Promise.resolve());
-    await remoteConfig.setCustomSignals({ 'customSignal': 'value' });
-
-    expect(modularSetCustomSignalsStub).to.have.been.calledWithExactly(
-      fakeModularRemoteConfig,
-      { 'customSignal': 'value' }
-    );
-  });
 });

packages/remote-config-compat/src/remoteConfig.ts

@@ -21,8 +21,7 @@ import {
   FetchStatus as FetchSTatusCompat,
   Settings as SettingsCompat,
   LogLevel as RemoteConfigLogLevel,
-  RemoteConfig as RemoteConfigCompat,
-  CustomSignals as RemoteConfigCustomSignals
+  RemoteConfig as RemoteConfigCompat
 } from '@firebase/remote-config-types';
 import {
   RemoteConfig,
@@ -36,8 +35,7 @@ import {
   getNumber,
   getString,
   getValue,
-  isSupported,
-  setCustomSignals
+  isSupported
 } from '@firebase/remote-config';
 
 export { isSupported };
@@ -117,8 +115,4 @@ export class RemoteConfigCompatImpl
   setLogLevel(logLevel: RemoteConfigLogLevel): void {
     setLogLevel(this._delegate, logLevel);
   }
-
-  setCustomSignals(customSignals: RemoteConfigCustomSignals): Promise<void> {
-    return setCustomSignals(this._delegate, customSignals);
-  }
 }

packages/remote-config-types/index.d.ts

@@ -97,11 +97,6 @@ export interface RemoteConfig {
    * Defines the log level to use.
    */
   setLogLevel(logLevel: LogLevel): void;
-
-  /**
-   * Sets custom signals for the Remote Config instance.
-   */
-  setCustomSignals(customSignals: CustomSignals): Promise<void>;
 }
 
 /**
@@ -186,9 +181,10 @@ export type LogLevel = 'debug' | 'error' | 'silent';
  * <ul>
  *   <li><code>string</code>
  *   <li><code>number</code>
+ *   <li><code>null</code>
  * </ul>
  */
-export type CustomSignals = { [key: string]: string | number };
+export type CustomSignals = { [key: string]: string | number | null };
 
 declare module '@firebase/component' {
   interface NameServiceMapping {

packages/remote-config/src/api.ts

@@ -265,7 +265,9 @@ function getAllKeys(obj1: {} = {}, obj2: {} = {}): string[] {
  * 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.
+ * @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 null unsets
+ * the signal. The signals will be persisted locally on the client.
  *
  * @public
  */

packages/remote-config/src/public_types.ts

@@ -142,12 +142,13 @@ export type LogLevel = 'debug' | 'error' | 'silent';
  * <ul>
  *   <li><code>string</code>
  *   <li><code>number</code>
+ *   <li><code>null</code>
  * </ul>
  *
  * @public
  */
 export interface CustomSignals {
-  [key: string]: string | number;
+  [key: string]: string | number | null;
 }
 
 declare module '@firebase/component' {

packages/remote-config/test/storage/storage.test.ts

@@ -140,4 +140,17 @@ describe('Storage', () => {
 
     expect(storedCustomSignals).to.deep.eq(updatedSignals);
   });
+
+  it('deletes custom signal when value supplied is null', async () => {
+    const customSignals = { key: 'value', key1: 'value1' };
+    const updatedSignals = { key: 'value' };
+
+    await storage.setCustomSignals(customSignals);
+
+    await storage.setCustomSignals({ key1: null });
+
+    const storedCustomSignals = await storage.getCustomSignals();
+
+    expect(storedCustomSignals).to.deep.eq(updatedSignals);
+  });
 });