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

Fix/34609: Remove old description page #35137

Merged
merged 34 commits into from
Feb 7, 2024
Merged

Conversation

DylanDylann
Copy link
Contributor

@DylanDylann DylanDylann commented Jan 25, 2024

Details

Remove MoneyRequestDescriptionPage and EditRequestDescriptionPage and only use IOURequestStepDescription for all description pages

Fixed Issues

$ #34609
PROPOSAL: #34609 (comment)

Tests

  1. Create a new request
  2. While creating a new request click on the description field
  3. Verify that the route display /create/request/
  4. After creating request click on description field to edit
  5. Verify that the route display /edit/request/
  6. Create a split bill
  7. While creating a new split bill click on the description field
  8. Verify that the route display /create/split/
  9. After creating a new split bill click on description field to edit
  10. Verify that the route display /edit/split/
  11. Verify that everything works well as before
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Same above

  • 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
a1.mp4
a2.mp4
Android: mWeb Chrome
c.mp4
iOS: Native
i.mp4
iOS: mWeb Safari
s.mp4
MacOS: Chrome / Safari
w.mp4
MacOS: Desktop
d.mp4

@DylanDylann DylanDylann marked this pull request as ready for review January 25, 2024 10:35
@DylanDylann DylanDylann requested a review from a team as a code owner January 25, 2024 10:35
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team January 25, 2024 10:35
Copy link

melvin-bot bot commented Jan 25, 2024

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

Comment on lines 73 to 88
const newComment = value.moneyRequestComment;
// Only update comment if it has changed
if (newComment.trim() !== lodashGet(transaction, 'comment.comment', '')) {
if (isDraft) {
IOU.setMoneyRequestDescription_temporaryForRefactor(transactionID, newComment, isDraft);
} else {
if (iouType === CONST.IOU.TYPE.REQUEST) {
IOU.updateMoneyRequestDescription(transaction.transactionID, reportID, newComment.trim());
}
if (iouType === CONST.IOU.TYPE.SPLIT) {
IOU.setDraftSplitTransaction(transaction.transactionID, {
comment: newComment.trim(),
});
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I expected to see all this logic handled in setMoneyRequestDescription_temporaryForRefactor

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

Comment on lines 666 to 677
if (props.isEditingSplitBill) {
Navigation.navigate(ROUTES.EDIT_SPLIT_BILL.getRoute(props.reportID, props.reportActionID, CONST.EDIT_REQUEST_FIELD.DESCRIPTION));
if (!props.isEditingSplitBill) {
return;
}
Navigation.navigate(ROUTES.MONEY_REQUEST_DESCRIPTION.getRoute(props.iouType, props.reportID));
Navigation.navigate(
ROUTES.MONEY_REQUEST_STEP_DESCRIPTION.getRoute(
CONST.IOU.ACTION.EDIT,
CONST.IOU.TYPE.SPLIT,
transaction.transactionID,
props.reportID,
Navigation.getActiveRouteWithoutParams(),
),
);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why we are assuming that this is going to be used for edits only? (similar question for MoneyTemporaryForRefactorRequestConfirmationList.js)

Copy link
Contributor Author

@DylanDylann DylanDylann Jan 27, 2024

Choose a reason for hiding this comment

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

@s77rt if props.isEditingSplitBill is false, we will disable this field by this logic

interactive={!props.isReadOnly}

Because of isReadOnly={!isEditingSplitBill}

Copy link
Contributor

Choose a reason for hiding this comment

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

The isReadOnly is a different prop and we can't assume it will always be related to isEditingSplitBill.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why we are assuming that this is going to be used for edits only?

@s77rt In that time, there was only editing split bill that used this component and this component MoneyRequestConfirmationList also be removed in this refactor phrase. But you're right, we can't assume that this is going to be used for edits only. So I updated in this commit to remove condition

 if (!props.isEditingSplitBill) {
                        return;
}

and using iouType as param of navigate function

Copy link
Contributor

Choose a reason for hiding this comment

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

@DylanDylann Is there any need to change the logic there? Can't we just keep using the same logic (i.e. keep isEditingSplitBill conditions) and navigate to the correct pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt We need to change logic to use a new route to IOURequestStepDescription for both case. The above code is outdated. This is code after updating

Screenshot 2024-01-31 at 23 51 43

@s77rt
Copy link
Contributor

s77rt commented Jan 26, 2024

Trying to edit a split bill request crashes the app, please make sure we are replacing all the old routes

Screen.Recording.2024-01-26.at.7.20.13.PM.mov

@DylanDylann
Copy link
Contributor Author

@s77rt I can't reproduce your bug

so.mp4

Could you help to point out the step to create this request?

src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/pages/EditRequestPage.js Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/pages/EditSplitBillPage.js Outdated Show resolved Hide resolved
src/pages/EditSplitBillPage.js Outdated Show resolved Hide resolved
src/pages/EditRequestPage.js Outdated Show resolved Hide resolved
src/pages/EditRequestPage.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
@DylanDylann
Copy link
Contributor Author

@s77rt Thanks for your commit suggestion. I updated

src/libs/actions/IOU.js Outdated Show resolved Hide resolved
@DylanDylann
Copy link
Contributor Author

@s77rt From your comment, I think we should revert this change in here. I agree with you that

it will be much confusing to see isDraft false yet still update the drafts collections

But we have 3 cases when user enter description and click save button:

  1. Create money request/Create split bill: We will save description to transactionsDraft and only send API if user click request money
  2. Edit money request: Send API immediately to update new description
  3. Edit split bill: We will save description to splitTransactionsDraft and only send API if user click save in the detail split bill page

@DylanDylann
Copy link
Contributor Author

DylanDylann commented Jan 29, 2024

Note that in case 3: we only call setDraftSplitTransaction if isDraft is true and iouType === CONST.IOU.TYPE.SPLIT. Draft in isDraft and draft in setDraftSplitTransaction are different. Draft in isDraft is to check if it is creating or editing flow. draft in setDraftSplitTransaction is a draft description. We can consider to rename one of them to be more clear. Please correct me if I miss anything

@s77rt
Copy link
Contributor

s77rt commented Jan 29, 2024

Edit money request: Send API immediately to update new description

We should update the transaction too same as we do with receipt

@s77rt
Copy link
Contributor

s77rt commented Jan 29, 2024

#35137 (comment)

Creating/Editing a split request => isDraft = true (and a comment explaining the reason)
Creating/Editing a regular request => isDraft = action === CREATE

@DylanDylann
Copy link
Contributor Author

@s77rt

Creating/Editing a split request => isDraft = true (and a comment explaining the reason)

We still need to use action param to check if it is Creating/editing a split bill request

Creating a split bill request => save to transactionDraft
Editing a split bill request => save to splitTransactionDraft

@s77rt
Copy link
Contributor

s77rt commented Jan 30, 2024

Creating a split bill request => save to transactionDraft

Is that the current behavior on main? Don't we save to splitTransactionDraft?

@DylanDylann
Copy link
Contributor Author

@s77rt Do you know how to re-run Reassure Performance Tests ?

@DylanDylann
Copy link
Contributor Author

I have seen this problem many times while implementing PR. I ofter merge the main and push a new commit to re-run Reassure Performance Tests

@s77rt
Copy link
Contributor

s77rt commented Feb 6, 2024

Any new commits should trigger the test but it seems unstable, even after merging main it could still fail

@DylanDylann
Copy link
Contributor Author

@s77rt What do you think about putting splitDraftTransaction into WithFullTransactionOrNotFound? In general, It will help us dry code a lot

@s77rt
Copy link
Contributor

s77rt commented Feb 6, 2024

It may not help us well as we will still need to check if splitDraftTransaction is empty and if it is then we would need to use transaction instead. So we will still subscribe to two onyx values afterall.

@DylanDylann
Copy link
Contributor Author

DylanDylann commented Feb 6, 2024

@s77rt I mean

putting splitDraftTransaction into WithFullTransactionOrNotFound

to avoid the use withOnyx in IOURequestStepDescription and many other similar pages

@s77rt
Copy link
Contributor

s77rt commented Feb 6, 2024

But we will be returning two transactions from withFullTransactionOrNotFound: transaction and splitDraftTransaction. Is that what you meant?

@DylanDylann
Copy link
Contributor Author

Yes. I checked all the places that used withFullTransactionOrNotFound. And see that almost places also need to import splitDraftTransaction to handle similar case as we did here

@deetergp
Copy link
Contributor

deetergp commented Feb 6, 2024

You can generally restart the either the failing tests or all the tests by clicking "Details" next to the failing test and selecting "Re-Run Jobs" at the top right. With that said, I restarted the failing job twice and it continued to fail. Can you please try pulling main into your branch and try again?

@s77rt
Copy link
Contributor

s77rt commented Feb 6, 2024

@DylanDylann I think it's fine to keep it that way for now. If anything a follow would be better than handling it here

@DylanDylann
Copy link
Contributor Author

@deetergp All jobs are successful. Please help to check again

@deetergp
Copy link
Contributor

deetergp commented Feb 7, 2024

@DylanDylann I just came here to say "It looks like the tests were fixed here" 😂

Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

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

Changes look good and test well 👍

@deetergp deetergp merged commit f88d526 into Expensify:main Feb 7, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

✋ 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

OSBotify commented Feb 8, 2024

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.39-0 🚀

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

@lanitochka17
Copy link

This PR is failing because of issue #36175

The issue is reproducible in: IOS Android mWeb

Bug6372489_1707422129564.Screen_Recording_20240209_032141_New_Expensify.1.mp4

arosiclair added a commit that referenced this pull request Feb 9, 2024
This reverts commit f88d526, reversing
changes made to 880e187.
CONST.IOU.TYPE.REQUEST,
transaction?.transactionID ?? '',
report.reportID,
Navigation.getActiveRouteWithoutParams(),
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this needs to be removed maybe?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.39-8 🚀

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

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.

6 participants