Skip to content

[DE-970] fix Arangosearch PrimarySort serialization #594

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.

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

Merged
merged 1 commit into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@

package com.arangodb.entity.arangosearch;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* @author Heiko Kernbach
*/
Expand All @@ -28,6 +31,14 @@ public final class PrimarySort {
private final String fieldName;
private Boolean ascending;

public PrimarySort(
@JsonProperty("field") String field,
@JsonProperty("asc") Boolean asc
) {
this.fieldName = field;
this.ascending = asc;
}

private PrimarySort(final String fieldName) {
super();
this.fieldName = fieldName;
Expand All @@ -46,11 +57,33 @@ public PrimarySort ascending(final Boolean ascending) {
return this;
}

@JsonIgnore
public Boolean getAscending() {
return ascending;
}

public Direction getDirection() {
if (ascending == null) {
return null;
}
return ascending ? Direction.asc : Direction.desc;
}

/**
* @deprecated for removal, use {@link #getField()} instead
*/
@Deprecated
@JsonIgnore
public String getFieldName() {
return getField();
}

public String getField() {
return fieldName;
}

public enum Direction {
asc,
desc
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.arangodb.entity.ViewType;
import com.arangodb.entity.arangosearch.*;
import com.arangodb.internal.serde.InternalSerializers;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.util.Arrays;
Expand Down Expand Up @@ -217,7 +218,16 @@ public Collection<CollectionLink> getLinks() {
return links;
}

/**
* @deprecated for removal, use {@link #getPrimarySort()} instead
*/
@Deprecated
@JsonIgnore
public Collection<PrimarySort> getPrimarySorts() {
return getPrimarySort();
}

public Collection<PrimarySort> getPrimarySort() {
return primarySorts;
}

Expand Down
11 changes: 9 additions & 2 deletions test-functional/src/test/java/com/arangodb/ArangoSearchTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ void createArangoSearchViewWithPrimarySort(ArangoDatabase db) {
final ArangoSearchCreateOptions options = new ArangoSearchCreateOptions();

final PrimarySort primarySort = PrimarySort.on("myFieldName");
primarySort.ascending(true);
primarySort.ascending(false);
options.primarySort(primarySort);
options.primarySortCompression(ArangoSearchCompression.none);
options.consolidationIntervalMsec(666666L);
Expand All @@ -179,6 +179,13 @@ void createArangoSearchViewWithPrimarySort(ArangoDatabase db) {
assertThat(retrievedStoredValue).isNotNull();
assertThat(retrievedStoredValue.getFields()).isEqualTo(storedValue.getFields());
assertThat(retrievedStoredValue.getCompression()).isEqualTo(storedValue.getCompression());
assertThat(properties.getPrimarySort())
.hasSize(1)
.allSatisfy(ps -> {
assertThat(ps).isNotNull();
assertThat(ps.getField()).isEqualTo(primarySort.getField());
assertThat(ps.getAscending()).isEqualTo(primarySort.getAscending());
});
}
}

Expand Down Expand Up @@ -739,7 +746,7 @@ void arangoSearchOptions(ArangoDatabase db) {
}

if (isEnterprise() && isAtLeastVersion(3, 12)) {
assertThat(properties.getOptimizeTopK()).containsExactly(optimizeTopK);
assertThat(properties.getOptimizeTopK()).containsExactly(optimizeTopK);
}

}
Expand Down