#16273: Fix bug in method getUrlInStore() of product model

[vasilii-b]

Description

This PR reference changes how/what is returned when product model method getUrlInStore() is called $product->getUrlInStore().
Problem is in how the current store is checked and what is returned based on it.

Fixed Issues

1. Method $product->getUrlInStore() returning extremely long URLs, could be a bug #16273
2. Having set Add store code to URLs in Admin Configuration to NO, store code is still shown in the product URL.

Manual testing scenarios

For issue 1 - please see the issue description.
For issue 2:

1. Go to Admin -> Stores -> Configuration -> Catalog -> Web -> Url Options -> Add Store Code to Urls and set it to NO.
2. In some .phtml file, list.phtml for example, call method getUrlInStore() for a product.

Expected Result

Store code is not added into product url

https://www.domain.com/my-product.html

Actual Result

Store code is added into product url

https://www.domain.com/my-product.html?___store=default

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 on Travis CI are green)

[magento-engcom-team]

Hi @vasilii-b. 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-engcom-team give me test instance - deploy test instance based on PR changes
• @magento-engcom-team give me {$VERSION} instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

[ishakhsuvarov]

Would it make sense to check for StoreInterface in this case?

[hostep]

@vasilii-b : correct me if I'm wrong, but the setting Add store code to URLs means:
domain-name/default/my-product.html

not:
domain-name/my-product.html ?___store=default

Although it's indeed incorrect that it adds that suffix to the url, but it is probably unrelated to the setting Add store code to URLs, but I'm not 100% sure...

UPDATE: nevermind me, I think I understand what's happening, please ignore this post ;)

[vasilii-b]

@ishakhsuvarov , can you please have a look on this one ? Requested changes were added.
Thank you!

[magento-engcom-team]

Hi @vasilii-b. Thank you for your contribution.
We will aim to release these changes as part of 2.2.6.
Please check the release notes for final confirmation.

Please, consider to port this solution to 2.3 release line.
You may use Porting tool to port commits automatically.