Deprecate these old APIs (#116793)

Hixie · web-flow · commit 806c1f818634 · 2023-04-06T19:53:50.000Z
Deprecate these old APIs
diff --git a/dev/bots/analyze.dart b/dev/bots/analyze.dart
@@ -534,6 +534,14 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =
             String possibleReason = '';
             if (lines[lineNumber].trimLeft().startsWith('"')) {
               possibleReason = ' You might have used double quotes (") for the string instead of single quotes (\').';
+            } else if (!lines[lineNumber].contains("'")) {
+              possibleReason = ' It might be missing the line saying "This feature was deprecated after...".';
+            } else if (!lines[lineNumber].trimRight().endsWith(" '")) {
+              if (lines[lineNumber].contains('This feature was deprecated')) {
+                possibleReason = ' There might not be an explanatory message.';
+              } else {
+                possibleReason = ' There might be a missing space character at the end of the line.';
+              }
             }
             throw 'Deprecation notice does not match required pattern.$possibleReason';
           }
@@ -546,6 +554,8 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =
             if (firstChar.toUpperCase() != firstChar) {
               throw 'Deprecation notice should be a grammatically correct sentence and start with a capital letter; see style guide: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo';
             }
+          } else {
+            message += messageMatch.namedGroup('message')!;
           }
           lineNumber += 1;
           if (lineNumber >= lines.length) {
@@ -565,7 +575,7 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =
           }
         }
         if (!message.endsWith('.') && !message.endsWith('!') && !message.endsWith('?')) {
-          throw 'Deprecation notice should be a grammatically correct sentence and end with a period.';
+          throw 'Deprecation notice should be a grammatically correct sentence and end with a period; notice appears to be "$message".';
         }
         if (!lines[lineNumber].startsWith("$indent  '")) {
           throw 'Unexpected deprecation notice indent.';
diff --git a/dev/bots/post_process_docs.dart b/dev/bots/post_process_docs.dart
@@ -94,13 +94,18 @@ Future<void> runProcessWithValidations(
   List<String> command,
   String workingDirectory, {
   @visibleForTesting ProcessManager processManager = const LocalProcessManager(),
+  bool verbose = true,
 }) async {
   final ProcessResult result =
       processManager.runSync(command, stdoutEncoding: utf8, workingDirectory: workingDirectory);
   if (result.exitCode == 0) {
-    print('Stdout: ${result.stdout}');
+    if (verbose) {
+      print('stdout: ${result.stdout}');
+    }
   } else {
-    print('StdErr: ${result.stderr}');
+    if (verbose) {
+      print('stderr: ${result.stderr}');
+    }
     throw CommandException();
   }
 }
diff --git a/dev/bots/test/analyze-test-input/root/packages/foo/deprecation.dart b/dev/bots/test/analyze-test-input/root/packages/foo/deprecation.dart
@@ -100,3 +100,8 @@ void test17() { }
   'This feature was deprecated after v2.1.0-11.0.pre.'
 )
 void test18() { }
+
+@Deprecated( // flutter_ignore: deprecation_syntax, https://github.com/flutter/flutter/issues/000000
+  'Missing the version line. '
+)
+void test19() { }
diff --git a/dev/bots/test/analyze_test.dart b/dev/bots/test/analyze_test.dart
@@ -45,13 +45,13 @@ void main() {
   test('analyze.dart - verifyDeprecations', () async {
     final String result = await capture(() => verifyDeprecations(testRootPath, minimumMatches: 2), shouldHaveErrors: true);
     final String lines = <String>[
-        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:12: Deprecation notice does not match required pattern.',
+        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:12: Deprecation notice does not match required pattern. There might be a missing space character at the end of the line.',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:18: Deprecation notice should be a grammatically correct sentence and start with a capital letter; see style guide: STYLE_GUIDE_URL',
-        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:25: Deprecation notice should be a grammatically correct sentence and end with a period.',
+        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:25: Deprecation notice should be a grammatically correct sentence and end with a period; notice appears to be "Also bad grammar".',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:29: Deprecation notice does not match required pattern.',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:32: Deprecation notice does not match required pattern.',
-        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:37: Deprecation notice does not match required pattern.',
-        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:41: Deprecation notice does not match required pattern.',
+        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:37: Deprecation notice does not match required pattern. It might be missing the line saying "This feature was deprecated after...".',
+        '║ test/analyze-test-input/root/packages/foo/deprecation.dart:41: Deprecation notice does not match required pattern. There might not be an explanatory message.',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:48: End of deprecation notice does not match required pattern.',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:51: Unexpected deprecation notice indent.',
         '║ test/analyze-test-input/root/packages/foo/deprecation.dart:70: Deprecation notice does not accurately indicate a beta branch version number; please see RELEASES_URL to find the latest beta build version number.',
diff --git a/dev/bots/test/post_process_docs_test.dart b/dev/bots/test/post_process_docs_test.dart
@@ -118,7 +118,7 @@ void main() async {
           ),
         ],
       );
-      await runProcessWithValidations(command, '', processManager: processManager);
+      await runProcessWithValidations(command, '', processManager: processManager, verbose: false);
       expect(processManager, hasNoRemainingExpectations);
     });
 
@@ -133,7 +133,7 @@ void main() async {
         ],
       );
       try {
-        await runProcessWithValidations(command, '', processManager: processManager);
+        await runProcessWithValidations(command, '', processManager: processManager, verbose: false);
         throw Exception('Exception was not thrown');
       } on CommandException catch (e) {
         expect(e, isA<Exception>());
diff --git a/dev/integration_tests/web_e2e_tests/test_driver/platform_messages_integration.dart b/dev/integration_tests/web_e2e_tests/test_driver/platform_messages_integration.dart
@@ -21,7 +21,7 @@ void main() {
     await tester.pumpAndSettle();
 
     // TODO(nurhan): https://github.com/flutter/flutter/issues/51885
-    SystemChannels.textInput.setMockMethodCallHandler(null);
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.textInput, null);
     // Focus on a TextFormField.
     final Finder finder = find.byKey(const Key('input'));
     expect(finder, findsOneWidget);
@@ -39,7 +39,7 @@ void main() {
     platformViewsRegistry.getNextPlatformViewId();
     // ignore: undefined_prefixed_name, avoid_dynamic_calls
     ui.platformViewRegistry.registerViewFactory('MyView', (int viewId) {
-      ++viewInstanceCount;
+      viewInstanceCount += 1;
       return html.DivElement();
     });
 
diff --git a/examples/api/test/widgets/binding/widget_binding_observer.0_test.dart b/examples/api/test/widgets/binding/widget_binding_observer.0_test.dart
@@ -13,8 +13,8 @@ void main() {
     Future<void> setAppLifeCycleState(AppLifecycleState state) async {
       final ByteData? message =
           const StringCodec().encodeMessage(state.toString());
-      await ServicesBinding.instance.defaultBinaryMessenger
-          .handlePlatformMessage('flutter/lifecycle', message, (_) {});
+      await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
+          'flutter/lifecycle', message, (_) {});
     }
 
     await tester.pumpWidget(
diff --git a/examples/api/test/widgets/editable_text/editable_text.on_content_inserted.0_test.dart b/examples/api/test/widgets/editable_text/editable_text.on_content_inserted.0_test.dart
@@ -44,7 +44,7 @@ void main() {
     });
 
     try {
-      await ServicesBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
+      await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
         'flutter/textinput',
         messageBytes,
             (ByteData? _) {},
diff --git a/packages/flutter/lib/src/services/binary_messenger.dart b/packages/flutter/lib/src/services/binary_messenger.dart
@@ -45,13 +45,12 @@ abstract class BinaryMessenger {
   /// To register a handler for a given message channel, see [setMessageHandler].
   ///
   /// To send a message _to_ a plugin on the platform thread, see [send].
-  // TODO(ianh): deprecate this method once cocoon and other customer_tests are migrated:
-  // @NotYetDeprecated(
-  //   'Instead of calling this method, use ServicesBinding.instance.channelBuffers.push. '
-  //   'In tests, consider using tester.binding.defaultBinaryMessenger.handlePlatformMessage '
-  //   'or TestDefaultBinaryMessenger.instance.defaultBinaryMessenger.handlePlatformMessage. '
-  //   'This feature was deprecated after v2.1.0-10.0.pre.'
-  // )
+  @Deprecated(
+    'Instead of calling this method, use ServicesBinding.instance.channelBuffers.push. '
+    'In tests, consider using tester.binding.defaultBinaryMessenger.handlePlatformMessage '
+    'or TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.handlePlatformMessage. '
+    'This feature was deprecated after v3.9.0-19.0.pre.'
+  )
   Future<void> handlePlatformMessage(String channel, ByteData? data, ui.PlatformMessageResponseCallback? callback);
 
   /// Send a binary message to the platform plugins on the given channel.
diff --git a/packages/flutter/test/cupertino/scrollbar_test.dart b/packages/flutter/test/cupertino/scrollbar_test.dart
@@ -208,10 +208,11 @@ void main() {
     await tester.pump();
 
     int hapticFeedbackCalls = 0;
-    SystemChannels.platform.setMockMethodCallHandler((MethodCall methodCall) async {
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.platform, (MethodCall methodCall) async {
       if (methodCall.method == 'HapticFeedback.vibrate') {
-        hapticFeedbackCalls++;
+        hapticFeedbackCalls += 1;
       }
+      return null;
     });
 
     // Long press on the scrollbar thumb and expect a vibration after it resizes.
@@ -966,10 +967,11 @@ void main() {
     await tester.pump();
 
     int hapticFeedbackCalls = 0;
-    SystemChannels.platform.setMockMethodCallHandler((MethodCall methodCall) async {
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.platform, (MethodCall methodCall) async {
       if (methodCall.method == 'HapticFeedback.vibrate') {
-        hapticFeedbackCalls++;
+        hapticFeedbackCalls += 1;
       }
+      return null;
     });
 
     // Long press on the scrollbar thumb and expect a vibration after it resizes.
diff --git a/packages/flutter/test/widgets/editable_text_test.dart b/packages/flutter/test/widgets/editable_text_test.dart
@@ -835,7 +835,7 @@ void main() {
 
   testWidgets('selection rects re-sent when refocused', (WidgetTester tester) async {
     final List<List<SelectionRect>> log = <List<SelectionRect>>[];
-    SystemChannels.textInput.setMockMethodCallHandler((MethodCall methodCall) async {
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.textInput, (MethodCall methodCall) async {
       if (methodCall.method == 'TextInput.setSelectionRects') {
         final List<dynamic> args = methodCall.arguments as List<dynamic>;
         final List<SelectionRect> selectionRects = <SelectionRect>[];
@@ -847,6 +847,7 @@ void main() {
         }
         log.add(selectionRects);
       }
+      return null;
     });
 
     final TextEditingController controller = TextEditingController();
@@ -1725,17 +1726,20 @@ void main() {
 
   group('BrowserContextMenu', () {
     setUp(() async {
-      SystemChannels.contextMenu.setMockMethodCallHandler((MethodCall call) {
-        // Just complete successfully, so that BrowserContextMenu thinks that
-        // the engine successfully received its call.
-        return Future<void>.value();
-      });
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
+        SystemChannels.contextMenu,
+        (MethodCall call) {
+          // Just complete successfully, so that BrowserContextMenu thinks that
+          // the engine successfully received its call.
+          return Future<void>.value();
+        },
+      );
       await BrowserContextMenu.disableContextMenu();
     });
 
     tearDown(() async {
       await BrowserContextMenu.enableContextMenu();
-      SystemChannels.contextMenu.setMockMethodCallHandler(null);
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.contextMenu, null);
     });
 
     testWidgets('web can show flutter context menu when the browser context menu is disabled', (WidgetTester tester) async {
@@ -5162,7 +5166,7 @@ void main() {
     tester.view.physicalSize = const Size(750.0, 1334.0);
 
     final List<List<SelectionRect>> log = <List<SelectionRect>>[];
-    SystemChannels.textInput.setMockMethodCallHandler((MethodCall methodCall) async {
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.textInput, (MethodCall methodCall) {
       if (methodCall.method == 'TextInput.setSelectionRects') {
         final List<dynamic> args = methodCall.arguments as List<dynamic>;
         final List<SelectionRect> selectionRects = <SelectionRect>[];
@@ -5174,6 +5178,7 @@ void main() {
         }
         log.add(selectionRects);
       }
+      return null;
     });
 
     final TextEditingController controller = TextEditingController();
@@ -5297,8 +5302,9 @@ void main() {
 
   testWidgets('selection rects are not sent if scribbleEnabled is false', (WidgetTester tester) async {
     final List<MethodCall> log = <MethodCall>[];
-    SystemChannels.textInput.setMockMethodCallHandler((MethodCall methodCall) async {
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.textInput, (MethodCall methodCall) async {
       log.add(methodCall);
+      return null;
     });
 
     final TextEditingController controller = TextEditingController();
diff --git a/packages/flutter/test/widgets/selectable_region_test.dart b/packages/flutter/test/widgets/selectable_region_test.dart
@@ -1883,7 +1883,7 @@ void main() {
 
   group('BrowserContextMenu', () {
     setUp(() async {
-      SystemChannels.contextMenu.setMockMethodCallHandler((MethodCall call) {
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.contextMenu, (MethodCall call) {
         // Just complete successfully, so that BrowserContextMenu thinks that
         // the engine successfully received its call.
         return Future<void>.value();
@@ -1893,7 +1893,7 @@ void main() {
 
     tearDown(() async {
       await BrowserContextMenu.enableContextMenu();
-      SystemChannels.contextMenu.setMockMethodCallHandler(null);
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.contextMenu, null);
     });
 
     testWidgets('web can show flutter context menu when the browser context menu is disabled', (WidgetTester tester) async {
diff --git a/packages/flutter/test/widgets/undo_history_test.dart b/packages/flutter/test/widgets/undo_history_test.dart
@@ -311,8 +311,9 @@ void main() {
 
     testWidgets('changes should send setUndoState to the UndoManagerConnection on iOS', (WidgetTester tester) async {
       final List<MethodCall> log = <MethodCall>[];
-      SystemChannels.undoManager.setMockMethodCallHandler((MethodCall methodCall) async {
+      tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.undoManager, (MethodCall methodCall) async {
         log.add(methodCall);
+        return null;
       });
       final FocusNode focusNode = FocusNode();
 
diff --git a/packages/flutter_test/lib/src/deprecated.dart b/packages/flutter_test/lib/src/deprecated.dart
diff --git a/packages/flutter_test/lib/src/test_text_input.dart b/packages/flutter_test/lib/src/test_text_input.dart
diff --git a/packages/flutter_tools/templates/plugin/test/projectName_method_channel_test.dart.tmpl b/packages/flutter_tools/templates/plugin/test/projectName_method_channel_test.dart.tmpl

Original file line number	Diff line number	Diff line change
`@@ -534,6 +534,14 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =`
`534`	`534`	`String possibleReason = '';`
`535`	`535`	`if (lines[lineNumber].trimLeft().startsWith('"')) {`
`536`	`536`	`possibleReason = ' You might have used double quotes (") for the string instead of single quotes (\').';`
	`537`	`+ } else if (!lines[lineNumber].contains("'")) {`
	`538`	`+ possibleReason = ' It might be missing the line saying "This feature was deprecated after...".';`
	`539`	`+ } else if (!lines[lineNumber].trimRight().endsWith(" '")) {`
	`540`	`+ if (lines[lineNumber].contains('This feature was deprecated')) {`
	`541`	`+ possibleReason = ' There might not be an explanatory message.';`
	`542`	`+ } else {`
	`543`	`+ possibleReason = ' There might be a missing space character at the end of the line.';`
	`544`	`+ }`
`537`	`545`	`}`
`538`	`546`	`throw 'Deprecation notice does not match required pattern.$possibleReason';`
`539`	`547`	`}`
`@@ -546,6 +554,8 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =`
`546`	`554`	`if (firstChar.toUpperCase() != firstChar) {`
`547`	`555`	`throw 'Deprecation notice should be a grammatically correct sentence and start with a capital letter; see style guide: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo';`
`548`	`556`	`}`
	`557`	`+ } else {`
	`558`	`+ message += messageMatch.namedGroup('message')!;`
`549`	`559`	`}`
`550`	`560`	`lineNumber += 1;`
`551`	`561`	`if (lineNumber >= lines.length) {`
`@@ -565,7 +575,7 @@ Future<void> verifyDeprecations(String workingDirectory, { int minimumMatches =`
`565`	`575`	`}`
`566`	`576`	`}`
`567`	`577`	`if (!message.endsWith('.') && !message.endsWith('!') && !message.endsWith('?')) {`
`568`		`- throw 'Deprecation notice should be a grammatically correct sentence and end with a period.';`
	`578`	`+ throw 'Deprecation notice should be a grammatically correct sentence and end with a period; notice appears to be "$message".';`
`569`	`579`	`}`
`570`	`580`	`if (!lines[lineNumber].startsWith("$indent '")) {`
`571`	`581`	`throw 'Unexpected deprecation notice indent.';`
Original file line number	Diff line number	Diff line change
`@@ -100,3 +100,8 @@ void test17() { }`
`100`	`100`	`'This feature was deprecated after v2.1.0-11.0.pre.'`
`101`	`101`	`)`
`102`	`102`	`void test18() { }`
	`103`	`+`
	`104`	`+@Deprecated( // flutter_ignore: deprecation_syntax, https://github.com/flutter/flutter/issues/000000`
	`105`	`+ 'Missing the version line. '`
	`106`	`+)`
	`107`	`+void test19() { }`