Skip to content

Fix flaky usePendingConciergeResponse unmount test#87556

Open
MelvinBot wants to merge 3 commits intomainfrom
claude-fixFlakyPendingConciergeResponseTest
Open

Fix flaky usePendingConciergeResponse unmount test#87556
MelvinBot wants to merge 3 commits intomainfrom
claude-fixFlakyPendingConciergeResponseTest

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Explanation of Change

The usePendingConciergeResponse unmount test was flaky on CI because it used an 80ms real-timer delay (Date.now() + SHORT_DELAY). Under CI load, the waitForBatchedUpdates round-trips consume enough wall-clock time for the delay to expire before unmount() runs, causing the timer callback to fire and the assertion to fail.

This PR changes the unmount test to use a 10s delay instead. Since this test only needs to prove that clearTimeout prevents the action on unmount, a large pending timer that gets cleared is just as valid as a short one — and it eliminates the race window entirely.

Fixed Issues

$ #87440

Tests

  1. Run npx jest tests/unit/hooks/usePendingConciergeResponse.test.ts
  2. Verify all 6 tests pass, including "should cancel the timer on unmount and not apply the action"
  3. Run the test multiple times to confirm it is no longer flaky
  • Verify that no errors appear in the JS console

Offline tests

N/A — test-only change, no runtime behavior affected.

QA Steps

[No QA] — This is a test-only fix for a flaky CI job. No product behavior is changed.

  • 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 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

N/A — test-only change

No UI changes.

Use a 10s delay instead of 80ms in the unmount-cleanup test so the
timer never races with real wall-clock time under CI load. The test
only needs to prove clearTimeout prevents the action — a large
pending timer that gets cleared is just as valid as a short one.

Co-authored-by: Vit Horacek <mountiny@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 11 files with indirect coverage changes

@mountiny mountiny marked this pull request as ready for review April 14, 2026 03:37
@melvin-bot melvin-bot Bot requested a review from thesahindia April 14, 2026 03:37
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 14, 2026

@thesahindia 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 April 14, 2026 03:37
@mountiny
Copy link
Copy Markdown
Contributor

@MelvinBot can you sync up with main

…gConciergeResponseTest

Co-authored-by: Vit Horacek <mountiny@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team as a code owner April 14, 2026 03:43
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Synced with main — merged the latest changes from main into this branch. No conflicts.

@melvin-bot melvin-bot Bot requested review from jjcoffee and mountiny April 14, 2026 03:43
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 14, 2026

@jjcoffee @mountiny One of you needs to 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 April 14, 2026 03:43
@MelvinBot
Copy link
Copy Markdown
Contributor Author

The verifySignedCommits failure is unrelated to this PR — it's a transient GitHub infrastructure error (GnuTLS recv error (-24): Decryption has failed) that caused git fetch to fail on all 3 retry attempts. No code fix needed.

To resolve: Re-run the failed verifySignedCommits workflow from the Actions tab.

Copy link
Copy Markdown

@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: cb05c49540

ℹ️ 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".

Comment on lines 113 to 115
// And we wait long enough to confirm the action was not applied
await delay(150);
await waitForBatchedUpdates();
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Wait past timer deadline in unmount cleanup test

This test no longer verifies that unmount cleanup actually cancels the timeout. displayAfter is set 10 seconds in the future, but the assertion runs after only 150ms, so the callback cannot execute even if clearTimeout is removed; the test would still pass and miss a real regression in usePendingConciergeResponse cleanup behavior.

Useful? React with 👍 / 👎.

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.

@MelvinBot can you check this feedback?

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.

Good catch — the test was indeed not validating that clearTimeout actually prevents the callback. Fixed in b3f7e0f: the unmount test now uses jest.useFakeTimers() and advances time past the deadline with jest.advanceTimersByTime(), so removing clearTimeout from the hook cleanup would cause the test to fail.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

The failing checks are not related to this PR's changes:

  1. verifySignedCommits — Failed due to a transient GitHub infrastructure error (GnuTLS recv error (-24): Decryption has failed). The CI runner couldn't fetch the repository over HTTPS — this is a network/TLS issue on GitHub's side, not a commit signing problem. Re-running this workflow should resolve it.

  2. checklist — Standard PR Author Checklist check, not a code issue.

All code-related checks (ESLint, TypeScript, Prettier, tests 1–7, Storybook, builds) are passing. Test job 8 is still running.

Action needed: Re-run the verifySignedCommits workflow — the failure is transient and unrelated to the PR.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

The failing checks are both unrelated to this PR's changes:

  1. verifySignedCommits — Transient GitHub Actions runner network error (GnuTLS recv error (-24): Decryption has failed). Failed on all 3 retry attempts. Re-running the check should resolve it.
  2. checklist — "No PR Reviewer Checklist was found." This is expected — it will pass once a reviewer posts their checklist.

All code-related checks (tests, ESLint, typecheck, prettier, storybook, builds) passed successfully.

…eout

The test previously used a 10s real-timer delay but only waited 150ms
after unmount, so it would pass even without clearTimeout. Now uses
jest.useFakeTimers() to advance past the deadline, ensuring the test
catches regressions in cleanup behavior.

Co-authored-by: Vit Horacek <mountiny@users.noreply.github.com>
@mountiny
Copy link
Copy Markdown
Contributor

@codex review

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