[WIP] Notifications

[jaxoncreed]

Implementation of the notification spec here: https://github.com/solid/notifications-panel/blob/main/proposals/solid-notifications.md and here: https://github.com/solid/notifications-panel/blob/main/proposals/solid-webhook-notifications.md

• /.well-known/solid route (https://github.com/solid/notifications-panel/blob/main/proposals/solid-notifications.md#discovery)
• Notification Gateway (https://github.com/solid/notifications-panel/blob/main/proposals/solid-notifications.md#notification-gateway)
• Notification Subscription (https://github.com/solid/notifications-panel/blob/main/proposals/solid-notifications.md#notification-subscription)
• WebSocketSubscription2021
  • TODO: Fille out requirements for WebSocketSubscription2021
• WebHookSubscription2021
  • Subscription API (https://github.com/solid/notifications-panel/blob/main/proposals/solid-webhook-notifications.md#subscription-api)
  • Webhook API (https://github.com/solid/notifications-panel/blob/main/proposals/solid-webhook-notifications.md#webhook-api)
  • Unsubscribe API (https://github.com/solid/notifications-panel/blob/main/proposals/solid-webhook-notifications.md#unsubscribe-api)
  • Webhook-Auth Feature (https://github.com/solid/notifications-panel/blob/main/proposals/solid-webhook-notifications.md#features)

[jaxoncreed]

I see that webhooks are in the codebase already, but I'm not sure if they are an old implementation or the new one. I've contacted @joachimvh on slack for clarification (it's late at night for him right now).

[joachimvh]

I see that webhooks are in the codebase already, but I'm not sure if they are an old implementation or the new one.

I'll reply here so there's a paper trail. The notification format currently in the codebase is the old one with (unsecure) websockets. This was added to have consistent behaviour with NSS at that point.

[csarven]

The Unofficial Draft (the proposal URL linked in the comment in this PR) is in the process of being removed from the proposals directory. The blob should still be accessible.

Canonical locations for CSS to track:

• Solid Notifications Protocol repository: https://github.com/solid/notifications
• Solid Notifications Protocol Editor's Draft: https://solid.github.io/notifications/protocol

As mentioned in two Notifications Panel meetings, the use of a Well-Known URI is at risk. Needs an issue pending resolutions to:

• Server Description solid/specification#355
• Servers responding to request targets using the asterisk-form or the origin-form solid/specification#356

Will follow up with updates to Notifications Protocol thereafter.

[ixuz]

Hi there, we have actually started an implementation of the NotificationGateway, NotificationSubscription and WebHookSubscription2021 according to the specifications listed above. We intend to provide these as a Pull Request to this repository very soon.

Additionally, we discovered the need for more descriptive events fired upon resource changes in order to provide meaningful Notifications (Activitiy Streams 2.0). We'll open up a pull request today with that implementation. This will be useful for the specific implementations, such as the WebHookSubscription2021 and WebSocketSubscription2021.

[RubenVerborgh]

@jaxoncreed Thank you for the pull request.
@ixuz Thank you for jumping in with code as well.

I think PRs #1074 and #1075 show something really important: we have to coordinate as a community when it comes to CSS.

Major features like these should not be implemented without having a joint architectural discussion. For most features, we can start this discussion in an issue here on GitHub. This is how we have always worked: in the open. For more complicated features, we might want to jump on a call. So let's do that 🙂

I will invite all of the people in this PR for a call, so we can see how to proceed together.

[RubenVerborgh]

IDP stuff should very likely not be in the notifications configuration.

[jaxoncreed]

This is a work in progress. I just copied over this configuration. Will clean up when it's done.

[jaxoncreed]

Thanks @RubenVerborgh for coordinating. @ixuz how soon do you think you'll make your PRs available. I'd love to help out.

[woutermont]

@RubenVerborgh, I was already aware of @ixuz' progress on this, and would like to follow up the implemenation closely. Could you invite me to the call as well?

About coordinating ourselves as a community: #1079

[RubenVerborgh]

@woutermont Absolutely; agree with your idea regarding roadmap, and you (and others) are most welcome to the meeting.

[jaxoncreed]

This can be closed in favor of #1080