flutteractionsbot 0aafd14efa
[CP-beta]Send statusBarTouch events via dedicated messages (#181670)
This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request)
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.

### Issue Link:
What is the link to the issue this cherry-pick is addressing?

https://github.com/flutter/flutter/issues/177992
https://github.com/flutter/flutter/issues/175606

### Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)?
Does it impact development (ex. flutter doctor crashes when Android Studio is installed),
or the shipping of production apps (the app crashes on launch).
This information is for domain experts and release engineers to understand the consequences of saying yes or no to the cherry pick.

The issues listed above impact app users. For instance #177992 prevents the user from interacting with hamburger menus on iPadOS 26.1+ for context, this probably has always been an issue but on iPadOS 26.1 the height of the status bar became taller so it gets in the way of the hamburger menu.

### Changelog Description:
Explain this cherry pick:
* In one line that is accessible to most Flutter developers.
* That describes the state prior to the fix.
* That includes which platforms are impacted.
See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples.

[flutter/177992] on iPadOS 26.1, tapping on the status bar dismisses the current modal route. 

### Workaround:
Is there a workaround for this issue?

Yes. There is a relatively reliable workaround described here: https://github.com/flutter/flutter/issues/175606#issuecomment-3576240885

### Risk:
What is the risk level of this cherry-pick?

  - [-] Low

### Test Coverage:
Are you confident that your fix is well-tested by automated tests?

  - [-] Yes

### Validation Steps:
What are the steps to validate that this fix works?

Following the repro steps in #177992. I've tried the fix myself on master following the steps outlined in the issue and couldn't reproduce the issue.
2026-02-03 18:57:25 +00:00

657 lines
21 KiB
Dart

// 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 'dart:ui';
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';
class MemoryPressureObserver with WidgetsBindingObserver {
bool sawMemoryPressure = false;
@override
void didHaveMemoryPressure() {
sawMemoryPressure = true;
}
}
class AppLifecycleStateObserver with WidgetsBindingObserver {
List<AppLifecycleState> accumulatedStates = <AppLifecycleState>[];
@override
void didChangeAppLifecycleState(AppLifecycleState state) {
accumulatedStates.add(state);
}
}
class ViewFocusObserver with WidgetsBindingObserver {
List<ViewFocusEvent> accumulatedEvents = <ViewFocusEvent>[];
@override
void didChangeViewFocus(ViewFocusEvent state) {
accumulatedEvents.add(state);
}
}
class PushRouteObserver with WidgetsBindingObserver {
late String pushedRoute;
@override
Future<bool> didPushRoute(String route) async {
pushedRoute = route;
return true;
}
}
class PushRouteInformationObserver with WidgetsBindingObserver {
late RouteInformation pushedRouteInformation;
@override
Future<bool> didPushRouteInformation(RouteInformation routeInformation) async {
pushedRouteInformation = routeInformation;
return true;
}
}
// Implements to make sure all methods get coverage.
class RentrantObserver implements WidgetsBindingObserver {
RentrantObserver() {
WidgetsBinding.instance.addObserver(this);
}
bool active = true;
int removeSelf() {
active = false;
var count = 0;
while (WidgetsBinding.instance.removeObserver(this)) {
count += 1;
}
return count;
}
@override
void didChangeAccessibilityFeatures() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangeAppLifecycleState(AppLifecycleState state) {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangeViewFocus(ViewFocusEvent event) {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangeLocales(List<Locale>? locales) {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangeMetrics() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangePlatformBrightness() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didChangeTextScaleFactor() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
void didHaveMemoryPressure() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
@override
Future<bool> didPopRoute() {
assert(active);
WidgetsBinding.instance.addObserver(this);
return Future<bool>.value(true);
}
@override
bool handleStartBackGesture(PredictiveBackEvent backEvent) {
assert(active);
WidgetsBinding.instance.addObserver(this);
return true;
}
@override
bool handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) {
assert(active);
WidgetsBinding.instance.addObserver(this);
return true;
}
@override
bool handleCommitBackGesture() {
assert(active);
WidgetsBinding.instance.addObserver(this);
return true;
}
@override
bool handleCancelBackGesture() {
assert(active);
WidgetsBinding.instance.addObserver(this);
return true;
}
@override
Future<bool> didPushRoute(String route) {
assert(active);
WidgetsBinding.instance.addObserver(this);
return Future<bool>.value(true);
}
@override
Future<bool> didPushRouteInformation(RouteInformation routeInformation) {
assert(active);
WidgetsBinding.instance.addObserver(this);
return Future<bool>.value(true);
}
@override
Future<AppExitResponse> didRequestAppExit() {
assert(active);
WidgetsBinding.instance.addObserver(this);
return Future<AppExitResponse>.value(AppExitResponse.exit);
}
@override
void handleStatusBarTap() {
assert(active);
WidgetsBinding.instance.addObserver(this);
}
}
void main() {
Future<void> setAppLifeCycleState(AppLifecycleState state) async {
final ByteData? message = const StringCodec().encodeMessage(state.toString());
await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
'flutter/lifecycle',
message,
(_) {},
);
}
testWidgets('Rentrant observer callbacks do not result in exceptions', (
WidgetTester tester,
) async {
final observer = RentrantObserver();
WidgetsBinding.instance.handleAccessibilityFeaturesChanged();
WidgetsBinding.instance.handleAppLifecycleStateChanged(AppLifecycleState.resumed);
WidgetsBinding.instance.handleLocaleChanged();
WidgetsBinding.instance.handleMetricsChanged();
WidgetsBinding.instance.handlePlatformBrightnessChanged();
WidgetsBinding.instance.handleTextScaleFactorChanged();
WidgetsBinding.instance.handleMemoryPressure();
WidgetsBinding.instance.handlePopRoute();
WidgetsBinding.instance.handlePushRoute('/');
WidgetsBinding.instance.handleRequestAppExit();
WidgetsBinding.instance.handleViewFocusChanged(
const ViewFocusEvent(
viewId: 0,
state: ViewFocusState.focused,
direction: ViewFocusDirection.forward,
),
);
await tester.idle();
expect(observer.removeSelf(), greaterThan(1));
expect(observer.removeSelf(), 0);
});
testWidgets('didHaveMemoryPressure callback', (WidgetTester tester) async {
final observer = MemoryPressureObserver();
WidgetsBinding.instance.addObserver(observer);
final ByteData message = const JSONMessageCodec().encodeMessage(<String, dynamic>{
'type': 'memoryPressure',
})!;
await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/system',
message,
(_) {},
);
expect(observer.sawMemoryPressure, true);
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('handleLifecycleStateChanged callback', (WidgetTester tester) async {
final observer = AppLifecycleStateObserver();
WidgetsBinding.instance.addObserver(observer);
await setAppLifeCycleState(AppLifecycleState.paused);
expect(observer.accumulatedStates, <AppLifecycleState>[AppLifecycleState.paused]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.resumed);
expect(observer.accumulatedStates, <AppLifecycleState>[
AppLifecycleState.hidden,
AppLifecycleState.inactive,
AppLifecycleState.resumed,
]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.paused);
expect(observer.accumulatedStates, <AppLifecycleState>[
AppLifecycleState.inactive,
AppLifecycleState.hidden,
AppLifecycleState.paused,
]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.inactive);
expect(observer.accumulatedStates, <AppLifecycleState>[
AppLifecycleState.hidden,
AppLifecycleState.inactive,
]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.hidden);
expect(observer.accumulatedStates, <AppLifecycleState>[AppLifecycleState.hidden]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.paused);
expect(observer.accumulatedStates, <AppLifecycleState>[AppLifecycleState.paused]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.detached);
expect(observer.accumulatedStates, <AppLifecycleState>[AppLifecycleState.detached]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.resumed);
expect(observer.accumulatedStates, <AppLifecycleState>[AppLifecycleState.resumed]);
observer.accumulatedStates.clear();
await setAppLifeCycleState(AppLifecycleState.detached);
expect(observer.accumulatedStates, <AppLifecycleState>[
AppLifecycleState.inactive,
AppLifecycleState.hidden,
AppLifecycleState.paused,
AppLifecycleState.detached,
]);
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('handleViewFocusChanged callback', (WidgetTester tester) async {
final observer = ViewFocusObserver();
WidgetsBinding.instance.addObserver(observer);
const expectedEvent = ViewFocusEvent(
viewId: 0,
state: ViewFocusState.focused,
direction: ViewFocusDirection.forward,
);
PlatformDispatcher.instance.onViewFocusChange!(expectedEvent);
expect(observer.accumulatedEvents, <ViewFocusEvent>[expectedEvent]);
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRoute callback', (WidgetTester tester) async {
final observer = PushRouteObserver();
WidgetsBinding.instance.addObserver(observer);
const testRouteName = 'testRouteName';
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRoute', testRouteName),
);
final ByteData result = (await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
))!;
final decodedResult = const JSONMethodCodec().decodeEnvelope(result) as bool;
expect(decodedResult, true);
expect(observer.pushedRoute, testRouteName);
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRouteInformation calls didPushRoute by default', (WidgetTester tester) async {
final observer = PushRouteObserver();
WidgetsBinding.instance.addObserver(observer);
const testRouteInformation = <String, dynamic>{
'location': 'testRouteName',
'state': 'state',
'restorationData': <dynamic, dynamic>{'test': 'config'},
};
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRouteInformation', testRouteInformation),
);
final ByteData result = (await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
))!;
final decodedResult = const JSONMethodCodec().decodeEnvelope(result) as bool;
expect(decodedResult, true);
expect(observer.pushedRoute, 'testRouteName');
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRouteInformation calls didPushRoute correctly when handling url', (
WidgetTester tester,
) async {
final observer = PushRouteObserver();
WidgetsBinding.instance.addObserver(observer);
// A url without any path.
var testRouteInformation = const <String, dynamic>{
'location': 'http://hostname',
'state': 'state',
'restorationData': <dynamic, dynamic>{'test': 'config'},
};
ByteData message = const JSONMethodCodec().encodeMethodCall(
MethodCall('pushRouteInformation', testRouteInformation),
);
await ServicesBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
);
expect(observer.pushedRoute, '/');
// A complex url.
testRouteInformation = const <String, dynamic>{
'location': 'http://hostname/abc?def=123&def=456#789',
'state': 'state',
'restorationData': <dynamic, dynamic>{'test': 'config'},
};
message = const JSONMethodCodec().encodeMethodCall(
MethodCall('pushRouteInformation', testRouteInformation),
);
await ServicesBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
);
expect(observer.pushedRoute, '/abc?def=123&def=456#789');
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRouteInformation callback', (WidgetTester tester) async {
final observer = PushRouteInformationObserver();
WidgetsBinding.instance.addObserver(observer);
const testRouteInformation = <String, dynamic>{'location': 'testRouteName', 'state': 'state'};
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRouteInformation', testRouteInformation),
);
await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
);
expect(observer.pushedRouteInformation.uri.toString(), 'testRouteName');
expect(observer.pushedRouteInformation.state, 'state');
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRouteInformation callback can handle url', (WidgetTester tester) async {
final observer = PushRouteInformationObserver();
WidgetsBinding.instance.addObserver(observer);
const testRouteInformation = <String, dynamic>{
'location': 'http://hostname/abc?def=123&def=456#789',
'state': 'state',
};
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRouteInformation', testRouteInformation),
);
await ServicesBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
);
expect(observer.pushedRouteInformation.location, '/abc?def=123&def=456#789');
expect(
observer.pushedRouteInformation.uri.toString(),
'http://hostname/abc?def=123&def=456#789',
);
expect(observer.pushedRouteInformation.state, 'state');
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('didPushRouteInformation callback with null state', (WidgetTester tester) async {
final observer = PushRouteInformationObserver();
WidgetsBinding.instance.addObserver(observer);
const testRouteInformation = <String, dynamic>{'location': 'testRouteName', 'state': null};
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRouteInformation', testRouteInformation),
);
await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
);
expect(observer.pushedRouteInformation.uri.toString(), 'testRouteName');
expect(observer.pushedRouteInformation.state, null);
WidgetsBinding.instance.removeObserver(observer);
});
testWidgets('pushRouteInformation not handled by observer returns false', (
WidgetTester tester,
) async {
const testRouteInformation = <String, dynamic>{'location': 'testRouteName', 'state': null};
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRouteInformation', testRouteInformation),
);
final ByteData result = (await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
))!;
final decodedResult = const JSONMethodCodec().decodeEnvelope(result) as bool;
expect(decodedResult, false);
});
testWidgets('pushRoute not handled by observer returns false', (WidgetTester tester) async {
const testRoute = 'testRouteName';
final ByteData message = const JSONMethodCodec().encodeMethodCall(
const MethodCall('pushRoute', testRoute),
);
final ByteData result = (await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
))!;
final decodedResult = const JSONMethodCodec().decodeEnvelope(result) as bool;
expect(decodedResult, false);
});
testWidgets('popRoute not handled by observer returns false', (WidgetTester tester) async {
final ByteData message = const JSONMethodCodec().encodeMethodCall(const MethodCall('popRoute'));
final ByteData result = (await tester.binding.defaultBinaryMessenger.handlePlatformMessage(
'flutter/navigation',
message,
(_) {},
))!;
final decodedResult = const JSONMethodCodec().decodeEnvelope(result) as bool;
expect(decodedResult, false);
});
testWidgets('Application lifecycle affects frame scheduling', (WidgetTester tester) async {
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.paused);
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.resumed);
expect(tester.binding.hasScheduledFrame, isTrue);
await tester.pump();
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.inactive);
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.paused);
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.detached);
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.inactive);
expect(tester.binding.hasScheduledFrame, isTrue);
await tester.pump();
expect(tester.binding.hasScheduledFrame, isFalse);
await setAppLifeCycleState(AppLifecycleState.paused);
expect(tester.binding.hasScheduledFrame, isFalse);
tester.binding.scheduleFrame();
expect(tester.binding.hasScheduledFrame, isFalse);
tester.binding.scheduleForcedFrame();
expect(tester.binding.hasScheduledFrame, isTrue);
await tester.pump();
var frameCount = 0;
tester.binding.addPostFrameCallback((Duration duration) {
frameCount += 1;
});
expect(tester.binding.hasScheduledFrame, isFalse);
await tester.pump(const Duration(milliseconds: 1));
expect(tester.binding.hasScheduledFrame, isFalse);
expect(frameCount, 0);
tester.binding.scheduleWarmUpFrame(); // this actually tests flutter_test's implementation
expect(tester.binding.hasScheduledFrame, isFalse);
expect(frameCount, 1);
// Get the tester back to a resumed state for subsequent tests.
await setAppLifeCycleState(AppLifecycleState.resumed);
expect(tester.binding.hasScheduledFrame, isTrue);
await tester.pump();
});
testWidgets('resetInternalState resets lifecycleState and framesEnabled to initial state', (
WidgetTester tester,
) async {
// Initial state
expect(tester.binding.lifecycleState, isNull);
expect(tester.binding.framesEnabled, isTrue);
tester.binding.handleAppLifecycleStateChanged(AppLifecycleState.paused);
expect(tester.binding.lifecycleState, AppLifecycleState.paused);
expect(tester.binding.framesEnabled, isFalse);
tester.binding.resetInternalState();
expect(tester.binding.lifecycleState, isNull);
expect(tester.binding.framesEnabled, isTrue);
});
testWidgets('scheduleFrameCallback error control test', (WidgetTester tester) async {
late FlutterError error;
try {
tester.binding.scheduleFrameCallback((Duration _) {}, rescheduling: true);
} on FlutterError catch (e) {
error = e;
}
expect(error, isNotNull);
expect(error.diagnostics.length, 3);
expect(error.diagnostics.last.level, DiagnosticLevel.hint);
expect(
error.diagnostics.last.toStringDeep(),
equalsIgnoringHashCodes(
'If this is the initial registration of the callback, or if the\n'
'callback is asynchronous, then do not use the "rescheduling"\n'
'argument.\n',
),
);
expect(
error.toStringDeep(),
'FlutterError\n'
' scheduleFrameCallback called with rescheduling true, but no\n'
' callback is in scope.\n'
' The "rescheduling" argument should only be set to true if the\n'
' callback is being reregistered from within the callback itself,\n'
' and only then if the callback itself is entirely synchronous.\n'
' If this is the initial registration of the callback, or if the\n'
' callback is asynchronous, then do not use the "rescheduling"\n'
' argument.\n',
);
});
testWidgets('defaultStackFilter elides framework Element mounting stacks', (
WidgetTester tester,
) async {
final FlutterExceptionHandler? oldHandler = FlutterError.onError;
late FlutterErrorDetails errorDetails;
FlutterError.onError = (FlutterErrorDetails details) {
errorDetails = details;
};
await tester.pumpWidget(
Directionality(
textDirection: TextDirection.ltr,
child: TestStatefulWidget(
child: Builder(
builder: (BuildContext context) {
return Opacity(
opacity: .5,
child: Builder(
builder: (BuildContext context) {
assert(false);
return const Text('');
},
),
);
},
),
),
),
);
FlutterError.onError = oldHandler;
expect(errorDetails.exception, isAssertionError);
const toMatch = '... Normal element mounting (';
expect(toMatch.allMatches(errorDetails.toString()).length, 1);
}, skip: kIsWeb); // https://github.com/flutter/flutter/issues/87875
}
class TestStatefulWidget extends StatefulWidget {
const TestStatefulWidget({required this.child, super.key});
final Widget child;
@override
State<StatefulWidget> createState() => TestStatefulWidgetState();
}
class TestStatefulWidgetState extends State<TestStatefulWidget> {
@override
Widget build(BuildContext context) {
return widget.child;
}
}