Merge pull request #65 from icatproject/v4.0.0

Bump version to 4.0.0-SNAPSHOT, write 4.0.0 release-notes

Author: patrick-austin

pom.xml

@@ -3,7 +3,7 @@
 
 	<groupId>org.icatproject</groupId>
 	<artifactId>icat.lucene</artifactId>
-	<version>3.0.1-SNAPSHOT</version>
+	<version>4.0.0-SNAPSHOT</version>
 	<packaging>war</packaging>
 	<name>ICAT Lucene</name>
 
@@ -114,7 +114,7 @@
 		<dependency>
 			<groupId>org.icatproject</groupId>
 			<artifactId>icat.utils</artifactId>
-			<version>4.17.0</version>
+			<version>4.17.1</version>
 		</dependency>
 
 		<dependency>

src/main/java/org/icatproject/lucene/Lucene.java

@@ -1179,6 +1179,7 @@ public void lock(@PathParam("entityName") String entityName, @QueryParam("minId"
 				IndexSearcher searcher = shardBucket.searcherManager.acquire();
 				try {
 					Query query;
+					Sort sort = new Sort(new SortedNumericSortField("id", Type.LONG, true));
 					if (minId == null && maxId == null) {
 						query = new MatchAllDocsQuery();
 					} else {
@@ -1190,7 +1191,7 @@ public void lock(@PathParam("entityName") String entityName, @QueryParam("minId"
 						}
 						query = LongPoint.newRangeQuery("id", minId + 1, maxId);
 					}
-					TopDocs topDoc = searcher.search(query, 1);
+					TopDocs topDoc = searcher.search(query, 1, sort);
 					if (topDoc.scoreDocs.length != 0) {
 						// If we have any results in the populating range, unlock and throw
 						bucket.locked.compareAndSet(true, false);
@@ -1627,7 +1628,7 @@ private void encodeSearchAfterField(JsonGenerator gen, SortField sortField, Scor
 	 * @param json Key value pairs of fields.
 	 * @return Lucene Document.
 	 */
-	private Document parseDocument(JsonObject json) {
+	public Document parseDocument(JsonObject json) {
 		Document document = new Document();
 		for (String key : json.keySet()) {
 			Field field = new Field(json, key, key, facetFields);

src/site/xhtml/release-notes.xhtml

@@ -6,6 +6,17 @@
 
 	<h1>ICAT Lucene Server Release Notes</h1>
 
+	<h2>4.0.0</h2>
+	<p>In addition to the bugfixes, the change to how the location field is parsed will require a re-index to ensure that searches using the new syntax match historic Documents.</p>
+	<ul>
+		<li>Bugfix: handle an unexpectedly closed IndexWriter</li>
+		<li>Bugfix: use RAFDirectory and AsynchronousFileChannel for locks</li>
+		<li>Bugfix: use IcatSynonymAnalyzer to write Documents</li>
+		<li>Feature: expand location into location, location.exact, location.fileName</li>
+		<li>Feature: sort by ICAT id to return highest id when failing to lock index</li>
+		<li>Feature: allow automatic commits to be disabled by config</li>
+	</ul>
+
 	<h2>3.0.0</h2>
 	<p>Significant changes to the functionality and performance of searches:</p>
 	<ul>

src/test/java/icat/lucene/TestLucene.java

@@ -35,6 +35,7 @@
 import org.apache.lucene.index.IndexWriter;
 import org.apache.lucene.index.IndexWriterConfig;
 import org.apache.lucene.index.IndexWriterConfig.OpenMode;
+import org.apache.lucene.index.IndexableField;
 import org.apache.lucene.index.Term;
 import org.apache.lucene.queryparser.flexible.core.QueryNodeException;
 import org.apache.lucene.queryparser.flexible.standard.StandardQueryParser;
@@ -60,7 +61,7 @@
 import org.icatproject.lucene.analyzers.IcatAnalyzer;
 import org.icatproject.lucene.analyzers.IcatSynonymAnalyzer;
 import org.icatproject.lucene.exceptions.LuceneException;
-import org.junit.Ignore;
+import org.icatproject.utils.IcatUnits;
 import org.junit.Test;
 
 import jakarta.json.Json;
@@ -410,6 +411,24 @@ public void testLocationFields() throws IOException, QueryNodeException {
 		checkHits(datafileSearcher, DocumentMapping.datafileParser, "+\"/dls/i00/data/2000\" +screen* +(AB00 DE00) +txt", 2L);
 	}
 
+	@Test
+	public void testParseDocument() {
+		// Ensure that we encode units correctly when SI conversion fails
+		Lucene lucene = new Lucene();
+		lucene.icatUnits = new IcatUnits();
+		JsonObjectBuilder builder = Json.createObjectBuilder();
+		builder.add("type.units", "N/A");
+		builder.add("numericValue", 1.);
+		Document document = lucene.parseDocument(builder.build());
+		assertEquals(4, document.getFields().size());
+		assertEquals("N/A", document.getField("type.units").stringValue());
+		// Unlike strings, numbers are represented by different fields for different purposes
+		IndexableField[] fields = document.getFields("numericValue");
+		assertEquals(4607182418800017408L, fields[0].numericValue().longValue());  // For faceting, the double value is encoded as a long
+		assertEquals(1., fields[1].numericValue().doubleValue(), 0);  // For querying, encoded as double
+		assertEquals(1., fields[2].numericValue().doubleValue(), 0);  // Stored value for returning documents, encoded as a double
+	}
+
 	private void checkHits(IndexSearcher searcher, StandardQueryParser parser, String queryString, long expected) throws QueryNodeException, IOException {
 		queryString = SearchBucket.escapePath(queryString);
 		Query query = parser.parse(queryString, null);