Skip to content

Commit 40b7e64

Browse files
authored
[pigeon] Fix NSnumber edge cases and null value bug (flutter#12997)
Fixes flutter#193266 Fixes two Swift FFI value serialization bugs in `SwiftGenerator`: 1. **`CFBoolean` and floating-point `NSNumber` bridging in `wrapNumber`**: When an Objective-C boolean (`__NSCFBoolean` / `CFBoolean`) or a whole-number floating-point `NSNumber` (such as `3.0` returned from `UserDefaults.object(forKey:)` or `NSDictionary`) is boxed inside `Any`, Swift's dynamic `as? Int` cast succeeds before reaching `case let value as Double:` or `case let value as Bool:`. `wrapNumber` now checks `CFGetTypeID(number as CFTypeRef) == CFBooleanGetTypeID()` (`type: 3`) and `CFNumberIsFloatType(nsNumber)` (`type: 2`) prior to switching on numeric types, matching `FlutterStandardCodec` behavior. 2. **Dictionary value `isNullish` check in `writeValue`**: Fixes a typo in `writeValue` where dictionary serialization checked `isNullish(key)` instead of `isNullish(value)` when serializing dictionary values. Fixes https://github.com/flutter/flutter/issues/<ISSUE_NUMBER> ## Pre-Review Checklist **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
1 parent c5c44ee commit 40b7e64

9 files changed

Lines changed: 90 additions & 52 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.4
2+
3+
* [swift] Fixes FFI number wrapping for Objective-C `CFBoolean` and floating-point `NSNumber` values.
4+
* [swift] Fixes FFI dictionary serialization checking `isNullish` on the key instead of the value.
5+
16
## 29.0.3
27

38
* [swift] Uses `isNullish` to check for null and `NSNull` in non-null Flutter API returns.

‎packages/pigeon/example/native_interop_app/ios/Runner/NativeInteropExample.g.swift‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,17 @@ import Foundation
6060
}
6161

6262
private func wrapNumber(number: Any) -> NativeInteropExampleNumberWrapper {
63-
switch number {
64-
case let value as Int:
65-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: value), type: 1)
66-
case let value as Int64:
67-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: value), type: 1)
68-
case let value as Double:
69-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: value), type: 2)
70-
case let value as Float:
71-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: value), type: 2)
72-
case let value as Bool:
73-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: value), type: 3)
74-
75-
default:
76-
return NativeInteropExampleNumberWrapper(number: NSNumber(value: 0), type: 0)
63+
if let nsNumber = number as? NSNumber {
64+
if CFGetTypeID(nsNumber as CFTypeRef) == CFBooleanGetTypeID() {
65+
return NativeInteropExampleNumberWrapper(number: nsNumber, type: 3)
66+
}
67+
if CFNumberIsFloatType(nsNumber) {
68+
return NativeInteropExampleNumberWrapper(number: nsNumber, type: 2)
69+
}
70+
return NativeInteropExampleNumberWrapper(number: nsNumber, type: 1)
7771
}
72+
73+
return NativeInteropExampleNumberWrapper(number: NSNumber(value: 0), type: 0)
7874
}
7975

8076
private func unwrapNumber(wrappedNumber: NativeInteropExampleNumberWrapper) -> Any {
@@ -307,7 +303,7 @@ class _PigeonFfiCodec {
307303
let res: NSMutableDictionary = NSMutableDictionary(capacity: dict.count)
308304
for (key, value) in dict {
309305
res.setObject(
310-
NativeInteropExamplePigeonInternal.isNullish(key)
306+
NativeInteropExamplePigeonInternal.isNullish(value)
311307
? NativeInteropExamplePigeonInternalNull()
312308
: writeValue(value: value, isObject: true) as! NSObject,
313309
forKey: writeValue(value: key, isObject: true) as! NSCopying)

‎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.3';
19+
const String pigeonVersion = '29.0.4';
2020

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

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

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ class _PigeonFfiCodec {
501501
let dict = value as! [AnyHashable: Any]
502502
let res: NSMutableDictionary = NSMutableDictionary(capacity: dict.count)
503503
for (key, value) in dict {
504-
res.setObject(${_classNamePrefix}PigeonInternal.isNullish(key) ? ${_classNamePrefix}PigeonInternalNull() : writeValue(value: value, isObject: true) as! NSObject, forKey: writeValue(value: key, isObject: true) as! NSCopying)
504+
res.setObject(${_classNamePrefix}PigeonInternal.isNullish(value) ? ${_classNamePrefix}PigeonInternalNull() : writeValue(value: value, isObject: true) as! NSObject, forKey: writeValue(value: key, isObject: true) as! NSCopying)
505505
}
506506
return res
507507
}
@@ -2321,35 +2321,40 @@ static func deepHash(value: Any?, hasher: inout Hasher) {
23212321
'private func wrapNumber(number: Any) -> ${_classNamePrefix}NumberWrapper {',
23222322
'}',
23232323
() {
2324-
indent.writeScoped('switch number {', '}', () {
2325-
var caseNum = 4;
2326-
indent.format('''
2327-
case let value as Int:
2328-
return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value), type: 1)
2329-
case let value as Int64:
2330-
return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value), type: 1)
2331-
case let value as Double:
2332-
return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value), type: 2)
2333-
case let value as Float:
2334-
return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value), type: 2)
2335-
case let value as Bool:
2336-
return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value), type: 3)
2324+
indent.format('''
2325+
if let nsNumber = number as? NSNumber {
2326+
if CFGetTypeID(nsNumber as CFTypeRef) == CFBooleanGetTypeID() {
2327+
return ${_classNamePrefix}NumberWrapper(number: nsNumber, type: 3)
2328+
}
2329+
if CFNumberIsFloatType(nsNumber) {
2330+
return ${_classNamePrefix}NumberWrapper(number: nsNumber, type: 2)
2331+
}
2332+
return ${_classNamePrefix}NumberWrapper(number: nsNumber, type: 1)
2333+
}
23372334
''');
2338-
for (final Enum anEnum in root.enums) {
2339-
indent.writeln('case let value as ${anEnum.name}:');
2335+
if (root.enums.isNotEmpty) {
2336+
indent.writeScoped('switch number {', '}', () {
2337+
var caseNum = 4;
2338+
for (final Enum anEnum in root.enums) {
2339+
indent.writeln('case let value as ${anEnum.name}:');
2340+
indent.inc();
2341+
indent.writeln(
2342+
'return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value.rawValue), type: ${caseNum++})',
2343+
);
2344+
indent.dec();
2345+
}
2346+
indent.writeln('default:');
23402347
indent.inc();
23412348
indent.writeln(
2342-
'return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: value.rawValue), type: ${caseNum++})',
2349+
'return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: 0), type: 0)',
23432350
);
23442351
indent.dec();
2345-
}
2346-
indent.writeln('default:');
2347-
indent.inc();
2352+
});
2353+
} else {
23482354
indent.writeln(
23492355
'return ${_classNamePrefix}NumberWrapper(number: NSNumber(value: 0), type: 0)',
23502356
);
2351-
indent.dec();
2352-
});
2357+
}
23532358
},
23542359
);
23552360
indent.newln();

‎packages/pigeon/platform_tests/shared_test_plugin_code/lib/integration_tests.dart‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,11 @@ void runPigeonIntegrationTests(TargetGenerator targetGenerator) {
443443
const Object sentDouble = 2.0694;
444444
final Object receivedDouble = await api.echoObject(sentDouble);
445445
expect(receivedDouble, sentDouble);
446+
447+
const Object sentWholeDouble = 3.0;
448+
final Object receivedWholeDouble = await api.echoObject(sentWholeDouble);
449+
expect(receivedWholeDouble, isA<double>());
450+
expect(receivedWholeDouble, sentWholeDouble);
446451
});
447452

448453
testWidgets('Uint8List as generic Objects serialize and deserialize correctly', (

‎packages/pigeon/platform_tests/shared_test_plugin_code/lib/native_interop_integration_tests.dart‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,11 @@ void runPigeonNativeInteropIntegrationTests(TargetGenerator targetGenerator) {
441441
const Object sentDouble = 2.0694;
442442
final Object receivedDouble = api!.echoObject(sentDouble);
443443
expect(receivedDouble, sentDouble);
444+
445+
const Object sentWholeDouble = 3.0;
446+
final Object receivedWholeDouble = api.echoObject(sentWholeDouble);
447+
expect(receivedWholeDouble, isA<double>());
448+
expect(receivedWholeDouble, sentWholeDouble);
444449
});
445450

446451
testWidgets('Uint8List as generic Objects serialize and deserialize correctly', (
@@ -849,10 +854,23 @@ void runPigeonNativeInteropIntegrationTests(TargetGenerator targetGenerator) {
849854
final Object? receivedString = api!.echoNullableObject(sentString);
850855
expect(receivedString, sentString);
851856

852-
// Echo a second type as well to ensure the handling is generic.
857+
// Echo each primitive number/boolean type as well to test boxed number handling.
853858
const Object sentInt = regularInt;
854859
final Object? receivedInt = api.echoNullableObject(sentInt);
855860
expect(receivedInt, sentInt);
861+
862+
const Object sentBool = true;
863+
final Object? receivedBool = api.echoNullableObject(sentBool);
864+
expect(receivedBool, sentBool);
865+
866+
const Object sentDouble = 2.0694;
867+
final Object? receivedDouble = api.echoNullableObject(sentDouble);
868+
expect(receivedDouble, sentDouble);
869+
870+
const Object sentWholeDouble = 3.0;
871+
final Object? receivedWholeDouble = api.echoNullableObject(sentWholeDouble);
872+
expect(receivedWholeDouble, isA<double>());
873+
expect(receivedWholeDouble, sentWholeDouble);
856874
});
857875

858876
testWidgets('Null generic Objects serialize and deserialize correctly', (WidgetTester _) async {

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,17 @@ private func createConnectionError(withChannelName channelName: String) -> Nativ
6767
}
6868

6969
private func wrapNumber(number: Any) -> NativeInteropTestsNumberWrapper {
70-
switch number {
71-
case let value as Int:
72-
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value), type: 1)
73-
case let value as Int64:
74-
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value), type: 1)
75-
case let value as Double:
76-
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value), type: 2)
77-
case let value as Float:
78-
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value), type: 2)
79-
case let value as Bool:
80-
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value), type: 3)
70+
if let nsNumber = number as? NSNumber {
71+
if CFGetTypeID(nsNumber as CFTypeRef) == CFBooleanGetTypeID() {
72+
return NativeInteropTestsNumberWrapper(number: nsNumber, type: 3)
73+
}
74+
if CFNumberIsFloatType(nsNumber) {
75+
return NativeInteropTestsNumberWrapper(number: nsNumber, type: 2)
76+
}
77+
return NativeInteropTestsNumberWrapper(number: nsNumber, type: 1)
78+
}
8179

80+
switch number {
8281
case let value as NativeInteropAnEnum:
8382
return NativeInteropTestsNumberWrapper(number: NSNumber(value: value.rawValue), type: 4)
8483
case let value as NativeInteropAnotherEnum:
@@ -2004,7 +2003,7 @@ class _PigeonFfiCodec {
20042003
let res: NSMutableDictionary = NSMutableDictionary(capacity: dict.count)
20052004
for (key, value) in dict {
20062005
res.setObject(
2007-
NativeInteropTestsPigeonInternal.isNullish(key)
2006+
NativeInteropTestsPigeonInternal.isNullish(value)
20082007
? NativeInteropTestsPigeonInternalNull()
20092008
: writeValue(value: value, isObject: true) as! NSObject,
20102009
forKey: writeValue(value: key, isObject: true) as! NSCopying)

‎packages/pigeon/platform_tests/test_plugin/darwin/test_plugin/Sources/test_plugin/TestPlugin.swift‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,6 +1009,16 @@ class NativeInteropTestsClass: NSObject, NativeInteropHostIntegrationCoreApi {
10091009
}
10101010

10111011
func echoNullable(_ aNullableObject: Any?) throws -> Any? {
1012+
// Return boxed NSNumber instances to test NSNumber/CFBoolean/CFNumber bridging across FFI.
1013+
if let boolValue = aNullableObject as? Bool {
1014+
return NSNumber(value: boolValue)
1015+
}
1016+
if let doubleValue = aNullableObject as? Double {
1017+
return NSNumber(value: doubleValue)
1018+
}
1019+
if let intValue = aNullableObject as? Int64 {
1020+
return NSNumber(value: intValue)
1021+
}
10121022
return aNullableObject
10131023
}
10141024

‎packages/pigeon/pubspec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: pigeon
22
description: Code generator tool to make communication between Flutter and the host platform type-safe and easier.
33
repository: https://github.com/flutter/packages/tree/main/packages/pigeon
44
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+pigeon%22
5-
version: 29.0.3 # This must match the version in lib/src/generator_tools.dart
5+
version: 29.0.4 # This must match the version in lib/src/generator_tools.dart
66

77
environment:
88
sdk: ^3.11.0

0 commit comments

Comments
 (0)