Skip to content

Replace Registry with CategoryRepository in ProductList::getDefaultSortField()#40601

Open
mcspronko wants to merge 2 commits intomagento:2.4-developfrom
pronkoconsulting:mpronko/product-list-helper-register-removal
Open

Replace Registry with CategoryRepository in ProductList::getDefaultSortField()#40601
mcspronko wants to merge 2 commits intomagento:2.4-developfrom
pronkoconsulting:mpronko/product-list-helper-register-removal

Conversation

@mcspronko
Copy link
Copy Markdown
Contributor

@mcspronko mcspronko commented Mar 18, 2026

Description (*)

ProductList.php changes:

  • Added imports: CategoryRepositoryInterface, RequestInterface, NoSuchEntityException
  • Kept Registry import with @deprecated annotation on the property
  • Added $categoryRepository and $request private properties
  • Constructor now takes two optional BC-compatible parameters; Registry param is kept but marked deprecated, no longer used
  • getDefaultSortField() now loads category via CategoryRepositoryInterface::get($id) where $id comes from RequestInterface::getParam('id'), with fallback to store config on missing category or no ID

ProductListTest.php changes:

  • Added imports for CategoryRepositoryInterface, Category, RequestInterface, NoSuchEntityException
  • Added mocks for $categoryRepositoryMock and $requestMock injected into setUp()
  • Added three test methods covering: category sort by returned, fallback on NoSuchEntityException, fallback when no category ID

Fixed Issues (if relevant)

  1. Fixes The Magento\Catalog\Helper\Product\ProductList class uses deprecated Magento\Framework\Registry class #40600
  2. Fixes Catalog ProductList helper has coupling to Registry #27119

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link
Copy Markdown

m2-assistant bot commented Mar 18, 2026

Hi @mcspronko. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@mcspronko
Copy link
Copy Markdown
Contributor Author

@magento run all tests

@engcom-Bravo engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 19, 2026
@github-project-automation github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Mar 19, 2026
@mcspronko mcspronko force-pushed the mpronko/product-list-helper-register-removal branch from 58b9894 to 92b90c9 Compare March 21, 2026 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: pending review

Projects

Status: Pending Review

2 participants