Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #29971 - Layered navigation swatches ignore show tooltip setting #30115

Open
wants to merge 3 commits into
base: 2.5-develop
Choose a base branch
from

Conversation

Bartlomiejsz
Copy link
Contributor

@Bartlomiejsz Bartlomiejsz commented Sep 19, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Layered navigation swatches ignore show tooltip setting #29971

Manual testing scenarios (*)

Please check fixed issue for testing scenario

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)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Sep 19, 2020

Hi @Bartlomiejsz. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ 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

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@Bartlomiejsz
Copy link
Contributor Author

@magento run all tests

@Bartlomiejsz
Copy link
Contributor Author

@magento run Functional Tests CE, Functional Tests EE, WebAPI Tests

@Bartlomiejsz
Copy link
Contributor Author

@magento run Functional Tests EE

@rogyar
Copy link
Contributor

rogyar commented Sep 19, 2020

Hi @Bartlomiejsz. Thank you for your contribution. Could I ask you to create an integration/functional test for this case, please? The test will set all the preconditions and assert that the page source does not have the tooltip selector.

Thank you!

@rogyar rogyar self-assigned this Sep 19, 2020
@Bartlomiejsz
Copy link
Contributor Author

Hi @rogyar, I believe I can work on it in the upcoming days

@sidolov sidolov added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Sep 21, 2020
@Bartlomiejsz Bartlomiejsz force-pushed the bugfix/29971_layered_navigation_swatch_tooltip branch from 81cda6f to 5599cdd Compare September 22, 2020 09:44
@ghost ghost removed the Progress: pending review label Oct 1, 2020
Copy link
Contributor

@sidolov sidolov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Bartlomiejsz could you please cover changes with automated test?

*/
protected $block = \Magento\Swatches\Block\LayeredNavigation\RenderLayered::class;
protected $swatchHelper;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make property private

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

) {
$this->layout = $layout;
$this->swatchHelper = $swatchHelper;
$this->configurableViewModel = $configurableViewModel
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may not follow BC development rules in plugins.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@ghost ghost assigned sidolov Oct 2, 2020
@Bartlomiejsz
Copy link
Contributor Author

Hi @sidolov, yes, I will work on that, just didn't yet have time for it unfortunately

@Bartlomiejsz Bartlomiejsz force-pushed the bugfix/29971_layered_navigation_swatch_tooltip branch from b5397d2 to 5fe0d4a Compare October 6, 2020 12:40
@Bartlomiejsz Bartlomiejsz force-pushed the bugfix/29971_layered_navigation_swatch_tooltip branch from 5fe0d4a to 354ec22 Compare October 6, 2020 12:41
@Bartlomiejsz
Copy link
Contributor Author

@magento run all tests

@Bartlomiejsz
Copy link
Contributor Author

@magento run Functional Tests CE

@Bartlomiejsz
Copy link
Contributor Author

@magento run WebAPI Tests

<checkOption selector="{{AdminProductFormSection.selectCategory(categoryName)}}" stepKey="selectCategory"/>
<click selector="{{AdminProductFormSection.done}}" stepKey="clickDone"/>
<waitForPageLoad stepKey="waitForApplyCategory"/>
<actionGroup name="AdminAssignCategoryToProductAndSaveActionGroup" extends="AdminAssignCategoryToProductActionGroup">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a very good cleanup. But unfortunately, it makes the PR backward-incompatible for 2.4-develop branch. There might be 3rd-party modules that extend the current action group and rely on the step keys. By removing the existing step keys we may brake such systems

<actionGroup ref="AdminLoginActionGroup" stepKey="loginAsAdmin"/>
</before>
<after>
<!-- Clean up our modifications to the existing color attribute -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here as well, if we remove the existing step keys, we introduce backward-incompatible changes.

@rogyar
Copy link
Contributor

rogyar commented Oct 9, 2020

Hi @Bartlomiejsz. Awesome job! Thank you.
I left some comments regarding backward compatibility. But it will be a shame to discard your refactorings because of that fact. I would go the following way. We may have the 2.5-develop branch soon. Once it's available, I would suggest you recreate the same PR into the 2.5-develop branch. In that way, we will not be afraid of backward compatibility.

How does it sound?

@Bartlomiejsz
Copy link
Contributor Author

@rogyar that sounds good to me, just wondering - is it known already when 2.5 branch will be available?

@rogyar
Copy link
Contributor

rogyar commented Oct 13, 2020

Hi @Bartlomiejsz. We have not publicly available info about that point so far

@sidolov sidolov added this to the 2.5 milestone Nov 11, 2020
@m2-community-project m2-community-project bot added Progress: review Progress: on hold Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. and removed Progress: review labels Nov 11, 2020
@Bartlomiejsz Bartlomiejsz changed the base branch from 2.4-develop to 2.5-develop January 11, 2021 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Frontend Component: Swatches Partner: Fast White Cat partners-contribution Pull Request is created by Magento Partner Priority: P3 May be fixed according to the position in the backlog. Progress: review Release Line: 2.5 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”.
Projects
Status: Review in Progress
Development

Successfully merging this pull request may close these issues.

Layered navigation swatches ignore show tooltip setting
5 participants