Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Conversation

@dkwingsmt
Copy link
Contributor

@dkwingsmt dkwingsmt commented Mar 18, 2022

This PR puts the procedure of handling a key event into a queue, so that before the last event is done processing (possibly handled by TextInputPlugin and sent to the next responder), the next event will not be started at all.

This PR fixes the macOS part of flutter/flutter#82673, which is caused by the racing condition between the two steps of key handling: key events, and text events. The complete analysis is posted at flutter/flutter#82673 (comment).

However, by reducing (the problematic) parallelization, this fix unsurprisingly comes at a cost of slowing down the overall key event processing. This should not be a problem in other languages, but in Vienamese Telex IME, where one key press can result in as many as 5 messages, the result is noticeable, as shown below.

1.mov

Mitigating this problem might need bigger changes in the future. For now, let's land this PR to correct the behavior first.

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 and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See testing the engine for instructions on
    writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

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

@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Remove log

add sync; clean code

Format
@dkwingsmt dkwingsmt force-pushed the mac-key-full-queue branch from ad05fd8 to ad8b644 Compare March 20, 2022 06:23
@chinmaygarde
Copy link
Member

cc @gspencergoog

@dkwingsmt dkwingsmt requested a review from gspencergoog March 25, 2022 10:10
Copy link
Contributor

@gspencergoog gspencergoog left a comment

Choose a reason for hiding this comment

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

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

uint64_t responseId = _responseId;
FlutterKeyPendingResponse* pending =
[[FlutterKeyPendingResponse alloc] initWithHandler:self responseId:responseId];
// The `pending` is released in `HandleResponse`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't need the backquotes (not a markdown comment)

}

- (void)handleEvent:(nonnull NSEvent*)event {
// The `handleEvent` does not process the event immediately, but instead put
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// The `handleEvent` does not process the event immediately, but instead put
// The `handleEvent` does not process the event immediately, but instead puts

Also don't need the backticks (not markdown).


// At the start of any kind of call, record the call type to the given storage.
//
// Only calls that are included in `typeMask` will be added. Options are
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't need the backticks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah but I thought having backticks made it easier to recognize they are variables.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants