refactor(hierarchical): update group logic (algolia#10)

Author: aallam

helper_dart/lib/src/filter_group.dart

@@ -42,44 +42,51 @@ class FilterGroupID {
 enum FilterOperator { and, or }
 
 /// Represents a filter group
-abstract class FilterGroup<T> extends DelegatingSet<T> {
+abstract class FilterGroup<T extends Filter> extends DelegatingSet<T> {
  /// Creates [FilterGroupID] instance.
  const FilterGroup._(this.groupID, this._filters) : super(_filters);
 
  /// Creates [FilterGroup] as [FacetFilterGroup].
  @factory
  static FacetFilterGroup facet({
+ required Set<FilterFacet> filters,
  String name = '',
- Set<FilterFacet> filters = const {},
  FilterOperator operator = FilterOperator.and,
  }) =>
  FacetFilterGroup(FilterGroupID(name, operator), filters);
 
  /// Creates [FilterGroup] as [TagFilterGroup].
  @factory
  static TagFilterGroup tag({
+ required Set<FilterTag> filters,
  String name = '',
- Set<FilterTag> filters = const {},
  FilterOperator operator = FilterOperator.and,
  }) =>
  TagFilterGroup(FilterGroupID(name, operator), filters);
 
  /// Creates [FilterGroup] as [NumericFilterGroup].
  @factory
  static NumericFilterGroup numeric({
+ required Set<FilterNumeric> filters,
  String name = '',
- Set<FilterNumeric> filters = const {},
  FilterOperator operator = FilterOperator.and,
  }) =>
  NumericFilterGroup(FilterGroupID(name, operator), filters);
 
  /// Creates [FilterGroup] as [HierarchicalFilterGroup].
  @factory
  static HierarchicalFilterGroup hierarchical({
+ required Set<FilterFacet> filters,
+ required List<FilterFacet> path,
+ required List<String> attributes,
  String name = '',
- Set<HierarchicalFilter> filters = const {},
  }) =>
- HierarchicalFilterGroup(name, filters);
+ HierarchicalFilterGroup(
+ FilterGroupID.and(name),
+ filters,
+ path,
+ attributes,
+ );
 
  /// Filter group ID (name and operator)
  final FilterGroupID groupID;
@@ -110,7 +117,7 @@ class FacetFilterGroup extends FilterGroup<FilterFacet> {
 
  /// Make a copy of the facet filters group.
  @override
- FilterGroup<FilterFacet> copyWith({
+ FacetFilterGroup copyWith({
  FilterGroupID? groupID,
  Set<FilterFacet>? filters,
  }) =>
@@ -131,7 +138,7 @@ class TagFilterGroup extends FilterGroup<FilterTag> {
 
  /// Make a copy of the tag filters group.
  @override
- FilterGroup<FilterTag> copyWith({
+ TagFilterGroup copyWith({
  FilterGroupID? groupID,
  Set<FilterTag>? filters,
  }) =>
@@ -151,7 +158,7 @@ class NumericFilterGroup extends FilterGroup<FilterNumeric> {
 
  /// Make a copy of the numeric filters group.
  @override
- FilterGroup<FilterNumeric> copyWith({
+ NumericFilterGroup copyWith({
  FilterGroupID? groupID,
  Set<FilterNumeric>? filters,
  }) =>
@@ -166,28 +173,51 @@ class NumericFilterGroup extends FilterGroup<FilterNumeric> {
 }
 
 /// Hierarchical filter group
-class HierarchicalFilterGroup extends FilterGroup<HierarchicalFilter> {
+class HierarchicalFilterGroup extends FilterGroup<FilterFacet> {
  /// Creates an [HierarchicalFilterGroup] instance.
- HierarchicalFilterGroup(String name, Set<HierarchicalFilter> filters)
- : this._(FilterGroupID(name), filters);
-
- /// Creates a [HierarchicalFilterGroup] instance.
- HierarchicalFilterGroup._(super.groupID, super.filters) : super._() {
+ HierarchicalFilterGroup(
+ super.groupID,
+ super.filters,
+ this.path,
+ this.attributes,
+ ) : super._() {
  assert(groupID.operator == FilterOperator.and);
  }
 
+ /// Filter facets path.
+ final List<FilterFacet> path;
+
+ /// Attributes names.
+ final List<String> attributes;
+
  /// Make a copy of the hierarchical filters group.
  @override
- FilterGroup<HierarchicalFilter> copyWith({
+ HierarchicalFilterGroup copyWith({
  FilterGroupID? groupID,
- Set<HierarchicalFilter>? filters,
+ Set<FilterFacet>? filters,
+ List<FilterFacet>? path,
+ List<String>? attributes,
  }) =>
- HierarchicalFilterGroup._(
+ HierarchicalFilterGroup(
  groupID ?? this.groupID,
  filters ?? _filters,
+ path ?? this.path,
+ attributes ?? this.attributes,
  );
 
  @override
  String toString() =>
  'HierarchicalFilterGroup{groupID: $groupID, filters: $_filters}';
+
+ @override
+ bool operator ==(Object other) =>
+ identical(this, other) ||
+ super == other &&
+ other is HierarchicalFilterGroup &&
+ runtimeType == other.runtimeType &&
+ path == other.path &&
+ attributes == other.attributes;
+
+ @override
+ int get hashCode => super.hashCode ^ path.hashCode ^ attributes.hashCode;
 }

helper_dart/lib/src/filter_group_converter.dart

@@ -11,9 +11,7 @@ class FilterGroupConverter {
  /// Converts [FilterGroup] to its SQL-like [String] representation.
  /// Returns `null` if the list is empty.
  String? sql(Set<FilterGroup> filterGroups) {
- final groups = filterGroups
- .whereType<FilterGroup<Filter>>()
- .whereNot((element) => element.isEmpty);
+ final groups = filterGroups.whereNot((element) => element.isEmpty);
  if (groups.isEmpty) return null;
  return groups.map(_sqlGroup).join(' AND ');
  }

helper_dart/lib/src/filters.dart

@@ -91,7 +91,14 @@ abstract class Filters {
  final numerics =
  numericGroups.toList(NumericFilterGroup.new).unmodifiable();
  final hierarchical = hierarchicalGroups
- .toList((name, filter) => HierarchicalFilterGroup(name, {filter}))
+ .toList(
+ (name, group) => HierarchicalFilterGroup(
+ FilterGroupID.and(name),
+ {group.filter},
+ group.path,
+ group.attributes,
+ ),
+ )
  .unmodifiable();
  return {...facets, ...tags, ...numerics, ...hierarchical};
  }
@@ -104,4 +111,28 @@ abstract class Filters {
  Map<FilterGroupID, Set<FilterNumeric>>? numericGroups,
  Map<String, HierarchicalFilter>? hierarchicalGroups,
  });
+
+ @override
+ String toString() => 'Filters{'
+ 'facetGroups: $facetGroups, '
+ 'tagGroups: $tagGroups, numericGroups: '
+ '$numericGroups, hierarchicalGroups: $hierarchicalGroups'
+ '}';
+
+ @override
+ bool operator ==(Object other) =>
+ identical(this, other) ||
+ other is Filters &&
+ runtimeType == other.runtimeType &&
+ facetGroups.equals(other.facetGroups) &&
+ tagGroups.equals(other.tagGroups) &&
+ numericGroups.equals(other.numericGroups) &&
+ hierarchicalGroups.equals(other.hierarchicalGroups);
+
+ @override
+ int get hashCode =>
+ facetGroups.hashing() ^
+ tagGroups.hashing() ^
+ numericGroups.hashing() ^
+ hierarchicalGroups.hashing();
 }

helper_dart/lib/src/query_builder.dart

@@ -33,19 +33,16 @@ class QueryBuilder {
  }
 
  /// Get hierarchical filters from the search state's filter groups.
- Iterable<HierarchicalFilter> _getHierarchicalFilters() =>
- _searchState.filterGroups
- ?.whereType<HierarchicalFilterGroup>()
- .expand((filterGroup) => filterGroup) ??
- [];
+ Iterable<HierarchicalFilterGroup> _getHierarchicalFilters() =>
+ _searchState.filterGroups?.whereType<HierarchicalFilterGroup>() ?? [];
 
  /// Number of generated hierarchical queries for given hierarchical
  /// filter
- int _getHierarchicalQueriesCount(HierarchicalFilter filter) {
- if (filter.attributes.length == filter.path.length) {
- return filter.attributes.length;
+ int _getHierarchicalQueriesCount(HierarchicalFilterGroup group) {
+ if (group.attributes.length == group.path.length) {
+ return group.attributes.length;
  }
- return filter.path.isEmpty ? 0 : filter.path.length + 1;
+ return group.path.isEmpty ? 0 : group.path.length + 1;
  }
 
  /// Total number of queries
@@ -119,11 +116,8 @@ class QueryBuilder {
  /// Build additional queries to fetch correct facets count values
  /// for hierarchical facets
  List<SearchState> _buildHierarchicalFacetingQueries(SearchState query) {
- final hierarchicalFilters = query.filterGroups
- ?.whereType<HierarchicalFilterGroup>()
- .expand((e) => e)
- .toList() ??
- [];
+ final hierarchicalFilters =
+ query.filterGroups?.whereType<HierarchicalFilterGroup>().toList() ?? [];
 
  final queries = <SearchState>[];
  for (final hierarchicalFilter in hierarchicalFilters) {
@@ -152,15 +146,11 @@ class QueryBuilder {
  SearchState _hierarchicalQueryOf(
  String facet,
  FilterFacet? pathFilter,
- HierarchicalFilter hierarchicalFilter,
+ HierarchicalFilterGroup group,
  SearchState state,
  ) {
  final filterGroupsCopy = _copyFilterGroups()
- ..forEach((filterGroup) {
- if (filterGroup.groupID.operator == FilterOperator.and) {
- filterGroup.removeWhere((filter) => filter == hierarchicalFilter);
- }
- });
+ ..removeWhere((filter) => filter == group);
 
  if (pathFilter != null) {
  filterGroupsCopy.add(

helper_dart/test/filter_converter_test.dart

@@ -162,9 +162,9 @@ void main() {
 
  test('Empty groups', () {
  final filterGroups = <FilterGroup<Filter>>{
- FilterGroup.facet(),
- FilterGroup.numeric(),
- FilterGroup.tag(),
+ FilterGroup.facet(filters: const {}),
+ FilterGroup.numeric(filters: const {}),
+ FilterGroup.tag(filters: const {}),
  };
  const converter = FilterGroupConverter();
  expect(converter.unquoted(filterGroups), null);

helper_dart/test/query_builder_test.dart

@@ -118,15 +118,17 @@ void main() {
  Filter.facet(lvl1, 'a > b'),
  Filter.facet(lvl2, 'a > b > c')
  ];
- final hierarchicalFilter =
- HierarchicalFilter(attributes, path, Filter.facet(lvl2, 'a > b > c'));
 
  final colorGroup = FacetFilterGroup(
  const FilterGroupID('color'),
  {Filter.facet('color', 'red')},
  );
- final hierarchicalGroup =
- HierarchicalFilterGroup('h', {hierarchicalFilter});
+ final hierarchicalGroup = FilterGroup.hierarchical(
+ name: 'h',
+ path: path,
+ attributes: attributes,
+ filters: {Filter.facet(lvl2, 'a > b > c')},
+ );
  final filterGroups = <FilterGroup>{colorGroup, hierarchicalGroup};
 
  final query = SearchState(
@@ -147,7 +149,7 @@ void main() {
 
  case 1:
  expect(query.facets, [lvl0]);
- expect(query.filterGroups!.length, 2);
+ expect(query.filterGroups!.length, 1);
  expect(
  query.filterGroups!.first.groupID,
  const FilterGroupID('color'),
@@ -225,22 +227,26 @@ void main() {
  });
 
  test('test disjunctive & hierarchical responses merging', () {
- final hierarchicalFilter = HierarchicalFilter(
- ['category.lvl0', 'category.lvl1', 'category.lvl2', 'category.lvl3'],
- [
- Filter.facet('category.lvl0', 'a'),
- Filter.facet('category.lvl1', 'a > b'),
- Filter.facet('category.lvl2', 'a > b > c')
- ],
- Filter.facet('category.lvl2', 'a > b > c'),
- );
-
  final query = SearchState(
  indexName: 'index',
  query: 'phone',
  disjunctiveFacets: {'color', 'brand', 'size'},
  filterGroups: {
- HierarchicalFilterGroup('category', {hierarchicalFilter})
+ FilterGroup.hierarchical(
+ name: 'category',
+ filters: {Filter.facet('category.lvl2', 'a > b > c')},
+ path: [
+ Filter.facet('category.lvl0', 'a'),
+ Filter.facet('category.lvl1', 'a > b'),
+ Filter.facet('category.lvl2', 'a > b > c')
+ ],
+ attributes: [
+ 'category.lvl0',
+ 'category.lvl1',
+ 'category.lvl2',
+ 'category.lvl3'
+ ],
+ )
  },
  );