Skip to content

Commit d8aba48

Browse files
authored
[pigeon] Treat NSNull as null for non-null Flutter API returns (flutter#12531)
## Description `FlutterStandardReader` substitutes `NSNull` for a `nil` element when it decodes a list, so a null reply for a non-null return value reaches the generated Swift code as `NSNull` rather than as `nil`. The generated guard only checks `listResponse[0] == nil`, so `NSNull` falls through to the force cast below it and aborts the process: ```swift } else if listResponse[0] == nil { completion(.failure(PigeonError(code: "null-error", ...))) } else { let result = listResponse[0] as! AuthenticationChallengeResponse // 💥 ``` This crashes production apps through `webview_flutter_wkwebview`: the plugin clears its native instance manager in `WebViewFlutterPlugin.tearDownProxyAPIRegistrar()`, which iOS triggers on `sceneDidDisconnect` / `applicationWillTerminate`. A `WKNavigationDelegate.didReceiveAuthenticationChallenge` reply that is still in flight then carries an identifier the native instance manager can no longer resolve, the codec reader returns `nil`, and the app dies with: ``` Could not cast value of type 'NSNull' (0x...) to 'webview_flutter_wkwebview.AuthenticationChallengeResponse' (0x...). ``` The same shape was reported before for other types (`URLRequestWrapper` in flutter/flutter#162437), which is expected: the generator emits this guard for every non-null return value, so any unresolvable instance crashes instead of reporting an error. This PR treats `NSNull` as a null reply, so the existing `null-error` path handles it. ## Verification * Added a Swift generator unit test asserting the generated guard covers `NSNull`. * Added a native regression test in `platform_tests` that replies `NSNull` to a non-null Flutter API return. It passes with this change; with the generated guard reverted it aborts with `Could not cast value of type 'NSNull' (0x...) to 'test_plugin.AllNullableTypes' (0x...)`. * `dart test` and `flutter_plugin_tools format` pass locally. *Fixes flutter/flutter#191254* ## Pre-Review Checklist
1 parent 6171e00 commit d8aba48

9 files changed

Lines changed: 90 additions & 46 deletions

File tree

‎packages/pigeon/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 29.0.2
2+
3+
* [swift] Fixes a crash when a Flutter API returns null for a non-null return
4+
value and the null arrives as `NSNull`.
5+
16
## 29.0.1
27

38
* [swift] Annotates async `FlutterApi` methods with `@MainActor`.

‎packages/pigeon/example/app/ios/Runner/Messages.g.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ class MessageFlutterApi: MessageFlutterApiProtocol {
401401
let message: String? = nilOrValue(listResponse[1])
402402
let details: String? = nilOrValue(listResponse[2])
403403
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
404-
} else if listResponse[0] == nil {
404+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
405405
continuation.resume(
406406
throwing: PigeonError(
407407
code: "null-error",

‎packages/pigeon/lib/src/generator_tools.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import 'generator.dart';
1616
/// The current version of pigeon.
1717
///
1818
/// This must match the version in pubspec.yaml.
19-
const String pigeonVersion = '29.0.1';
19+
const String pigeonVersion = '29.0.2';
2020

2121
/// Default plugin package name.
2222
const String defaultPluginPackageName = 'dev.flutter.pigeon';

‎packages/pigeon/lib/src/swift/swift_generator.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2682,7 +2682,7 @@ enum ${_classNamePrefix}PigeonInternalNumberType: Int {
26822682
);
26832683
}, addTrailingNewline: false);
26842684
if (!returnType.isNullable && !returnType.isVoid) {
2685-
indent.addScoped('else if listResponse[0] == nil {', '} ', () {
2685+
indent.addScoped('else if listResponse[0] == nil || listResponse[0] is NSNull {', '} ', () {
26862686
indent.writeln(
26872687
resumeError(
26882688
'${_getErrorClassName(generatorOptions)}(code: "null-error", message: "Flutter api returned null value for non-null return value.", details: "")',

‎packages/pigeon/platform_tests/test_plugin/darwin/test_plugin/Sources/test_plugin/CoreTests.gen.swift‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4834,7 +4834,7 @@ class FlutterCallbackCoreApi: FlutterCallbackCoreApiProtocol {
48344834
let message: String? = nilOrValue(listResponse[1])
48354835
let details: String? = nilOrValue(listResponse[2])
48364836
completion(.failure(PigeonError(code: code, message: message, details: details)))
4837-
} else if listResponse[0] == nil {
4837+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
48384838
completion(
48394839
.failure(
48404840
PigeonError(
@@ -5130,7 +5130,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
51305130
let message: String? = nilOrValue(listResponse[1])
51315131
let details: String? = nilOrValue(listResponse[2])
51325132
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5133-
} else if listResponse[0] == nil {
5133+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
51345134
continuation.resume(
51355135
throwing: PigeonError(
51365136
code: "null-error",
@@ -5190,7 +5190,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
51905190
let message: String? = nilOrValue(listResponse[1])
51915191
let details: String? = nilOrValue(listResponse[2])
51925192
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5193-
} else if listResponse[0] == nil {
5193+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
51945194
continuation.resume(
51955195
throwing: PigeonError(
51965196
code: "null-error",
@@ -5251,7 +5251,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
52515251
let message: String? = nilOrValue(listResponse[1])
52525252
let details: String? = nilOrValue(listResponse[2])
52535253
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5254-
} else if listResponse[0] == nil {
5254+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
52555255
continuation.resume(
52565256
throwing: PigeonError(
52575257
code: "null-error",
@@ -5280,7 +5280,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
52805280
let message: String? = nilOrValue(listResponse[1])
52815281
let details: String? = nilOrValue(listResponse[2])
52825282
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5283-
} else if listResponse[0] == nil {
5283+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
52845284
continuation.resume(
52855285
throwing: PigeonError(
52865286
code: "null-error",
@@ -5309,7 +5309,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
53095309
let message: String? = nilOrValue(listResponse[1])
53105310
let details: String? = nilOrValue(listResponse[2])
53115311
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5312-
} else if listResponse[0] == nil {
5312+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
53135313
continuation.resume(
53145314
throwing: PigeonError(
53155315
code: "null-error",
@@ -5338,7 +5338,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
53385338
let message: String? = nilOrValue(listResponse[1])
53395339
let details: String? = nilOrValue(listResponse[2])
53405340
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5341-
} else if listResponse[0] == nil {
5341+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
53425342
continuation.resume(
53435343
throwing: PigeonError(
53445344
code: "null-error",
@@ -5367,7 +5367,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
53675367
let message: String? = nilOrValue(listResponse[1])
53685368
let details: String? = nilOrValue(listResponse[2])
53695369
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5370-
} else if listResponse[0] == nil {
5370+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
53715371
continuation.resume(
53725372
throwing: PigeonError(
53735373
code: "null-error",
@@ -5397,7 +5397,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
53975397
let message: String? = nilOrValue(listResponse[1])
53985398
let details: String? = nilOrValue(listResponse[2])
53995399
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5400-
} else if listResponse[0] == nil {
5400+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
54015401
continuation.resume(
54025402
throwing: PigeonError(
54035403
code: "null-error",
@@ -5426,7 +5426,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
54265426
let message: String? = nilOrValue(listResponse[1])
54275427
let details: String? = nilOrValue(listResponse[2])
54285428
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5429-
} else if listResponse[0] == nil {
5429+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
54305430
continuation.resume(
54315431
throwing: PigeonError(
54325432
code: "null-error",
@@ -5455,7 +5455,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
54555455
let message: String? = nilOrValue(listResponse[1])
54565456
let details: String? = nilOrValue(listResponse[2])
54575457
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5458-
} else if listResponse[0] == nil {
5458+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
54595459
continuation.resume(
54605460
throwing: PigeonError(
54615461
code: "null-error",
@@ -5486,7 +5486,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
54865486
let message: String? = nilOrValue(listResponse[1])
54875487
let details: String? = nilOrValue(listResponse[2])
54885488
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5489-
} else if listResponse[0] == nil {
5489+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
54905490
continuation.resume(
54915491
throwing: PigeonError(
54925492
code: "null-error",
@@ -5515,7 +5515,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
55155515
let message: String? = nilOrValue(listResponse[1])
55165516
let details: String? = nilOrValue(listResponse[2])
55175517
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5518-
} else if listResponse[0] == nil {
5518+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
55195519
continuation.resume(
55205520
throwing: PigeonError(
55215521
code: "null-error",
@@ -5546,7 +5546,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
55465546
let message: String? = nilOrValue(listResponse[1])
55475547
let details: String? = nilOrValue(listResponse[2])
55485548
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5549-
} else if listResponse[0] == nil {
5549+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
55505550
continuation.resume(
55515551
throwing: PigeonError(
55525552
code: "null-error",
@@ -5575,7 +5575,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
55755575
let message: String? = nilOrValue(listResponse[1])
55765576
let details: String? = nilOrValue(listResponse[2])
55775577
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5578-
} else if listResponse[0] == nil {
5578+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
55795579
continuation.resume(
55805580
throwing: PigeonError(
55815581
code: "null-error",
@@ -5606,7 +5606,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
56065606
let message: String? = nilOrValue(listResponse[1])
56075607
let details: String? = nilOrValue(listResponse[2])
56085608
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5609-
} else if listResponse[0] == nil {
5609+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
56105610
continuation.resume(
56115611
throwing: PigeonError(
56125612
code: "null-error",
@@ -5635,7 +5635,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
56355635
let message: String? = nilOrValue(listResponse[1])
56365636
let details: String? = nilOrValue(listResponse[2])
56375637
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5638-
} else if listResponse[0] == nil {
5638+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
56395639
continuation.resume(
56405640
throwing: PigeonError(
56415641
code: "null-error",
@@ -5664,7 +5664,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
56645664
let message: String? = nilOrValue(listResponse[1])
56655665
let details: String? = nilOrValue(listResponse[2])
56665666
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5667-
} else if listResponse[0] == nil {
5667+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
56685668
continuation.resume(
56695669
throwing: PigeonError(
56705670
code: "null-error",
@@ -5695,7 +5695,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
56955695
let message: String? = nilOrValue(listResponse[1])
56965696
let details: String? = nilOrValue(listResponse[2])
56975697
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5698-
} else if listResponse[0] == nil {
5698+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
56995699
continuation.resume(
57005700
throwing: PigeonError(
57015701
code: "null-error",
@@ -5726,7 +5726,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
57265726
let message: String? = nilOrValue(listResponse[1])
57275727
let details: String? = nilOrValue(listResponse[2])
57285728
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5729-
} else if listResponse[0] == nil {
5729+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
57305730
continuation.resume(
57315731
throwing: PigeonError(
57325732
code: "null-error",
@@ -5755,7 +5755,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
57555755
let message: String? = nilOrValue(listResponse[1])
57565756
let details: String? = nilOrValue(listResponse[2])
57575757
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5758-
} else if listResponse[0] == nil {
5758+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
57595759
continuation.resume(
57605760
throwing: PigeonError(
57615761
code: "null-error",
@@ -5785,7 +5785,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
57855785
let message: String? = nilOrValue(listResponse[1])
57865786
let details: String? = nilOrValue(listResponse[2])
57875787
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5788-
} else if listResponse[0] == nil {
5788+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
57895789
continuation.resume(
57905790
throwing: PigeonError(
57915791
code: "null-error",
@@ -5816,7 +5816,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
58165816
let message: String? = nilOrValue(listResponse[1])
58175817
let details: String? = nilOrValue(listResponse[2])
58185818
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5819-
} else if listResponse[0] == nil {
5819+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
58205820
continuation.resume(
58215821
throwing: PigeonError(
58225822
code: "null-error",
@@ -5845,7 +5845,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
58455845
let message: String? = nilOrValue(listResponse[1])
58465846
let details: String? = nilOrValue(listResponse[2])
58475847
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5848-
} else if listResponse[0] == nil {
5848+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
58495849
continuation.resume(
58505850
throwing: PigeonError(
58515851
code: "null-error",
@@ -5874,7 +5874,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
58745874
let message: String? = nilOrValue(listResponse[1])
58755875
let details: String? = nilOrValue(listResponse[2])
58765876
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
5877-
} else if listResponse[0] == nil {
5877+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
58785878
continuation.resume(
58795879
throwing: PigeonError(
58805880
code: "null-error",
@@ -6455,7 +6455,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
64556455
let message: String? = nilOrValue(listResponse[1])
64566456
let details: String? = nilOrValue(listResponse[2])
64576457
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
6458-
} else if listResponse[0] == nil {
6458+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
64596459
continuation.resume(
64606460
throwing: PigeonError(
64616461
code: "null-error",
@@ -6484,7 +6484,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
64846484
let message: String? = nilOrValue(listResponse[1])
64856485
let details: String? = nilOrValue(listResponse[2])
64866486
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
6487-
} else if listResponse[0] == nil {
6487+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
64886488
continuation.resume(
64896489
throwing: PigeonError(
64906490
code: "null-error",
@@ -6783,7 +6783,7 @@ class FlutterSmallApi: FlutterSmallApiProtocol {
67836783
let message: String? = nilOrValue(listResponse[1])
67846784
let details: String? = nilOrValue(listResponse[2])
67856785
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
6786-
} else if listResponse[0] == nil {
6786+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
67876787
continuation.resume(
67886788
throwing: PigeonError(
67896789
code: "null-error",
@@ -6811,7 +6811,7 @@ class FlutterSmallApi: FlutterSmallApiProtocol {
68116811
let message: String? = nilOrValue(listResponse[1])
68126812
let details: String? = nilOrValue(listResponse[2])
68136813
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
6814-
} else if listResponse[0] == nil {
6814+
} else if listResponse[0] == nil || listResponse[0] is NSNull {
68156815
continuation.resume(
68166816
throwing: PigeonError(
68176817
code: "null-error",

0 commit comments

Comments
 (0)