Skip to content

[pigeon] FlutterApi error handling - #5008

Merged
auto-submit[bot] merged 17 commits into
flutter:mainfrom
tarrinneal:FAEH
Oct 4, 2023
Merged

[pigeon] FlutterApi error handling#5008
auto-submit[bot] merged 17 commits into
flutter:mainfrom
tarrinneal:FAEH

Conversation

@tarrinneal

@tarrinnealtarrinneal commented Sep 26, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Adds error handling on Flutter Api methods.
  • Breaking Change Removes Reply class from all Java method returns.
  • Breaking Change Adds NullableResult class for all nullable Java method returns.
  • Breaking Change Nests all enum returns in Objective-c to allow for nil response on error.
  • Breaking Change Renames Setup to SetUp in Objective-c.

fixesflutter/flutter#118243
fixesflutter/flutter#118245
fixesflutter/flutter#124268
fixesflutter/flutter#135176

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@tarrinnealtarrinneal changed the title Faeh[pigeon] FlutterApi error handlingSep 28, 2023
@tarrinneal
tarrinneal marked this pull request as ready for review September 28, 2023 17:30
@stuartmorgan-g

stuartmorgan-g commented Oct 2, 2023

Copy link
Copy Markdown
Collaborator

Since we have breaking changes to Java in this PR we should do the setup->setUp fix in Java too.

stuartmorgan-g
stuartmorgan-g requested changes Oct 2, 2023
View reviewed changes

@stuartmorgan-gstuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the new generated boilerplate makes me sad, but we can tackle that later. It great to have this plumbed correctly everywhere!

Comment threadpackages/pigeon/CHANGELOG.md Outdated
Comment threadpackages/pigeon/CHANGELOG.md Outdated
Comment threadpackages/pigeon/CHANGELOG.md Outdated
Comment threadpackages/pigeon/CHANGELOG.md Outdated
Comment threadpackages/pigeon/example/app/android/app/src/main/java/io/flutter/plugins/Messages.java Outdated
Comment threadpackages/pigeon/lib/objc_generator.dart Outdated
Comment threadpackages/pigeon/lib/objc_generator.dart Outdated
Comment threadpackages/pigeon/lib/objc_generator.dart Outdated
Comment threadpackages/pigeon/lib/objc_generator.dart Outdated

@stuartmorgan-gstuartmorgan-gOct 2, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the [outputAsNumber integerValue] need to be cast to the enum type to avoid warnings?

@tarrinnealtarrinnealOct 2, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, they're freely convertible from my understanding. 🤷

Comment threadpackages/pigeon/lib/swift_generator.dart Outdated
stuartmorgan-g
stuartmorgan-g approved these changes Oct 3, 2023
View reviewed changes

@stuartmorgan-gstuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment threadpackages/pigeon/CHANGELOG.md Outdated
Comment threadpackages/pigeon/lib/java_generator.dart Outdated
@tarrinnealtarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 4, 2023
@auto-submit
auto-submitBot merged commit d654f75 into flutter:mainOct 4, 2023
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Oct 4, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 4, 2023
@engine-flutter-autoroll
d654f75[pigeon] FlutterApi error handling (flutter/packages#5008)
f0f1076
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Oct 4, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 4, 2023
@engine-flutter-autoroll
d654f75[pigeon] FlutterApi error handling (flutter/packages#5008)
59446b7
auto-submitBot pushed a commit to flutter/flutter that referenced this pull request Oct 4, 2023
@engine-flutter-autoroll
Roll Packages fromc7008cftod654f75(3 revisions) (#135996)
c200616
flutter/packages@c7008cf...d654f75
2023-10-04 tarrinneal@gmail.com [pigeon] FlutterApi error handling (flutter/packages#5008)
2023-10-03 ychris@google.com [webview_flutter] [webview_flutter_wkwebview]Fix race condition in flaky test (flutter/packages#5068)
2023-10-03 engine-flutter-autoroll@skia.org Roll Flutter from 57ed724 to 5122991 (21 revisions) (flutter/packages#5067)
If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.
To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose
To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Mairramer pushed a commit to Mairramer/flutter that referenced this pull request Oct 10, 2023
@engine-flutter-autoroll@Mairramer
Roll Packages fromc7008cftod654f75(3 revisions) (flutter#135996)
b6f461b
flutter/packages@c7008cf...d654f75
2023-10-04 tarrinneal@gmail.com [pigeon] FlutterApi error handling (flutter/packages#5008)
2023-10-03 ychris@google.com [webview_flutter] [webview_flutter_wkwebview]Fix race condition in flaky test (flutter/packages#5068)
2023-10-03 engine-flutter-autoroll@skia.org Roll Flutter from 57ed724 to 5122991 (21 revisions) (flutter/packages#5067)
If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.
To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose
To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@tarrinneal
[pigeon] FlutterApi error handling (flutter#5008)
6780c8c
* Adds error handling on Flutter Api methods.
* **Breaking Change** Removes `Reply` class from all Java method returns.
* **Breaking Change** Adds `NullableResult` class for all nullable Java method returns.
* **Breaking Change** Nests all enum returns in Objective-c to allow for `nil` response on error.
* **Breaking Change** Renames `Setup` to `SetUp` in Objective-c.
fixesflutter/flutter#118243fixesflutter/flutter#118245fixesflutter/flutter#124268fixesflutter/flutter#135176
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
@tarrinneal
[pigeon] FlutterApi error handling (flutter#5008)
b5426f2
* Adds error handling on Flutter Api methods.
* **Breaking Change** Removes `Reply` class from all Java method returns.
* **Breaking Change** Adds `NullableResult` class for all nullable Java method returns.
* **Breaking Change** Nests all enum returns in Objective-c to allow for `nil` response on error.
* **Breaking Change** Renames `Setup` to `SetUp` in Objective-c.
fixesflutter/flutter#118243fixesflutter/flutter#118245fixesflutter/flutter#124268fixesflutter/flutter#135176
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stuartmorgan-gstuartmorgan-gstuartmorgan-g approved these changes

Assignees

No one assigned

Labels

autosubmitMerge PR when tree becomes green via auto submit Appp: pigeonplatform-androidplatform-iosplatform-macosplatform-windows

Projects

None yet

Milestone

No milestone

2 participants

@tarrinneal@stuartmorgan-g