Skip to content

Commit 26f7613

Browse files
davideastdavideast
authored
feat(messaging): AngularFireMessaing (#1749)
* feat(messaging): AngularFireMessaing * Zone.js and DI on top of this work, also fixing a couple small things * Cleanup the build
1 parent f2bfda9 commit 26f7613

14 files changed

+218
-6
lines changed

‎src/messaging/index.spec.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './messaging.spec';

‎src/messaging/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './public_api';

‎src/messaging/messaging.module.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import { NgModule } from '@angular/core';
2+
import { AngularFireModule, FirebaseApp } from 'angularfire2';
3+
import { AngularFireMessaging } from './messaging';
4+
import 'firebase/messaging';
5+
6+
@NgModule({
7+
providers: [ AngularFireMessaging ]
8+
})
9+
export class AngularFireMessagingModule { }

‎src/messaging/messaging.ts

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
import { Injectable, Inject, Optional, NgZone, PLATFORM_ID } from '@angular/core';
2+
import { isPlatformBrowser } from '@angular/common';
3+
import { messaging } from 'firebase';
4+
import { requestPermission } from './observable/request-permission';
5+
import { Observable, empty, from, of, throwError } from 'rxjs';
6+
import { mergeMap, catchError } from 'rxjs/operators';
7+
import { FirebaseOptions, FirebaseAppConfig } from 'angularfire2';
8+
import { FirebaseOptionsToken, FirebaseNameOrConfigToken, _firebaseAppFactory, FirebaseZoneScheduler } from 'angularfire2';
9+
10+
@Injectable()
11+
export class AngularFireMessaging {
12+
messaging: messaging.Messaging;
13+
requestPermission: Observable<void>;
14+
getToken: Observable<string|null>;
15+
tokenChanges: Observable<string|null>;
16+
messages: Observable<{}>;
17+
requestToken: Observable<string|null>;
18+
deleteToken: (string) => Observable<boolean>;
19+
20+
constructor(
21+
@Inject(FirebaseOptionsToken) options:FirebaseOptions,
22+
@Optional() @Inject(FirebaseNameOrConfigToken) nameOrConfig:string|FirebaseAppConfig|undefined,
23+
@Inject(PLATFORM_ID) platformId: Object,
24+
zone: NgZone
25+
) {
26+
const scheduler = new FirebaseZoneScheduler(zone, platformId);
27+
this.messaging = zone.runOutsideAngular(() => {
28+
const app = _firebaseAppFactory(options, nameOrConfig);
29+
return app.messaging();
30+
});
31+
32+
if (isPlatformBrowser(platformId)) {
33+
34+
this.requestPermission = scheduler.runOutsideAngular(
35+
requestPermission(this.messaging)
36+
);
37+
38+
this.getToken = scheduler.runOutsideAngular(
39+
from(this.messaging.getToken())
40+
);
41+
42+
this.tokenChanges = scheduler.runOutsideAngular(
43+
new Observable(subscriber => {
44+
this.messaging.getToken().then(t => subscriber.next(t));
45+
this.messaging.onTokenRefresh(subscriber.next);
46+
})
47+
);
48+
49+
this.messages = scheduler.runOutsideAngular(
50+
new Observable(subscriber => {
51+
this.messaging.onMessage(subscriber.next);
52+
})
53+
);
54+
55+
this.requestToken = this.requestPermission.pipe(
56+
catchError(() => of(null)),
57+
mergeMap(() => this.tokenChanges),
58+
);
59+
60+
} else {
61+
62+
this.requestPermission = throwError('Not available on server platform.');
63+
this.getToken = of(null);
64+
this.tokenChanges = of(null);
65+
this.messages = empty();
66+
this.requestToken = of(null);
67+
68+
}
69+
70+
this.deleteToken = (token: string) => scheduler.runOutsideAngular(
71+
from(this.messaging.deleteToken(token))
72+
);
73+
}
74+
75+
}

‎src/messaging/observable/request-permission.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { Observable, from } from 'rxjs';
2+
import { messaging } from 'firebase';
3+
4+
export function requestPermission(messaging: messaging.Messaging): Observable<void> {
5+
return from(messaging.requestPermission()!);
6+
}

‎src/messaging/package.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "angularfire2/messaging",
3+
"version": "ANGULARFIRE2_VERSION",
4+
"description": "The messaging module",
5+
"main": "../bundles/messaging.umd.js",
6+
"module": "index.js",
7+
"es2015": "./es2015/index.js",
8+
"keywords": [
9+
"angular",
10+
"firebase",
11+
"rxjs"
12+
],
13+
"repository": {
14+
"type": "git",
15+
"url": "git+https://github.com/angular/angularfire2.git"
16+
},
17+
"author": "angular,firebase",
18+
"license": "MIT",
19+
"peerDependencies": {
20+
"angularfire2": "ANGULARFIRE2_VERSION",
21+
"@angular/common": "ANGULAR_VERSION",
22+
"@angular/core": "ANGULAR_VERSION",
23+
"@angular/platform-browser": "ANGULAR_VERSION",
24+
"@angular/platform-browser-dynamic": "ANGULAR_VERSION",
25+
"@firebase/app": "FIREBASE_APP_VERSION",
26+
"@firebase/messaging": "FIREBASE_MESSAGING_VERSION",
27+
"rxjs": "RXJS_VERSION",
28+
"zone.js": "ZONEJS_VERSION"
29+
},
30+
"typings": "index.d.ts"
31+
}

‎src/messaging/public_api.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export * from './observable/request-permission';
2+
export * from './messaging';
3+
export * from './messaging.module';

‎src/messaging/test-config.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
export const COMMON_CONFIG = {
3+
apiKey: "AIzaSyBVSy3YpkVGiKXbbxeK0qBnu3-MNZ9UIjA",
4+
authDomain: "angularfire2-test.firebaseapp.com",
5+
databaseURL: "https://angularfire2-test.firebaseio.com",
6+
storageBucket: "angularfire2-test.appspot.com",
7+
messagingSenderId: "920323787688"
8+
};

‎src/messaging/tsconfig-build.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"compilerOptions": {
3+
"baseUrl": ".",
4+
"experimentalDecorators": true,
5+
"emitDecoratorMetadata": true,
6+
"module": "es2015",
7+
"target": "es2015",
8+
"noImplicitAny": false,
9+
"outDir": "../../dist/packages-dist/messaging/es2015",
10+
"rootDir": ".",
11+
"sourceMap": true,
12+
"inlineSources": true,
13+
"declaration": false,
14+
"removeComments": true,
15+
"strictNullChecks": true,
16+
"lib": ["es2015", "dom", "es2015.promise", "es2015.collection", "es2015.iterable"],
17+
"skipLibCheck": true,
18+
"moduleResolution": "node",
19+
"paths": {
20+
"angularfire2": ["../../dist/packages-dist"]
21+
}
22+
},
23+
"files": [
24+
"index.ts",
25+
"../../node_modules/zone.js/dist/zone.js.d.ts"
26+
],
27+
"angularCompilerOptions": {
28+
"skipTemplateCodegen": true,
29+
"strictMetadataEmit": true,
30+
"enableSummariesForJit": false
31+
}
32+
}
33+

‎src/messaging/tsconfig-esm.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"extends": "./tsconfig-build.json",
3+
"compilerOptions": {
4+
"target": "es5",
5+
"outDir": "../../dist/packages-dist/messaging",
6+
"declaration": true
7+
},
8+
"files": [
9+
"public_api.ts",
10+
"../../node_modules/zone.js/dist/zone.js.d.ts"
11+
],
12+
"angularCompilerOptions": {
13+
"skipTemplateCodegen": true,
14+
"strictMetadataEmit": true,
15+
"enableSummariesForJit": false,
16+
"flatModuleOutFile": "index.js",
17+
"flatModuleId": "angularfire2/messaging"
18+
}
19+
}

‎src/messaging/tsconfig-test.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"extends": "./tsconfig-esm.json",
3+
"compilerOptions": {
4+
"baseUrl": ".",
5+
"paths": {
6+
"angularfire2": ["../../dist/packages-dist"]
7+
}
8+
},
9+
"files": [
10+
"index.spec.ts",
11+
"../../node_modules/zone.js/dist/zone.js.d.ts"
12+
]
13+
}

‎src/root.spec.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export * from './packages-dist/database/list/snapshot-changes.spec';
1313
export * from './packages-dist/database/list/state-changes.spec';
1414
export * from './packages-dist/database/list/audit-trail.spec';
1515
export * from './packages-dist/storage/storage.spec';
16+
//export * from './packages-dist/messaging/messaging.spec';
1617

1718
// // Since this a deprecated API, we run on it on manual tests only
1819
// // It needs a network connection to run which makes it flaky on Travis

‎src/tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"angularfire2/firestore": ["./firestore"],
1717
"angularfire2/functions": ["./functions"],
1818
"angularfire2/storage": ["./storage"],
19+
"angularfire2/messaging": ["./messaging"],
1920
"angularfire2/database-deprecated": ["./database-deprecated"]
2021
},
2122
"rootDir": ".",

‎tools/build.js

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ const GLOBALS = {
2020
'firebase/app': 'firebase',
2121
'firebase/auth': 'firebase',
2222
'firebase/database': 'firebase',
23+
'firebase/messaging': 'firebase',
2324
'firebase/firestore': 'firebase',
2425
'firebase/functions': 'firebase',
2526
'firebase/storage': 'firebase',
@@ -29,7 +30,8 @@ const GLOBALS = {
2930
'angularfire2/database-deprecated': 'angularfire2.database_deprecated',
3031
'angularfire2/firestore': 'angularfire2.firestore',
3132
'angularfire2/functions': 'angularfire2.functions',
32-
'angularfire2/storage': 'angularfire2.storage'
33+
'angularfire2/storage': 'angularfire2.storage',
34+
'angularfire2/messaging': 'angularfire2.messaging',
3335
};
3436

3537
// Map of dependency versions across all packages
@@ -53,7 +55,8 @@ const MODULE_NAMES = {
5355
"database-deprecated": 'angularfire2.database_deprecated',
5456
firestore: 'angularfire2.firestore',
5557
functions: 'angularfire2.functions',
56-
storage: 'angularfire2.storage'
58+
storage: 'angularfire2.storage',
59+
messaging: 'angularfire2.messaging',
5760
};
5861

5962
const ENTRIES = {
@@ -63,7 +66,8 @@ const ENTRIES = {
6366
"database-deprecated": `${process.cwd()}/dist/packages-dist/database-deprecated/index.js`,
6467
firestore: `${process.cwd()}/dist/packages-dist/firestore/index.js`,
6568
functions: `${process.cwd()}/dist/packages-dist/functions/index.js`,
66-
storage: `${process.cwd()}/dist/packages-dist/storage/index.js`
69+
storage: `${process.cwd()}/dist/packages-dist/storage/index.js`,
70+
messaging: `${process.cwd()}/dist/packages-dist/messaging/index.js`,
6771
};
6872

6973
const SRC_PKG_PATHS = {
@@ -74,7 +78,8 @@ const SRC_PKG_PATHS = {
7478
firestore: `${process.cwd()}/src/firestore/package.json`,
7579
"firebase-node": `${process.cwd()}/src/firebase-node/package.json`,
7680
functions: `${process.cwd()}/src/functions/package.json`,
77-
storage: `${process.cwd()}/src/storage/package.json`
81+
storage: `${process.cwd()}/src/storage/package.json`,
82+
messaging: `${process.cwd()}/src/messaging/package.json`,
7883
};
7984

8085
const DEST_PKG_PATHS = {
@@ -85,7 +90,8 @@ const DEST_PKG_PATHS = {
8590
firestore: `${process.cwd()}/dist/packages-dist/firestore/package.json`,
8691
"firebase-node": `${process.cwd()}/dist/packages-dist/firebase-node/package.json`,
8792
functions: `${process.cwd()}/dist/packages-dist/functions/package.json`,
88-
storage: `${process.cwd()}/dist/packages-dist/storage/package.json`
93+
storage: `${process.cwd()}/dist/packages-dist/storage/package.json`,
94+
messaging: `${process.cwd()}/dist/packages-dist/messaging/package.json`,
8995
};
9096

9197
// Constants for running typescript commands
@@ -246,6 +252,7 @@ function getVersions() {
246252
getDestPackageFile('firebase-node'),
247253
getDestPackageFile('functions'),
248254
getDestPackageFile('storage'),
255+
getDestPackageFile('messaging'),
249256
getDestPackageFile('database-deprecated')
250257
];
251258
return paths
@@ -285,14 +292,16 @@ function buildModules(globals) {
285292
const firestore$ = buildModule('firestore', globals);
286293
const functions$ = buildModule('functions', globals);
287294
const storage$ = buildModule('storage', globals);
295+
const messaging$ = buildModule('messaging', globals);
288296
const dbdep$ = buildModule('database-deprecated', globals);
289297
return forkJoin(core$, from(copyRootTest())).pipe(
290298
switchMapTo(auth$),
291299
switchMapTo(db$),
292300
switchMapTo(firestore$),
293301
switchMapTo(functions$),
294302
switchMapTo(storage$),
295-
switchMapTo(dbdep$)
303+
switchMapTo(messaging$),
304+
switchMapTo(dbdep$),
296305
);
297306
}
298307

@@ -312,6 +321,7 @@ function buildLibrary(globals) {
312321
const fsStats = measure('firestore');
313322
const functionsStats = measure('functions');
314323
const storageStats = measure('storage');
324+
const messagingStats = measure('messaging');
315325
const dbdepStats = measure('database-deprecated');
316326
console.log(`
317327
core.umd.js - ${coreStats.size}, ${coreStats.gzip}
@@ -320,6 +330,7 @@ function buildLibrary(globals) {
320330
firestore.umd.js - ${fsStats.size}, ${fsStats.gzip}
321331
functions.umd.js - ${functionsStats.size}, ${functionsStats.gzip}
322332
storage.umd.js - ${storageStats.size}, ${storageStats.gzip}
333+
messaging.umd.js - ${messagingStats.size}, ${messagingStats.gzip}
323334
database-deprecated.umd.js - ${dbdepStats.size}, ${dbdepStats.gzip}
324335
`);
325336
verifyVersions();

0 commit comments

Comments
 (0)