From 09b5c4c5c1903a78842135217c3c2001a214cba0 Mon Sep 17 00:00:00 2001
From: Ludovic DANIEL <ludovic.daniel@smile.fr>
Date: Wed, 16 Aug 2023 16:25:41 +0200
Subject: [PATCH 1/5] 8941 - fileCount is now added in SOLR while indexing

---
 conf/solr/8.11.1/schema.xml                      |  2 ++
 .../iq/dataverse/search/IndexServiceBean.java    |  2 ++
 .../iq/dataverse/search/SearchFields.java        |  2 ++
 .../iq/dataverse/search/SearchServiceBean.java   |  2 ++
 .../iq/dataverse/search/SolrSearchResult.java    | 16 +++++++++++++++-
 5 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/conf/solr/8.11.1/schema.xml b/conf/solr/8.11.1/schema.xml
index ceff082f418..0203d1c690a 100644
--- a/conf/solr/8.11.1/schema.xml
+++ b/conf/solr/8.11.1/schema.xml
@@ -236,6 +236,8 @@
 
     <!-- incomplete datasets issue 8822 -->
     <field name="datasetValid" type="boolean" stored="true" indexed="true" multiValued="false"/>
+
+    <field name="fileCount" type="long" stored="true" indexed="true" multiValued="false"/>
     
     <!--
         METADATA SCHEMA FIELDS
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
index d6d0be7a17b..1f961f21ab1 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
@@ -880,6 +880,8 @@ public SolrInputDocuments toSolrDocs(IndexableDataset indexableDataset, Set<Long
             solrInputDocument.addField(SearchFields.DATASET_CITATION, datasetVersion.getCitation(false));
             solrInputDocument.addField(SearchFields.DATASET_CITATION_HTML, datasetVersion.getCitation(true));
 
+            solrInputDocument.addField(SearchFields.FILE_COUNT, datasetVersion.getFileMetadatas().size());
+
             if (datasetVersion.isInReview()) {
                 solrInputDocument.addField(SearchFields.PUBLICATION_STATUS, IN_REVIEW_STRING);
             }
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/SearchFields.java b/src/main/java/edu/harvard/iq/dataverse/search/SearchFields.java
index 8fb7c161517..bb591f3f9f5 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/SearchFields.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/SearchFields.java
@@ -276,4 +276,6 @@ more targeted results for just datasets. The format is YYYY (i.e.
 
     public static final String DATASET_VALID = "datasetValid";
 
+    public static final String FILE_COUNT = "fileCount";
+
 }
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/SearchServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/search/SearchServiceBean.java
index 5df8c58ff35..f5e69144373 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/SearchServiceBean.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/SearchServiceBean.java
@@ -414,6 +414,7 @@ public SolrQueryResponse search(
             String nameOfDataverse = (String) solrDocument.getFieldValue(SearchFields.DATAVERSE_NAME);
             Long embargoEndDate = (Long) solrDocument.getFieldValue(SearchFields.EMBARGO_END_DATE);
             Boolean datasetValid = (Boolean) solrDocument.getFieldValue(SearchFields.DATASET_VALID);
+            Long fileCount = (Long) solrDocument.getFieldValue(SearchFields.FILE_COUNT);
             
             List<String> matchedFields = new ArrayList<>();
             List<Highlight> highlights = new ArrayList<>();
@@ -479,6 +480,7 @@ public SolrQueryResponse search(
             solrSearchResult.setDeaccessionReason(deaccessionReason);
             solrSearchResult.setDvTree(dvTree);
             solrSearchResult.setDatasetValid(datasetValid);
+            solrSearchResult.setFileCount(fileCount);
 
             String originSource = (String) solrDocument.getFieldValue(SearchFields.METADATA_SOURCE);
             if (IndexServiceBean.HARVESTED.equals(originSource)) {
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java b/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
index 6ad7f9dbbf6..a16e8b00732 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
@@ -78,6 +78,12 @@ public class SolrSearchResult {
 	private String dataverseAffiliation;
 	private String citation;
 	private String citationHtml;
+
+	/**
+	 * Only Dataset can have a file count
+	 */
+	private Long fileCount;
+
 	/**
 	 * Files and datasets might have a UNF. Dataverses don't.
 	 */
@@ -571,7 +577,7 @@ public JsonObjectBuilder json(boolean showRelevance, boolean showEntityIds, bool
 					subjects.add(subject);
 				}
 				nullSafeJsonBuilder.add("subjects", subjects);
-				nullSafeJsonBuilder.add("fileCount", dv.getFileMetadatas().size());
+				nullSafeJsonBuilder.add("fileCount", this.fileCount);
 				nullSafeJsonBuilder.add("versionId", dv.getId());
 				nullSafeJsonBuilder.add("versionState", dv.getVersionState().toString());
 				if (this.isPublishedState()) {
@@ -1268,4 +1274,12 @@ public void setDatasetValid(Boolean datasetValid) {
 	public boolean isValid() {
 		return datasetValid;
     }
+
+	public Long getFileCount() {
+		return fileCount;
+	}
+
+	public void setFileCount(Long fileCount) {
+		this.fileCount = fileCount;
+	}
 }

From 7364816a729c2a4c007d66d7e3e59f4053dd5cd6 Mon Sep 17 00:00:00 2001
From: sferey <steven.ferey@smile.fr>
Date: Wed, 30 Aug 2023 16:42:21 +0200
Subject: [PATCH 2/5] Adaptation for SolR 9.3.0

---
 conf/solr/9.3.0/schema.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/conf/solr/9.3.0/schema.xml b/conf/solr/9.3.0/schema.xml
index b3e3d9b001d..7dd90a7aed2 100644
--- a/conf/solr/9.3.0/schema.xml
+++ b/conf/solr/9.3.0/schema.xml
@@ -230,7 +230,7 @@
     <!-- incomplete datasets issue 8822 -->
     <field name="datasetValid" type="boolean" stored="true" indexed="true" multiValued="false"/>
 
-    <field name="fileCount" type="long" stored="true" indexed="true" multiValued="false"/>
+    <field name="fileCount" type="plong" stored="true" indexed="true" multiValued="false"/>
     
     <!--
         METADATA SCHEMA FIELDS

From a0028c31e136ef3f7e6b64a5e6aee9ba66222de3 Mon Sep 17 00:00:00 2001
From: Ludovic DANIEL <ludovic.daniel@smile.fr>
Date: Thu, 30 May 2024 15:39:44 +0200
Subject: [PATCH 3/5] 8941 - rework after merging develop and handling
 conflicts

---
 .../edu/harvard/iq/dataverse/api/Search.java  | 11 +------
 .../iq/dataverse/search/IndexServiceBean.java |  5 +++-
 .../iq/dataverse/search/SolrSearchResult.java | 30 +++++++++----------
 3 files changed, 20 insertions(+), 26 deletions(-)

diff --git a/src/main/java/edu/harvard/iq/dataverse/api/Search.java b/src/main/java/edu/harvard/iq/dataverse/api/Search.java
index 6b9fcb38305..f86f9f446fa 100644
--- a/src/main/java/edu/harvard/iq/dataverse/api/Search.java
+++ b/src/main/java/edu/harvard/iq/dataverse/api/Search.java
@@ -175,7 +175,7 @@ public Response search(
             JsonArrayBuilder itemsArrayBuilder = Json.createArrayBuilder();
             List<SolrSearchResult> solrSearchResults = solrQueryResponse.getSolrSearchResults();
             for (SolrSearchResult solrSearchResult : solrSearchResults) {
-                itemsArrayBuilder.add(solrSearchResult.json(showRelevance, showEntityIds, showApiUrls, metadataFields, getDatasetFileCount(solrSearchResult)));
+                itemsArrayBuilder.add(solrSearchResult.json(showRelevance, showEntityIds, showApiUrls, metadataFields));
             }
 
             JsonObjectBuilder spelling_alternatives = Json.createObjectBuilder();
@@ -229,15 +229,6 @@ public Response search(
         }
     }
 
-    private Long getDatasetFileCount(SolrSearchResult solrSearchResult) {
-        DvObject dvObject = solrSearchResult.getEntity();
-        if (dvObject.isInstanceofDataset()) {
-            DatasetVersion datasetVersion = ((Dataset) dvObject).getVersionFromId(solrSearchResult.getDatasetVersionId());
-            return datasetVersionFilesServiceBean.getFileMetadataCount(datasetVersion);
-        }
-        return null;
-    }
-
     private User getUser(ContainerRequestContext crc) throws WrappedResponse {
         User userToExecuteSearchAs = GuestUser.get();
         try {
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
index af1305a3774..15bba02ad04 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/IndexServiceBean.java
@@ -127,6 +127,9 @@ public class IndexServiceBean {
     @EJB
     DatasetFieldServiceBean datasetFieldService;
 
+    @Inject
+    DatasetVersionFilesServiceBean datasetVersionFilesServiceBean;
+
     public static final String solrDocIdentifierDataverse = "dataverse_";
     public static final String solrDocIdentifierFile = "datafile_";
     public static final String solrDocIdentifierDataset = "dataset_";
@@ -905,7 +908,7 @@ public SolrInputDocuments toSolrDocs(IndexableDataset indexableDataset, Set<Long
             solrInputDocument.addField(SearchFields.DATASET_CITATION, datasetVersion.getCitation(false));
             solrInputDocument.addField(SearchFields.DATASET_CITATION_HTML, datasetVersion.getCitation(true));
 
-            solrInputDocument.addField(SearchFields.FILE_COUNT, datasetVersion.getFileMetadatas().size());
+            solrInputDocument.addField(SearchFields.FILE_COUNT, datasetVersionFilesServiceBean.getFileMetadataCount(datasetVersion));
 
             if (datasetVersion.isInReview()) {
                 solrInputDocument.addField(SearchFields.PUBLICATION_STATUS, IN_REVIEW_STRING);
diff --git a/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java b/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
index 4eb7a0f8d25..bbc8fee416c 100644
--- a/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
+++ b/src/main/java/edu/harvard/iq/dataverse/search/SolrSearchResult.java
@@ -443,10 +443,10 @@ public JsonObjectBuilder getJsonForMyData(boolean isValid) {
 	} // getJsonForMydata
 
 	public JsonObjectBuilder json(boolean showRelevance, boolean showEntityIds, boolean showApiUrls) {
-		return json(showRelevance, showEntityIds, showApiUrls, null, null);
+		return json(showRelevance, showEntityIds, showApiUrls, null);
 	}
 
-	public JsonObjectBuilder json(boolean showRelevance, boolean showEntityIds, boolean showApiUrls, List<String> metadataFields, Long datasetFileCount) {
+	public JsonObjectBuilder json(boolean showRelevance, boolean showEntityIds, boolean showApiUrls, List<String> metadataFields) {
 		if (this.type == null) {
 			return jsonObjectBuilder();
 		}
@@ -1265,20 +1265,20 @@ public void setDatasetValid(Boolean datasetValid) {
 	}
 
 	public boolean isValid(Predicate<SolrSearchResult> canUpdateDataset) {
-        if (this.datasetValid) {
-            return true;
-        }
-        if (!this.getType().equals("datasets")) {
-            return true;
-        }
-        if (this.isDraftState()) {
-            return false;
-        }
-        if (!JvmSettings.UI_SHOW_VALIDITY_LABEL_WHEN_PUBLISHED.lookupOptional(Boolean.class).orElse(true)) {
-            return true;
-        }
+		if (this.datasetValid) {
+			return true;
+		}
+		if (!this.getType().equals("datasets")) {
+			return true;
+		}
+		if (this.isDraftState()) {
+			return false;
+		}
+		if (!JvmSettings.UI_SHOW_VALIDITY_LABEL_WHEN_PUBLISHED.lookupOptional(Boolean.class).orElse(true)) {
+			return true;
+		}
 		return !canUpdateDataset.test(this);
-    }
+	}
 	public Long getFileCount() {
 		return fileCount;
 	}

From c349748ec39ac05764ca7d6cb66df7b671141e45 Mon Sep 17 00:00:00 2001
From: Ludovic DANIEL <ludovic.daniel@smile.fr>
Date: Thu, 30 May 2024 16:38:10 +0200
Subject: [PATCH 4/5] update index unit tests

---
 .../edu/harvard/iq/dataverse/search/IndexServiceBeanTest.java    | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/test/java/edu/harvard/iq/dataverse/search/IndexServiceBeanTest.java b/src/test/java/edu/harvard/iq/dataverse/search/IndexServiceBeanTest.java
index 92b06e5936f..4f6f0f0016e 100644
--- a/src/test/java/edu/harvard/iq/dataverse/search/IndexServiceBeanTest.java
+++ b/src/test/java/edu/harvard/iq/dataverse/search/IndexServiceBeanTest.java
@@ -51,6 +51,7 @@ public void setUp() {
         indexService.settingsService = Mockito.mock(SettingsServiceBean.class);
         indexService.dataverseService = Mockito.mock(DataverseServiceBean.class);
         indexService.datasetFieldService = Mockito.mock(DatasetFieldServiceBean.class);
+        indexService.datasetVersionFilesServiceBean = Mockito.mock(DatasetVersionFilesServiceBean.class);
         BrandingUtil.injectServices(indexService.dataverseService, indexService.settingsService);
 
         Mockito.when(indexService.dataverseService.findRootDataverse()).thenReturn(dataverse);

From 42d50298522c2b79369c19ec2d87d98cc54ac547 Mon Sep 17 00:00:00 2001
From: Ludovic DANIEL <ludovic.daniel@smile.fr>
Date: Wed, 5 Jun 2024 14:50:51 +0200
Subject: [PATCH 5/5] added release note

---
 .../8941-adding-fileCount-in-solr.md              | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 doc/release-notes/8941-adding-fileCount-in-solr.md

diff --git a/doc/release-notes/8941-adding-fileCount-in-solr.md b/doc/release-notes/8941-adding-fileCount-in-solr.md
new file mode 100644
index 00000000000..164b91e6123
--- /dev/null
+++ b/doc/release-notes/8941-adding-fileCount-in-solr.md
@@ -0,0 +1,15 @@
+## Release Highlights
+
+### Adding fileCount as SOLR field
+
+A new search field called `fileCount` can be searched to discover the number of files per dataset. (#10598)
+
+## Upgrade Instructions
+
+1. Update your Solr `schema.xml` to include the new field.
+For details, please see https://guides.dataverse.org/en/latest/admin/metadatacustomization.html#updating-the-solr-schema
+
+2. Reindex Solr.
+Once the schema.xml is updated, Solr must be restarted and a reindex initiated.
+For details, see https://guides.dataverse.org/en/latest/admin/solr-search-index.html but here is the reindex command:
+`curl http://localhost:8080/api/admin/index`