Skip to content

REST API Product update url_key doesnt re-gerenate url_rewites when single store enabled #32009

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

Merged
merged 4 commits into from
Mar 7, 2021

Conversation

engcom-Charlie
Copy link
Contributor

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes REST API Product update url_key doesnt re-gerenate url_rewites (INSANE) #30316

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

@m2-assistant
Copy link

m2-assistant bot commented Feb 9, 2021

Hi @engcom-Charlie. Thank you for your contribution
Here are 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
  13. Semantic Version Checker

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 the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Feb 9, 2021
@engcom-Charlie
Copy link
Contributor Author

@magento run all tests

@danielrussob
Copy link

@magento give me test instance

@magento-deployment-service
Copy link

Hi @danielrussob. Thank you for your request. I'm working on Magento instance for you.

@danielrussob
Copy link

@magento give me 2.4-develop instance

@magento-deployment-service
Copy link

Hi @danielrussob. Thank you for your request. I'm working on Magento instance for you.

@magento-deployment-service
Copy link

@danielrussob
Copy link

danielrussob commented Feb 9, 2021

Issue reproduced on vanilla 2.4

SKU: 24-MB01

Payload:

{
  "product": {
    "custom_attributes": [
      {
        "attribute_code": "url_key",
        "value": "nuovissimo-url-key-ahaha"
      }
    ]
  }
}

image

@danielrussob
Copy link

danielrussob commented Feb 9, 2021

Issue solved on new instance

SKU: 24-MB01

Payload:

{
  "product": {
    "custom_attributes": [
      {
        "attribute_code": "url_key",
        "value": "nuovissimo-url-key-ahaha"
      }
    ]
  }
}

image

@danielrussob
Copy link

Checking commit 558d527 in data 10 september 18 there was a refactor on foreach that could cause bug

image

image

@@ -828,9 +828,6 @@ public function getStoreIds()
if (!$this->hasStoreIds()) {
$storeIds = [];
if ($websiteIds = $this->getWebsiteIds()) {
if (!$this->isObjectNew() && $this->_storeManager->isSingleStoreMode()) {
$websiteIds = array_keys($websiteIds);
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @engcom-Charlie, thanks for your PR.

I agree that removing this code solves the issue and, as we read in the issue, this code doesn't seem to have any meaning. Actually, @danielrussob found the point in time where the array_keys was introduced causing the error.

But there is a unit test asserting that the method isSingleStoreMode() is called once; indeed now it fails because the method is no more called.

So in order for this PR to be processed, we also need to remove that expectation from the failing unit test.

Choose a reason for hiding this comment

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

I confirm

@@ -828,9 +828,6 @@ public function getStoreIds()
if (!$this->hasStoreIds()) {
$storeIds = [];
if ($websiteIds = $this->getWebsiteIds()) {
if (!$this->isObjectNew() && $this->_storeManager->isSingleStoreMode()) {
$websiteIds = array_keys($websiteIds);

Choose a reason for hiding this comment

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

I confirm

@engcom-Bravo
Copy link
Contributor

✔️ QA Passed

Manual testing scenario

  1. From Admin Panel, go to Stores - Configuration - General and set Single Store Mode to Yes
  2. Create a Simple product with setting URL Key under _Search Engine Optimization. Save the product
    seo_product
  3. Open Swagger, and perform {{magento_url}}/rest/all/V1/products/{{sku}} PUT request to change the URL Key
{
  "product": {
    "custom_attributes": [
        {
            "attribute_code": "url_key",
            "value": "my-new-url"
        }
    ]
  }
}
  1. Go to Marketing - URL Rewrites and check if the Request Path has been changed for the previously created Simple Product

BEFORE applying changes provided in the PR, the Request Path did not change
url_rewrite_before

AFTER switching to the PR, the Request Path changed according to the value set in the PUT request
url_rewrite_after

@engcom-Bravo engcom-Bravo added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Feb 11, 2021
@engcom-Bravo engcom-Bravo added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Progress: testing in progress Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. and removed Progress: ready for testing labels Feb 11, 2021
@magento-engcom-team
Copy link
Contributor

Hi @danielrussob, thank you for the review.
ENGCOM-8754 has been created to process this Pull Request

@engcom-Bravo
Copy link
Contributor

✔️ QA Passed

The result is the same as in the report above #32009 (comment)

magento-engcom-team pushed a commit that referenced this pull request Mar 7, 2021
@magento-engcom-team magento-engcom-team merged commit 2305d63 into magento:2.4-develop Mar 7, 2021
@m2-assistant
Copy link

m2-assistant bot commented Mar 7, 2021

Hi @engcom-Charlie, 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
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Component: Catalog Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept 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. Type: Bug Fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

REST API Product update url_key doesnt re-gerenate url_rewites (INSANE)
6 participants