Skip to content

Changed Newsletter Enabled/Disable config settings by priority, store scope then default scope #31208

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jan 24, 2021
Merged

Changed Newsletter Enabled/Disable config settings by priority, store scope then default scope #31208

merged 10 commits into from
Jan 24, 2021

Conversation

saphaljha
Copy link
Contributor

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Newsletter enabled setting is always retrieved from the default scope #31188

Manual testing scenarios (*)

  1. manually Testes

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 Dec 8, 2020

Hi @saphaljha. 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

@m2-community-project m2-community-project bot added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Dec 8, 2020
@magento-engcom-team magento-engcom-team added Partner: Krish TechnoLabs partners-contribution Pull Request is created by Magento Partner labels Dec 8, 2020
@saphaljha
Copy link
Contributor Author

@magento run all tests

gabrieldagama
gabrieldagama suggested changes Dec 16, 2020
View reviewed changes
Copy link
Contributor

@gabrieldagama gabrieldagama left a comment

Choose a reason for hiding this comment

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

Hi, @saphaljha thanks for contributing! Please have a look at my comment below, also, we must cover the changes in this PR with automated tests in order to proceed with it.

Thanks!

app/code/Magento/Newsletter/Model/Config.php Outdated
@@ -41,7 +41,7 @@ public function __construct(
* @param string $scopeType
* @return bool
*/
public function isActive(string $scopeType = ScopeConfigInterface::SCOPE_TYPE_DEFAULT): bool
public function isActive(string $scopeType = \Magento\Store\Model\ScopeInterface::SCOPE_STORE): bool
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe we shouldn't change the scope here, as you can see the scope is a parameter and can be requested differently by who is calling it, I would recommend changing \Magento\Customer\Block\Form\Register::isNewsletterEnabled to request the store scope instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, I'll work on it

@engcom-Hotel engcom-Hotel self-assigned this Dec 21, 2020
@engcom-Hotel
Copy link
Contributor

Hello @saphaljha,
I will help with the fix and its test coverage.

@saphaljha
Copy link
Contributor Author

@engcom-Hotel, ok, thank you!!

@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B

@magento-engcom-team
Copy link
Contributor

Hi @gabrieldagama, thank you for the review.
ENGCOM-8675 has been created to process this Pull Request
✳️ @gabrieldagama, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@engcom-Bravo engcom-Bravo self-assigned this Jan 21, 2021
@gabrieldagama gabrieldagama added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix labels Jan 21, 2021
@engcom-Bravo
Copy link
Contributor

✔️ QA Passed

Manual testing scenario

  1. From Admin Panel, go to Stores - Configuration - Customers - Newsletter
  2. Select Scope - Default Config (should be selected by default)
  3. Expand General Options and set Yes for Enabled (should be selected by default)
  4. Save Config
  5. Change the Scope to Default Store View
  6. Expand General Options and set No for Enabled, Save Config
  7. Go to Storefront, default store view and click Create an Account
  8. Verify if the Sign up for Newsletter checkbox is available in the customer registration form

BEFORE applying changes provided in the PR, the Sign up for Newsletter checkbox was available despite that it has been disabled from Admin Panel
sign_up_before

AFTER switching to the PR, the Sign up for Newsletter checkbox is not available
sign_up_after

  • tested in Scope of multiple storeviews
  • tested a case when a Customer is registered when the Newsletter subscription is Disabled, and then changed the configuration and Enabled the Newsletter subscription. Customer can successfully Subscribe for Newsletter
    subscr_success

@engcom-Bravo engcom-Bravo added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Jan 21, 2021
magento-engcom-team pushed a commit that referenced this pull request Jan 24, 2021
@gabrieldagama
ENGCOM-8675: Changed Newsletter Enabled/Disable config settings by pr…
33d322b 
…iority, store scope then default scope #31208
@magento-engcom-team magento-engcom-team merged commit a687390 into magento:2.4-develop Jan 24, 2021
@m2-assistant
Copy link

m2-assistant bot commented Jan 24, 2021

Hi @saphaljha, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@engcom-Hotel engcom-Hotel engcom-Hotel left review comments

@gabrieldagama gabrieldagama gabrieldagama approved these changes

Assignees

@gabrieldagama gabrieldagama

@engcom-Bravo engcom-Bravo

@engcom-Hotel engcom-Hotel

Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Component: Customer Component: Newsletter Partner: Krish TechnoLabs partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Progress: testing in progress QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Newsletter enabled setting is always retrieved from the default scope
5 participants
@saphaljha @engcom-Hotel @magento-engcom-team @engcom-Bravo @gabrieldagama