Skip to content

Add scrolling to new transactions in the new report screen - #61707

Merged
mountiny merged 20 commits into
Expensify:mainfrom
software-mansion-labs:@szymczak/scroll-to-new-transactions
May 22, 2025
Merged

mountiny merged 20 commits into
Expensify:mainfrom
software-mansion-labs:@szymczak/scroll-to-new-transactions

Conversation

@SzymczakJ

@SzymczakJ SzymczakJ commented May 8, 2025 •

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR makes table report view auto-scroll to the expense if it's out of the scroll view.

Fixed Issues

$ #60418
PROPOSAL:

Tests

  1. Create empty report, make an expense in it with the composer plus button and make sure it's higlighted.
  2. Open a report that already has transactions from Inbox tab and make sure no transactions are highlighted.
  3. Open a report that already has transactions from Inbox tab, make an expense in it with the composer plus button and make sure it's higlighted and that scroll view scrolls to it if it's not already visible.
  4. Open a report that already has transactions from Inbox tab, add unreported expenses to it and make sure every one of them is highlighted. The scroll view should scroll to the first item, if it's not visible.

Offline tests

QA Steps

Same as tests.

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-05-13.at.17.25.17.mov
Android: mWeb Chrome
Screen.Recording.2025-05-13.at.18.09.38.mov
iOS: Native
Screen.Recording.2025-05-13.at.18.06.17.mov
iOS: mWeb Safari
Screen.Recording.2025-05-13.at.18.07.36.mov
MacOS: Chrome / Safari
Screen.Recording.2025-05-13.at.16.36.31.mov
MacOS: Desktop

@SzymczakJ
SzymczakJ marked this pull request as ready for review May 13, 2025 15:35
@SzymczakJ
SzymczakJ requested review from a team as code owners May 13, 2025 15:35
@melvin-bot
melvin-bot Bot requested review from DylanDylann and removed request for a team May 13, 2025 15:35
@melvin-bot

melvin-bot Bot commented May 13, 2025

Copy link
Copy Markdown

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

@SzymczakJ

SzymczakJ commented May 13, 2025 •

Copy link
Copy Markdown
Contributor Author

Failing test seems unrelated, I'll recheck it tomorrow.

@mountiny
mountiny requested review from allgandalf and removed request for DylanDylann May 13, 2025 16:16
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test app build. You can view the workflow run here.

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
Android 🤖🔄 iOS 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/61707-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/61707-hybrid/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/61707/NewExpensify.dmg https://61707.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton

Copy link
Copy Markdown
Contributor

Videos look correct, though iOS native seems quite laggy? Maybe it will feel better on a real device.

@dubielzyk-expensify

Copy link
Copy Markdown
Contributor

Sorry if this is part of a separate issue, but there's a weird gap here as well. I would expect the scrollview to be touching the header, not the gap inbetween:

CleanShot 2025-05-14 at 12 24 41@2x

@allgandalf

allgandalf commented May 14, 2025 •

Copy link
Copy Markdown
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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
Screen.Recording.2025-05-22.at.11.40.10.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-05-22.at.11.42.58.AM.mov
iOS: HybridApp
iOS: mWeb Safari
Screen.Recording.2025-05-22.at.11.45.01.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-05-22.at.11.22.27.AM.mov
Screen.Recording.2025-05-22.at.11.20.09.AM.mov
MacOS: Desktop
Screen.Recording.2025-05-22.at.11.36.50.AM.mov

@allgandalf

Copy link
Copy Markdown
Contributor

Jest is failing @SzymczakJ

@shawnborton

Copy link
Copy Markdown
Contributor

but there's a weird gap here as well.

Good catch, I think we should fix that!

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

Today, I was busy with deploy blockers, I'll fix both thing tomorrow.

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

so I guess wide screen padding should also be fixed, right @dubielzyk-expensify @shawnborton ?
Screenshot 2025-05-15 at 15 23 56

@shawnborton

Copy link
Copy Markdown
Contributor

That's correct - we shouldn't have that extra padding at the top and bottom of the view - that seems like it was introduced recently.

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

@shawnborton I fixed the spacings according to Figma, is that correct? Wide:
Screenshot 2025-05-15 at 16 25 02
and when scrolled from the top
Screenshot 2025-05-15 at 16 29 22
Mobile:
Screenshot 2025-05-15 at 16 39 26

@shawnborton

Copy link
Copy Markdown
Contributor

Glad we caught the bug!

@allgandalf

Copy link
Copy Markdown
Contributor

Thanks for the PR, I will review it later today

@mountiny

Copy link
Copy Markdown
Contributor

Asked if @DylanDylann could take over as Gandalf has other important tasks to handle

@mountiny

Copy link
Copy Markdown
Contributor

@SzymczakJ conflicts

@allgandalf allgandalf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit picks, lets fix those while we resolve conflicts

*/
scrollingVerticalBottomOffset.current = fullContentHeight - layoutMeasurement.height - contentOffset.y;

// we additionally track the top offset to be able to scroll to the new transaction when it's added

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
// we additionally track the top offset to be able to scroll to the new transaction when it's added
// We additionally track the top offset to be able to scroll to the new transaction when it's added

const scrollToNewTransaction = useCallback(
(pageY: number) => {
wrapperViewRef.current?.measureInWindow((x, y, w, height) => {
// if the new transaction is already visible, we don't need to scroll to it

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
// if the new transaction is already visible, we don't need to scroll to it
// If the new transaction is already visible, we don't need to scroll to it

Comment on lines +435 to +437
if (pageY > 0 && pageY < height) {
return;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Smarttttt!

/** List of transactions belonging to one report */
transactions: OnyxTypes.Transaction[];

/** Report that these transactions belong to */

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/** Report that these transactions belong to */
/** List of transactions that arrived when the report was open */

Comment thread tests/unit/ReportUtilsTest.ts Outdated
it('should exclude hidden participants', () => {
const report: Report = {
...createRandomReport(1),
...createRandomReport(123),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is this change necessary ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I changed it in an attempt to fix a flaky test, I think that the test is already fixed so I will remove this change.

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

Comments fixed @allgandalf

@allgandalf

Copy link
Copy Markdown
Contributor

and they're back

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

fixed @allgandalf

@allgandalf

Copy link
Copy Markdown
Contributor

@SzymczakJ we are having type failures

@allgandalf allgandalf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lets fix test and we're good to go!

@SzymczakJ

Copy link
Copy Markdown
Contributor Author

fixed typechecks, let's merge this!

@melvin-bot
melvin-bot Bot requested a review from mountiny May 22, 2025 12:22

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changes look good to me but they are quite extensive and might influence other parts of the codebase so please @allgandalf @SzymczakJ be on a look out for deploy blockers and remember that blockers are the most important task to work on if they come up

Comment on lines +112 to +120
const newTransactions = useMemo(() => {
if (!prevTransactions || !transactions || transactions.length <= prevTransactions.length) {
return CONST.EMPTY_ARRAY as unknown as OnyxTypes.Transaction[];
}
return transactions.filter((transaction) => !prevTransactions?.some((prevTransaction) => prevTransaction.transactionID === transaction.transactionID));
// Depending only on transactions is enough because prevTransactions is a helper object.
// eslint-disable-next-line react-compiler/react-compiler
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [transactions]);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could we refactor this to avoid the eslint disable? there should be a way to do so

Comment on lines +314 to +323
const newTransactions = useMemo(() => {
if (!prevTransactions || reportTransactions.length <= prevTransactions.length) {
return CONST.EMPTY_ARRAY as unknown as OnyxTypes.Transaction[];
}
return reportTransactions.filter((transaction) => !prevTransactions?.some((prevTransaction) => prevTransaction.transactionID === transaction.transactionID));
// Depending only on transactions is enough because prevTransactions is a helper object.
// eslint-disable-next-line react-compiler/react-compiler
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [reportTransactions]);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same here, we ideally do not want to add these exceptions

@mountiny
mountiny merged commit 9087dcb into Expensify:main May 22, 2025
@OSBotify

Copy link
Copy Markdown
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.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.51-0 🚀

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/arosiclair in version: 9.1.51-6 🚀

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

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.

6 participants