fix:settings changes detection issue with empty array #424
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.
Describe your change
If you set customRanking as an empty Array, like below, Algolia understands that you set the customRanking as null.
As a result, the index setting API (
/1/indexes/%s/settings?getVersion=1
) returns setting information like below.customRanking is nil.
This behavior is natural and understandable.
However, the settings changes checking function does not handle this difference correctly.
So, I add an additional compare logic to the function, especially
[]
andnil
comparing usingblank?
method.What problem is this fixing?
If you set customRanking ( or any other attributes ) as an empty Array , a useless index setting update API will be called when you use the search function.
It's heavy and blocking(synchronous) API calling, so your search function might be timed out.