Secure paste milestone 2 #159013

justinmc · 2024-11-16T00:27:22Z

Implements the framework side of secure paste milestone 2, where the iOS system context menu items can be customized.

Depends on PR #161103. Currently I've merged that PR into this one for testing, but I think that PR should merge separately first.

Widget API (most users)

TextField(
  contextMenuBuilder: (BuildContext context, EditableTextState editableTextState) {
    return SystemContextMenu.editableText(
      editableTextState: editableTextState,
      // items is optional
      items: <IOSSystemContextMenuItem>[
        const IOSSystemContextMenuItemCut(),
        constIOS SystemContextMenuItemCopy(),
        const IOSSystemContextMenuItemPaste(),
        const IOSSystemContextMenuItemSelectAll(),
        const IOSSystemContextMenuItemSearchWeb(
          title: 'Search!', // title is optional for this button, defaults to localized string
        ),
        // Milestone 3:
        IOSSystemContextMenuItemCustom(
          // title and onPressed are required
          title: 'custom button',
          onPressed: () {
            print('pressed the custom button.');
          }
        ),
      ],
    );
  },
),

Raw Controller API

_systemContextMenuController.show(
  widget.anchor,
  <IOSSystemContextMenuItemData>[
    // Notice these are different classes than those used for the widget. That's
    // mainly because I can't provide localized defaults here, so the titles are
    // required in the classes that have titles.
    const IOSSystemContextMenuItemDataCut(),
    const IOSSystemContextMenuItemDataCopy(),
    const IOSSystemContextMenuItemDataPaste(),
    const IOSSystemContextMenuItemDataSelectAll(),
    const IOSSystemContextMenuItemDataSearchWeb(
      title: 'Search!', // title is required.
    ),
    // Milestone 3:
    IOSSystemContextMenuItemDataCustom(
      // title and onPressed are required as before.
      title: 'custom button',
      onPressed: () {
        print('pressed the custom button.');
      }
    ),
  ],
);

Json format

    return _channel.invokeMethod<Map<String, dynamic>>(
      'ContextMenu.showSystemContextMenu',
      <String, dynamic>{
        'targetRect': <String, double>{
          'x': targetRect.left,
          'y': targetRect.top,
          'width': targetRect.width,
          'height': targetRect.height,
        },
        'items': <dynamic>[
          <String, dynamic>{
            'type': 'default',
            'action': 'paste',
          },
          <String, dynamic>{
            'type': 'default',
            'action': 'copy',
          },
          <String, dynamic>{
            'type': 'default',
            'title': 'Crazy Title',
            'action': 'share',
          },
        ],
      },
    );

Localization changes

This change requires the SystemContextMenu widget in the widgets library to be able to look up the default localized label for several context menu buttons like "Copy", etc. Those strings previously resided in MaterialLocalizations and CupertinoLocalizations, but not in WidgetsLocalizations, so I have copied the necessary strings into WidgetsLocalizations.

flutter-dashboard · 2024-11-16T00:27:45Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

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. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

I tried to make it compatible with other platforms in the future. Android has a different API.

1. Do them inside of the AppleSystemContextMenuItem. That requires me to move that class to the widgets library. Not possible with sealed class? 2. Do them inside of SystemContextMenu. But then it messes with the `json` method of SystemContextMenuItem. That would need the localized title in order to work. Maybe there are 2 concepts here. One has to be the class that's presented to the user (currently AppleSystemContextMenuItem), which needs to be compact and understandable. The pure data representation. The other is the data that is sent to the engine. Currently my problem arises because these concepts are mixed: AppleSystemContextMenuItem tries to provide a nice API to the user while also providing a toJson method that talks to the engine. Separate these two ideas. The user-facing thing shouldn't know about the engine json. Maybe SystemContextMenu should do that conversion, since it knows about both of these concepts and also has the localizations.

I've put all the localization logic in SystemContextMenu. The Items just contain dumb data and don't know anything about their conversion to json. I think this way is a lot better, but I should give a pass through to clean up and see if I can improve the architecture more.

Really needs cleanup though, and I have to remove the custom buttons stuff from this PR anyway. So next I should decide on the non-custom API in a way that works nicely with custom buttons in the future, then once that's solidified, delete the custom button stuff.

Both SystemContextMenu.items and SystemContextMenuController.show. Somewhat concerned about all of the sealed class stuff... Still considering moving/isolating the json stuff.

Reduced lines of code in respecifying title/onPressed.

No way to know if there is another SystemContextMenuController somewhere in the app! Also, that's how it was before this PR.

Manual roll requested by [email protected] flutter/flutter@043b719...1659206 2025-02-24 [email protected] Roll Skia from 3dfb3fee52e1 to 28017200173a (2 revisions) (flutter/flutter#163981) 2025-02-24 [email protected] Add integration test for Gradle-initiated android builds with flavors (flutter/flutter#163737) 2025-02-23 [email protected] Roll Skia from 72f949950adb to 3dfb3fee52e1 (1 revision) (flutter/flutter#163959) 2025-02-23 [email protected] Roll Skia from 4bee660601de to 72f949950adb (1 revision) (flutter/flutter#163948) 2025-02-22 [email protected] Roll Skia from cca9328df6ca to 4bee660601de (1 revision) (flutter/flutter#163927) 2025-02-22 [email protected] Roll Dart SDK from bad289580d9b to aea6fff33f06 (3 revisions) (flutter/flutter#163912) 2025-02-22 [email protected] Roll Skia from 1d884bab8593 to cca9328df6ca (12 revisions) (flutter/flutter#163910) 2025-02-22 [email protected] [fuchsia] include more tests in the fuchsia builders (flutter/flutter#163800) 2025-02-21 [email protected] [Engine] Add RoundSuperellipse to drawing OP (flutter/flutter#160883) 2025-02-21 [email protected] [remake] Restore old back handling for FlutterFragmentActivity (flutter/flutter#161545) 2025-02-21 [email protected] Revert "Marks Mac_benchmark basic_material_app_macos__compile to be flaky" (flutter/flutter#163878) 2025-02-21 [email protected] Revert "Marks Mac_benchmark flutter_view_macos__start_up to be flaky" (flutter/flutter#163880) 2025-02-21 [email protected] Roll Dart SDK from c5e582f15b6c to bad289580d9b (1 revision) (flutter/flutter#163885) 2025-02-21 [email protected] Revert "Marks Windows_mokey native_assets_android to be flaky" (flutter/flutter#163881) 2025-02-21 [email protected] Mark platform_views_hcpp_scroll_perf__timeline_summary out of bringup (flutter/flutter#163883) 2025-02-21 [email protected] Roll Skia from 6da10829d017 to 1d884bab8593 (42 revisions) (flutter/flutter#163789) 2025-02-21 [email protected] Enable `linux_android_emulator_tests` on presubmit. (flutter/flutter#163879) 2025-02-21 [email protected] Update gradle memory properties in example and test projects (flutter/flutter#163798) 2025-02-21 [email protected] Secure paste milestone 2 (flutter/flutter#159013) 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] 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

) Manual roll requested by [email protected] flutter/flutter@043b719...1659206 2025-02-24 [email protected] Roll Skia from 3dfb3fee52e1 to 28017200173a (2 revisions) (flutter/flutter#163981) 2025-02-24 [email protected] Add integration test for Gradle-initiated android builds with flavors (flutter/flutter#163737) 2025-02-23 [email protected] Roll Skia from 72f949950adb to 3dfb3fee52e1 (1 revision) (flutter/flutter#163959) 2025-02-23 [email protected] Roll Skia from 4bee660601de to 72f949950adb (1 revision) (flutter/flutter#163948) 2025-02-22 [email protected] Roll Skia from cca9328df6ca to 4bee660601de (1 revision) (flutter/flutter#163927) 2025-02-22 [email protected] Roll Dart SDK from bad289580d9b to aea6fff33f06 (3 revisions) (flutter/flutter#163912) 2025-02-22 [email protected] Roll Skia from 1d884bab8593 to cca9328df6ca (12 revisions) (flutter/flutter#163910) 2025-02-22 [email protected] [fuchsia] include more tests in the fuchsia builders (flutter/flutter#163800) 2025-02-21 [email protected] [Engine] Add RoundSuperellipse to drawing OP (flutter/flutter#160883) 2025-02-21 [email protected] [remake] Restore old back handling for FlutterFragmentActivity (flutter/flutter#161545) 2025-02-21 [email protected] Revert "Marks Mac_benchmark basic_material_app_macos__compile to be flaky" (flutter/flutter#163878) 2025-02-21 [email protected] Revert "Marks Mac_benchmark flutter_view_macos__start_up to be flaky" (flutter/flutter#163880) 2025-02-21 [email protected] Roll Dart SDK from c5e582f15b6c to bad289580d9b (1 revision) (flutter/flutter#163885) 2025-02-21 [email protected] Revert "Marks Windows_mokey native_assets_android to be flaky" (flutter/flutter#163881) 2025-02-21 [email protected] Mark platform_views_hcpp_scroll_perf__timeline_summary out of bringup (flutter/flutter#163883) 2025-02-21 [email protected] Roll Skia from 6da10829d017 to 1d884bab8593 (42 revisions) (flutter/flutter#163789) 2025-02-21 [email protected] Enable `linux_android_emulator_tests` on presubmit. (flutter/flutter#163879) 2025-02-21 [email protected] Update gradle memory properties in example and test projects (flutter/flutter#163798) 2025-02-21 [email protected] Secure paste milestone 2 (flutter/flutter#159013) 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] 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

WIP Playing around with it and it works

96048cd

justinmc self-assigned this Nov 16, 2024

justinmc marked this pull request as draft November 16, 2024 00:27

github-actions 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 Nov 16, 2024

justinmc mentioned this pull request Nov 18, 2024

Flutter should support iOS 15's Secure Paste feature #103163

Closed

justinmc added 10 commits November 18, 2024 13:24

WIP POC API to pass items

cc1739f

Possible public API for specifying menu items.

c387600

I tried to make it compatible with other platforms in the future. Android has a different API.

Update to new naming in the engine

f52a560

No more platform-specific items, and other cleanup.

9c61519

Todos around reconciling with ContextMenuButtonItem

a5e436f

WIP exploring onPressed callbacks (milestone4) to decide API

052e872

Remove SystemContextMenuItemType and infer it instead.

e0fe575

justinmc force-pushed the secure-paste-milestone-2 branch from cef6cac to e0fe575 Compare December 9, 2024 21:42

justinmc added 8 commits December 9, 2024 16:26

Strict enforcement of the (different) rules at both levels.

05adf33

Both SystemContextMenu.items and SystemContextMenuController.show. Somewhat concerned about all of the sealed class stuff... Still considering moving/isolating the json stuff.

Organization and a comment about how to handle type/action json stuff

931c968

Update to match simpler engine API with only type, no action

7bb0348

Use a private enum instead of a naked string

5472b3f

Final decision on where the json goes! And cleanup.

20833c8

Reduced lines of code in respecifying title/onPressed.

Docs and more simplification for SystemContextMenuItemData

8bf373c

Simplify SystemContextMenuItem

bf74cba

Full docs on button data classes

802346f

justinmc force-pushed the secure-paste-milestone-2 branch from 9596f33 to 802346f Compare December 11, 2024 21:55

justinmc added 3 commits December 11, 2024 14:43

Only save one client, the active one, not a list of all

f585b55

No separate system channel needed. Hard tied to text input.

db66e40

Probably should allow showing when already shown.

8feec81

No way to know if there is another SystemContextMenuController somewhere in the app! Also, that's how it was before this PR.

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

2fae9ae

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 641765e283cf (42 revisions) flutter/packages#8699

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

c24d05c

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 5a8f23c3dcf0 (43 revisions) flutter/packages#8701

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

354b01b

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 73b518d0c36e (44 revisions) flutter/packages#8702

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

c90150e

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to be1938aa1cbe (45 revisions) flutter/packages#8703

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

03f8548

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 289993ab8347 (46 revisions) flutter/packages#8704

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

cb08389

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 940fb3c8b1ad (47 revisions) flutter/packages#8705

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 25, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

b56e22d

engine-flutter-autoroll mentioned this pull request Feb 25, 2025

Roll Flutter from 911aa7547ed7 to 70b7664ba297 (48 revisions) flutter/packages#8706

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

a7fc3eb

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

9585a55

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

787370a

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

67a0206

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

2d10b51

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 26, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

95730da

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 27, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

ee2af49

engine-flutter-autoroll mentioned this pull request Feb 27, 2025

Manual roll Flutter from 043b71954ce7 to 16592066d70b (19 revisions) flutter/packages#8728

Merged

jmagman mentioned this pull request May 5, 2025

[ios]support native edit menu with custom actions on iOS #140184

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

275f053

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

bb05fea

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

df65e46 Secure paste milestone 2 (flutter/flutter#159013)

9fb1e0a

Asquare17 mentioned this pull request May 30, 2025

OCR option not showing in native text field menu after Secure Paste M2 implementation #169781

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Secure paste milestone 2 #159013

Secure paste milestone 2 #159013

Uh oh!

justinmc commented Nov 16, 2024 •

edited

Loading

Uh oh!

flutter-dashboard bot commented Nov 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Secure paste milestone 2 #159013

Secure paste milestone 2 #159013

Uh oh!

Conversation

justinmc commented Nov 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Widget API (most users)

Raw Controller API

Localization changes

Uh oh!

flutter-dashboard bot commented Nov 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

justinmc commented Nov 16, 2024 •

edited

Loading