Dataverse Featured Items support #11124

GPortas · 2024-12-23T12:51:18Z

What this PR does / why we need it:

CRUD endpoints for Collection Featured Items have been implemented. In particular, the following endpoints have been implemented:

Create a feature item (POST /api/dataverses/<dataverse_id>/featuredItems)
Update a feature item (PUT /api/dataverseFeaturedItems/<item_id>)
Delete a feature item (DELETE /api/dataverseFeaturedItems/<item_id>)
List all featured items in a collection (GET /api/dataverses/<dataverse_id>/featuredItems)
Delete all featured items in a collection (DELETE /api/dataverses/<dataverse_id>/featuredItems)
Update all featured items in a collection (PUT /api/dataverses/<dataverse_id>/featuredItems)

Which issue(s) this PR closes:

Closes API support for SPA Featured Items #10943

Suggestions on how to test this:

Follow the docs added to native-api to make curl calls and test the different operations on featured items.

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, attached.

Preview docs at https://dataverse-guide--11124.org.readthedocs.build/en/11124/api/native-api.html#list-collection-featured-items

…averseFeaturedItemCommand

… the featured item image from the client

…ed-items

pdurbin

This is a big PR that adds some very useful functionality. I'm leaving some initial feedback and assigning @GPortas to take a look.

pdurbin · 2025-01-16T17:14:08Z

src/test/java/edu/harvard/iq/dataverse/api/DataverseFeaturedItemsIT.java

@@ -0,0 +1,112 @@
+package edu.harvard.iq.dataverse.api;
+


Heads up that some tests are failing at https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-11124/36/testReport/

I don't have access to Jenkins. Can you tell me exactly which tests are failing? I can also request temporal access to Jenkins.

doc/release-notes/10943-featured-items.md

doc/sphinx-guides/source/api/native-api.rst

pdurbin · 2025-01-16T17:23:55Z

doc/sphinx-guides/source/api/native-api.rst

+
+The ``file`` parameter must be specified for each image we want to attach to featured items. Note that images can be shared between featured items, so ``fileName`` can have the same value in different featured items.
+
+The ``id`` parameter must be ``0`` for new items or set to the item's identifier for updates. The ``fileName`` parameter should be empty to exclude an image or match the name of a file sent in a ``file`` parameter to set a new image. ``keepFile`` must always be set to ``false``, unless it's an update to a featured item where we want to preserve the existing image, if one exists.


Wow! This is a bit confusing! The examples as well, with all the -F arguments. Did you consider other ways of accepting input, such as having all input in a JSON file? Are you happy with the final result?

I tried to simplify the input, but couldn't make it simpler due to how the API handles Multipart Form Data input type. For example, the inability to send optional parameters while maintaining the relationship between properties of the same object in the form forced me to structure it this way (e.g. using 0 as id, or keepFile=false when not needed). Currently, js-dataverse successfully calls the endpoint, and it works correctly in the SPA (check the related PRs: IQSS/dataverse-client-javascript#235 and IQSS/dataverse-frontend#575). I will be happy to simplify it further in the future if we find a better way to send the data.

pdurbin · 2025-01-16T17:25:42Z

src/main/java/edu/harvard/iq/dataverse/DataverseFeaturedItem.java

+@Entity
+@Table(indexes = @Index(columnList = "displayOrder"))
+public class DataverseFeaturedItem {


We don't need a SQL upgrade script because we're creating a new table, is that right?

pdurbin · 2025-01-16T17:28:16Z

src/main/java/edu/harvard/iq/dataverse/util/MarkupChecker.java

+                .addTags("h1", "h2", "h3", "kbd", "hr", "s", "del", "map", "area")
+                .addAttributes("img", "usemap")


I'm a little confused what's going on here. Are we allowing more HTML tags and attributes? Does this affect other parts of the app, besides features items? 🤔

No. We only allow more HTML tags for featured items, where for example we need to prevent HTML sanitization from removing important tags like className. Previous use cases work as before. The many changes you see are simply due to the refactoring I did to selectively support the new logic for featured items.

Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>

github-actions · 2025-01-21T19:10:12Z

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10943-featured-items

ghcr.io/gdcc/configbaker:10943-featured-items

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

GPortas added 2 commits December 16, 2024 17:51

Stash: update featureItems endpoint PoC WIP

d796959

Stash: CreateDataverseFeaturedItemCommand WIP

755fd4d

GPortas marked this pull request as draft December 23, 2024 12:51

GPortas added 9 commits December 24, 2024 19:04

Changed: multiple featured item creation endpoint converted to single

67e3fe0

Removed: unused/incorrect code

b7352aa

Removed: unused imports

0744c30

Added: persisting featured items in the database

2c96f21

Added: new InvalidCommandArgumentsException and using it in CreateDat…

9cc6117

…averseFeaturedItemCommand

Added: endpoint for listing featured items

11a0592

Added: returning imageUrl with new associated endpoint for retrieving…

ec3b6f2

… the featured item image from the client

Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…

ea798b8

…ed-items

Removed: wrongly committed files

160ffa5

This comment has been minimized.

Sign in to view

Stash: relocating file-specific logic and unit tests in progress

f124f4a

This comment has been minimized.

Sign in to view

Fixed: exception handling when image file is invalid in a featured item

64ec37b

This comment has been minimized.

Sign in to view

Added: tweaks and fixes for featured items

98f3645

This comment has been minimized.

Sign in to view

GPortas added 3 commits January 1, 2025 11:33

Added: flush call when saving DataverseFeaturedItem

ea03a07

Added: DeleteDataverseFeaturedItemCommand

ea388ba

Added: DataverseFeaturedItems API with delete method

7ede831

This comment has been minimized.

Sign in to view

GPortas added 3 commits January 1, 2025 14:00

Added: DataverseFeaturedItems API with delete method IT

d50a943

Added: DataverseFeaturedItemsIT assertion

220e02a

Added: testCreateFeaturedItem IT cases

1bc2ba7

This comment has been minimized.

Sign in to view

Added: handling image file optionality in dataverse featured items

f7d60c7

This comment has been minimized.

Sign in to view

Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…

d386bc6

…ed-items

GPortas added the SPA.Q1 Not related to any specific Q1 feature label Jan 15, 2025

This comment has been minimized.

Sign in to view

GPortas added 2 commits January 15, 2025 16:32

Added: docs for updating a single featured item through API

a5b2687

Added: docs for deleting a single featured item through API

651347e

This comment has been minimized.

Sign in to view

Fixed: Bundle.properties string format

4503aa8

This comment has been minimized.

Sign in to view

Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…

a90b7e5

…ed-items

This comment has been minimized.

Sign in to view

g-saracca mentioned this pull request Jan 16, 2025

Featured Items - Collection Page IQSS/dataverse-frontend#575

Open

Fixed: typos in Bundle.properties

15568a8

This comment has been minimized.

Sign in to view

GPortas added 2 commits January 16, 2025 15:36

Added: API docs for updating all featured items

93c1eca

Added: release notes for #10943

13301be

This comment has been minimized.

Sign in to view

Changed: API endpoint route

38e7d88

GPortas marked this pull request as ready for review January 16, 2025 15:59

GPortas added Size: 10 A percentage of a sprint. 7 hours. Original size: 10 SPA These changes are required for the Dataverse SPA FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) labels Jan 16, 2025

This comment has been minimized.

Sign in to view

pdurbin self-assigned this Jan 16, 2025

pdurbin reviewed Jan 16, 2025

View reviewed changes

pdurbin assigned GPortas Jan 16, 2025

GPortas and others added 2 commits January 21, 2025 18:59

Changed: updated release notes

c4387d5

Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>

Changed: docs title format tweak

17f523a

Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>

This comment has been minimized.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dataverse Featured Items support #11124

Dataverse Featured Items support #11124

GPortas commented Dec 23, 2024 •

edited by pdurbin

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

pdurbin left a comment

pdurbin Jan 16, 2025

GPortas Jan 21, 2025

pdurbin Jan 16, 2025

GPortas Jan 21, 2025

pdurbin Jan 16, 2025

pdurbin Jan 16, 2025

GPortas Jan 21, 2025

This comment has been minimized.

github-actions bot commented Jan 21, 2025


		The ``file`` parameter must be specified for each image we want to attach to featured items. Note that images can be shared between featured items, so ``fileName`` can have the same value in different featured items.

		The ``id`` parameter must be ``0`` for new items or set to the item's identifier for updates. The ``fileName`` parameter should be empty to exclude an image or match the name of a file sent in a ``file`` parameter to set a new image. ``keepFile`` must always be set to ``false``, unless it's an update to a featured item where we want to preserve the existing image, if one exists.

		.addTags("h1", "h2", "h3", "kbd", "hr", "s", "del", "map", "area")
		.addAttributes("img", "usemap")

Dataverse Featured Items support #11124

Are you sure you want to change the base?

Dataverse Featured Items support #11124

Conversation

GPortas commented Dec 23, 2024 • edited by pdurbin Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

pdurbin left a comment

Choose a reason for hiding this comment

pdurbin Jan 16, 2025

Choose a reason for hiding this comment

GPortas Jan 21, 2025

Choose a reason for hiding this comment

pdurbin Jan 16, 2025

Choose a reason for hiding this comment

GPortas Jan 21, 2025

Choose a reason for hiding this comment

pdurbin Jan 16, 2025

Choose a reason for hiding this comment

pdurbin Jan 16, 2025

Choose a reason for hiding this comment

GPortas Jan 21, 2025

Choose a reason for hiding this comment

This comment has been minimized.

github-actions bot commented Jan 21, 2025

GPortas commented Dec 23, 2024 •

edited by pdurbin

Loading