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: Implement lazy Split Request preview #34221

Closed

Conversation

paultsimura
Copy link
Contributor

Details

When creating a split request in a room, the transaction data is not loaded after relogin. We want to show the request details instead of the skeleton, therefore fetch the transaction data from the reportAction.originalMessage.

Fixed Issues

$ #33766
PROPOSAL: #33766 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

  1. Create a Workspace with a few members
  2. Open the announce room of the workspace
  3. Make a split bill with all members
  4. Relogin
  5. Navigate to the announce room and locate the created split request
  • Verify the request details are displayed instead of the loading skeleton

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

@paultsimura
Copy link
Contributor Author

paultsimura commented Jan 10, 2024

@allroundexperts @Gonals The preview works as expected, but I have a couple of concerns here:

First (rather minor concern): the reportAction.originalMessage doesn't store the merchant – it should be added on the BE if we want to show it on the lazy loaded preview.

Second, from what I found, these Split requests can be posted into a room directly, without wrapping it into an IOU Report. Therefore, there is currently no mechanism to fetch the transaction from BE after a Split was created (as they usually get loaded by OpenReport API call on the IOU or Expense Report). As a result, we:

  1. Cannot show the Split Details (should keep the Split preview non-clickable);
  2. Such Split requests cannot be modified (they almost cannot be modified anyway, only when created with empty required fields);
  • Should we do nothing and keep such split requests non-clickable, since there is no way to fetch the Split transaction (the underlying 1:1 transactions will be loaded and can be reimbursed correctly)?
  • Should we show the split details drawer with available lazy data (it's currently missing merchant, category, tag, and receipt-related fields)?
  • Should we think of adding an API route to allow fetching transactions by IDs from BE, so when a user clicks on the split preview, and the transaction's missing, we'll first fetch it from the BE, similar to what we do with the OpenReport calls?

@paultsimura
Copy link
Contributor Author

Also tagging @mountiny as you might be interested since you've been involved in other lazy-loading issues: #34221 (comment)

@paultsimura paultsimura force-pushed the fix/33766-split-lazy-preview branch from 4659325 to 44b8141 Compare January 10, 2024 11:00
@mountiny
Copy link
Contributor

@paultsimura can you bring this to Slack please, this is better discussed there, thnanks!

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.

2 participants