Order Item Repository saving and deleting items on the null key in registry

[ioiste]

Description (*)

Hi, Magento 2 team! We noticed an issue. While saving or deleting Order Items via Magento/Sales/Model/Order/ItemRepository, the entities are stored in the $this->registry array using $entity->getEntityId() as the key.
However, entity_id ($entity->getEntityId()) does not exist on the Order Item and, while saving or deleting,
it would set the Order Item object in $this->registry on the null key. This might cause issues in some cases.

Consider the following scenario:

$orderItem = ItemRepository->get(1234); // Checks the `registry` for that item, doesn't find it, gets the item from DB and stores it in the `registry` array on the `1234` key
$orderItem->setQtyCanceled(2); // Update something
ItemRepository->save(orderItem); // Save the item, store the updated entity in the `registry` on the `null` key (this is the issue)

Later on, using the exact same ItemRepository instance, you want to get the order item with id 1234, so you do:
$orderItem = ItemRepository->get(1234); - It checks the registry for that item, finds it for the 1234 key and then returns that entity. That entity won't be the one saved earlier (since that one is on the null key), thus being outdated.
$orderItem->getQtyCanceled() will not be the expected 2.

The proper field to use as the key would be item_id ($entity->getItemId()).
It returns the Order Item ID, which, besides fixing the issue described above, it makes sure the repository can properly handle saving multiple subsequent elements in the $this->registry array (since before you would override the previous object in registry because you'd set the new object on the same key - null).

You can also see the issue if you debug through the code:

Please let me know if this is not clear enough. I can try to explain better.

Related Pull Requests

• Not applicable, I think. I haven't seen a PR related to this.

Fixed Issues (if relevant)

• Not applicable, I think. I haven't seen an issue related to this.

Manual testing scenarios (*)

I'm not sure how to manually test this, since you'd have to write code to reproduce what I described in the scenario above. I don't know places in Magento 2 CE where that really happens.
We came across this issue while developing something custom.

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]

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

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, 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, join the Community Contributions Triage session to discuss the appropriate ticket.

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

[magento-automated-testing]

Failed to run the builds. Please try to re-run them later.

[ioiste]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[ioiste]

@magento run Functional Tests CE, Functional Tests EE

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.