fix(service-worker): avoid uncaught rejection warning when registration fails #30876

H--o-l · 2019-06-05T15:59:57Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

After using ServiceWorkerModule.register('/ngsw-worker.js'),, if you have an unstable internet connection, navigator.serviceWorker.register('/ngsw-worker.js') call can fail and your application can crash.
I think that the error can't be caught on the user side.

What is the new behavior?

If navigator.serviceWorker.register('/ngsw-worker.js') fail, there is no uncaught error anymore.

Does this PR introduce a breaking change?

Yes
No (I'm not completely sure)

Other information

N/A

googlebot · 2019-06-05T16:00:04Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

H--o-l · 2019-06-05T16:04:25Z

I signed it!

googlebot · 2019-06-05T16:05:27Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

gkalpak · 2019-06-05T19:31:07Z

packages/service-worker/src/module.ts

    readyToRegister$.pipe(take(1)).subscribe(
-        () => navigator.serviceWorker.register(script, {scope: options.scope}));
+        () => navigator.serviceWorker.register(script, {scope: options.scope}).catch(() => {}));


I don't think it is a good idea to swallow that error. If the SW fails to register (for whatever reason), the developer should know.
If you want to avoid that the uncaught rejection error, maybe we could explicitly pass it to console.error() inside the catch()? WDYT?

Hey @gkalpak, thanks for the feedback.
It's a good idea, here is the diff I just push in my commit:

--- a/packages/service-worker/src/module.ts +++ b/packages/service-worker/src/module.ts @@ -118,7 +118,9 @@ export function ngswAppInitializer( // Don't return anything to avoid blocking the application until the SW is registered. // Catch and ignore the error if SW registration fails. readyToRegister$.pipe(take(1)).subscribe( - () => navigator.serviceWorker.register(script, {scope: options.scope}).catch(() => {})); + () => + navigator.serviceWorker.register(script, {scope: options.scope}) + .catch(err => console.error('NGSW - service worker register failed with: ', err)));

PS: Would you be able to help me fixing the CI tests ?
If you think this fix is a good idea of course.

The failing tests on CI are due to the fact that we are mocking serviceWorker.register() here, but not returning a promise (which was not necessary before). You need to change the above line to something like:

-beforeEach(() => swRegisterSpy = spyOn(navigator.serviceWorker, 'register')); +beforeEach(() => swRegisterSpy = spyOn(navigator.serviceWorker, 'register').and.returnValue(Promise.resolve()));

gkalpak

Thx, @H--o-l. I left a couple of minor comments, but otherwise lgtm.
I also suggest some changes to the commit message:

Change the subject to fix(service-worker): avoid uncaught rejection warning when registration fails
Typo: "can failed" --> "can fail"
Typo: " a `Uncaught" --> "an `Uncaught"
Change the last sentence to describe the new behavior (i.e. logging the error and not ignoring the error).

gkalpak · 2019-06-06T12:28:07Z

packages/service-worker/src/module.ts

-    // Don't return anything to avoid blocking the application until the SW is registered or
-    // causing a crash if the SW registration fails.
+    // Don't return anything to avoid blocking the application until the SW is registered.
+    // Catch and ignore the error if SW registration fails.


We are not really ignoring it any more. Maybe change to Catch and log the error if SW registration fails to avoid uncaught rejection warning?

gkalpak · 2019-06-06T12:31:40Z

packages/service-worker/src/module.ts

-        () => navigator.serviceWorker.register(script, {scope: options.scope}));
+        () =>
+            navigator.serviceWorker.register(script, {scope: options.scope})
+                .catch(err => console.error('NGSW - service worker register failed with: ', err)));


I would change it to just Service worker registration failed with:.

H--o-l · 2019-06-06T16:14:20Z

@gkalpak, CI looks good, the fix was exactly what you proposed.
I also update the commit and commit message with changes you suggested.

Thanks for your help !

gkalpak

👍

Looking at the test fix again, I think it is a good idea to add a test for the new behavior (in module_spec.ts). It could go like this:

it('catches and a logs registration errors', async() => {
  const consoleErrorSpy = spyOn(console.error);
  swRegisterSpy.and.returnValue(Promise.reject('no reason'));

  await configTestBed({enabled: true, scope: 'foo'});
  expect(consoleErrorSpy).toHaveBeenCalledWith('Service worker registration failed with:' , 'no reason');
});

…on fails Service worker API `navigator.serviceWorker.register` can fail in multiple ways. For example, in Chrome, with an unstable network connection you can have the following error: `An unknown error occurred when fetching the script.` In the current state, it creates an `Uncaught (in promise) TypeError:` style of error, which cannot be caught by the user on his own. I think it's better to log the error over raising an error that cannot be caught.

H--o-l · 2019-06-07T10:27:37Z

Hey @gkalpak, thanks for the idea, and the test I should have wrote myself from the beginning.
I add it to the commit, inside the describe('register()', () => { test section.
CI looks to like it 💪

gkalpak

Great job! Thx, @H--o-l 👍

…on fails (#30876) Service worker API `navigator.serviceWorker.register` can fail in multiple ways. For example, in Chrome, with an unstable network connection you can have the following error: `An unknown error occurred when fetching the script.` In the current state, it creates an `Uncaught (in promise) TypeError:` style of error, which cannot be caught by the user on his own. I think it's better to log the error over raising an error that cannot be caught. PR Close #30876

angular-automatic-lock-bot · 2019-09-15T04:22:53Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

H--o-l requested a review from a team as a code owner June 5, 2019 15:59

googlebot added the cla: no label Jun 5, 2019

googlebot added cla: yes and removed cla: no labels Jun 5, 2019

H--o-l force-pushed the fix/do_not_crash_if_serviceWorker_fail branch from 2e8642e to a0ebcf5 Compare June 5, 2019 16:33

gkalpak requested changes Jun 5, 2019

View reviewed changes

gkalpak added area: service-worker Issues related to the @angular/service-worker package state: WIP target: patch This PR is targeted for the next patch release type: bug/fix labels Jun 5, 2019

ngbot bot added this to the needsTriage milestone Jun 5, 2019

H--o-l force-pushed the fix/do_not_crash_if_serviceWorker_fail branch from a0ebcf5 to 589c6ab Compare June 6, 2019 08:36

gkalpak requested changes Jun 6, 2019

View reviewed changes

H--o-l force-pushed the fix/do_not_crash_if_serviceWorker_fail branch from 589c6ab to 1d53c41 Compare June 6, 2019 15:22

H--o-l changed the title ~~fix(service-worker): don't crash if registration failed~~ fix(service-worker): avoid uncaught rejection warning when registration fails Jun 6, 2019

gkalpak requested changes Jun 6, 2019

View reviewed changes

H--o-l force-pushed the fix/do_not_crash_if_serviceWorker_fail branch from 1d53c41 to 31f7764 Compare June 7, 2019 08:57

gkalpak approved these changes Jun 7, 2019

View reviewed changes

gkalpak added action: merge The PR is ready for merge by the caretaker and removed state: WIP labels Jun 7, 2019

mhevery closed this in 81c2a94 Jun 7, 2019

angelkenneth mentioned this pull request Jul 22, 2019

Registering Service Worker causes uncaught "SecurityError: The operation is insecure" when Firefox cookie settings is set to "Keep unitl Firefox is closed" #28373

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(service-worker): avoid uncaught rejection warning when registration fails #30876

fix(service-worker): avoid uncaught rejection warning when registration fails #30876

Uh oh!

H--o-l commented Jun 5, 2019 •

edited

Loading

Uh oh!

googlebot commented Jun 5, 2019

Uh oh!

H--o-l commented Jun 5, 2019

Uh oh!

googlebot commented Jun 5, 2019

Uh oh!

gkalpak Jun 5, 2019

Uh oh!

H--o-l Jun 6, 2019

Uh oh!

gkalpak Jun 6, 2019

Uh oh!

gkalpak left a comment

Uh oh!

gkalpak Jun 6, 2019

Uh oh!

gkalpak Jun 6, 2019

Uh oh!

H--o-l commented Jun 6, 2019

Uh oh!

gkalpak left a comment

Uh oh!

H--o-l commented Jun 7, 2019

Uh oh!

gkalpak left a comment

Uh oh!

angular-automatic-lock-bot bot commented Sep 15, 2019

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(service-worker): avoid uncaught rejection warning when registration fails #30876

fix(service-worker): avoid uncaught rejection warning when registration fails #30876

Uh oh!

Conversation

H--o-l commented Jun 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

googlebot commented Jun 5, 2019

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

H--o-l commented Jun 5, 2019

Uh oh!

googlebot commented Jun 5, 2019

Uh oh!

gkalpak Jun 5, 2019

Choose a reason for hiding this comment

Uh oh!

H--o-l Jun 6, 2019

Choose a reason for hiding this comment

Uh oh!

gkalpak Jun 6, 2019

Choose a reason for hiding this comment

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

gkalpak Jun 6, 2019

Choose a reason for hiding this comment

Uh oh!

gkalpak Jun 6, 2019

Choose a reason for hiding this comment

Uh oh!

H--o-l commented Jun 6, 2019

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

H--o-l commented Jun 7, 2019

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

angular-automatic-lock-bot bot commented Sep 15, 2019

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

H--o-l commented Jun 5, 2019 •

edited

Loading