Skip to content

Commit

Permalink
Alert engine upon registering ServiceBinding (flutter#126075)
Browse files Browse the repository at this point in the history
Send a platform message to the engine when the `ServiceBinding` is
registered. Framework side of
flutter/engine#41733

Addresses flutter#126033

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] 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].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#overview
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[test-exempt]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat

---------

Co-authored-by: Greg Spencer <gspencergoog@users.noreply.github.com>
  • Loading branch information
2 people authored and Casey Hillers committed May 24, 2023
1 parent 75d13b0 commit 90ca6f0
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/flutter/lib/src/services/binding.dart
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ mixin ServicesBinding on BindingBase, SchedulerBinding {
SystemChannels.platform.setMethodCallHandler(_handlePlatformMessage);
TextInput.ensureInitialized();
readInitialLifecycleStateFromNativeWindow();
initializationComplete();
}

/// The current [ServicesBinding], if one has been created.
Expand Down Expand Up @@ -415,6 +416,14 @@ mixin ServicesBinding on BindingBase, SchedulerBinding {
void setSystemUiChangeCallback(SystemUiChangeCallback? callback) {
_systemUiChangeCallback = callback;
}

/// Alert the engine that the binding is registered. This instructs the engine to
/// register its top level window handler on Windows. This signals that the app
/// is able to process "System.requestAppExit" signals from the engine.
@protected
Future<void> initializationComplete() async {
await SystemChannels.platform.invokeMethod('System.initializationComplete');
}
}

/// Signature for listening to changes in the [SystemUiMode].
Expand Down
4 changes: 4 additions & 0 deletions packages/flutter/lib/src/services/system_channels.dart
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ abstract final class SystemChannels {
/// * `System.requestAppExit`: The application has requested that it be
/// terminated. See [ServicesBinding.exitApplication].
///
/// * `System.initializationComplete`: Indicate to the engine the
/// initialization of a binding that may, among other tasks, register a
/// handler for application exit attempts.
///
/// Calls to methods that are not implemented on the shell side are ignored
/// (so it is safe to call methods when the relevant plugin might be missing).
static const MethodChannel platform = OptionalMethodChannel(
Expand Down
45 changes: 45 additions & 0 deletions packages/flutter/test/services/binding_lifecycle_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/scheduler.dart';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';

class _TestBinding extends BindingBase with SchedulerBinding, ServicesBinding {
@override
Future<void> initializationComplete() async {
return super.initializationComplete();
}

@override
TestDefaultBinaryMessenger get defaultBinaryMessenger => super.defaultBinaryMessenger as TestDefaultBinaryMessenger;

@override
TestDefaultBinaryMessenger createBinaryMessenger() {
Future<ByteData?> keyboardHandler(ByteData? message) async {
return const StandardMethodCodec().encodeSuccessEnvelope(<int, int>{1:1});
}
return TestDefaultBinaryMessenger(
super.createBinaryMessenger(),
outboundHandlers: <String, MessageHandler>{'flutter/keyboard': keyboardHandler},
);
}
}

void main() {
final _TestBinding binding = _TestBinding();

test('can send message on completion of binding initialization', () async {
bool called = false;
binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.platform, (MethodCall method) async {
if (method.method == 'System.initializationComplete') {
called = true;
}
return null;
});
await binding.initializationComplete();
expect(called, isTrue);
});
}

0 comments on commit 90ca6f0

Please sign in to comment.