1418376 - report a message to the web console if we block service workers due to storage configuration

Status: RESOLVED FIXED

(Core :: DOM: Service Workers, enhancement, P2)

Description

[Ben Kelly [:bkelly, not reviewing]]

Since I added code to block service workers when storage is disabled in bug 1336364 we have gotten a number of bugs by people confused by this.  We should log a message to the web console to clarify what is going on for developers.

Comment 1

[Hsin-Yi Tsai (she/her) [:hsinyi]]

Tom, do you have bandwidth to take this?

Comment 2

[Tom Tung [:tt, :ttung]]

Sure, I'll work on this after fixing the bug 1222008

Comment 3

[Tom Tung [:tt, :ttung]]

Attachment: Bug 1418376: Report to the console if a service worker is blocked because the storage is not fully allow. r?bkelly

Hi Ben,

There are seven if-statements [1] where the service worker checks the permission of StorageAccess. However, I don't think web developers are able to call GetServiceWorkerRegistrationInfo()[2]. Thus, I only report six of them to the web console and add testcases for them. I make them report to the console while failing.

Could you help me to review the patch? Thanks!

[1] https://searchfox.org/mozilla-central/search?q=StorageAccess&case=false&regexp=false&path=dom%2Fworkers
[2] https://searchfox.org/mozilla-central/source/dom/workers/ServiceWorkerManager.cpp#2029

Comment 4

[Ben Kelly [:bkelly, not reviewing]]

Comment on attachment 8934388 [details] [diff] [review]
Bug 1418376: Report to the console if a service worker is blocked because the storage is not fully allow. r?bkelly

Review of attachment 8934388 [details] [diff] [review]:
-----------------------------------------------------------------

Awesome, thank you!  Great to have a test for this as well.

r=me with one minor message text comment addressed.

::: dom/locales/en-US/chrome/dom/dom.properties
@@ +221,5 @@
>  ServiceWorkerRegisterNetworkError=Failed to register/update a ServiceWorker for scope ‘%1$S’: Load failed with status %2$S for script ‘%3$S’.
>  # LOCALIZATION NOTE: Do not translate "ServiceWorker". %1$S is a URL representing the scope of the ServiceWorker, %2$S is a MIME Media Type like "text/plain" and %3$S is a URL.
>  ServiceWorkerRegisterMimeTypeError=Failed to register/update a ServiceWorker for scope ‘%1$S’: Bad Content-Type of ‘%2$S’ received for script ‘%3$S’.  Must be ‘text/javascript’, ‘application/x-javascript’, or ‘application/javascript’.
> +# LOCALIZATION NOTE: Do not translate "ServiceWorker". %S is a URL representing the scope of the ServiceWorker.
> +ServiceWorkerRegisterStorageError=Failed to register/update a ServiceWorker for scope ‘%S’: The storage access is not fully allowed.

Can you rephrase "The storage access is not fully allowed" to something like:

  Storage access is restricted in this context due to user settings or private browsing mode.

Here and in the other messages.

Comment 5

[Tom Tung [:tt, :ttung]]

Attachment: Bug 1418376: Report to the console if a service worker is blocked because the storage is not fully allow. r=bkelly

Thanks for the review! I address the comment.

Comment 6

[Tom Tung [:tt, :ttung]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=445fd4575e4a5ff9e88ae9e92e2923f3c79ef0c4

Comment 7

[Tom Tung [:tt, :ttung]]

(In reply to Tom Tung [:tt] from comment #6)
> https://treeherder.mozilla.org/#/
> jobs?repo=try&revision=445fd4575e4a5ff9e88ae9e92e2923f3c79ef0c4

Try shows that I should use another encoding for "'"

try with the fix:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=be72c36740bb0c939b4d37257b39bd742e878ed9&selectedJob=150097452

Comment 8

[Tom Tung [:tt, :ttung]]

Attachment: interdiff.patch

Ben, the previous try result shows that I should use "’" instead of "'". Would you mind reviewing it? Thanks! 

I'll apply this change to the attachment 8934776 [details] [diff] [review] once it gets r+.

Comment 9

[Tom Tung [:tt, :ttung]]

Attachment: [Final] Bug 1418376: Report to the console if a service worker is blocked because the storage is not fully allow. r=bkelly

Thanks for the review!

Comment 10

[Tom Tung [:tt, :ttung]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=eb1958c17cb2cc8e56b1eefe510817800ca19d2d

Comment 11

[Tom Tung [:tt, :ttung]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/eae544da26b6ea225e3f402c1bd62085cf1c7ec1
Bug 1418376: Report to the console if a service worker is blocked because the storage is not fully allow. r=bkelly

Comment 12

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/eae544da26b6