Skip to content

[pigeon] Deprecate dartHostTestHandler #10403

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
merged 2 commits into from
Nov 12, 2025
+16 −4
Merged

[pigeon] Deprecate dartHostTestHandler #10403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7e1ee3
[pigeon] Deprecate dartHostTestHandler
stuartmorgan-g Nov 11, 2025
7918568
Add dartTestOut to changelog
stuartmorgan-g Nov 11, 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
7 changes: 7 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,10 @@
## 26.1.0

* Deprecates `dartHostTestHandler` and `dartTestOut`.
* If you have a use case where this cannot easily be replaced with a mock or
fake of the generated Dart API, please provide details in
https://github.com/flutter/flutter/issues/178322.

## 26.0.5

* [kotlin] Serialize custom enums as `Long` instead of `Int` to avoid `ClassCastException` on decoding.
Expand Down
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.0.5';
const String pigeonVersion = '26.1.0';

/// Read all the content from [stdin] to a String.
String readStdin() {
Expand Down
9 changes: 7 additions & 2 deletions packages/pigeon/lib/src/pigeon_lib.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,10 @@ class ConfigurePigeon {
/// generated host-platform interface.
class HostApi {
/// Parametric constructor for [HostApi].
const HostApi({this.dartHostTestHandler});
const HostApi({
@Deprecated('Mock/fake the generated Dart API instead.')
this.dartHostTestHandler,
});

/// The name of an interface generated for tests. Implement this
/// interface and invoke `[name of this handler].setup` to receive
Expand All @@ -111,6 +114,7 @@ class HostApi {
/// testing.
///
/// Defaults to `null` in which case no handler will be generated.
@Deprecated('Mock/fake the generated Dart API instead.')
final String? dartHostTestHandler;
}

Expand Down Expand Up @@ -238,7 +242,7 @@ class PigeonOptions {
const PigeonOptions({
this.input,
this.dartOut,
this.dartTestOut,
@Deprecated('Mock/fake the generated Dart API instead.') this.dartTestOut,
this.objcHeaderOut,
this.objcSourceOut,
this.objcOptions,
Expand Down Expand Up @@ -269,6 +273,7 @@ class PigeonOptions {
final String? dartOut;

/// Path to the Dart file that will be generated for test support classes.
@Deprecated('Mock/fake the generated Dart API instead.')
final String? dartTestOut;

/// Path to the ".h" Objective-C file will be generated.
Expand Down
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.0.5 # This must match the version in lib/src/generator_tools.dart
version: 26.1.0 # This must match the version in lib/src/generator_tools.dart

environment:
sdk: ^3.7.0
Expand Down