1265841 - Implement the `notificationclose` service worker event

Status: RESOLVED FIXED

(Core :: DOM: Push Subscriptions, defect)

Description

[Lina Butler (ex-Mozilla)]

We don't implement `notificationclose` (https://notifications.spec.whatwg.org/#closing-a-notification) yet, so a service worker can't know when a persistent notification is closed.

Comment 1

[Lina Butler (ex-Mozilla)]

Attachment: MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review commit: https://reviewboard.mozilla.org/r/47715/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/47715/

Comment 2

[Lina Butler (ex-Mozilla)]

https://reviewboard.mozilla.org/r/47715/#review44507

::: dom/notification/Notification.cpp:1730
(Diff revision 1)
>      // The observer is wholly owned by the NotificationObserver passed to the alert service.
> -    observer = new ServiceWorkerNotificationObserver(mScope, GetPrincipal(), mID);
> +    nsAutoString behavior;
> +    if (NS_WARN_IF(!mBehavior.ToJSON(behavior))) {
> +      behavior.Truncate();
> +    }
> +    observer = new ServiceWorkerNotificationObserver(mScope,

It might make sense for `ServiceWorkerNotificationObserver` to just take ownership of the notification, as `{MainThread, Worker}NotificationObserver` already do.

But I'm not sure if that means we need to register a feature to keep the notification alive. It also seems like persistent notifications can be accessed from either thread; I'm assuming that's one of the reasons we release the notification and call `ConstructFromFields` when we need it again.

Comment 3

[Lina Butler (ex-Mozilla)]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/47715/diff/1-2/

Comment 4

[Lina Butler (ex-Mozilla)]

Attachment: MozReview Request: Bug 1265841 - Remove persistent notifications from storage. r?wchen

Review commit: https://reviewboard.mozilla.org/r/47941/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/47941/

Comment 5

[Lina Butler (ex-Mozilla)]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/47715/diff/2-3/

Comment 6

[Lina Butler (ex-Mozilla)]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/47715/diff/3-4/

Comment 7

[Lina Butler (ex-Mozilla)]

I haven't been keeping up with the changes to https://notifications.spec.whatwg.org/, but it looks like notifications created via the `Notification` constructor no longer have `onshow` or `onclose` events. I guess that's because they're meant to be temporary (https://github.com/whatwg/notifications/issues/31#issuecomment-75955968), as opposed to persistent service worker notifications.

Comment 8

[William Chen [:wchen]]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

https://reviewboard.mozilla.org/r/47715/#review45969

::: dom/notification/Notification.cpp:1590
(Diff revision 4)
> -      return rv;
> +    return rv;
> -    }
> +  }
>  
> -    nsCOMPtr<nsIServiceWorkerManager> swm =
> +  nsCOMPtr<nsIServiceWorkerManager> swm =
> -      mozilla::services::GetServiceWorkerManager();
> +    mozilla::services::GetServiceWorkerManager();
> +  if (NS_WARN_IF(!swm)) {

If swm is not available we should still remove the notification from notification storage since it's no longer around.

::: dom/workers/ServiceWorkerPrivate.cpp:1093
(Diff revision 4)
> +
> +  return NS_OK;
> +}
> +
> +nsresult
> +ServiceWorkerPrivate::SendNotificationCloseEvent(const nsAString& aID,

There is a lot of duplicated code for ServiceWorkePrivate and ServiceWorkerManager. Can you refactor the function to take the event as a parameter, similar to what you did for SendNotificationEventRunnable?

Comment 9

[Lina Butler (ex-Mozilla)]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/47715/diff/4-5/

Comment 10

[William Chen [:wchen]]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

https://reviewboard.mozilla.org/r/47715/#review46395

::: dom/notification/Notification.cpp:1630
(Diff revision 5)
>      if (notificationStorage) {
>        notificationStorage->Delete(origin, mID);
>      }
> +
> +    if (!NS_WARN_IF(!swm)) {
> +      swm->SendNotificationCloseEvent(originSuffix,

Let's handle the nsresult from SendNotificationCloseEvent and SendNotificationClickEvent.

Comment 11

[Lina Butler (ex-Mozilla)]

Haitao, CCing you on this bug, since it might affect bug 1264815. If you're refactoring `ServiceWorkerNotificationObserver`, it probably makes sense to have this bug depend on yours, but it's up to you.

Comment 12

[Andrea Marchesini [:baku]]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

https://reviewboard.mozilla.org/r/47715/#review53080

::: dom/notification/Notification.cpp:1600
(Diff revision 5)
> -    }
> +  }
>  
> -    nsCOMPtr<nsIServiceWorkerManager> swm =
> +  nsCOMPtr<nsIServiceWorkerManager> swm =
> -      mozilla::services::GetServiceWorkerManager();
> +    mozilla::services::GetServiceWorkerManager();
>  
> -    if (swm) {
> +  if (!strcmp("alertclickcallback", aTopic) && !NS_WARN_IF(!swm)) {

I prefer to have:

if (NS_WARN_IF(!swm)) {
  return NS_ERROR_FAILURE;
}

::: dom/notification/Notification.cpp:1629
(Diff revision 5)
>        do_GetService(NS_NOTIFICATION_STORAGE_CONTRACTID);
>      if (notificationStorage) {
>        notificationStorage->Delete(origin, mID);
>      }
> +
> +    if (!NS_WARN_IF(!swm)) {

if (NS_WARN_IF(!swm)) {
  return NS_ERROR_FAILURE;
}

this if (!NS_WARN_IF(!swm)) is confusing

Comment 13

[Lina Butler (ex-Mozilla)]

Comment on attachment 8743321 [details]
MozReview Request: Bug 1265841 - Implement the `notificationclose` service worker event. r=wchen,baku

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/47715/diff/5-6/

Comment 14

[Lina Butler (ex-Mozilla)]

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

Comment 15

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/253aa0a9809b
Implement the `notificationclose` service worker event. r=wchen,baku

Comment 16

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/253aa0a9809b