fix: icon not set when adding bookmark to iOS home screen #21856

eh2077 · 2023-06-29T09:18:55Z

Details

Fixed Issues

$ #21064
PROPOSAL: #21064 (comment)

Tests

Navigate to https://new.expensify.com/ in iOS Safari
Tap on share icon from toolbar
Select Add to Home Screen option
Tap Add on the following screen
Verify Expensify icon that gets added to Home Screen
Click the icon bookmark just added from Home Screen
Verify that it open https://new.expensify.com/ in iOS Safari
Repeat 1-7 on Android Chrome.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as test

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

N/A

Mobile Web - Chrome

mobile-chrome.mp4

Mobile Web - Safari

mobile-safari.mp4

Desktop

N/A

iOS

N/A

Android

N/A

melvin-bot · 2023-06-29T09:19:00Z

@shawnborton @mollfpr One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mollfpr · 2023-06-29T18:34:19Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Screen_Recording_20230706_024331_One.UI.Home.mp4

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-07-06.at.02.35.27.mp4

Desktop

iOS

Android

mollfpr · 2023-06-30T02:47:50Z

@eh2077 The icon for mWeb/Chrome added to the home screen is square instead of rounded.

untitled.webm

eh2077 · 2023-06-30T04:10:48Z

@mollfpr Thanks for checking it on mobile Chrome. But I can't reproduce it on mobile Chrome, see below video

mobile-chrome.mp4

From my emulator, the preview icon is round, see below screenshots

Dev	Staging

Did you use the icon provided here and rebuild(Cmd + c to exit the process and run npm run web again) the project?

mollfpr · 2023-06-30T16:35:35Z

Screen.Recording.2023-06-30.at.23.33.52.mov

Here's what I commented on the apple-touch-icon link, and it works. I also check on the real device have the same behavior.

eh2077 · 2023-06-30T16:57:07Z

That's so strange. I still can't reproduce it.

Below is my emulator setting

Do you test on the same branch of this PR? Or can you share the branch you're testing?

Let me setup another emulator using Pixel 5 and API 33 and try to reproduce it.

mollfpr · 2023-06-30T16:59:39Z

I'm checkout to this PR with GH CLI.

eh2077 · 2023-06-30T17:03:25Z

Still can't reproduce it on emulator of Pixel 5 API 33

mollfpr · 2023-06-30T17:21:34Z

@marcochavezf Could you help us here to check whether the icon on adding the page to the home screen is displayed correctly like on the staging? Thanks!

eh2077 · 2023-07-01T05:41:56Z

@mollfpr Would you mind testing with following changes on your env?

<link rel="icon" id="favicon" sizes="any" href="/favicon.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">

I still can’t reproduce it but I guess it's related to the legacy usage of rel="shortcut icon".

It looks like rel="shortcut icon" is not recommended for modern browsers and it's recommended to use rel="icon", see rel="shortcut icon" considered harmful and How to Favicon in 2023: Six files that fit most needs FYI.

mollfpr · 2023-07-03T03:40:35Z

Screen.Recording.2023-07-03.at.10.19.16.mp4

@eh2077 It's still reproducing even after I clean up the project.

eh2077 · 2023-07-03T04:05:06Z

@mollfpr Could you update your Chrome and test with property sizes="any" added again? I had experienced other weird issues on outdated Chrome before. ChatGPT tells me that Chrome possibly reads icon from meta tag <link rel="apple-touch-icon"> if it can't find the proper icon 🤔 but I think, in this case, the Chrome should be able to find the right icon?

eh2077 · 2023-07-04T10:02:00Z

Friendly bump @mollfpr on #21856 (comment)

mollfpr · 2023-07-05T16:46:18Z

Sorry for the delay! It's still resulting in the same.

ChatGPT tells me that Chrome possibly reads icon from meta tag if it can't find the proper icon

Is there any information on what the proper icon is?

Although, the result in my phone is not too noticeable, and the icon on my home screen is not round like in the simulator.

Screen_Recording_20230705_234057_One.UI.Home.mp4

@shawnborton Could you help confirm if the icon in the above video for Android is okay? Where is previously the icon that shows in Android was the favicon.

shawnborton · 2023-07-05T18:30:42Z

I think that looks good to me.

mollfpr

Thanks for confirming it @shawnborton ❤️

@eh2077 Let's add test for mWeb/chrome too in the test case.

eh2077 · 2023-07-05T23:29:26Z

@eh2077 Let's add test for mWeb/chrome too in the test case.

Added!

eh2077 · 2023-07-06T15:52:41Z

Friendly @marcochavezf

marcochavezf

Thanks guys, love the "Look Gorilla To Me" 😆

OSBotify · 2023-07-06T23:53:02Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-07-07T10:43:54Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.38-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-07-10T23:58:56Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

fix icon not set when adding bookmark to iOS home screen

d9a4620

eh2077 requested a review from a team as a code owner June 29, 2023 09:18

melvin-bot bot requested review from mollfpr and shawnborton and removed request for a team June 29, 2023 09:18

shawnborton approved these changes Jun 29, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Jun 30, 2023

[Snyk] Fix for 3 vulnerabilities #21425

Closed

57 tasks

eh2077 mentioned this pull request Jul 4, 2023

[HOLD for payment 2023-07-17] [$1000] IOS - Icon is not set when https://new.expensify.com is added to home screen on iOS devices #21064

Closed

6 tasks

mollfpr approved these changes Jul 5, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf July 5, 2023 19:48

marcochavezf approved these changes Jul 6, 2023

View reviewed changes

marcochavezf merged commit 22467c1 into Expensify:main Jul 6, 2023

OSBotify mentioned this pull request Jul 7, 2023

Deploy Checklist: New Expensify 2023-07-07 #22399

Closed

64 tasks

MelvinBot mentioned this pull request Jul 8, 2023

[Snyk] Fix for 1 vulnerabilities #22462

Closed

58 tasks

melvin-bot bot mentioned this pull request Jul 8, 2023

[HOLD for payment 2023-08-17] [Snyk] Fix for 1 vulnerabilities #22463

Closed

melvin-bot bot mentioned this pull request Jul 17, 2023

[Snyk] Fix for 3 vulnerabilities #21426

Closed

MelvinBot mentioned this pull request Jan 29, 2024

[Snyk] Fix for 25 vulnerabilities #35341

Closed

50 tasks

melvin-bot bot mentioned this pull request Jan 29, 2024

[Snyk] Fix for 25 vulnerabilities #35342

Closed

MelvinBot mentioned this pull request Feb 12, 2024

[Snyk] Security upgrade @storybook/react from 6.5.10 to 7.0.0 #36331

Closed

50 tasks

melvin-bot bot mentioned this pull request Feb 12, 2024

[Snyk] Security upgrade @storybook/react from 6.5.10 to 7.0.0 #36332

Closed

MelvinBot mentioned this pull request Mar 14, 2024

[Snyk] Fix for 3 vulnerabilities #38311

Closed

50 tasks

melvin-bot bot mentioned this pull request Mar 14, 2024

[Snyk] Fix for 3 vulnerabilities #38312

Closed

MelvinBot mentioned this pull request Mar 22, 2024

[Snyk] Security upgrade @storybook/react from 6.5.10 to 7.0.0 #38809

Closed

50 tasks

melvin-bot bot mentioned this pull request Mar 22, 2024

[Snyk] Security upgrade @storybook/react from 6.5.10 to 7.0.0 #38810

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: icon not set when adding bookmark to iOS home screen #21856

fix: icon not set when adding bookmark to iOS home screen #21856

eh2077 commented Jun 29, 2023 •

edited

Loading

melvin-bot bot commented Jun 29, 2023

mollfpr commented Jun 29, 2023 •

edited

Loading

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jul 1, 2023

mollfpr commented Jul 3, 2023

eh2077 commented Jul 3, 2023

eh2077 commented Jul 4, 2023

mollfpr commented Jul 5, 2023

shawnborton commented Jul 5, 2023

mollfpr left a comment

eh2077 commented Jul 5, 2023

eh2077 commented Jul 6, 2023

marcochavezf left a comment

OSBotify commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 10, 2023

fix: icon not set when adding bookmark to iOS home screen #21856

fix: icon not set when adding bookmark to iOS home screen #21856

Conversation

eh2077 commented Jun 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 29, 2023

mollfpr commented Jun 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jun 30, 2023

mollfpr commented Jun 30, 2023

eh2077 commented Jul 1, 2023

mollfpr commented Jul 3, 2023

eh2077 commented Jul 3, 2023

eh2077 commented Jul 4, 2023

mollfpr commented Jul 5, 2023

shawnborton commented Jul 5, 2023

mollfpr left a comment

Choose a reason for hiding this comment

eh2077 commented Jul 5, 2023

eh2077 commented Jul 6, 2023

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 10, 2023

eh2077 commented Jun 29, 2023 •

edited

Loading

mollfpr commented Jun 29, 2023 •

edited

Loading