[pigeon] Fixes channel names of the named constructors of ProxyApis. (#8201)

bparrishMines · web-flow · commit 74963062fb0b · 2024-12-04T04:28:51.000Z
diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 22.6.4
+
+* [swift] Fixes the channel names of the named constructors of ProxyApis.
+
 ## 22.6.3
 
 * Replaces deprecated collection method usage.
diff --git a/packages/pigeon/lib/generator_tools.dart b/packages/pigeon/lib/generator_tools.dart
@@ -14,7 +14,7 @@ import 'ast.dart';
 /// The current version of pigeon.
 ///
 /// This must match the version in pubspec.yaml.
-const String pigeonVersion = '22.6.3';
+const String pigeonVersion = '22.6.4';
 
 /// Read all the content from [stdin] to a String.
 String readStdin() {
diff --git a/packages/pigeon/lib/swift_generator.dart b/packages/pigeon/lib/swift_generator.dart
@@ -2012,7 +2012,9 @@ private func nilOrValue<T>(_ value: Any?) -> T? {
               : 'pigeonDefaultConstructor';
           final String channelName = makeChannelNameWithStrings(
             apiName: api.name,
-            methodName: '${classMemberNamePrefix}defaultConstructor',
+            methodName: constructor.name.isNotEmpty
+                ? constructor.name
+                : '${classMemberNamePrefix}defaultConstructor',
             dartPackageName: dartPackageName,
           );
           writeWithApiCheckIfNecessary(
diff --git a/packages/pigeon/pigeons/proxy_api_tests.dart b/packages/pigeon/pigeons/proxy_api_tests.dart
@@ -54,6 +54,8 @@ abstract class ProxyApiTestClass extends ProxyApiSuperClass
     ProxyApiSuperClass? nullableProxyApiParam,
   );
 
+  ProxyApiTestClass.namedConstructor();
+
   late bool aBool;
   late int anInt;
   late double aDouble;
diff --git a/packages/pigeon/platform_tests/shared_test_plugin_code/lib/integration_tests.dart b/packages/pigeon/platform_tests/shared_test_plugin_code/lib/integration_tests.dart
@@ -2170,6 +2170,22 @@ void runPigeonIntegrationTests(TargetGenerator targetGenerator) {
       return;
     }
 
+    testWidgets('named constructor', (_) async {
+      final ProxyApiTestClass instance = ProxyApiTestClass.namedConstructor(
+        aBool: true,
+        anInt: 0,
+        aDouble: 0.0,
+        aString: '',
+        aUint8List: Uint8List(0),
+        aList: const <Object?>[],
+        aMap: const <String?, Object?>{},
+        anEnum: ProxyApiTestEnum.one,
+        aProxyApi: ProxyApiSuperClass(),
+      );
+      // Ensure no error calling method on instance.
+      await instance.noop();
+    });
+
     testWidgets('noop', (_) async {
       final ProxyApiTestClass api = _createGenericProxyApiTestClass();
 
diff --git a/packages/pigeon/platform_tests/shared_test_plugin_code/lib/src/generated/proxy_api_tests.gen.dart b/packages/pigeon/platform_tests/shared_test_plugin_code/lib/src/generated/proxy_api_tests.gen.dart
@@ -578,6 +578,104 @@ class ProxyApiTestClass extends ProxyApiSuperClass
     }();
   }
 
+  ProxyApiTestClass.namedConstructor({
+    super.pigeon_binaryMessenger,
+    super.pigeon_instanceManager,
+    required this.aBool,
+    required this.anInt,
+    required this.aDouble,
+    required this.aString,
+    required this.aUint8List,
+    required this.aList,
+    required this.aMap,
+    required this.anEnum,
+    required this.aProxyApi,
+    this.aNullableBool,
+    this.aNullableInt,
+    this.aNullableDouble,
+    this.aNullableString,
+    this.aNullableUint8List,
+    this.aNullableList,
+    this.aNullableMap,
+    this.aNullableEnum,
+    this.aNullableProxyApi,
+    this.anInterfaceMethod,
+    this.flutterNoop,
+    this.flutterThrowError,
+    this.flutterThrowErrorFromVoid,
+    this.flutterEchoBool,
+    this.flutterEchoInt,
+    this.flutterEchoDouble,
+    this.flutterEchoString,
+    this.flutterEchoUint8List,
+    this.flutterEchoList,
+    this.flutterEchoProxyApiList,
+    this.flutterEchoMap,
+    this.flutterEchoProxyApiMap,
+    this.flutterEchoEnum,
+    this.flutterEchoProxyApi,
+    this.flutterEchoNullableBool,
+    this.flutterEchoNullableInt,
+    this.flutterEchoNullableDouble,
+    this.flutterEchoNullableString,
+    this.flutterEchoNullableUint8List,
+    this.flutterEchoNullableList,
+    this.flutterEchoNullableMap,
+    this.flutterEchoNullableEnum,
+    this.flutterEchoNullableProxyApi,
+    this.flutterNoopAsync,
+    this.flutterEchoAsyncString,
+  }) : super.pigeon_detached() {
+    final int pigeonVar_instanceIdentifier =
+        pigeon_instanceManager.addDartCreatedInstance(this);
+    final _PigeonInternalProxyApiBaseCodec pigeonChannelCodec =
+        _pigeonVar_codecProxyApiTestClass;
+    final BinaryMessenger? pigeonVar_binaryMessenger = pigeon_binaryMessenger;
+    () async {
+      const String pigeonVar_channelName =
+          'dev.flutter.pigeon.pigeon_integration_tests.ProxyApiTestClass.namedConstructor';
+      final BasicMessageChannel<Object?> pigeonVar_channel =
+          BasicMessageChannel<Object?>(
+        pigeonVar_channelName,
+        pigeonChannelCodec,
+        binaryMessenger: pigeonVar_binaryMessenger,
+      );
+      final List<Object?>? pigeonVar_replyList =
+          await pigeonVar_channel.send(<Object?>[
+        pigeonVar_instanceIdentifier,
+        aBool,
+        anInt,
+        aDouble,
+        aString,
+        aUint8List,
+        aList,
+        aMap,
+        anEnum,
+        aProxyApi,
+        aNullableBool,
+        aNullableInt,
+        aNullableDouble,
+        aNullableString,
+        aNullableUint8List,
+        aNullableList,
+        aNullableMap,
+        aNullableEnum,
+        aNullableProxyApi
+      ]) as List<Object?>?;
+      if (pigeonVar_replyList == null) {
+        throw _createConnectionError(pigeonVar_channelName);
+      } else if (pigeonVar_replyList.length > 1) {
+        throw PlatformException(
+          code: pigeonVar_replyList[0]! as String,
+          message: pigeonVar_replyList[1] as String?,
+          details: pigeonVar_replyList[2],
+        );
+      } else {
+        return;
+      }
+    }();
+  }
+
   /// Constructs [ProxyApiTestClass] without creating the associated native object.
   ///
   /// This should only be used by subclasses created by this library or to
diff --git a/packages/pigeon/platform_tests/test_plugin/android/src/main/kotlin/com/example/test_plugin/ProxyApiTestApiImpls.kt b/packages/pigeon/platform_tests/test_plugin/android/src/main/kotlin/com/example/test_plugin/ProxyApiTestApiImpls.kt
@@ -74,6 +74,29 @@ class ProxyApiTestClassApi(override val pigeonRegistrar: ProxyApiRegistrar) :
     return ProxyApiTestClass()
   }
 
+  override fun namedConstructor(
+      aBool: Boolean,
+      anInt: Long,
+      aDouble: Double,
+      aString: String,
+      aUint8List: ByteArray,
+      aList: List<Any?>,
+      aMap: Map<String?, Any?>,
+      anEnum: ProxyApiTestEnum,
+      aProxyApi: ProxyApiSuperClass,
+      aNullableBool: Boolean?,
+      aNullableInt: Long?,
+      aNullableDouble: Double?,
+      aNullableString: String?,
+      aNullableUint8List: ByteArray?,
+      aNullableList: List<Any?>?,
+      aNullableMap: Map<String?, Any?>?,
+      aNullableEnum: ProxyApiTestEnum?,
+      aNullableProxyApi: ProxyApiSuperClass?,
+  ): ProxyApiTestClass {
+    return ProxyApiTestClass()
+  }
+
   override fun attachedField(pigeon_instance: ProxyApiTestClass): ProxyApiSuperClass {
     return ProxyApiSuperClass()
   }
diff --git a/packages/pigeon/platform_tests/test_plugin/android/src/main/kotlin/com/example/test_plugin/ProxyApiTests.gen.kt b/packages/pigeon/platform_tests/test_plugin/android/src/main/kotlin/com/example/test_plugin/ProxyApiTests.gen.kt
@@ -549,6 +549,27 @@ abstract class PigeonApiProxyApiTestClass(
       nullableProxyApiParam: com.example.test_plugin.ProxyApiSuperClass?
   ): ProxyApiTestClass
 
+  abstract fun namedConstructor(
+      aBool: Boolean,
+      anInt: Long,
+      aDouble: Double,
+      aString: String,
+      aUint8List: ByteArray,
+      aList: List<Any?>,
+      aMap: Map<String?, Any?>,
+      anEnum: ProxyApiTestEnum,
+      aProxyApi: com.example.test_plugin.ProxyApiSuperClass,
+      aNullableBool: Boolean?,
+      aNullableInt: Long?,
+      aNullableDouble: Double?,
+      aNullableString: String?,
+      aNullableUint8List: ByteArray?,
+      aNullableList: List<Any?>?,
+      aNullableMap: Map<String?, Any?>?,
+      aNullableEnum: ProxyApiTestEnum?,
+      aNullableProxyApi: com.example.test_plugin.ProxyApiSuperClass?
+  ): ProxyApiTestClass
+
   abstract fun attachedField(
       pigeon_instance: ProxyApiTestClass
   ): com.example.test_plugin.ProxyApiSuperClass
@@ -1108,6 +1129,67 @@ abstract class PigeonApiProxyApiTestClass(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.pigeon_integration_tests.ProxyApiTestClass.namedConstructor",
+                codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val pigeon_identifierArg = args[0] as Long
+            val aBoolArg = args[1] as Boolean
+            val anIntArg = args[2] as Long
+            val aDoubleArg = args[3] as Double
+            val aStringArg = args[4] as String
+            val aUint8ListArg = args[5] as ByteArray
+            val aListArg = args[6] as List<Any?>
+            val aMapArg = args[7] as Map<String?, Any?>
+            val anEnumArg = args[8] as ProxyApiTestEnum
+            val aProxyApiArg = args[9] as com.example.test_plugin.ProxyApiSuperClass
+            val aNullableBoolArg = args[10] as Boolean?
+            val aNullableIntArg = args[11] as Long?
+            val aNullableDoubleArg = args[12] as Double?
+            val aNullableStringArg = args[13] as String?
+            val aNullableUint8ListArg = args[14] as ByteArray?
+            val aNullableListArg = args[15] as List<Any?>?
+            val aNullableMapArg = args[16] as Map<String?, Any?>?
+            val aNullableEnumArg = args[17] as ProxyApiTestEnum?
+            val aNullableProxyApiArg = args[18] as com.example.test_plugin.ProxyApiSuperClass?
+            val wrapped: List<Any?> =
+                try {
+                  api.pigeonRegistrar.instanceManager.addDartCreatedInstance(
+                      api.namedConstructor(
+                          aBoolArg,
+                          anIntArg,
+                          aDoubleArg,
+                          aStringArg,
+                          aUint8ListArg,
+                          aListArg,
+                          aMapArg,
+                          anEnumArg,
+                          aProxyApiArg,
+                          aNullableBoolArg,
+                          aNullableIntArg,
+                          aNullableDoubleArg,
+                          aNullableStringArg,
+                          aNullableUint8ListArg,
+                          aNullableListArg,
+                          aNullableMapArg,
+                          aNullableEnumArg,
+                          aNullableProxyApiArg),
+                      pigeon_identifierArg)
+                  listOf(null)
+                } catch (exception: Throwable) {
+                  wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel =
             BasicMessageChannel<Any?>(
diff --git a/packages/pigeon/platform_tests/test_plugin/ios/Classes/ProxyApiTests.gen.swift b/packages/pigeon/platform_tests/test_plugin/ios/Classes/ProxyApiTests.gen.swift
@@ -628,6 +628,15 @@ protocol PigeonApiDelegateProxyApiTestClass {
     nullableListParam: [Any?]?, nullableMapParam: [String?: Any?]?,
     nullableEnumParam: ProxyApiTestEnum?, nullableProxyApiParam: ProxyApiSuperClass?
   ) throws -> ProxyApiTestClass
+  func namedConstructor(
+    pigeonApi: PigeonApiProxyApiTestClass, aBool: Bool, anInt: Int64, aDouble: Double,
+    aString: String, aUint8List: FlutterStandardTypedData, aList: [Any?], aMap: [String?: Any?],
+    anEnum: ProxyApiTestEnum, aProxyApi: ProxyApiSuperClass, aNullableBool: Bool?,
+    aNullableInt: Int64?, aNullableDouble: Double?, aNullableString: String?,
+    aNullableUint8List: FlutterStandardTypedData?, aNullableList: [Any?]?,
+    aNullableMap: [String?: Any?]?, aNullableEnum: ProxyApiTestEnum?,
+    aNullableProxyApi: ProxyApiSuperClass?
+  ) throws -> ProxyApiTestClass
   func attachedField(pigeonApi: PigeonApiProxyApiTestClass, pigeonInstance: ProxyApiTestClass)
     throws -> ProxyApiSuperClass
   func staticAttachedField(pigeonApi: PigeonApiProxyApiTestClass) throws -> ProxyApiSuperClass
@@ -1168,6 +1177,50 @@ final class PigeonApiProxyApiTestClass: PigeonApiProtocolProxyApiTestClass {
     } else {
       pigeonDefaultConstructorChannel.setMessageHandler(nil)
     }
+    let namedConstructorChannel = FlutterBasicMessageChannel(
+      name: "dev.flutter.pigeon.pigeon_integration_tests.ProxyApiTestClass.namedConstructor",
+      binaryMessenger: binaryMessenger, codec: codec)
+    if let api = api {
+      namedConstructorChannel.setMessageHandler { message, reply in
+        let args = message as! [Any?]
+        let pigeonIdentifierArg = args[0] as! Int64
+        let aBoolArg = args[1] as! Bool
+        let anIntArg = args[2] as! Int64
+        let aDoubleArg = args[3] as! Double
+        let aStringArg = args[4] as! String
+        let aUint8ListArg = args[5] as! FlutterStandardTypedData
+        let aListArg = args[6] as! [Any?]
+        let aMapArg = args[7] as! [String?: Any?]
+        let anEnumArg = args[8] as! ProxyApiTestEnum
+        let aProxyApiArg = args[9] as! ProxyApiSuperClass
+        let aNullableBoolArg: Bool? = nilOrValue(args[10])
+        let aNullableIntArg: Int64? = nilOrValue(args[11])
+        let aNullableDoubleArg: Double? = nilOrValue(args[12])
+        let aNullableStringArg: String? = nilOrValue(args[13])
+        let aNullableUint8ListArg: FlutterStandardTypedData? = nilOrValue(args[14])
+        let aNullableListArg: [Any?]? = nilOrValue(args[15])
+        let aNullableMapArg: [String?: Any?]? = nilOrValue(args[16])
+        let aNullableEnumArg: ProxyApiTestEnum? = nilOrValue(args[17])
+        let aNullableProxyApiArg: ProxyApiSuperClass? = nilOrValue(args[18])
+        do {
+          api.pigeonRegistrar.instanceManager.addDartCreatedInstance(
+            try api.pigeonDelegate.namedConstructor(
+              pigeonApi: api, aBool: aBoolArg, anInt: anIntArg, aDouble: aDoubleArg,
+              aString: aStringArg, aUint8List: aUint8ListArg, aList: aListArg, aMap: aMapArg,
+              anEnum: anEnumArg, aProxyApi: aProxyApiArg, aNullableBool: aNullableBoolArg,
+              aNullableInt: aNullableIntArg, aNullableDouble: aNullableDoubleArg,
+              aNullableString: aNullableStringArg, aNullableUint8List: aNullableUint8ListArg,
+              aNullableList: aNullableListArg, aNullableMap: aNullableMapArg,
+              aNullableEnum: aNullableEnumArg, aNullableProxyApi: aNullableProxyApiArg),
+            withIdentifier: pigeonIdentifierArg)
+          reply(wrapResult(nil))
+        } catch {
+          reply(wrapError(error))
+        }
+      }
+    } else {
+      namedConstructorChannel.setMessageHandler(nil)
+    }
     let attachedFieldChannel = FlutterBasicMessageChannel(
       name: "dev.flutter.pigeon.pigeon_integration_tests.ProxyApiTestClass.attachedField",
       binaryMessenger: binaryMessenger, codec: codec)
diff --git a/packages/pigeon/platform_tests/test_plugin/ios/Classes/TestPlugin.swift b/packages/pigeon/platform_tests/test_plugin/ios/Classes/TestPlugin.swift
@@ -1238,6 +1238,18 @@ class ProxyApiDelegate: ProxyApiTestsPigeonProxyApiDelegate {
         return ProxyApiTestClass()
       }
 
+      func namedConstructor(
+        pigeonApi: PigeonApiProxyApiTestClass, aBool: Bool, anInt: Int64, aDouble: Double,
+        aString: String, aUint8List: FlutterStandardTypedData, aList: [Any?], aMap: [String?: Any?],
+        anEnum: ProxyApiTestEnum, aProxyApi: ProxyApiSuperClass, aNullableBool: Bool?,
+        aNullableInt: Int64?, aNullableDouble: Double?, aNullableString: String?,
+        aNullableUint8List: FlutterStandardTypedData?, aNullableList: [Any?]?,
+        aNullableMap: [String?: Any?]?, aNullableEnum: ProxyApiTestEnum?,
+        aNullableProxyApi: ProxyApiSuperClass?
+      ) throws -> ProxyApiTestClass {
+        return ProxyApiTestClass()
+      }
+
       func attachedField(pigeonApi: PigeonApiProxyApiTestClass, pigeonInstance: ProxyApiTestClass)
         throws -> ProxyApiSuperClass
       {
diff --git a/packages/pigeon/platform_tests/test_plugin/macos/Classes/ProxyApiTests.gen.swift b/packages/pigeon/platform_tests/test_plugin/macos/Classes/ProxyApiTests.gen.swift
diff --git a/packages/pigeon/platform_tests/test_plugin/macos/Classes/TestPlugin.swift b/packages/pigeon/platform_tests/test_plugin/macos/Classes/TestPlugin.swift
diff --git a/packages/pigeon/pubspec.yaml b/packages/pigeon/pubspec.yaml
diff --git a/packages/pigeon/test/swift/proxy_api_test.dart b/packages/pigeon/test/swift/proxy_api_test.dart
diff --git a/packages/pigeon/tool/shared/generation.dart b/packages/pigeon/tool/shared/generation.dart
