#29174 Add save_rewrites_history to categories via API #29205

amenk · 2020-07-20T07:05:14Z

Support save_rewrites_history to categories API

Description (*)

See #29174

Fixed Issues (if relevant)

Fixes Category API should support save_rewrites_history for consistency reasons #29174, [Issue] #29174 Add save_rewrites_history to categories via API #30240

Manual testing scenarios (*)

See example in #29174

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)

Resolved issues:

resolves [Issue] #29174 Add save_rewrites_history to categories via API #30240: Category API should support save_rewrites_history for consistency reasons #29174 Add save_rewrites_history to categories via API

m2-assistant · 2020-07-20T07:05:16Z

Hi @amenk. 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:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
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

* Support save_rewrites_history in save

swnsma

Hi @amenk!

Thank you for your contribution!
Could you please check my comments?

Could you, also, please add coverage with webapi-functional tests?
Thank you!

app/code/Magento/CatalogUrlRewrite/Plugin/Webapi/Controller/Rest/InputParamsResolver.php

swnsma · 2020-07-21T10:52:05Z

app/code/Magento/Catalog/Model/CategoryRepository.php

@@ -82,6 +82,10 @@ public function save(\Magento\Catalog\Api\Data\CategoryInterface $category)
        $existingData = array_diff_key($existingData, array_flip(['path', 'level', 'parent_id']));
        $existingData['store_id'] = $storeId;

+        if ($category->getData('save_rewrites_history', null) !== null) {


It should be placed in Magento_CatalogUrlRewrite, not in Magento_Catalog.

Do you have a clue how we could do that?

@swnsma

In the first place my code is very similar to the solution products, just the categories are persisted differently and I am wondering which is the better way :)
I.e. if we change it for categories, we might need to adapt products as well.

I see several options:

Mess with \Magento\Catalog\Model\CategoryRepository::getExtensibleDataObjectConverter (which is already deprecated)

Intercept a different method, in the before save event, and somehow get the info that rewrites should be created from the request

.... ?

Help is very much appreciated :)

The problem that approach is lead to violation of modularity.
I see that for save from Adminhtml area, it uses observer to set a value and ResourceModel to save:
observer name="category_save_rewrites_history_setter"

Could you play somehow with \Magento\Catalog\Model\CategoryRepository::getExtensibleDataObjectConverter ? (the method is deprecated because class should be injected into the constructor parameters).

I see that it can handle custom attributes: \Magento\Framework\Api\ExtensibleDataObjectConverter::processCustomAttributes
Could we check why it does not help to solve our issue?

The problem that approach is lead to violation of modularity.
absolutely

I see that for save from Adminhtml area, it uses observer to set a value and ResourceModel to save:
observer name="category_save_rewrites_history_setter"

yes, but no access to what was sent via the API, here

Could you play somehow with \Magento\Catalog\Model\CategoryRepository::getExtensibleDataObjectConverter ? (the
method is deprecated because class should be injected into the constructor parameters).
I see that it can handle custom attributes:
\Magento\Framework\Api\ExtensibleDataObjectConverter::processCustomAttributes
Could we check why it does not help to solve our issue?

Maybe ... I am still wondering if that flag should be a custom attribute at all

Oh, I really would like to avoid such complications.
In such a case, it will be nice to have a mechanism for extension of Custom Attributes with not only EAV attributes but also with some configuration (more XML!).
But we already have Extension Attributes, which, could be used for this.

I prefer to look into two possible ways:

A short one - look into how we are saving category.
Probably, we need to just copy 'all other' fields from category data as it works for the product:

magento2/app/code/Magento/Catalog/Model/ProductRepository.php

Line 538 in 3008324

$productDataArray = $this->extensibleDataObjectConverter

A long one but more solid - look if we can replace usage of a custom attribute for extension attributes.
But it still is required to think about possible BC breaks (at least for products, where it works previously).

Thanks for your feedback @swnsma - I choose the blue pill (1.) for now. Let's see what the full test suite say.
I might still be BC breaking in a way, that some module does not expect all data to be copied in the repository's save, but it is very unlikely.

Actually I am not sure how repositories are supposed to work: Whether they should the attributes to the ones clearly specified (like EAV attributes) or not.

Option 2. would be great to implement, because it also saves us from all the hassle in InputParamsResolver, but I just don't have the resources to do that now -- at least we would have a integration test now if this get's merged :)

In the end of the day, I am not even sure if this setData() approach is nice to trigger the URL key regeneration - maybe somebody has even some better idea here.

I also do not really like the idea to pass all data with setData(). It also a hack but, at least, it does not provide modularity issue 😅

But, in general, it will be nice to ask someone else for additional ideas.

I would prefer option 1 if it is enough to solve the issue.
Looks like the safest and the easiest way.

That is like it is currently implemented in the PR... Can you take over and fix the tests? Thanks in advance

amenk · 2020-07-21T12:41:47Z

Could you, also, please add coverage with webapi-functional tests?

I thought about doing that, yes :) Do you have some suggestion which test would be a good starting point.

amenk · 2020-07-21T12:55:35Z

I think I will use \Magento\Catalog\Api\CategoryRepositoryTest::testUpdate as a base test

…egory updates

amenk · 2020-07-21T13:06:43Z

@swnsma functional test added, no we just have to solve the architectural problem in
https://github.com/magento/magento2/pull/29205/files/00176f5a3a0c6671556ff28b66f437ffb1970060#diff-7493dc1498457624ac9529eacf844ff7

Feel free to adapt the pull request, if you have an idea how to fix it and now that a proper test is in place.

…egory updates

amenk · 2020-07-21T17:22:03Z

Actually there are tons of modularity problems between Catalog and CatalogUrlRewrite --- save_rewrites_history is used in Magento_Catalog and url_key of course as well ...

The simples possible fix for the full issue would be

Index: app/code/Magento/Catalog/Model/Category.php
===================================================================
--- app/code/Magento/Catalog/Model/Category.php	(revision b8c848b22083b369702bebc19af7ad74bfe83c27)
+++ app/code/Magento/Catalog/Model/Category.php	(date 1595352024085)
@@ -309,7 +309,9 @@
	 if ($this->customAttributesCodes === null) {
	     $this->customAttributesCodes = $this->getEavAttributesCodes($this->metadataService);
	     $this->customAttributesCodes = array_diff($this->customAttributesCodes, CategoryInterface::ATTRIBUTES);
+            $this->customAttributesCodes[] = 'save_rewrites_history';
	 }
	 return $this->customAttributesCodes;
     }

We could do something similar for products and get rid of the full file

app/code/Magento/CatalogUrlRewrite/Plugin/Webapi/Controller/Rest/InputParamsResolver.php

…function

…4-save-rewrites-for-categories # Conflicts: # dev/tests/api-functional/testsuite/Magento/Catalog/Api/CategoryRepositoryTest.php

amenk · 2020-07-25T11:32:35Z

@magento run all tests

amenk · 2020-07-25T14:01:23Z

@magento run all tests

swnsma · 2020-07-26T12:43:35Z

@magento run all tests

swnsma · 2020-07-27T07:15:33Z

@magento run all tests

amenk · 2020-07-28T12:53:08Z

But, in general, it will be nice to ask someone else for additional ideas.

@swnsma whom?

engcom-Echo · 2020-09-29T12:45:11Z

@magento run all tests

engcom-Echo · 2020-09-29T14:22:02Z

Failed functional tests not related to the changes in this PR

magento-engcom-team · 2020-09-30T06:40:45Z

Hi @swnsma, thank you for the review.
ENGCOM-8286 has been created to process this Pull Request
✳️ @swnsma, 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

swnsma · 2020-09-30T06:41:46Z

@magento run Functional Tests EE, Functional Tests B2B

engcom-Bravo · 2020-09-30T09:57:26Z

✔️ QA Passed

Manual testing scenario

Go to Catalog - Categories and create a new Subcategory
Open Swagger (http://magentositewname.domain/swagger)
Generate Admin token via integrationAdminTokenServiceV1 POST /V1/integration/admin/token request
Copy the generated token into api_key field and click **apply
Perform the catalogCategoryRepositoryV1 PUT /V1/categories/{id} request with the following Parameters:

id 2 (id of the previously created category)
body

{
    "category": {
    "id": 5,
    "parent_id": 2,
    "name": "new name",
    "is_active": true,
    "position": 0,
    "level": 0,
    "created_at": "string",
    "updated_at": "string",
    "path": "string",
    "include_in_menu": true,
    "extension_attributes": {},
    "custom_attributes": [
      {
        "attribute_code": "url_key",
        "value": "new name1"
      },{
        "attribute_code":"save_rewrites_history",
        "value":1
        }
      ]
     }
    }

Verify if the Response body is correct.
Example:
Open database table url_rewrite

BEFORE applying changes provided in this PR, the old url_rewriew record has been removed, and only the new record existed

AFTER switching to the PR, the previous record is not removed

engcom-Bravo · 2020-09-30T10:01:20Z

@magento create issue

…29205

m2-assistant · 2020-09-30T19:38:29Z

Hi @amenk, 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.

magento#29174 Add save_rewrites_history to categories via API

5307bad

ghost added the Progress: pending review label Jul 20, 2020

magento-engcom-team added Component: CatalogUrlRewrite Release Line: 2.4 labels Jul 20, 2020

magento#29174 Transport save_rewrites_history in save

00176f5

* Support save_rewrites_history in save

swnsma requested changes Jul 21, 2020

View reviewed changes

ghost assigned swnsma Jul 21, 2020

ghost added Progress: needs update and removed Progress: pending review labels Jul 21, 2020

magento#29174 Make const private

4c99f0d

magento#29174 Add API functional test for redirect generation for cat…

f0ba72a

…egory updates

magento#29174 Add API functional test for redirect generation for cat…

0f983b2

…egory updates

amenk added 2 commits July 25, 2020 13:24

magento#29174 Category save: transport all existing data to the save …

7f380b6

…function

Merge remote-tracking branch 'upstream/2.4-develop' into feature/2917…

3361e72

…4-save-rewrites-for-categories # Conflicts: # dev/tests/api-functional/testsuite/Magento/Catalog/Api/CategoryRepositoryTest.php

amenk added 3 commits July 25, 2020 15:53

magento#29174 Fix unit tests

79c54ae

magento#29174 Fix complexity

99da072

magento#29174 Fix PHPStan Test

f61a27a

swnsma added the help wanted label Jul 27, 2020

ghost assigned novikor Jul 31, 2020

sidolov added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Aug 13, 2020

fix static

1ad4482

ghost added Progress: pending review and removed Progress: needs update labels Sep 29, 2020

swnsma self-requested a review September 30, 2020 06:38

swnsma approved these changes Sep 30, 2020

View reviewed changes

swnsma added the Award: bug fix label Sep 30, 2020

ghost added Progress: ready for testing and removed Progress: pending review labels Sep 30, 2020

swnsma added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Sep 30, 2020

engcom-Bravo self-assigned this Sep 30, 2020

novikor removed their assignment Sep 30, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Sep 30, 2020

m2-assistant bot mentioned this pull request Sep 30, 2020

[Issue] #29174 Add save_rewrites_history to categories via API #30240

Closed

4 tasks

engcom-Bravo added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Sep 30, 2020

ghost added Progress: extended testing Progress: accept and removed Progress: testing in progress Progress: extended testing labels Sep 30, 2020

magento-engcom-team mentioned this pull request Sep 30, 2020

Category API should support save_rewrites_history for consistency reasons #29174

Closed

magento-engcom-team pushed a commit that referenced this pull request Sep 30, 2020

ENGCOM-8286: #29174 Add save_rewrites_history to categories via API #…

e36b246

…29205

magento-engcom-team merged commit d21807c into magento:2.4-develop Sep 30, 2020

hostep mentioned this pull request Feb 21, 2025

Category Url Rewrite not correctly generated when updating url_key through API #39632

Closed

5 tasks

#29174 Add save_rewrites_history to categories via API #29205

#29174 Add save_rewrites_history to categories via API #29205

Uh oh!

Conversation

amenk commented Jul 20, 2020 • edited by engcom-Echo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Jul 20, 2020

Uh oh!

swnsma left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amenk commented Jul 21, 2020

Uh oh!

amenk commented Jul 21, 2020

Uh oh!

amenk commented Jul 21, 2020

Uh oh!

amenk commented Jul 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

amenk commented Jul 25, 2020

Uh oh!

amenk commented Jul 25, 2020

Uh oh!

swnsma commented Jul 26, 2020

Uh oh!

swnsma commented Jul 27, 2020

Uh oh!

amenk commented Jul 28, 2020

Uh oh!

engcom-Echo commented Sep 29, 2020

Uh oh!

engcom-Echo commented Sep 29, 2020

Uh oh!

magento-engcom-team commented Sep 30, 2020

Uh oh!

swnsma commented Sep 30, 2020

Uh oh!

engcom-Bravo commented Sep 30, 2020

Manual testing scenario

Uh oh!

engcom-Bravo commented Sep 30, 2020

Uh oh!

m2-assistant bot commented Sep 30, 2020

Uh oh!

Uh oh!

amenk commented Jul 20, 2020 •

edited by engcom-Echo

Loading

amenk commented Jul 21, 2020 •

edited

Loading