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

Inconsistent return type for getStoreId() #18079

Closed
sreichel opened this issue Sep 16, 2018 · 6 comments
Closed

Inconsistent return type for getStoreId() #18079

sreichel opened this issue Sep 16, 2018 · 6 comments
Labels
Component: Catalog Fixed in 2.2.x The issue has been fixed in 2.2 release line Fixed in 2.3.x The issue has been fixed in 2.3 release line Issue: Clear Description Gate 2 Passed. Manual verification of the issue description passed Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development Reproduced on 2.2.x The issue has been reproduced on latest 2.2 release Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release

Comments

@sreichel
Copy link
Contributor

sreichel commented Sep 16, 2018

Summary

  • Magento 2.*
  • PHP7.1
  • using strict type decalaration

getStoreId() returns a string for products, but int for categories that causes a fatal error in extensions code.

Examples

Simplified code:

ObserverA:

https://github.com/magento/magento2/blob/2.3-develop/app/code/Magento/Catalog/Model/Product.php#L521-L532

$product = $observer->getProduct();
$storeId = $product->getStoreId();
$result = $this->someMethod($storeId);

ObserverB:

https://github.com/magento/magento2/blob/2.3-develop/app/code/Magento/Catalog/Model/Category.php#L560-L573

$category = $observer->getCategory();
$storeId = $category->getStoreId();
$result = $this->someMethod($storeId);

Shared method

public funtion someMethod(int $storeId)

If i pass products store ID to someMethod i get a fatal error.

Proposed solution

  1. cast return type to int in product model
  2. check all (80) getStoreId() methods to return always int value

Would create PR for "1." since I#ve not enough time to check all others.

Please advice.

@magento-engcom-team
Copy link
Contributor

magento-engcom-team commented Sep 16, 2018

Hi @sreichel. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

  • Summary of the issue
  • Information on your environment
  • Steps to reproduce
  • Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me $VERSION instance

where $VERSION is version tags (starting from 2.2.0+) or develop branches (for example: 2.3-develop).
For more details, please, review the Magento Contributor Assistant documentation.

@sreichel do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

  • yes
  • no

@magento-engcom-team magento-engcom-team added the Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed label Sep 16, 2018
sreichel added a commit to sreichel/magento2 that referenced this issue Sep 16, 2018
@ghost ghost added the Issue: Clear Description Gate 2 Passed. Manual verification of the issue description passed label Sep 17, 2018
@ghost ghost self-assigned this Sep 17, 2018
@magento-engcom-team
Copy link
Contributor

magento-engcom-team commented Sep 17, 2018

Hi @engcom-backlog-nazar. 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).

    DetailsIf the issue has a valid description, the label G1 Passed will be added to the issue automatically. Please, edit issue description if needed, until label G1 Passed appears.

  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add G2 Passed label to the issue by yourself.

  • 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

  • 4. Verify that the issue is reproducible on 2.3-develop branch

    Details- Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.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. Verify that the issue is reproducible on 2.2-develop branch.

    Details- Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

  • 6. Add label acknowledged once verification is complete.

  • 7. Make sure that automatic system confirms that report is acknowledged.

@ghost ghost added Reproduced on 2.2.x The issue has been reproduced on latest 2.2 release Component: Catalog Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development labels Sep 17, 2018
@magento-engcom-team
Copy link
Contributor

@engcom-backlog-nazar Thank you for verifying the issue. Based on the provided information internal tickets MAGETWO-95051, MAGETWO-95052 were created

@ghost ghost removed their assignment Sep 17, 2018
@ghost
Copy link

ghost commented Sep 17, 2018

Hi @sreichel , thank you for your report.
We've acknowledge the issue and added to our backlog.

@magento-engcom-team magento-engcom-team added the Fixed in 2.2.x The issue has been fixed in 2.2 release line label Sep 28, 2018
@magento-engcom-team
Copy link
Contributor

Hi @sreichel. Thank you for your report.
The issue has been fixed in #18086 by @sreichel in 2.2-develop branch
Related commit(s):

The fix will be available with the upcoming 2.2.8 release.

magento-engcom-team added a commit that referenced this issue Sep 28, 2018
 - Merge Pull Request #18086 from sreichel/magento2:develop/fix-getStoreId
 - Merged commits:
   1. 9d8b04a
@slavvka
Copy link
Member

slavvka commented Oct 3, 2018

Hi @sreichel. Thank you for your report.
The issue has been fixed in #18303 by @sreichel in 2.3-develop branch
Related commit(s):

The fix will be available with the upcoming 2.3.1 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Catalog Fixed in 2.2.x The issue has been fixed in 2.2 release line Fixed in 2.3.x The issue has been fixed in 2.3 release line Issue: Clear Description Gate 2 Passed. Manual verification of the issue description passed Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development Reproduced on 2.2.x The issue has been reproduced on latest 2.2 release Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release
Projects
None yet
Development

No branches or pull requests

3 participants