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

[No QA] Update testing platforms for PRs to include MacOS Safari #13692

Merged
merged 2 commits into from
Dec 19, 2022

Conversation

puneetlath
Copy link
Contributor

@puneetlath puneetlath commented Dec 19, 2022

Details

Adding MacOS Safari and updating the order as discussed here.

Tests

No tests, just a documentation change.

  • Verify that no errors appear in the JS console

QA Steps

No QA.

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@puneetlath puneetlath self-assigned this Dec 19, 2022
@puneetlath puneetlath marked this pull request as ready for review December 19, 2022 16:37
@puneetlath puneetlath requested a review from a team as a code owner December 19, 2022 16:37
@melvin-bot melvin-bot bot requested review from Gonals and removed request for a team December 19, 2022 16:38
@melvin-bot
Copy link

melvin-bot bot commented Dec 19, 2022

@Gonals 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]

@mountiny
Copy link
Contributor

mountiny commented Dec 19, 2022

Reviewer Checklist

Not testing since this is just markdown change

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

mountiny
mountiny previously approved these changes Dec 19, 2022
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@puneetlath puneetlath changed the title Update testing platforms for PRs to include MacOS Safari [No QA] Update testing platforms for PRs to include MacOS Safari Dec 19, 2022
luacmartins
luacmartins previously approved these changes Dec 19, 2022
@puneetlath puneetlath dismissed stale reviews from luacmartins and mountiny via fa8198c December 19, 2022 16:55
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thank you!

@mountiny mountiny merged commit e194fb4 into main Dec 19, 2022
@mountiny mountiny deleted the update-pr-template branch December 19, 2022 16:59
@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
TTI 821.489 ms → 836.245 ms (+14.757 ms, +1.8%)
runJsBundle 195.469 ms → 201.500 ms (+6.031 ms, +3.1%)
regularAppStart 0.017 ms → 0.015 ms (-0.002 ms, -13.1%)
nativeLaunch 9.548 ms → 9.533 ms (-0.015 ms, ±0.0%)
Show details
Name Duration
TTI Baseline
Mean: 821.489 ms
Stdev: 39.323 ms (4.8%)
Runs: 749.4683619998395 762.9658859996125 769.5004749996588 780.5883160000667 786.0126649998128 788.2282130001113 788.5230729999021 791.4155379999429 794.5111830001697 800.7752839997411 801.0303800003603 803.0904710004106 803.112354000099 804.0943830003962 804.5123340003192 810.360811999999 816.7072839997709 817.4651089999825 827.6038790000603 828.9968560002744 834.5769170001149 838.6759179998189 849.4062569998205 859.0332909999415 859.1493899999186 865.9998000003397 867.272970999591 881.1054680002853 891.5269240001217 893.1018829997629 897.3323889998719

Current
Mean: 836.245 ms
Stdev: 43.634 ms (5.2%)
Runs: 753.4288459997624 765.4179910002276 776.9572019996122 785.5271920002997 788.4449920002371 801.8414420001209 802.3576659997925 805.6010779999197 806.3948419997469 807.5737140001729 812.5124430004507 814.3852129997686 816.6274439999834 820.4490219997242 828.8949939999729 832.1072960002348 833.4635589998215 843.6067920001224 848.4177040001377 851.0669480003417 856.8985679997131 863.3666869997978 865.3121939999983 865.8518460001796 871.3923000004143 873.8078549997881 883.2160130003467 889.9157069995999 911.0626649996266 918.7502279998735 928.9481760002673
runJsBundle Baseline
Mean: 195.469 ms
Stdev: 25.797 ms (13.2%)
Runs: 162 163 169 170 172 172 172 174 176 178 178 181 181 182 182 186 187 188 194 204 207 209 210 211 215 215 216 219 227 232 257 266

Current
Mean: 201.500 ms
Stdev: 21.919 ms (10.9%)
Runs: 168 171 175 175 176 177 178 189 190 191 191 191 191 192 193 195 198 200 203 205 207 213 213 215 215 222 222 226 227 231 251 257
regularAppStart Baseline
Mean: 0.017 ms
Stdev: 0.002 ms (9.3%)
Runs: 0.013956000097095966 0.014649000018835068 0.014688999392092228 0.014852000400424004 0.015298999845981598 0.015381000004708767 0.015625 0.015625 0.015786999836564064 0.015951000154018402 0.015991000458598137 0.016112999990582466 0.016153999604284763 0.016234999522566795 0.01623500045388937 0.016276000067591667 0.016316999681293964 0.016479999758303165 0.0167239997535944 0.017008000053465366 0.017049000598490238 0.01713000051677227 0.017171000130474567 0.017659000121057034 0.018024999648332596 0.018432999961078167 0.018635999411344528 0.018717999570071697 0.01879899948835373 0.019979000091552734 0.020915000699460506

Current
Mean: 0.015 ms
Stdev: 0.001 ms (3.9%)
Runs: 0.013345999643206596 0.013426999561488628 0.01371300034224987 0.0138349998742342 0.013915999792516232 0.014119000174105167 0.014241999946534634 0.014242000877857208 0.014282000251114368 0.01432300079613924 0.014363999478518963 0.014405000023543835 0.01444500032812357 0.014485999941825867 0.014485999941825867 0.014526000246405602 0.014566999860107899 0.014566999860107899 0.014566999860107899 0.014607000164687634 0.014770000241696835 0.014770999550819397 0.0148930000141263 0.014933000318706036 0.015014000236988068 0.015015000477433205 0.015015000477433205 0.015015000477433205 0.01574699953198433 0.016032000072300434
nativeLaunch Baseline
Mean: 9.548 ms
Stdev: 1.542 ms (16.1%)
Runs: 7 7 8 8 8 8 8 9 9 9 9 9 9 9 9 9 9 9 9 10 10 10 10 11 11 11 11 12 12 13 13

Current
Mean: 9.533 ms
Stdev: 1.087 ms (11.4%)
Runs: 8 8 8 8 8 9 9 9 9 9 9 9 9 9 9 9 10 10 10 10 10 10 10 10 10 11 11 11 12 12

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @mountiny in version: 1.2.42-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @yuwenmemon in version: 1.2.42-2 🚀

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.

4 participants