FirebaseApp / Options typeguard. More tests.

Author: DellaBitta

common/api-review/app.api.md

@@ -116,6 +116,9 @@ export function initializeApp(): FirebaseApp;
 // @public
 export function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
 
+// @internal (undocumented)
+export function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
+
 // @public
 export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
 

packages/app/src/api.test.ts

@@ -162,12 +162,6 @@ describe('API tests', () => {
       expect(app.name).to.equal(appName);
     });
 
-    it('takes an object as the second parameter to create named App', () => {
-      const appName = 'MyApp';
-      const app = initializeApp({}, { name: appName });
-      expect(app.name).to.equal(appName);
-    });
-
     it('sets automaticDataCollectionEnabled', () => {
       const app = initializeApp({}, { automaticDataCollectionEnabled: true });
       expect(app.automaticDataCollectionEnabled).to.be.true;
@@ -189,18 +183,59 @@ describe('API tests', () => {
   });
 
   describe('initializeServerApp', () => {
-    it('creates named App', () => {
+    it('creates FirebaseServerApp with options', () => {
+      const options = {
+        apiKey: 'APIKEY'
+      };
+
+      const serverAppSettings: FirebaseServerAppSettings = {};
+
+      const app = initializeServerApp(options, serverAppSettings);
+      expect(app).to.not.equal(null);
+      expect(app.automaticDataCollectionEnabled).to.be.false;
+    });
+
+    it('creates FirebaseServerApp with automaticDataCollectionEnabled', () => {
       const options = {
         apiKey: 'APIKEY'
       };
 
+      const serverAppSettings: FirebaseServerAppSettings = {
+        automaticDataCollectionEnabled: true
+      };
+
+      const app = initializeServerApp(options, serverAppSettings);
+      expect(app).to.not.equal(null);
+      expect(app.automaticDataCollectionEnabled).to.be.true;
+    });
+
+    it('creates FirebaseServerApp with releaseOnDeref', () => {
+      const options = { apiKey: 'APIKEY' };
       const serverAppSettings: FirebaseServerAppSettings = {
         automaticDataCollectionEnabled: false,
         releaseOnDeref: options
       };
 
       const app = initializeServerApp(options, serverAppSettings);
       expect(app).to.not.equal(null);
+      expect(app.automaticDataCollectionEnabled).to.be.false;
+    });
+
+    it('creates FirebaseServerApp with FirebaseApp', () => {
+      const options = {
+        apiKey: 'test1'
+      };
+      const standardApp = initializeApp(options);
+      expect(standardApp.name).to.equal(DEFAULT_ENTRY_NAME);
+      expect(standardApp.options.apiKey).to.equal('test1');
+
+      const serverAppSettings: FirebaseServerAppSettings = {
+        automaticDataCollectionEnabled: false
+      };
+
+      const serverApp = initializeServerApp(standardApp, serverAppSettings);
+      expect(serverApp).to.not.equal(null);
+      expect(serverApp.options.apiKey).to.equal('test1');
     });
   });
 

packages/app/src/api.ts

@@ -36,6 +36,7 @@ import { FirebaseServerAppImpl } from './firebaseServerApp';
 import {
   _apps,
   _components,
+  _isFirebaseApp,
   _registerComponent,
   _serverApps
 } from './internal';
@@ -234,10 +235,10 @@ export function initializeServerApp(
   };
 
   let appOptions: FirebaseOptions;
-  if ((_options as FirebaseApp).options !== undefined) {
-    appOptions = (_options as FirebaseApp).options;
+  if (_isFirebaseApp(_options)) {
+    appOptions = _options.options;
   } else {
-    appOptions = _options as FirebaseOptions;
+    appOptions = _options;
   }
 
   const nameObj = {

packages/app/src/internal.ts

@@ -15,7 +15,11 @@
  * limitations under the License.
  */
 
-import { FirebaseApp, FirebaseServerApp } from './public-types';
+import {
+  FirebaseApp,
+  FirebaseOptions,
+  FirebaseServerApp
+} from './public-types';
 import { Component, Provider, Name } from '@firebase/component';
 import { logger } from './logger';
 import { DEFAULT_ENTRY_NAME } from './constants';
@@ -137,6 +141,20 @@ export function _removeServiceInstance<T extends Name>(
   _getProvider(app, name).clearInstance(instanceIdentifier);
 }
 
+/**
+ *
+ * @param obj - an object of type FirebaseApp or FirebaseOptions.
+ *
+ * @returns true if the provide object is of type FirebaseApp.
+ *
+ * @internal
+ */
+export function _isFirebaseApp(
+  obj: FirebaseApp | FirebaseOptions
+): obj is FirebaseApp {
+  return (obj as FirebaseApp).options !== undefined;
+}
+
 /**
  * Test only
  *