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

[WAVE 7] Hold Requests: Individual Money Request Page, Reason Interstitial, Banner #33897

Merged

Conversation

BartoszGrajdek
Copy link
Contributor

@BartoszGrajdek BartoszGrajdek commented Jan 3, 2024

Details

Fixed Issues

$ #31300

Tests

  1. Send a money request
  2. Open this newly created money request page
  3. In top right corner click three dots and "Hold request" button (in a workspace people able to put the request on hold are: admins, approvers that the request has been sent to, and owner of the money request, in personal IOU all members should be able to put the request on hold)
  4. Check if the hold reason popup was opened
  5. Make sure that an error is being displayed when submitting a hold reason without input being filled
  6. Fill in the hold reason input and submit
  7. Check if the Hold Banner on top has appeared and a system message with a comment has been sent
  8. Log into another account that is a member of the money request and check if everything is displayed properly
  9. On personal IOU requests only the person who has put the request on hold be able to see/use the "Unhold request" button in three dots menu
  10. On workspace money request admin, the approver that the request has been sent to and the person that put the money request on hold should be able to see/use the "Unhold request" button
  11. Click the "Unhold request" button and check if a system message has been sent saying that the request has been unheld
  12. Check different accounts with different permissions, and make sure that the "Hold request" & "Unhold request" buttons are being displayed and working for proper accounts (according to the description above)

Offline tests

  1. Send a money request (this and the second step can be both done in offline and online mode to check permissions)
  2. Open this newly created money request page
  3. In the top right corner click three dots and the "Hold request" button (in a workspace people able to put the request on hold are: admins, approvers that the request has been sent to, and owner of the money request, in personal IOU all members should be able to put the request on hold)
  4. Check if the hold reason popup was opened
  5. Make sure that an error is being displayed when submitting a hold reason without input being filled
  6. Fill in the hold reason input and submit
  7. Check if the Hold Banner on top has appeared and a system message with a comment has been sent
  8. On personal IOU requests only the person who has put the request on hold be able to see/use the "Unhold request" button in three dots menu
  9. On workspace money request admin, the approver that the request has been sent to and the person that put the money request on hold should be able to see/use the "Unhold request" button
  10. Click the "Unhold request" button and check if a system message has been sent saying that the request has been unheld
  11. Check different accounts with different permissions, and make sure that the "Hold request" & "Unhold request" buttons are being displayed and working for proper accounts (according to the description above)

QA Steps

  1. Send a money request
  2. Open this newly created money request page
  3. In top right corner click three dots and "Hold request" button (in a workspace people able to put the request on hold are: admins, approvers that the request has been sent to, and owner of the money request, in personal IOU all members should be able to put the request on hold)
  4. Check if the hold reason popup was opened
  5. Make sure that an error is being displayed when submitting a hold reason without input being filled
  6. Fill in the hold reason input and submit
  7. Check if the Hold Banner on top has appeared and a system message with a comment has been sent
  8. Log into another account that is a member of the money request and check if everything is displayed properly
  9. On personal IOU requests only the person who has put the request on hold be able to see/use the "Unhold request" button in three dots menu
  10. On workspace money request admin, the approver that the request has been sent to and the person that put the money request on hold should be able to see/use the "Unhold request" button
  11. Click the "Unhold request" button and check if a system message has been sent saying that the request has been unheld
  12. Check different accounts with different permissions, and make sure that the "Hold request" & "Unhold request" buttons are being displayed and working for proper accounts (according to the description 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
android.mov
Android: mWeb Chrome
chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
safari.mov
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@BartoszGrajdek BartoszGrajdek changed the title feat: add hold implementation [WAVE 7] Hold Requests: Individual Money Request Page, Reason Interstitial, Banner Jan 3, 2024
src/components/MoneyRequestHeader.js Outdated Show resolved Hide resolved
src/languages/es.ts Show resolved Hide resolved
@robertjchen
Copy link
Contributor

robertjchen commented Feb 16, 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@robertjchen robertjchen merged commit 7fd529b into Expensify:main Feb 16, 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/robertjchen in version: 1.4.43-0 🚀

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

valueType="string"
name="comment"
defaultValue={undefined}
label="Reason"
Copy link
Contributor

Choose a reason for hiding this comment

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

@BartoszGrajdek We missed translate here and that created #36826
Do you please mind pushing a quick fix?

@MonilBhavsar
Copy link
Contributor

We have this another issue where composer stays focussed when Hold Request RHP is open. If anyone is interested in taking it 🙏 #36829

{
type: CONST.REPORT.MESSAGE.TYPE.TEXT,
style: 'normal',
text: `held this money request with the comment: ${comment}`,
Copy link
Contributor

Choose a reason for hiding this comment

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

And we're also missing translate here and at L3548 below that caused #36836.

@dragnoir
Copy link
Contributor

We have this another issue where composer stays focussed when Hold Request RHP is open. If anyone is interested in taking it 🙏 #36829

I created a proposal #36829 (comment)

@BartoszGrajdek
Copy link
Contributor Author

@MonilBhavsar I can create a PR fixing all the regressions you've mentioned, just let me know if you treat this as a regression as well - I think it is one, but I can already see some proposals there, so I don't want to cause any confusion

@BartoszGrajdek
Copy link
Contributor Author

Never mind, I can see that you started working on the translation fixes in your PR. I can work on the composer bug, so I am still waiting for info on that one @MonilBhavsar

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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

validate={validate}
enabledWhenOffline
>
<Text style={[styles.textHeadline, styles.mb6]}>{translate('iou.explainHold')}</Text>
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't have set styles.textHeadline style for consistency with other pages.

Comment on lines +51 to +59
const validate = useCallback((values: FormOnyxValues<typeof ONYXKEYS.FORMS.MONEY_REQUEST_HOLD_FORM>) => {
const errors: FormInputErrors<typeof ONYXKEYS.FORMS.MONEY_REQUEST_HOLD_FORM> = ValidationUtils.getFieldRequiredErrors(values, [INPUT_IDS.COMMENT]);

if (!values.comment) {
errors.comment = 'common.error.fieldRequired';
}

return errors;
}, []);
Copy link
Contributor

Choose a reason for hiding this comment

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

Quite an edge case but when user A opens hold request reason and another user B settles the request in the same time, the user A presses the hold button but gets no feedback nor reason page closes. ref: #37014

@sobitneupane
Copy link
Contributor

sobitneupane commented May 7, 2024

#37554 issue is probably a regression from this PR.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented May 16, 2024

This PR causes a regression #37536. Hold Option should not be shown while report is in Scanning state (Not sure whether it was the case before). Also minor alignment issue.

reportActionID: createdReportAction.reportActionID,
},
{optimisticData, successData, failureData},
);
Copy link
Contributor

Choose a reason for hiding this comment

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

We should call Report.notifyNewAction(currentReportID, userAccountID); here to trigger scroll to bottom. Ref: #49959

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.