Fix Jackson serialization of granular filterable attributes#985
Fix Jackson serialization of granular filterable attributes#985Moustafa-Ameen wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthrough
ChangesGranular filterable attributes
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/main/java/com/meilisearch/sdk/model/Settings.java`:
- Around line 64-65: Remove the `@JsonIgnore` from the String[] overload
`Settings.setFilterableAttributes(String[])` so Jackson can deserialize legacy
`filterableAttributes` arrays while retaining granular-object configuration
handling. Add a regression test covering a payload such as
`{"filterableAttributes":["title"]}` and verify the resulting settings preserve
the decoded legacy values.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 8f2250d6-3821-4d59-9241-6ed566bd3416
📒 Files selected for processing (2)
src/main/java/com/meilisearch/sdk/model/Settings.javasrc/test/java/com/meilisearch/sdk/json/JacksonJsonHandlerTest.java
| @JsonIgnore | ||
| public Settings setFilterableAttributes(String[] filterableAttributes) { |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n -A8 -B4 \
'`@JsonIgnore`|setFilterableAttributes\(String\[\]|setFilterableAttributesConfig' \
src/main/java/com/meilisearch/sdk/model/Settings.java
rg -n \
'filterableAttributes.*\["|setFilterableAttributes\(new String' \
src/test/javaRepository: meilisearch/meilisearch-java
Length of output: 2156
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Files:\n'
git ls-files 'src/main/java/com/meilisearch/sdk/model/Settings.java' 'src/main/java/com/meilisearch/sdk/model/Filterable*.java'
printf '\nSettings.java lines 1-110:\n'
cat -n src/main/java/com/meilisearch/sdk/model/Settings.java | sed -n '1,110p'
printf '\nFilterable attribute files:\n'
git ls-files 'src/main/java/com/meilisearch/sdk/model/Filterable*.java' | sort
for f in $(git ls-files 'src/main/java/com/meilisearch/sdk/model/Filterable*.java' | sort); do
echo "--- $f"
cat -n "$f" | sed -n '1,220p'
done
printf '\nDeserializer/adapter usages:\n'
rg -n "Settings|FilterableAttributesLegacyAdapter|FilterableAttributesConfig|filterableAttributes" src/main/java src/test/java | head -n 200Repository: meilisearch/meilisearch-java
Length of output: 36584
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Files:\n'
git ls-files 'src/main/java/com/meilisearch/sdk/model/Settings.java' 'src/main/jsonschema' 'src/test/resources' | sed -n '1,200p'
printf '\nSettings.java lines 1-110:\n'
cat -n src/main/java/com/meilisearch/sdk/model/Settings.java | sed -n '1,110p'
printf '\nFilterable attribute files:\n'
git ls-files 'src/main/java/com/meilisearch/sdk/model/Filterable*.java' | sort
for f in $(git ls-files 'src/main/java/com/meilisearch/sdk/model/Filterable*.java' | sort); do
echo "--- $f"
cat -n "$f" | sed -n '1,220p'
done
printf '\nDeserializer/adapter usages:\n'
rg -n "Settings|FilterableAttributesLegacyAdapter|FilterableAttributesConfig|filterableAttributes" src/main/java src/test/java | head -n 200Repository: meilisearch/meilisearch-java
Length of output: 36746
Preserve legacy filterableAttributes deserialization.
@JsonIgnore hides both the legacy string setter and getter, so Jackson no longer decodes legacy payloads like {"filterableAttributes":["title"]} through setFilterableAttributes(String[]). Keep deserialization working for the string legacy form in addition to granular-object config entries, and add a regression test for that legacy shape.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/main/java/com/meilisearch/sdk/model/Settings.java` around lines 64 - 65,
Remove the `@JsonIgnore` from the String[] overload
`Settings.setFilterableAttributes(String[])` so Jackson can deserialize legacy
`filterableAttributes` arrays while retaining granular-object configuration
handling. Add a regression test covering a payload such as
`{"filterableAttributes":["title"]}` and verify the resulting settings preserve
the decoded legacy values.
1 participant
Related issue
Fixes #973
What does this PR do?
Fixes Jackson serialization when callers use granular
filterableAttributesConfigvalues. Jackson previously invoked the legacygetFilterableAttributes()accessor, which throws when a configuration contains granular feature settings.filterableAttributesJSON property.String[]getter and setter from Jackson serialization while retaining them as public SDK methods.features.filterandfacetSearchsettings.Validation
./gradlew.bat compileTestJava --no-daemongit diff --checkThe full test task is blocked locally because the repository's Mockito 4 / JaCoCo 0.8.8 test setup is incompatible with the installed Java 24 runtime; the failure occurs during test initialization before assertions run.
AI usage
I used Codex to help inspect the affected serialization path and draft the implementation and regression test. I reviewed the code and validated the behavior locally.
PR checklist
Summary by CodeRabbit