Repository navigation
[pigeon] C++ generated code doesn't handle null arguments of custom class type #149174
Description
Steps to reproduce
I have a reproduction repo here.
Code uses url launcher windows package. I essentially updated the messages/pigeon.dart and regenerated the code.
In a nutshell, if an arg is nullable, and null is passed, it will crash the app. Here is where it crashes in the code. Essentially, when it tries to parse the nullable value.
I have instructions in the README of the reproduction repo, but here they are for completeness:
- Run
flutter build windows --debuginexample/ - Open app on Visual Studio by opening the solution in
example/build/windows/x64/runner/runner.sln - Put two break points on these lines. Note that it gets to the first line but will crash before getting to the second line.
This issue was found when implementing this feature on FlutterFire: https://github.com/firebase/flutterfire/pull/12825/files#diff-ad8aa9e593097c77254420c5c93cccbba4478ba947392296a18cceddc6068d85R4028-R4037
Expected results
Not to crash when passing null as nullable argument.
Actual results
Crashes in Pigeon generated code on this line
Code sample
Screenshots or Video
Screenshots / Video demonstration
Logs
Logs
None.
Flutter Doctor output
Doctor output
[√] Flutter (Channel stable, 3.19.6, on Microsoft Windows [Version 10.0.22631.3593], locale en-GB)
[√] Windows Version (Installed version of Windows is version 10 or higher)
[X] Android toolchain - develop for Android devices
X Unable to locate Android SDK.
Install Android Studio from: https://developer.android.com/studio/index.html
On first launch it will assist you in installing the Android SDK components.
(or visit https://flutter.dev/docs/get-started/install/windows#android-setup for detailed instructions).
If the Android SDK has been installed to a custom location, please use
`flutter config --android-sdk` to update to that location.
[√] Chrome - develop for the web
[√] Visual Studio - develop Windows apps (Visual Studio Community 2022 17.8.3)
[!] Android Studio (not installed)
[√] VS Code (version 1.89.1)
[√] Connected device (3 available)
[√] Network resources
Activity
[-]Pigeon plugin bug for nullable args in generated C++ API[/-][+]Pigeon package bug for nullable args in generated C++ API[/+]stuartmorgan-g commentedon May 28, 2024
I thought we had tests covering every arg type both nullable and non-nullable, but it looks like we missed null custom class top-level arguments somehow.
I'll see if the custom codec PR fixes this; if so we can just track adding an integration test for this here.
[-]Pigeon package bug for nullable args in generated C++ API[/-][+][pigeon] C++ generated code doesn't handle null arguments of custom class type[/+]stuartmorgan-g commentedon May 28, 2024
It doesn't. I'll look at fixing this once the custom codec changes land.
In the short term, a workaround would be to wrap the nullable class in a non-nullable class whose only field is the nullable class.
stuartmorgan-g commentedon May 28, 2024
I have a trivial fix, which I can land once custom codecs land.
russellwheatley commentedon May 29, 2024
Thank you for the quick turn around, @stuartmorgan. I look forward to its release 🙏
[pigeon] Fix handling of null class args in C++ (#6881)
github-actions commentedon Jun 21, 2024
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of
flutter doctor -vand a minimal reproduction of the issue.[pigeon] Fix handling of null class args in C++ (flutter#6881)
[pigeon] Fix handling of null class args in C++ (flutter#6881)