Skip to content
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.

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

[pigeon] Adds @CanIgnoreReturnValue annotation #5601

Merged
merged 11 commits into from
Dec 12, 2023

Conversation

tarrinneal
Copy link
Contributor

@tarrinneal tarrinneal commented Dec 7, 2023

adds @CanIgnoreReturnValue annotation to java class builder method

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.

@tarrinneal tarrinneal changed the title [pigeon] Adds Can ignore return value [pigeon] Adds @CaIignoreReturnValue annotation Dec 7, 2023
@tarrinneal tarrinneal changed the title [pigeon] Adds @CaIignoreReturnValue annotation [pigeon] Adds @CanIgnoreReturnValue annotation Dec 7, 2023
@tarrinneal tarrinneal marked this pull request as ready for review December 7, 2023 14:28
@@ -65,6 +70,10 @@ protected static FlutterError createConnectionError(@NonNull String channelName)
"channel-error", "Unable to establish connection on channel: " + channelName + ".", "");
}

@Target(METHOD)
@Retention(CLASS)
@interface CanIgnoreReturnValue {}
Copy link

Choose a reason for hiding this comment

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

Thoughts about also emitting a CheckReturnValue annotation on the enclosing type? (That also means generating a CRV annotation as well)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you think it's a valuable addition, I can look into it.

Copy link

Choose a reason for hiding this comment

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

It won't help internal Google users (we have CRV by default), but any external users who are using static analysis would definitely benefit the addition of @CheckReturnValue on the enclosing type. (That being said, it can be done later, so a TODO is also fine.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we'll wait for now. If there are users who are interested in this being added, I encourage you to file an issue (or throw up a quick pr!).

Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

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

LGTM with one added comment.

packages/pigeon/lib/java_generator.dart Show resolved Hide resolved
@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 12, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 12, 2023
Copy link
Contributor

auto-submit bot commented Dec 12, 2023

auto label is removed for flutter/packages/5601, due to - The status or check suite Linux_android custom_package_tests stable has failed. Please fix the issues identified (or deflake) before re-applying this label.

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 12, 2023
@auto-submit auto-submit bot merged commit 8d3c506 into flutter:main Dec 12, 2023
79 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2023
HugoOlthof pushed a commit to moneybird/packages that referenced this pull request Dec 13, 2023
adds @CanIgnoreReturnValue annotation to java class builder method
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2023
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Dec 13, 2023
flutter/packages@80aa46a...b5958e2

2023-12-13 43054281+camsim99@users.noreply.github.com [camera, camera_android] Re-enable passing integration tests (flutter/packages#5658)
2023-12-13 engine-flutter-autoroll@skia.org Roll Flutter from 9719097 to 11a9cb7 (32 revisions) (flutter/packages#5665)
2023-12-13 stuartmorgan@google.com [url_launcher] Return false on Windows when there is no handler (flutter/packages#5359)
2023-12-13 stuartmorgan@google.com [url_launcher] Simplify Linux implementation (flutter/packages#5376)
2023-12-12 49699333+dependabot[bot]@users.noreply.github.com [local_auth]: Bump androidx.fragment:fragment from 1.6.1 to 1.6.2 in /packages/local_auth/local_auth_android/android (flutter/packages#5332)
2023-12-12 tarrinneal@gmail.com [pigeon] Adds @CanIgnoreReturnValue annotation (flutter/packages#5601)
2023-12-12 tarrinneal@gmail.com [image_picker] updates to resize logic. (flutter/packages#5527)
2023-12-12 stuartmorgan@google.com [various] Update examples using video_player (flutter/packages#5653)
2023-12-12 louisehsu@google.com [tools] Validate pubspec topic format (flutter/packages#5565)
2023-12-12 nathan2000@outlook.com [pigeon] Fix Kotlin generator to use provided errorClassName (flutter/packages#5480)

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://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
foxtrotravi pushed a commit to foxtrotravi/packages that referenced this pull request Dec 14, 2023
adds @CanIgnoreReturnValue annotation to java class builder method
@reidbaker reidbaker mentioned this pull request Jan 12, 2024
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
adds @CanIgnoreReturnValue annotation to java class builder method
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: pigeon platform-android
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants