[pigeon] Fixes bug where Dart FlutterApis would assert that a nulla…

…ble argument was nonnull (#1515)
flutter · Apr 14, 2022 · 4eda7ad · 4eda7ad
1 parent b3ab4a5
commit 4eda7ad
Show file tree

Hide file tree

Showing 19 changed files with 161 additions and 87 deletions.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -22,6 +22,9 @@ analyzer:
     todo: ignore
     # Turned off until null-safe rollout is complete.
     unnecessary_null_comparison: ignore
+  exclude:
+    # Ignore generated files
+    - '**/*.mocks.dart' # Mockito @GenerateMocks
 
 linter:
   rules:

diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.0.4
+
+* Fixes bug where Dart `FlutterApi`s would assert that a nullable argument was nonnull.
+
 ## 2.0.3
 
 * Makes the generated Java Builder class final.

diff --git a/packages/pigeon/lib/dart_generator.dart b/packages/pigeon/lib/dart_generator.dart
@@ -338,13 +338,17 @@ void _writeFlutterApi(
 
                   indent.writeln(
                       'final $argType$nullTag $argName = ($argsArray[$count] as $genericArgType$nullTag)${castCall.isEmpty ? '' : '$nullTag$castCall'};');
-                  indent.writeln(
-                      'assert($argName != null, \'Argument for $channelName was null, expected non-null $argType.\');');
+                  if (!arg.type.isNullable) {
+                    indent.writeln(
+                        'assert($argName != null, \'Argument for $channelName was null, expected non-null $argType.\');');
+                  }
                 });
                 final Iterable<String> argNames =
-                    indexMap(func.arguments, argNameFunc);
-                call =
-                    'api.${func.name}(${argNames.map<String>((String x) => '$x$unwrapOperator').join(', ')})';
+                    indexMap(func.arguments, (int index, NamedType field) {
+                  final String name = _getSafeArgumentName(index, field);
+                  return '$name${field.type.isNullable ? '' : unwrapOperator}';
+                });
+                call = 'api.${func.name}(${argNames.join(', ')})';
               }
               if (func.returnType.isVoid) {
                 if (isAsync) {

diff --git a/packages/pigeon/lib/generator_tools.dart b/packages/pigeon/lib/generator_tools.dart
@@ -8,7 +8,7 @@ import 'dart:mirrors';
 import 'ast.dart';
 
 /// The current version of pigeon. This must match the version in pubspec.yaml.
-const String pigeonVersion = '2.0.3';
+const String pigeonVersion = '2.0.4';
 
 /// Read all the content from [stdin] to a String.
 String readStdin() {

diff --git a/packages/pigeon/mock_handler_tester/test/message.dart b/packages/pigeon/mock_handler_tester/test/message.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v0.3.0), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12
@@ -19,6 +19,12 @@ enum RequestState {
 }
 
 class SearchRequest {
+  SearchRequest({
+    this.query,
+    this.anInt,
+    this.aBool,
+  });
+
   String? query;
   int? anInt;
   bool? aBool;
@@ -33,14 +39,21 @@ class SearchRequest {
 
   static SearchRequest decode(Object message) {
     final Map<Object?, Object?> pigeonMap = message as Map<Object?, Object?>;
-    return SearchRequest()
-      ..query = pigeonMap['query'] as String?
-      ..anInt = pigeonMap['anInt'] as int?
-      ..aBool = pigeonMap['aBool'] as bool?;
+    return SearchRequest(
+      query: pigeonMap['query'] as String?,
+      anInt: pigeonMap['anInt'] as int?,
+      aBool: pigeonMap['aBool'] as bool?,
+    );
   }
 }
 
 class SearchReply {
+  SearchReply({
+    this.result,
+    this.error,
+    this.state,
+  });
+
   String? result;
   String? error;
   RequestState? state;
@@ -55,16 +68,21 @@ class SearchReply {
 
   static SearchReply decode(Object message) {
     final Map<Object?, Object?> pigeonMap = message as Map<Object?, Object?>;
-    return SearchReply()
-      ..result = pigeonMap['result'] as String?
-      ..error = pigeonMap['error'] as String?
-      ..state = pigeonMap['state'] != null
+    return SearchReply(
+      result: pigeonMap['result'] as String?,
+      error: pigeonMap['error'] as String?,
+      state: pigeonMap['state'] != null
           ? RequestState.values[pigeonMap['state']! as int]
-          : null;
+          : null,
+    );
   }
 }
 
 class Nested {
+  Nested({
+    this.request,
+  });
+
   SearchRequest? request;
 
   Object encode() {
@@ -75,10 +93,11 @@ class Nested {
 
   static Nested decode(Object message) {
     final Map<Object?, Object?> pigeonMap = message as Map<Object?, Object?>;
-    return Nested()
-      ..request = pigeonMap['request'] != null
+    return Nested(
+      request: pigeonMap['request'] != null
           ? SearchRequest.decode(pigeonMap['request']!)
-          : null;
+          : null,
+    );
   }
 }
 
@@ -132,7 +151,6 @@ class Api {
       throw PlatformException(
         code: 'channel-error',
         message: 'Unable to establish connection on channel.',
-        details: null,
       );
     } else if (replyMap['error'] != null) {
       final Map<Object?, Object?> error =
@@ -152,12 +170,11 @@ class Api {
         'dev.flutter.pigeon.Api.search', codec,
         binaryMessenger: _binaryMessenger);
     final Map<Object?, Object?>? replyMap =
-        await channel.send(<Object>[arg_request]) as Map<Object?, Object?>?;
+        await channel.send(<Object?>[arg_request]) as Map<Object?, Object?>?;
     if (replyMap == null) {
       throw PlatformException(
         code: 'channel-error',
         message: 'Unable to establish connection on channel.',
-        details: null,
       );
     } else if (replyMap['error'] != null) {
       final Map<Object?, Object?> error =
@@ -167,6 +184,11 @@ class Api {
         message: error['message'] as String?,
         details: error['details'],
       );
+    } else if (replyMap['result'] == null) {
+      throw PlatformException(
+        code: 'null-error',
+        message: 'Host platform returned null value for non-null return value.',
+      );
     } else {
       return (replyMap['result'] as SearchReply?)!;
     }
@@ -183,6 +205,9 @@ class _NestedApiCodec extends StandardMessageCodec {
     } else if (value is SearchReply) {
       buffer.putUint8(129);
       writeValue(buffer, value.encode());
+    } else if (value is SearchRequest) {
+      buffer.putUint8(130);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -197,6 +222,9 @@ class _NestedApiCodec extends StandardMessageCodec {
       case 129:
         return SearchReply.decode(readValue(buffer)!);
 
+      case 130:
+        return SearchRequest.decode(readValue(buffer)!);
+
       default:
         return super.readValueOfType(type, buffer);
     }
@@ -219,12 +247,11 @@ class NestedApi {
         'dev.flutter.pigeon.NestedApi.search', codec,
         binaryMessenger: _binaryMessenger);
     final Map<Object?, Object?>? replyMap =
-        await channel.send(<Object>[arg_nested]) as Map<Object?, Object?>?;
+        await channel.send(<Object?>[arg_nested]) as Map<Object?, Object?>?;
     if (replyMap == null) {
       throw PlatformException(
         code: 'channel-error',
         message: 'Unable to establish connection on channel.',
-        details: null,
       );
     } else if (replyMap['error'] != null) {
       final Map<Object?, Object?> error =
@@ -234,6 +261,11 @@ class NestedApi {
         message: error['message'] as String?,
         details: error['details'],
       );
+    } else if (replyMap['result'] == null) {
+      throw PlatformException(
+        code: 'null-error',
+        message: 'Host platform returned null value for non-null return value.',
+      );
     } else {
       return (replyMap['result'] as SearchReply?)!;
     }
@@ -274,18 +306,19 @@ abstract class FlutterSearchApi {
   static const MessageCodec<Object?> codec = _FlutterSearchApiCodec();
 
   SearchReply search(SearchRequest request);
-  static void setup(FlutterSearchApi? api) {
+  static void setup(FlutterSearchApi? api, {BinaryMessenger? binaryMessenger}) {
     {
-      const BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
-          'dev.flutter.pigeon.FlutterSearchApi.search', codec);
+      final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.FlutterSearchApi.search', codec,
+          binaryMessenger: binaryMessenger);
       if (api == null) {
         channel.setMessageHandler(null);
       } else {
         channel.setMessageHandler((Object? message) async {
           assert(message != null,
               'Argument for dev.flutter.pigeon.FlutterSearchApi.search was null.');
           final List<Object?> args = (message as List<Object?>?)!;
-          final SearchRequest? arg_request = args[0] as SearchRequest?;
+          final SearchRequest? arg_request = (args[0] as SearchRequest?);
           assert(arg_request != null,
               'Argument for dev.flutter.pigeon.FlutterSearchApi.search was null, expected non-null SearchRequest.');
           final SearchReply output = api.search(arg_request!);

diff --git a/packages/pigeon/mock_handler_tester/test/test.dart b/packages/pigeon/mock_handler_tester/test/test.dart
@@ -2,9 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v0.3.0), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
-// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import
+// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis
+// ignore_for_file: avoid_relative_lib_imports
 // @dart = 2.12
 import 'dart:async';
 import 'dart:typed_data' show Uint8List, Int32List, Int64List, Float64List;
@@ -49,10 +50,11 @@ abstract class TestHostApi {
 
   void initialize();
   SearchReply search(SearchRequest request);
-  static void setup(TestHostApi? api) {
+  static void setup(TestHostApi? api, {BinaryMessenger? binaryMessenger}) {
     {
-      const BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
-          'dev.flutter.pigeon.Api.initialize', codec);
+      final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.Api.initialize', codec,
+          binaryMessenger: binaryMessenger);
       if (api == null) {
         channel.setMockMessageHandler(null);
       } else {
@@ -64,16 +66,17 @@ abstract class TestHostApi {
       }
     }
     {
-      const BasicMessageChannel<Object?> channel =
-          BasicMessageChannel<Object?>('dev.flutter.pigeon.Api.search', codec);
+      final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.Api.search', codec,
+          binaryMessenger: binaryMessenger);
       if (api == null) {
         channel.setMockMessageHandler(null);
       } else {
         channel.setMockMessageHandler((Object? message) async {
           assert(message != null,
               'Argument for dev.flutter.pigeon.Api.search was null.');
           final List<Object?> args = (message as List<Object?>?)!;
-          final SearchRequest? arg_request = args[0] as SearchRequest?;
+          final SearchRequest? arg_request = (args[0] as SearchRequest?);
           assert(arg_request != null,
               'Argument for dev.flutter.pigeon.Api.search was null, expected non-null SearchRequest.');
           final SearchReply output = api.search(arg_request!);
@@ -94,6 +97,9 @@ class _TestNestedApiCodec extends StandardMessageCodec {
     } else if (value is SearchReply) {
       buffer.putUint8(129);
       writeValue(buffer, value.encode());
+    } else if (value is SearchRequest) {
+      buffer.putUint8(130);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -108,6 +114,9 @@ class _TestNestedApiCodec extends StandardMessageCodec {
       case 129:
         return SearchReply.decode(readValue(buffer)!);
 
+      case 130:
+        return SearchRequest.decode(readValue(buffer)!);
+
       default:
         return super.readValueOfType(type, buffer);
     }
@@ -118,18 +127,19 @@ abstract class TestNestedApi {
   static const MessageCodec<Object?> codec = _TestNestedApiCodec();
 
   SearchReply search(Nested nested);
-  static void setup(TestNestedApi? api) {
+  static void setup(TestNestedApi? api, {BinaryMessenger? binaryMessenger}) {
     {
-      const BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
-          'dev.flutter.pigeon.NestedApi.search', codec);
+      final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.NestedApi.search', codec,
+          binaryMessenger: binaryMessenger);
       if (api == null) {
         channel.setMockMessageHandler(null);
       } else {
         channel.setMockMessageHandler((Object? message) async {
           assert(message != null,
               'Argument for dev.flutter.pigeon.NestedApi.search was null.');
           final List<Object?> args = (message as List<Object?>?)!;
-          final Nested? arg_nested = args[0] as Nested?;
+          final Nested? arg_nested = (args[0] as Nested?);
           assert(arg_nested != null,
               'Argument for dev.flutter.pigeon.NestedApi.search was null, expected non-null Nested.');
           final SearchReply output = api.search(arg_nested!);

diff --git a/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/all_datatypes.dart b/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/all_datatypes.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v1.0.19), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12

diff --git a/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/multiple_arity.gen.dart b/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/multiple_arity.gen.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v1.0.19), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12

diff --git a/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/non_null_fields.gen.dart b/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/non_null_fields.gen.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v1.0.19), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12

diff --git a/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/null_fields.gen.dart b/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/null_fields.gen.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v2.0.2), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12

diff --git a/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/null_safe_pigeon.dart b/packages/pigeon/platform_tests/flutter_null_safe_unit_tests/lib/null_safe_pigeon.dart
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
-// Autogenerated from Pigeon (v1.0.19), do not edit directly.
+// Autogenerated from Pigeon (v2.0.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name
 // @dart = 2.12