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

remove MoneyRequestCategoryPage and refactor route #35458

Merged
merged 34 commits into from
Feb 22, 2024

Conversation

dukenv0307
Copy link
Contributor

Details

  1. Remove all use of MoneyRequestCategoryPage
  2. Use IOURequestStepCategory for both create and edit case
  3. Add action param for the route of IOURequestStepCategory
  4. EditRequestCategoryPage will be removed after removing all use of EditRequestPage

Fixed Issues

$ #34606
PROPOSAL: #34606 (comment)

Tests

  • create and edit request money
  1. Verify that MoneyRequestCategoryPage is removed with the route, screen, and all use of this page in the app
  2. Create a request money and select a category
  3. Go to transaction thread report
  4. Verify that selected category is displayed as well
  5. Click on category to edit
  6. Verify that the route has this format :action/:iouType/category/:transactionID/:reportID and action param in URL is edit
  7. Select onther category and verify that category is edited successfully
  • Create and edit scan split bill
  1. Go to workspace chat
  2. Create a scan split bill request and select a category
  3. Click on split bill detail
  4. Verify that selected category is displayed as well
  5. Click on category to edit
  6. Verify that the route has this format :action/:iouType/category/:transactionID/:reportID and action param in URL is edit
  7. Select another category and verify that category is edited successfully
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  • create and edit request money
  1. Verify that MoneyRequestCategoryPage is removed with the route, screen, and all use of this page in the app
  2. Create a request money and select a category
  3. Go to transaction thread report
  4. Verify that selected category is displayed as well
  5. Click on category to edit
  6. Verify that the route has this format :action/:iouType/category/:transactionID/:reportID and action param in URL is edit
  7. Select another category and verify that category is edited successfully
  • Create and edit scan split bill
  1. Go to workspace chat
  2. Create a scan split bill request and select a category
  3. Click on split bill detail
  4. Verify that selected category is displayed as well
  5. Click on category to edit
  6. Verify that the route has this format :action/:iouType/category/:transactionID/:reportID?backTo= and action param in URL is edit
  7. Select another category and verify that category is edited successfully
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
  • create and edit request money
Screen.Recording.2024-01-31.at.16.03.51.mov
  • Create and edit scan split bill
Screen.Recording.2024-01-31.at.16.04.25.mov
Android: mWeb Chrome
  • create and edit request money
Screen.Recording.2024-01-31.at.15.59.23.mov
  • Create and edit scan split bill
Screen.Recording.2024-01-31.at.15.59.47.mov
iOS: Native
iOS: mWeb Safari
  • create and edit request money
Screen.Recording.2024-01-31.at.15.55.35.mov
  • Create and edit scan split bill
Screen.Recording.2024-01-31.at.15.56.00.mov
MacOS: Chrome / Safari
  • create and edit request money
Screen.Recording.2024-01-31.at.15.40.47.mov
  • Create and edit scan split bill
Screen.Recording.2024-01-31.at.15.43.30.mov
MacOS: Desktop
  • create and edit request money
Screen.Recording.2024-01-31.at.16.08.55.mov
  • Create and edit scan split bill
Screen.Recording.2024-01-31.at.16.09.15.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review January 31, 2024 09:10
@dukenv0307 dukenv0307 requested a review from a team as a code owner January 31, 2024 09:10
@melvin-bot melvin-bot bot removed the request for review from a team January 31, 2024 09:10
Copy link

melvin-bot bot commented Jan 31, 2024

@DylanDylann 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 DylanDylann January 31, 2024 09:10
@DylanDylann
Copy link
Contributor

@dukenv0307 Please resolve conflict

@dukenv0307
Copy link
Contributor Author

@DylanDylann I updated.

@DylanDylann
Copy link
Contributor

Also resolve conflict, please

@dukenv0307
Copy link
Contributor Author

@DylanDylann I updated.

@dukenv0307
Copy link
Contributor Author

My IOS simulator doesn't work now, please help me to test this.

@DylanDylann
Copy link
Contributor

@dukenv0307 Please fix lint error and resolve conflict

@dukenv0307
Copy link
Contributor Author

@DylanDylann I updated.

@DylanDylann
Copy link
Contributor

@dukenv0307 Please also use IOURequestStepCategory for editing requests and editing split bill

@dukenv0307
Copy link
Contributor Author

@dukenv0307 Please also use IOURequestStepCategory for editing requests and editing split bill

I already used it for the edit case.

@DylanDylann
Copy link
Contributor

Also should remove EditRequestCategoryPage

@@ -101,6 +107,10 @@ function IOURequestStepCategory({
navigateBack();
};

if (!shouldShowCategories) {
return <FullPageNotFoundView shouldShow />;
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about moving FullPageNotFoundView into StepScreenWrapper

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that's good.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DylanDylann moved not found to into StepScreenWrapper .

@DylanDylann
Copy link
Contributor

The changes look good. Testing

@DylanDylann
Copy link
Contributor

DylanDylann commented Feb 20, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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

Android: Native
Screen.Recording.2024-02-21.at.15.24.09-compressed.mov
Android: mWeb Chrome
category-chro.mp4
iOS: Native
Screen.Recording.2024-02-21.at.15.22.35-compressed.mov
iOS: mWeb Safari
category-saf.mp4
MacOS: Chrome / Safari
category-web.mp4
MacOS: Desktop
category-desk.mp4

Copy link
Contributor

@DylanDylann DylanDylann left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from amyevans February 21, 2024 08:36
Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Bug: Can't edit a category in request money. Error: Malformed currency code

I'm experiencing this as well

On main, I'm getting a different error:

Uncaught TypeError: Cannot read properties of undefined (reading 'scrollTop')

so that's fun.

I don't feel comfortable approving/merging until the editing flow can be tested again, so let's wait until it's fixed in main (Slack convo), then merge main and retest.

Comment on lines 773 to 781
Navigation.navigate(ROUTES.MONEY_REQUEST_CATEGORY.getRoute(props.iouType, props.reportID));
Navigation.navigate(ROUTES.MONEY_REQUEST_TAG.getRoute(props.iouType, props.reportID));
Copy link
Contributor

Choose a reason for hiding this comment

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

What's up with this change?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for your catch. @dukenv0307 It seems you update this in this commit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's my mistake.

Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION_DRAFT}${transactionID}`, {category});
}

// eslint-disable-next-line @typescript-eslint/naming-convention
function resetMoneyRequestCategory_temporaryForRefactor(transactionID: string) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm still seeing an instance of this on your branch locally - perhaps from a merge with main?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this to use setMoneyRequestCategory function.

@@ -299,16 +299,10 @@ function setMoneyRequestPendingFields(transactionID: string, pendingFields: Pend
Onyx.merge(`${ONYXKEYS.COLLECTION.TRANSACTION_DRAFT}${transactionID}`, {pendingFields});
}

// eslint-disable-next-line @typescript-eslint/naming-convention
function setMoneyRequestCategory_temporaryForRefactor(transactionID: string, category: string) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Still seeing one usage of this too on your branch

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above.

src/pages/iou/request/step/StepScreenWrapper.js Outdated Show resolved Hide resolved
const {category: transactionCategory} = ReportUtils.getTransactionDetails(isEditingSplitBill ? splitDraftTransaction : transaction);

const isPolicyExpenseChat = ReportUtils.isGroupPolicy(report);
const shouldShowCategories = isPolicyExpenseChat && (transactionCategory || OptionsListUtils.hasEnabledOptions(_.values(policyCategories)));
Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 Should update to shouldShowNotFoundPage

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DylanDylann Updated.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Feb 22, 2024

I don't feel comfortable approving/merging until the editing flow can be tested again, so let's wait until it's fixed in main (Slack convo), then merge main and retest.

@amyevans We can test this now. I tested and It worked well

@amyevans
Copy link
Contributor

Okay great. Was able to test fully, looks good on that front! Let me just give the code another once over quick

@amyevans amyevans merged commit 586ddff into Expensify:main Feb 22, 2024
15 checks passed
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.44-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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