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

[Prod QA] Help page style fixes #14166

Merged
merged 6 commits into from
Jan 13, 2023
Merged

[Prod QA] Help page style fixes #14166

merged 6 commits into from
Jan 13, 2023

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented Jan 9, 2023

Details

Fixed Issues

$ #14124
$ #13681

Tests

  1. Run the help site - instructions
  2. Verify that the page headers are using our new font
  3. Verify that hovering the LHN links lightens its color
  4. Verify that the text in cards wrap into multiple lines when the browser window is narrow
  5. Verify that the cards are the same width

web2

web3

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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

web1
web2
web3

Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS

ios

Android

@luacmartins luacmartins self-assigned this Jan 9, 2023
@luacmartins luacmartins changed the title Help page style fixes [Prod QA] Help page style fixes Jan 10, 2023
@luacmartins luacmartins marked this pull request as ready for review January 10, 2023 21:05
@luacmartins luacmartins requested a review from a team as a code owner January 10, 2023 21:05
@melvin-bot melvin-bot bot requested review from marcaaron and Santhosh-Sellavel and removed request for a team January 10, 2023 21:05
@melvin-bot
Copy link

melvin-bot bot commented Jan 10, 2023

@Santhosh-Sellavel @marcaaron 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]

@shawnborton
Copy link
Contributor

Looking good, thanks @luacmartins!

@Santhosh-Sellavel
Copy link
Collaborator

@luacmartins I believe C+ review is not required here, if needs to be done share the instructions as I can't access the instructions in the PR Steps, thanks!

@luacmartins
Copy link
Contributor Author

@Santhosh-Sellavel ah you can follow the instructions in this README to get set up.

@Santhosh-Sellavel
Copy link
Collaborator

Ah, this should be quick I guess. I've already done this setup once.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jan 11, 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

✅ Verify that the page headers are using our new font
✅ Verify that hovering the LHN links lightens its color
✅ Verify that the text in cards wrap into multiple lines when the browser window is narrow
✅ Verify that the cards are the same width

Web
Wenb.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good & tests well for me!

@marcaaron marcaaron merged commit 800cb1c into main Jan 13, 2023
@marcaaron marcaaron deleted the cmartins-helpFont branch January 13, 2023 00:52
@OSBotify
Copy link
Contributor

✋ 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

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
App start TTI 634.293 ms → 647.534 ms (+13.241 ms, +2.1%)
App start regularAppStart 0.019 ms → 0.013 ms (-0.005 ms, -28.4%) 🟢
App start nativeLaunch 21.767 ms → 21.167 ms (-0.600 ms, -2.8%)
App start runJsBundle 175.625 ms → 173.531 ms (-2.094 ms, -1.2%)
Open Search Page TTI 618.416 ms → 611.863 ms (-6.552 ms, -1.1%)
Show details
Name Duration
App start TTI Baseline
Mean: 634.293 ms
Stdev: 23.530 ms (3.7%)
Runs: 589.9203070001677 593.8937290003523 596.2745829997584 599.0587139995769 600.6251959996298 604.5252769999206 614.7791539998725 615.9826140003279 620.1033950001001 620.6321830004454 622.9538839999586 632.3220149995759 633.6963510001078 634.0446600001305 634.1846110001206 635.8603389998898 637.8815069999546 638.785166000016 638.7996209999546 640.4946450004354 651.1494190003723 653.7722420003265 653.8231889996678 654.616654000245 659.1594369998202 659.8507629996166 662.3407829999924 662.850034000352 665.4758559996262 667.2635399997234 667.9614890003577

Current
Mean: 647.534 ms
Stdev: 32.947 ms (5.1%)
Runs: 591.6767950002104 602.6792040001601 605.3008479997516 611.9683140004054 616.0977579997852 617.8105830000713 623.5769269997254 624.808481999673 624.963891999796 628.6566880000755 628.6789619997144 629.7214780002832 632.5496100001037 633.5361559996381 634.3876059995964 635.6585839996114 637.4991619996727 640.2698860000819 643.1156599996611 650.1940789995715 654.8202120000497 657.8309359997511 660.9389859996736 666.7616550000384 673.3326660003513 683.9671010002494 686.389798999764 692.93904499989 693.1859259996563 706.224431999959 712.1215350003913 719.4137369999662
App start regularAppStart Baseline
Mean: 0.019 ms
Stdev: 0.001 ms (6.0%)
Runs: 0.0165200000628829 0.017211999744176865 0.017455999739468098 0.017537999898195267 0.01766000036150217 0.017740000039339066 0.017781000584363937 0.017822000198066235 0.01790399942547083 0.017985000275075436 0.018106999807059765 0.018148000352084637 0.018187999725341797 0.01839200034737587 0.0185139998793602 0.018595000728964806 0.018717999570071697 0.018757999874651432 0.018757999874651432 0.01883900072425604 0.018881000578403473 0.018960999324917793 0.018961000256240368 0.019125000573694706 0.019449000246822834 0.019733999855816364 0.020304000005126 0.020874000154435635 0.021037000231444836 0.021321999840438366

Current
Mean: 0.013 ms
Stdev: 0.001 ms (4.0%)
Runs: 0.012329000048339367 0.012531999498605728 0.012736000120639801 0.01281800027936697 0.012858000583946705 0.012897999957203865 0.012899000197649002 0.012939000502228737 0.012980000115931034 0.012981000356376171 0.013021000660955906 0.013061000034213066 0.013061999343335629 0.013062000274658203 0.013183999806642532 0.013346999883651733 0.013387000188231468 0.013387000188231468 0.0134680001065135 0.013469000346958637 0.013590999878942966 0.013590999878942966 0.013671999797224998 0.01371300034224987 0.013915999792516232 0.013996999710798264 0.0139979999512434 0.014119000174105167 0.01411999948322773 0.014282000251114368 0.014607000164687634
App start nativeLaunch Baseline
Mean: 21.767 ms
Stdev: 2.753 ms (12.6%)
Runs: 18 19 19 19 19 20 20 20 20 20 20 21 21 21 21 21 21 21 21 22 22 22 23 24 24 24 25 27 29 29

Current
Mean: 21.167 ms
Stdev: 1.319 ms (6.2%)
Runs: 19 19 19 20 20 20 20 20 20 20 20 21 21 21 21 21 21 22 22 22 22 22 22 22 22 23 23 23 23 24
App start runJsBundle Baseline
Mean: 175.625 ms
Stdev: 17.222 ms (9.8%)
Runs: 149 153 154 156 156 158 159 160 161 167 167 168 168 170 170 170 170 171 172 178 178 189 190 190 191 192 196 197 198 201 209 212

Current
Mean: 173.531 ms
Stdev: 15.738 ms (9.1%)
Runs: 146 149 152 154 159 159 159 160 162 164 166 166 170 170 171 172 173 174 174 175 178 181 181 181 183 184 185 192 194 203 206 210
Open Search Page TTI Baseline
Mean: 618.416 ms
Stdev: 27.779 ms (4.5%)
Runs: 568.3270669998601 571.3881429992616 575.6337900003418 587.2729490008205 591.6228030007333 592.1580809997395 595.7259110007435 597.8960369993001 598.9635419994593 600.5702319992706 602.0205079996958 602.675904000178 602.7254639994353 605.2961830003187 610.5392669998109 612.3448489997536 614.4332689996809 615.5917159998789 617.5325930006802 620.3289790004492 627.072550999932 634.4771330002695 634.8486330006272 637.7845060005784 645.734416000545 647.7534999996424 648.6269539995119 648.8671059999615 649.1429849993438 649.4872240005061 656.900797999464 660.0026860004291 683.96952399984

Current
Mean: 611.863 ms
Stdev: 19.387 ms (3.2%)
Runs: 576.1579590002075 578.9366460004821 583.1728110006079 587.6583259999752 588.6656499998644 590.1127530001104 595.1695559993386 595.8860269999132 596.0987149998546 598.4484869996086 599.1928709996864 602.3784590000287 603.1389570003375 604.1542569994926 612.74198500067 613.6612550001591 614.3583990000188 614.6785479998216 615.7984220003709 616.3198650004342 617.5764569994062 621.565592000261 622.6004229998216 622.7443850003183 625.2992759998888 626.3261719997972 626.5284430002794 630.6638190001249 631.2421470005065 636.0611169999465 645.0550539996475 648.9577230000868 650.1352130006999

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @marcaaron in version: 1.2.54-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @AndrewGable in version: 1.2.54-2 🚀

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

@AndrewGable
Copy link
Contributor

@luacmartins @shawnborton or @marcaaron - Can you run prod QA on this? Thanks!

@luacmartins
Copy link
Contributor Author

@AndrewGable just tested and seems to work well!

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.

6 participants