feat(functions): Adding AngularFireFunctions with httpCallable (angular#1532)

Author: jamesdaniels

karma.conf.js

@@ -30,6 +30,7 @@ module.exports = function(config) {
       'dist/packages-dist/bundles/auth.umd.{js,map}',
       'dist/packages-dist/bundles/database.umd.{js,map}',
       'dist/packages-dist/bundles/firestore.umd.{js,map}',
+      'dist/packages-dist/bundles/functions.umd.{js,map}',
       'dist/packages-dist/bundles/storage.umd.{js,map}',
       'dist/packages-dist/bundles/database-deprecated.umd.{js,map}',
       'dist/packages-dist/bundles/test.umd.{js,map}',

package.json

@@ -42,6 +42,8 @@
     "@firebase/database-types": "^0.3.1",
     "@firebase/firestore": "^0.5.2",
     "@firebase/firestore-types": "^0.4.1",
+    "@firebase/functions": "^0.2.2",
+    "@firebase/functions-types": "^0.1.2",
     "@firebase/messaging-types": "^0.2.2",
     "@firebase/storage": "^0.2.2",
     "@firebase/storage-types": "^0.2.2",

src/core/firebase.app.module.ts

@@ -9,6 +9,7 @@ import { FirebaseDatabase } from '@firebase/database-types';
 import { FirebaseMessaging } from '@firebase/messaging-types';
 import { FirebaseStorage } from '@firebase/storage-types';
 import { FirebaseFirestore } from '@firebase/firestore-types';
+import { FirebaseFunctions } from '@firebase/functions-types';
 
 export class FirebaseApp implements _FirebaseApp {
     name: string;
@@ -20,6 +21,7 @@ export class FirebaseApp implements _FirebaseApp {
     storage: (storageBucket?: string) => FirebaseStorage;
     delete: () => Promise<void>;
     firestore: () => FirebaseFirestore;
+    functions: () => FirebaseFunctions;
 }
 
 export function _firebaseAppFactory(options: FirebaseOptions, nameOrConfig?: string | FirebaseAppConfig) {

src/functions/functions.module.ts

@@ -0,0 +1,8 @@
+import { NgModule } from '@angular/core';
+import { AngularFireFunctions } from './functions';
+import '@firebase/functions'
+
+@NgModule({
+  providers: [ AngularFireFunctions ]
+})
+export class AngularFireFunctionsModule { }

src/functions/functions.spec.ts

@@ -0,0 +1,75 @@
+import { ReflectiveInjector, Provider } from '@angular/core';
+import { TestBed, inject } from '@angular/core/testing';
+import { FirebaseApp, FirebaseOptionsToken, AngularFireModule, FirebaseNameOrConfigToken } from 'angularfire2';
+import { AngularFireFunctions, AngularFireFunctionsModule } from 'angularfire2/functions';
+import { COMMON_CONFIG } from './test-config';
+
+describe('AngularFireFunctions', () => {
+  let app: FirebaseApp;
+  let afFns: AngularFireFunctions;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        AngularFireModule.initializeApp(COMMON_CONFIG),
+        AngularFireFunctionsModule
+      ]
+    });
+    inject([FirebaseApp, AngularFireFunctions], (app_: FirebaseApp, _fn: AngularFireFunctions) => {
+      app = app_;
+      afFns = _fn;
+    })();
+  });
+
+  afterEach(done => {
+    app.delete();
+    done();
+  });
+
+  it('should be exist', () => {
+    expect(afFns instanceof AngularFireFunctions).toBe(true);
+  });
+
+  it('should have the Firebase Functions instance', () => {
+    expect(afFns.functions).toBeDefined();
+  });
+
+});
+
+const FIREBASE_APP_NAME_TOO = (Math.random() + 1).toString(36).substring(7);
+
+describe('AngularFireFunctions with different app', () => {
+  let app: FirebaseApp;
+  let afFns: AngularFireFunctions;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        AngularFireModule.initializeApp(COMMON_CONFIG),
+        AngularFireFunctionsModule
+      ],
+      providers: [
+        { provide: FirebaseNameOrConfigToken, useValue: FIREBASE_APP_NAME_TOO },
+        { provide: FirebaseOptionsToken, useValue: COMMON_CONFIG }
+      ]
+    });
+    inject([FirebaseApp, AngularFireFunctions], (app_: FirebaseApp, _fns: AngularFireFunctions) => {
+      app = app_;
+      afFns = _fns;
+    })();
+  });
+
+  afterEach(done => {
+    app.delete();
+    done();
+  });
+
+  describe('<constructor>', () => {
+
+    it('should be an AngularFireAuth type', () => {
+      expect(afFns instanceof AngularFireFunctions).toEqual(true);
+    });
+
+  });
+
+});

src/functions/functions.ts

@@ -0,0 +1,46 @@
+import { FirebaseFunctions } from '@firebase/functions-types';
+import { FirebaseOptions, FirebaseAppConfig } from '@firebase/app-types';
+import { Injectable, Inject, Optional, NgZone, PLATFORM_ID } from '@angular/core';
+import { Observable, from } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+import { FirebaseOptionsToken, FirebaseNameOrConfigToken, _firebaseAppFactory, FirebaseZoneScheduler } from 'angularfire2';
+
+@Injectable()
+export class AngularFireFunctions {
+
+  /**
+   * Firebase Functions instance
+   */
+  public readonly functions: FirebaseFunctions;
+
+  public readonly scheduler: FirebaseZoneScheduler;
+
+  constructor(
+    @Inject(FirebaseOptionsToken) options:FirebaseOptions,
+    @Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
+    @Inject(PLATFORM_ID) platformId: Object,
+    zone: NgZone
+  ) {
+    this.scheduler = new FirebaseZoneScheduler(zone, platformId);
+    
+    this.functions = zone.runOutsideAngular(() => {
+      const app = _firebaseAppFactory(options, nameOrConfig);
+      return app.functions();
+    });
+
+  }
+
+  public httpsCallable<T=any, R=any>(name: string) {
+    const callable = this.functions.httpsCallable(name);
+    return (data: T) => {
+      const callable$ = from(callable(data));
+      return this.scheduler.runOutsideAngular(
+        callable$.pipe(
+          map(r => r.data as R)
+        )
+      )
+    }
+  }
+
+}

src/functions/index.spec.ts

@@ -0,0 +1 @@
+import './functions.spec';

src/functions/index.ts

@@ -0,0 +1 @@
+export * from './public_api';

src/functions/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "angularfire2/functions",
+  "version": "ANGULARFIRE2_VERSION",
+  "description": "The functions module",
+  "main": "../bundles/functions.umd.js",
+  "module": "index.js",
+  "es2015": "./es2015/index.js",
+  "keywords": [
+    "angular",
+    "firebase",
+    "rxjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/angular/angularfire2.git"
+  },
+  "author": "angular,firebase",
+  "license": "MIT",
+  "peerDependencies": {
+    "angularfire2": "ANGULARFIRE2_VERSION",
+    "@angular/common": "ANGULAR_VERSION",
+    "@angular/core": "ANGULAR_VERSION",
+    "@angular/platform-browser": "ANGULAR_VERSION",
+    "@angular/platform-browser-dynamic": "ANGULAR_VERSION",
+    "@firebase/app": "FIREBASE_APP_VERSION",
+    "@firebase/functions": "FIREBASE_FUNCTIONS_VERSION",
+    "rxjs": "RXJS_VERSION",
+    "zone.js": "ZONEJS_VERSION"
+  },
+  "typings": "index.d.ts"
+}

src/functions/public_api.ts

@@ -0,0 +1,2 @@
+export * from './functions';
+export * from './functions.module';