Skip to content

[pigeon] Fix kotlin warning about calling bridge method #10632

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

Merged
auto-submit merged 15 commits into from
Dec 18, 2025
Merged

[pigeon] Fix kotlin warning about calling bridge method #10632

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c5a0497
Modify genrated code to implement methods from *PigeonEventChannelWra…
reidbaker Dec 15, 2025
8434383
Bump tooling/yaml version, update changelog
reidbaker Dec 15, 2025
e29d755
update kotlin generated tests
reidbaker Dec 15, 2025
ded0ac9
Implements should be outside companion object
reidbaker Dec 15, 2025
3bde0ba
Update packages/pigeon/CHANGELOG.md
reidbaker Dec 15, 2025
840ed28
Make implementation abstract to force implementation while still not …
reidbaker Dec 15, 2025
5abaa3b
Remove open and implemenation
reidbaker Dec 16, 2025
a8b0df1
Modify example to implement cancel
reidbaker Dec 16, 2025
5b75a9e
Add onCancel method to TestPlugin.kt
reidbaker Dec 16, 2025
b171079
Update example readme
reidbaker Dec 16, 2025
5e98a5b
Merge branch 'main' into i_178908_bridge_call
reidbaker Dec 16, 2025
c405fa3
Remove open with abstract because it causes lint errors
reidbaker Dec 16, 2025
b1e4279
onListen and onCancel have implementations so that not every extensio…
reidbaker Dec 16, 2025
0903bf6
Update generated files
reidbaker Dec 16, 2025
cd16ddf
Remove abstract and modify changelog
reidbaker Dec 16, 2025
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 @@
## 26.1.5

* [kotlin] Fixes a "bridge method" warning that occurs when a class uses `*PigeonEventChannelWrapper` as a
supertype without implementing all of its methods.

@stuartmorgan-g stuartmorgan-g Dec 16, 2025

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.

Is the "without implementing all of its methods" part right? The video_player code was implementing both of these methods.

@reidbaker reidbaker Dec 16, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am open to better wording but the class that implemented all the methods was an implementation of *EventsStreamHandler not the interface *PigeonEventChannelWrapper.

@stuartmorgan-g stuartmorgan-g Dec 16, 2025

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.

Oh, I see. Since we don't expect Pigeon users to directly subclass the Wrapper class, let's just say "... warning when implementing an event stream handler."


## 26.1.4

* [swift][kotlin] Fixes crash that occurs when an object that is removed from the instance manager
Expand Down
4 changes: 4 additions & 0 deletions .../app/android/app/src/main/kotlin/dev/flutter/pigeon_example_app/EventChannelMessages.g.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,4 +186,8 @@ abstract class StreamEventsStreamHandler :
.setStreamHandler(internalStreamHandler)
}
}
// Implement methods from EventChannelMessagesPigeonEventChannelWrapper
override open fun onListen(p0: Any?, sink: PigeonEventSink<PlatformEvent>) {}

@stuartmorgan-g stuartmorgan-g Dec 15, 2025

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.

Does making these abstract instead of no-ops ({}) work and fix the warning? That would be an explicit statement of the intent here, which is to not implement the interface at this level but require subclasses to implement the type-specified version.

@stuartmorgan-g stuartmorgan-g Dec 15, 2025

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.

I repro'd locally and tried it, and this does indeed seem to work:

  override open abstract fun onListen(p0: Any?, sink: PigeonEventSink<PlatformVideoEvent>)
  override open abstract fun onCancel(p0: Any?)

That keeps the same semantics of forcing the subclasses to implement both methods, without tripping the warning.

@reidbaker reidbaker Dec 15, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

modifying the pr to do this instead. My goal was not to change the semantics.


override open fun onCancel(p0: Any?) {}
}
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 = '26.1.4';
const String pigeonVersion = '26.1.5';

/// Read all the content from [stdin] to a String.
String readStdin() {
Expand Down
6 changes: 6 additions & 0 deletions packages/pigeon/lib/src/kotlin/kotlin_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1234,6 +1234,12 @@ if (wrapped == null) {
EventChannel(messenger, channelName, ${generatorOptions.fileSpecificClassNameComponent}$_pigeonMethodChannelCodec).setStreamHandler(internalStreamHandler)
}
}
// Implement methods from ${generatorOptions.fileSpecificClassNameComponent}PigeonEventChannelWrapper
override
open fun onListen(p0: Any?, sink: PigeonEventSink<${_kotlinTypeForDartType(func.returnType)}>) {}

override
open fun onCancel(p0: Any?) {}
}
''');
}
Expand Down
12 changes: 12 additions & 0 deletions ...ests/test_plugin/android/src/main/kotlin/com/example/test_plugin/EventChannelTests.gen.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,10 @@ abstract class StreamIntsStreamHandler : EventChannelTestsPigeonEventChannelWrap
.setStreamHandler(internalStreamHandler)
}
}
// Implement methods from EventChannelTestsPigeonEventChannelWrapper
override open fun onListen(p0: Any?, sink: PigeonEventSink<Long>) {}

override open fun onCancel(p0: Any?) {}
}

abstract class StreamEventsStreamHandler :
Expand All @@ -595,6 +599,10 @@ abstract class StreamEventsStreamHandler :
.setStreamHandler(internalStreamHandler)
}
}
// Implement methods from EventChannelTestsPigeonEventChannelWrapper
override open fun onListen(p0: Any?, sink: PigeonEventSink<PlatformEvent>) {}

override open fun onCancel(p0: Any?) {}
}

abstract class StreamConsistentNumbersStreamHandler :
Expand All @@ -615,4 +623,8 @@ abstract class StreamConsistentNumbersStreamHandler :
.setStreamHandler(internalStreamHandler)
}
}
// Implement methods from EventChannelTestsPigeonEventChannelWrapper
override open fun onListen(p0: Any?, sink: PigeonEventSink<Long>) {}

override open fun onCancel(p0: Any?) {}
}
2 changes: 1 addition & 1 deletion packages/pigeon/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: pigeon
description: Code generator tool to make communication between Flutter and the host platform type-safe and easier.
repository: https://github.com/flutter/packages/tree/main/packages/pigeon
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+pigeon%22
version: 26.1.4 # This must match the version in lib/src/generator_tools.dart
version: 26.1.5 # This must match the version in lib/src/generator_tools.dart

environment:
sdk: ^3.9.0
Expand Down