fix(): Shore up optional types and allow functions emulator configuration

jamesdaniels · jamesdaniels · commit 9669ccf7c66a · 2018-11-29T13:54:17.000-08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "angularfire2",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "The official library of Firebase and Angular.",
   "private": true,
   "scripts": {
@@ -12,7 +12,7 @@
     "delayed_karma": "sleep 10 && karma start",
     "build": "rm -rf dist && node tools/build.js",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
-    "build:wrapper": "npm i --prefix wrapper && VERSION=5.1.0 npm run --prefix wrapper build"
+    "build:wrapper": "npm i --prefix wrapper && VERSION=5.1.1 npm run --prefix wrapper build"
   },
   "keywords": [
     "angular",
@@ -35,7 +35,7 @@
     "@angular/core": ">=6.0.0 <8",
     "@angular/platform-browser": ">=6.0.0 <8",
     "@angular/platform-browser-dynamic": ">=6.0.0 <8",
-    "firebase": "^5.5.0",
+    "firebase": "^5.5.7",
     "rxjs": "^6.0.0",
     "ws": "^3.3.2",
     "xhr2": "^0.1.4",
@@ -46,9 +46,9 @@
     "utf-8-validate": "~4.0.0"
   },
   "devDependencies": {
+    "@angular/animations": ">=6.0.0 <8",
     "@angular/compiler-cli": ">=6.0.0 <8",
     "@angular/platform-server": ">=6.0.0 <8",
-    "@angular/animations": ">=6.0.0 <8",
     "@types/jasmine": "^2.5.36",
     "@types/request": "0.0.30",
     "concurrently": "^2.2.0",
diff --git a/src/auth/auth.ts b/src/auth/auth.ts
@@ -38,7 +38,7 @@ export class AngularFireAuth {
 
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
     @Inject(PLATFORM_ID) platformId: Object,
     private zone: NgZone
   ) {
diff --git a/src/core/firebase.app.module.ts b/src/core/firebase.app.module.ts
@@ -34,7 +34,7 @@ export class FirebaseApp implements app.App {
     functions: (region?: string) => FirebaseFunctions;
 }
 
-export function _firebaseAppFactory(options: FirebaseOptions, nameOrConfig?: string | FirebaseAppConfig) {
+export function _firebaseAppFactory(options: FirebaseOptions, nameOrConfig?: string|FirebaseAppConfig|null) {
     const name = typeof nameOrConfig === 'string' && nameOrConfig || '[DEFAULT]';
     const config = typeof nameOrConfig === 'object' && nameOrConfig || {};
     config.name = config.name || name;
@@ -53,7 +53,7 @@ const FirebaseAppProvider = {
         [new Optional(), FirebaseNameOrConfigToken]
     ]
 };
- 
+
 @NgModule({
     providers: [ FirebaseAppProvider ],
 })
diff --git a/src/core/package.json b/src/core/package.json
@@ -12,12 +12,10 @@
     "angularfire",
     "angularfire2"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/angular/angularfire2.git"
-  },
+  "repository": "github:angular/angularfire2",
   "author": "angular,firebase",
   "license": "MIT",
+  "homepage": "https://firebaseopensource.com/projects/angular/angularfire2",
   "peerDependencies": {
     "@angular/common": "ANGULAR_VERSION",
     "@angular/core": "ANGULAR_VERSION",
diff --git a/src/database/database.ts b/src/database/database.ts
@@ -13,7 +13,7 @@ export class AngularFireDatabase {
 
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
     @Optional() @Inject(RealtimeDatabaseURL) databaseURL:string,
     @Inject(PLATFORM_ID) platformId: Object,
     zone: NgZone
diff --git a/src/firestore/firestore.ts b/src/firestore/firestore.ts
@@ -7,7 +7,7 @@ import { AngularFirestoreDocument } from './document/document';
 import { AngularFirestoreCollection } from './collection/collection';
 
 import { FirebaseFirestore, FirebaseOptions, FirebaseAppConfig, FirebaseOptionsToken, FirebaseNameOrConfigToken, _firebaseAppFactory, FirebaseZoneScheduler } from '@angular/fire';
-import { isPlatformBrowser } from '@angular/common';
+import { isPlatformServer } from '@angular/common';
 
 import { firestore } from 'firebase/app';
 
@@ -107,12 +107,12 @@ export class AngularFirestore {
    */
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
     @Optional() @Inject(EnablePersistenceToken) shouldEnablePersistence: boolean,
     @Optional() @Inject(FirestoreSettingsToken) settings: Settings,
     @Inject(PLATFORM_ID) platformId: Object,
     zone: NgZone,
-    @Optional() @Inject(PersistenceSettingsToken) persistenceSettings: PersistenceSettings|undefined,
+    @Optional() @Inject(PersistenceSettingsToken) persistenceSettings: PersistenceSettings|null
   ) {
     this.scheduler = new FirebaseZoneScheduler(zone, platformId);
     this.firestore = zone.runOutsideAngular(() => {
@@ -122,12 +122,12 @@ export class AngularFirestore {
       return firestore;
     });
 
-    if (shouldEnablePersistence && isPlatformBrowser(platformId)) {
+    if (shouldEnablePersistence && !isPlatformServer(platformId)) {
       // We need to try/catch here because not all enablePersistence() failures are caught
       // https://github.com/firebase/firebase-js-sdk/issues/608
       const enablePersistence = () => {
         try {
-          return from(this.firestore.enablePersistence(persistenceSettings).then(() => true, () => false));
+          return from(this.firestore.enablePersistence(persistenceSettings || undefined).then(() => true, () => false));
         } catch(e) {
           return of(false);
         }
diff --git a/src/functions/functions.spec.ts b/src/functions/functions.spec.ts
@@ -1,7 +1,7 @@
 import { ReflectiveInjector, Provider } from '@angular/core';
 import { TestBed, inject } from '@angular/core/testing';
 import { FirebaseApp, FirebaseOptionsToken, AngularFireModule, FirebaseNameOrConfigToken } from '@angular/fire';
-import { AngularFireFunctions, AngularFireFunctionsModule, FunctionsRegionToken } from '@angular/fire/functions';
+import { AngularFireFunctions, AngularFireFunctionsModule, FunctionsRegionToken, FunctionsEmulatorOrigin } from '@angular/fire/functions';
 import { COMMON_CONFIG } from './test-config';
 
 describe('AngularFireFunctions', () => {
@@ -32,6 +32,9 @@ describe('AngularFireFunctions', () => {
 
   it('should have the Firebase Functions instance', () => {
     expect(afFns.functions).toBeDefined();
+    expect((afFns.functions as any).app_).toEqual(app);
+    expect((afFns.functions as any).region_).toEqual('us-central1');
+    expect((afFns.functions as any).emulatorOrigin).toEqual(null);
   });
 
 });
@@ -52,6 +55,7 @@ describe('AngularFireFunctions with different app', () => {
         { provide: FirebaseNameOrConfigToken, useValue: FIREBASE_APP_NAME_TOO },
         { provide: FirebaseOptionsToken, useValue: COMMON_CONFIG },
         { provide: FunctionsRegionToken, useValue: 'asia-northeast1' },
+        { provide: FunctionsEmulatorOrigin, useValue: 'http://localhost:9999' },
       ]
     });
     inject([FirebaseApp, AngularFireFunctions], (app_: FirebaseApp, _fns: AngularFireFunctions) => {
@@ -73,6 +77,9 @@ describe('AngularFireFunctions with different app', () => {
 
     it('should have the Firebase Functions instance', () => {
       expect(afFns.functions).toBeDefined();
+      expect((afFns.functions as any).app_).toEqual(app);
+      expect((afFns.functions as any).region_).toEqual('asia-northeast1');
+      expect((afFns.functions as any).emulatorOrigin).toEqual('http://localhost:9999');
     });
 
   });
diff --git a/src/functions/functions.ts b/src/functions/functions.ts
@@ -1,10 +1,11 @@
 import { Injectable, Inject, Optional, NgZone, PLATFORM_ID, InjectionToken } from '@angular/core';
 import { Observable, from } from 'rxjs';
-import { map } from 'rxjs/operators';
+import { map, catchError } from 'rxjs/operators';
 import { FirebaseOptions, FirebaseAppConfig } from '@angular/fire';
 import { FirebaseFunctions, FirebaseOptionsToken, FirebaseNameOrConfigToken, _firebaseAppFactory, FirebaseZoneScheduler } from '@angular/fire';
 
 export const FunctionsRegionToken = new InjectionToken<string>('angularfire2.functions.region');
+export const FunctionsEmulatorOrigin = new InjectionToken<string>('angularfire2.functions.emulatorOrigin');
 
 @Injectable()
 export class AngularFireFunctions {
@@ -18,10 +19,11 @@ export class AngularFireFunctions {
 
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
     @Inject(PLATFORM_ID) platformId: Object,
     zone: NgZone,
-    @Optional() @Inject(FunctionsRegionToken) region:string|undefined
+    @Optional() @Inject(FunctionsRegionToken) region:string|null,
+    @Optional() @Inject(FunctionsEmulatorOrigin) emulatorOrigin:string|null
   ) {
     this.scheduler = new FirebaseZoneScheduler(zone, platformId);
     
@@ -30,6 +32,10 @@ export class AngularFireFunctions {
       return app.functions(region || undefined);
     });
 
+    if (emulatorOrigin) {
+      this.functions.useFunctionsEmulator(emulatorOrigin);
+    }
+
   }
 
   public httpsCallable<T=any, R=any>(name: string) {
diff --git a/src/messaging/messaging.ts b/src/messaging/messaging.ts
@@ -1,5 +1,5 @@
 import { Injectable, Inject, Optional, NgZone, PLATFORM_ID } from '@angular/core';
-import { isPlatformBrowser } from '@angular/common';
+import { isPlatformServer } from '@angular/common';
 import { messaging } from 'firebase/app';
 import { Observable, empty, from, of, throwError } from 'rxjs';
 import { mergeMap, catchError, map, switchMap, concat, defaultIfEmpty } from 'rxjs/operators';
@@ -18,12 +18,12 @@ export class AngularFireMessaging {
 
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
     @Inject(PLATFORM_ID) platformId: Object,
     zone: NgZone
   ) {
 
-    if (isPlatformBrowser(platformId)) {
+    if (!isPlatformServer(platformId)) {
 
       // @ts-ignore
       const requireMessaging = from(import('firebase/messaging'));
diff --git a/src/storage/storage.ts b/src/storage/storage.ts
@@ -22,8 +22,8 @@ export class AngularFireStorage {
 
   constructor(
     @Inject(FirebaseOptionsToken) options:FirebaseOptions,
-    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
-    @Optional() @Inject(StorageBucket) storageBucket:string,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|null,
+    @Optional() @Inject(StorageBucket) storageBucket:string|null,
     @Inject(PLATFORM_ID) platformId: Object,
     zone: NgZone
   ) {
diff --git a/yarn.lock b/yarn.lock
