Added a timeout

Author: hsubox76

.changeset/neat-beans-rescue.md

@@ -1,5 +1,5 @@
 ---
-'@firebase/messaging': patch
+'@firebase/messaging': minor
 ---
 
 Fix an issue where PushManager.subscribe() is called too soon after registering the default service worker.

common/api-review/messaging-sw.api.md

@@ -24,6 +24,7 @@ export function getMessaging(app?: FirebaseApp): Messaging;
 // @public
 export interface GetTokenOptions {
     serviceWorkerRegistration?: ServiceWorkerRegistration;
+    serviceWorkerRegistrationTimeout?: number;
     vapidKey?: string;
 }
 

common/api-review/messaging.api.md

@@ -27,6 +27,7 @@ export function getToken(messaging: Messaging, options?: GetTokenOptions): Promi
 // @public
 export interface GetTokenOptions {
     serviceWorkerRegistration?: ServiceWorkerRegistration;
+    serviceWorkerRegistrationTimeout?: number;
     vapidKey?: string;
 }
 

docs-devsite/messaging_.gettokenoptions.md

@@ -23,6 +23,7 @@ export interface GetTokenOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [serviceWorkerRegistration](./messaging_.gettokenoptions.md#gettokenoptionsserviceworkerregistration) | ServiceWorkerRegistration | The service worker registration for receiving push messaging. If the registration is not provided explicitly, you need to have a <code>firebase-messaging-sw.js</code> at your root location. See [Access the registration token](https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token) for more details. |
+|  [serviceWorkerRegistrationTimeout](./messaging_.gettokenoptions.md#gettokenoptionsserviceworkerregistrationtimeout) | number | Milliseconds to wait for service worker registration to complete before rejecting and throwing an error. Defaults to 10000. |
 |  [vapidKey](./messaging_.gettokenoptions.md#gettokenoptionsvapidkey) | string | The public server key provided to push services. The key is used to authenticate push subscribers to receive push messages only from sending servers that hold the corresponding private key. If it is not provided, a default VAPID key is used. Note that some push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended to generate and import a VAPID key for your project with [Configure Web Credentials with FCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services. |
 
 ## GetTokenOptions.serviceWorkerRegistration
@@ -35,6 +36,16 @@ The service worker registration for receiving push messaging. If the registratio
 serviceWorkerRegistration?: ServiceWorkerRegistration;
 ```
 
+## GetTokenOptions.serviceWorkerRegistrationTimeout
+
+Milliseconds to wait for service worker registration to complete before rejecting and throwing an error. Defaults to 10000.
+
+<b>Signature:</b>
+
+```typescript
+serviceWorkerRegistrationTimeout?: number;
+```
+
 ## GetTokenOptions.vapidKey
 
 The public server key provided to push services. The key is used to authenticate push subscribers to receive push messages only from sending servers that hold the corresponding private key. If it is not provided, a default VAPID key is used. Note that some push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended to generate and import a VAPID key for your project with [Configure Web Credentials with FCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services.

docs-devsite/messaging_sw.gettokenoptions.md

@@ -23,6 +23,7 @@ export interface GetTokenOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [serviceWorkerRegistration](./messaging_sw.gettokenoptions.md#gettokenoptionsserviceworkerregistration) | ServiceWorkerRegistration | The service worker registration for receiving push messaging. If the registration is not provided explicitly, you need to have a <code>firebase-messaging-sw.js</code> at your root location. See [Access the registration token](https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token) for more details. |
+|  [serviceWorkerRegistrationTimeout](./messaging_sw.gettokenoptions.md#gettokenoptionsserviceworkerregistrationtimeout) | number | Milliseconds to wait for service worker registration to complete before rejecting and throwing an error. Defaults to 10000. |
 |  [vapidKey](./messaging_sw.gettokenoptions.md#gettokenoptionsvapidkey) | string | The public server key provided to push services. The key is used to authenticate push subscribers to receive push messages only from sending servers that hold the corresponding private key. If it is not provided, a default VAPID key is used. Note that some push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended to generate and import a VAPID key for your project with [Configure Web Credentials with FCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services. |
 
 ## GetTokenOptions.serviceWorkerRegistration
@@ -35,6 +36,16 @@ The service worker registration for receiving push messaging. If the registratio
 serviceWorkerRegistration?: ServiceWorkerRegistration;
 ```
 
+## GetTokenOptions.serviceWorkerRegistrationTimeout
+
+Milliseconds to wait for service worker registration to complete before rejecting and throwing an error. Defaults to 10000.
+
+<b>Signature:</b>
+
+```typescript
+serviceWorkerRegistrationTimeout?: number;
+```
+
 ## GetTokenOptions.vapidKey
 
 The public server key provided to push services. The key is used to authenticate push subscribers to receive push messages only from sending servers that hold the corresponding private key. If it is not provided, a default VAPID key is used. Note that some push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended to generate and import a VAPID key for your project with [Configure Web Credentials with FCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services.

packages/messaging/src/api/deleteToken.ts

@@ -22,14 +22,15 @@ import { deleteTokenInternal } from '../internals/token-manager';
 import { registerDefaultSw } from '../helpers/registerDefaultSw';
 
 export async function deleteToken(
-  messaging: MessagingService
+  messaging: MessagingService,
+  swRegistrationTimeoutMillis?: number
 ): Promise<boolean> {
   if (!navigator) {
     throw ERROR_FACTORY.create(ErrorCode.AVAILABLE_IN_WINDOW);
   }
 
   if (!messaging.swRegistration) {
-    await registerDefaultSw(messaging);
+    await registerDefaultSw(messaging, swRegistrationTimeoutMillis);
   }
 
   return deleteTokenInternal(messaging);

packages/messaging/src/api/getToken.ts

@@ -40,7 +40,11 @@ export async function getToken(
   }
 
   await updateVapidKey(messaging, options?.vapidKey);
-  await updateSwReg(messaging, options?.serviceWorkerRegistration);
+  await updateSwReg(
+    messaging,
+    options?.serviceWorkerRegistration,
+    options?.serviceWorkerRegistrationTimeout
+  );
 
   return getTokenInternal(messaging);
 }

packages/messaging/src/helpers/registerDefaultSw.ts

@@ -15,13 +15,18 @@
  * limitations under the License.
  */
 
-import { DEFAULT_SW_PATH, DEFAULT_SW_SCOPE } from '../util/constants';
+import {
+  DEFAULT_REGISTRATION_TIMEOUT,
+  DEFAULT_SW_PATH,
+  DEFAULT_SW_SCOPE
+} from '../util/constants';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 
 import { MessagingService } from '../messaging-service';
 
 export async function registerDefaultSw(
-  messaging: MessagingService
+  messaging: MessagingService,
+  swRegistrationTimeoutMillis?: number
 ): Promise<void> {
   try {
     messaging.swRegistration = await navigator.serviceWorker.register(
@@ -39,7 +44,10 @@ export async function registerDefaultSw(
     messaging.swRegistration.update().catch(() => {
       /* it is non blocking and we don't care if it failed */
     });
-    await waitForRegistrationActive(messaging.swRegistration);
+    await waitForRegistrationActive(
+      messaging.swRegistration,
+      swRegistrationTimeoutMillis
+    );
   } catch (e) {
     throw ERROR_FACTORY.create(ErrorCode.FAILED_DEFAULT_REGISTRATION, {
       browserErrorMessage: (e as Error)?.message
@@ -57,21 +65,33 @@ export async function registerDefaultSw(
  * to become "active".
  */
 async function waitForRegistrationActive(
-  registration: ServiceWorkerRegistration
+  registration: ServiceWorkerRegistration,
+  swRegistrationTimeoutMillis: number = DEFAULT_REGISTRATION_TIMEOUT
 ): Promise<void> {
   return new Promise<void>((resolve, reject) => {
+    const rejectTimeout = setTimeout(
+      () =>
+        reject(
+          new Error(
+            `Service worker not registered after ${swRegistrationTimeoutMillis} ms`
+          )
+        ),
+      swRegistrationTimeoutMillis
+    );
+    const incomingSw = registration.installing || registration.waiting;
     if (registration.active) {
+      clearTimeout(rejectTimeout);
       resolve();
-    }
-    const incomingSw = registration.installing || registration.waiting;
-    if (incomingSw) {
+    } else if (incomingSw) {
       incomingSw.onstatechange = ev => {
         if ((ev.target as ServiceWorker)?.state === 'activated') {
           incomingSw.onstatechange = null;
+          clearTimeout(rejectTimeout);
           resolve();
         }
       };
     } else {
+      clearTimeout(rejectTimeout);
       reject(new Error('No incoming service worker found.'));
     }
   });

packages/messaging/src/helpers/updateSwReg.ts

@@ -22,10 +22,11 @@ import { registerDefaultSw } from './registerDefaultSw';
 
 export async function updateSwReg(
   messaging: MessagingService,
-  swRegistration?: ServiceWorkerRegistration | undefined
+  swRegistration?: ServiceWorkerRegistration | undefined,
+  swRegistrationTimeoutMillis?: number
 ): Promise<void> {
   if (!swRegistration && !messaging.swRegistration) {
-    await registerDefaultSw(messaging);
+    await registerDefaultSw(messaging, swRegistrationTimeoutMillis);
   }
 
   if (!swRegistration && !!messaging.swRegistration) {

packages/messaging/src/interfaces/public-types.ts

@@ -132,6 +132,11 @@ export interface GetTokenOptions {
    * for more details.
    */
   serviceWorkerRegistration?: ServiceWorkerRegistration;
+  /**
+   * Milliseconds to wait for service worker registration to complete before
+   * rejecting and throwing an error. Defaults to 10000.
+   */
+  serviceWorkerRegistrationTimeout?: number;
 }
 
 /**