Use appName + appId to key installation entries (#116)

Also changes idb manager functions to get the key from the app config.

Author: mmermerkaya

packages/installations/src/api.test.ts

@@ -35,6 +35,7 @@ import {
   RequestStatus
 } from './interfaces/installation-entry';
 import { compareHeaders } from './testing/compare-headers';
+import { getFakeAppConfig } from './testing/get-fake-app';
 import './testing/setup';
 
 const FID = 'defenders-of-the-faith';
@@ -44,11 +45,7 @@ describe('api', () => {
   let fetchSpy: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
 
   beforeEach(async () => {
-    appConfig = {
-      apiKey: 'apiKey',
-      projectId: 'projectId',
-      appId: '1:777777777777:web:d93b5ca1475efe57'
-    };
+    appConfig = getFakeAppConfig();
   });
 
   afterEach(() => {

packages/installations/src/get-auth-token.test.ts

@@ -33,6 +33,7 @@ import {
 } from './interfaces/installation-entry';
 import { getFakeApp } from './testing/get-fake-app';
 import './testing/setup';
+import { extractAppConfig } from './util/extract-app-config';
 import { sleep } from './util/sleep';
 
 const FID = 'dont-talk-to-strangers';
@@ -43,10 +44,13 @@ const ONE_WEEK_MS = 7 * 24 * 60 * 60 * 1000;
  * A map of different states of the database and a function that creates the
  * said state.
  */
-const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
+const setupInstallationEntryMap: Map<
+  string,
+  (appConfig: AppConfig) => Promise<void>
+> = new Map([
   [
     'existing and valid auth token',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: RegisteredInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.COMPLETED,
@@ -58,12 +62,12 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
           creationTime: Date.now()
         }
       };
-      set('appId', entry);
+      set(appConfig, entry);
     }
   ],
   [
     'expired auth token',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: RegisteredInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.COMPLETED,
@@ -75,12 +79,12 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
           creationTime: Date.now() - 2 * ONE_WEEK_MS
         }
       };
-      set('appId', entry);
+      set(appConfig, entry);
     }
   ],
   [
     'pending auth token',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: RegisteredInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.COMPLETED,
@@ -91,7 +95,7 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
         }
       };
 
-      set('appId', entry);
+      set(appConfig, entry);
 
       // Finish pending request in 10 ms
       sleep(50).then(() => {
@@ -104,13 +108,13 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
             creationTime: Date.now()
           }
         };
-        set('appId', updatedEntry);
+        set(appConfig, updatedEntry);
       });
     }
   ],
   [
     'no auth token',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: RegisteredInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.COMPLETED,
@@ -119,19 +123,19 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
           requestStatus: RequestStatus.NOT_STARTED
         }
       };
-      set('appId', entry);
+      set(appConfig, entry);
     }
   ],
   [
     'pending fid registration',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: InProgressInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.IN_PROGRESS,
         registrationTime: Date.now() - 3 * 1000
       };
 
-      set('appId', entry);
+      set(appConfig, entry);
 
       // Finish pending request in 10 ms
       sleep(50).then(async () => {
@@ -146,25 +150,26 @@ const setupInstallationEntryMap: Map<string, () => Promise<void>> = new Map([
             creationTime: Date.now()
           }
         };
-        set('appId', updatedEntry);
+        set(appConfig, updatedEntry);
       });
     }
   ],
   [
     'unregistered fid',
-    async () => {
+    async (appConfig: AppConfig) => {
       const entry: UnregisteredInstallationEntry = {
         fid: FID,
         registrationStatus: RequestStatus.NOT_STARTED
       };
 
-      set('appId', entry);
+      set(appConfig, entry);
     }
   ]
 ]);
 
 describe('getAuthToken', () => {
-  const app: FirebaseApp = getFakeApp();
+  let app: FirebaseApp;
+  let appConfig: AppConfig;
   let createInstallationSpy: SinonStub<
     [AppConfig, InProgressInstallationEntry],
     Promise<RegisteredInstallationEntry>
@@ -175,6 +180,9 @@ describe('getAuthToken', () => {
   >;
 
   beforeEach(() => {
+    app = getFakeApp();
+    appConfig = extractAppConfig(app);
+
     createInstallationSpy = stub(api, 'createInstallation').callsFake(
       async (_, installationEntry) => {
         await sleep(50); // Request would take some time
@@ -216,7 +224,9 @@ describe('getAuthToken', () => {
   describe('basic functionality', () => {
     for (const [title, setup] of setupInstallationEntryMap.entries()) {
       describe(`when ${title} in the DB`, () => {
-        beforeEach(setup);
+        beforeEach(() => {
+          setup(appConfig);
+        });
 
         it('resolves with an auth token', async () => {
           const token = await getAuthToken(app);
@@ -226,7 +236,7 @@ describe('getAuthToken', () => {
         it('saves the token in the DB', async () => {
           const token = await getAuthToken(app);
           const installationEntry = await get<RegisteredInstallationEntry>(
-            app.options.appId
+            appConfig
           );
           expect(installationEntry).not.to.be.undefined;
           expect(installationEntry!.registrationStatus).to.equal(
@@ -281,7 +291,7 @@ describe('getAuthToken', () => {
           requestStatus: RequestStatus.NOT_STARTED
         }
       };
-      await set(app.options.appId, installationEntry);
+      await set(appConfig, installationEntry);
     });
 
     it('gets the token by calling generateAuthToken', async () => {
@@ -314,7 +324,7 @@ describe('getAuthToken', () => {
         });
 
         await expect(getAuthToken(app)).to.eventually.be.rejected;
-        await expect(get(app.options.appId)).to.eventually.be.undefined;
+        await expect(get(appConfig)).to.eventually.be.undefined;
       });
 
       it('removes the FID from the DB if the server returns a 404 response', async () => {
@@ -328,7 +338,7 @@ describe('getAuthToken', () => {
         });
 
         await expect(getAuthToken(app)).to.eventually.be.rejected;
-        await expect(get(app.options.appId)).to.eventually.be.undefined;
+        await expect(get(appConfig)).to.eventually.be.undefined;
       });
 
       it('does not remove the FID from the DB if the server returns any other response', async () => {
@@ -342,7 +352,7 @@ describe('getAuthToken', () => {
         });
 
         await expect(getAuthToken(app)).to.eventually.be.rejected;
-        await expect(get(app.options.appId)).to.eventually.deep.equal(
+        await expect(get(appConfig)).to.eventually.deep.equal(
           installationEntry
         );
       });
@@ -362,7 +372,7 @@ describe('getAuthToken', () => {
           creationTime: Date.now()
         }
       };
-      await set(app.options.appId, installationEntry);
+      await set(appConfig, installationEntry);
     });
 
     it('does not call any server APIs', async () => {
@@ -394,7 +404,7 @@ describe('getAuthToken', () => {
           creationTime: Date.now() - ONE_WEEK_MS + TOKEN_EXPIRATION_BUFFER + 10
         }
       };
-      await set(app.options.appId, installationEntry);
+      await set(appConfig, installationEntry);
     });
 
     it('returns a different token after expiration', async () => {
@@ -424,7 +434,7 @@ describe('getAuthToken', () => {
           creationTime: Date.now() - 2 * ONE_WEEK_MS
         }
       };
-      await set(app.options.appId, installationEntry);
+      await set(appConfig, installationEntry);
     });
 
     it('throws if the app is offline', async () => {

packages/installations/src/get-auth-token.ts

@@ -63,7 +63,7 @@ async function completeInstallationRegistration(
 async function fetchAuthToken(appConfig: AppConfig): Promise<string> {
   let tokenPromise: Promise<CompletedAuthToken> | undefined;
   const entry = await update(
-    appConfig.appId,
+    appConfig,
     (oldEntry?: InstallationEntry): RegisteredInstallationEntry => {
       if (!isEntryRegistered(oldEntry)) {
         throw ERROR_FACTORY.create(ErrorCode.NOT_REGISTERED);
@@ -75,7 +75,7 @@ async function fetchAuthToken(appConfig: AppConfig): Promise<string> {
         return oldEntry;
       } else if (oldAuthToken.requestStatus === RequestStatus.IN_PROGRESS) {
         // There already is a token request in progress.
-        tokenPromise = waitUntilAuthTokenRequest(appConfig.appId);
+        tokenPromise = waitUntilAuthTokenRequest(appConfig);
         return oldEntry;
       } else {
         // No token or token expired.
@@ -100,18 +100,18 @@ async function fetchAuthToken(appConfig: AppConfig): Promise<string> {
  * Call only if FID is registered and Auth Token request is in progress.
  */
 async function waitUntilAuthTokenRequest(
-  appId: string
+  appConfig: AppConfig
 ): Promise<CompletedAuthToken> {
   // Unfortunately, there is no way of reliably observing when a value in
   // IndexedDB changes (yet, see https://github.com/WICG/indexed-db-observers),
   // so we need to poll.
 
-  let entry = await updateAuthTokenRequest(appId);
+  let entry = await updateAuthTokenRequest(appConfig);
   while (entry.authToken.requestStatus === RequestStatus.IN_PROGRESS) {
     // generateAuthToken still in progress.
     await sleep(100);
 
-    entry = await updateAuthTokenRequest(appId);
+    entry = await updateAuthTokenRequest(appConfig);
   }
 
   const authToken = entry.authToken;
@@ -131,10 +131,10 @@ async function waitUntilAuthTokenRequest(
  * Returns the updated InstallationEntry.
  */
 function updateAuthTokenRequest(
-  appId: string
+  appConfig: AppConfig
 ): Promise<RegisteredInstallationEntry> {
   return update(
-    appId,
+    appConfig,
     (oldEntry?: InstallationEntry): RegisteredInstallationEntry => {
       if (!isEntryRegistered(oldEntry)) {
         throw ERROR_FACTORY.create(ErrorCode.NOT_REGISTERED);
@@ -163,19 +163,19 @@ async function fetchAuthTokenFromServer(
       ...installationEntry,
       authToken
     };
-    await set(appConfig.appId, updatedInstallationEntry);
+    await set(appConfig, updatedInstallationEntry);
     return authToken;
   } catch (e) {
     if (isServerError(e) && (e.serverCode === 401 || e.serverCode === 404)) {
       // Server returned a "FID not found" or a "Invalid authentication" error.
       // Generate a new ID next time.
-      await remove(appConfig.appId);
+      await remove(appConfig);
     } else {
       const updatedInstallationEntry: RegisteredInstallationEntry = {
         ...installationEntry,
         authToken: { requestStatus: RequestStatus.NOT_STARTED }
       };
-      await set(appConfig.appId, updatedInstallationEntry);
+      await set(appConfig, updatedInstallationEntry);
     }
     throw e;
   }