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

Add link to NewHelp #13898

Merged
merged 10 commits into from
Jan 14, 2023
Merged

Add link to NewHelp #13898

merged 10 commits into from
Jan 14, 2023

Conversation

marcochavezf
Copy link
Contributor

@marcochavezf marcochavezf commented Dec 30, 2022

Details

Add link to NewHelp site from Settings page and Get assistance page.

Fixed Issues

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

Tests

  1. Open Settings menu
  2. Click on "Help" item and verify it opens the site https://help.expensify.com/
  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. Click on "Explore help docs" item and verify it also opens the site https://help.expensify.com/
  • 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
    • 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
Screen.Recording.2023-01-09.at.17.40.34.mov
Mobile Web - Chrome
Screen.Recording.2023-01-09.at.17.45.57.mov
Mobile Web - Safari
Screen.Recording.2023-01-09.at.17.46.58.mov
Desktop
Screen.Recording.2023-01-09.at.17.49.06.mov
iOS
Screen.Recording.2023-01-09.at.17.57.53.mov
Android
Screen.Recording.2023-01-09.at.17.56.56.mov

@marcochavezf marcochavezf self-assigned this Dec 30, 2022
@marcochavezf marcochavezf changed the title [WIP] Add link to NewHelp Add link to NewHelp Jan 10, 2023
@marcochavezf marcochavezf marked this pull request as ready for review January 10, 2023 00:03
@marcochavezf marcochavezf requested a review from a team as a code owner January 10, 2023 00:03
@melvin-bot melvin-bot bot requested review from ctkochan22 and eVoloshchak and removed request for a team January 10, 2023 00:03
@melvin-bot
Copy link

melvin-bot bot commented Jan 10, 2023

@eVoloshchak @ctkochan22 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

@ctkochan22 @eVoloshchak could you complete the PR Reviewer checklist to pass the GH checks?

@ctkochan22
Copy link
Contributor

@eVoloshchak you have time to do the checklist?

@eVoloshchak
Copy link
Contributor

@eVoloshchak you have time to do the checklist?

I will be able to do that in ±12 hours, would that be ok?

@eVoloshchak
Copy link
Contributor

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
Screen.Recording.2023-01-14.at.12.41.18.mov
Mobile Web - Chrome
Screen_Recording_20230114-165733_Chrome.mp4
Mobile Web - Safari
Screen.Recording.2023-01-14.at.16.56.59.mov
Desktop
Screen.Recording.2023-01-14.at.12.42.16.mov
iOS
Screen.Recording.2023-01-14.at.16.56.35.mov
Android
Screen_Recording_20230114-165515_Chrome.mp4

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

LGTM

@marcochavezf
Copy link
Contributor Author

Thank you guys! I'm going to merge it now

@marcochavezf marcochavezf merged commit f3600bf into main Jan 14, 2023
@marcochavezf marcochavezf deleted the marco-addNewHelpLink branch January 14, 2023 16:30
@github-actions
Copy link
Contributor

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
Open Search Page TTI 613.753 ms → 617.233 ms (+3.479 ms, +0.6%)
App start nativeLaunch 21.143 ms → 21.750 ms (+0.607 ms, +2.9%)
App start regularAppStart 0.019 ms → 0.019 ms (+0.000 ms, +1.5%)
App start TTI 639.883 ms → 636.456 ms (-3.428 ms, -0.5%)
App start runJsBundle 172.500 ms → 168.967 ms (-3.533 ms, -2.0%)
Show details
Name Duration
Open Search Page TTI Baseline
Mean: 613.753 ms
Stdev: 14.937 ms (2.4%)
Runs: 584.6504720002413 586.2473560012877 590.853108998388 595.7330729998648 599.8151860013604 601.8622239977121 602.5139969997108 602.632325001061 603.1477860026062 603.9021399989724 604.1615809984505 606.1572270020843 607.171916000545 608.9357909969985 609.15555800125 613.3146170005202 615.4730230011046 617.2686359994113 618.5607100017369 621.9077150002122 623.9030769988894 626.0496819987893 626.5203039981425 626.9464519992471 628.2469890005887 629.071858998388 629.2914230003953 630.2011730000377 630.9167480021715 638.2752690017223 643.4640309996903

Current
Mean: 617.233 ms
Stdev: 23.567 ms (3.8%)
Runs: 578.3726399987936 583.6328129991889 584.9302980005741 587.2642019987106 590.8493660017848 592.3838299997151 593.7447520010173 601.3640139997005 604.3676769994199 606.5084639973938 607.681518997997 608.9253749996424 609.5800379998982 609.8472499996424 611.2462159991264 612.8572999984026 612.9425050020218 613.9792890027165 614.196532998234 614.6482749991119 618.1636560000479 621.2380780018866 622.8520109988749 626.0579840019345 628.1434739977121 635.4029130004346 638.5819909982383 646.5881760008633 647.4780279994011 649.4101159982383 656.6852619983256 661.0026450008154 677.7458900026977
App start nativeLaunch Baseline
Mean: 21.143 ms
Stdev: 1.355 ms (6.4%)
Runs: 18 19 19 20 20 20 20 20 20 21 21 21 21 21 21 21 22 22 22 22 22 22 22 22 23 23 23 24

Current
Mean: 21.750 ms
Stdev: 2.475 ms (11.4%)
Runs: 18 19 19 19 19 19 19 20 20 20 20 20 21 21 21 21 21 21 22 22 23 23 23 23 24 24 24 25 25 26 26 28
App start regularAppStart Baseline
Mean: 0.019 ms
Stdev: 0.002 ms (8.3%)
Runs: 0.016724001616239548 0.01684599742293358 0.01700899749994278 0.017170999199151993 0.01717200130224228 0.01725200191140175 0.01741499826312065 0.017700999975204468 0.01786300167441368 0.01822900027036667 0.01827000081539154 0.01827000081539154 0.01839200034737587 0.01839200034737587 0.018432997167110443 0.018636003136634827 0.018716998398303986 0.019043002277612686 0.0192050002515316 0.019450001418590546 0.019450001418590546 0.01961199939250946 0.01961200311779976 0.01977599784731865 0.019937999546527863 0.019937999546527863 0.02046699821949005 0.020955000072717667 0.021240998059511185 0.02156500145792961 0.022624000906944275 0.022746000438928604

Current
Mean: 0.019 ms
Stdev: 0.001 ms (4.9%)
Runs: 0.017740998417139053 0.017781000584363937 0.01794400066137314 0.018026001751422882 0.01822900027036667 0.018269997090101242 0.01827000081539154 0.018390998244285583 0.018431998789310455 0.018594998866319656 0.0186769999563694 0.018758002668619156 0.019003000110387802 0.01936899870634079 0.019369002431631088 0.019409000873565674 0.01948999986052513 0.01953199878334999 0.019816000014543533 0.019898001104593277 0.02001900225877762 0.020059999078512192 0.020100999623537064 0.02014099806547165 0.020263999700546265 0.02046700194478035 0.020507000386714935 0.020629998296499252 0.02063000202178955 0.020670000463724136
App start TTI Baseline
Mean: 639.883 ms
Stdev: 24.972 ms (3.9%)
Runs: 591.1848860010505 599.2570360004902 610.7088790014386 616.3759160004556 619.0684019997716 619.5291449986398 621.2023160010576 622.9373929984868 624.5319410003722 626.6601519994438 627.2845409996808 630.5646440014243 631.6265189982951 631.7801930010319 632.1253280006349 633.4566590003669 633.7637500017881 636.0263519994915 638.2031890004873 640.6262129992247 641.8832250013947 645.2027259990573 648.8709609992802 660.5104510001838 661.3759859986603 662.2148439995944 662.2180150002241 666.0662419982255 668.661113999784 672.2415140010417 687.8364120014012 712.2757290005684

Current
Mean: 636.456 ms
Stdev: 19.400 ms (3.0%)
Runs: 597.9990839995444 610.2904380001128 610.5975349992514 612.0938699990511 613.9282569997013 621.7294920012355 621.9308580011129 623.5675350017846 623.931373000145 624.7574950009584 626.3330530002713 627.2605619989336 627.6757550016046 630.5692920014262 633.6371759995818 633.7791679985821 635.9560660012066 637.8730049990118 639.3678449988365 640.6506219990551 640.9428570009768 648.4957429990172 651.6750679984689 653.6706259995699 654.0875210016966 655.1644130013883 657.1597039997578 658.4255729988217 659.0056889988482 670.239036001265 687.3341909982264
App start runJsBundle Baseline
Mean: 172.500 ms
Stdev: 13.070 ms (7.6%)
Runs: 153 155 157 158 159 159 162 163 163 164 164 164 165 165 167 168 169 169 174 175 178 179 180 183 183 183 187 189 190 197 197 201

Current
Mean: 168.967 ms
Stdev: 10.203 ms (6.0%)
Runs: 150 151 153 156 159 159 161 162 164 164 164 164 165 167 167 168 171 173 174 174 174 177 177 177 178 181 182 182 183 192

@jayeshmangwani
Copy link
Contributor

local app is crashing because of this PR, we are using themeColors on GetAssistance Page but have not imported

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Jan 15, 2023

local app is crashing because of this PR, we are using themeColors on GetAssistance Page but have not imported

Oh, true, thank you
The import was there, then it got removed in #14289 since at that point this PR wasn't merged
I always thought GitHub does a lint check when merging, it should have caught that

image

Then again, even if linter would have caught it and we added the themeColors import back, it wouldn't crash anymore, but there would still be a bug, the icon wouldn't change the color oh hover (since this behavior was just recently added by #14289)

Screen.Recording.2023-01-15.at.11.46.42.mov

So to actually fix this we need to delete this line. I'm going to open a PR shortly

iconFill: themeColors.success,

There's also a post for this on Slack @jayeshmangwani created

PR is up

@aimane-chnaif
Copy link
Contributor

This is a good example why we should re-test after merging into main or merge from main before review and test.
The issue didn't happen on PR branch test but happened only after merge.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.2.55-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @AndrewGable in version: 1.2.55-0 🚀

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

@AndrewGable
Copy link
Contributor

@marcochavezf - Can you please production QA this?

@marcochavezf
Copy link
Contributor Author

Tested on all platforms and looks good

@jayeshmangwani
Copy link
Contributor

was checking if am I eligible for the bonus to reporting a regression.

cc: @eVoloshchak @aimane-chnaif

@jayeshmangwani
Copy link
Contributor

was checking if am I eligible for the bonus to reporting a regression.

cc: @eVoloshchak @aimane-chnaif

@eVoloshchak @aimane-chnaif can you please confirm this, I am not able to find the original issue to comment

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Jan 27, 2023

@jayeshmangwani original issue is internal so you can 👁️ this thread and request bonus at the time when @eVoloshchak gets compensation for internal PR review.

@eVoloshchak this is a good chance to test automation of creating issue 🙂
Can you please comment anything and re-approve this PR?
If automation doesn't work (maybe because PR already merged), hopefully BZ member will create new issue for payment purpose.

@eVoloshchak
Copy link
Contributor

@aimane-chnaif, thank you for the info!
I can't approve the PR since it was already merged, so I'm going to ask BZ members for help in Slack

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Jan 30, 2023

Also leaving a note that this had a regression that couldn't be prevented by following the checklist, not sure what're the rules on that

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.

7 participants