Skip to content

[pigeon] Treat NSNull as null for non-null Flutter API returns #12531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Xelorium wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[pigeon] Treat NSNull as null for non-null Flutter API returns #12531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3cd890
[pigeon] Treat NSNull as null for non-null Flutter API returns
Xelorium Aug 25, 2026
06c1df5
Address review: drop explanatory comments, fold the regression test i…
Xelorium Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/pigeon/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 28.0.1

* [swift] Fixes a crash when a Flutter API returns null for a non-null return
value and the null arrives as `NSNull`.

## 28.0.0

* **Breaking Change** Updates Kotlin and Swift generators to generate `suspend` functions and `async throws` signatures for `@FlutterApi` methods by default, and for `@HostApi` methods annotated with `@async`.
Expand Down
2 changes: 1 addition & 1 deletion packages/pigeon/example/app/ios/Runner/Messages.g.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ class MessageFlutterApi: MessageFlutterApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down
2 changes: 1 addition & 1 deletion packages/pigeon/lib/src/generator_tools.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import 'generator.dart';
/// The current version of pigeon.
///
/// This must match the version in pubspec.yaml.
const String pigeonVersion = '28.0.0';
const String pigeonVersion = '28.0.1';

/// Default plugin package name.
const String defaultPluginPackageName = 'dev.flutter.pigeon';
Expand Down
19 changes: 12 additions & 7 deletions packages/pigeon/lib/src/swift/swift_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1751,13 +1751,18 @@ static func deepHash(value: Any?, hasher: inout Hasher) {
);
}, addTrailingNewline: false);
if (!returnType.isNullable && !returnType.isVoid) {
indent.addScoped('else if listResponse[0] == nil {', '} ', () {
indent.writeln(
resumeError(
'${_getErrorClassName(generatorOptions)}(code: "null-error", message: "Flutter api returned null value for non-null return value.", details: "")',
),
);
}, addTrailingNewline: false);
indent.addScoped(
'else if listResponse[0] == nil || listResponse[0] is NSNull {',
'} ',
() {
indent.writeln(
resumeError(
'${_getErrorClassName(generatorOptions)}(code: "null-error", message: "Flutter api returned null value for non-null return value.", details: "")',
),
);
},
addTrailingNewline: false,
);
}
indent.addScoped('else {', '}', () {
if (returnType.isVoid) {
Expand Down
56 changes: 28 additions & 28 deletions ...eon/platform_tests/test_plugin/darwin/test_plugin/Sources/test_plugin/CoreTests.gen.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4815,7 +4815,7 @@ class FlutterCallbackCoreApi: FlutterCallbackCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
completion(.failure(PigeonError(code: code, message: message, details: details)))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
completion(
.failure(
PigeonError(
Expand Down Expand Up @@ -5098,7 +5098,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5157,7 +5157,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5218,7 +5218,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5247,7 +5247,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5276,7 +5276,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5305,7 +5305,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5334,7 +5334,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5363,7 +5363,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5392,7 +5392,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5421,7 +5421,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5450,7 +5450,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5479,7 +5479,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5508,7 +5508,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5537,7 +5537,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5566,7 +5566,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5595,7 +5595,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5624,7 +5624,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5655,7 +5655,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5684,7 +5684,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5713,7 +5713,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5742,7 +5742,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5773,7 +5773,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5802,7 +5802,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -5831,7 +5831,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -6401,7 +6401,7 @@ class FlutterIntegrationCoreApi: FlutterIntegrationCoreApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -6700,7 +6700,7 @@ class FlutterSmallApi: FlutterSmallApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down Expand Up @@ -6728,7 +6728,7 @@ class FlutterSmallApi: FlutterSmallApiProtocol {
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
continuation.resume(throwing: PigeonError(code: code, message: message, details: details))
} else if listResponse[0] == nil {
} else if listResponse[0] == nil || listResponse[0] is NSNull {
continuation.resume(
throwing: PigeonError(
code: "null-error",
Expand Down
Loading
Loading