feat(service-worker): add support for configuring navigations URLs by gkalpak · Pull Request #23339 · angular/angular

gkalpak · 2018-04-12T15:29:22Z

PR Checklist

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

[x] Feature

What is the current behavior?

The ServiceWorker will redirect navigation requests that don't match any asset or data group to the specified index file. The rules for a request to be classified as a navigation request are as follows:

Its mode must be navigation.
It must accept a text/html response.
Its URL must match certain criteria (see below).

By default, a navigation request can have any URL except for:

URLs containing __.
URLs to files (i.e. containing a file extension in the last path segment).

While thse rules are fine in many cases, sometimes it is desirable to configure different rules for the URLs of navigation requests (e.g. ignore specific URLs and pass them through to the server).

Issue Number: #20404

What is the new behavior?

It is now possible to specify an optional navigationUrls list in ngsw-config.json, which contains URLs or simple globs (currently only recognizing !, * and **). Only requests whose URLs match any of the positive URLs/patterns and none of the negative ones (i.e. URLs/patterns starting with !) will be considered navigation requests (and handled accordingly by the SW).

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

This is an alternative implementation to #23025.
Fixes #20404.

mary-poppins · 2018-04-12T15:40:31Z

You can preview 369967a at https://pr23339-369967a.ngbuilds.io/.

mary-poppins · 2018-04-12T22:10:03Z

You can preview 5e2542c at https://pr23339-5e2542c.ngbuilds.io/.

The ServiceWorker will redirect navigation requests that don't match any `asset` or `data` group to the specified index file. The rules for a request to be classified as a navigation request are as follows: 1. Its `mode` must be `navigation`. 2. It must accept a `text/html` response. 3. Its URL must match certain criteria (see below). By default, a navigation request can have any URL except for: 1. URLs containing `__`. 2. URLs to files (i.e. containing a file extension in the last path segment). While these rules are fine in many cases, sometimes it is desirable to configure different rules for the URLs of navigation requests (e.g. ignore specific URLs and pass them through to the server). This commit adds support for specifying an optional `navigationUrls` list in `ngsw-config.json`, which contains URLs or simple globs (currently only recognizing `!`, `*` and `**`). Only requests whose URLs match any of the positive URLs/patterns and none of the negative ones (i.e. URLs/patterns starting with `!`) will be considered navigation requests (and handled accordingly by the SW). (This is an alternative implementation to angular#23025.) Fixes angular#20404

In [glob patterns][1], the `*` wildcard is supposed to match 0 or more characters. For reference: - This is also how `*` works in other implementations, such as `.gitignore` files or Firebase hosting config. - Some popular JS implementations (e.g. [minimatch][2], [micromatch][3]) work differently, matching 1 or more character (but not 0). This commit "fixes" the minimal glob support in `@angular/service-worker` to allow `*` to also match 0 characters. [1]: https://en.wikipedia.org/wiki/Glob_%28programming%29 [2]: https://www.npmjs.com/package/minimatch [3]: https://www.npmjs.com/package/micromatch

mary-poppins · 2018-04-12T23:21:12Z

You can preview b5e94eb at https://pr23339-b5e94eb.ngbuilds.io/.

alxhub · 2018-04-13T16:41:18Z

        // There is an assignment for this client already.
-        let hash = this.clientVersionMap.get(clientId) !;
+        const hash = this.clientVersionMap.get(clientId) !;
+        let appVersion = this.lookupVersionByHash(hash, 'assignVersion');


This call can throw if the SW is not in an okay state to read this.versions (if this.state is not DriverReadyState.NORMAL. Let's guard this lookup so it only happens if the SW is in a normal state state.

Discussed "offline". lookupVersionByHash() was called without checking the state anyway, so this PR does not change anything in that regard.

ngbot · 2018-04-13T19:32:17Z

I see that you just added the PR action: merge label, but the following checks are still failing:
forbidden label detected: PR action: review
status "google3" is pending

If you want your PR to be merged, it has to pass all the CI checks.

If you can't get the PR to a green state due to flakes or broken master, please try rebasing to master and/or restarting the CI job. If that fails and you believe that the issue is not due to your change, please contact the caretaker and ask for help.

PR Close #23339

…23339) The ServiceWorker will redirect navigation requests that don't match any `asset` or `data` group to the specified index file. The rules for a request to be classified as a navigation request are as follows: 1. Its `mode` must be `navigation`. 2. It must accept a `text/html` response. 3. Its URL must match certain criteria (see below). By default, a navigation request can have any URL except for: 1. URLs containing `__`. 2. URLs to files (i.e. containing a file extension in the last path segment). While these rules are fine in many cases, sometimes it is desirable to configure different rules for the URLs of navigation requests (e.g. ignore specific URLs and pass them through to the server). This commit adds support for specifying an optional `navigationUrls` list in `ngsw-config.json`, which contains URLs or simple globs (currently only recognizing `!`, `*` and `**`). Only requests whose URLs match any of the positive URLs/patterns and none of the negative ones (i.e. URLs/patterns starting with `!`) will be considered navigation requests (and handled accordingly by the SW). (This is an alternative implementation to #23025.) Fixes #20404 PR Close #23339

In [glob patterns][1], the `*` wildcard is supposed to match 0 or more characters. For reference: - This is also how `*` works in other implementations, such as `.gitignore` files or Firebase hosting config. - Some popular JS implementations (e.g. [minimatch][2], [micromatch][3]) work differently, matching 1 or more character (but not 0). This commit "fixes" the minimal glob support in `@angular/service-worker` to allow `*` to also match 0 characters. [1]: https://en.wikipedia.org/wiki/Glob_%28programming%29 [2]: https://www.npmjs.com/package/minimatch [3]: https://www.npmjs.com/package/micromatch PR Close #23339

angular-automatic-lock-bot · 2019-09-15T01:53:01Z

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.}

googlebot added the cla: yes label Apr 12, 2018

gkalpak requested a review from alxhub April 12, 2018 15:30

gkalpak added state: WIP and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Apr 12, 2018

gkalpak added 2 commits April 12, 2018 22:51

docs(service-worker): minor fixes/improvements

080e687

refactor(service-worker): move common code into method

c383b1a

gkalpak force-pushed the feat-sw-nav-urls branch from 369967a to 5e2542c Compare April 12, 2018 22:00

gkalpak mentioned this pull request Apr 12, 2018

feat(service-worker): add support for ignoring specific URLs #23025

Closed

3 tasks done

gkalpak added 2 commits April 13, 2018 02:12

gkalpak force-pushed the feat-sw-nav-urls branch from 5e2542c to b5e94eb Compare April 12, 2018 23:12

gkalpak added action: review The PR is still awaiting reviews from at least one requested reviewer and removed state: WIP labels Apr 12, 2018

alxhub approved these changes Apr 13, 2018

View reviewed changes

IgorMinar approved these changes Apr 13, 2018

View reviewed changes

IgorMinar added the action: merge The PR is ready for merge by the caretaker label Apr 13, 2018

IgorMinar removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Apr 13, 2018

IgorMinar closed this in d1e716b Apr 13, 2018

IgorMinar pushed a commit that referenced this pull request Apr 13, 2018

refactor(service-worker): move common code into method (#23339)

1e1c7fd

PR Close #23339

gkalpak deleted the feat-sw-nav-urls branch April 15, 2018 11:57

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

Navigation Menu

Repository navigation

feat(service-worker): add support for configuring navigations URLs - #23339

feat(service-worker): add support for configuring navigations URLs#23339
gkalpak wants to merge 4 commits into
angular:masterfrom
gkalpak:feat-sw-nav-urls

gkalpak commented Apr 12, 2018

Uh oh!

mary-poppins commented Apr 12, 2018

Uh oh!

mary-poppins commented Apr 12, 2018

Uh oh!

mary-poppins commented Apr 12, 2018

Uh oh!

alxhub Apr 13, 2018

Uh oh!

gkalpak Apr 13, 2018

Uh oh!

ngbot Bot commented Apr 13, 2018

Uh oh!

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

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

gkalpak commented Apr 12, 2018

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!

mary-poppins commented Apr 12, 2018

Uh oh!

mary-poppins commented Apr 12, 2018

Uh oh!

mary-poppins commented Apr 12, 2018

Uh oh!

alxhub Apr 13, 2018

Choose a reason for hiding this comment

Uh oh!

gkalpak Apr 13, 2018

Choose a reason for hiding this comment

Uh oh!

ngbot Bot commented Apr 13, 2018

Uh oh!

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

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants