Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TermvectorsResponse fix for optionals. #642

Merged
merged 7 commits into from
Oct 9, 2023
Merged

TermvectorsResponse fix for optionals. #642

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
08297be
TermvectorsResponse fix for optionals.
MikePieperSer Sep 27, 2023
06a0685
Add Changelog.
MikePieperSer Sep 27, 2023
aa5e13f
Tabs vs. spaces fix.
MikePieperSer Sep 29, 2023
ecded52
Version is not optional.
MikePieperSer Sep 29, 2023
e2e8386
Merge remote-tracking branch 'upstream/main' into termvectorsresponse…
MikePieperSer Oct 4, 2023
37d02d8
Changelog fix.
MikePieperSer Oct 5, 2023
ffb3c55
Period removed.
MikePieperSer Oct 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed
- Fix version and build ([#254](https://github.com/opensearch-project/opensearch-java/pull/254))
- Fix PutMappingRequest by removing unsupported fields ([#597](https://github.com/opensearch-project/opensearch-java/pull/597))

- [BUG] Fix TermvectorsResponse for optional fields. ([#642](https://github.com/opensearch-project/opensearch-java/pull/642))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make this look like the other lines. Say Fix ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

### Security

## [Unreleased 2.x]
Expand Down
10 changes: 6 additions & 4 deletions java-client/src/main/java/org/opensearch/client/opensearch/core/TermvectorsResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public class TermvectorsResponse implements JsonpSerializable {

private final long took;

private final long version;
private final Long version;

// ---------------------------------------------------------------------------------------------

Expand All @@ -73,7 +73,7 @@ private TermvectorsResponse(Builder builder) {
this.index = ApiTypeHelper.requireNonNull(builder.index, this, "index");
this.termVectors = ApiTypeHelper.unmodifiable(builder.termVectors);
this.took = ApiTypeHelper.requireNonNull(builder.took, this, "took");
this.version = ApiTypeHelper.requireNonNull(builder.version, this, "version");
this.version = builder.version;

}

Expand Down Expand Up @@ -157,8 +157,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
generator.writeKey("took");
generator.write(this.took);

generator.writeKey("_version");
generator.write(this.version);
if (null != this.version) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tabs vs. spaces looks suspicious here. Also surprised spotless didn't catch it, mind checking please?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this optional? Maybe add a test?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have right. According to the server sources https://github.com/opensearch-project/OpenSearch/blob/7dc6683838951e1a211c6ff634d9eea93e2be3c2/server/src/main/java/org/opensearch/action/termvectors/TermVectorsResponse.java#L205 _version is still delivered.

generator.writeKey("_version");
generator.write(this.version);
}

}

Expand Down
20 changes: 11 additions & 9 deletions java-client/src/main/java/org/opensearch/client/opensearch/core/termvectors/Term.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@

package org.opensearch.client.opensearch.core.termvectors;

import jakarta.json.stream.JsonGenerator;
import java.util.List;
import java.util.function.Function;
import javax.annotation.Nullable;
import org.opensearch.client.json.JsonpDeserializable;
import org.opensearch.client.json.JsonpDeserializer;
import org.opensearch.client.json.JsonpMapper;
Expand All @@ -41,10 +45,6 @@
import org.opensearch.client.util.ApiTypeHelper;
import org.opensearch.client.util.ObjectBuilder;
import org.opensearch.client.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.util.List;
import java.util.function.Function;
import javax.annotation.Nullable;

// typedef: _global.termvectors.Term

Expand All @@ -57,7 +57,7 @@ public class Term implements JsonpSerializable {
@Nullable
private final Double score;

private final int termFreq;
private final Integer termFreq;

private final List<Token> tokens;

Expand All @@ -70,8 +70,8 @@ private Term(Builder builder) {

this.docFreq = builder.docFreq;
this.score = builder.score;
this.termFreq = ApiTypeHelper.requireNonNull(builder.termFreq, this, "termFreq");
this.tokens = ApiTypeHelper.unmodifiableRequired(builder.tokens, this, "tokens");
this.termFreq = builder.termFreq;
this.tokens = ApiTypeHelper.unmodifiable(builder.tokens);
this.ttf = builder.ttf;

}
Expand Down Expand Up @@ -139,8 +139,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
generator.write(this.score);

}
generator.writeKey("term_freq");
generator.write(this.termFreq);
if (null != this.termFreq) {
generator.writeKey("term_freq");
generator.write(this.termFreq);
}

if (ApiTypeHelper.isDefined(this.tokens)) {
generator.writeKey("tokens");
Expand Down
8 changes: 5 additions & 3 deletions java-client/src/main/java/org/opensearch/client/opensearch/core/termvectors/TermVector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public class TermVector implements JsonpSerializable {

private TermVector(Builder builder) {

this.fieldStatistics = ApiTypeHelper.requireNonNull(builder.fieldStatistics, this, "fieldStatistics");
this.fieldStatistics = builder.fieldStatistics;
this.terms = ApiTypeHelper.unmodifiableRequired(builder.terms, this, "terms");

}
Expand Down Expand Up @@ -92,8 +92,10 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {

protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {

generator.writeKey("field_statistics");
this.fieldStatistics.serialize(generator, mapper);
if (null != this.fieldStatistics) {
generator.writeKey("field_statistics");
this.fieldStatistics.serialize(generator, mapper);
}

if (ApiTypeHelper.isDefined(this.terms)) {
generator.writeKey("terms");
Expand Down
26 changes: 25 additions & 1 deletion java-client/src/test/java/org/opensearch/client/opensearch/experiments/ParsingTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@
package org.opensearch.client.opensearch.experiments;

import java.util.List;

import org.junit.Test;
import org.opensearch.client.opensearch._types.Time;
import org.opensearch.client.opensearch._types.analysis.Analyzer;
import org.opensearch.client.opensearch._types.analysis.TokenFilterDefinition;
import org.opensearch.client.opensearch._types.analysis.TokenizerBuilders;
import org.opensearch.client.opensearch._types.analysis.TokenizerDefinition;
import org.opensearch.client.opensearch.core.TermvectorsResponse;
import org.opensearch.client.opensearch.experiments.api.FooRequest;
import org.opensearch.client.opensearch.indices.IndexSettings;
import org.opensearch.client.opensearch.indices.IndexSettingsMapping;
Expand Down Expand Up @@ -173,4 +173,28 @@ public void testCjk_Analyzer() {
assertEquals(analyzer.cjk().stopwords(), analyzer2.cjk().stopwords());
assertEquals(analyzer.cjk().stopwordsPath(), analyzer2.cjk().stopwordsPath());
}
@Test
public void testTermvectorsResponseOptionals() {
// Build a response without any optionals
final TermvectorsResponse response = TermvectorsResponse.of(b -> b
.index("index")
.id("id")
.found(true)
.took(0)
.termVectors("key1", tvb -> tvb
.terms("term1", tb -> tb
.score(0.3)
)
)
);

String str = toJson(response);
assertEquals("{\"found\":true,\"_id\":\"id\",\"_index\":\"index\","
+"\"term_vectors\":{\"key1\":{\"terms\":{\"term1\":{\"score\":0.3}}}},\"took\":0}", str);

final TermvectorsResponse response2 = fromJson(str, TermvectorsResponse._DESERIALIZER);
assertEquals(response.index(), response2.index());
}


}
Loading