Skip to content

IQSS/8914 COAR compliant LDN messaging #10490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
stevenwinship merged 53 commits into from
Nov 25, 2025
Merged

IQSS/8914 COAR compliant LDN messaging #10490

stevenwinship merged 53 commits into from
Nov 25, 2025

Conversation

@qqmyers
Copy link
Member

@qqmyers qqmyers commented Apr 12, 2024 •
edited by pdurbin
Loading

What this PR does / why we need it: This PR updates our COAR LDN messaging to be compliant with the final specification and improves/updates the code in various ways now that several sites will be deploying it.

  • Updates to the final spec
  • Updates how the title of the remote resource is retrieved (via signposting!)
  • Separates the idea of the general LDN inbox from COAR Notify messages and the specific COAR Notify Relationship Announcement message type (the only one we currently handle)
  • Updates setting to match - moves the non-workflow ones to JVM options (workflows currently only support db settings)
  • allows multiple targets when sending messages
  • Improves the parsing of the publication subfields and other possible fields to find a remote resource URI
  • Improves error handling
  • Enhances and updates documentation
  • Now sends the publication relationType (new since the original code)
  • Added tests of receiving messages.

Which issue(s) this PR closes:

Special notes for your reviewer: In testing, I found that the TDL dev server was failing to show the notifications page due to the JSONUtil.getJsonObject(String) method being overloaded by the JSONUtil.getJsonObject(InputStream) method - the log was showing a problem converting the input string to an InputStream. The PR includes a change to make the stream version getJsonObjectFromInputStream() to avoid this.

Suggestions on how to test this: This has been tested against the Harvard DASH test repository and with TDL's DSpace test instance. The code includes IT tests related to receiving and parsing messages. It is possible to manually replicate those tests by sending the appropriate JSON to the /api/inbox endpoint.

Turning on fine logging for the various classes (LDN Inbox, COARNotificationRelationshipAnnouncement, COARNotificationRelationshipAnnouncementStep) will show what messages are being received or sent in the server.log

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

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

Additional documentation: included

qqmyers added 21 commits August 11, 2022 14:49
@qqmyers
HDC 3b 1.5 initial update
a9f72f2
@qqmyers
add workflow settings to main list per qa
63aeed1
@qqmyers
start adding default bestID
a410659
@qqmyers
replace system.out.println call
8b69c0f
@qqmyers
Improve default compound field handling and some reformatting
cbd20fa
@qqmyers
add template custom instructions info
94d40e6
@qqmyers
get blocks from metadataroot
aa88182
@qqmyers
Merge remote-tracking branch 'IQSS/develop' into GDCC/8914-COAR-compl…
c9c7c91 
…iant_messaging
@qqmyers
fix parsing to match spec/dash msg
62fe214
@qqmyers
use getString for 'Relationship', revert other changes
e5228af
@qqmyers
temporarily drop name/type in display
fb56d04
@qqmyers
misplaced }
8ecb8e4
@qqmyers
Add callback loop and make display tolerant wrt name/type being found
789b3c9
@qqmyers
Merge remote-tracking branch 'IQSS/develop' into GDCC/8914-COAR-compl…
d06c5dc 
…iant_messaging
@qqmyers
Merge remote-tracking branch 'IQSS/develop' into GDCC/8914-COAR-compl…
d84ae12 
…iant_messaging
@qqmyers
add fields missing in https://notify.coar-repositories.org/scenarios/10/
37ebf7d
@qqmyers
debugging
ceb3ff5
@qqmyers
added logging/switched to info for HDC debugging
62888e2
@qqmyers
Merge remote-tracking branch 'IQSS/develop' into
6c46571 
GDCC/8914-COAR-compliant_messaging
@qqmyers
Merge remote-tracking branch 'IQSS/develop' into GDCC/8914-COAR-compl…
1a28089 
…iant_messaging
@qqmyers
merge issues
d714a1a
@qqmyers qqmyers mentioned this pull request Aug 8, 2024
Open
@coveralls
Copy link

coveralls commented Oct 2, 2024 •
edited
Loading

Coverage Status

coverage: 24.165% (+0.1%) from 24.037%
when pulling 54b060c on GlobalDataverseCommunityConsortium:GDCC/8914-COAR-compliant_messaging
into b8f5c1e on IQSS:develop.

@pdurbin pdurbin added the Type: Feature a feature request label Oct 9, 2024
@qqmyers
Copy link
Member Author

qqmyers commented Oct 17, 2024

Note: A v.1.0.0 version of the COAR Notify specification has just been released - see https://coar-notify.net/2024/significant-revision-to-specification/. This PR has not yet been checked to make sure it is consistent with the changes in this release.

@qqmyers qqmyers added the Size: 10 A percentage of a sprint. 7 hours. label Jul 8, 2025
@qqmyers qqmyers added this to the 6.8 milestone Jul 11, 2025
@qqmyers qqmyers removed the Status: Merge Conflicts Merge conflicts must be resolved. label Nov 13, 2025
pdurbin
pdurbin approved these changes Nov 13, 2025
View reviewed changes
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the changes I suggested. Approved.

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Nov 13, 2025
@pdurbin pdurbin removed their assignment Nov 13, 2025
@qqmyers qqmyers mentioned this pull request Nov 17, 2025
Open
@stevenwinship
Copy link
Contributor

stevenwinship commented Nov 20, 2025

@qqmyers Please resolve the conflicts

@qqmyers
Merge remote-tracking branch 'IQSS/develop' into
4da5d6f 
GDCC/8914-COAR-compliant_messaging_orig
@stevenwinship stevenwinship moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Nov 21, 2025
stevenwinship
stevenwinship reviewed Nov 21, 2025
View reviewed changes
stevenwinship
stevenwinship reviewed Nov 21, 2025
View reviewed changes
@stevenwinship
Copy link
Contributor

stevenwinship commented Nov 21, 2025

I'm also seeing a lot of these in the log

6.2025.3|edu.harvard.iq.dataverse.api.LDNInbox|_ThreadID=240;_ThreadName=http-thread-pool::http-listener-1(7);_TimeMillis=1763736091927;_LevelValue=1000;|

Ignoring message from IP address: 178.128.69.202|#]

@stevenwinship
Copy link
Contributor

stevenwinship commented Nov 21, 2025

LDNInboxIT is not included in tests/integration-tests.txt which explains why there were no failures in the pipeline tests

@cmbz cmbz added the FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) label Nov 22, 2025
@qqmyers qqmyers removed their assignment Nov 24, 2025
@stevenwinship stevenwinship merged commit 739052f into IQSS:develop Nov 25, 2025
17 checks passed
@github-project-automation github-project-automation bot moved this from 🔍 Interest to Done in Recherche Data Gouv Nov 25, 2025
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Nov 25, 2025
@stevenwinship stevenwinship removed their assignment Nov 25, 2025
@pdurbin pdurbin moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Nov 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pdurbin pdurbin pdurbin approved these changes

@stevenwinship stevenwinship stevenwinship left review comments

Assignees

No one assigned

Labels

FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) FY26 Sprint 9 FY26 Sprint 9 (2025-10-22 - 2025-11-05) FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) GDCC: Borealis of interest to Borealis GDCC: Harvard related to GDCC work for Harvard Size: 10 A percentage of a sprint. 7 hours. TDL of interest to the Texas Digital Library Type: Feature a feature request

Projects

IQSS Dataverse Project
Status: Done 🧹
Recherche Data Gouv
Status: Done

Milestone

6.9

Development

Successfully merging this pull request may close these issues.

Make LDN messages COAR compliant

6 participants

@qqmyers @coveralls @stevenwinship @pdurbin @scolapasta @cmbz