fixing yarn lint errors

Author: Samruddhi90

docs-devsite/remote-config.fetchresponse.md

@@ -27,6 +27,7 @@ export interface FetchResponse
 |  [config](./remote-config.fetchresponse.md#fetchresponseconfig) | [FirebaseRemoteConfigObject](./remote-config.firebaseremoteconfigobject.md#firebaseremoteconfigobject_interface) | Defines the map of parameters returned as "entries" in the fetch response body.<p>Only defined for 200 responses. |
 |  [eTag](./remote-config.fetchresponse.md#fetchresponseetag) | string | Defines the ETag response header value.<p>Only defined for 200 and 304 responses. |
 |  [status](./remote-config.fetchresponse.md#fetchresponsestatus) | number | The HTTP status, which is useful for differentiating success responses with data from those without.<p>The Remote Config client is modeled after the native <code>Fetch</code> interface, so HTTP status is first-class.<p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the HTTP status code. The former is normalized into the latter. |
+|  [templateVersion](./remote-config.fetchresponse.md#fetchresponsetemplateversion) | number | The version number of the config template fetched from the server. |
 
 ## FetchResponse.config
 
@@ -65,3 +66,13 @@ The HTTP status, which is useful for differentiating success responses with data
 ```typescript
 status: number;
 ```
+
+## FetchResponse.templateVersion
+
+The version number of the config template fetched from the server.
+
+<b>Signature:</b>
+
+```typescript
+templateVersion?: number;
+```

docs-devsite/remote-config.md

@@ -53,6 +53,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 |  Type Alias | Description |
 |  --- | --- |
 |  [FetchStatus](./remote-config.md#fetchstatus) | Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.<ul> <li>"no-fetch-yet" indicates the [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.</li> <li>"success" indicates the last attempt succeeded.</li> <li>"failure" indicates the last attempt failed.</li> <li>"throttle" indicates the last attempt was rate-limited.</li> </ul> |
+|  [FetchType](./remote-config.md#fetchtype) | Indicates the type of fetch request.<ul> <li>"BASE" indicates a standard fetch request.</li> <li>"REALTIME" indicates a fetch request triggered by a real-time update.</li> </ul> |
 |  [LogLevel](./remote-config.md#loglevel) | Defines levels of Remote Config logging. |
 |  [Unsubscribe](./remote-config.md#unsubscribe) | A function that unsubscribes from a real-time event stream. |
 |  [ValueSource](./remote-config.md#valuesource) | Indicates the source of a value.<ul> <li>"static" indicates the value was defined by a static constant.</li> <li>"default" indicates the value was defined by default config.</li> <li>"remote" indicates the value was defined by fetched config.</li> </ul> |
@@ -384,6 +385,18 @@ Summarizes the outcome of the last attempt to fetch config from the Firebase Rem
 export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
 ```
 
+## FetchType
+
+Indicates the type of fetch request.
+
+<ul> <li>"BASE" indicates a standard fetch request.</li> <li>"REALTIME" indicates a fetch request triggered by a real-time update.</li> </ul>
+
+<b>Signature:</b>
+
+```typescript
+export type FetchType = 'BASE' | 'REALTIME';
+```
+
 ## LogLevel
 
 Defines levels of Remote Config logging.

packages/remote-config/src/client/realtime_handler.ts

@@ -120,7 +120,7 @@ export class RealtimeHandler {
       backoffEndTimeMillis: backoffEndTime,
       numFailedStreams
     });
-    this.retryHttpConnectionWhenBackoffEnds();
+    await this.retryHttpConnectionWhenBackoffEnds();
   }
 
   /**
@@ -270,7 +270,7 @@ export class RealtimeHandler {
     if (fetchResponse.config != null && fetchResponse.templateVersion) {
       return fetchResponse.templateVersion >= lastKnownVersion;
     }
-    return this.storageCache.getLastFetchStatus() === 'success' ;
+    return this.storageCache.getLastFetchStatus() === 'success';
   }
 
   private parseAndValidateConfigUpdateMessage(message: string): string {
@@ -299,30 +299,23 @@ export class RealtimeHandler {
     newConfig: FirebaseRemoteConfigObject,
     oldConfig: FirebaseRemoteConfigObject
   ): Set<string> {
-    const changed = new Set<string>();
+    const changedKeys = new Set<string>();
     const newKeys = new Set(Object.keys(newConfig || {}));
     const oldKeys = new Set(Object.keys(oldConfig || {}));
 
     for (const key of newKeys) {
-      if (!oldKeys.has(key)) {
-        changed.add(key);
-        continue;
-      }
-      if (
-        JSON.stringify((newConfig as any)[key]) !==
-        JSON.stringify((oldConfig as any)[key])
-      ) {
-        changed.add(key);
-        continue;
+      if (!oldKeys.has(key) || newConfig[key] !== oldConfig[key]) {
+        changedKeys.add(key);
       }
     }
 
     for (const key of oldKeys) {
       if (!newKeys.has(key)) {
-        changed.add(key);
+        changedKeys.add(key);
       }
     }
-    return changed;
+
+    return changedKeys;
   }
 
   private async fetchLatestConfig(
@@ -337,12 +330,12 @@ export class RealtimeHandler {
         `Fetching config with custom signals: ${JSON.stringify(customSignals)}`
       );
     }
-    const abortSignal =new RemoteConfigAbortSignal();
+    const abortSignal = new RemoteConfigAbortSignal();
     try {
       const fetchRequest: FetchRequest = {
         cacheMaxAgeMillis: 0,
         signal: abortSignal,
-        customSignals: customSignals,
+        customSignals,
         fetchType: 'REALTIME',
         fetchAttempt: currentAttempt
       };
@@ -471,7 +464,7 @@ export class RealtimeHandler {
           if (TEMPLATE_VERSION_KEY in jsonObject) {
             const oldTemplateVersion =
               await this.storage.getLastKnownTemplateVersion();
-            let targetTemplateVersion = Number(
+            const targetTemplateVersion = Number(
               jsonObject[TEMPLATE_VERSION_KEY]
             );
             if (
@@ -497,11 +490,12 @@ export class RealtimeHandler {
               retryIntervalSeconds
             );
           }
-        } catch (e: any) {
+        } catch (e: unknown) {
           this.logger.error('Unable to parse latest config update message.', e);
+          const errorMessage = e instanceof Error ? e.message : String(e);
           this.propagateError(
             ERROR_FACTORY.create(ErrorCode.CONFIG_UPDATE_MESSAGE_INVALID, {
-              originalErrorMessage: e
+              originalErrorMessage: errorMessage
             })
           );
         }
@@ -510,7 +504,7 @@ export class RealtimeHandler {
     }
   }
 
-  public async listenForNotifications(
+  private async listenForNotifications(
     reader: ReadableStreamDefaultReader
   ): Promise<void> {
     try {
@@ -521,15 +515,14 @@ export class RealtimeHandler {
       if (!this.isInBackground) {
         // Otherwise, the real-time server connection was closed due to a transient issue.
         this.logger.debug(
-          'Real-time connection was closed due to an exception.',
-          e
+          'Real-time connection was closed due to an exception.'
         );
       }
     } finally {
       // Only need to close the reader, beginRealtimeHttpStream will disconnect
       // the connection
       if (this.reader) {
-        this.reader.cancel();
+        void this.reader.cancel();
         this.reader = undefined;
       }
     }

packages/remote-config/src/client/rest_client.ts

@@ -163,8 +163,8 @@ export class RestClient implements RemoteConfigFetchClient {
       state = responseBody['state'];
       templateVersion = responseBody['templateVersion'];
 
-      if (templateVersion != undefined) {
-        this.storage.setLastKnownTemplateVersion(templateVersion);
+      if (templateVersion !== undefined) {
+        await this.storage.setLastKnownTemplateVersion(templateVersion);
       }
     }
 

packages/remote-config/src/public_types.ts

@@ -52,6 +52,8 @@ export interface RemoteConfig {
 
 /**
  * Defines a self-descriptive reference for config key-value pairs.
+ *
+ *  @public
  */
 export interface FirebaseRemoteConfigObject {
   [key: string]: string;
@@ -62,6 +64,8 @@ export interface FirebaseRemoteConfigObject {
  *
  * <p>Modeled after the native `Response` interface, but simplified for Remote Config's
  * use case.
+ *
+ * @public
  */
 export interface FetchResponse {
   /**

packages/remote-config/test/client/rest_client.test.ts

@@ -26,6 +26,7 @@ import {
   FetchRequest,
   RemoteConfigAbortSignal
 } from '../../src/client/remote_config_fetch_client';
+import { Storage } from '../../src/storage/storage';
 
 const DEFAULT_REQUEST: FetchRequest = {
   cacheMaxAgeMillis: 1,
@@ -34,6 +35,7 @@ const DEFAULT_REQUEST: FetchRequest = {
 
 describe('RestClient', () => {
   const firebaseInstallations = {} as FirebaseInstallations;
+  const storage = {} as Storage;
   let client: RestClient;
 
   beforeEach(() => {
@@ -43,14 +45,16 @@ describe('RestClient', () => {
       'namespace',
       'project-id',
       'api-key',
-      'app-id'
+      'app-id',
+      storage
     );
     firebaseInstallations.getId = sinon
       .stub()
       .returns(Promise.resolve('fis-id'));
     firebaseInstallations.getToken = sinon
       .stub()
       .returns(Promise.resolve('fis-token'));
+    storage.setLastKnownTemplateVersion = sinon.stub();
   });
 
   describe('fetch', () => {
@@ -74,7 +78,8 @@ describe('RestClient', () => {
         status: 200,
         eTag: 'etag',
         state: 'UPDATE',
-        entries: { color: 'sparkling' }
+        entries: { color: 'sparkling' },
+        templateVersion: 1
       };
 
       fetchStub.returns(
@@ -85,7 +90,8 @@ describe('RestClient', () => {
           json: () =>
             Promise.resolve({
               entries: expectedResponse.entries,
-              state: expectedResponse.state
+              state: expectedResponse.state,
+              templateVersion: expectedResponse.templateVersion
             })
         } as Response)
       );
@@ -95,7 +101,8 @@ describe('RestClient', () => {
       expect(response).to.deep.eq({
         status: expectedResponse.status,
         eTag: expectedResponse.eTag,
-        config: expectedResponse.entries
+        config: expectedResponse.entries,
+        templateVersion: expectedResponse.templateVersion
       });
     });
 
@@ -184,7 +191,8 @@ describe('RestClient', () => {
       expect(response).to.deep.eq({
         status: 304,
         eTag: 'response-etag',
-        config: undefined
+        config: undefined,
+        templateVersion: undefined
       });
     });
 
@@ -222,7 +230,8 @@ describe('RestClient', () => {
       expect(response).to.deep.eq({
         status: 304,
         eTag: 'etag',
-        config: undefined
+        config: undefined,
+        templateVersion: undefined
       });
     });
 
@@ -239,7 +248,8 @@ describe('RestClient', () => {
         await expect(client.fetch(DEFAULT_REQUEST)).to.eventually.be.deep.eq({
           status: 200,
           eTag: 'etag',
-          config: {}
+          config: {},
+          templateVersion: undefined
         });
       }
     });