Merge aa00008 into 8bece48

Author: hsubox76

.changeset/fair-garlics-smoke.md

@@ -0,0 +1,6 @@
+---
+'@firebase/app': patch
+'@firebase/app-check': patch
+---
+
+Make App Check initialization explicit, to prevent unexpected errors for users who do not intend to use App Check.

packages/app-check/src/index.ts

@@ -16,7 +16,11 @@
  */
 import firebase from '@firebase/app';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
-import { Component, ComponentType } from '@firebase/component';
+import {
+  Component,
+  ComponentType,
+  InstantiationMode
+} from '@firebase/component';
 import {
   FirebaseAppCheck,
   AppCheckComponentName
@@ -41,6 +45,26 @@ function registerAppCheck(firebase: _FirebaseNamespace): void {
       },
       ComponentType.PUBLIC
     )
+      /**
+       * AppCheck can only be initialized by explicitly calling firebase.appCheck()
+       * We don't want firebase products that consume AppCheck to gate on AppCheck
+       * if the user doesn't intend them to, just because the AppCheck component
+       * is registered.
+       */
+      .setInstantiationMode(InstantiationMode.EXPLICIT)
+      /**
+       * Because all firebase products that depend on app-check depend on app-check-internal directly,
+       * we need to initialize app-check-internal after app-check is initialized to make it
+       * available to other firebase products.
+       */
+      .setInstanceCreatedCallback(
+        (container, _instanceIdentifier, _instance) => {
+          const appCheckInternalProvider = container.getProvider(
+            APP_CHECK_NAME_INTERNAL
+          );
+          appCheckInternalProvider.initialize();
+        }
+      )
   );
 
   // The internal interface used by other Firebase products
@@ -54,7 +78,7 @@ function registerAppCheck(firebase: _FirebaseNamespace): void {
         return internalFactory(app, platformLoggerProvider);
       },
       ComponentType.PUBLIC
-    )
+    ).setInstantiationMode(InstantiationMode.EXPLICIT)
   );
 
   firebase.registerVersion(name, version);

packages/app/src/firebaseApp.ts

@@ -29,7 +29,8 @@ import {
   ComponentContainer,
   Component,
   ComponentType,
-  Name
+  Name,
+  InstantiationMode
 } from '@firebase/component';
 import { AppError, ERROR_FACTORY } from './errors';
 import { DEFAULT_ENTRY_NAME } from './constants';
@@ -122,8 +123,17 @@ export class FirebaseAppImpl implements FirebaseApp {
   ): FirebaseService {
     this.checkDestroyed_();
 
+    // Initialize instance if InstatiationMode is `EXPLICIT`.
+    const provider = this.container.getProvider(name as Name);
+    if (
+      !provider.isInitialized() &&
+      provider.getComponent()?.instantiationMode === InstantiationMode.EXPLICIT
+    ) {
+      provider.initialize();
+    }
+
     // getImmediate will always succeed because _getService is only called for registered components.
-    return (this.container.getProvider(name as Name).getImmediate({
+    return (provider.getImmediate({
       identifier: instanceIdentifier
     }) as unknown) as FirebaseService;
   }

packages/app/test/clientLogger.test.ts

@@ -16,7 +16,10 @@
  */
 
 import { FirebaseNamespace, VersionService } from '@firebase/app-types';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
+import {
+  _FirebaseNamespace,
+  FirebaseService
+} from '@firebase/app-types/private';
 import { createFirebaseNamespace } from '../src/firebaseNamespace';
 import { expect } from 'chai';
 import { spy as Spy } from 'sinon';
@@ -29,7 +32,7 @@ declare module '@firebase/component' {
   interface NameServiceMapping {
     'vs1': VersionService;
     'vs2': VersionService;
-    'test-shell': Promise<void>;
+    'test-shell': FirebaseService;
   }
 }
 

packages/app/test/platformLogger.test.ts

@@ -16,7 +16,10 @@
  */
 
 import { FirebaseNamespace, VersionService } from '@firebase/app-types';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
+import {
+  FirebaseService,
+  _FirebaseNamespace
+} from '@firebase/app-types/private';
 import { createFirebaseNamespace } from '../src/firebaseNamespace';
 import { expect } from 'chai';
 import './setup';
@@ -33,7 +36,7 @@ declare module '@firebase/component' {
   interface NameServiceMapping {
     'vs1': VersionService;
     'vs2': VersionService;
-    'test-shell': Promise<void>;
+    'test-shell': FirebaseService;
   }
 }