Make Settings a top-level navigation destination
Show Back only when Settings is reached through a pushed route, and remove duplicate Settings controls where the shell already provides navigation. Update focused widget coverage and document the destination behavior.
This commit is contained in:
@@ -7,15 +7,16 @@ import 'package:pipelines_app/features/settings/settings_screen.dart';
|
||||
import 'package:pipelines_app/ui/adaptive/floating_destination_bar.dart';
|
||||
import 'package:shared_preferences/shared_preferences.dart';
|
||||
|
||||
import '../bar_action.dart';
|
||||
import '../core/transport/pipelines_client_test.dart' show FakeChannel;
|
||||
import '../features/pipelines/fixtures.dart';
|
||||
import 'pipelines_app_test.dart' show webServer;
|
||||
import 'pipelines_replies.dart';
|
||||
|
||||
/// Settings is not a tab: it opens as a page (from the gear in the Pipelines
|
||||
/// bar on a phone, from the rail's foot on a wide window), keeps its
|
||||
/// `/settings` route (and deep link), and closes back to Pipelines. The tab bar keeps Pipelines selected meanwhile.
|
||||
/// Settings is a navigation destination: the phone's bar and the wide rail
|
||||
/// offer it, and the floating tab bar's width (between the list-detail and rail
|
||||
/// widths) keeps the Pipelines bar's gear. Settings reached from a nav control
|
||||
/// has no Back; reached as a pushed page (the gear, the /settings deep link) it
|
||||
/// has Back, which returns to Pipelines.
|
||||
void main() {
|
||||
Future<PlatformRouteInformationProvider> pumpApp(
|
||||
WidgetTester tester, {
|
||||
@@ -50,61 +51,47 @@ void main() {
|
||||
int selectedTab(WidgetTester tester) =>
|
||||
tester.widget<NavigationBar>(find.byType(NavigationBar)).selectedIndex;
|
||||
|
||||
// A phone's Pipelines bar keeps the gear; a wide window's rail offers
|
||||
// Settings instead (see the wide test below).
|
||||
for (final size in [const Size(390, 844)]) {
|
||||
testWidgets('${size.width}: the Pipelines bar gear opens Settings '
|
||||
'as a page and Back returns', (tester) async {
|
||||
final provider = await pumpApp(
|
||||
tester,
|
||||
location: '/pipelines',
|
||||
size: size,
|
||||
);
|
||||
// Four tabs and Settings as the bar's last destination.
|
||||
expect(
|
||||
tester
|
||||
.widget<NavigationBar>(find.byType(NavigationBar))
|
||||
.destinations
|
||||
.map((item) => (item as NavigationDestination).label),
|
||||
['Pipelines', 'Runs', 'Chat', 'Search', 'Settings'],
|
||||
);
|
||||
expect(
|
||||
find.byKey(const ValueKey('shell.destination.settings')),
|
||||
findsOneWidget,
|
||||
);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
testWidgets('390: the bar offers Settings and no gear; Settings from the bar '
|
||||
'has no Back and the Pipelines item leaves it', (tester) async {
|
||||
final provider = await pumpApp(
|
||||
tester,
|
||||
location: '/pipelines',
|
||||
size: const Size(390, 844),
|
||||
);
|
||||
// Four tabs and Settings as the bar's last destination.
|
||||
expect(
|
||||
tester
|
||||
.widget<NavigationBar>(find.byType(NavigationBar))
|
||||
.destinations
|
||||
.map((item) => (item as NavigationDestination).label),
|
||||
['Pipelines', 'Runs', 'Chat', 'Search', 'Settings'],
|
||||
);
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsNothing);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
|
||||
await tapBarAction(
|
||||
tester,
|
||||
find.byKey(const Key('pipelines-open-settings')),
|
||||
'Settings',
|
||||
);
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
expect(provider.value.uri.path, '/settings');
|
||||
expect(find.byType(SettingsScreen), findsOneWidget);
|
||||
expect(find.text('Quick switch animation'), findsOneWidget);
|
||||
await openSettingsSection(tester, 'Connection');
|
||||
expect(find.text('Server URL'), findsOneWidget);
|
||||
// A page of Pipelines: Back in its bar, Settings selected in the bar.
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.search')), findsNothing);
|
||||
expect(selectedTab(tester), 4);
|
||||
expect(tester.takeException(), isNull);
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(provider.value.uri.path, '/settings');
|
||||
expect(find.byType(SettingsScreen), findsOneWidget);
|
||||
expect(find.text('Quick switch animation'), findsOneWidget);
|
||||
await openSettingsSection(tester, 'Connection');
|
||||
expect(find.text('Server URL'), findsOneWidget);
|
||||
// A destination: no Back, and Settings is the selected item of the bar.
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
expect(find.byKey(const ValueKey('shell.search')), findsNothing);
|
||||
expect(selectedTab(tester), 4);
|
||||
expect(tester.takeException(), isNull);
|
||||
|
||||
await tester.tap(find.byKey(const ValueKey('shell.back')));
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
expect(provider.value.uri.path, '/pipelines');
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsWidgets);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
await tester.pumpWidget(const SizedBox.shrink());
|
||||
await tester.pump();
|
||||
});
|
||||
}
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.pipelines')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(provider.value.uri.path, '/pipelines');
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
await tester.pumpWidget(const SizedBox.shrink());
|
||||
await tester.pump();
|
||||
});
|
||||
|
||||
testWidgets('1200: the rail offers Settings at its foot and no gear is '
|
||||
'left in the Pipelines toolbar; Settings is a page and Back returns', (
|
||||
'left in the Pipelines toolbar; Settings from the rail has no Back', (
|
||||
tester,
|
||||
) async {
|
||||
final provider = await pumpApp(
|
||||
@@ -129,21 +116,19 @@ void main() {
|
||||
}
|
||||
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
await tester.pumpAndSettle();
|
||||
expect(provider.value.uri.path, '/settings');
|
||||
expect(find.byType(SettingsScreen), findsOneWidget);
|
||||
// Settings is a page of Pipelines: the rail marks Settings, not a tab.
|
||||
// Settings is a destination: the rail marks Settings, not a tab.
|
||||
expect(
|
||||
tester.widget<NavigationRail>(find.byType(NavigationRail)).selectedIndex,
|
||||
isNull,
|
||||
);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
expect(tester.takeException(), isNull);
|
||||
|
||||
await tester.tap(find.byKey(const ValueKey('shell.back')));
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.pipelines')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(provider.value.uri.path, '/pipelines');
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsNothing);
|
||||
expect(
|
||||
@@ -154,8 +139,8 @@ void main() {
|
||||
await tester.pump();
|
||||
});
|
||||
|
||||
testWidgets('the /settings deep link opens the Settings page and '
|
||||
'the system Back closes it to Pipelines', (tester) async {
|
||||
testWidgets('the /settings deep link opens Settings as a pushed page with '
|
||||
'Back, and the system Back closes it to Pipelines', (tester) async {
|
||||
final provider = await pumpApp(
|
||||
tester,
|
||||
location: '/settings',
|
||||
@@ -168,8 +153,7 @@ void main() {
|
||||
|
||||
final handled = await tester.binding.handlePopRoute();
|
||||
expect(handled, isTrue, reason: 'Back closes the page, not the app');
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
await tester.pumpAndSettle();
|
||||
expect(provider.value.uri.path, '/pipelines');
|
||||
await tester.pumpWidget(const SizedBox.shrink());
|
||||
await tester.pump();
|
||||
|
||||
@@ -7,7 +7,6 @@ import 'package:pipelines_app/application/pipelines_app.dart';
|
||||
import 'package:pipelines_app/core/transport/pipelines_client.dart';
|
||||
import 'package:shared_preferences/shared_preferences.dart';
|
||||
|
||||
import '../bar_action.dart';
|
||||
import '../core/transport/pipelines_client_test.dart' show FakeChannel;
|
||||
import '../features/pipelines/fixtures.dart';
|
||||
import 'pipelines_app_test.dart' show webServer, requestOf;
|
||||
@@ -45,11 +44,7 @@ void main() {
|
||||
);
|
||||
await replyPipelines(tester, channel, PipelineFixture());
|
||||
|
||||
await tapBarAction(
|
||||
tester,
|
||||
find.byKey(const Key('pipelines-open-settings')),
|
||||
'Settings',
|
||||
);
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pump();
|
||||
await tester.pump();
|
||||
expect(provider.value.uri.path, '/settings');
|
||||
|
||||
@@ -11,7 +11,6 @@ import 'package:pipelines_app/features/settings/settings_screen.dart';
|
||||
import 'package:pipelines_app/features/pipelines/screen.dart';
|
||||
import 'package:pipelines_app/shell/destination.dart';
|
||||
|
||||
import '../bar_action.dart';
|
||||
import '../core/transport/pipelines_client_test.dart' show FakeChannel;
|
||||
import '../features/pipelines/fixtures.dart';
|
||||
import 'pipelines_app_test.dart' show webServer;
|
||||
@@ -63,13 +62,10 @@ void main() {
|
||||
final app = await mount(tester);
|
||||
await replyPipelines(tester, app.channel, PipelineFixture());
|
||||
await tester.pumpAndSettle();
|
||||
await tapBarAction(
|
||||
tester,
|
||||
find.byKey(const Key('pipelines-open-settings')),
|
||||
'Settings',
|
||||
);
|
||||
await tester.pumpAndSettle();
|
||||
await tab(tester, 'settings');
|
||||
expect(app.provider.value.uri.path, '/settings');
|
||||
// A destination opened from its nav item: no Back.
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
final settingsState = tester.state(find.byType(SettingsScreen));
|
||||
await tab(tester, 'chat');
|
||||
expect(app.provider.value.uri.path, '/chat');
|
||||
@@ -77,19 +73,12 @@ void main() {
|
||||
expect(app.provider.value.uri.path, '/settings');
|
||||
expect(tester.state(find.byType(SettingsScreen)), same(settingsState));
|
||||
await tab(tester, 'pipelines');
|
||||
expect(
|
||||
app.provider.value.uri.path,
|
||||
'/settings',
|
||||
reason: 'tab retap is not Back',
|
||||
);
|
||||
await tester.tap(find.byKey(const ValueKey('shell.back')));
|
||||
await tester.pump();
|
||||
await tester.pump(const Duration(milliseconds: 500));
|
||||
expect(
|
||||
app.provider.value.uri.path,
|
||||
'/pipelines',
|
||||
reason: 'explicit Back still exits Settings',
|
||||
reason: 'the Pipelines item leaves Settings for its list',
|
||||
);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
expect(tester.takeException(), isNull);
|
||||
});
|
||||
testWidgets(
|
||||
@@ -191,8 +180,8 @@ void main() {
|
||||
await tab(tester, 'pipelines');
|
||||
expect(app.provider.value.uri.path, '/settings');
|
||||
expect(tester.widget<PipelinesScreen>(hidden).initialPipelineId, 1);
|
||||
await tester.tap(find.byKey(const Key('shell.back')));
|
||||
await tester.pumpAndSettle();
|
||||
// Settings has no Back; the Pipelines item returns to the open pipeline.
|
||||
await tab(tester, 'pipelines');
|
||||
expect(app.provider.value.uri.path, '/pipelines/1');
|
||||
expect(tester.state(find.byType(PipelinesScreen)), same(pipelineState));
|
||||
expect(
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_test/flutter_test.dart';
|
||||
import 'package:pipelines_app/features/pipelines/screen.dart';
|
||||
import 'package:pipelines_app/shell/adaptive_shell.dart';
|
||||
import 'package:pipelines_app/shell/destination.dart';
|
||||
import 'package:pipelines_app/ui/adaptive/floating_destination_bar.dart';
|
||||
|
||||
import 'fixtures.dart';
|
||||
import 'test_helpers.dart';
|
||||
|
||||
/// The Pipelines bar's Settings gear inside the shell: it is kept only where the
|
||||
/// floating tab bar is the shell's sole navigation (between the list-detail and
|
||||
/// rail widths), because only there Settings has no nav entry. Elsewhere the
|
||||
/// phone's bar or the rail offers Settings, so the bar has no gear.
|
||||
void main() {
|
||||
// Returns how many times the gear opened Settings.
|
||||
Future<int Function()> pumpInShell(WidgetTester tester, Size size) async {
|
||||
tester.view.physicalSize = size;
|
||||
tester.view.devicePixelRatio = 1;
|
||||
addTearDown(tester.view.resetPhysicalSize);
|
||||
addTearDown(tester.view.resetDevicePixelRatio);
|
||||
var opened = 0;
|
||||
final gateway = gatewayFor(PipelineFixture());
|
||||
await tester.pumpWidget(
|
||||
MaterialApp(
|
||||
home: AdaptiveShell(
|
||||
destination: AppDestination.pipelines,
|
||||
destinationBodies: {
|
||||
// The app's Pipelines destination embeds the screen in the shell.
|
||||
AppDestination.pipelines: (_) => PipelinesScreen(
|
||||
gateway: gateway,
|
||||
embedded: true,
|
||||
onOpenSettings: () => opened++,
|
||||
),
|
||||
},
|
||||
),
|
||||
),
|
||||
);
|
||||
await tester.pumpAndSettle();
|
||||
return () => opened;
|
||||
}
|
||||
|
||||
testWidgets('a phone bar offers Settings, so the Pipelines bar has no gear', (
|
||||
tester,
|
||||
) async {
|
||||
await pumpInShell(tester, const Size(390, 844));
|
||||
expect(find.byType(NavigationBar), findsOneWidget);
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsNothing);
|
||||
});
|
||||
|
||||
testWidgets('a rail offers Settings, so the Pipelines bar has no gear', (
|
||||
tester,
|
||||
) async {
|
||||
await pumpInShell(tester, const Size(1200, 800));
|
||||
expect(find.byType(NavigationRail), findsOneWidget);
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsNothing);
|
||||
});
|
||||
|
||||
testWidgets('the floating tab bar lists tabs only, so the Pipelines bar '
|
||||
'keeps the gear and it opens Settings', (tester) async {
|
||||
final opened = await pumpInShell(tester, const Size(650, 844));
|
||||
expect(find.byType(FloatingDestinationBar), findsOneWidget);
|
||||
expect(find.byKey(const Key('pipelines-open-settings')), findsOneWidget);
|
||||
// At this width the bar folds the gear into its More menu, so it is not
|
||||
// hit-testable here; its handler is what opens Settings.
|
||||
final gear = tester.widget<IconButton>(
|
||||
find.byKey(const Key('pipelines-open-settings')),
|
||||
);
|
||||
expect(gear.tooltip, 'Settings');
|
||||
gear.onPressed!();
|
||||
expect(opened(), 1);
|
||||
});
|
||||
}
|
||||
@@ -90,8 +90,8 @@ void main() {
|
||||
expect(find.text('runs body'), findsOneWidget);
|
||||
});
|
||||
|
||||
testWidgets('Settings opens from the rail foot as a page and no tab is '
|
||||
'selected meanwhile', (tester) async {
|
||||
testWidgets('Settings opens from the rail foot as a destination with no '
|
||||
'Back and no tab is selected meanwhile', (tester) async {
|
||||
final semantics = tester.ensureSemantics();
|
||||
await pumpShell(tester, width: 1000);
|
||||
|
||||
@@ -106,8 +106,10 @@ void main() {
|
||||
.isSelected,
|
||||
Tristate.isTrue,
|
||||
);
|
||||
// The page's own Back returns to Pipelines, the tab it belongs to.
|
||||
await tester.tap(find.byKey(const ValueKey('shell.back')));
|
||||
// Opened from its rail item, Settings is not a page: no Back.
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
// The Pipelines item leaves it for the Pipelines tab.
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.pipelines')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(tester.widget<NavigationRail>(rail()).selectedIndex, 0);
|
||||
semantics.dispose();
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_test/flutter_test.dart';
|
||||
import 'package:pipelines_app/shell/adaptive_shell.dart';
|
||||
import 'package:pipelines_app/shell/destination.dart';
|
||||
|
||||
/// Settings' Back: a destination reached from a shell control has none; a page
|
||||
/// pushed by a route (a first load or a route change, such as a deep link or
|
||||
/// the Pipelines gear) has one that returns to Pipelines.
|
||||
void main() {
|
||||
AdaptiveShell shellAt(AppDestination destination) => AdaptiveShell(
|
||||
destination: destination,
|
||||
destinationBodies: {
|
||||
for (final value in AppDestination.values)
|
||||
value: (_) => Text('${value.name} body'),
|
||||
},
|
||||
);
|
||||
|
||||
Future<void> pumpAt(
|
||||
WidgetTester tester,
|
||||
AppDestination destination, {
|
||||
double width = 1000,
|
||||
}) async {
|
||||
tester.view.physicalSize = Size(width, 800);
|
||||
tester.view.devicePixelRatio = 1;
|
||||
addTearDown(tester.view.resetPhysicalSize);
|
||||
addTearDown(tester.view.resetDevicePixelRatio);
|
||||
await tester.pumpWidget(MaterialApp(home: shellAt(destination)));
|
||||
await tester.pumpAndSettle();
|
||||
}
|
||||
|
||||
testWidgets('Settings selected from a rail item has no Back', (tester) async {
|
||||
await pumpAt(tester, AppDestination.pipelines);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.text('settings body'), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
});
|
||||
|
||||
testWidgets('Settings selected from a phone bar item has no Back', (
|
||||
tester,
|
||||
) async {
|
||||
await pumpAt(tester, AppDestination.pipelines, width: 390);
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.text('settings body'), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
});
|
||||
|
||||
testWidgets('Settings pushed by a route change has Back, which returns to '
|
||||
'Pipelines', (tester) async {
|
||||
await pumpAt(tester, AppDestination.pipelines);
|
||||
// The route moves to Settings (as a gear or a deep link does).
|
||||
await tester.pumpWidget(
|
||||
MaterialApp(home: shellAt(AppDestination.settings)),
|
||||
);
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.text('settings body'), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsOneWidget);
|
||||
|
||||
await tester.tap(find.byKey(const ValueKey('shell.back')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.text('pipelines body'), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
});
|
||||
|
||||
testWidgets('a first load on Settings (a deep link) has Back', (
|
||||
tester,
|
||||
) async {
|
||||
await pumpAt(tester, AppDestination.settings);
|
||||
expect(find.text('settings body'), findsOneWidget);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsOneWidget);
|
||||
});
|
||||
|
||||
testWidgets('a nav selection after a pushed Settings clears its Back', (
|
||||
tester,
|
||||
) async {
|
||||
await pumpAt(tester, AppDestination.settings);
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsOneWidget);
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.chat')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.text('chat body'), findsOneWidget);
|
||||
|
||||
// Settings opened again from its rail item is a destination, not a page.
|
||||
await tester.tap(find.byKey(const ValueKey('shell.destination.settings')));
|
||||
await tester.pumpAndSettle();
|
||||
expect(find.byKey(const ValueKey('shell.back')), findsNothing);
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user