From 78bc7e8c64c6145276f7ad4ed0f522c7a853131a Mon Sep 17 00:00:00 2001 From: zhichao-aws Date: Fri, 17 Nov 2023 10:57:07 +0800 Subject: [PATCH] [Backport main manually][bug fix] Fix async actions are left in neural_sparse query (#438) (#479) * [bug fix] Fix async actions are left in neural_sparse query (#438) * add serialization and deserialization Signed-off-by: zhichao-aws * hash, equals. + UT Signed-off-by: zhichao-aws * tidy Signed-off-by: zhichao-aws * add test Signed-off-by: zhichao-aws --------- Signed-off-by: zhichao-aws (cherry picked from commit 51e6c00770d27fb4eabc20c38bdeff23c5c45997) * rm max_token_score Signed-off-by: zhichao-aws * add changelog Signed-off-by: zhichao-aws * tidy Signed-off-by: zhichao-aws --------- Signed-off-by: zhichao-aws Signed-off-by: Gopala-Krishna.Char --- CHANGELOG.md | 1 + .../query/NeuralSparseQueryBuilder.java | 24 ++++++++++- .../query/NeuralSparseQueryBuilderTests.java | 42 +++++++++++++++++++ 3 files changed, 65 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b92edd850..d5cba89c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Features ### Enhancements ### Bug Fixes +Fix async actions are left in neural_sparse query ([438](https://github.com/opensearch-project/neural-search/pull/438)) ### Infrastructure ### Documentation ### Maintenance diff --git a/src/main/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilder.java b/src/main/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilder.java index 3e181c73f..86859a054 100644 --- a/src/main/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilder.java +++ b/src/main/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilder.java @@ -9,6 +9,7 @@ import java.util.List; import java.util.Locale; import java.util.Map; +import java.util.Objects; import java.util.function.Supplier; import lombok.AllArgsConstructor; @@ -84,6 +85,10 @@ public NeuralSparseQueryBuilder(StreamInput in) throws IOException { this.fieldName = in.readString(); this.queryText = in.readString(); this.modelId = in.readString(); + if (in.readBoolean()) { + Map queryTokens = in.readMap(StreamInput::readString, StreamInput::readFloat); + this.queryTokensSupplier = () -> queryTokens; + } } @Override @@ -91,6 +96,12 @@ protected void doWriteTo(StreamOutput out) throws IOException { out.writeString(fieldName); out.writeString(queryText); out.writeString(modelId); + if (!Objects.isNull(queryTokensSupplier) && !Objects.isNull(queryTokensSupplier.get())) { + out.writeBoolean(true); + out.writeMap(queryTokensSupplier.get(), StreamOutput::writeString, StreamOutput::writeFloat); + } else { + out.writeBoolean(false); + } } @Override @@ -256,16 +267,25 @@ private static void validateQueryTokens(Map queryTokens) { @Override protected boolean doEquals(NeuralSparseQueryBuilder obj) { if (this == obj) return true; - if (obj == null || getClass() != obj.getClass()) return false; + if (Objects.isNull(obj) || getClass() != obj.getClass()) return false; + if (Objects.isNull(queryTokensSupplier) && !Objects.isNull(obj.queryTokensSupplier)) return false; + if (!Objects.isNull(queryTokensSupplier) && Objects.isNull(obj.queryTokensSupplier)) return false; EqualsBuilder equalsBuilder = new EqualsBuilder().append(fieldName, obj.fieldName) .append(queryText, obj.queryText) .append(modelId, obj.modelId); + if (!Objects.isNull(queryTokensSupplier)) { + equalsBuilder.append(queryTokensSupplier.get(), obj.queryTokensSupplier.get()); + } return equalsBuilder.isEquals(); } @Override protected int doHashCode() { - return new HashCodeBuilder().append(fieldName).append(queryText).append(modelId).toHashCode(); + HashCodeBuilder builder = new HashCodeBuilder().append(fieldName).append(queryText).append(modelId); + if (!Objects.isNull(queryTokensSupplier)) { + builder.append(queryTokensSupplier.get()); + } + return builder.toHashCode(); } @Override diff --git a/src/test/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilderTests.java b/src/test/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilderTests.java index 7ff6ca0cb..f3fa3264d 100644 --- a/src/test/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilderTests.java +++ b/src/test/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilderTests.java @@ -26,6 +26,7 @@ import lombok.SneakyThrows; import org.opensearch.client.Client; +import org.opensearch.common.SetOnce; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.common.xcontent.XContentFactory; import org.opensearch.core.action.ActionListener; @@ -262,6 +263,23 @@ public void testStreams() { NeuralSparseQueryBuilder copy = new NeuralSparseQueryBuilder(filterStreamInput); assertEquals(original, copy); + + SetOnce> queryTokensSetOnce = new SetOnce<>(); + queryTokensSetOnce.set(Map.of("hello", 1.0f, "world", 2.0f)); + original.queryTokensSupplier(queryTokensSetOnce::get); + + BytesStreamOutput streamOutput2 = new BytesStreamOutput(); + original.writeTo(streamOutput2); + + filterStreamInput = new NamedWriteableAwareStreamInput( + streamOutput2.bytes().streamInput(), + new NamedWriteableRegistry( + List.of(new NamedWriteableRegistry.Entry(QueryBuilder.class, MatchAllQueryBuilder.NAME, MatchAllQueryBuilder::new)) + ) + ); + + copy = new NeuralSparseQueryBuilder(filterStreamInput); + assertEquals(original, copy); } public void testHashAndEquals() { @@ -275,6 +293,8 @@ public void testHashAndEquals() { float boost2 = 3.8f; String queryName1 = "query-1"; String queryName2 = "query-2"; + Map queryTokens1 = Map.of("hello", 1.0f, "world", 2.0f); + Map queryTokens2 = Map.of("hello", 1.0f, "world", 2.2f); NeuralSparseQueryBuilder sparseEncodingQueryBuilder_baseline = new NeuralSparseQueryBuilder().fieldName(fieldName1) .queryText(queryText1) @@ -329,6 +349,22 @@ public void testHashAndEquals() { .boost(boost1) .queryName(queryName2); + // Identical to sparseEncodingQueryBuilder_baseline except non-null query tokens supplier + NeuralSparseQueryBuilder sparseEncodingQueryBuilder_nonNullQueryTokens = new NeuralSparseQueryBuilder().fieldName(fieldName1) + .queryText(queryText1) + .modelId(modelId1) + .boost(boost1) + .queryName(queryName1) + .queryTokensSupplier(() -> queryTokens1); + + // Identical to sparseEncodingQueryBuilder_baseline except non-null query tokens supplier + NeuralSparseQueryBuilder sparseEncodingQueryBuilder_diffQueryTokens = new NeuralSparseQueryBuilder().fieldName(fieldName1) + .queryText(queryText1) + .modelId(modelId1) + .boost(boost1) + .queryName(queryName1) + .queryTokensSupplier(() -> queryTokens2); + assertEquals(sparseEncodingQueryBuilder_baseline, sparseEncodingQueryBuilder_baseline); assertEquals(sparseEncodingQueryBuilder_baseline.hashCode(), sparseEncodingQueryBuilder_baseline.hashCode()); @@ -352,6 +388,12 @@ public void testHashAndEquals() { assertNotEquals(sparseEncodingQueryBuilder_baseline, sparseEncodingQueryBuilder_diffQueryName); assertNotEquals(sparseEncodingQueryBuilder_baseline.hashCode(), sparseEncodingQueryBuilder_diffQueryName.hashCode()); + + assertNotEquals(sparseEncodingQueryBuilder_baseline, sparseEncodingQueryBuilder_nonNullQueryTokens); + assertNotEquals(sparseEncodingQueryBuilder_baseline.hashCode(), sparseEncodingQueryBuilder_nonNullQueryTokens.hashCode()); + + assertNotEquals(sparseEncodingQueryBuilder_nonNullQueryTokens, sparseEncodingQueryBuilder_diffQueryTokens); + assertNotEquals(sparseEncodingQueryBuilder_nonNullQueryTokens.hashCode(), sparseEncodingQueryBuilder_diffQueryTokens.hashCode()); } @SneakyThrows