Skip to content

migrate workspaceReimburseView.js from class to function component#22243

Merged
MonilBhavsar merged 17 commits into
Expensify:mainfrom
KrAbhas:migrting-workspaceReimburseView-2
Jul 18, 2023
Merged

migrate workspaceReimburseView.js from class to function component#22243
MonilBhavsar merged 17 commits into
Expensify:mainfrom
KrAbhas:migrting-workspaceReimburseView-2

Conversation

@KrAbhas

@KrAbhas KrAbhas commented Jul 5, 2023

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ 16312
PROPOSAL: GH_LINK_ISSUE(COMMENT) 1608137455

Tests

  1. Open expenxify, click on avatar, settings panel will open
  2. Go to Workspace, create workspace if already not present, click reimbursements
  3. The panel that opens is our component 'WorkspaceReimburseView'
  4. Click on on all the cards and links to make sure it is working.
  5. The first panel titled 'Capture Receipts' should open up a link in new tab for expenses (link will not find a page in localhost)
  6. The second panel titled Track distance that will open up another page where one can configure values changing which will reflect in our component's second panel.
  7. Third panel is a connect bank account that opens a different component with a card for streamlined payments.
  8. The component gets synced going from offline to online.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to Reimbursement page and click on first section, you will get a popup page.
  2. Check by changing the data in the second section (Track Distance) for the rate and unit, so that it gets reflected after saving on the reimbursement page.
  3. Open the 3rd section (Unlock next-day reimbursements), and check see if its opening correctly.
  4. Go offline and then turn online, and see if the component gets sync.
  5. Open the app in a different place (anywhere...desktop, mobile) and change the data in second section (Track Distance) to see if it gets sync in the first place.
  6. Change currency by visiting the setting of the workspace in second place and in the first place try opening 3rd section, it should work if the currency is currently USD.
  • 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
    • 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 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
WorkspaceReimburseView_web.mov
Mobile Web - Chrome
WorkspaceReimburse_android_chrome.mp4
Mobile Web - Safari
WorkspaceReimburse_ios_safari_720p.mov
Desktop
WorkspaceReimburse_desktop_720p.mov
iOS
WorkspaceReimburseView_ios_720p.mov
Android
WorkspaceReimburseView_android_480p.mov

@KrAbhas KrAbhas requested a review from a team as a code owner July 5, 2023 01:59
@melvin-bot melvin-bot Bot requested review from Li357 and removed request for a team July 5, 2023 02:00
@melvin-bot

melvin-bot Bot commented Jul 5, 2023

Copy link
Copy Markdown

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

@KrAbhas

KrAbhas commented Jul 5, 2023

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@KrAbhas KrAbhas mentioned this pull request Jul 5, 2023
57 tasks
@KrAbhas

KrAbhas commented Jul 5, 2023

Copy link
Copy Markdown
Contributor Author

This PR is raised as the old PR has unverified commits. This PR has exactly same changes as in old PR.

@MonilBhavsar MonilBhavsar requested a review from mollfpr July 5, 2023 14:48
@Li357 Li357 requested review from MonilBhavsar and removed request for Li357 July 5, 2023 14:49
@mollfpr

mollfpr commented Jul 5, 2023

Copy link
Copy Markdown
Contributor

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 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
22243.Web.mov
Mobile Web - Chrome
22243.mWeb.Chrome.webm
Mobile Web - Safari
22243.mWeb.Safari.mp4
Desktop
22243.Desktop.mov
iOS
22243.iOS.mp4
Android
22243.Android.webm

@mollfpr mollfpr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Screen.Recording.2023-07-08.at.21.36.41.mov

The API call twice.

We can remove the fetchData inside the second useEffect and handle the fetching in the first useEffect whenever we are online.

Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
@KrAbhas KrAbhas requested a review from mollfpr July 9, 2023 18:17
@KrAbhas

KrAbhas commented Jul 11, 2023

Copy link
Copy Markdown
Contributor Author

@mollfpr I have made the changes, please review

@mollfpr mollfpr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The API is still called everytime I changing the language.

Screen.Recording.2023-07-12.at.11.59.36.mov

Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
@KrAbhas

KrAbhas commented Jul 13, 2023

Copy link
Copy Markdown
Contributor Author

Hi @mollfpr , I have made the required changes, please see it

@KrAbhas KrAbhas requested a review from mollfpr July 13, 2023 06:06

@mollfpr mollfpr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good now and tests well. Just some minor improvement.

Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
KrAbhas and others added 2 commits July 13, 2023 21:52
Co-authored-by: Luthfi <luthfi.ufi14@gmail.com>
Co-authored-by: Luthfi <luthfi.ufi14@gmail.com>
@KrAbhas

KrAbhas commented Jul 13, 2023

Copy link
Copy Markdown
Contributor Author

@mollfpr the changes has been committed. Thanks for taking the pain of helping me with this as this was my first PR for Expensify. I will be more cautious from next time while making changes as well as testing.

@KrAbhas KrAbhas requested a review from mollfpr July 13, 2023 16:25

@mollfpr mollfpr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

Sorry for taking a long time to finish this. You're doing a great job, and I like how you commit things for each purpose 👍

@mollfpr

mollfpr commented Jul 13, 2023

Copy link
Copy Markdown
Contributor

@MonilBhavsar We need a hand for the workflow and review. Thank you!

Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated
@KrAbhas KrAbhas force-pushed the migrting-workspaceReimburseView-2 branch from 4564cc8 to 36cf4bf Compare July 17, 2023 20:18
@MonilBhavsar

Copy link
Copy Markdown
Contributor

QA steps are missing in the PR description. They can be similar to tests. But let's QA this PR

Comment thread src/pages/workspace/reimburse/WorkspaceReimburseView.js
@KrAbhas KrAbhas requested a review from MonilBhavsar July 18, 2023 12:27
@KrAbhas

KrAbhas commented Jul 18, 2023

Copy link
Copy Markdown
Contributor Author

I have added the QA steps in PR description. @MonilBhavsar

@MonilBhavsar MonilBhavsar merged commit 0aa0a35 into Expensify:main Jul 18, 2023
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.42-10 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.44-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-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