Skip to content

Fix TextField error in production environment because it wrongly uses ancestor render boxes #126324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
justinmc merged 17 commits into from
May 26, 2023
Merged

Fix TextField error in production environment because it wrongly uses ancestor render boxes #126324

justinmc merged 17 commits into from
May 26, 2023

Conversation

@fzyzcjy
Copy link
Contributor

@fzyzcjy fzyzcjy commented May 9, 2023

Close #126312

Will add tests etc, if you think the PR looks roughly OK :)

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

flutter-dashboard bot commented May 9, 2023

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.

@flutter-dashboard flutter-dashboard bot added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. labels May 9, 2023
@fzyzcjy fzyzcjy mentioned this pull request May 9, 2023
Closed
8 tasks
@fzyzcjy fzyzcjy mentioned this pull request May 9, 2023
Closed
justinmc
justinmc reviewed May 9, 2023
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

The parameter canTouchLayoutPhaseData that you added seems awkward to me, like it adds complexity to _openInputConnection. I'm trying to think of a way to make it a bit more sound architecturally if possible.

Fundamentally I think the problem here is that _updateSizeAndTransform shouldn't be called during the build phase, and that this is not obvious.

Should _updateSizeAndTransform always be called inside of a post frame callback? Or should we be checking the SchedulerBinding.schedulerPhase or something in order to decide if it's possible that layout hasn't finished?

@LongCatIsLooong I feel like we have a convention for this sort of thing but I'm forgetting where I've seen it, do you know?

pdblasi-google
pdblasi-google reviewed May 9, 2023
View reviewed changes
@fzyzcjy
Copy link
Contributor Author

fzyzcjy commented May 9, 2023

Fundamentally I think the problem here is that _updateSizeAndTransform shouldn't be called during the build phase, and that this is not obvious.

Yes I think so.

Should _updateSizeAndTransform always be called inside of a post frame callback? Or should we be checking the SchedulerBinding.schedulerPhase or something in order to decide if it's possible that layout hasn't finished?
@LongCatIsLooong I feel like we have a convention for this sort of thing but I'm forgetting where I've seen it, do you know?

👀

@fzyzcjy
Copy link
Contributor Author

fzyzcjy commented May 11, 2023 •
edited
Loading

Great, CI is green - justinmc's approach works! I will add tests now :)

image

@fzyzcjy fzyzcjy mentioned this pull request May 11, 2023
Closed
@fzyzcjy
Revert "bump test"
1442cd5 
This reverts commit ccda625.
@fzyzcjy
Copy link
Contributor Author

fzyzcjy commented May 11, 2023

Tests are added and CI is green (again) :)

image

pdblasi-google
pdblasi-google approved these changes May 11, 2023
View reviewed changes
Copy link
Contributor

@pdblasi-google pdblasi-google left a comment

Choose a reason for hiding this comment

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

LGTM

In theory this approval will kick off Google tests, so we should probably wait for those to complete before fully merging things in.

justinmc
justinmc reviewed May 11, 2023
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

Thanks, just some comments improvements.

I talked this over a bit offline with @LongCatIsLooong and @Renzo-Olivares. The current addPostFrameCallback solution should be good because it will always be required in didUpdateWidget. I think let's just add some comments as mentioned below to warn other callers of _openInputConnection/_updateSizeAndTransform.

justinmc
justinmc reviewed May 16, 2023
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

It looks like there are Google test failures. @fzyzcjy Can you push another merge commit just to make sure these are legitimate?

I worry that this PR may be causing some layouts to take an additional frame now. When something changes in the widget and didUpdateWidget is called, now it will always take an extra frame to call _textInputConnection!.setEditableSizeAndTransform.

However, this is probably desired. Some of these may have worked in 1 frame in the past, but they just lucked out that none of their parent widgets had dirty layout. If we continue to see these failures after it runs again, then I can try updating the Google tests to add an extra .pump and see if that fixes them.

@fzyzcjy
Copy link
Contributor Author

fzyzcjy commented May 16, 2023

@justinmc

Can you push another merge commit just to make sure these are legitimate?

done

However, this is probably desired. Some of these may have worked in 1 frame in the past, but they just lucked out that none of their parent widgets had dirty layout.

Totally agree!

@fzyzcjy
Copy link
Contributor Author

fzyzcjy commented May 20, 2023 •
edited
Loading

@justinmc Google testing seems to pass!

image

justinmc
justinmc approved these changes May 26, 2023
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

LGTM 👍 . Thanks, I'll merge this!

@justinmc justinmc merged commit c1558f6 into flutter:master May 26, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 27, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 27, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
4e0aaf4 
…ongly uses ancestor render boxes (flutter/flutter#126324)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 27, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 27, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
aa36dc2 
…ongly uses ancestor render boxes (flutter/flutter#126324)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 27, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 27, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
3350052 
…ongly uses ancestor render boxes (flutter/flutter#126324)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 28, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 28, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
8682109 
…ongly uses ancestor render boxes (flutter/flutter#126324)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 28, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 28, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
6bf9316 
…ongly uses ancestor render boxes (flutter/flutter#126324)
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Jun 2, 2023
@engine-flutter-autoroll
Roll Flutter from ee162e4 to 3db9504 (31 revisions) (#4098)
db4954e 
flutter/flutter@ee162e4...3db9504

2023-05-28 [email protected] Roll Flutter Engine from 340936f7c03c to a4d4ad9dae1a (1 revision) (flutter/flutter#127772)
2023-05-28 [email protected] Roll Flutter Engine from 57e491a46e05 to 340936f7c03c (1 revision) (flutter/flutter#127767)
2023-05-28 [email protected] Roll Flutter Engine from a37b1a38d97a to 57e491a46e05 (1 revision) (flutter/flutter#127765)
2023-05-28 [email protected] Roll Flutter Engine from b1698020bd57 to a37b1a38d97a (1 revision) (flutter/flutter#127761)
2023-05-27 [email protected] Roll Flutter Engine from 9e97c7379c7f to b1698020bd57 (1 revision) (flutter/flutter#127758)
2023-05-27 [email protected] Roll Flutter Engine from 0f38a0f0a18a to 9e97c7379c7f (1 revision) (flutter/flutter#127755)
2023-05-27 [email protected] Roll Flutter Engine from 1187168472a7 to 0f38a0f0a18a (1 revision) (flutter/flutter#127752)
2023-05-27 [email protected] Roll Flutter Engine from 3426cb827efb to 1187168472a7 (1 revision) (flutter/flutter#127745)
2023-05-27 [email protected] Roll Flutter Engine from 795db50e7453 to 3426cb827efb (9 revisions) (flutter/flutter#127738)
2023-05-27 [email protected] Updated the `ToggleButtons` API doc to link to `SegmentedButton` (flutter/flutter#127021)
2023-05-26 [email protected] Remove more `test_api/src` imports (flutter/flutter#127716)
2023-05-26 [email protected] Move shared inline widget logic to `RenderInlineWidgetContainerDefaults` (flutter/flutter#127308)
2023-05-26 [email protected] Roll Flutter Engine from 3b5b5fc96b8f to 795db50e7453 (1 revision) (flutter/flutter#127720)
2023-05-26 [email protected] Update collection-fors to prefer final (as per updated `prefer_final_in_for_each`) (flutter/flutter#127511)
2023-05-26 [email protected] Roll Flutter Engine from eed12f36f595 to 3b5b5fc96b8f (1 revision) (flutter/flutter#127713)
2023-05-26 [email protected] Remove references to deprecated `ThemeData.primaryColorBrightness` (flutter/flutter#127238)
2023-05-26 [email protected] TwoDimensional scrolling foundation (flutter/flutter#125437)
2023-05-26 [email protected] Roll Flutter Engine from 858d9753453c to eed12f36f595 (2 revisions) (flutter/flutter#127702)
2023-05-26 [email protected] Remove button announcement for `MenuItemButton` and `SubmenuButton` (flutter/flutter#127620)
2023-05-26 [email protected] Reland "Update labeler action wildcards #127524" (flutter/flutter#127690)
2023-05-26 [email protected] Revert "Log all lines from ios-deploy (#127502)" (flutter/flutter#127684)
2023-05-26 [email protected] Roll Flutter Engine from ec7b0ae3599f to 858d9753453c (2 revisions) (flutter/flutter#127700)
2023-05-26 [email protected] Add M3 date range picker tests and fix header background theme color (flutter/flutter#127662)
2023-05-26 [email protected] Support minifcation for apps that depend on AGP 8 and integration_test (flutter/flutter#127628)
2023-05-26 [email protected] Bump Snippet version (flutter/flutter#127688)
2023-05-26 [email protected] [Linux] Use up_client_get_devices2 when possible (flutter/flutter#127699)
2023-05-26 [email protected] Roll Flutter Engine from 84f2fc16e55d to ec7b0ae3599f (3 revisions) (flutter/flutter#127698)
2023-05-26 [email protected] Fix `TextField` error in production environment because it wrongly uses ancestor render boxes (flutter/flutter#126324)
2023-05-26 [email protected] Interactive viewer doesn't appear to respect the trackpadScrollCausesScale parameter (flutter/flutter#127114)
2023-05-26 [email protected] Remove release timeline (flutter/flutter#127685)
2023-05-26 [email protected] Manual roll Flutter Engine from 8573f3b63a1f to 84f2fc16e55d (7 revisions) (flutter/flutter#127676)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
c9b9a92 
…ongly uses ancestor render boxes (flutter/flutter#126324)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
63df670 
…ongly uses ancestor render boxes (flutter/flutter#126324)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
b016cc5 
…ongly uses ancestor render boxes (flutter/flutter#126324)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
c1558f6 Fix TextField error in production environment because it wr…
f5ba394 
…ongly uses ancestor render boxes (flutter/flutter#126324)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justinmc justinmc justinmc approved these changes

+1 more reviewer

@pdblasi-google pdblasi-google pdblasi-google approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

TextField throws error in production environment because it wrongly uses ancestor render boxes (will PR; with cause analyzed)

3 participants

@fzyzcjy @justinmc @pdblasi-google