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

Update TestRail_Navigation_C+.md #15557

Merged
merged 1 commit into from
Feb 28, 2023
Merged

Update TestRail_Navigation_C+.md #15557

merged 1 commit into from
Feb 28, 2023

Conversation

dylanexpensify
Copy link
Contributor

@dylanexpensify dylanexpensify commented Feb 28, 2023

Updated process to have C+ propose the test steps

Details

Fixed Issues

N/A

Tests

N/A

Offline tests

N/A

QA Steps

N/A

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.
  • 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

Updated process to have C+ propose the test steps
@dylanexpensify dylanexpensify requested a review from a team as a code owner February 28, 2023 12:10
@melvin-bot melvin-bot bot requested review from cristipaval and removed request for a team February 28, 2023 12:11
@MelvinBot
Copy link

@cristipaval Please 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]

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Nice! Not sure if the very last line needed to be deleted, but shouldn't matter 😅

@cristipaval
Copy link
Contributor

cristipaval commented Feb 28, 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.
  • 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
Mobile Web - Safari
Desktop
iOS
Android

@cristipaval
Copy link
Contributor

trigger for the pr reviewer checklist

@cristipaval cristipaval merged commit 75bc60b into main Feb 28, 2023
@cristipaval cristipaval deleted the dylanexpensify-patch-1 branch February 28, 2023 13:53
@MelvinBot
Copy link

@cristipaval looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@cristipaval
Copy link
Contributor

this has nothing to do with the never ending job related to tests.

@github-actions
Copy link
Contributor

Performance Comparison Report 📊

Significant Changes To Duration

Name Duration
Open Search Page TTI 622.394 ms → 682.157 ms (+59.762 ms, +9.6%) 🔴
Show details
Name Duration
Open Search Page TTI Baseline
Mean: 622.394 ms
Stdev: 28.069 ms (4.5%)
Runs: 587.796875 588.4905199999921 590.8527030004188 592.2035329998471 593.2648519999348 596.6829429999925 597.9300139998086 598.1119789998047 598.3826909996569 598.5459800004028 600.2526449998841 602.8070880002342 610.9932050001808 616.1134449997917 616.3601890001446 616.656413000077 617.7107339999638 618.6809089998715 620.3796389997005 622.8197019998915 623.4303389997222 623.8425289997831 631.1729330001399 631.9105229997076 634.6796059999615 639.3563230000436 642.2469480000436 650.4864099998958 654.1067709997296 666.2979329996742 678.1254880004562 687.7114659999497 690.6050619999878

Current
Mean: 682.157 ms
Stdev: 28.367 ms (4.2%)
Runs: 622.4502770002 626.7000330002047 628.313639999833 630.2287599998526 631.409789999947 660.1450199997053 662.3320309999399 666.5986739997752 666.9433999997564 669.8022060003132 673.8570150001906 675.8226319998503 684.0064699999057 687.1748049999587 687.922851999756 688.0789389996789 689.0329189999029 689.8113609999418 691.8313809996471 693.2602550000884 695.0902919997461 696.500610999763 696.8309730002657 697.4652510001324 700.4150399998762 701.6277669998817 702.1879070000723 702.5141190001741 706.0658769998699 710.2755950000137 711.9777430002578 725.5286870002747 738.9679359998554

Meaningless Changes To Duration

Show entries
Name Duration
App start TTI 737.556 ms → 775.713 ms (+38.157 ms, +5.2%)
App start runJsBundle 200.452 ms → 211.871 ms (+11.419 ms, +5.7%)
App start nativeLaunch 19.500 ms → 19.933 ms (+0.433 ms, +2.2%)
App start regularAppStart 0.015 ms → 0.016 ms (+0.001 ms, +4.3%)
Show details
Name Duration
App start TTI Baseline
Mean: 737.556 ms
Stdev: 30.252 ms (4.1%)
Runs: 691.1030600001104 693.5969070000574 694.0994270001538 699.7948630000465 708.3482380001806 710.5742210000753 713.8683529999107 714.249394999817 717.872839000076 721.9820489999838 722.5612269998528 723.1076319999993 723.6418320001103 723.8683560001664 724.3430139999837 728.9482829999179 730.2040800000541 735.4802230000496 737.2505890000612 737.7806199998595 740.1917759999633 743.5944150001742 754.040471999906 756.6426360001788 769.1779080000706 770.0623460002244 771.1870430000126 772.4358219997957 787.6830799998716 789.0421790000983 796.4432999999262 798.6192499999888

Current
Mean: 775.713 ms
Stdev: 26.792 ms (3.5%)
Runs: 729.9150000000373 735.793240999803 737.3963689999655 749.2410670001991 752.2922539999709 755.9780959999189 756.9200280001387 760.7169079999439 761.576348000206 762.0910700000823 762.3292749999091 763.7220879998058 764.9172660000622 765.183778999839 765.8715800000355 766.9281819998287 767.1569329998456 769.9647829998285 770.0080690002069 772.2510979999788 778.6632449999452 781.3493209998123 788.337762999814 789.1759420000017 789.904573999811 798.8653830001131 806.8137539997697 813.1204780000262 813.1279609999619 818.008032000158 836.9207799998112 838.2701099999249
App start runJsBundle Baseline
Mean: 200.452 ms
Stdev: 15.659 ms (7.8%)
Runs: 180 181 182 182 183 184 188 190 190 191 193 194 194 196 196 197 197 198 199 201 202 204 206 213 213 214 223 226 226 230 241

Current
Mean: 211.871 ms
Stdev: 16.050 ms (7.6%)
Runs: 184 188 188 191 193 197 199 200 203 203 204 204 208 208 209 209 211 212 217 218 218 219 220 222 224 227 229 236 236 244 247
App start nativeLaunch Baseline
Mean: 19.500 ms
Stdev: 1.408 ms (7.2%)
Runs: 18 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 21 21 22 23 23

Current
Mean: 19.933 ms
Stdev: 1.526 ms (7.7%)
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 22 22 23 24
App start regularAppStart Baseline
Mean: 0.015 ms
Stdev: 0.001 ms (7.4%)
Runs: 0.013590000104159117 0.013671999797224998 0.01375299971550703 0.013915999792516232 0.014078999869525433 0.014201000332832336 0.014241999946534634 0.014282000251114368 0.014404000248759985 0.014607999939471483 0.014771000016480684 0.014810999855399132 0.014851999934762716 0.014973999932408333 0.015054999850690365 0.015055999625474215 0.015178000088781118 0.015217999927699566 0.015218000393360853 0.01525900000706315 0.01534100016579032 0.015503000002354383 0.0157880000770092 0.015828000381588936 0.01607199991121888 0.01607300015166402 0.016479999758303165 0.0165200000628829 0.01696799974888563 0.0172520000487566 0.017659999895840883 0.017903999891132116

Current
Mean: 0.016 ms
Stdev: 0.001 ms (5.8%)
Runs: 0.013753000181168318 0.014607000164687634 0.014688999857753515 0.014973999932408333 0.015298999845981598 0.015298999845981598 0.015299999620765448 0.015339999925345182 0.015339999925345182 0.015380000229924917 0.015380000229924917 0.015381000004708767 0.015381000004708767 0.015503000002354383 0.015625 0.015665000304579735 0.0157880000770092 0.016112999990582466 0.016112999990582466 0.016276000067591667 0.01639900030568242 0.016439000144600868 0.0165200000628829 0.016642000060528517 0.01672299997881055 0.016846000216901302 0.017171000130474567 0.017171999905258417 0.0172520000487566 0.0172520000487566 0.017943999730050564

@github-actions github-actions bot added the DeployBlockerCash This issue or pull request should block deployment label Feb 28, 2023
@github-actions
Copy link
Contributor

@Expensify/mobile-deployers 📣 Please look into this performance regression as it's a deploy blocker.

@cristipaval
Copy link
Contributor

It doesn't make sense that performance is impacted by these changes in the md file. Removing DeployBlockerCash label.

@cristipaval cristipaval removed the DeployBlockerCash This issue or pull request should block deployment label Feb 28, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Mar 2, 2023

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.2.78-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2023

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

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

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.

5 participants