Add error handling

Author: Athira M

packages/remote-config/src/abt/experiment.ts

@@ -19,13 +19,19 @@ import { FirebaseExperimentDescription } from '../public_types';
 import { Provider } from '@firebase/component';
 import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
 import { Logger } from '@firebase/logger';
+import { RemoteConfig } from '../remote_config';
+import { ERROR_FACTORY, ErrorCode } from '../errors';
 
 export class Experiment {
-  constructor(
-    private readonly storage: Storage,
-    private readonly logger: Logger,
-    private readonly analyticsProvider: Provider<FirebaseAnalyticsInternalName>
-  ) {}
+  private storage: Storage;
+  private logger: Logger;
+  private analyticsProvider: Provider<FirebaseAnalyticsInternalName>;
+
+  constructor(rc: RemoteConfig) {
+    this.storage = rc._storage;
+    this.logger = rc._logger;
+    this.analyticsProvider = rc._analyticsProvider;
+  }
 
   async updateActiveExperiments(
     latestExperiments: FirebaseExperimentDescription[]
@@ -58,7 +64,7 @@ export class Experiment {
         customProperty[experimentId] = experimentInfo.variantId;
       }
     }
-    void this.addExperimentToAnalytics(customProperty);
+    this.addExperimentToAnalytics(customProperty);
   }
 
   private removeInactiveExperiments(
@@ -71,22 +77,29 @@ export class Experiment {
         customProperty[experimentId] = null;
       }
     }
-    void this.addExperimentToAnalytics(customProperty);
+    this.addExperimentToAnalytics(customProperty);
   }
 
-  private async addExperimentToAnalytics(
+  private addExperimentToAnalytics(
     customProperty: Record<string, string | null>
-  ): Promise<void> {
+  ): void {
+    if (Object.keys(customProperty).length === 0) {
+      return;
+    }
     try {
       const analytics = this.analyticsProvider.getImmediate({ optional: true });
       if (analytics) {
         analytics.setUserProperties({ properties: customProperty });
       } else {
+        // TODO: Update warning message
         this.logger.warn(`Analytics is not imported correctly`);
       }
     } catch (error) {
+      // TODO: Update error message
       this.logger.error(`Failed to add experiment to analytics : ${error}`);
-      return;
+      throw ERROR_FACTORY.create(ErrorCode.ANALYTICS_UNAVAILABLE, {
+        originalErrorMessage: (error as Error)?.message
+      });
     }
   }
 }

packages/remote-config/src/api.ts

@@ -111,11 +111,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise<boolean> {
     // config.
     return false;
   }
-  const experiment = new Experiment(
-    rc._storage,
-    rc._logger,
-    rc._analyticsProvider
-  );
+  const experiment = new Experiment(rc);
   const updateActiveExperiments = lastSuccessfulFetchResponse.experiments
     ? experiment.updateActiveExperiments(
         lastSuccessfulFetchResponse.experiments

packages/remote-config/src/errors.ts

@@ -37,7 +37,8 @@ export const enum ErrorCode {
   CONFIG_UPDATE_STREAM_ERROR = 'stream-error',
   CONFIG_UPDATE_UNAVAILABLE = 'realtime-unavailable',
   CONFIG_UPDATE_MESSAGE_INVALID = 'update-message-invalid',
-  CONFIG_UPDATE_NOT_FETCHED = 'update-not-fetched'
+  CONFIG_UPDATE_NOT_FETCHED = 'update-not-fetched',
+  ANALYTICS_UNAVAILABLE = 'analytics-unavailable'
 }
 
 const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
@@ -84,7 +85,9 @@ const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
   [ErrorCode.CONFIG_UPDATE_MESSAGE_INVALID]:
     'The stream invalidation message was unparsable: {$originalErrorMessage}',
   [ErrorCode.CONFIG_UPDATE_NOT_FETCHED]:
-    'Unable to fetch the latest config: {$originalErrorMessage}'
+    'Unable to fetch the latest config: {$originalErrorMessage}',
+  [ErrorCode.ANALYTICS_UNAVAILABLE]:
+    'Connection to firebase analytics failed: {$originalErrorMessage}'
 };
 
 // Note this is effectively a type system binding a code to params. This approach overlaps with the
@@ -108,6 +111,7 @@ interface ErrorParams {
   [ErrorCode.CONFIG_UPDATE_UNAVAILABLE]: { originalErrorMessage: string };
   [ErrorCode.CONFIG_UPDATE_MESSAGE_INVALID]: { originalErrorMessage: string };
   [ErrorCode.CONFIG_UPDATE_NOT_FETCHED]: { originalErrorMessage: string };
+  [ErrorCode.ANALYTICS_UNAVAILABLE]: { originalErrorMessage: string };
 }
 
 export const ERROR_FACTORY = new ErrorFactory<ErrorCode, ErrorParams>(

packages/remote-config/test/abt/experiment.test.ts

@@ -23,12 +23,18 @@ import { Storage } from '../../src/storage/storage';
 import { Provider } from '@firebase/component';
 import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
 import { Logger } from '@firebase/logger';
+import { RemoteConfig } from '../../src/remote_config';
 
 describe('Experiment', () => {
   const storage = {} as Storage;
   const analyticsProvider = {} as Provider<FirebaseAnalyticsInternalName>;
   const logger = {} as Logger;
-  const experiment = new Experiment(storage, logger, analyticsProvider);
+  const rc = {
+    _storage: storage,
+    _analyticsProvider: analyticsProvider,
+    _logger: logger
+  } as RemoteConfig;
+  const experiment = new Experiment(rc);
 
   describe('updateActiveExperiments', () => {
     beforeEach(() => {