feat(service-worker): add JSON schema for service worker config

[cyrilletuzi]

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) > not relevant
• Docs have been added / updated (for bug fixes / features) (not relevant here) > not relevant

PR Type

What kind of change does this PR introduce?

• Feature

What is the current behavior?

No assistance/validation in editor for service worker config.

Issue Number: Fixes #19847

With angular/angular-cli#13325, it will also fix angular/angular-cli#13324

What is the new behavior?

Assistance/validation in editor for service worker config.

Does this PR introduce a breaking change?

• No

Other information

The schema follows @angular/service-worker interfaces (here).

Descriptions come from the official documentation on angular.io (here).

Default values have been verified in @angular/service-worker code (here).

I don't understand how the build works. When following the contributing guidelines, I can't see the static files that should be copied (like safety-worker.js and schema.json) in dist builds. So this part have to be checked.

As this is just an helper for development, this could be added in a patch version.

@gkalpak

[gkalpak]

Awesome work 💯

A couple of comments:

1. Wrap property names/values in backticks or quotes (to make it clear you are referring to a property name/value).
2. Change the commit message to match our guidelines; e.g.:

   feat(service-worker): add JSON schema for service worker config

   Fixes Feature Request: JSON Schema for @angular/service-worker #19847

[cyrilletuzi]

For the commit message, I don't see what I'm not respecting from the contributing guidelines, it's just adding the "fixes" part right?

[gkalpak]

It's the "fixes" part and adding add (:wink:) to the subject (i.e. describing what change you are making: adding a JSON schema (in contrast to updating or fixing or refactoring the JSON schema)).

[cyrilletuzi]

@gkalpak Changes done.

The bazel part (for copying the schema.json in the dist package) should be checked, as I don't know how to check this myself.

Should the fix of the doc (about the bad default for version) be part of this PR or be another?

[cyrilletuzi]

Integration test is failing but I don't think it's related to this PR.

[gkalpak]

Thx, @cyrilletuzi!

Should the fix of the doc (about the bad default for version) be part of this PR or be another?

Let's make it a separate PR so we can merge it into the patch branch as well.

[gkalpak]

Almost there 😃 A couple of minor comments.

[cyrilletuzi]

Changes done. (Again a Travis fail unrelated to this PR)

[gkalpak]

One minor comment. LGTM otherwise 🎉

_{BTW, it helps with reviews if you make subsequent changes in fixup commits (instead of amending the original commit)}

[gkalpak]

I just checked and it seems that schema.json is not published in dist/packages-dist/. (I had checked before and it was published, but maybe that was before moving it to service-worker/config/.)

Maybe package.json is special (in a way that schema.json is not) and we should include schema.json elsewhere. We need to pull in a bazel expert 😒

[cyrilletuzi]

Change done.

Who should we call for the bazel part?

I tried your suggestion of using fixup commits. To be honest I didn't know this feature, does this mean I don't need to rebase anymore?

[gkalpak]

I tried your suggestion of using fixup commits. To be honest I didn't know this feature, does this mean I don't need to rebase anymore?

Well...this doesn't change anything wrt to rebasing. (I.e. you didn't have to rebase before either, unless your branch had conflicts with master. The same is true when using --fixup.)
But it is a very cool feature of git (especially when combined with --autosquash 💪).

[googlebot]

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

[cyrilletuzi]

@gkalpak I took the chance to add a last change, following feeback from my experience: as the goal is to ensure there are no errors in ngsw-config.json, additionalProperties should be set to false for objects. Otherwise, I could do a typo and a wrong property would be allowed while the right one would be missing. As a consequence, $schema itself must be autothorized.

[gkalpak]

Thx, @cyrilletuzi. I will take a look at the changes.

BTW, it would be better if we didn't work on the PR at the same time 😁
I am currently working on fixing CI; I'll let you know once I am done. But I think it is fine to merge this one and then do any enhancements/improvements in a follow-up PR.

[cyrilletuzi]

@gkalpak Yep, sorry, I've seen you were working at the same time at the moment I pushed. :/

[gkalpak]

I am done. CI is green. @cyrilletuzi, could you take care of #27859 (comment) (if needed)?
(Also happy to drop this commit from the PR, merge the PR and then open a new PR with the fix.)

[cyrilletuzi]

@gkalpak You're totally right, it's fixed. I hope I didn't mess with your CI fixes, as I admit I'm quite lost with the git conflicts...

[ngbot]

I see that you just added the PR action: merge label, but the following checks are still failing:
     status "cla/google" is failing
     missing required labels: cla: yes
     forbidden labels detected: cla: no
     status "ci/angular: size" is pending
     status "ci/circleci: aio_preview" is pending
     status "ci/circleci: build-ivy-npm-packages" is pending
     status "ci/circleci: build-npm-packages" is pending
     status "ci/circleci: lint" is pending
     status "ci/circleci: test" is pending
     status "ci/circleci: test_aio" is pending
     status "ci/circleci: test_ivy_aot" is pending
     missing required status "ci/circleci: publish_snapshot"

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.

[googlebot]

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

[gkalpak]

Thx, @cyrilletuzi! (No worries about the git merge/rebase mess. I cleaned it up 😉)
As soon as CI is happy, this should be good to go.

merge-asssitance: The fw-compiler, fw-forms and tools-language-service approvals are not needed (they were auto-requested by GitHub after a bad rebase).
merge-assistance: @alexeagle's approval should cover fw-integration. (It probably shows as pending because GitHub auto-re-requested after the aforementioned bad rebase.)

[angular-automatic-lock-bot]

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