fix(service-worker): fix handling absolute and relative base href #37922

gkalpak · 2020-07-04T10:14:42Z

Various fixes to allow the Angular ServiceWorker to correctly work when the app has an absolute or relative base href.
See individual commits for details.

Fixes #25055 and #30505.

mary-poppins · 2020-07-04T10:28:08Z

You can preview 17b9d4b at https://pr37922-17b9d4b.ngbuilds.io/.

mary-poppins · 2020-07-04T11:00:59Z

You can preview 63974dd at https://pr37922-63974dd.ngbuilds.io/.

mary-poppins · 2020-07-04T19:26:27Z

You can preview 3953c4a at https://pr37922-3953c4a.ngbuilds.io/.

mary-poppins · 2020-07-04T20:19:27Z

You can preview 4d3843f at https://pr37922-4d3843f.ngbuilds.io/.

mary-poppins · 2020-07-05T19:29:35Z

You can preview e574fbb at https://pr37922-e574fbb.ngbuilds.io/.

mary-poppins · 2020-07-05T20:42:35Z

You can preview 407f8ff at https://pr37922-407f8ff.ngbuilds.io/.

…scope The Angular ServiceWorker can serve requests to a special virtual path, `ngsw/state`, showing [information about its internal state][1], which can be useful for debugging. Previously, this would only work if the ServiceWorker's [scope][2] was the root directory (`/`). Otherwise, (e.g. when building the app with `--baseHref=/some/path/`), the ServiceWorker would fail to detect a request to `/some/path/ngsw/state` as matching `ngsw/state` and would not serve it with the debugging information. This commit fixes it by ensuring that the ServiceWorker's scope is taken into account when detecting a request to `ngsw/state`. [1]: https://angular.io/guide/service-worker-devops#locating-and-analyzing-debugging-information [2]: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/scope Fixes angular#30505

This is in preparation of enabling the ServiceWorker to handle relative paths in `ngsw.json` (as discussed in angular#25055), which will require normalizing URLs in other parts of the ServiceWorker.

…l ones This commit makes the mock implementations used is ServiceWorker tests behave more similar to the actual ones.

mary-poppins · 2020-07-06T16:17:01Z

You can preview 6eb027c at https://pr37922-6eb027c.ngbuilds.io/.

In some cases, it is useful to use a relative base href in the app (e.g. when an app has to be accessible on different URLs, such as on an intranet and the internet - see angular#25055 for a related discussion). Previously, the Angular ServiceWorker was not able to handle relative base hrefs (for example when building the with `--base-href=./`). This commit fixes this by normalizing all URLs from the ServiceWorker configuration wrt the ServiceWorker's scope. Fixes angular#25055

Some ServiceWorker operations and methods require normalized URLs. Previously, the generic `string` type was used. This commit introduces a new `NormalizedUrl` type, a special kind of `string`, to make this requirement explicit and use the type system to enforce it.

mary-poppins · 2020-07-06T16:45:36Z

You can preview d59b181 at https://pr37922-d59b181.ngbuilds.io/.

alxhub · 2020-07-06T18:21:11Z

packages/service-worker/worker/testing/mock.ts

-    fs.list().forEach(path => {
-      const file = fs.lookup(path)!;
-      this.resources.set(path, new MockResponse(file.contents, {headers: file.headers}));
+  withRootDirectory(newRootDir: string): MockServerStateBuilder {


So clean, I love it.

…37922) This is in preparation of enabling the ServiceWorker to handle relative paths in `ngsw.json` (as discussed in #25055), which will require normalizing URLs in other parts of the ServiceWorker. PR Close #37922

…l ones (#37922) This commit makes the mock implementations used is ServiceWorker tests behave more similar to the actual ones. PR Close #37922

In some cases, it is useful to use a relative base href in the app (e.g. when an app has to be accessible on different URLs, such as on an intranet and the internet - see #25055 for a related discussion). Previously, the Angular ServiceWorker was not able to handle relative base hrefs (for example when building the with `--base-href=./`). This commit fixes this by normalizing all URLs from the ServiceWorker configuration wrt the ServiceWorker's scope. Fixes #25055 PR Close #37922

Some ServiceWorker operations and methods require normalized URLs. Previously, the generic `string` type was used. This commit introduces a new `NormalizedUrl` type, a special kind of `string`, to make this requirement explicit and use the type system to enforce it. PR Close #37922

…scope (#37922) The Angular ServiceWorker can serve requests to a special virtual path, `ngsw/state`, showing [information about its internal state][1], which can be useful for debugging. Previously, this would only work if the ServiceWorker's [scope][2] was the root directory (`/`). Otherwise, (e.g. when building the app with `--baseHref=/some/path/`), the ServiceWorker would fail to detect a request to `/some/path/ngsw/state` as matching `ngsw/state` and would not serve it with the debugging information. This commit fixes it by ensuring that the ServiceWorker's scope is taken into account when detecting a request to `ngsw/state`. [1]: https://angular.io/guide/service-worker-devops#locating-and-analyzing-debugging-information [2]: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/scope Fixes #30505 PR Close #37922

…37922) This is in preparation of enabling the ServiceWorker to handle relative paths in `ngsw.json` (as discussed in #25055), which will require normalizing URLs in other parts of the ServiceWorker. PR Close #37922

…l ones (#37922) This commit makes the mock implementations used is ServiceWorker tests behave more similar to the actual ones. PR Close #37922

In some cases, it is useful to use a relative base href in the app (e.g. when an app has to be accessible on different URLs, such as on an intranet and the internet - see #25055 for a related discussion). Previously, the Angular ServiceWorker was not able to handle relative base hrefs (for example when building the with `--base-href=./`). This commit fixes this by normalizing all URLs from the ServiceWorker configuration wrt the ServiceWorker's scope. Fixes #25055 PR Close #37922

Some ServiceWorker operations and methods require normalized URLs. Previously, the generic `string` type was used. This commit introduces a new `NormalizedUrl` type, a special kind of `string`, to make this requirement explicit and use the type system to enforce it. PR Close #37922

angular-automatic-lock-bot · 2020-08-09T16:15:21Z

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

…scope (angular#37922) The Angular ServiceWorker can serve requests to a special virtual path, `ngsw/state`, showing [information about its internal state][1], which can be useful for debugging. Previously, this would only work if the ServiceWorker's [scope][2] was the root directory (`/`). Otherwise, (e.g. when building the app with `--baseHref=/some/path/`), the ServiceWorker would fail to detect a request to `/some/path/ngsw/state` as matching `ngsw/state` and would not serve it with the debugging information. This commit fixes it by ensuring that the ServiceWorker's scope is taken into account when detecting a request to `ngsw/state`. [1]: https://angular.io/guide/service-worker-devops#locating-and-analyzing-debugging-information [2]: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/scope Fixes angular#30505 PR Close angular#37922

…ngular#37922) This is in preparation of enabling the ServiceWorker to handle relative paths in `ngsw.json` (as discussed in angular#25055), which will require normalizing URLs in other parts of the ServiceWorker. PR Close angular#37922

…l ones (angular#37922) This commit makes the mock implementations used is ServiceWorker tests behave more similar to the actual ones. PR Close angular#37922

In some cases, it is useful to use a relative base href in the app (e.g. when an app has to be accessible on different URLs, such as on an intranet and the internet - see angular#25055 for a related discussion). Previously, the Angular ServiceWorker was not able to handle relative base hrefs (for example when building the with `--base-href=./`). This commit fixes this by normalizing all URLs from the ServiceWorker configuration wrt the ServiceWorker's scope. Fixes angular#25055 PR Close angular#37922

…ar#37922) Some ServiceWorker operations and methods require normalized URLs. Previously, the generic `string` type was used. This commit introduces a new `NormalizedUrl` type, a special kind of `string`, to make this requirement explicit and use the type system to enforce it. PR Close angular#37922

googlebot added the cla: yes label Jul 4, 2020

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 Jul 4, 2020

ngbot bot modified the milestone: needsTriage Jul 4, 2020

gkalpak mentioned this pull request Jul 4, 2020

fix(service-worker): allow service worker to handle non root base hrefs #35979

Closed

14 tasks

gkalpak force-pushed the fix-sw-baseHref branch from 17b9d4b to 63974dd Compare July 4, 2020 10:48

gkalpak force-pushed the fix-sw-baseHref branch from 4d3843f to e574fbb Compare July 5, 2020 19:16

gkalpak force-pushed the fix-sw-baseHref branch 2 times, most recently from 58f4704 to 407f8ff Compare July 5, 2020 20:31

gkalpak added 3 commits July 6, 2020 16:55

refactor(service-worker): move asset URL normalization to Adapter

dc42fdf

This is in preparation of enabling the ServiceWorker to handle relative paths in `ngsw.json` (as discussed in angular#25055), which will require normalizing URLs in other parts of the ServiceWorker.

test(service-worker): make mock implementations more similar to actua…

1dd2b09

…l ones This commit makes the mock implementations used is ServiceWorker tests behave more similar to the actual ones.

gkalpak force-pushed the fix-sw-baseHref branch from 407f8ff to 6eb027c Compare July 6, 2020 16:04

gkalpak marked this pull request as ready for review July 6, 2020 16:26

gkalpak added 2 commits July 6, 2020 19:30

gkalpak force-pushed the fix-sw-baseHref branch from 6eb027c to d59b181 Compare July 6, 2020 16:31

gkalpak requested a review from alxhub July 6, 2020 16:31

alxhub reviewed Jul 6, 2020

View reviewed changes

alxhub approved these changes Jul 7, 2020

View reviewed changes

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

pullapprove bot requested a review from AndrewKushnir July 7, 2020 19:57

AndrewKushnir approved these changes Jul 8, 2020

View reviewed changes

atscott closed this in 2156bee Jul 9, 2020

gkalpak deleted the fix-sw-baseHref branch July 9, 2020 16:59

angular-automatic-lock-bot bot locked and limited conversation to collaborators Aug 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(service-worker): fix handling absolute and relative base href #37922

fix(service-worker): fix handling absolute and relative base href #37922

gkalpak commented Jul 4, 2020 •

edited

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 5, 2020

mary-poppins commented Jul 5, 2020

mary-poppins commented Jul 6, 2020

mary-poppins commented Jul 6, 2020

alxhub Jul 6, 2020

angular-automatic-lock-bot bot commented Aug 9, 2020

fix(service-worker): fix handling absolute and relative base href #37922

fix(service-worker): fix handling absolute and relative base href #37922

Conversation

gkalpak commented Jul 4, 2020 • edited

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 4, 2020

mary-poppins commented Jul 5, 2020

mary-poppins commented Jul 5, 2020

mary-poppins commented Jul 6, 2020

mary-poppins commented Jul 6, 2020

alxhub Jul 6, 2020

Choose a reason for hiding this comment

angular-automatic-lock-bot bot commented Aug 9, 2020

gkalpak commented Jul 4, 2020 •

edited