Release 2.5.1

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.5.1
+
+# Fixed
+- Filter unexpected items from the hierarchical tree results
+
 # 2.5.0
 
 ## Added

README.md

@@ -51,6 +51,10 @@ Add this proguard rule to solve it.
 -keep class com.algolia.search.model.** { *; }
 ```
 
+## Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/guides/building-search-ui/troubleshooting/faq/android/) where you will find answers for the most common issues and gotchas with the library.
+
 # License
 
 InstantSearch Android is [licensed under Apache V2](LICENSE).

buildSrc/src/main/kotlin/dependency/Library.kt

@@ -5,7 +5,7 @@ object Library: Dependency  {
 
     override val group = "com.algolia"
     override val artifact = "instantsearch"
-    override val version = "2.5.0"
+    override val version = "2.5.1"
 
     val packageName = "$group:$artifact-android"
 

helper/src/commonMain/kotlin/com/algolia/instantsearch/helper/hierarchical/HierarchicalConnectionSearcher.kt

@@ -5,6 +5,7 @@ import com.algolia.instantsearch.core.connection.ConnectionImpl
 import com.algolia.instantsearch.helper.searcher.SearcherSingleIndex
 import com.algolia.instantsearch.helper.searcher.addFacet
 import com.algolia.search.model.response.ResponseSearch
+import com.algolia.search.model.search.Facet
 
 internal data class HierarchicalConnectionSearcher(
     private val viewModel: HierarchicalViewModel,
@@ -17,12 +18,33 @@ internal data class HierarchicalConnectionSearcher(
                 ?: response.facetsOrNull?.filter { it.key == viewModel.hierarchicalAttributes.first() } ?: mapOf()
 
             viewModel.tree.value = viewModel.hierarchicalAttributes
-                .mapNotNull { facets[it] }
+                .mapNotNull { facets[it]?.toMutableList() }
+                .filterUnprefixed()
                 .flatten()
                 .toNodes(selectedHierarchicalValue)
         }
     }
 
+    /**
+     * Removes results not matching the naming pattern.
+     * This is a workaround to remove unexpected categories in results.
+     *
+     * Let's consider an item with the following filters:
+     * Level 0: [Clothing, Top]
+     * Level 1: [Clothing > Men, Clothing > Women, Top > T-shirts]
+     *
+     * In case of selecting 'Clothing' the tree will be:
+     * Level 0: [Clothing, Furniture]
+     * Level 1: [Clothing > Men, Clothing > Women]
+     */
+    private fun List<MutableList<Facet>>.filterUnprefixed(): List<MutableList<Facet>> {
+        viewModel.hierarchicalPath.value.forEachIndexed { index, (_, item) ->
+            getOrNull(index + 1)?. // Get next level (sub-category)
+            removeAll { !it.value.startsWith(item) } // Remove the items not respecting the prefix convention
+        }
+        return this
+    }
+
     private val selectedHierarchicalValue: String?
         get() {
             val value = viewModel.selections.value

helper/src/commonMain/kotlin/com/algolia/instantsearch/helper/hierarchical/HierarchicalViewModel.kt

@@ -20,6 +20,8 @@ public open class HierarchicalViewModel(
     public val selections = SubscriptionValue<List<String>>(listOf())
     public val eventHierarchicalPath = SubscriptionEvent<HierarchicalPath>()
 
+    internal val hierarchicalPath = SubscriptionValue<HierarchicalPath>(listOf())
+
     init {
         if (hierarchicalAttributes.isEmpty())
             throw IllegalArgumentException("HierarchicalAttributes should not be empty")
@@ -37,10 +39,11 @@ public open class HierarchicalViewModel(
             selections.getOrNull(index)?.let { item to it }
         }.filterNotNull()
 
+        this.hierarchicalPath.value = hierarchicalPath
         eventHierarchicalPath.send(hierarchicalPath)
     }
 
     private fun String.toSelectionList(): List<String> = split(separator).fold(listOf()) { acc, s ->
         acc + if (acc.isEmpty()) s else acc.last() + separator + s
     }
-}
+}