Skip to content

fix: resolve keyboard reordering edge cases in DraggableList#80261

Merged
chuckdries merged 5 commits intoExpensify:mainfrom
MobileMage:fix/79247-keyboard-reordering-followup
Feb 27, 2026
Merged

fix: resolve keyboard reordering edge cases in DraggableList#80261
chuckdries merged 5 commits intoExpensify:mainfrom
MobileMage:fix/79247-keyboard-reordering-followup

Conversation

@MobileMage
Copy link
Contributor

@MobileMage MobileMage commented Jan 22, 2026

Explanation of Change

This PR fixes three edge case issues with keyboard-based reordering in DraggableList that were discovered after the initial keyboard reordering implementation (#79793):

  1. Enter key conflict: The default @dnd-kit KeyboardSensor uses both Enter and Space to start/end drags, which conflicts with MenuItem's Enter-to-navigate behavior. Fixed by configuring KeyboardSensor to only use Space for start/end, and blocking Enter during drag via capture phase.

  2. Ghost drag replay: When closing the panel mid-drag, the drag state persisted and replayed on the next component mount. Fixed by:

    • Generating unique instance IDs with useState() to force DndContext state reset on remount
    • Dispatching Escape on unmount to cancel any active keyboard drag via dnd-kit's built-in cancel mechanism

Related: dnd-kit #857, dnd-kit #1367

Fixed Issues

$ #80165
$ #80166
$ #80167

Tests

  1. Go to +Track distance
  2. Add two waypoints (e.g., "Philadelphia" and "Boston")
  3. Tab to a waypoint until it's focused
  4. Press Space to start keyboard drag
  5. Press ArrowDown to move it
  6. Press Space to complete the reorder
  7. Verify reordering works correctly with no errors

Test ghost drag fix:

  1. Start a keyboard drag (Space → ArrowDown)
  2. Click Close (X) WITHOUT pressing Space to end
  3. Open a new Track distance expense
  4. Press Tab then Space on an empty waypoint
  5. Verify no ghost data from previous expense appears

Test mouse drag after keyboard:

  1. Go to +Track distance
  2. Add two waypoints (e.g., "Philadelphia" and "Boston")
  3. Tab to a waypoint until it is focused
  4. Press Space to start a keyboard drag
  5. Press ArrowDown to move it
  6. Press Space to complete the reorder
  7. Now use your mouse to click and hold the drag handle on a waypoint
  8. Drag it to a different position and release
  9. Verify the waypoint reorders correctly via mouse drag
  10. Verify no errors appear in the JS console
  • Verify that no errors appear in the JS console

Offline tests

N/A - This is a UI interaction fix that doesn't involve network requests.

QA Steps

Same as Tests 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
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

- Configure KeyboardSensor to use Space-only for start/end drag
- Block Enter key during drag to prevent MenuItem navigation conflicts
- Generate unique instance ID per mount to reset DndContext state
- Dispatch Escape on unmount to cancel any active keyboard drag
@MobileMage MobileMage requested review from a team as code owners January 22, 2026 19:59
@melvin-bot melvin-bot bot requested review from jayeshmangwani and joekaufmanexpensify and removed request for a team and joekaufmanexpensify January 22, 2026 20:00
@melvin-bot
Copy link

melvin-bot bot commented Jan 22, 2026

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

@melvin-bot melvin-bot bot removed the request for review from a team January 22, 2026 20:00
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c844374fa4

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@codecov
Copy link

codecov bot commented Jan 22, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/components/DraggableList/SortableItem.tsx 0.00% <0.00%> (ø)
src/components/DraggableList/index.tsx 0.00% <0.00%> (ø)
... and 15 files with indirect coverage changes

@jayeshmangwani
Copy link
Contributor

@MobileMage I’m not sure why I was auto-assigned here. Do you remember whether any C+ was involved in the issues mentioned above?

@MobileMage
Copy link
Contributor Author

Yeah, I think @chuckdries said something about this being an edge case of sorts

Well, I wouldn't call any of these issues regressions, but I do think we are in a bit of an edge case here. Normally each of those separate issues would already have a C+ who reviewed the proposals and would then be the PR reviewer, but in this case none of them did because we skipped that, so it picked a random C+.

Do you think I should close this?

@jayeshmangwani
Copy link
Contributor

I’m not sure whether to close this or not. @chuckdries , what do you think? Should I go ahead with the review, or should someone from C+ who reviewed the above issues handle this?

@chuckdries
Copy link
Contributor

@jayeshmangwani You were randomly chosen by the bot because nobody was assigned to the linked issues. If you're comfortable, please review and cross platform test, and the automation will create an issue to ensure you get paid for your review. If not, we can reassign to the C+ that reviewed the original implementation

@jayeshmangwani
Copy link
Contributor

If you're comfortable, please review and cross platform test, and the automation will create an issue to ensure you get paid for your review.

Yes, I’m starting the PR review now. That works for me.

@jayeshmangwani
Copy link
Contributor

@MobileMage, I’m starting the review, could you please complete the PR checklist?

@MobileMage
Copy link
Contributor Author

Yup, I'll do that today.

@jayeshmangwani
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 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
  • 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
80165.mov
80166.mov
80167.mov

@jayeshmangwani
Copy link
Contributor

Above-mentioned three issues have been resolved. As now we are blocking the Enter key when the Space key is pressed (rearranging is still ongoing).

@MobileMage Also, please rewrite the third case for “Test mouse drag after keyboard” more explicitly so it’s easier for QA to test.

@jayeshmangwani
Copy link
Contributor

@MobileMage did you get a chance to look at the comment above #80261 (comment)?

@MobileMage
Copy link
Contributor Author

Yeah, I did. @jayeshmangwani
image

@jayeshmangwani
Copy link
Contributor

Thankyou!

Copy link
Contributor

@jayeshmangwani jayeshmangwani left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@melvin-bot melvin-bot bot requested a review from chuckdries February 16, 2026 05:55
Copy link
Contributor

@chuckdries chuckdries left a comment

Choose a reason for hiding this comment

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

Hi! Sorry for the delay on my review. Looks good overall, just wondering if we can replace the custom instanceId logic with a React useId call

const styles = useThemeStyles();

// Generate a unique ID per mount to ensure DndContext state resets when component remounts
const [instanceId] = useState(() => `${Date.now()}-${Math.random().toString(36).slice(2)}`);
Copy link
Contributor

Choose a reason for hiding this comment

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

Quick question: can we use useId for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

Copy link
Contributor

@chuckdries chuckdries left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@chuckdries chuckdries merged commit 59bc354 into Expensify:main Feb 27, 2026
28 checks passed
@github-actions
Copy link
Contributor

🚧 @chuckdries has triggered a test Expensify/App build. You can view the workflow run here.

@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

OSBotify commented Mar 2, 2026

🚀 Deployed to staging by https://github.com/chuckdries in version: 9.3.28-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2026

🚀 Deployed to staging by https://github.com/chuckdries in version: 9.3.30-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2026

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.30-3 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 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.

4 participants