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

Change right icon for the help site #14641

Merged
merged 4 commits into from
Feb 4, 2023
Merged

Conversation

marcochavezf
Copy link
Contributor

@marcochavezf marcochavezf commented Jan 27, 2023

Details

We want to reflect the correct UX for the action of the help site button which opens in a new browser tab. Context here.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/258498

Tests

  1. Open the Settings menu
  2. Verify the "Help" item has the correct icon to open an external resource (see screenshots).
  3. Open the menu of an existing workspace.
  4. Open the Get assistance page (Click on the "?" icon at the top of the page)
  5. Verify the "Explore help docs" item it also has the correct icon to open an external resource (see screenshots).
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Test steps.

  • 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 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 correct English and 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-01-27 at 16 31 53 Screenshot 2023-02-03 at 18 59 44
Mobile Web - Chrome Screenshot 2023-01-27 at 16 47 57 Screenshot 2023-02-03 at 19 01 56
Mobile Web - Safari Screenshot 2023-01-27 at 16 47 01 Screenshot 2023-02-03 at 19 01 02
Desktop Screenshot 2023-01-27 at 16 51 11 Screenshot 2023-02-03 at 19 04 01
iOS Screenshot 2023-01-27 at 16 43 33 Screenshot 2023-02-03 at 19 05 31
Android Screenshot 2023-01-27 at 16 57 46 Screenshot 2023-02-03 at 19 13 40

@marcochavezf marcochavezf requested a review from a team as a code owner January 27, 2023 22:00
@marcochavezf marcochavezf self-assigned this Jan 27, 2023
@melvin-bot melvin-bot bot requested review from mollfpr and puneetlath and removed request for a team January 27, 2023 22:00
@melvin-bot
Copy link

melvin-bot bot commented Jan 27, 2023

@mollfpr @puneetlath 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]

@marcochavezf
Copy link
Contributor Author

Unnassigning C+ since this is a small icon change

@marcochavezf marcochavezf removed the request for review from mollfpr January 27, 2023 22:03
@puneetlath
Copy link
Contributor

@marcochavezf I think it's fine to leave C+ assigned, even if for a small PR, unless it is super urgent. That way they can handle the all-device testing. Adding back @mollfpr.

puneetlath
puneetlath previously approved these changes Jan 28, 2023
@mollfpr
Copy link
Contributor

mollfpr commented Jan 29, 2023

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 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 correct English and 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Chrome Settings Page Chrome Get Assistance Page
14641 Web:Chrome - Settings page 14641 Web:Chrome - Get assistance page
Safari Settings Page Safari Get Assistance Page
14641 Web:Safari - Settings page 14641 Web:Safari - Get assistance page
Mobile Web - Chrome
Settings Page Get Assistance Page
14641 mWeb:Chrome - Settings page 14641 mWeb:Chrome - Get assistance page
Mobile Web - Safari
Settings Page Get Assistance Page
14641 mWeb:Safari - Settings page 14641 mWeb:Safari - Get assistance page
Desktop
Settings Page Get Assistance Page
14641 Desktop - Settings page 14641 Desktop - Get assistance page
iOS
Settings Page Get Assistance Page
14641 iOS - Settings page 14641 iOS - Get assistance page
Android
Settings Page Get Assistance Page
14641 Android - Settings page 14641 Android - Get assistance page

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that Schedule a setup call also opens a new window to a browser. Should we update the icon here, or it already has the correct icon?

Simulator.Screen.Recording.-.iPhone.13.-.2023-01-30.at.10.53.05.mp4

@puneetlath
Copy link
Contributor

Great catch. I would think we should update that here too.

@marcochavezf
Copy link
Contributor Author

Updated icon and screenshots 👍🏽

@puneetlath puneetlath merged commit 6a787ca into main Feb 4, 2023
@puneetlath puneetlath deleted the marco-changeHelpRightIcon branch February 4, 2023 20:37
@OSBotify
Copy link
Contributor

OSBotify commented Feb 4, 2023

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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2023

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
App start TTI 738.598 ms → 768.767 ms (+30.169 ms, +4.1%)
App start runJsBundle 204.387 ms → 209.935 ms (+5.548 ms, +2.7%)
Open Search Page TTI 587.777 ms → 589.133 ms (+1.356 ms, ±0.0%)
App start regularAppStart 0.016 ms → 0.018 ms (+0.002 ms, +12.2%)
App start nativeLaunch 19.903 ms → 19.690 ms (-0.214 ms, -1.1%)
Show details
Name Duration
App start TTI Baseline
Mean: 738.598 ms
Stdev: 27.054 ms (3.7%)
Runs: 679.9345870018005 688.3994619995356 694.695650998503 702.9165839999914 704.297175001353 714.7504520006478 718.7147909998894 721.186044998467 724.9001149982214 725.3299969993532 725.5920009985566 729.202459000051 729.2727660015225 733.8161740005016 740.2060410007834 741.2213100008667 746.5621519982815 750.2362530007958 750.4732160009444 750.7857690006495 751.482214000076 753.3083930015564 754.8399230018258 755.947868000716 760.2353999987245 762.4021040014923 767.2882549986243 767.7949150018394 774.4319900013506 787.4456189982593 788.8699540011585

Current
Mean: 768.767 ms
Stdev: 23.744 ms (3.1%)
Runs: 732.1260260008276 732.8232120014727 737.2986800000072 739.9553349986672 745.3053999990225 745.6141359992325 747.4452800005674 749.620668001473 753.1118119992316 753.7233319990337 753.8274139985442 756.824944999069 757.764240000397 762.1979629993439 762.9230719991028 765.4613489992917 766.5044229999185 767.4325559996068 772.6328720003366 773.8251280002296 776.0937420018017 776.7119660004973 777.5116400010884 785.8530509993434 786.1638449989259 786.8047760017216 790.13839700073 790.299387998879 800.5399140007794 804.8391290009022 822.3394090011716 826.8194740004838
App start runJsBundle Baseline
Mean: 204.387 ms
Stdev: 18.703 ms (9.2%)
Runs: 173 174 177 178 183 185 188 191 193 195 196 197 198 198 202 205 206 207 208 210 212 215 215 218 218 222 223 231 235 239 244

Current
Mean: 209.935 ms
Stdev: 15.326 ms (7.3%)
Runs: 182 188 190 192 192 193 194 195 198 201 203 206 209 209 209 210 210 212 215 216 216 217 219 219 221 223 223 230 232 232 252
Open Search Page TTI Baseline
Mean: 587.777 ms
Stdev: 23.756 ms (4.0%)
Runs: 548.1398109979928 556.5110270008445 558.4234619997442 561.9478770010173 561.9958499968052 563.6588540002704 569.8767900019884 571.054078001529 572.313110999763 573.4740400016308 573.6598310023546 577.780721001327 579.2724200002849 579.3649500012398 583.6175950020552 584.1939300000668 586.6742760017514 590.6789139993489 591.6131189987063 596.8023690022528 597.3611649982631 598.1294759996235 599.8515220023692 600.391561999917 600.7369790002704 600.7444659993052 609.6573080010712 618.1080729998648 618.2545989975333 644.4211019985378 652.3770759999752

Current
Mean: 589.133 ms
Stdev: 19.542 ms (3.3%)
Runs: 545.9030359983444 548.5070799998939 562.8731290027499 565.5608319975436 566.9646000005305 569.6590580008924 569.6612140014768 571.8789470009506 572.9490559995174 576.7926429994404 579.5736490003765 581.6879470013082 584.6692709997296 585.3473719991744 585.3981119990349 588.7771410010755 590.2775069996715 596.2372239977121 596.8434249982238 597.344319999218 599.2344569973648 599.8113609999418 600.2580979987979 600.3870849981904 601.5507820025086 603.1189780011773 609.7368570007384 610.0137939974666 610.836872998625 612.4132089987397 614.186686001718 614.6021329984069 628.3268229998648
App start regularAppStart Baseline
Mean: 0.016 ms
Stdev: 0.001 ms (7.3%)
Runs: 0.013754002749919891 0.013835001736879349 0.013874996453523636 0.014159999787807465 0.014566998928785324 0.014974001795053482 0.015015002340078354 0.015055999159812927 0.015096001327037811 0.015137001872062683 0.015381000936031342 0.015543997287750244 0.015706997364759445 0.0157880000770092 0.0157880000770092 0.016112998127937317 0.01619500294327736 0.016275998204946518 0.016275998204946518 0.016316000372171402 0.016520000994205475 0.016642000526189804 0.016805000603199005 0.016968000680208206 0.017089001834392548 0.01729300245642662 0.017455998808145523 0.017496999353170395 0.017496999353170395 0.017537999898195267 0.01757900044322014

Current
Mean: 0.018 ms
Stdev: 0.001 ms (7.9%)
Runs: 0.015299998223781586 0.015828996896743774 0.016357000917196274 0.01643899828195572 0.016600999981164932 0.016642000526189804 0.01676500216126442 0.016805000603199005 0.01684499904513359 0.01688600331544876 0.016927000135183334 0.01725200191140175 0.017333999276161194 0.017333999276161194 0.01741599664092064 0.017537999898195267 0.017618998885154724 0.01786300167441368 0.01794400066137314 0.017944999039173126 0.018066998571157455 0.018230002373456955 0.018596000969409943 0.018880002200603485 0.019043002277612686 0.019043002277612686 0.019368000328540802 0.019409000873565674 0.019491001963615417 0.019531000405550003 0.02071099728345871 0.022012997418642044
App start nativeLaunch Baseline
Mean: 19.903 ms
Stdev: 1.399 ms (7.0%)
Runs: 18 18 18 18 18 18 19 19 19 19 19 19 19 20 20 20 20 20 20 20 21 21 21 21 21 21 21 21 22 23 23

Current
Mean: 19.690 ms
Stdev: 1.054 ms (5.4%)
Runs: 18 18 18 19 19 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 20 20 20 21 21 21 21 22 22

@mollfpr
Copy link
Contributor

mollfpr commented Feb 5, 2023

@marcochavezf @puneetlath Sorry, I just have time to take this, and thanks to @puneetlath for taking care 🙏

@OSBotify
Copy link
Contributor

OSBotify commented Feb 6, 2023

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.2.66-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.2.66-0 🚀

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

@mollfpr
Copy link
Contributor

mollfpr commented Feb 16, 2023

@puneetlath Could you help to create the E/App issue for payment? I'm not sure why the bot not creating the E/App issue this time. Thanks!

@mollfpr
Copy link
Contributor

mollfpr commented Feb 20, 2023

Bump @puneetlath for the above comment; thank you!

@puneetlath
Copy link
Contributor

Thanks for the bump. Created the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants