DSA Notifications

[nick-funk]

What does this PR do?

Preliminarily adds notifications to the DSA epic branch.

These changes will impact:

• commenters
• moderators
• admins
• developers

What changes to the GraphQL/Database Schema does this PR introduce?

• Adds a new Notification type and corresponding Connection types

Does this PR introduce any new environment variables or feature flags?

No.

If any indexes were added, were they added to INDEXES.md?

db.notifications.createIndex({ tenantID: 1, id: 1 }, { unique: true });

This index creates the uniqueness constraint for the tenantID and id fields on the notifications collection

db.notifications.createIndex({ tenantID: 1, ownerID: 1, createdAt: 1 });

This index speeds up the retrieval of notifications by tenantID, ownerID, and createdAt which is the most common way of retrieving notifications for pagination in the notifications tab on the stream.

How do I test this PR?

• Enable the DSA features under Admin > Configure > General
• Create some comments
• Feature, approve, or reject the comments
• Check Notifications for updates on these actions

Where any tests migrated to React Testing Library?

No

How do we deploy this PR?

• Merge into the dsa-launchpad branch
• Eventually merge the dsa-launchpad branch into develop
• Release
• Ensure appropriate indices (described above) are applied to any mongo instances using the notification features

[nick-funk]

@marcushaddon and @kabeaty, this is what it looks like to publish a notification for a user. All you need is access to the ctx.notifications which is available for every query and mutation in Coral's API.

The content of the notification is also malleable and has many optional fields. It can also be extended to provide new interface types for various kinds of notifications. It's all very flexible to whatever needs to be inside the notification.

As well, there is a convenient NotificationType to categorize the notifications and is infinite in how many kinds it can be, but adds a type that makes it easy to create/sort/filter notifications in the future.

This is what I mean by a one-liner to publish a notification anywhere. This isn't relevant for either of your DSA work, but it shows how minimal it will be to send new notifications throughout both of your's code.

[kabeaty]

Very nice initial framework for notifications to keep building on and extending!

[kabeaty]

Echoing my previous review, fantastic framework for notifications set up here! Just left a few small comments/questions throughout.