Skip to content
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.

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

COAR Notify impossible to send/receive message from another DSpace #3113

Merged
merged 8 commits into from
Jun 14, 2024

Conversation

atarix83
Copy link
Contributor

References

Add references/links to any related issues or PRs. These may include:

Description

This PR introduce important fixes in order to address DSpace/DSpace#9644.
It also contains a porting of fixes for the suggestions page from DSpace-CRIS.

Instructions for Reviewers

List of changes in this PR:

  • Added 'announce-relationship' as supported pattern when configuring a LDN service
  • When configuring a LDN service the pattern is no longer mandatory
  • Improved LDN form by adjusting form button color following application guidelines
  • Renamed and reorganized suggestion data services
  • Fixed an issue in the suggestion page with pagination of the suggestion entries

Include guidance for how to test or review your PR.
Please refer to instructions present in the REST PR here DSpace/DSpace#9645 (comment).

Checklist

  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using yarn lint
  • My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@atarix83 atarix83 changed the title Task/main/duracom 271 coar fixes fixed COAR Notify impossible to send/receive message from another DSpace Jun 12, 2024
@atarix83 atarix83 requested a review from tdonohue June 12, 2024 16:32
@tdonohue tdonohue added bug integration: COAR Notify / LDN Related to Linked Data Notifications (LDN) or COAR Notify services labels Jun 12, 2024
Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

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

👍 Thanks @atarix83 ! I was able to successfully test this process of sending LDN messages from one DSpace 8 instance to another DSpace 8 instance in order to link together two items.

The process itself went smoothly, but I found one odd / minor issue that I wish to report.

On the target repository, after you accept the COAR notify change, it adds a datacite.relation.isSupplementedBy field which links back to the source Item (in the source repository). This works well, but it shows the label "Dataset" for this field:

DataSet-label

These relationships may not always be to a "Dataset", so I'd propose we update the code with new i18n keys. This improper label exists also for datacite.relation.isReferencedBy and exists in two places (which were not added by this PR, but were added in earlier COAR Notify PRs).

I'd propose we remove the item.page.dataset i18n key, and replace it with two keys:

"item.page.supplemented": "Supplemented By",
"item.page.referenced": "Referenced By",

Then, obviously the datacite.relation.isSupplementedBy field should use item.page.supplemented and datacite.relation.isReferencedBy should use item.page.referenced.

This is a minor change, but I feel it's important to properly label these fields. If you have any objections, let me know, but I suspect this will take only a few minutes to fix.

Once fixed, I'll quickly review this and merge it. Thanks!

@tdonohue tdonohue added the needs documentation PR is missing documentation. All new features and config changes require documentation. label Jun 13, 2024
@tdonohue tdonohue added this to the 8.0 milestone Jun 13, 2024
@atarix83 atarix83 requested a review from tdonohue June 14, 2024 11:18
@atarix83
Copy link
Contributor Author

thanks @tdonohue

changes applied

Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

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

👍 Thanks @atarix83 ! Looks good to me now

@tdonohue
Copy link
Member

Merging, however this is flagged as needs documentation because we need to document how to send messages between DSpace instances using COAR Notify, perhaps in a new page under https://wiki.lyrasis.org/display/DSDOC8x/COAR+Notify

@tdonohue tdonohue merged commit d71964d into DSpace:main Jun 14, 2024
13 checks passed
@tdonohue
Copy link
Member

@tdonohue tdonohue removed the needs documentation PR is missing documentation. All new features and config changes require documentation. label Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug integration: COAR Notify / LDN Related to Linked Data Notifications (LDN) or COAR Notify services
Projects
No open projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

COAR Notify impossible to send/receive message from another DSpace
2 participants