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

[NoQA] Include link to slack thread about the mapbox token #28735

Merged
merged 1 commit into from
Oct 3, 2023

Conversation

mountiny
Copy link
Contributor

@mountiny mountiny commented Oct 3, 2023

Details

There is a token the contributors can use to set up the mapbox for testing so lets link to the slack thread so they can find it as invited contributors

Fixed Issues

N/A
PROPOSAL:

Tests

N/A

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • 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

@mountiny mountiny requested a review from a team as a code owner October 3, 2023 16:17
@mountiny mountiny self-assigned this Oct 3, 2023
@melvin-bot melvin-bot bot removed the request for review from a team October 3, 2023 16:18
@melvin-bot
Copy link

melvin-bot bot commented Oct 3, 2023

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

@melvin-bot melvin-bot bot requested a review from puneetlath October 3, 2023 16:18
@puneetlath
Copy link
Contributor

puneetlath commented Oct 3, 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • 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

@puneetlath puneetlath merged commit 5fc9d9c into main Oct 3, 2023
12 checks passed
@puneetlath puneetlath deleted the vit-updateReadmeWithToken branch October 3, 2023 16:38
@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 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 github-actions bot added the DeployBlockerCash This issue or pull request should block deployment label Oct 3, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

Performance Comparison Report 📊

Significant Changes To Duration

Name Duration
App start TTI 1200.209 ms → 1306.589 ms (+106.380 ms, +8.9%) 🔴
App start runJsBundle 829.226 ms → 916.469 ms (+87.243 ms, +10.5%) 🔴
Show details
Name Duration
App start TTI Baseline
Mean: 1200.209 ms
Stdev: 51.283 ms (4.3%)
Runs: 1075.6114900000393 1120.493328999728 1122.8691899999976 1124.768311000429 1150.1573590002954 1158.8112859996036 1162.2046079998836 1168.3397770002484 1169.2527149999514 1169.7330579999834 1173.8002739995718 1189.020414000377 1189.7020910000429 1195.0742520000786 1195.3083210000768 1197.36207799986 1200.1659390004352 1206.0754019999877 1224.9189830003306 1224.975153000094 1225.0755529999733 1226.8895209999755 1233.0131419999525 1236.4653740003705 1241.5289380000904 1248.4241699995473 1254.3777350001037 1263.595057000406 1272.9913440002128 1288.4406939996406 1297.029310000129

Current
Mean: 1306.589 ms
Stdev: 38.003 ms (2.9%)
Runs: 1205.7782640000805 1258.5142999999225 1267.3853730000556 1268.3010740000755 1269.8444400001317 1273.363633999601 1274.441239000298 1276.8017119998112 1277.4040689999238 1280.68567099981 1289.9702439997345 1297.2420789999887 1297.9052780000493 1300.2549449997023 1300.6248650001362 1301.9165449999273 1304.0347419995815 1317.463507000357 1317.984988999553 1318.1676960000768 1320.8984059998766 1323.300851999782 1327.6520100003108 1329.8486789995804 1331.6272290004417 1333.7910979995504 1346.3316329997033 1359.7925469996408 1372.5853110002354 1375.5170689998195 1384.8141620000824
App start runJsBundle Baseline
Mean: 829.226 ms
Stdev: 46.599 ms (5.6%)
Runs: 742 749 750 768 789 791 791 792 810 813 815 816 817 820 825 828 828 830 836 843 845 849 853 854 857 859 880 888 914 926 928

Current
Mean: 916.469 ms
Stdev: 31.463 ms (3.4%)
Runs: 865 866 874 878 880 887 888 889 890 894 896 899 901 907 911 912 915 919 925 927 927 933 934 941 942 943 945 958 962 967 972 980

Meaningless Changes To Duration

Show entries
Name Duration
Open Search Page TTI 656.911 ms → 669.469 ms (+12.558 ms, +1.9%)
App start nativeLaunch 20.833 ms → 22.774 ms (+1.941 ms, +9.3%)
App start regularAppStart 0.018 ms → 0.019 ms (+0.001 ms, +7.7%)
Show details
Name Duration
Open Search Page TTI Baseline
Mean: 656.911 ms
Stdev: 45.557 ms (6.9%)
Runs: 581.8020019996911 599.0676270006225 600.7430020002648 605.6848149998114 617.7721770005301 618.6188969993964 622.1904710000381 622.2012130003422 623.3776860004291 624.6370040001348 627.4720459999517 629.1247969996184 632.5125730000436 633.8062740005553 636.550619000569 639.953614000231 646.769897999242 647.0006099995226 652.2841799994931 654.322266000323 655.7985030002892 670.4656170001253 680.8358970005065 686.7922360002995 687.8208410004154 689.91040099971 690.8365080002695 714.4818530008197 717.6801360007375 721.2176930001006 721.7123210001737 757.4262290000916 767.1805419996381

Current
Mean: 669.469 ms
Stdev: 48.341 ms (7.2%)
Runs: 597.2594000007957 607.7749429997057 615.2868659999222 616.4745289999992 619.922201000154 623.6489260001108 631.6585290003568 634.3675950001925 635.2948819994926 638.865112000145 639.5884199999273 640.3814289998263 645.5076089994982 647.2080889996141 648.853190000169 650.2107750000432 652.0116379996762 653.4931239997968 655.2682300005108 663.7669279994443 669.2669679997489 680.6569819999859 681.9335939995944 712.4785159993917 714.4270430002362 715.8933509998024 717.0243330001831 722.3399260006845 726.404094000347 738.2025560000911 746.1349290004 753.4236249998212 797.4400239996612
App start nativeLaunch Baseline
Mean: 20.833 ms
Stdev: 1.507 ms (7.2%)
Runs: 18 19 19 19 19 19 20 20 20 20 20 20 20 21 21 21 21 21 21 21 21 22 22 22 22 22 23 23 23 25

Current
Mean: 22.774 ms
Stdev: 2.498 ms (11.0%)
Runs: 20 20 20 20 20 20 21 21 21 21 21 21 22 22 22 22 22 22 23 23 24 24 24 25 25 25 25 26 26 28 30
App start regularAppStart Baseline
Mean: 0.018 ms
Stdev: 0.001 ms (6.9%)
Runs: 0.014934000559151173 0.016154000535607338 0.016235999763011932 0.016276000067591667 0.01639800053089857 0.016438999213278294 0.01647899951785803 0.01700899936258793 0.017090000212192535 0.017090000212192535 0.017171000130474567 0.017211999744176865 0.01737500075250864 0.017496000044047832 0.017496000044047832 0.01749700028449297 0.0176189998164773 0.017740000039339066 0.01782199926674366 0.017903000116348267 0.018067000433802605 0.018311000429093838 0.018432999961078167 0.0185139998793602 0.019082999788224697 0.019123999401926994 0.019286999478936195 0.019571999087929726 0.019652999937534332 0.020507999695837498

Current
Mean: 0.019 ms
Stdev: 0.001 ms (7.2%)
Runs: 0.017130999825894833 0.017211000435054302 0.017416000366210938 0.017578000202775 0.017659000121057034 0.01769999973475933 0.017700999975204468 0.017862999811768532 0.01798499934375286 0.018025999888777733 0.018269999884068966 0.0185139998793602 0.018636000342667103 0.01875900011509657 0.019084000028669834 0.01912400033324957 0.019328000023961067 0.019328000023961067 0.019328000023961067 0.0194089999422431 0.019449999555945396 0.019896999932825565 0.02001999970525503 0.020060000009834766 0.0201409999281168 0.020426999777555466 0.02164699975401163 0.021728000603616238 0.022419999353587627

@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

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

@puneetlath
Copy link
Contributor

Given that this is just a readme change, I don't think it could've caused a performance regression.

@mountiny mountiny removed the DeployBlockerCash This issue or pull request should block deployment label Oct 3, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Oct 5, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 6, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.78-4 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 6, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 9, 2023

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 9, 2023

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 cancelled 🔪
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

OSBotify commented Oct 9, 2023

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

3 participants