Auto Create thumbnail so Search API will return image_url when publis… (#12403)

stevenwinship · landreev · web-flow · commit 8bbd737029d3 · 2026-05-29T11:32:56.000-04:00
* Auto Create thumbnail so Search API will return image_url when publishing Datasets * clean up test * review comments * review comments * clean up JsonPrinter * Fixing an old bug that resulted in jsf triggering auto-selection of a dataset-level thumbnail in some situations. #11588 * fix race comdition updating dataset with thumbnail * fix race comdition updating dataset with thumbnail * increase max dataset index wait --------- Co-authored-by: Leonid Andreev <leonid@hmdc.harvard.edu>
diff --git a/doc/release-notes/11588-search-api-doesnt-return-image-url.md b/doc/release-notes/11588-search-api-doesnt-return-image-url.md
@@ -0,0 +1,4 @@
+## BUG ##
+Search API doesn't return image_url after newly created dataset is published.
+
+The Dataset thumbnail will be created automatically when a Dataset is published under the following conditions: The Dataset has no existing thumbnail; The Dataset has image files that can be converted to a thumbnail; The Feature Flag "disable-dataset-thumbnail-autoselect" is not enabled;
diff --git a/src/main/java/edu/harvard/iq/dataverse/Dataset.java b/src/main/java/edu/harvard/iq/dataverse/Dataset.java
@@ -763,6 +763,10 @@ public void setThumbnailFile(DataFile thumbnailFile) {
         this.thumbnailFile = thumbnailFile;
     }
 
+    public String getThumbnailUrl() {
+        return thumbnailFile != null ? SystemConfig.getDataverseSiteUrlStatic() + "/api/datasets/" + this.getId() + "/logo" : null;
+    }
+
     public boolean isUseGenericThumbnail() {
         return useGenericThumbnail;
     }
diff --git a/src/main/java/edu/harvard/iq/dataverse/DatasetVersionServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/DatasetVersionServiceBean.java
@@ -35,7 +35,6 @@
 import jakarta.json.JsonObjectBuilder;
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.NoResultException;
-import jakarta.persistence.OptimisticLockException;
 import jakarta.persistence.PersistenceContext;
 import jakarta.persistence.Query;
 import jakarta.persistence.TypedQuery;
@@ -892,7 +891,7 @@ public Long getThumbnailByVersionId(Long versionId) {
 
                 if (thumbnailFileId != null) {
                     logger.fine("obtained file id: " + thumbnailFileId);
-                    DataFile thumbnailFile = datafileService.find(thumbnailFileId);
+                    DataFile thumbnailFile = getDataFileById(thumbnailFileId);
                     if (thumbnailFile != null) {
                         if (datafileService.isThumbnailAvailable(thumbnailFile)) {
                             assignDatasetThumbnailByNativeQuery(versionId, thumbnailFileId);
@@ -925,7 +924,7 @@ public Long getThumbnailByVersionId(Long versionId) {
                 }
 
                 if (thumbnailFileId != null) {
-                    DataFile thumbnailFile = datafileService.find(thumbnailFileId);
+                    DataFile thumbnailFile = getDataFileById(thumbnailFileId);
                     if (thumbnailFile != null) {
                         if (datafileService.isThumbnailAvailable(thumbnailFile)) {
                             assignDatasetThumbnailByNativeQuery(versionId, thumbnailFileId);
@@ -937,7 +936,11 @@ public Long getThumbnailByVersionId(Long versionId) {
         }
         return null;
     }
-    
+
+    public DataFile getDataFileById(Long id) {
+        return datafileService.find(id);
+    }
+
     private void assignDatasetThumbnailByNativeQuery(Long versionId, Long dataFileId) {
         try {
             em.createNativeQuery("UPDATE dataset SET thumbnailfile_id=" + dataFileId + " WHERE id in (SELECT dataset_id FROM datasetversion WHERE id=" + versionId + ")").executeUpdate();
diff --git a/src/main/java/edu/harvard/iq/dataverse/ThumbnailServiceWrapper.java b/src/main/java/edu/harvard/iq/dataverse/ThumbnailServiceWrapper.java
@@ -208,11 +208,11 @@ public String getDatasetCardImageAsUrl(Dataset dataset, Long versionId, boolean
             // If no other logo we attempt to auto-select via the optimized, native
             // query-based method
             // from the DatasetVersionService:
-            if (!hasDatasetLogo && datasetVersionService.getThumbnailByVersionId(versionId) == null) {
+            if (!hasDatasetLogo && (!autoselect || datasetVersionService.getThumbnailByVersionId(versionId) == null)) {
                 return null;
             }
         }
-        String url = SystemConfig.getDataverseSiteUrlStatic() + "/api/datasets/" + dataset.getId() + "/logo";
+        String url = dataset.getThumbnailUrl();
         logger.fine("getDatasetCardImageAsUrl: " + url);
         this.dvobjectThumbnailsMap.put(datasetId,url);
         return url;
diff --git a/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/FinalizeDatasetPublicationCommand.java b/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/FinalizeDatasetPublicationCommand.java
@@ -171,7 +171,16 @@ public Dataset execute(CommandContext ctxt) throws CommandException {
         
         //Use dataset pub date (which may not be the current date for migrated datasets)
         updateFiles(new Timestamp(version.getReleaseTime().getTime()), ctxt);
-        
+
+        // Populate thumbnail if needed and allowed
+        if (theDataset.getThumbnailFile() == null && !theDataset.isUseGenericThumbnail()) {
+            Long thumbnailFileId = ctxt.datasetVersion().getThumbnailByVersionId(version.getId());
+            if (thumbnailFileId != null) {
+                theDataset.setThumbnailFile(ctxt.datasetVersion().getDataFileById(thumbnailFileId));
+                logger.info("Setting default thumbnail " + theDataset.getThumbnailUrl());
+            }
+        }
+
         // 
         // TODO: Not sure if this .merge() is necessary here - ? 
         // I'm moving a bunch of code from PublishDatasetCommand here; and this .merge()
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java b/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java
@@ -551,6 +551,7 @@ public static JsonObjectBuilder json(Dataset ds, Boolean returnOwners) {
                 .add("separator", ds.getSeparator())
                 .add("publisher", BrandingUtil.getInstallationBrandName())
                 .add("publicationDate", ds.getPublicationDateFormattedYYYYMMDD())
+                .add("image_url", ds.getThumbnailUrl())
                 .add("storageIdentifier", ds.getStorageIdentifier());
         if (ds.getGuestbook() != null) {
             bld.add("guestbookId", ds.getGuestbook().getId());
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/DataRetrieverApiIT.java b/src/test/java/edu/harvard/iq/dataverse/api/DataRetrieverApiIT.java
@@ -21,7 +21,6 @@
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.startsWith;
 import static org.junit.jupiter.api.Assertions.*;
-import org.junit.jupiter.api.Disabled;
 
 public class DataRetrieverApiIT {
 
@@ -78,7 +77,7 @@ public void testRetrieveMyDataAsJsonString() throws InterruptedException {
         Response createDatasetResponse = UtilIT.createRandomDatasetViaNativeApi(dataverseAlias, normalUserApiToken);
         createDatasetResponse.prettyPrint();
         Integer datasetId = UtilIT.getDatasetIdFromResponse(createDatasetResponse);
-        UtilIT.sleepForReindex(datasetId.toString(), normalUserApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetId.toString(), normalUserApiToken);
         Response oneDatasetResponse = UtilIT.retrieveMyDataAsJsonString(normalUserApiToken, "", new ArrayList<>(Arrays.asList(6L)));
         assertEquals(OK.getStatusCode(), oneDatasetResponse.getStatusCode());
         JsonPath jsonPathOneDataset = oneDatasetResponse.getBody().jsonPath();
@@ -277,13 +276,13 @@ public void testRetrieveMyDataAsJsonStringSortOrder() {
         createDatasetOneResponse.prettyPrint();
         Integer datasetOneId = UtilIT.getDatasetIdFromResponse(createDatasetOneResponse);
         String datasetOnePid = UtilIT.getDatasetPersistentIdFromResponse(createDatasetOneResponse);
-        UtilIT.sleepForReindex(datasetOneId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetOneId.toString(), userApiToken);
 
         Response createDatasetTwoResponse = UtilIT.createRandomDatasetViaNativeApi(dataverseAlias, userApiToken);
         createDatasetTwoResponse.prettyPrint();
         Integer datasetTwoId = UtilIT.getDatasetIdFromResponse(createDatasetTwoResponse);
         String datasetTwoPid = UtilIT.getDatasetPersistentIdFromResponse(createDatasetTwoResponse);
-        UtilIT.sleepForReindex(datasetTwoId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetTwoId.toString(), userApiToken);
 
         // Request datasets belonging to user
         Response twoDatasetsInReviewResponse = UtilIT.retrieveMyDataAsJsonString(userApiToken, "", new ArrayList<>(Arrays.asList(6L)));
@@ -301,13 +300,13 @@ public void testRetrieveMyDataAsJsonStringSortOrder() {
         Response publishDatasetOne = UtilIT.publishDatasetViaNativeApi(datasetOneId, "major", superUserApiToken);
         publishDatasetOne.prettyPrint();
         publishDatasetOne.then().assertThat().statusCode(OK.getStatusCode());
-        UtilIT.sleepForReindex(datasetOneId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetOneId.toString(), userApiToken);
 
         // Publish dataset 2
         Response publishDatasetTwo = UtilIT.publishDatasetViaNativeApi(datasetTwoId, "major", superUserApiToken);
         publishDatasetTwo.prettyPrint();
         publishDatasetTwo.then().assertThat().statusCode(OK.getStatusCode());
-        UtilIT.sleepForReindex(datasetTwoId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetTwoId.toString(), userApiToken);
 
         // Request datasets belonging to user
         Response twoPublishedDatasetsResponse = UtilIT.retrieveMyDataAsJsonString(userApiToken, "", new ArrayList<>(Arrays.asList(6L)));
@@ -326,7 +325,7 @@ public void testRetrieveMyDataAsJsonStringSortOrder() {
         Response addDataToPublishedVersion = UtilIT.addDatasetMetadataViaNative(datasetOnePid, pathToJsonFilePostPub, userApiToken);
         addDataToPublishedVersion.prettyPrint();
         addDataToPublishedVersion.then().assertThat().statusCode(OK.getStatusCode());
-        UtilIT.sleepForReindex(datasetOneId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetOneId.toString(), userApiToken);
 
         // Request datasets belonging to user
         Response twoPublishedDatasetsOneDraftResponse = UtilIT.retrieveMyDataAsJsonString(userApiToken, "", new ArrayList<>(Arrays.asList(6L)));
@@ -350,7 +349,7 @@ public void testRetrieveMyDataAsJsonStringSortOrder() {
         Response uploadImage = UtilIT.uploadFileViaNative(datasetTwoId.toString(), pathToFile, userApiToken);
         uploadImage.prettyPrint();
         uploadImage.then().assertThat().statusCode(OK.getStatusCode());
-        UtilIT.sleepForReindex(datasetTwoId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetTwoId.toString(), userApiToken);
 
         // Request datasets belonging to user
         Response twoPublishedDatasetsTwoDraftsResponse = UtilIT.retrieveMyDataAsJsonString(userApiToken, "", new ArrayList<>(Arrays.asList(6L)));
@@ -373,7 +372,7 @@ public void testRetrieveMyDataAsJsonStringSortOrder() {
         Response publishDatasetOneMinor = UtilIT.publishDatasetViaNativeApi(datasetOneId, "minor", superUserApiToken);
         publishDatasetOneMinor.prettyPrint();
         publishDatasetOneMinor.then().assertThat().statusCode(OK.getStatusCode());
-        UtilIT.sleepForReindex(datasetOneId.toString(), userApiToken, 4);
+        UtilIT.sleepForDatasetIndex(datasetOneId.toString(), userApiToken);
 
         // Request datasets belonging to user
         Response oneMinorOneMajorOneDraftDatasetResponse = UtilIT.retrieveMyDataAsJsonString(userApiToken, "", new ArrayList<>(Arrays.asList(6L)));
@@ -429,7 +428,7 @@ public void testRetrieveMyDataWithMetadataFields() {
         Response createDatasetResponse = UtilIT.createRandomDatasetViaNativeApi(dataverseAlias, apiToken);
         String datasetId = UtilIT.getDatasetIdFromResponse(createDatasetResponse).toString();
         
-        UtilIT.sleepForReindex(datasetId, apiToken, 5);
+        UtilIT.sleepForDatasetIndex(datasetId, apiToken);
         
         Response myDataWithAuthor = UtilIT.retrieveMyDataAsJsonString(apiToken, "", new ArrayList<>(Arrays.asList(6L)), "&metadata_fields=citation:author");
         myDataWithAuthor.prettyPrint();
@@ -482,7 +481,7 @@ public void testRetrieveMyDataWithCollections() {
 
         UtilIT.publishDatasetViaNativeApi(datasetId, "major", apiToken).then().assertThat().statusCode(OK.getStatusCode());
 
-        UtilIT.sleepForReindex(datasetPid, apiToken, 5);
+        UtilIT.sleepForDatasetIndex(datasetPid, apiToken);
         
         // Test that the Dataverse collection that the dataset was created in is returned
         Response myDataResponse = UtilIT.retrieveMyDataAsJsonString(apiToken, "", new ArrayList<>(Arrays.asList(6L)), "&show_collections=true");
@@ -506,7 +505,7 @@ public void testRetrieveMyDataWithCollections() {
 
         UtilIT.linkDataset(datasetPid, dataverse2Alias, apiToken).then().assertThat().statusCode(OK.getStatusCode());
 
-        UtilIT.sleepForReindex(String.valueOf(datasetId), apiToken, 5);
+        UtilIT.sleepForDatasetIndex(String.valueOf(datasetId), apiToken);
 
         // Test that the Dataverse collection that the dataset was linked to is also returned
         myDataResponse = UtilIT.retrieveMyDataAsJsonString(apiToken, "", new ArrayList<>(Arrays.asList(6L)), "&show_collections=true");
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/SearchIT.java b/src/test/java/edu/harvard/iq/dataverse/api/SearchIT.java
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java b/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

Original file line number	Diff line number	Diff line change
`@@ -763,6 +763,10 @@ public void setThumbnailFile(DataFile thumbnailFile) {`
`763`	`763`	`this.thumbnailFile = thumbnailFile;`
`764`	`764`	`}`
`765`	`765`
	`766`	`+ public String getThumbnailUrl() {`
	`767`	`+ return thumbnailFile != null ? SystemConfig.getDataverseSiteUrlStatic() + "/api/datasets/" + this.getId() + "/logo" : null;`
	`768`	`+ }`
	`769`	`+`
`766`	`770`	`public boolean isUseGenericThumbnail() {`
`767`	`771`	`return useGenericThumbnail;`
`768`	`772`	`}`
Original file line number	Diff line number	Diff line change
`@@ -208,11 +208,11 @@ public String getDatasetCardImageAsUrl(Dataset dataset, Long versionId, boolean`
`208`	`208`	`// If no other logo we attempt to auto-select via the optimized, native`
`209`	`209`	`// query-based method`
`210`	`210`	`// from the DatasetVersionService:`
`211`		`- if (!hasDatasetLogo && datasetVersionService.getThumbnailByVersionId(versionId) == null) {`
	`211`	`+ if (!hasDatasetLogo && (!autoselect \|\| datasetVersionService.getThumbnailByVersionId(versionId) == null)) {`
`212`	`212`	`return null;`
`213`	`213`	`}`
`214`	`214`	`}`
`215`		`- String url = SystemConfig.getDataverseSiteUrlStatic() + "/api/datasets/" + dataset.getId() + "/logo";`
	`215`	`+ String url = dataset.getThumbnailUrl();`
`216`	`216`	`logger.fine("getDatasetCardImageAsUrl: " + url);`
`217`	`217`	`this.dvobjectThumbnailsMap.put(datasetId,url);`
`218`	`218`	`return url;`