Skip to content

Fixed keyboard assertion crash during app startup and added tests#181719

Closed
prinsh-canary wants to merge 4 commits into
flutter:masterfrom
prinsh-canary:keyabord-issue
Closed

Fixed keyboard assertion crash during app startup and added tests#181719
prinsh-canary wants to merge 4 commits into
flutter:masterfrom
prinsh-canary:keyabord-issue

Conversation

@prinsh-canary

@prinsh-canary prinsh-canary commented Jan 30, 2026

Copy link
Copy Markdown

Description

This PR adds comprehensive test coverage for the keyboard assertion crash fix during app startup.

The fix resolved a race condition where KeyDownEvent could arrive after syncKeyboardState() had already marked keys as pressed, causing assertion crashes when users held keys during app initialization.

This PR adds 6 test cases to verify the fix works correctly:

  1. KeyDownEvent allowed when key already pressed - Validates that duplicate KeyDownEvents don't trigger assertions when keys are pre-synced
  2. Multiple keys during startup - Tests handling of multiple modifier keys (Ctrl+Shift+Alt) held simultaneously
  3. Synthesized events skip assertions - Verifies synthesized events bypass all assertion checks
  4. Regular KeyDownEvent unchanged - Ensures normal key press behavior remains intact
  5. KeyDownEvent after syncKeyboardState - Simulates the exact real-world bug scenario
  6. Modifier keys during startup - Specifically tests modifier key combinations common during app launch

##Related Issues

  - Fixes #172153
  - Fixes #125975
  - Related to #87391

##Test Results

  • All 19 tests pass (13 existing + 6 new)
  • flutter analyze passes with no issues

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Allow KeyDownEvent for keys already detected by syncKeyboardState.
Prevents crash when pressing keys during initialization
Add 6 test cases covering the keyboard initialization race condition where
KeyDownEvent arrives after syncKeyboardState() marks keys as pressed.

Tests cover single keys, multiple keys, synthesized events, and modifier
keys held during app startup. Ensures no assertion crashes occur.
@github-actions github-actions Bot added the framework flutter/packages/flutter repository. See also f: labels. label Jan 30, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request addresses a keyboard assertion crash during app startup by relaxing the assertion that prevents duplicate KeyDownEvents. The change also correctly skips assertions for synthesized events. The fix is accompanied by a comprehensive set of new tests that validate the new behavior under various scenarios, including the specific race condition that caused the crash. While the fix is effective, I've noted that it completely removes a potentially useful assertion, and the accompanying comment could be more precise. I've provided a suggestion to improve the comment's clarity.

Comment thread packages/flutter/lib/src/services/hardware_keyboard.dart Outdated
@IliaKhuzhakhmetov

Copy link
Copy Markdown

Very need this fix, so annoying

@dkwingsmt dkwingsmt self-requested a review February 3, 2026 23:23
@dkwingsmt

Copy link
Copy Markdown
Contributor

Thanks for the idea. I have some more ideas and I think it'd be better for me to just rewrite it, which results in #181894.

@justinmc

Copy link
Copy Markdown
Contributor

Should this be closed now that #181894 is merging?

@dkwingsmt

Copy link
Copy Markdown
Contributor

Closing this in favor of #181894 .

@dkwingsmt dkwingsmt closed this Feb 10, 2026
github-merge-queue Bot pushed a commit that referenced this pull request Feb 10, 2026
Suppresses #125975

This PR disable hardware keyboard regularity warning unless
`debugPrintKeyboardEvents` is set.

Keyboard state synchronization has proven extremely difficult, largely
due to the asynchronous communication between the engine and framework.
Unfortunately, I haven't had the bandwidth to fix it, causing developers
to experience false errors during hot restarts. It's time to acknowledge
this and prioritize development experience over idealism by disabling
these useless warnings.

I apologize for the issues I've caused over the years. Perhaps someday
we can make this work with a fully regular event stream.

Replaces #181719 .

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
rickhohler pushed a commit to rickhohler/flutter that referenced this pull request Feb 19, 2026
Suppresses flutter#125975

This PR disable hardware keyboard regularity warning unless
`debugPrintKeyboardEvents` is set.

Keyboard state synchronization has proven extremely difficult, largely
due to the asynchronous communication between the engine and framework.
Unfortunately, I haven't had the bandwidth to fix it, causing developers
to experience false errors during hot restarts. It's time to acknowledge
this and prioritize development experience over idealism by disabling
these useless warnings.

I apologize for the issues I've caused over the years. Perhaps someday
we can make this work with a fully regular event stream.

Replaces flutter#181719 .

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
mboetger pushed a commit to mboetger/flutter that referenced this pull request Mar 26, 2026
Suppresses flutter#125975

This PR disable hardware keyboard regularity warning unless
`debugPrintKeyboardEvents` is set.

Keyboard state synchronization has proven extremely difficult, largely
due to the asynchronous communication between the engine and framework.
Unfortunately, I haven't had the bandwidth to fix it, causing developers
to experience false errors during hot restarts. It's time to acknowledge
this and prioritize development experience over idealism by disabling
these useless warnings.

I apologize for the issues I've caused over the years. Perhaps someday
we can make this work with a fully regular event stream.

Replaces flutter#181719 .

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

4 participants