FCM Pre Modularization #3234

zwu52 · 2020-06-18T16:34:32Z

[ariane/4026631 IS APPROVED]

This PR implement "Milestone I" in section: API Change Plan: Deprecation, Removal, Addition. Specially, this PR:

Mark Deprecate:

setBackgroundHandler (instead divert developer to use onBackgroundMessage)
onTokenRefresh (currently no-op and we have no plan to implement in foreseeable future)
useVapidKey (divert developer to use getToken(options:{serviceWorkerRegistration, vapidKey})
useServiceWorker (divert developer to use getToken(options:{serviceWorkerRegistration, vapidKey})
getToken() (divert developer to use getToken(options:{serviceWorkerRegistration, vapidKey})

Add:

getToken(options:{serviceWorkerRegistration, vapidKey}
onBackgroundMessage
Typing for onBackgroundMessage: this would make easy for user to know what parameters are gettable.

google-oss-bot · 2020-06-18T16:44:48Z

Binary Size Report

Affected SDKs

@firebase/analytics

Type Base (b07f822) Head (93d6d22) Diff

esm2017 8.68 kB 9.89 kB +1.20 kB (+13.9%)

main 9.69 kB 11.1 kB +1.42 kB (+14.7%)

module 9.37 kB 10.8 kB +1.45 kB (+15.5%)
@firebase/auth

Type Base (b07f822) Head (93d6d22) Diff

browser ? 177 kB ? (?)
@firebase/database

Type Base (b07f822) Head (93d6d22) Diff

browser 268 kB 269 kB +849 B (+0.3%)

esm2017 235 kB 236 kB +524 B (+0.2%)

main 269 kB 270 kB +849 B (+0.3%)

module 267 kB 268 kB +844 B (+0.3%)

`@firebase/firestore`

Type	Base (`b07f822`)	Head (`93d6d22`)	Diff
browser	247 kB	249 kB	+1.87 kB (+0.8%)
esm2017	194 kB	195 kB	+1.33 kB (+0.7%)
main	495 kB	474 kB	-20.8 kB (-4.2%)
module	245 kB	246 kB	+1.64 kB (+0.7%)
react-native	194 kB	195 kB	+1.33 kB (+0.7%)

@firebase/firestore/exp

Type Base (b07f822) Head (93d6d22) Diff

browser ? 189 kB ? (?)

main 400 kB 467 kB +67.0 kB (+16.8%)

module ? 189 kB ? (?)

react-native ? 189 kB ? (?)
@firebase/firestore/lite

Type Base (b07f822) Head (93d6d22) Diff

browser ? 64.5 kB ? (?)

main 124 kB 141 kB +17.2 kB (+13.9%)

module ? 64.5 kB ? (?)

react-native ? 64.6 kB ? (?)

`@firebase/firestore/memory`

Type	Base (`b07f822`)	Head (`93d6d22`)	Diff
browser	185 kB	187 kB	+2.24 kB (+1.2%)
esm2017	145 kB	146 kB	+1.30 kB (+0.9%)
main	364 kB	348 kB	-15.8 kB (-4.3%)
module	183 kB	185 kB	+2.04 kB (+1.1%)
react-native	145 kB	146 kB	+1.30 kB (+0.9%)

@firebase/messaging

Type Base (b07f822) Head (93d6d22) Diff

esm2017 23.2 kB 25.9 kB +2.68 kB (+11.5%)

main 31.4 kB 34.6 kB +3.18 kB (+10.1%)

module 30.9 kB 34.1 kB +3.17 kB (+10.2%)

`@firebase/performance`

Type	Base (`b07f822`)	Head (`93d6d22`)	Diff
browser	26.7 kB	27.1 kB	+376 B (+1.4%)
esm2017	24.7 kB	25.1 kB	+359 B (+1.5%)
main	26.7 kB	27.1 kB	+376 B (+1.4%)
module	26.4 kB	26.8 kB	+376 B (+1.4%)

@firebase/storage

Type Base (b07f822) Head (93d6d22) Diff

esm2017 56.4 kB 54.9 kB -1.42 kB (-2.5%)

main 62.7 kB 61.3 kB -1.38 kB (-2.2%)

module 62.5 kB 61.1 kB -1.39 kB (-2.2%)

`@firebase/util`

Type	Base (`b07f822`)	Head (`93d6d22`)	Diff
browser	19.6 kB	20.5 kB	+893 B (+4.6%)
esm2017	17.5 kB	18.3 kB	+758 B (+4.3%)
main	19.6 kB	20.5 kB	+893 B (+4.6%)
module	18.7 kB	19.5 kB	+804 B (+4.3%)

@firebase/webchannel-wrapper

Type Base (b07f822) Head (93d6d22) Diff

esm2017 37.7 kB 39.4 kB +1.69 kB (+4.5%)

main 38.8 kB 41.0 kB +2.21 kB (+5.7%)

module 38.4 kB 40.6 kB +2.21 kB (+5.8%)

`firebase`

Click to show 15 binary size changes.

Type	Base (`b07f822`)	Head (`93d6d22`)	Diff
firebase-analytics.js	26.6 kB	28.3 kB	+1.72 kB (+6.5%)
firebase-app.js	19.9 kB	20.0 kB	+42 B (+0.2%)
firebase-auth.js	174 kB	173 kB	-184 B (-0.1%)
firebase-database.js	187 kB	187 kB	-486 B (-0.3%)
firebase-firestore.js	285 kB	288 kB	+2.30 kB (+0.8%)
firebase-firestore.memory.js	224 kB	227 kB	+3.05 kB (+1.4%)
firebase-functions.js	9.84 kB	9.88 kB	+43 B (+0.4%)
firebase-installations.js	19.2 kB	19.2 kB	+40 B (+0.2%)
firebase-messaging.js	39.2 kB	40.9 kB	+1.76 kB (+4.5%)
firebase-performance-standalone.es2017.js	72.0 kB	72.1 kB	+173 B (+0.2%)
firebase-performance-standalone.js	47.4 kB	47.4 kB	-24 B (-0.1%)
firebase-performance.js	37.8 kB	37.8 kB	-36 B (-0.1%)
firebase-remote-config.js	37.0 kB	37.0 kB	+40 B (+0.1%)
firebase-storage.js	40.9 kB	39.9 kB	-979 B (-2.4%)
firebase.js	819 kB	823 kB	+3.81 kB (+0.5%)

Test Logs

Base (b07f822b): https://github.com/firebase/firebase-js-sdk/actions/runs/167951201
Head (93d6d220): https://github.com/firebase/firebase-js-sdk/actions/runs/204507889

changeset-bot · 2020-06-28T20:07:15Z

🦋 Changeset is good to go

Latest commit: 374dc78

We got this.

This PR includes changesets to release 13 packages

Name	Type
firebase	Minor
@firebase/messaging
@firebase/messaging-types	Minor
rxfire	Major
@firebase/testing	Patch
firebase-browserify-test	Patch
firebase-package-typings-test	Patch
firebase-messaging-selenium-test	Patch
firebase-typescript-test	Patch
firebase-webpack-test	Patch
@firebase/functions	Patch
@firebase/functions-exp	Patch
firebase-exp	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

…into api

kroikie

I would also recommend letting @egilmorez have a look at the comments.

integration/messaging/test/static/helpers.js

integration/messaging/test/static/valid-vapid-key-modern-sw/sw.js

packages/firebase/index.d.ts

…into api

egilmorez

Some wordsmithing things to look at Kai. Thanks!

packages/firebase/index.d.ts

Feiyang1

Added some comments. There is a bunch of formatting issues. Can you please run prettier on all files?

packages/firebase/index.d.ts

packages/messaging/src/helpers/externalizePayload.ts

packages/messaging/src/controllers/window-controller.test.ts

…into api sync head

zwu52

requested change will be included in the upcoming commit

packages/firebase/index.d.ts

packages/messaging/src/controllers/sw-controller.test.ts

packages/messaging/src/helpers/externalizePayload.ts

packages/messaging/src/controllers/sw-controller.ts

packages/messaging/src/controllers/window-controller.ts

zwu52 · 2020-07-09T18:31:42Z

packages/messaging/src/controllers/window-controller.ts

+        TAG +
+          'no sw has been provided explicitly. Attempting to find firebase-messaging-sw.js in default directory.'
+      );
+      await this.registerDefaultSw();


packages/messaging/src/controllers/window-controller.ts

egilmorez

LG with a one-word nit, thanks!

packages/firebase/index.d.ts

…o api

packages/installations/package.json

packages/messaging/package.json

.changeset/strange-crabs-tell.md

packages/messaging/src/controllers/sw-controller.test.ts

packages/messaging/src/controllers/sw-controller.ts

packages/messaging/src/controllers/window-controller.ts

FCM Pre Modualization

22a0ce5

zwu52 requested a review from egilmorez as a code owner June 18, 2020 16:34

zwu52 marked this pull request as draft June 18, 2020 16:34

zwu52 requested review from Feiyang1, hsubox76 and a team June 18, 2020 16:35

Refactor FCM typing

78b0e73

zwu52 added 4 commits June 28, 2020 21:18

Polish javascript doc

3e4f2d6

Merge branch 'master' of https://github.com/firebase/firebase-js-sdk …

3aa4d88

…into api

Update index.d.ts

d504772

Add Changeset

0dfecf6

zwu52 requested a review from kroikie June 29, 2020 18:26

Fix changeset from major to minor

31fa196

zwu52 assigned Feiyang1, hsubox76, kroikie and egilmorez Jun 29, 2020

zwu52 marked this pull request as ready for review June 29, 2020 18:40

zwu52 requested review from alikn, andirayo, avolkovi, erikeldridge, sam-gc, scottcrossen, yuchenshi and zijianjoy as code owners June 29, 2020 18:40

Add to changeset

d058ba4

kroikie approved these changes Jul 1, 2020

View reviewed changes

zwu52 added 2 commits July 7, 2020 12:25

Merge branch 'master' of https://github.com/firebase/firebase-js-sdk …

5b719a8

…into api

Polished index.d.ts based on Arthur's feedback

8aedf92

egilmorez reviewed Jul 7, 2020

View reviewed changes

Feiyang1 suggested changes Jul 8, 2020

View reviewed changes

Feiyang1 removed their assignment Jul 8, 2020

Merge branch 'master' of https://github.com/firebase/firebase-js-sdk …

d1670fe

…into api sync head

zwu52 commented Jul 9, 2020

View reviewed changes

Polish PR based on feedbacks

0403b84

zwu52 requested review from Feiyang1 and egilmorez July 9, 2020 23:02

zwu52 and others added 2 commits July 9, 2020 16:04

Update Changeset

436fa54

Merge branch 'master' into api

5624886

egilmorez approved these changes Jul 10, 2020

View reviewed changes

packages/firebase/index.d.ts Outdated Show resolved Hide resolved

zwu52 and others added 3 commits July 10, 2020 10:25

Merge branch 'master' into api

ed31954

Fix wording

6921af8

Merge branch 'api' of https://github.com/firebase/firebase-js-sdk int…

8911188

…o api

zwu52 assigned Feiyang1 Jul 10, 2020

Feiyang1 reviewed Aug 10, 2020

View reviewed changes

Polishing

374dc78

zwu52 requested a review from Feiyang1 August 11, 2020 20:00

Feiyang1 approved these changes Aug 11, 2020

View reviewed changes

zwu52 merged commit 29327b2 into master Aug 11, 2020

google-oss-bot mentioned this pull request Aug 11, 2020

Version Packages #3614

Merged

firebase locked and limited conversation to collaborators Sep 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FCM Pre Modularization #3234

FCM Pre Modularization #3234

zwu52 commented Jun 18, 2020 •

edited

google-oss-bot commented Jun 18, 2020 •

edited

`@firebase/analytics`

`@firebase/auth`

`@firebase/database`

`@firebase/firestore`

`@firebase/firestore/exp`

`@firebase/firestore/lite`

`@firebase/firestore/memory`

`@firebase/messaging`

`@firebase/performance`

`@firebase/storage`

`@firebase/util`

`@firebase/webchannel-wrapper`

`firebase`

changeset-bot bot commented Jun 28, 2020 •

edited

kroikie left a comment

egilmorez left a comment

Feiyang1 left a comment

zwu52 left a comment

zwu52 Jul 9, 2020

egilmorez left a comment

FCM Pre Modularization #3234

FCM Pre Modularization #3234

Conversation

zwu52 commented Jun 18, 2020 • edited

Mark Deprecate:

Add:

google-oss-bot commented Jun 18, 2020 • edited

Binary Size Report

Affected SDKs

@firebase/analytics

@firebase/auth

@firebase/database

@firebase/firestore

@firebase/firestore/exp

@firebase/firestore/lite

@firebase/firestore/memory

@firebase/messaging

@firebase/performance

@firebase/storage

@firebase/util

@firebase/webchannel-wrapper

firebase

Test Logs

changeset-bot bot commented Jun 28, 2020 • edited

🦋 Changeset is good to go

kroikie left a comment

Choose a reason for hiding this comment

egilmorez left a comment

Choose a reason for hiding this comment

Feiyang1 left a comment

Choose a reason for hiding this comment

zwu52 left a comment

Choose a reason for hiding this comment

zwu52 Jul 9, 2020

Choose a reason for hiding this comment

egilmorez left a comment

Choose a reason for hiding this comment

zwu52 commented Jun 18, 2020 •

edited

google-oss-bot commented Jun 18, 2020 •

edited

`@firebase/analytics`

`@firebase/auth`

`@firebase/database`

`@firebase/firestore`

`@firebase/firestore/exp`

`@firebase/firestore/lite`

`@firebase/firestore/memory`

`@firebase/messaging`

`@firebase/performance`

`@firebase/storage`

`@firebase/util`

`@firebase/webchannel-wrapper`

`firebase`

changeset-bot bot commented Jun 28, 2020 •

edited