Use Cases for Get Notifications and Delete Notifications

[ChengShi-1]

What this PR does / why we need it:

Inspired by 2025 Q3

Referring to native api
Get All Notifications by User
Delete Notification by User

Set displayAsRead
https://github.com/IQSS/dataverse/pull/11664/files

Which issue(s) this PR closes:

• Closes Create Use Cases for Get Notifications and Delete Notifications #334

Related Dataverse PRs:

IQSS/dataverse#11696

Special notes for your reviewer:

Test env. variables should be changed back after IQSS/dataverse#11696 is merged

Suggestions on how to test this:

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

Additional documentation:

[ekraffmiller]

looks good! I just have some comments about naming.

[ChengShi-1]

Hi Ellen @ekraffmiller , thanks for review! I made changes based on suggestion.
Do you think we should change the type property of notification to enum according to https://github.com/IQSS/dataverse/blob/23d47a3063576c69a4efaad1bd07e9e89b0a3151/src/main/java/edu/harvard/iq/dataverse/UserNotification.java#L36

[ekraffmiller]

Hi Ellen @ekraffmiller , thanks for review! I made changes based on suggestion. Do you think we should change the type property of notification to enum according to https://github.com/IQSS/dataverse/blob/23d47a3063576c69a4efaad1bd07e9e89b0a3151/src/main/java/edu/harvard/iq/dataverse/UserNotification.java#L36

Hi @ChengShi-1, yes that sounds good 👍
Also, in looking at the UI, I noticed that we need to display whether the file has been read or not. There is a field, displayAsRead that is used in the JSF notifications table, and another field unreadNotificationCount that is used in the Dataverse Header: https://github.com/IQSS/dataverse/blob/23d47a3063576c69a4efaad1bd07e9e89b0a3151/src/main/java/edu/harvard/iq/dataverse/DataverseHeaderFragment.java#L154.
So I think we need to request an update to the Notifications API to get the 'displayAsRead' field, and also we need an API endpoint to update a notification as read when the user views the table.

[ChengShi-1]

@ekraffmiller right, we need this. I just create an issue to dataverse repo for it. IQSS/dataverse#11650

[johannes-darms]

A pagination feature would be nice:)

[ekraffmiller]

Waiting for version of the notifications API, IQSS/dataverse#11673

[ekraffmiller]

Hi @ChengShi-1 it looks good! just some comments about naming conventions, and a question about the integration test.

[ekraffmiller]

to follow the naming convention we have in other use cases, change to GetUnreadNotificationsCount?

[ekraffmiller]

I'm getting flaky behavior when running this locally - the test fails even though it succeeds on Github. Can you try to reproduce that? If needed, you could avoid relying on the existence of a notification by creating one before running the test.

 FAIL  test/integration/notifications/NotificationsRepository.test.ts (9.565 s)

 RUNS  test/integration/files/DirectUpload.test.ts
 RUNS  test/integration/notifications/NotificationsRepository.test.ts
 RUNS  test/integration/datasets/DatasetsRepository.test.ts
 RUNS  test/integration/collections/CollectionsRepository.test.ts
 RUNS  test/integration/files/FilesRepository.test.ts
  ● NotificationsRepository › should find notification with ASSIGNROLE type

    expect(received).toBeDefined()

    Received: undefined

      101 |     expect(assignRoleNotification?.sentTimestamp).toBeDefined()
      102 |     expect(assignRoleNotification?.displayAsRead).toBeDefined()
    > 103 |     expect(assignRoleNotification?.dataverseDisplayName).toBeDefined()
          |                                                          ^
      104 |
      105 |     expect(assignRoleNotification?.roleAssignments).toBeDefined()
      106 |     expect(assignRoleNotification?.roleAssignments?.length).toBeGreaterThan(0)

      at test/integration/notifications/NotificationsRepository.test.ts:103:58
      at fulfilled (test/integration/notifications/NotificationsRepository.test.ts:5:58)

[ChengShi-1]

Thanks for catching this! The notifications.find(...) gave a deleted object there as the 1st eligible element,
assignRoleNotification { id: 139, type: 'ASSIGNROLE', displayAsRead: false, sentTimestamp: '2025-08-22T13:28:34Z', objectDeleted: true }
so I add a line to filter out deleted objects there

[ekraffmiller]

looks good, approved!

[ofahimIQSS]

tests passing, merging