Integrate ABT with Firebase analytics to add experiment as UP

Author: Athira M

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

@@ -22,7 +22,7 @@ import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types
 export class Experiment {
   constructor(
     private readonly storage: Storage,
-    private readonly analytics: Provider<FirebaseAnalyticsInternalName>
+    private readonly analyticsProvider: Provider<FirebaseAnalyticsInternalName>
   ) {}
 
   async updateActiveExperiments(
@@ -68,14 +68,18 @@ export class Experiment {
     }
   }
 
-  private addExperimentToAnalytics(
-    _experimentId: string,
-    _variantId: string
-  ): void {
-    // TODO
+  private async addExperimentToAnalytics(
+    experimentId: string,
+    variantId: string|null
+  ): Promise<void> {
+    const analytics = await this.analyticsProvider.get();
+    const customProperty = {
+      [experimentId]: variantId,
+    };
+    analytics.setUserProperties({properties: customProperty});
   }
 
-  private removeExperimentFromAnalytics(_experimentId: string): void {
-    // TODO
+  private async removeExperimentFromAnalytics(experimentId: string): Promise<void> {
+    this.addExperimentToAnalytics(experimentId, null);
   }
 }

packages/remote-config/src/api.ts

@@ -111,7 +111,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise<boolean> {
     // config.
     return false;
   }
-  const experiment = new Experiment(rc._storage);
+  const experiment = new Experiment(rc._storage, rc._analyticsProvider);
   await Promise.all([
     rc._storageCache.setActiveConfig(lastSuccessfulFetchResponse.config),
     rc._storage.setActiveConfigEtag(lastSuccessfulFetchResponse.eTag),

packages/remote-config/src/register.ts

@@ -66,7 +66,7 @@ export function registerRemoteConfig(): void {
     const installations = container
       .getProvider('installations-internal')
       .getImmediate();
-    const analytics = container.getProvider('analytics-internal');
+    const analyticsProvider = container.getProvider('analytics-internal');
 
     // Normalizes optional inputs.
     const { projectId, apiKey, appId } = app.options;
@@ -129,7 +129,7 @@ export function registerRemoteConfig(): void {
       storage,
       logger,
       realtimeHandler,
-      analytics
+      analyticsProvider
     );
 
     // Starts warming cache.

packages/remote-config/src/remote_config.ts

@@ -90,10 +90,10 @@ export class RemoteConfig implements RemoteConfigType {
     /**
      * @internal
      */
-    readonly _realtimeHandler: RealtimeHandler
+    readonly _realtimeHandler: RealtimeHandler,
     /**
      * @internal
      */
-    readonly _analytics: Provider<FirebaseAnalyticsInternalName>
+    readonly _analyticsProvider: Provider<FirebaseAnalyticsInternalName>
   ) {}
 }

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

@@ -25,17 +25,16 @@ import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types
 
 describe('Experiment', () => {
   const storage = {} as Storage;
-  const analytics = {} as Provider<FirebaseAnalyticsInternalName>;
-  const experiment = new Experiment(storage, analytics);
-
-describe('Experiment', () => {
-  const storage = {} as Storage;
-  const experiment = new Experiment(storage);
+  const analyticsProvider = {} as Provider<FirebaseAnalyticsInternalName>;
+  const experiment = new Experiment(storage, analyticsProvider);
 
   describe('updateActiveExperiments', () => {
     beforeEach(() => {
       storage.getActiveExperiments = sinon.stub();
       storage.setActiveExperiments = sinon.stub();
+      analyticsProvider.get = sinon.stub().returns(Promise.resolve({
+        setUserProperties: sinon.stub()
+      }));
     });
 
     it('adds mew experiments to storage', async () => {
@@ -66,12 +65,14 @@ describe('Experiment', () => {
       storage.getActiveExperiments = sinon
         .stub()
         .returns(new Set(['_exp_1', '_exp_2']));
+      const analytics = await analyticsProvider.get();
 
       await experiment.updateActiveExperiments(latestExperiments);
 
       expect(storage.setActiveExperiments).to.have.been.calledWith(
         expectedStoredExperiments
       );
+      expect(analytics.setUserProperties).to.have.been.calledWith({properties: {'_exp_1': '1'}});
     });
 
     it('removes missing experiment in fetch response from storage', async () => {
@@ -88,12 +89,14 @@ describe('Experiment', () => {
       storage.getActiveExperiments = sinon
         .stub()
         .returns(new Set(['_exp_1', '_exp_2']));
+      const analytics = await analyticsProvider.get();
 
       await experiment.updateActiveExperiments(latestExperiments);
 
       expect(storage.setActiveExperiments).to.have.been.calledWith(
         expectedStoredExperiments
       );
+      expect(analytics.setUserProperties).to.have.been.calledWith({properties: {'_exp_1': null}});
     });
   });
 });

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

@@ -73,7 +73,7 @@ describe('RemoteConfig', () => {
   let logger: Logger;
   let realtimeHandler: RealtimeHandler;
   let rc: RemoteConfigType;
-  let analytics: Provider<FirebaseAnalyticsInternalName>;
+  let analyticsProvider: Provider<FirebaseAnalyticsInternalName>;
 
 
   let getActiveConfigStub: sinon.SinonStub;
@@ -86,7 +86,7 @@ describe('RemoteConfig', () => {
     client = {} as RemoteConfigFetchClient;
     storageCache = {} as StorageCache;
     storage = {} as Storage;
-    analytics = {} as Provider<FirebaseAnalyticsInternalName>;
+    analyticsProvider = {} as Provider<FirebaseAnalyticsInternalName>;
     realtimeHandler = {} as RealtimeHandler;
     logger = new Logger('package-name');
     getActiveConfigStub = sinon.stub().returns(undefined);
@@ -100,7 +100,7 @@ describe('RemoteConfig', () => {
       storage,
       logger,
       realtimeHandler,
-      analytics
+      analyticsProvider
     );
   });