Seperate internal interface from public interface.

Author: ChaoqunCHEN

packages-exp/installations-exp/src/api/delete-installations.test.ts

@@ -19,10 +19,6 @@ import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import * as deleteInstallationRequestModule from '../functions/delete-installation-request';
 import { get, set } from '../helpers/idb-manager';
-import {
-  FirebaseInstallations,
-  AppConfig
-} from '@firebase/installations-types-exp';
 import {
   InProgressInstallationEntry,
   RegisteredInstallationEntry,
@@ -34,11 +30,15 @@ import '../testing/setup';
 import { ErrorCode } from '../util/errors';
 import { sleep } from '../util/sleep';
 import { deleteInstallations } from './delete-installations';
+import {
+  FirebaseInstallationsImpl,
+  AppConfig
+} from '../interfaces/installation-impl';
 
 const FID = 'children-of-the-damned';
 
 describe('deleteInstallation', () => {
-  let installations: FirebaseInstallations;
+  let installations: FirebaseInstallationsImpl;
   let deleteInstallationRequestSpy: SinonStub<
     [AppConfig, RegisteredInstallationEntry],
     Promise<void>

packages-exp/installations-exp/src/api/delete-installations.ts

@@ -19,10 +19,10 @@ import { deleteInstallationRequest } from '../functions/delete-installation-requ
 import { remove, update } from '../helpers/idb-manager';
 import { RequestStatus } from '../interfaces/installation-entry';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 export async function deleteInstallations(
-  installations: FirebaseInstallations
+  installations: FirebaseInstallationsImpl
 ): Promise<void> {
   const { appConfig } = installations;
 

packages-exp/installations-exp/src/api/get-id.test.ts

@@ -19,22 +19,22 @@ import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import * as getInstallationEntryModule from '../helpers/get-installation-entry';
 import * as refreshAuthTokenModule from '../helpers/refresh-auth-token';
-import {
-  FirebaseInstallations,
-  AppConfig
-} from '@firebase/installations-types-exp';
 import {
   RegisteredInstallationEntry,
   RequestStatus
 } from '../interfaces/installation-entry';
 import { getFakeInstallations } from '../testing/fake-generators';
 import '../testing/setup';
 import { getId } from './get-id';
+import {
+  FirebaseInstallationsImpl,
+  AppConfig
+} from '../interfaces/installation-impl';
 
 const FID = 'disciples-of-the-watch';
 
 describe('getId', () => {
-  let installations: FirebaseInstallations;
+  let installations: FirebaseInstallationsImpl;
   let getInstallationEntrySpy: SinonStub<
     [AppConfig],
     Promise<getInstallationEntryModule.InstallationEntryWithRegistrationPromise>

packages-exp/installations-exp/src/api/get-id.ts

@@ -17,10 +17,10 @@
 
 import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 export async function getId(
-  installations: FirebaseInstallations
+  installations: FirebaseInstallationsImpl
 ): Promise<string> {
   const { installationEntry, registrationPromise } = await getInstallationEntry(
     installations.appConfig

packages-exp/installations-exp/src/api/get-installations.ts

@@ -18,14 +18,11 @@
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 import { _getProvider } from '@firebase/app-exp';
-import { extractAppConfig } from '../helpers/extract-app-config';
 
 export function getInstallations(app: FirebaseApp): FirebaseInstallations {
-  const appConfig = extractAppConfig(app);
-  const platformLoggerProvider = _getProvider(app, 'platform-logger');
-  const installations: FirebaseInstallations = {
-    appConfig,
-    platformLoggerProvider
-  };
-  return installations;
+  const installationsImpl = _getProvider(
+    app,
+    'installations-exp'
+  ).getImmediate();
+  return installationsImpl;
 }

packages-exp/installations-exp/src/api/get-token.test.ts

@@ -20,10 +20,6 @@ import { SinonFakeTimers, SinonStub, stub, useFakeTimers } from 'sinon';
 import * as createInstallationRequestModule from '../functions/create-installation-request';
 import * as generateAuthTokenRequestModule from '../functions/generate-auth-token-request';
 import { get, set } from '../helpers/idb-manager';
-import {
-  FirebaseInstallations,
-  AppConfig
-} from '@firebase/installations-types-exp';
 import {
   CompletedAuthToken,
   InProgressInstallationEntry,
@@ -37,6 +33,10 @@ import { TOKEN_EXPIRATION_BUFFER } from '../util/constants';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 import { sleep } from '../util/sleep';
 import { getToken } from './get-token';
+import {
+  AppConfig,
+  FirebaseInstallationsImpl
+} from '../interfaces/installation-impl';
 
 const FID = 'dont-talk-to-strangers';
 const AUTH_TOKEN = 'authToken';
@@ -173,13 +173,13 @@ const setupInstallationEntryMap: Map<
 ]);
 
 describe('getToken', () => {
-  let installations: FirebaseInstallations;
+  let installations: FirebaseInstallationsImpl;
   let createInstallationRequestSpy: SinonStub<
     [AppConfig, InProgressInstallationEntry],
     Promise<RegisteredInstallationEntry>
   >;
   let generateAuthTokenRequestSpy: SinonStub<
-    [FirebaseInstallations, RegisteredInstallationEntry],
+    [FirebaseInstallationsImpl, RegisteredInstallationEntry],
     Promise<CompletedAuthToken>
   >;
 

packages-exp/installations-exp/src/api/get-token.ts

@@ -18,12 +18,12 @@
 import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
 import {
-  FirebaseInstallations,
+  FirebaseInstallationsImpl,
   AppConfig
-} from '@firebase/installations-types-exp';
+} from '../interfaces/installation-impl';
 
 export async function getToken(
-  installations: FirebaseInstallations,
+  installations: FirebaseInstallationsImpl,
   forceRefresh = false
 ): Promise<string> {
   await completeInstallationRegistration(installations.appConfig);

packages-exp/installations-exp/src/api/on-id-change.test.ts

@@ -21,10 +21,10 @@ import '../testing/setup';
 import { onIdChange } from './on-id-change';
 import * as FidChangedModule from '../helpers/fid-changed';
 import { getFakeInstallations } from '../testing/fake-generators';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 describe('onIdChange', () => {
-  let installations: FirebaseInstallations;
+  let installations: FirebaseInstallationsImpl;
 
   beforeEach(() => {
     installations = getFakeInstallations();

packages-exp/installations-exp/src/api/on-id-change.ts

@@ -16,7 +16,7 @@
  */
 
 import { addCallback, removeCallback } from '../helpers/fid-changed';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 export type IdChangeCallbackFn = (installationId: string) => void;
 export type IdChangeUnsubscribeFn = () => void;
@@ -26,7 +26,7 @@ export type IdChangeUnsubscribeFn = () => void;
  * Returns an unsubscribe function that will remove the callback when called.
  */
 export function onIdChange(
-  { appConfig }: FirebaseInstallations,
+  { appConfig }: FirebaseInstallationsImpl,
   callback: IdChangeCallbackFn
 ): IdChangeUnsubscribeFn {
   addCallback(appConfig, callback);

packages-exp/installations-exp/src/functions/common.ts

@@ -17,7 +17,6 @@
 
 import { FirebaseError } from '@firebase/util';
 import { GenerateAuthTokenResponse } from '../interfaces/api-response';
-import { AppConfig } from '@firebase/installations-types-exp';
 import {
   CompletedAuthToken,
   RegisteredInstallationEntry,
@@ -28,6 +27,7 @@ import {
   INTERNAL_AUTH_VERSION
 } from '../util/constants';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
+import { AppConfig } from '../interfaces/installation-impl';
 
 export function getInstallationsEndpoint({ projectId }: AppConfig): string {
   return `${INSTALLATIONS_API_URL}/projects/${projectId}/installations`;

packages-exp/installations-exp/src/functions/config.ts

@@ -15,45 +15,61 @@
  * limitations under the License.
  */
 
-import { _registerComponent } from '@firebase/app-exp';
+import { _registerComponent, _getProvider } from '@firebase/app-exp';
 import { _FirebaseService } from '@firebase/app-types-exp';
 import {
   Component,
   ComponentType,
   InstanceFactory,
   ComponentContainer
 } from '@firebase/component';
-import {
-  getInstallations,
-  deleteInstallations,
-  getId,
-  getToken,
-  onIdChange
-} from '../api/index';
-import { FirebaseInstallationsInternal } from '../interfaces/installation-internal';
+import { deleteInstallations, getId, getToken } from '../api/index';
+import { FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
+import { extractAppConfig } from '../helpers/extract-app-config';
 
-const installationsName = 'installations-exp';
+const INSTALLATIONS_NAME = 'installations-exp';
 
-const factory: InstanceFactory<'installations-exp'> = (
+const publicFactory: InstanceFactory<'installations-exp'> = (
   container: ComponentContainer
 ) => {
   const app = container.getProvider('app-exp').getImmediate();
-
   // Throws if app isn't configured properly.
-  const installations = getInstallations(app);
-  const installationsService: FirebaseInstallationsInternal = {
+  const appConfig = extractAppConfig(app);
+  const platformLoggerProvider = _getProvider(app, 'platform-logger');
+
+  const installationsImpl: FirebaseInstallationsImpl = {
     app,
-    getId: () => getId(installations),
-    getToken: (forceRefresh?: boolean) => getToken(installations, forceRefresh),
-    _delete: () => deleteInstallations(installations),
-    onIdChange: (callback: (fid: string) => void) =>
-      onIdChange(installations, callback)
+    appConfig,
+    platformLoggerProvider,
+    _delete: () => deleteInstallations(installationsImpl)
   };
-  return installationsService;
+  return installationsImpl;
+};
+
+const internalFactory: InstanceFactory<'installations-exp-internal'> = (
+  container: ComponentContainer
+) => {
+  const app = container.getProvider('app-exp').getImmediate();
+  // Internal FIS instance relies on public FIS instance.
+  const installationsImpl = _getProvider(
+    app,
+    INSTALLATIONS_NAME
+  ).getImmediate();
+
+  const installationsInternal: FirebaseInstallationsInternal = {
+    getId: () => getId(installationsImpl),
+    getToken: (forceRefresh?: boolean) =>
+      getToken(installationsImpl, forceRefresh)
+  };
+  return installationsInternal;
 };
 
 export function registerInstallations(): void {
   _registerComponent(
-    new Component(installationsName, factory, ComponentType.PUBLIC)
+    new Component(INSTALLATIONS_NAME, publicFactory, ComponentType.PUBLIC)
+  );
+  _registerComponent(
+    new Component(INSTALLATIONS_NAME, internalFactory, ComponentType.PRIVATE)
   );
 }

packages-exp/installations-exp/src/functions/create-installation-request.test.ts

@@ -19,7 +19,7 @@ import { FirebaseError } from '@firebase/util';
 import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import { CreateInstallationResponse } from '../interfaces/api-response';
-import { AppConfig } from '@firebase/installations-types-exp';
+import { AppConfig } from '../interfaces/installation-impl';
 import {
   InProgressInstallationEntry,
   RequestStatus

packages-exp/installations-exp/src/functions/create-installation-request.ts

@@ -16,7 +16,6 @@
  */
 
 import { CreateInstallationResponse } from '../interfaces/api-response';
-import { AppConfig } from '@firebase/installations-types-exp';
 import {
   InProgressInstallationEntry,
   RegisteredInstallationEntry,
@@ -30,6 +29,7 @@ import {
   getInstallationsEndpoint,
   retryIfServerError
 } from './common';
+import { AppConfig } from '../interfaces/installation-impl';
 
 export async function createInstallationRequest(
   appConfig: AppConfig,

packages-exp/installations-exp/src/functions/delete-installation-request.test.ts

@@ -18,7 +18,7 @@
 import { FirebaseError } from '@firebase/util';
 import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
-import { AppConfig } from '@firebase/installations-types-exp';
+import { AppConfig } from '../interfaces/installation-impl';
 import {
   RegisteredInstallationEntry,
   RequestStatus

packages-exp/installations-exp/src/functions/delete-installation-request.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { AppConfig } from '@firebase/installations-types-exp';
+import { AppConfig } from '../interfaces/installation-impl';
 import { RegisteredInstallationEntry } from '../interfaces/installation-entry';
 import {
   getErrorFromResponse,

packages-exp/installations-exp/src/functions/generate-auth-token-request.test.ts

@@ -19,7 +19,6 @@ import { FirebaseError } from '@firebase/util';
 import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import { GenerateAuthTokenResponse } from '../interfaces/api-response';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
 import {
   CompletedAuthToken,
   RegisteredInstallationEntry,
@@ -35,11 +34,12 @@ import {
 } from '../util/constants';
 import { ErrorResponse } from './common';
 import { generateAuthTokenRequest } from './generate-auth-token-request';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 const FID = 'evil-has-no-boundaries';
 
 describe('generateAuthTokenRequest', () => {
-  let installations: FirebaseInstallations;
+  let installations: FirebaseInstallationsImpl;
   let fetchSpy: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
   let registeredInstallationEntry: RegisteredInstallationEntry;
   let response: GenerateAuthTokenResponse;

packages-exp/installations-exp/src/functions/generate-auth-token-request.ts

@@ -16,10 +16,6 @@
  */
 
 import { GenerateAuthTokenResponse } from '../interfaces/api-response';
-import {
-  AppConfig,
-  FirebaseInstallations
-} from '@firebase/installations-types-exp';
 import {
   CompletedAuthToken,
   RegisteredInstallationEntry
@@ -32,9 +28,13 @@ import {
   getInstallationsEndpoint,
   retryIfServerError
 } from './common';
+import {
+  FirebaseInstallationsImpl,
+  AppConfig
+} from '../interfaces/installation-impl';
 
 export async function generateAuthTokenRequest(
-  { appConfig, platformLoggerProvider }: FirebaseInstallations,
+  { appConfig, platformLoggerProvider }: FirebaseInstallationsImpl,
   installationEntry: RegisteredInstallationEntry
 ): Promise<CompletedAuthToken> {
   const endpoint = getGenerateAuthTokenEndpoint(appConfig, installationEntry);

packages-exp/installations-exp/src/helpers/extract-app-config.test.ts

@@ -17,7 +17,7 @@
 
 import { FirebaseError } from '@firebase/util';
 import { expect } from 'chai';
-import { AppConfig } from '@firebase/installations-types-exp';
+import { AppConfig } from '../interfaces/installation-impl';
 import { getFakeApp } from '../testing/fake-generators';
 import '../testing/setup';
 import { extractAppConfig } from './extract-app-config';

packages-exp/installations-exp/src/helpers/extract-app-config.ts

@@ -17,7 +17,7 @@
 
 import { FirebaseApp, FirebaseOptions } from '@firebase/app-types-exp';
 import { FirebaseError } from '@firebase/util';
-import { AppConfig } from '@firebase/installations-types-exp';
+import { AppConfig } from '../interfaces/installation-impl';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 
 export function extractAppConfig(app: FirebaseApp): AppConfig {