Codestin Search App

Renzo-Olivares · 2021-09-16T17:59:42Z

Description

Fixes b/200138301

Looks like there are some failures for those who implement TextInputClient. They are missing an updateEditingValueWithDeltas implementation. This change aims to fix this by instead of adding updateEditingValueWithDeltas to TextInputClient interface, we extend TextInputClient and add the new method in there. This extension will be called DeltaTextInputClient.

With this change we do not force people who do not want any deltas to implement updateEditingValueWithDeltas.

Related Issues

Fixes b/200138301

Tests

Added tests to verify updateEditingValueWithDeltas method is called.
Adds a text_input_utils.dart for the common FakeTextChannel to be shared.

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 feature I am adding, or Hixie said the PR is test-exempt.
All existing and new tests are passing.

flutter-dashboard · 2021-09-16T17:59:44Z

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.

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.

justinmc

Some things to discuss in my comments, but overall I think I like this approach better. We probably shouldn't force implementers of TextInputClient to implement updateEditingValueWithDeltas when most don't care about deltas at all.

justinmc · 2021-09-16T18:06:36Z

packages/flutter/lib/src/services/text_input.dart

        }

-        _currentConnection!._client.updateEditingValueWithDeltas(deltas);
+        (_currentConnection!._client as DeltaTextInputClient).updateEditingValueWithDeltas(deltas);


Is there any risk that _currentConnection!._client might not be a DeltaTextInputClient? Is updateEditingStateWithDeltas ever called on any platform when enableDeltaModel is false? Even if it's not, maybe we need to make it obvious to users in the docs that if they set enableDeltaModel to true, then they must be using an implementation of DeltaTextInputClient and not TextInputClient.

On the platform side there is no risk. But yes we can add this to the documentation.

We should add an assert here as well! This is one of the problems with casting things around, it adds risk of misuse. The assert can also include an error message that makes this clear if it is ever encountered.

I don't think we can accomplish this same thing without breaking the interface API though, so reluctantly, we may have to proceed with something like this even though it is a bit awkward

That's right. If a platform implements the delta model, and someone is using a TextInputClient with a TextInputConfiguration with enableDeltaModel set to true then they will be able to reach this case and receive unexpected behavior.

Ok, well let's slap tons of warnings and docs and asserts around this to make sure it is at least obvious exactly how to fix it/make it work. Kind of ugly but the cost of being non-breaking.

If this were not an opt-in feature, im tempted to just break as most developers using this would be advanced anyways and it should be trivial to copy-paste in a snipped already included in the docs, but I don't think we should break people especially if they don't even need it for their code to keep working.

justinmc · 2021-09-16T18:07:58Z

packages/flutter/lib/src/widgets/editable_text.dart

-      value = delta.apply(value);
-    }
-    updateEditingValue(value);
-  }


Since we're losing this method, should we include it as an example implementation of updateEditingValueWithDeltas in the docs or something? I want to make sure that users know what to do here when they implement updateEditingValueWithDeltas.

That makes sense to me! Don't see why an example would hurt.

…nted

GaryQian · 2021-09-16T19:10:00Z

packages/flutter/lib/src/services/text_input.dart


 /// An interface to receive information from [TextInput].
 ///
+/// If [TextInputConfiguration.enableDeltaModel] is set to true you should


Nit wording: ... is set to true, [DeltaTextInputClient] must be implemented instead of this class.

GaryQian · 2021-09-16T19:10:32Z

packages/flutter/lib/src/services/text_input.dart

 ///  * [TextInput.attach]
 ///  * [EditableText], a [TextInputClient] implementation.
+///  * [DeltaTextInputClient], a [TextInputClient] extension that receives
+///  granular information from the platform's text input.


nit, add indent here

GaryQian · 2021-09-16T19:10:54Z

packages/flutter/lib/src/services/text_input.dart

        _currentConnection!._client.updateEditingValue(TextEditingValue.fromJSON(args[1] as Map<String, dynamic>));
        break;
      case 'TextInputClient.updateEditingStateWithDeltas':
+        assert(_currentConnection!._client is DeltaTextInputClient, 'You should be using a DeltaTextInputClient if you have TextInputConfiguration.enableDeltaModel set to true');


should -> must

justinmc

LGTM 👍 , just two nits.

justinmc · 2021-09-16T21:26:28Z

packages/flutter/lib/src/services/text_input.dart

+  ///
+  /// Here is an example of what implementation of this method could look like:
+  ///
+  /// @override


This example should probably be a {@tool snippet} so that it's formatted nicely on the docs website.

justinmc · 2021-09-16T21:30:42Z

packages/flutter/test/services/delta_text_input_test.dart

+  TextInputConfiguration get configuration => const TextInputConfiguration(enableDeltaModel: true);
+}
+
+class FakeTextChannel implements MethodChannel {


Nit: Is this identical to the one in text_input_test.dart? Could the code be shared somehow? Maybe a text_input_utils.dart file or something.

Yeah it's shared by autofill_test.dart and text_input_test.dart so i'll make it a common file.

GaryQian

LGTM, thanks!

justinmc

LGTM with the changes 👍

Create DeltaTextInputClient

c116901

flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Sep 16, 2021

google-cla bot added the cla: yes label Sep 16, 2021

Renzo-Olivares requested review from GaryQian, LongCatIsLooong and justinmc September 16, 2021 18:03

justinmc reviewed Sep 16, 2021

View reviewed changes

Renzo-Olivares added 9 commits September 16, 2021 11:13

Remove old tests as updateEditingValueWithDeltas is no longer impleme…

f8446a4

…nted

fix analyzer

24ca8f8

Update docs

5adb216

Make example more general

f78e48b

Update docs

c4260e6

Add assert to check that TextInputClient is a DeltaTextInputClient

a8cc64d

Update assert

f55a142

More docs

cc8e5ea

update

745f050

GaryQian reviewed Sep 16, 2021

View reviewed changes

Renzo-Olivares added 9 commits September 16, 2021 12:19

Clean up docs

2de2660

updates

d72cdce

Update docs

9b607f6

updates

3c8e596

Fix test

78a9d6d

add test

f508448

updates

0a32611

remove logs

6851c13

fix tests

45401cf

Renzo-Olivares requested a review from justinmc September 16, 2021 20:58

Renzo-Olivares requested a review from GaryQian September 16, 2021 20:58

Address reviewer comments

d9e7c40

justinmc approved these changes Sep 16, 2021

View reviewed changes

GaryQian approved these changes Sep 16, 2021

View reviewed changes

Renzo-Olivares added 2 commits September 16, 2021 14:45

Add text_input_utils.dart

b9afa31

Address reviewer comments

303e8b6

justinmc approved these changes Sep 16, 2021

View reviewed changes

LongCatIsLooong approved these changes Sep 16, 2021

View reviewed changes

Merge branch 'master' of github.com:flutter/flutter into g_fix

3ac88e2

Renzo-Olivares merged commit 4b330dd into flutter:master Sep 17, 2021

This comment was marked as off-topic.

Sign in to view

Conversation

Renzo-Olivares commented Sep 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Sep 16, 2021

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaryQian Sep 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Renzo-Olivares Sep 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaryQian left a comment

Choose a reason for hiding this comment

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as off-topic.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Renzo-Olivares commented Sep 16, 2021 •

edited

Loading

GaryQian Sep 16, 2021 •

edited

Loading

Renzo-Olivares Sep 16, 2021 •

edited

Loading