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

feat: [Held requests] option does not show in the preview overflow menu. #42034

Merged
merged 13 commits into from
Jun 11, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented May 13, 2024

Details

Fixed Issues

$ #41440
PROPOSAL: #41440 (comment)

Tests

  1. Create one or two expenses on a Collect policy
  2. Navigate to Workspace Chat > Report
  3. Hover over an expense
  4. Click the three dots in the comment action menu
  5. Verify there is a hold option > click on hold > enter reason > submit
  6. Go to expense report page > verify the report is held > go back
  7. Hover on the same report
  8. Verify unhold option is there > click on unhold
  9. Go to expense report page > verify the report is unheld
  • Verify that no errors appear in the JS console

Offline tests

  1. Create one or two expenses on a Collect policy
  2. Navigate to Workspace Chat > Report
  3. Hover over an expense
  4. Click the three dots in the comment action menu
  5. Verify there is a hold option > click on hold > enter reason > submit
  6. Go to expense report page > verify the report is held > go back
  7. Hover on the same report
  8. Verify unhold option is there > click on unhold
  9. Go to expense report page > verify the report is unheld

QA Steps

  1. Create one or two expenses on a Collect policy
  2. Navigate to Workspace Chat > Report
  3. Hover over an expense
  4. Click the three dots in the comment action menu
  5. Verify there is a hold option > click on hold > enter reason > submit
  6. Go to expense report page > verify the report is held > go back
  7. Hover on the same report
  8. Verify unhold option is there > click on unhold
  9. Go to expense report page > verify the report is unheld
  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested a review from a team as a code owner May 13, 2024 04:32
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team May 13, 2024 04:32
Copy link

melvin-bot bot commented May 13, 2024

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

@Krishna2323 Krishna2323 marked this pull request as draft May 13, 2024 04:32
@hungvu193
Copy link
Contributor

hey @Krishna2323 , it's been a while, do you have any ETA for this?

@Krishna2323
Copy link
Contributor Author

@hungvu193, I will update this today or tomorrow. Sorry for the delay, I'm not at my workplace.

@Krishna2323 Krishna2323 marked this pull request as ready for review May 17, 2024 09:03
@Krishna2323
Copy link
Contributor Author

@hungvu193, can you pls give this PR a quick look, if everything seems fine to you, I will add the screenshot.

@hungvu193
Copy link
Contributor

I'll take a look in a few hours 👀

@hungvu193
Copy link
Contributor

@hungvu193, can you pls give this PR a quick look, if everything seems fine to you, I will add the screenshot.

Please add the screenshots

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved
src/pages/home/report/ContextMenu/ContextMenuActions.tsx Outdated Show resolved Hide resolved
Comment on lines +2772 to +2780
if (reportAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.IOU) {
return;
}
const moneyRequestReportID = reportAction?.originalMessage?.IOUReportID ?? 0;

const moneyRequestReport = getReport(String(moneyRequestReportID));
if (!moneyRequestReportID || !moneyRequestReport) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we merge these 2 conditions?

if (reportAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.IOU || !moneyRequestReportID || !moneyRequestReport) {
return;
}

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 thats fine, reportAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.IOU check is required before defining moneyRequestReport or moneyRequestReportID.

@hungvu193
Copy link
Contributor

little bump here @Krishna2323

@Krishna2323
Copy link
Contributor Author

@hungvu193, sorry for delay, I will add the recordings today.

@mallenexpensify
Copy link
Contributor

@Krishna2323 as part of Rule #1, Get Shit Done, please be sure to action upon any existing issues/PRs before submitting new proposals. CONTRIBUTING.md is being updated to specifically mention this too

Contributors should not submit proposals on issues when they have assigned issues or PRs that are awaiting an action from them. If so, they will be in violation of Rule #1 (Get Shit Done) in our Code of Conduct and will receive a warning. Multiple warnings can lead to removal from the program.

We'll be issuing warnings for these infractions in the future. This is not a warning though, since CONTRIBUTING.md isn't updated yet (and I haven't posted in #expensify-open-source about the update either)

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented May 21, 2024

@hungvu193, I have added the recordings, can you pls review once again?

@hungvu193
Copy link
Contributor

@hungvu193, I have added the recordings, can you pls review once again?

Ok. I'll take a look in next few hours

@@ -2707,6 +2715,80 @@ function canEditReportAction(reportAction: OnyxEntry<ReportAction>): boolean {
);
}

function getParentReportAction(parentReportActions: OnyxEntry<ReportActions>, parentReportActionID: string | undefined): OnyxEntry<ReportAction> {
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought you mentioned you removed this one?

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 re-added this as the other function is deprecated and we are using this function in ReportScreen also.

Copy link
Contributor

Choose a reason for hiding this comment

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

@robertjchen This is my concern, we should use deprecated function or creating a new one here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason why we can't use Use Onyx.connect() or withOnyx() instead as recommended by the deprecation comment? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

@Krishna2323 Bump on the above question.

I checked ReportUtils, I saw that we're still using ReportActionsUtils.getParentReportAction(report); to get parentReportActions.

Copy link
Contributor

Choose a reason for hiding this comment

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

little bump @Krishna2323 so we can merge this one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hungvu193, I think we can leave getParentReportAction as it is for now. It will be removed/replaced in this issue, and we are already using getParentReportAction in multiple places.

function getParentReportAction(parentReportActions: OnyxEntry<OnyxTypes.ReportActions>, parentReportActionID: string | undefined): OnyxEntry<OnyxTypes.ReportAction> {
if (!parentReportActions || !parentReportActionID) {
return null;
}
return parentReportActions[parentReportActionID ?? '0'];
}

@tgolen, can you pls confirm if we are going to replace getParentReportAction or not? I don't see any open issue/PR for that.

Copy link
Contributor

Choose a reason for hiding this comment

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

What are your thoughts on this, @robertjchen? Since we're already using the deprecated getParentReportAction in ReportUtils, I'm okay with using it until we have a plan to remove it all at once.

Copy link
Contributor

@robertjchen robertjchen Jun 6, 2024

Choose a reason for hiding this comment

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

Sounds good, given the current progress on the migration- we can use the deprecated function for now 👍

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 confirming 😄 .
@Krishna2323 Can you update this please? Thank you 🙇

@hungvu193
Copy link
Contributor

hungvu193 commented May 22, 2024

Not sure if this is related but every time I held an expense, I saw a RBR.
Also the number of replies only updated after I clicked that expense and went back.

Screen.Recording.2024-05-22.at.09.17.28.mov

@hungvu193
Copy link
Contributor

Not sure if this is related but every time I held an expense, I saw a RBR. Also the number of replies only updated after I clicked that expense and went back.

Screen.Recording.2024-05-22.at.09.17.28.mov

How about this one? @Krishna2323

@Krishna2323
Copy link
Contributor Author

@hungvu193, I need to check for that, the reply count update doesn't seem to be related but I will check and RBR is expected behaviour afaik

@hungvu193
Copy link
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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.native.mov
Android: mWeb Chrome
mAndroid.mov
iOS: Native
ios.native.mov
iOS: mWeb Safari
mSafari.mov
MacOS: Chrome / Safari
chrome.mov
MacOS: Desktop
desk.mov

@hungvu193
Copy link
Contributor

I need to check for that, the reply count update doesn't seem to be related but I will check

Let's me know when you finish your investigation so we can merge this one. Thank you 😄

@trjExpensify
Copy link
Contributor

@Krishna2323 how did you get on? Will you complete that today?

@hungvu193
Copy link
Contributor

Let's me know if you have any new update @Krishna2323

@Krishna2323
Copy link
Contributor Author

@hungvu193, still trying to get the solution, it would be great if you can look once.

const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${moneyRequestReport.policyID}`] ?? null;

if (isOnHold) {
IOU.unholdRequest(transactionID, reportAction.childReportID ?? '');
Copy link
Contributor

Choose a reason for hiding this comment

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

In here, you updated the hold expense with its childReportID, in our BE we didn't send Pusher event to update its parent that's why our replies didn't increase when you held the expense.

Copy link
Contributor

Choose a reason for hiding this comment

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

This seems that we will need BE changes here cc @robertjchen.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hungvu193, thanks a lot for looking into this, I agree with you.

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it, so the backend should also push updates for the parent report here, is that correct?

Could you let me know which particular field changes in the parent report that makes the update from the backend necessary? 👀

Copy link
Contributor

Choose a reason for hiding this comment

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

childVisibleActionCount is the current field to count the replies.
Since we also added a comment when we held request, I think the pusher event will be exactly the same when we added a new comment inside a thread.

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it, we can investigate- can this PR go out ahead of the backend changes or is it blocked until that field is available?

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 we can go ahead with this PR first, but let's leave a note for QA team that the issue about counting replies will be fixed once BE PR is deployed.

@melvin-bot melvin-bot bot requested a review from robertjchen May 28, 2024 02:37
@hungvu193
Copy link
Contributor

We have conflicts here @Krishna2323

@trjExpensify
Copy link
Contributor

Bump on the conflicts, thanks!

@Krishna2323
Copy link
Contributor Author

conflicts resolved.

@trjExpensify
Copy link
Contributor

I'm unclear what we're waiting on here, @robertjchen? (coming from here)

@robertjchen
Copy link
Contributor

@trjExpensify There's ongoing discussion in the comments above, once those are wrapped up we can merge 👍

@robertjchen
Copy link
Contributor

@Krishna2323 Just need a final change here and we should be good to go! #42034 (comment)

@robertjchen
Copy link
Contributor

Looks like a final lint issue and we should be good to merge 👍

@hungvu193
Copy link
Contributor

All yours @robertjchen

Copy link
Contributor

@robertjchen robertjchen left a comment

Choose a reason for hiding this comment

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

Perfect, thank you!

@robertjchen robertjchen merged commit 65db650 into Expensify:main Jun 11, 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.82-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.82-4 🚀

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

@JmillsExpensify
Copy link

Hey ya'll! Any idea why I'm not able to get hold to appear in the overflow menu on a report that's with me for approval?

CleanShot 2024-06-24 at 21 40 38

@hungvu193
Copy link
Contributor

it might relate to #43589
is that non-reimbursable transaction?

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.

7 participants