Add backwards-compatible serialization for filtration #840
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Can we call this |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| package com.meilisearch.sdk.json; | ||
|
|
||
| import com.google.gson.*; | ||
| import com.meilisearch.sdk.model.FilterableAttribute; | ||
| import java.lang.reflect.Type; | ||
| import java.util.*; | ||
|
|
||
| /** JSON serializer/deserializer for {@link FilterableAttribute} objects. */ | ||
| public class GsonFilterableAttributeSerializer | ||
| implements JsonSerializer<FilterableAttribute>, JsonDeserializer<FilterableAttribute> { | ||
|
|
||
| @Override | ||
| public JsonElement serialize( | ||
| FilterableAttribute attributes, | ||
| Type type, | ||
| JsonSerializationContext jsonSerializationContext) { | ||
| // when possible, limit size of data sent by using legacy string format | ||
| return (canBeString(attributes)) | ||
| ? new JsonPrimitive(attributes.getPatterns()[0]) | ||
| : serializeAttribute(attributes); | ||
| } | ||
|
|
||
| private boolean canBeString(FilterableAttribute attribute) { | ||
| if (attribute == null) return false; | ||
| Map<String, Boolean> filters = attribute.getFilter(); | ||
| if (filters == null) filters = new HashMap<>(); | ||
|
|
||
| boolean equalityAllowed = !filters.containsKey("equality") || filters.get("equality"); | ||
| boolean comparisonAllowed = filters.getOrDefault("comparison", false); | ||
|
|
||
| return attribute.getPatterns() != null | ||
| && attribute.getPatterns().length == 1 | ||
| && (attribute.getFacetSearch() == null || !attribute.getFacetSearch()) | ||
| && equalityAllowed | ||
| && !comparisonAllowed; | ||
| } | ||
|
|
||
| private JsonElement serializeAttribute(FilterableAttribute attribute) { | ||
| if (attribute == null) return null; | ||
| List<Exception> exceptions = new ArrayList<>(); | ||
| JsonArray patternArray = new JsonArray(); | ||
| if (attribute.getPatterns() != null && attribute.getPatterns().length > 0) | ||
| try { | ||
| // Collect values from POJO | ||
| patternArray = | ||
| Arrays.stream(attribute.getPatterns()) | ||
| .map(JsonPrimitive::new) | ||
| .collect(JsonArray::new, JsonArray::add, JsonArray::addAll); | ||
| } catch (Exception e) { | ||
| exceptions.add(e); | ||
| } | ||
| else exceptions.add(new JsonParseException("Patterns to filter for were not specified!")); | ||
|
|
||
| JsonObject filters = new JsonObject(); | ||
| if (attribute.getFilter() != null) { | ||
| try { | ||
| filters = | ||
| attribute.getFilter().entrySet().stream() | ||
| .collect( | ||
| JsonObject::new, | ||
| (jsonObject, kv) -> | ||
| jsonObject.addProperty(kv.getKey(), kv.getValue()), | ||
| this::combineJsonObjects); | ||
| } catch (Exception e) { | ||
| exceptions.add(e); | ||
| } | ||
| } else { | ||
| filters.addProperty("comparison", false); | ||
| filters.addProperty("equality", true); | ||
| } | ||
|
|
||
| if (!exceptions.isEmpty()) { | ||
| throw new JsonParseException(String.join("\n", Arrays.toString(exceptions.toArray()))); | ||
| } | ||
|
|
||
| // Create JSON object | ||
| JsonObject jsonObject = new JsonObject(); | ||
| JsonObject features = new JsonObject(); | ||
| if (attribute.getFacetSearch() != null) | ||
| features.addProperty("facetSearch", attribute.getFacetSearch()); | ||
| else features.addProperty("facetSearch", false); | ||
| features.add("filter", filters); | ||
| jsonObject.add("attributePatterns", patternArray); | ||
| jsonObject.add("features", features); | ||
| return jsonObject; | ||
| } | ||
|
|
||
| private void combineJsonObjects(JsonObject a, JsonObject b) { | ||
| for (Map.Entry<String, JsonElement> kv : b.entrySet()) a.add(kv.getKey(), kv.getValue()); | ||
| } | ||
|
|
||
| @Override | ||
| public FilterableAttribute deserialize( | ||
| JsonElement jsonElement, | ||
| Type type, | ||
| JsonDeserializationContext jsonDeserializationContext) | ||
| throws JsonParseException { | ||
| try { | ||
| // legacy check | ||
| if (jsonElement.isJsonPrimitive() && jsonElement.getAsJsonPrimitive().isString()) | ||
| return new FilterableAttribute(jsonElement.getAsString()); | ||
|
|
||
| JsonObject object = jsonElement.getAsJsonObject(); | ||
| JsonObject features = | ||
| object.has("features") ? object.getAsJsonObject("features") : null; | ||
| // default values for instance lacking `features` | ||
| boolean facetSearch = false; | ||
| Map<String, Boolean> filters = new HashMap<>(); | ||
| filters.put("equality", true); | ||
| filters.put("comparison", false); | ||
|
|
||
| List<Exception> exceptions = new ArrayList<>(); | ||
| // pull values from features. | ||
| if (features != null && features.has("facetSearch")) { | ||
| try { | ||
| JsonPrimitive facetSearchPrimitive = features.getAsJsonPrimitive("facetSearch"); | ||
| facetSearch = | ||
| facetSearchPrimitive != null && facetSearchPrimitive.getAsBoolean(); | ||
| } catch (ClassCastException | IllegalStateException e) { | ||
| exceptions.add(e); | ||
| } | ||
| } | ||
| if (features != null && features.has("filter")) | ||
| try { | ||
| filters = | ||
| features.getAsJsonObject("filter").entrySet().stream() | ||
| .collect( | ||
| HashMap::new, | ||
| (m, kv) -> | ||
| m.put( | ||
| kv.getKey(), | ||
| kv.getValue().getAsBoolean()), | ||
| HashMap::putAll); | ||
| } catch (ClassCastException | IllegalStateException e) { | ||
| exceptions.add(e); | ||
| } | ||
| String[] patterns = new String[0]; | ||
| try { | ||
| patterns = | ||
| object.has("attributePatterns") | ||
| ? object.getAsJsonArray("attributePatterns").asList().stream() | ||
| .map(JsonElement::getAsString) | ||
| .toArray(String[]::new) | ||
| : new String[0]; | ||
| } catch (ClassCastException | IllegalStateException e) { | ||
| exceptions.add(e); | ||
| } | ||
|
|
||
| if (!exceptions.isEmpty()) | ||
| throw new JsonParseException( | ||
| String.join("\n", Arrays.toString(exceptions.toArray()))); | ||
|
|
||
| if (filters.entrySet().stream().noneMatch(Map.Entry::getValue)) | ||
| exceptions.add( | ||
| new JsonParseException( | ||
| "No filtration methods were allowed! Must have at least one type <comparison, equality> allowed.\n" | ||
| + Arrays.toString(filters.entrySet().toArray()))); | ||
| if (patterns.length == 0) | ||
| exceptions.add( | ||
| new JsonParseException( | ||
| "Patterns to filter for were not specified! Invalid Attribute.")); | ||
|
|
||
| if (!exceptions.isEmpty()) | ||
| throw new JsonParseException( | ||
| String.join("\n", Arrays.toString(exceptions.toArray()))); | ||
|
|
||
| return new FilterableAttribute(patterns, facetSearch, filters); | ||
| } catch (Exception e) { | ||
| throw new JsonParseException("Failed to deserialize FilterableAttribute", e); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix variable name typo in code sample.
The map is declared as
filtersTypesbut the third argument passesfilters, which doesn’t exist and will cause a compilation error. It should usefiltersTypes. Consider also renaming the variable tofilterTypesfor clarity.Apply this diff:
📝 Committable suggestion
🤖 Prompt for AI Agents
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you apply this change as the @coderabbitai suggested?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brunoocasali I'll apply the suggested fix for the compilation error in the code sample.
Task: Fix compilation error in filterable attributes code sample
filtersreference to use the correct variable name⏳ Preparing changes...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A summary of the edits CodeRabbit can apply:
A plan of each step that CodeRabbit will take in order to execute the edits for each file (with inline rough draft snippets):
✏️ .code-samples.meilisearch.yaml
Replace the variable declaration on line 230 from
Map<String, Boolean> filtersTypes = new HashMap<>();toMap<String, Boolean> filterTypes = new HashMap<>();to improve naming clarity by removing the redundant 's' and making it more readable.Update line 231 to use the new variable name by changing
filtersTypes.put("comparison",true);tofilterTypes.put("comparison", true);- also adding proper spacing around the comma for consistency.Update line 232 to use the new variable name by changing
filtersTypes.put("equality",true);tofilterTypes.put("equality", true);- also adding proper spacing around the comma for consistency.Fix the compilation error on line 233 by replacing the undefined variable
filterswith the correct variable namefilterTypes. Change the constructor call fromnew FilterableAttribute(new String[]{"director"}, true, filters)tonew FilterableAttribute(new String[]{"director"}, true, filterTypes).A summary of the context that CodeRabbit is considering across the codebase: