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

[Issue] Fix incorrect return type for getOptionByCode method #39404

Open
5 tasks
m2-assistant bot opened this issue Nov 26, 2024 · 4 comments · May be fixed by #39389
Open
5 tasks

[Issue] Fix incorrect return type for getOptionByCode method #39404

m2-assistant bot opened this issue Nov 26, 2024 · 4 comments · May be fixed by #39389
Assignees
Labels
Area: Framework Component: Quote Component: Wishlist Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@m2-assistant
Copy link

m2-assistant bot commented Nov 26, 2024

This issue is automatically created based on existing pull request: #39389: Fix incorrect return type for getOptionByCode method


Description (*)

I've noticed that \Magento\Catalog\Model\Product\Configuration\Item\ItemInterface::getOptionByCode return type is defined as object all the time:

/**
* Get item option by code
*
* @param string $code
* @return \Magento\Catalog\Model\Product\Configuration\Item\Option\OptionInterface
*/
public function getOptionByCode($code);

However, this interface implements 3 classes, and each of them returns object OR null, so it's a bug in the method definition on interface:

  • /**
    * @inheritdoc
    * @since 101.1.1
    */
    public function getOptionByCode($code)
    {
    if ($this->getQuoteItem()) {
    return $this->getQuoteItem()->getOptionBycode($code);
    }
    return null;
    }
  • /**
    * Get item option by code
    *
    * @param string $code
    * @return \Magento\Quote\Model\Quote\Item\Option || null
    */
    public function getOptionByCode($code)
    {
    if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
    return $this->_optionsByCode[$code];
    }
    return null;
    }
  • /**
    * Get item option by code
    *
    * @param string $code
    * @return Option|null
    */
    public function getOptionByCode($code)
    {
    if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
    return $this->_optionsByCode[$code];
    }
    return null;
    }

This pull request fixes incorrect phpdoc block, which leads to confusion, which leads to bugs during development

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

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)
  • 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 m2-assistant bot linked a pull request Nov 26, 2024 that will close this issue
6 tasks
@github-project-automation github-project-automation bot moved this to Ready for Confirmation in Issue Confirmation and Triage Board Nov 26, 2024
@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 Nov 26, 2024
@engcom-Hotel engcom-Hotel added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Nov 27, 2024
@engcom-Hotel engcom-Hotel added Reported on 2.4.x Indicates original Magento version for the Issue report. and removed Progress: PR in progress labels Nov 27, 2024
@engcom-Hotel engcom-Hotel self-assigned this Nov 27, 2024
Copy link
Author

m2-assistant bot commented Nov 27, 2024

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
  • 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
  • 4. Verify that the issue is reproducible on 2.4-develop branch
    Details- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
  • 5. Add label Issue: Confirmed once verification is complete.
  • 6. Make sure that automatic system confirms that report has been added to the backlog.

Sorry, something went wrong.

@engcom-Hotel
Copy link
Contributor

Hello @ihor-sviziev,

Thanks for the report and collaboration!

We are confirming the issue by looking at the code in the 2.4-develop branch.

Thanks

@engcom-Hotel engcom-Hotel added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Component: Quote Component: Wishlist Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework and removed Issue: ready for confirmation labels Nov 27, 2024
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-13424 is successfully created for this GitHub issue.

Copy link
Author

m2-assistant bot commented Nov 27, 2024

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Component: Quote Component: Wishlist Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants