Implement register() and FID-based registration with onRegistered / onUnregistered by zwu52 · Pull Request #9714 · firebase/firebase-js-sdk

zwu52 · 2026-03-11T02:49:31Z

Implements Phase 2 of FCM Web modernization: a new register() API that links the app to its Firebase Installation ID (FID) and delivers it via the onRegistered callback, plus onUnregistered for when a FID is deactivated. This supports moving from legacy FCM tokens to FID as the primary send target.

register(messaging, options?) ensures VAPID and service worker are set, gets the FID from Installations, and invokes onRegistered with it (same options as getToken). When register() is called multiple times, onRegistered is only invoked when the FID changes from the last notified value (or on first call). The “get FID → compare → notify” step is serialized so concurrent register() calls do not trigger duplicate callbacks for the same FID.

New surface: onRegistered(messaging, nextOrObserver) and onUnregistered(messaging, nextOrObserver) for subscribing to FID delivery and deactivation. Unit tests cover options passthrough, observer vs function handler, FID source, and the dedupe and three-call FID-change behavior. All 78 messaging tests pass.

gemini-code-assist · 2026-03-11T02:49:35Z

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

changeset-bot · 2026-03-11T02:49:36Z

⚠️ No Changeset found

Latest commit: ef850be

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

…llback (draft) Made-with: Cursor

- Restore copyright year to 2020; add JSDoc for FID-dedupe behavior - Serialize get FID + compare + notify to avoid duplicate callback on concurrent register() - Add lastNotifiedFid assertion and three-call FID-change test Made-with: Cursor

packages/messaging/src/api/register.ts

DellaBitta · 2026-03-19T18:14:45Z

packages/messaging/src/api/register.test.ts

@@ -0,0 +1,200 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC


nit: the copyright on these new files should be 2026

Made-with: Cursor

Doris-Ge · 2026-03-20T17:35:42Z

packages/messaging/src/internals/register-fid.ts

+ * limitations under the License.
+ */
+
+import { SubscriptionOptions } from '../interfaces/token-details';


nit: Maybe rename this file to registration-details if easy

easy with ai 🤖 done

Doris-Ge · 2026-03-20T17:41:32Z

packages/messaging/src/internals/requests.ts

+  // `FID_REGISTRATION_FAILED` to keep the error surface uniform.
+  // Best-effort extraction of error details; the main signal is response.ok / status.
+  try {
+    const responseData = (await response.json()) as ApiResponse;


If only this line could throw an error, can we just surround it with try-catch?

The current structure is a bit confusing.

packages/messaging/src/api/register.ts

packages/messaging/src/api/register.test.ts

packages/messaging/src/api/register.ts

packages/messaging/src/api.ts

packages/messaging/src/api/register.ts

Doris-Ge · 2026-03-20T18:11:14Z

packages/messaging/src/internals/requests.ts

+      getEndpoint(firebaseDependencies.appConfig),
+      subscribeOptions
+    );
+  } catch (err) {


Shall we retry a few times on a retriable error?

implemented a exponential backup for max 3 times retry.

…lint Made-with: Cursor

Doris-Ge · 2026-03-20T21:49:34Z

packages/messaging/src/util/errors.ts

-    'called before calling getToken() to ensure your VAPID key is used.'
+    'called before calling getToken() to ensure your VAPID key is used.',
+  [ErrorCode.INVALID_ON_REGISTERED_HANDLER]:
+    'No onRegistered callback handler was provided or registered. Call onRegistered() before register().'


Suggested change

'No onRegistered callback handler was provided or registered. Call onRegistered() before register().'

'No onRegistered callback handler was provided or registered. Implement onRegistered() before register().'

Doris-Ge · 2026-03-20T21:57:48Z

packages/messaging/src/internals/requests.ts

+    if (err instanceof Error) {
+      throw err;
+    }


Do we need this based on the above comment?

// Best-effort parse the body to extract `error.message`, but always fail with // `FID_REGISTRATION_FAILED` to keep the error surface uniform.

Doris-Ge · 2026-03-20T22:00:08Z

packages/messaging/src/internals/register-fid.ts

+ * For the new FID-based register path:
+ * - Create (or refresh) an FCM Web registration in the backend via CreateRegistration.
+ * - Use the FIS auth token produced by the installations instance (implicitly associated with FID).
+ * - Only rely on HTTP success/failure (do not depend on returned FCM token).


nit: It's unclear to me what "returned FCM token" means. Do you mean FID?

Doris-Ge · 2026-03-20T22:03:04Z

packages/messaging/src/helpers/migrate-old-database.ts

 import { arrayToBase64 } from './array-base64-translator';

-// https://github.com/firebase/firebase-js-sdk/blob/7857c212f944a2a9eb421fd4cb7370181bc034b5/packages/messaging/src/interfaces/token-details.ts
+// https://github.com/firebase/firebase-js-sdk/blob/7857c212f944a2a9eb421fd4cb7370181bc034b5/packages/messaging/src/interfaces/registration-details.ts


Revert this change as the updated link is invalid. Same for the following changes.

Doris-Ge · 2026-03-20T22:09:09Z

packages/messaging/src/api/register.ts

+  if (!navigator) {
+    throw ERROR_FACTORY.create(ErrorCode.AVAILABLE_IN_WINDOW);
+  }
+
+  if (Notification.permission === 'default') {
+    await Notification.requestPermission();
+  }
+
+  if (Notification.permission !== 'granted') {
+    throw ERROR_FACTORY.create(ErrorCode.PERMISSION_BLOCKED);
+  }


Do we need unit tests to cover these logics?

zwu52 requested review from a team as code owners March 11, 2026 02:49

zwu52 added 2 commits March 10, 2026 19:51

feat(messaging): Phase 2 concurrent registration - register(), FID ca…

54c307a

…llback (draft) Made-with: Cursor

zwu52 force-pushed the feat/messaging-phase2-concurrent-registration branch from 182879a to 39f546b Compare March 11, 2026 02:52

OrlandriaH-G approved these changes Mar 11, 2026

View reviewed changes

zwu52 assigned Doris-Ge Mar 11, 2026

zwu52 requested a review from Doris-Ge March 11, 2026 17:21

Doris-Ge reviewed Mar 16, 2026

View reviewed changes

packages/messaging/src/api/register.ts Show resolved Hide resolved

Doris-Ge reviewed Mar 17, 2026

View reviewed changes

packages/messaging/src/api/register.ts Show resolved Hide resolved

packages/messaging/src/api/register.ts Show resolved Hide resolved

DellaBitta reviewed Mar 19, 2026

View reviewed changes

zwu52 added 2 commits March 19, 2026 11:57

feat(messaging): implement FID-based register request

ed875ca

Made-with: Cursor

Update copyright year in register.test.ts

058a90d

zwu52 requested a review from Doris-Ge March 19, 2026 19:07

Doris-Ge reviewed Mar 20, 2026

View reviewed changes

refactor(messaging): persist registration details, fix requests test …

ef850be

…lint Made-with: Cursor

zwu52 requested a review from Doris-Ge March 20, 2026 21:04

Doris-Ge approved these changes Mar 20, 2026

View reviewed changes

	'No onRegistered callback handler was provided or registered. Call onRegistered() before register().'
	'No onRegistered callback handler was provided or registered. Implement onRegistered() before register().'

Conversation

zwu52 commented Mar 11, 2026

Uh oh!

gemini-code-assist bot commented Mar 11, 2026

Uh oh!

changeset-bot bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zwu52 Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Mar 11, 2026 •

edited

Loading

zwu52 Mar 20, 2026 •

edited

Loading