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 - Expense - Submit button appears for archived workspace chat if delayed submission is enabled #52183

Open
wants to merge 41 commits into
base: main
Choose a base branch
from

Conversation

FitseTLT
Copy link
Contributor

@FitseTLT FitseTLT commented Nov 7, 2024

Details

Fixed Issues

$ #49169
PROPOSAL: #49169 (comment)

Tests

  1. Create a workspace from User A and enable workflow and manual submission
  2. Invite User B
  3. Submit an expense report from User B's account
  4. Remove User B from the workspace using User A's account
  5. From User B side open the archive workspace chat
  6. Open the expense report you submitted in (3)
  7. Verify that composer is visible (not hidden) and you can comment, all context menu work correctly like reply in thread, react.
  8. Verify that you can edit the expense fields like date, receipt, description, merchant, amount.
  9. Verify that you cannot submit (submit button doesn't appear)
  10. Verify that you cannot create expense on the archived expense report.
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as 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(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If 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
2025-01-06.20-29-11.mp4
Android: mWeb Chrome
2025-01-06.20-36-52.mp4
iOS: Native
2025-01-06.20-48-38.mp4
iOS: mWeb Safari
2025-01-06.20-41-20.mp4
MacOS: Chrome / Safari
2025-01-06.20-50-26.mp4
MacOS: Desktop
2025-01-06.20-51-55.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner November 7, 2024 13:33
@melvin-bot melvin-bot bot requested a review from Ollyws November 7, 2024 13:33
Copy link

melvin-bot bot commented Nov 7, 2024

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

@FitseTLT FitseTLT requested a review from srikarparsi November 11, 2024 10:52
@srikarparsi
Copy link
Contributor

@FitseTLT what's the ETA for this PR? It's holding up a couple other PRs so just wanted to check. Also, we should try to be a little careful with this since it has a chance to cause regressions. By this, I mean that we should check all occurrences of isArchivedRoom and isArchivedRoomWithID to make sure that any that deal with expense reports are switched over to isArchivedExpenseReport. Otherwise, archived expense reports will be able to be Paid, Submitted or Approved which we don't want.

@FitseTLT
Copy link
Contributor Author

@FitseTLT what's the ETA for this PR? It's holding up a couple other PRs so just wanted to check. Also, we should try to be a little careful with this since it has a chance to cause regressions. By this, I mean that we should check all occurrences of isArchivedRoom and isArchivedRoomWithID to make sure that any that deal with expense reports are switched over to isArchivedExpenseReport. Otherwise, archived expense reports will be able to be Paid, Submitted or Approved which we don't want.

I am working on it. Will provide update tomorrow 👍

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Nov 14, 2024

I have checked all instances of isArchivedRoom and isArchivedRoomWithID and I have listed down some case I want confirmation from U

  1. I believe we don't want to hide edit, flag as offensive, delete action, join thread menu items for archive expense report.
  2. if (!isArchivedReport) {
    return {icon: getStatusIcon(Expensicons.Hourglass), description: translate('iou.bookingPendingDescription')};
    }
    if (isArchivedReport && archiveReason === CONST.REPORT.ARCHIVE_REASON.BOOKING_END_DATE_HAS_PASSED) {
    return {icon: getStatusIcon(Expensicons.Box), description: translate('iou.bookingArchivedDescription')};
    }

    if (!isArchivedReport) {
    return {shouldShow: true, messageIcon: Expensicons.Hourglass, messageDescription: translate('iou.bookingPending')};
    }
    if (isArchivedReport && archiveReason === CONST.REPORT.ARCHIVE_REASON.BOOKING_END_DATE_HAS_PASSED) {

    which I think you were discussing about above and you should help me what to do with them.
  3. canAddTransaction, canDeleteTransaction, ??
  4. getReasonAndReportActionThatRequiresAttention we return null if it is archived room or the parent report is.
    Should it require attention?
  5. getPolicyExpenseChatName , getReportName whether to show archived suffix
  6. reasonForReportToBeInOptionList: Archived reports should always be shown when in default (most recent) mode
  7. shouldShowFlagComment - we don't show flag comment page for archived pages should we
  8. shouldReportShowSubscript - we don't show subtitle for archived reports, what about our for expense reports
  9. canUserPerformWriteAction - I think we want to allow write action in order to allow commenting
  10. shouldDisableThread - we want to enable reply in thread (let me know if you disagree
  11. getOrderedReportIDs - we order the archived reports last in LHN
  12. BaseReportActionContextMenu - whether to show hold and unhold menu in context menu
  13. ReportActionItem - I don't think we want to disable emoji picker button in ReportActionItemMessageEdit
  14. In report details page - we are currently showing cancel payment, unapproved, delete expense and oddly it works the BE correctly handles them. WDYT we should leave it ??

Now to confirm: You are aiming to set is_privateArchived for expense reports from BE. Correct me if I am wrong.

Last question: I know we want to allow commenting and so on on open archive expense reports but what about settled archived reports we want the same behaviour as the unsettled one? This might also decide our isArchivedExpenseReport.

@srikarparsi
Copy link
Contributor

Thank you for all the questions @FitseTLT, I'll get to them tomorrow since I need to look at some of the backend code

@srikarparsi
Copy link
Contributor

srikarparsi commented Nov 19, 2024

I believe we don't want to hide edit, flag as offensive, delete action, join thread menu items for archive expense report.

Yes, since they are still able to be commented on, we don't want to hide these menu items

What to do with ARCHIVE_REASON.BOOKING_END_DATE_HAS_PASSED

We do want to show this as archived. So the isArchivedReport should query for the last action and if it is this, then even if it's an expense report, then it should still be considered as archived.

canAddTransaction, canDeleteTransaction, ??

This should not be possible with isArchivedReport or isArchivedExpenseReport

getReasonAndReportActionThatRequiresAttention we return null if it is archived room or the parent report is. Should it require attention?

I think no right now because there is nothing actionable on these expense reports so they shouldn't have RBRs or GBRs. (The move button doesn't exist yet). But @trjExpensify could you help confirm?

getPolicyExpenseChatName , getReportName whether to show archived suffix

No, we should not show the archived suffix for expense reports

reasonForReportToBeInOptionList: Archived reports should always be shown when in default (most recent) mode

Yes, but for the expense reports, the reason should not be archived but rather the regular expense report reasons.

shouldShowFlagComment - we don't show flag comment page for archived pages should we

Yes, we should show it for expense reports because they are still able to be commented on

shouldReportShowSubscript - we don't show subtitle for archived reports, what about our for expense reports

Yes, we should show subscript, expense reports shouldn't be visibly archived in the frontend.

canUserPerformWriteAction - I think we want to allow write action in order to allow commenting

Yes.

shouldDisableThread - we want to enable reply in thread (let me know if you disagree

Yes, we want to enable reply in thread

getOrderedReportIDs - we order the archived reports last in LHN

Expense reports shouldn't be considered archived so we don't want to order these last

BaseReportActionContextMenu - whether to show hold and unhold menu in context menu

I don't believe we want to show hold and unhold either for archived expense reports. @trjExpensify do you think you can confirm this one as well.

ReportActionItem - I don't think we want to disable emoji picker button in ReportActionItemMessageEdit

Yes, we do not for archived expense reports.

In report details page - we are currently showing cancel payment, unapproved, delete expense and oddly it works the BE correctly handles them. WDYT we should leave it ??

I don't think we want to show any action buttons on archived expense reports. @trjExpensify can you please help confirm this one as well?

You are aiming to set is_privateArchived for expense reports from BE. Correct me if I am wrong.

Yes, but after we merge this PR so that users are able to continue commenting on expense reports. If we do that first before merging this PR, users won't be able to comment on expense reports until this PR gets deployed.

I know we want to allow commenting and so on on open archive expense reports but what about settled archived reports we want the same behaviour as the unsettled one?

Yes, I believe we want the same behavior for all expense reports. I had the same question here and @trjExpensify recommended we should retain the ability to chat on all archived expense reports.

Please let me know if you have any other questions.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Nov 21, 2024

@srikarparsi Applied all changes. Only doubt here

const isArchivedReport = ReportUtils.isArchivedRoomWithID(iouReportID);

const isArchivedReport = ReportUtils.isArchivedRoomWithID(moneyRequestReport?.reportID);

We use the variable to determine the status bar prop. I know I asked you last time but it is not clear to me can you tell me directly what function to use, is it isArchivedNonExpenseReport or isArchivedAnyReport ?

@trjExpensify
Copy link
Contributor

Sorry, I weirdly didn't catch this in my inbox until that latest comment.

I think no right now because there is nothing actionable on these expense reports so they shouldn't have RBRs or GBRs. (The move button doesn't exist yet). But @trjExpensify could you help confirm?

Agreed, no RBR/GBR. We should add the ability to change the workspace the expense report is on soon though!

BaseReportActionContextMenu - whether to show hold and unhold menu in context menu

I don't believe we want to show hold and unhold either for archived expense reports. @trjExpensify do you think you can confirm this one as well.

Hmm, I don't see a reason to restrict these.

In report details page - we are currently showing cancel payment, unapproved, delete expense and oddly it works the BE correctly handles them. WDYT we should leave it ??

I don't think we want to show any action buttons on archived expense reports. @trjExpensify can you please help confirm this one as well?

Same here, I think we should leave these as they are. OldDot doesn't restrict actions like reject, unapprove, delete etc when the workspace is deleted. Only Submit > Approve > Pay.

Yes, I believe we want the same behavior for all expense reports. I had the same question #49169 (comment) and @trjExpensify recommended we should retain the ability to chat on all archived expense reports.

Agreed.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Nov 22, 2024

@srikarparsi I will need a confirmation on two of @trjExpensify responses and will make the changes as soon as you guys agree on it but the other responses are already aligned to the current code 👍
BaseReportActionContextMenu - whether to show hold and unhold menu in context menu

I don't believe we want to show hold and unhold either for archived expense reports. @trjExpensify do you think you can confirm this one as well.

Hmm, I don't see a reason to restrict these.

In report details page - we are currently showing cancel payment, unapproved, delete expense and oddly it works the BE correctly handles them. WDYT we should leave it ??

I don't think we want to show any action buttons on archived expense reports. @trjExpensify can you please help confirm this one as well?

Same here, I think we should leave these as they are. OldDot doesn't restrict actions like reject, unapprove, delete etc when the workspace is deleted. Only Submit > Approve > Pay.

@srikarparsi
Copy link
Contributor

srikarparsi commented Nov 22, 2024

Thanks @trjExpensify and @FitseTLT. Let's move forward with what @trjExpensify said in this comment, I also agree with it.

@srikarparsi
Copy link
Contributor

Hey @FitseTLT, how is this one looking? Do you think this can be ready for review today?

@FitseTLT FitseTLT marked this pull request as ready for review January 6, 2025 17:53
@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 6, 2025

Ready for review 👍 @srikarparsi @Ollyws

@Ollyws
Copy link
Contributor

Ollyws commented Jan 6, 2025

Great, will review asap.

@@ -32,12 +32,12 @@ function ReportActionItem({action, report, ...props}: PureReportActionItemProps)
{selector: (transaction) => transaction?.errorFields?.route ?? null},
);
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- This is needed to prevent the app from crashing when the app is using imported state.
const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID}`);
const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID || undefined}`);
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this necessary? reportID would be undefined already no?

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 do ?? CONST.DEFAULT_NUMBER_ID instead? This would be more in line with the rest of the code.

Copy link
Contributor Author

@FitseTLT FitseTLT Jan 7, 2025

Choose a reason for hiding this comment

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

The reason I chose undefined is because it aligns with the guide as we are trying to give a fallback for a string id, we use DEFAULT_NUMBER_ID for number ids. And ?? doesn't help here because we want to avoid empty string because it will cause a crash when switching from empty string to some non-empty string.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 6, 2025 via email

@Ollyws
Copy link
Contributor

Ollyws commented Jan 7, 2025

If we delete the workspace (without first removing the user) Create expense still exists and the backend throws an error if you create one. This also happens on staging:

Screenshot 2025-01-07 at 14 38 41

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 7, 2025

If we delete the workspace (without first removing the user) Create expense still exists and the backend throws an error if you create one. This also happens on staging:

Screenshot 2025-01-07 at 14 38 41

Yep because the necessary BE changes hasn't been applied that's why you should test only the removing user case 👍

@Ollyws
Copy link
Contributor

Ollyws commented Jan 8, 2025

Continuing testing, will try to have this one reviewed today/tomorrow.

@Ollyws
Copy link
Contributor

Ollyws commented Jan 8, 2025

Do we want to do something about getLastMessageTextForReport?
This still shows "This chatroom has been archived" in the share destination even when it's an expense report:

Screenshot 2025-01-08 at 11 36 22

@srikarparsi
Copy link
Contributor

srikarparsi commented Jan 8, 2025

Good call, we should fix that. We will also fix this in the backend by not adding the closed action to reportActions for expense reports. But we should also make sure that this is updated in the frontend at getLastMessageTextForReport as you mentioned.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 8, 2025

Do we want to do something about getLastMessageTextForReport? This still shows "This chatroom has been archived" in the share destination even when it's an expense report:

Screenshot 2025-01-08 at 11 36 22

Fixed

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.

5 participants