Skip to content

Local Reviews (via API and Croissant)#12425

Open
pdurbin wants to merge 10 commits into
developfrom
12313-local-reviews-croissant
Open

Local Reviews (via API and Croissant)#12425
pdurbin wants to merge 10 commits into
developfrom
12313-local-reviews-croissant

Conversation

@pdurbin

@pdurbin pdurbin commented Jun 2, 2026

Copy link
Copy Markdown
Member

What this PR does / why we need it:

We want to support local reviews, which is when a review dataset points at a regular dataset and both are in the same installation of Dataverse.

Which issue(s) this PR closes:

Special notes for your reviewer:

  • I made some slides that show the functionality.
  • We are deferring some performance work: Performance of Croissant with reviews (JSON is not cached) #12442
  • ReviewsIT isn't being executed by Jenkins because we don't load the reviews.tsv
  • I called the command GetDatasetReviewsCommand but I'm ok with changing it to ListDatasetReviewsCommand to match the entry in the API Guide.

Suggestions on how to test this:

In Docker, set DATAVERSE_FEATURE_CROISSANT_WITH_LOCAL_REVIEWS to "1" (or use the JVM equivalent).

Create a dataset like this:

Screenshot 2026-04-13 at 4 55 54 PM

Then, create a review dataset that points to the dataset like this:

Screenshot 2026-04-13 at 4 56 16 PM

Then try the new "list reviews" API endpoint.

Then download the Croissant for the dataset being reviewed. It should contain the review. This Croissant should be in the "head" of the HTML as well.

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

No.

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

Yes, included.

Additional documentation:

Preview at https://dataverse-guide--12327.org.readthedocs.build/en/12327/api/native-api.html#list-reviews

In the image below (source) ReviewDataset2 is a local review:

Screenshot 2026-04-14 at 2 43 37 PM

@github-actions github-actions Bot added Croissant Croissant and Kaggle related work FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) Project: Trusted Data Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) labels Jun 2, 2026
@pdurbin pdurbin mentioned this pull request Jun 2, 2026
// "maxValue": 10
// }
// },
// ]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck> reported by reviewdog 🐶
File contains tab characters (this is the first instance).

@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Jun 2, 2026
@pdurbin pdurbin added this to the 6.11 milestone Jun 2, 2026
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

Test Results

397 tests  ±0   382 ✅ ±0   32m 48s ⏱️ + 7m 37s
 53 suites ±0    15 💤 ±0 
 53 files   ±0     0 ❌ ±0 

Results for commit ac0d032. ± Comparison against base commit 0a1817f.

♻️ This comment has been updated with latest results.

@pdurbin pdurbin force-pushed the 12313-local-reviews-croissant branch from 613d452 to d6f93f6 Compare June 3, 2026 17:00
@coveralls

coveralls commented Jun 3, 2026

Copy link
Copy Markdown

Coverage Status

coverage: 25.08% (+0.01%) from 25.067% — 12313-local-reviews-croissant into develop

@github-actions

This comment has been minimized.

pdurbin added 2 commits June 3, 2026 16:35
tests/verify_mdb_properties.sh now passes
@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 25 FY26 Sprint 25 (2026-06-03 - 2026-06-17) label Jun 3, 2026
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:12313-local-reviews-croissant
ghcr.io/gdcc/configbaker:12313-local-reviews-croissant

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@stevenwinship stevenwinship self-assigned this Jun 4, 2026
@stevenwinship stevenwinship moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jun 4, 2026

@stevenwinship stevenwinship left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved. Code looks good. Docs look good. I also tested using ReviewsIT in docker deployed environment after loading both tsv files, updating solr schema, and enabling the feature flag.

@github-project-automation github-project-automation Bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jun 4, 2026
@stevenwinship stevenwinship removed their assignment Jun 4, 2026
@pdurbin pdurbin added Size: 10 A percentage of a sprint. 7 hours. Original size: 30 and removed Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) labels Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Croissant Croissant and Kaggle related work FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) FY26 Sprint 25 FY26 Sprint 25 (2026-06-03 - 2026-06-17) Original size: 30 Project: Trusted Data Size: 10 A percentage of a sprint. 7 hours.

Projects

Status: Ready for QA ⏩

Development

Successfully merging this pull request may close these issues.

Croissant with local reviews Local reviews

4 participants