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

Fix relationType display value bug #10926

Merged

Conversation

qqmyers
Copy link
Member

@qqmyers qqmyers commented Oct 15, 2024

What this PR does / why we need it: The recent changes to include more information in the XML sent to DataCite, including the new relationType child field for related publications, is sending the display value of that field rather than the real CVV value. DataCite is rejecting values that do not match it's schema. In English, any of the values that are multiple words, e.g. IsSupplementTo, having the display value Is Supplement To, cause DOI updates to fail and therefor for dataset publication to fail. (In other languages, presumably all values would fail.) Dataset that do not have a Related Publication entry, or have a default null value for the relationType, are unaffected (nulls are turned into an IsSupplementTo value in code which does not rely on the display value).

This PR make a simple change to include the CVV value itself rather than display value.

Which issue(s) this PR closes:

  • Closes #

Special notes for your reviewer:The change is made in the DatasetVersion method which is used to create jsonld and json for other purposed - the other uses right now do not use the relationType value at all, but, if/when they do, it seems like the real CVV value is what should be sent.

Suggestions on how to test this: Configure Dataverse to use DataCite, add a publication with the Is Supplement To relationType and make sure publication succeeds, that there is no error in the log, that DataCite Fabrica shows the information as expected.

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?: This is probably patch/announce worthy.

Additional documentation:

@qqmyers qqmyers added the Size: 3 A percentage of a sprint. 2.1 hours. label Oct 15, 2024
@coveralls
Copy link

coveralls commented Oct 15, 2024

Coverage Status

coverage: 21.506% (+0.6%) from 20.875%
when pulling 816b704 on QualitativeDataRepository:RelationType_Bug_Fix
into c44ad65 on IQSS:develop.

Copy link
Contributor

@landreev landreev left a comment

Choose a reason for hiding this comment

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

Nice test.

@cmbz cmbz added FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) labels Oct 23, 2024
@ofahimIQSS ofahimIQSS self-assigned this Nov 5, 2024
@ofahimIQSS
Copy link
Contributor

Hi @qqmyers - when I tested this PR in Internal, I could not see the "Relation Type" field on the UI of edit dataset metadata page so I couldn't test this. Please see screenshot below:

image

Steps:

  1. Go to https://dataverse-internal.iq.harvard.edu/
  2. Create Dataset
  3. Scroll to Related Publication Section

Expected Result: Relation Type field should be displayed under Related Publication section.

@qqmyers
Copy link
Member Author

qqmyers commented Nov 5, 2024

I'm guessing that step 6. Update metadata blocks of the Upgrade instructions for v6.4 wasn't done on that machine. Once the new citation metadata block is installed, the field should be there. (Could then be issues with indexing if step 7 update solr schema wasn't done.)

@ofahimIQSS
Copy link
Contributor

Testing Complete - fix looks good. Merging PR.
Testing of 10926.docx

@ofahimIQSS ofahimIQSS merged commit 5d392b6 into IQSS:develop Nov 5, 2024
11 checks passed
@ofahimIQSS ofahimIQSS removed their assignment Nov 5, 2024
@pdurbin pdurbin added this to the 6.5 milestone Nov 5, 2024
JayanthyChengan added a commit to scholarsportal/dataverse that referenced this pull request Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) Size: 3 A percentage of a sprint. 2.1 hours.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants