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

Fixes expensify-common lib version for italic markdown fix #15261

Merged
merged 3 commits into from
Feb 21, 2023

Conversation

alexxxwork
Copy link
Contributor

@alexxxwork alexxxwork commented Feb 17, 2023

Details

Markdown symbols like *text*, ~text~ or _text_ should match text with newlines.
Bold and strikethrough markdown have been fixed here Expensify/expensify-common#486
this PR switches version of expensify-common with fix for italic text _text_ and corresponding tests

Fixed Issues

$ #14675
$ #14675 (comment)

Tests

  1. Launch the app
  2. Login with any account
  3. Go to any chat
  4. Type in more than one line of text surrounded by _ symbols like
_multi
line_
  1. Verify that the comment shows as multiple lines with italic style
  • Verify that no errors appear in the JS console
  • Verify that text appears in italic font in report window

Offline tests

n/a

QA Steps

  1. Launch the app
  2. Login with any account
  3. Go to any chat
  4. Type in more than one line of text surrounded by _ symbols like
_multi
line_
  1. Verify that the comment shows as multiple lines with italic style
  • Verify that no errors appear in the JS console
  • Verify that text appears in italic font in report window

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 Screenshot 2023-02-15 06 10 41
Mobile Web - Chrome Screenshot 2023-02-15 06 29 41
Mobile Web - Safari Screenshot 2023-02-15 06 14 25
Desktop
iOS Screenshot 2023-02-15 06 05 23
Android Screenshot 2023-02-15 06 33 40

@alexxxwork alexxxwork requested a review from a team as a code owner February 17, 2023 20:50
@melvin-bot melvin-bot bot requested review from eVoloshchak and neil-marcellini and removed request for a team February 17, 2023 20:50
@MelvinBot
Copy link

@neil-marcellini @eVoloshchak 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]

@neil-marcellini neil-marcellini removed the request for review from eVoloshchak February 21, 2023 18:03
@MelvinBot
Copy link

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Tests well but please commit the package.lock.json file too.

@alexxxwork
Copy link
Contributor Author

Tests well but please commit the package.lock.json file too.

@neil-marcellini fixed!

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Thanks

@neil-marcellini
Copy link
Contributor

The reviewer checklist was already completed on the expensify-common PR, but here it is again.

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

@neil-marcellini neil-marcellini merged commit d3c2f04 into Expensify:main Feb 21, 2023
@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 711.473 ms → 718.530 ms (+7.057 ms, +1.0%)
App start runJsBundle 194.125 ms → 198.065 ms (+3.940 ms, +2.0%)
Open Search Page TTI 609.611 ms → 611.078 ms (+1.468 ms, ±0.0%)
App start regularAppStart 0.015 ms → 0.014 ms (-0.000 ms, -3.0%)
App start nativeLaunch 20.133 ms → 19.200 ms (-0.933 ms, -4.6%)
Show details
Name Duration
App start TTI Baseline
Mean: 711.473 ms
Stdev: 35.667 ms (5.0%)
Runs: 640.2047180002555 650.8624689998105 655.3358159996569 668.185797999613 681.3601089995354 682.81751000043 683.1792369997129 683.5714159999043 684.6864989995956 688.3744329996407 690.2030710000545 693.7509970003739 695.1015339996666 698.7354499995708 705.3172279996797 706.1328029995784 711.5056670000777 719.6262450003996 721.8268750002608 721.9275409998372 726.433852000162 727.1429260000587 729.6775160003453 732.9270500000566 737.1563410004601 739.8816280001774 747.6471950002015 754.90470200032 766.0802039997652 768.0003549996763 771.7351399995387 782.8525729998946

Current
Mean: 718.530 ms
Stdev: 33.038 ms (4.6%)
Runs: 645.1048999996856 667.9486830001697 669.484551999718 684.6791749997064 689.6503050001338 690.1446200003847 692.4399939998984 694.4397470001131 696.7295030001551 696.8624849999323 697.9885459998623 703.5356959998608 712.4259500000626 713.9346789997071 718.9257540004328 722.754855000414 724.9644010001794 726.0872719995677 729.0991900004447 729.2637099996209 730.4474689997733 730.946990000084 732.9257169999182 733.6623379997909 738.2195939999074 743.1238439995795 744.3541449997574 763.331220000051 769.2005289997905 789.2968159997836 792.4646760001779
App start runJsBundle Baseline
Mean: 194.125 ms
Stdev: 22.198 ms (11.4%)
Runs: 162 166 167 168 169 172 176 177 178 181 182 185 186 187 187 188 189 190 191 194 198 199 204 205 205 214 224 226 227 227 239 249

Current
Mean: 198.065 ms
Stdev: 19.497 ms (9.8%)
Runs: 163 165 169 176 178 182 182 183 185 188 188 190 191 193 194 196 198 201 202 203 207 208 213 213 213 214 217 222 225 236 245
Open Search Page TTI Baseline
Mean: 609.611 ms
Stdev: 19.741 ms (3.2%)
Runs: 579.7408039998263 581.1356199998409 581.8517249999568 584.0741379996762 584.8358970005065 585.6475019995123 587.1784269995987 588.647135999985 589.8973799999803 592.8251550002024 599.9698890000582 602.715046999976 602.947103000246 603.9341639997438 604.2302249995992 606.0936279995367 609.4227700000629 617.9322509998456 618.2934170002118 618.4026699997485 619.1201990004629 620.5674649998546 624.9350999994203 626.1175140002742 627.5754800001159 628.8701990004629 629.7406820002943 632.3844820000231 633.4963790001348 634.8038330003619 643.1239419998601 647.0264889998361

Current
Mean: 611.078 ms
Stdev: 18.361 ms (3.0%)
Runs: 571.0083820000291 575.5106199998409 587.2901200000197 587.8417159998789 590.5002450002357 596.3100190004334 597.7923590000719 598.3210450001061 599.5353600000963 599.890788000077 600.2614750005305 602.7029210003093 606.5183520000428 609.5212399996817 610.0479739997536 610.1078700004146 611.5172939999029 612.2018230007961 613.2356370007619 614.4489339999855 614.8597409995273 615.8612879998982 617.4693200001493 618.9579269997776 620.2014570003375 621.5795900002122 624.4447839995846 630.2235930003226 635.8541669994593 636.5168460002169 637.5212409999222 648.1783450003713 649.3503010002896
App start regularAppStart Baseline
Mean: 0.015 ms
Stdev: 0.001 ms (8.7%)
Runs: 0.012817999348044395 0.012980000115931034 0.013143000192940235 0.013508999720215797 0.013549999333918095 0.01358999963849783 0.013590999878942966 0.013631000183522701 0.013671999797224998 0.013672000728547573 0.013753999955952168 0.013794000260531902 0.013916000723838806 0.013956999406218529 0.013996999710798264 0.014078999869525433 0.014119000174105167 0.014159999787807465 0.014364000409841537 0.014405000023543835 0.014607000164687634 0.014689000323414803 0.014973999932408333 0.015177999623119831 0.015381000004708767 0.015868999995291233 0.016193999908864498 0.016276000067591667 0.01647899951785803 0.016479999758303165 0.016968000680208206 0.0181470001116395

Current
Mean: 0.014 ms
Stdev: 0.001 ms (5.3%)
Runs: 0.012897999957203865 0.01322499942034483 0.013264000415802002 0.013387000188231468 0.013388000428676605 0.013427999801933765 0.013631000183522701 0.013631000183522701 0.013712000101804733 0.01375299971550703 0.01375299971550703 0.013753999955952168 0.013794000260531902 0.013794000260531902 0.01387499924749136 0.013916000723838806 0.014077999629080296 0.01407800056040287 0.014159999787807465 0.014159999787807465 0.01444500032812357 0.014567000791430473 0.014728999696671963 0.0147299999371171 0.0147299999371171 0.014933000318706036 0.014973999932408333 0.015137000009417534 0.015949999913573265 0.015990999527275562
App start nativeLaunch Baseline
Mean: 20.133 ms
Stdev: 1.765 ms (8.8%)
Runs: 18 18 18 18 18 18 18 19 19 19 20 20 20 20 20 20 20 20 20 20 21 21 21 21 21 22 22 23 24 25

Current
Mean: 19.200 ms
Stdev: 1.194 ms (6.2%)
Runs: 17 18 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 21 22 22

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.2.76-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

HLEDYA added a commit to HLEDYA/Expensify-App that referenced this pull request Jul 10, 2023
roryabraham added a commit that referenced this pull request Jul 13, 2023
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