#29721 :- Logo is always 170 pixels wide, regardless of actual size #29746

konarshankar07 · 2020-08-26T06:08:46Z

Description (*)

This PR will fix the issue with the logo width if the logo width is added from the design configuration

Related Pull Requests

Fixed Issues (if relevant)

Fixes Logo is always 170 pixels wide, regardless of actual size #29721

Manual testing scenarios (*)

Login to Admin
Content -> Configuration -> Global -> Edit -> Header
Upload 800x300 example logo image (attached to issue)
Enter 800 in Logo Attribute Width
Enter 300 in Logo Attribute Height
Save Configuration
Clear cache
Go to frontend and inspect logo dimensions

Expected Result

Logo is 800 pixels wide

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)
All automated tests passed successfully (all builds are green)

…ration

m2-assistant · 2020-08-26T06:08:49Z

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

konarshankar07 · 2020-08-26T06:09:03Z

@magento run all tests

lbajsarowicz

Just 2 minor adjustments.

lbajsarowicz · 2020-08-26T08:43:13Z

app/code/Magento/Theme/Block/Html/Header/Logo.php

+            'design/header/logo_width',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
+        return $logoWidth ? (int) $logoWidth : $this->_data['logo_width'];


Isn't that better to cast type to int for whole line just in case there's string in _data?

lbajsarowicz · 2020-08-26T08:43:31Z

app/code/Magento/Theme/Block/Html/Header/Logo.php

+     * Retrieve logo width
+     * @return int
+     */
+    public function getLogoImageWidth()


Can we use type hint for method?

konarshankar07 · 2020-08-26T11:19:08Z

@magento run all tests

konarshankar07 · 2020-08-26T12:29:07Z

@magento run all tests

mrtuvn · 2020-08-26T14:03:43Z

app/code/Magento/Theme/Block/Html/Header/Logo.php

+     *
+     * @return int
+     */
+    public function getLogoImageWidth() :int


should we change it to getLogoImageWidth(): int instead of getLogoImageWidth() :int

As far as I know - the standard says about : int.

@lbajsarowicz is right and its mentioned in the PSR-12

For more information :- https://www.php-fig.org/psr/psr-12/
But I don't know that we started following the PSR-12 standards?

PSR-12 is in the works: magento/architecture#225 & magento/magento-coding-standard#128

lbajsarowicz

Just two minor things :)

➕ Return value of Magento\Theme\Block\Html\Header\Logo::getLogoImageWidth() must be of the type int, string returned - Change the implementation to return int values (the parenthesis has to be around the value)

lbajsarowicz · 2020-08-27T07:17:27Z

app/code/Magento/Theme/Test/Unit/Block/Html/Header/LogoTest.php

+    public function testGetLogoImageWidth()
+    {
+        $scopeConfigWithLogoWidthArgument = $this->getMockForAbstractClass(ScopeConfigInterface::class);
+        $scopeConfigWithLogoWidthArgument->expects($this->any())->method('getValue')->willReturn(null);
+
+        $scopeConfigWithoutLogoWidthArgument = $this->getMockForAbstractClass(ScopeConfigInterface::class);
+        $scopeConfigWithoutLogoWidthArgument->expects($this->once())->method('getValue')->willReturn(800);
+
+        $objectManager = new ObjectManager($this);
+        $argumentsWithLogoWidth = [
+            'scopeConfig' => $scopeConfigWithLogoWidthArgument,
+            '_data' => [
+                'logo_width' => 200
+            ]
+        ];
+        $blockWithLogoWidthArgument = $objectManager->getObject(Logo::class, $argumentsWithLogoWidth);
+
+        $this->assertEquals('200', $blockWithLogoWidthArgument->getLogoWidth());
+
+        $argumentsWithoutLogoWidth = [
+            'scopeConfig' => $scopeConfigWithoutLogoWidthArgument
+        ];
+        $blockWithoutLogoWidthArgument = $objectManager->getObject(Logo::class, $argumentsWithoutLogoWidth);
+
+        $this->assertEquals('800', $blockWithoutLogoWidthArgument->getLogoWidth());
+    }


Could you split that test into 2:

testGetLogoImageWidthWhenImageWidthConfigured

testGetLogoImageWidthWhenImageWidthNotConfigured

That gives us 2 benefits:

When it fails - we exactly know which case fails

The test is easier to read and understand.

You can additionally split that into sections:

// Given - The environmental / mocked elements (eg. ScopeConfig)

// When - The call to tested method

// Then - Assertions (comparison of expected to actual results)

lbajsarowicz · 2020-08-27T07:18:30Z

app/code/Magento/Theme/Block/Html/Header/Logo.php

+    {
+        $logoWidth = $this->_scopeConfig->getValue(
+            'design/header/logo_width',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE


Let's import class there and make it inline.

JosephLeedy · 2020-08-28T18:58:05Z

I'm getting an error stating that getImageLogoWidth() tried to return a string instead of an integer. The following change resolved it:

-        return (int)$logoWidth ? $logoWidth : $this->_data['logo_width'];
+        return (int)($logoWidth ? $logoWidth : $this->_data['logo_width']);

lbajsarowicz · 2020-08-28T19:50:38Z

@JosephLeedy That was exactly what I thought saying: "Change the implementation to return int values (the parenthesis has to be around the value)" Thanks!

konarshankar07 · 2020-08-29T11:29:32Z

@magento run all tests

konarshankar07 · 2020-09-07T04:44:26Z

@magento run all tests

gabrieldagama · 2020-09-07T12:48:43Z

The risk was set tolow due to: the suggested changes shouldn't impact other areas.

sidolov · 2020-09-09T17:32:57Z

@konarshankar07 please, take a look at the review comments! Thanks!

konarshankar07 · 2020-09-10T05:10:37Z

Hello @sidolov ..
I already addressed the review changes
Thanks

lbajsarowicz

✔️ Thanks for the Contribution.

magento-engcom-team · 2020-09-11T06:37:15Z

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

engcom-Bravo · 2020-09-23T10:13:07Z

✔️ QA Passed

Manual testing scenario:

Login to Admin
Content -> Configuration -> Global -> Edit -> Header
Upload 800x300 example logo image (attached to issue)
Enter 800 in Logo Attribute Width
Enter 300 in Logo Attribute Height
Save Configuration
Clear cache
Go to frontend and inspect logo dimensions

Result AFTER switching to PR

❌ Result BEFORE switching to PR

Checked also on Blank theme

engcom-Foxtrot · 2020-09-23T11:19:15Z

SVC failure should be approved.

Pull Request state was updated. Re-review required.

oviliz · 2020-11-04T12:14:11Z

Oh dear... :(

denchev · 2020-12-02T08:18:28Z

I see the issue is fixed upstream and will eventually be widely available but in the meantime, I want to post a workaround for people who can't wait or cannot afford to upgrade.

Create (if you don't have it) a file "app/design/frontend/Vendor/Theme/Magento_Theme/layout/default.xml"
Add the following code within the tag:
<referenceBlock name="logo"> <arguments> <argument name="logo_width" xsi:type="number">0</argument> </arguments> </referenceBlock>

This will force the getLogoWidth() check to start working.

puntable · 2021-02-01T14:17:33Z

I see the issue is fixed upstream and will eventually be widely available but in the meantime, I want to post a workaround for people who can't wait or cannot afford to upgrade.

Create (if you don't have it) a file "app/design/frontend/Vendor/Theme/Magento_Theme/layout/default.xml"

Add the following code within the tag:
<referenceBlock name="logo"> <arguments> <argument name="logo_width" xsi:type="number">0</argument> </arguments> </referenceBlock>

This will force the getLogoWidth() check to start working.

If you have multiple sites using the same theme, but with different logo size, you have a problem...

mrtuvn · 2021-06-19T03:54:18Z

4531c76
Seem issue already resolved internals by adobe. The fix already delivered to 2.4-develop branch. Not only storefront but also in logo email
CC: @konarshankar07 @gwharton
Also anyone involed in this topics

tuna2smc · 2021-09-06T17:05:56Z

e1aaf74
Can you check your work with this latest update in commit
@konarshankar07

Fixed the logo width issue and width is taken from the design configu…

9d84f20

…ration

magento-engcom-team added Area: Frontend Component: Theme labels Aug 26, 2020

magento-engcom-team added the Release Line: 2.4 label Aug 26, 2020

ghost added the Progress: pending review label Aug 26, 2020

lbajsarowicz suggested changes Aug 26, 2020

View reviewed changes

ghost assigned lbajsarowicz Aug 26, 2020

ghost added Progress: needs update and removed Progress: pending review labels Aug 26, 2020

Feedback changes

a81b281

Fixed static tests

c03793f

mrtuvn reviewed Aug 26, 2020

View reviewed changes

sidolov added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Aug 26, 2020

Type hint standard followed

a008c22

konarshankar07 requested a review from lbajsarowicz August 27, 2020 06:57

lbajsarowicz suggested changes Aug 27, 2020

View reviewed changes

Feedback changes

7288f02

gabrieldagama added the Risk: low label Sep 7, 2020

konarshankar07 requested a review from lbajsarowicz September 11, 2020 05:10

lbajsarowicz previously approved these changes Sep 11, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Sep 11, 2020

engcom-Bravo self-assigned this Sep 23, 2020

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

engcom-Bravo added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Progress: ready for testing and removed Progress: testing in progress labels Sep 23, 2020

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

ghost added Progress: extended testing and removed Progress: ready for testing labels Sep 23, 2020

engcom-Foxtrot self-assigned this Sep 23, 2020

ghost added Progress: to approve and removed Progress: extended testing labels Sep 23, 2020

konarshankar07 mentioned this pull request Oct 26, 2020

Logo is always 170 pixels wide, regardless of actual size #29721

Closed

5 tasks

m2-community-project bot added Progress: review and removed Progress: to approve labels Nov 13, 2020

konarshankar07 closed this Dec 29, 2022

m2-community-project bot removed the Progress: review label Dec 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#29721 :- Logo is always 170 pixels wide, regardless of actual size #29746

#29721 :- Logo is always 170 pixels wide, regardless of actual size #29746

konarshankar07 commented Aug 26, 2020

m2-assistant bot commented Aug 26, 2020

konarshankar07 commented Aug 26, 2020

lbajsarowicz left a comment

lbajsarowicz Aug 26, 2020

lbajsarowicz Aug 26, 2020

konarshankar07 commented Aug 26, 2020

konarshankar07 commented Aug 26, 2020

mrtuvn Aug 26, 2020

lbajsarowicz Aug 26, 2020

konarshankar07 Aug 27, 2020

hostep Aug 27, 2020

lbajsarowicz left a comment •

edited

Loading

lbajsarowicz Aug 27, 2020

lbajsarowicz Aug 27, 2020

JosephLeedy commented Aug 28, 2020

lbajsarowicz commented Aug 28, 2020

konarshankar07 commented Aug 29, 2020

konarshankar07 commented Sep 7, 2020

gabrieldagama commented Sep 7, 2020

sidolov commented Sep 9, 2020

konarshankar07 commented Sep 10, 2020

lbajsarowicz left a comment

magento-engcom-team commented Sep 11, 2020

engcom-Bravo commented Sep 23, 2020

engcom-Foxtrot commented Sep 23, 2020

oviliz commented Nov 4, 2020

denchev commented Dec 2, 2020

puntable commented Feb 1, 2021

mrtuvn commented Jun 19, 2021 •

edited

Loading

tuna2smc commented Sep 6, 2021

#29721 :- Logo is always 170 pixels wide, regardless of actual size #29746

#29721 :- Logo is always 170 pixels wide, regardless of actual size #29746

Conversation

konarshankar07 commented Aug 26, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Expected Result

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Aug 26, 2020

konarshankar07 commented Aug 26, 2020

lbajsarowicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

konarshankar07 commented Aug 26, 2020

konarshankar07 commented Aug 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbajsarowicz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JosephLeedy commented Aug 28, 2020

lbajsarowicz commented Aug 28, 2020

konarshankar07 commented Aug 29, 2020

konarshankar07 commented Sep 7, 2020

gabrieldagama commented Sep 7, 2020

sidolov commented Sep 9, 2020

konarshankar07 commented Sep 10, 2020

lbajsarowicz left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Sep 11, 2020

engcom-Bravo commented Sep 23, 2020

Manual testing scenario:

engcom-Foxtrot commented Sep 23, 2020

oviliz commented Nov 4, 2020

denchev commented Dec 2, 2020

puntable commented Feb 1, 2021

mrtuvn commented Jun 19, 2021 • edited Loading

tuna2smc commented Sep 6, 2021

lbajsarowicz left a comment •

edited

Loading

mrtuvn commented Jun 19, 2021 •

edited

Loading