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

995x - Signposting fixes #9955

Merged

Conversation

qqmyers
Copy link
Member

@qqmyers qqmyers commented Sep 25, 2023

What this PR does / why we need it: This addresses several issues raised by the community in signposting - two related to the format of output that wasn't per the spec, one regarding the mimetype used for a link, and one to avoid a potential issue where auto-updates of the page were failing in 5.14. (For the last one, it appears that 6.0 offers a fix. The fixes here will assure if workingversion == null for signposting occurs, it will not result in an exception that stops processing. They also add a check to make sure the versionId is set in the DatasetPage.refresh method, which was the problem in v5.14 as described in #9954.)

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this: For the first two, read the issue and assure that the output now matches, i.e. <> chars exist in the license line and calling the linkset api doesn't return a linkset object as a child of a "data" json object. For the third, verify the mimetype used for the link in the issue is application/ld_json and verify the curl command in the issue - changed to use the new mimetype - works. For the last - as of now, regression testing that publishing a dataset works with the page finally updating to the published version is all we can do in 6.x. This is because 6.0 has changes that fix the known test cases and we don't know if the problem still exists in 6.x (with the fixes, if the problem does occur, we'll get waning messages in the log rather than having the dataset page display/refresh fail). FWIW, I did verify that the fixes here worked/works at QDR prior to the 6.0 fix.

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?: added.

Additional documentation:

@coveralls
Copy link

coveralls commented Sep 25, 2023

Coverage Status

coverage: 20.035% (-0.003%) from 20.038% when pulling 3629cb6 on GlobalDataverseCommunityConsortium:GDCC/Signposting into 7e0738e on IQSS:develop.

@pdurbin pdurbin added the Feature: Signposting Typed links in headers, etc. https://signposting.org label Sep 26, 2023
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.

For my reference, the original Signposting PR:

I'm just asking a question in this review.

Related issues and PRs:

@qqmyers qqmyers added the Size: 3 A percentage of a sprint. 2.1 hours. label Sep 26, 2023
@qqmyers qqmyers added this to the 6.1 milestone Sep 27, 2023
@pdurbin pdurbin self-assigned this Oct 3, 2023
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.

There's a failing test:

java.lang.NullPointerException: Cannot invoke "jakarta.json.JsonArray.getJsonObject(int)" because the return value of "jakarta.json.JsonObject.getJsonArray(String)" is null
at edu.harvard.iq.dataverse.api.SignpostingIT.testSignposting(SignpostingIT.java:96)

See https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-9955/6/testReport/edu.harvard.iq.dataverse.api/SignpostingIT/testSignposting/

@qqmyers qqmyers removed their assignment Oct 3, 2023
@pdurbin
Copy link
Member

pdurbin commented Oct 4, 2023

I added some docs and tests in 9f0b810. @qqmyers if I added any inaccuracies, please correct them!

I also merged the latest from develop.

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.

Looks good!

@pdurbin pdurbin removed their assignment Oct 10, 2023
janvanmansum added a commit to janvanmansum/dataverse that referenced this pull request Oct 11, 2023
janvanmansum added a commit to DANS-KNAW/dataverse that referenced this pull request Oct 11, 2023
janvanmansum added a commit to DANS-KNAW/dataverse that referenced this pull request Oct 12, 2023
* Applied IQSS#9984

* Merge IQSS#9955

---------

Co-authored-by: Jan van Mansum <janvanmansum@gmail.com>
Co-authored-by: Jan van Mansum <jan.van.mansum@dans.knaw.nl>
@kcondon kcondon self-assigned this Oct 16, 2023
@kcondon kcondon merged commit 6c5e411 into IQSS:develop Oct 16, 2023
9 checks passed
PaulBoon pushed a commit to PaulBoon/dataverse that referenced this pull request Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Signposting Typed links in headers, etc. https://signposting.org Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: No status
4 participants