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

Draft
wants to merge 8 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

  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

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

@@ -358,7 +362,6 @@ function ReportPreview({
const shouldShowPendingSubtitle = numberOfPendingRequests === 1 && numberOfRequests === 1;

const isPayAtEndExpense = ReportUtils.isPayAtEndExpenseReport(iouReportID, allTransactions);
const isArchivedReport = ReportUtils.isArchivedRoomWithID(iouReportID);
const [archiveReason] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${iouReportID}`, {selector: ReportUtils.getArchiveReason});

const getPendingMessageProps: () => PendingMessageProps = () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @rlinoz, do you know of the top of your head what type of report will have ARCHIVE_REASON.BOOKING_END_DATE_HAS_PASSED? As in chat, expense or iou? We're refactoring some of the archived code so might have to make some changes based on this.

Copy link
Contributor

@rlinoz rlinoz Nov 11, 2024

Choose a reason for hiding this comment

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

Answering your question: expense reports

Explanation of what we are doing:

Travel reports that are related to a booking that you had to pay in person, in this case we create a placeholder report that gets archived when the end date of the booking has passed

https://github.com/Expensify/Web-Expensify/blob/bb1305f554dad2a193e9bd1c7891a213399fe6dd/script/bwm/ArchiveReportAtBookingEndDate.php#L23

Let me know if that is still confusing

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok cool, it makes sense, thank you! After these changes, since it is an expense report, it will be able to be commented on. But there will still be no actions like Submit, Approve, Pay on these reports. Does that sound ok? cc @trjExpensify

Copy link
Contributor

Choose a reason for hiding this comment

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

There aren't any action buttons in this case. It's just a placeholder booking confirmation, which we intended to then archive using the pattern applied to chat reports when the booking date has passed. This is the visual ref:

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah okay, so even though this is an expense report, do we still want to continue archiving it using the chat pattern? Or do we want to switch to the expense report archive pattern where the composer is visible?

The This booking is archived now that the trip date has passed... header text will still be visible with either approach that we take.

Copy link
Contributor

Choose a reason for hiding this comment

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

Using the archive pattern still makes sense to me, because our intention is to communicate it as archived as displayed above. So if it doesn't follow that same pattern as how other archived chats show up in the product, it's confusing.

@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
If that is the case I suggest:
We have 2 functions isArchivedRoom - it will only check for is_privateArchived so it will render both archived expense and non expense reports and isArchivedNonExpenseReport this will check that the archived report is non expense.
Now we will only change the isArchivedRoom instance with isArchivedNonExpenseReport for cases we want to allow for archived expense reports.
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?

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