CIF-2982 - Support product filter hooks in ProductList component

[herzog31]

Description

• Made CategoryRetriever from ProductList component public.
• Extended CategoryRetriever with product filter extension. This is for setting and getting only, not actually used by this retriever.
• Added unit test.

How Has This Been Tested?

• Unit test
• Proxy component in Venia

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes and the overall coverage did not decrease.
• All unit tests pass on CircleCi.
• I ran all tests locally and they pass.

[codecov]

Codecov Report

Merging #966 (6f31774) into master (00af1c5) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##             master     #966   +/-   ##
=========================================
  Coverage     89.14%   89.15%           
- Complexity     2208     2211    +3     
=========================================
  Files           354      354           
  Lines          9980     9985    +5     
  Branches       1437     1437           
=========================================
+ Hits           8897     8902    +5     
  Misses          787      787           
  Partials        296      296           

Flag	Coverage Δ
integration	51.80% <79.16%> (-0.05%)	⬇️
jest	86.68% <ø> (ø)
karma	95.53% <ø> (ø)
unittests	87.42% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ore/components/models/productlist/ProductList.java	50.00% <ø> (ø)
...ch/internal/services/SearchResultsServiceImpl.java	94.49% <ø> (ø)
...nternal/models/v1/productlist/ProductListImpl.java	89.01% <100.00%> (ø)
...mponents/models/productlist/CategoryRetriever.java	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[buuhuu]

With this approach we now have two ways to extend the query of the product list component: by using the productQueryHook of the ProductList#getCategoryRetriever() and by using the newly introduced filter hook.

Wouldn't it make more sense to add the product filter hook to the AbstractCategoryRetriever? That way the extension pattern remains the same. Also that the SearchResults and the ProductList use the same queries is an implementation detail, it does not mean that any ProductCollection would allow to do that.

[herzog31]

@buuhuu I think we have a few consistency issues here:

• SearchResults doesn't use any retriever, so we cannot use the same pattern here as with the ProductList.
• AbstractCategoryRetriever is used in the context of a category query. While extending category, category filter and products make sense here, extending the product filter does not. This retriever would not be using it for anything, but we would only have an external consumer.
• I agree that moving the extensions to ProductCollection might not be the best place, since as you said, we cannot expect any subclass to allow the same grade of extensibility.

I don't have a good answer here, since frankly the SearchResultsService is a mess.