support read/unread status for notifications

[pdurbin]

What this PR does / why we need it:

• displayAsRead boolean added to "get all"
• new GET unreadCount API endpoint
• new PUT markAsRead API endpoint

Which issue(s) this PR closes:

• Closes Notifications API: support Read/Unread Status #11650

Special notes for your reviewer:

NotificationsIT points out two APIs that don't generate notifications at all:

• UtilIT.createRandomDataverse
• UtilIT.createRandomDatasetViaNativeApi

They probably should! And there are probably others. I opened this issue a while ago (10+ years!) about this:

• Notifications: user notifications not being generated by API calls #1342

As I mentioned in Slack, we could maybe go with just "read", "unread" (what GitHub uses), or "hasBeenRead" instead of "displayAsRead" (which comes from a transient variable used by JSF).

Existing methods in Notifications.java use a funny pattern to get an authenticated user. Methods I added use our standard getRequestAuthenticatedUserOrDie.

@ekraffmiller mentioned that #11648 is related and I plan to take a look, at least. I think a fix might be better as a follow up pull request. Update: a draft, for now:

• introduce "UI" setting for JSF vs SPA #11665

Here are some related GitHub APIs I looked at:

• https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#mark-notifications-as-read
• https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#mark-a-thread-as-read

They obviously store timestamps for when notifications were read but we only store booleans.

Suggestions on how to test this:

Try the endpoints mentioned in the docs for this PR.

Automated tests are also included. Make sure they are passing.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

Yes, included.

Additional documentation:

Preview at https://dataverse-guide--11664.org.readthedocs.build/en/11664/api/native-api.html#notifications

[coveralls]

coverage: 23.218% (+0.04%) from 23.175%
when pulling 5d753d1 on 11650-unread
into bfe59f0 on develop.

[sekmiller]

Looks good. Thanks for the quick fix on the doc

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11650-unread

ghcr.io/gdcc/configbaker:11650-unread

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

[ofahimIQSS]

curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/notifications/all"
^ I ran this in internal with the dataverseadmin user and the api call failed. See server log.

11664 server.log

EDIT: was able to reproduce issue on the develop branch - created a separate issue to track this: #11683

[ofahimIQSS]

Testing Passed - Merging. 11
11664testing.log