test(desktop): cover the desktop shell, player bar and shortcuts

This commit is contained in:
zarzet committed 2026-10-20 14:35:11 +07:00
1 parent 8b90b1b3f8
commit dea5a0c0fb
1 file changed
+440
+440
View File
@@ -0,0 +1,440 @@
import 'dart:async';
import 'package:audio_service/audio_service.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_riverpod/misc.dart' show Override;
import 'package:flutter_test/flutter_test.dart';
import 'package:material_3_expressive/material_3_expressive.dart';
import 'package:mornye/l10n/app_localizations.dart';
import 'package:mornye/providers/music_player_provider.dart';
import 'package:mornye/providers/system_volume_provider.dart';
import 'package:mornye/services/shell_navigation_service.dart';
import 'package:mornye/theme/app_theme.dart';
import 'package:mornye/theme/mornye_theme.dart';
import 'package:mornye/utils/desktop_platform.dart';
import 'package:mornye/widgets/desktop/desktop_commands.dart';
import 'package:mornye/widgets/desktop/desktop_navigation.dart';
import 'package:mornye/widgets/desktop/desktop_player_bar.dart';
import 'package:mornye/widgets/desktop/desktop_shortcuts.dart';
import 'package:mornye/widgets/expressive_navigation_bar.dart';
import 'package:mornye/widgets/mini_player.dart';
import 'package:mornye/widgets/mornye_bottom_bar.dart';
class _FakeController implements MusicPlayerController {
final calls = <String>[];
@override
Future<void> togglePlayPause(bool isPlaying) async =>
calls.add(isPlaying ? 'pause' : 'play');
@override
Future<void> next() async => calls.add('next');
@override
Future<void> previous() async => calls.add('previous');
@override
Future<void> seek(Duration position) async => calls.add('seek');
@override
dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}
const _track = MediaItem(
id: 'track',
title: 'A song',
artist: 'An artist',
duration: Duration(minutes: 3),
);
List<DesktopDestination> _destinations({required bool mornye}) => [
for (final tab in desktopDestinationTabs(mornye: mornye, showStore: true))
DesktopDestination(
tab: tab,
icon: Icons.circle_outlined,
selectedIcon: Icons.circle,
label: tab.name,
badgeCount: tab == ShellTab.library ? 2 : 0,
),
];
void main() {
late _FakeController controller;
late List<double> volumeWrites;
late List<ShellTab> selections;
setUp(() {
debugDesktopPlatformOverride = true;
desktopSidebarCollapsed.value = false;
controller = _FakeController();
volumeWrites = [];
selections = [];
});
tearDown(() {
debugDesktopPlatformOverride = null;
desktopSidebarCollapsed.value = false;
});
List<Override> overrides({MediaItem? item = _track, bool playing = false}) =>
[
currentMediaItemProvider.overrideWithBuild(
(ref, notifier) => Stream.value(item),
),
playbackStateProvider.overrideWith(
(ref) => Stream.value(PlaybackState(playing: playing)),
),
musicPlayerControllerProvider.overrideWithValue(controller),
systemVolumeProvider.overrideWith((ref) => Stream.value(0.5)),
systemVolumeWriterProvider.overrideWithValue((value) async {
volumeWrites.add(value);
}),
];
Future<void> pumpShell(
WidgetTester tester, {
required bool mornye,
required double width,
MediaItem? item = _track,
}) async {
tester.view.physicalSize = Size(width, 800);
tester.view.devicePixelRatio = 1;
addTearDown(tester.view.resetPhysicalSize);
addTearDown(tester.view.resetDevicePixelRatio);
await tester.pumpWidget(
ProviderScope(
overrides: overrides(item: item),
child: MaterialApp(
theme: mornye
? MornyeTheme.build(Brightness.light)
: AppTheme.light(),
localizationsDelegates: AppLocalizations.localizationsDelegates,
supportedLocales: AppLocalizations.supportedLocales,
home: Scaffold(
body: DesktopShellLayout(
destinations: _destinations(mornye: mornye),
selected: ShellTab.home,
onSelected: selections.add,
body: const Center(child: Text('content')),
),
),
),
),
);
await tester.pumpAndSettle();
}
void expectNoTouchNavigation() {
expect(find.byType(NavigationBar), findsNothing);
expect(find.byType(ExpressiveNavigationBar), findsNothing);
expect(find.byType(MornyeBottomBar), findsNothing);
expect(find.byType(MiniPlayer), findsNothing);
}
group('Material shell', () {
testWidgets('collapses the rail at 900 and shows the player bar', (
tester,
) async {
await pumpShell(tester, mornye: false, width: 900);
expect(find.byType(DesktopNavigationRail), findsOneWidget);
expect(tester.getSize(find.byType(M3ENavigationRail)).width, 96);
expect(find.byType(DesktopSidebar), findsNothing);
expectNoTouchNavigation();
expect(find.byType(DesktopPlayerBar), findsOneWidget);
expect(
tester.getSize(find.byType(DesktopPlayerBar)).height,
DesktopPlayerBar.materialHeight,
);
expect(find.text('A song'), findsOneWidget);
expect(find.text('content'), findsOneWidget);
});
testWidgets('expands the rail at 1400 with Settings at the bottom', (
tester,
) async {
await pumpShell(tester, mornye: false, width: 1400);
expect(
tester.getSize(find.byType(M3ENavigationRail)).width,
desktopSidebarWidth,
);
expectNoTouchNavigation();
final home = tester.getTopLeft(find.text('home'));
final settings = tester.getTopLeft(find.text('settings'));
// Settings sits at the bottom of the rail, just above the player bar,
// aligned with the destinations above it.
expect(settings.dy, greaterThan(600));
expect(settings.dx, closeTo(home.dx, 1));
await tester.tap(find.text('settings'));
await tester.tap(find.text('library'));
expect(selections, [ShellTab.settings, ShellTab.library]);
});
testWidgets('player bar names its shortcuts and runs the transport', (
tester,
) async {
await pumpShell(tester, mornye: false, width: 1400);
expect(find.byTooltip('Next track (Ctrl+Right)'), findsOneWidget);
expect(find.byTooltip('Previous track (Ctrl+Left)'), findsOneWidget);
expect(find.byTooltip('Play (Space)'), findsOneWidget);
expect(find.byTooltip('Lyrics (Ctrl+Shift+L)'), findsOneWidget);
expect(find.byTooltip('Up next (Ctrl+Shift+U)'), findsOneWidget);
await tester.tap(find.byTooltip('Next track (Ctrl+Right)'));
await tester.tap(find.byTooltip('Play (Space)'));
expect(controller.calls, ['next', 'play']);
});
testWidgets('idle player bar stays in place with disabled controls', (
tester,
) async {
await pumpShell(tester, mornye: false, width: 900, item: null);
expect(find.byType(DesktopPlayerBar), findsOneWidget);
expect(find.text('Not playing'), findsOneWidget);
await tester.tap(find.byTooltip('Next track (Ctrl+Right)'));
expect(controller.calls, isEmpty);
});
});
group('Mornye shell', () {
for (final width in [900.0, 1400.0]) {
testWidgets('shows the sidebar and player bar at $width', (tester) async {
await pumpShell(tester, mornye: true, width: width);
expect(find.byType(DesktopSidebar), findsOneWidget);
expect(
tester.getSize(find.byType(DesktopSidebar)).width,
desktopSidebarWidth,
);
// The Material rail must not appear in the Mornye style.
expect(find.byType(DesktopNavigationRail), findsNothing);
expect(find.byType(M3ENavigationRail), findsNothing);
expect(find.byType(NavigationRail), findsNothing);
expectNoTouchNavigation();
expect(find.byType(DesktopPlayerBar), findsOneWidget);
expect(
tester.getSize(find.byType(DesktopPlayerBar)).height,
DesktopPlayerBar.mornyeHeight,
);
expect(find.text('A song'), findsOneWidget);
expect(find.byKey(const ValueKey('desktop-sidebar-search')), findsOne);
});
}
testWidgets('sidebar rows select destinations and name shortcuts', (
tester,
) async {
await pumpShell(tester, mornye: true, width: 1400);
expect(find.byTooltip('library (Ctrl+2)'), findsOneWidget);
expect(find.byTooltip('settings (Ctrl+5)'), findsOneWidget);
await tester.tap(find.text('library'));
await tester.tap(find.text('settings'));
expect(selections, [ShellTab.library, ShellTab.settings]);
});
testWidgets('sidebar collapses to icons and back', (tester) async {
await pumpShell(tester, mornye: true, width: 900);
await tester.tap(find.byKey(const ValueKey('desktop-sidebar-toggle')));
await tester.pumpAndSettle();
expect(
tester.getSize(find.byType(DesktopSidebar)).width,
DesktopSidebar.collapsedWidth,
);
expect(find.text('library'), findsNothing);
expect(find.byTooltip('library (Ctrl+2)'), findsOneWidget);
desktopSidebarCollapsed.value = false;
await tester.pumpAndSettle();
expect(
tester.getSize(find.byType(DesktopSidebar)).width,
desktopSidebarWidth,
);
});
});
group('desktop shortcuts', () {
final navigatorKey = GlobalKey<NavigatorState>();
late Object owner;
late List<ShellTab> requested;
setUp(() {
owner = Object();
requested = [];
ShellNavigationService.registerTabSelectionHandler(
owner: owner,
handler: requested.add,
);
});
tearDown(() => ShellNavigationService.unregisterTabSelectionHandler(owner));
Future<void> pumpApp(WidgetTester tester, {bool playing = false}) async {
await tester.pumpWidget(
ProviderScope(
overrides: overrides(playing: playing),
child: MaterialApp(
navigatorKey: navigatorKey,
theme: AppTheme.light(),
localizationsDelegates: AppLocalizations.localizationsDelegates,
supportedLocales: AppLocalizations.supportedLocales,
builder: (context, child) =>
DesktopShortcuts(navigatorKey: navigatorKey, child: child!),
home: const Scaffold(
body: Column(children: [Text('home'), TextField()]),
),
),
),
);
await tester.pumpAndSettle();
}
Future<void> press(
WidgetTester tester,
LogicalKeyboardKey key, {
bool control = false,
}) async {
if (control) await tester.sendKeyDownEvent(LogicalKeyboardKey.control);
await tester.sendKeyEvent(key);
if (control) await tester.sendKeyUpEvent(LogicalKeyboardKey.control);
await tester.pump();
}
testWidgets('control playback and volume', (tester) async {
await pumpApp(tester, playing: true);
await press(tester, LogicalKeyboardKey.space);
await press(tester, LogicalKeyboardKey.arrowRight, control: true);
await press(tester, LogicalKeyboardKey.arrowLeft, control: true);
expect(controller.calls, ['pause', 'next', 'previous']);
await press(tester, LogicalKeyboardKey.arrowUp, control: true);
await press(tester, LogicalKeyboardKey.arrowDown, control: true);
expect(volumeWrites, [closeTo(0.55, 1e-9), closeTo(0.45, 1e-9)]);
});
testWidgets('leave Space and arrows to a focused text field', (
tester,
) async {
await pumpApp(tester);
await tester.tap(find.byType(TextField));
await tester.pump();
await press(tester, LogicalKeyboardKey.space);
await press(tester, LogicalKeyboardKey.arrowRight, control: true);
expect(controller.calls, isEmpty);
// Escape first leaves the field, then Space plays again.
await press(tester, LogicalKeyboardKey.escape);
expect(
FocusManager.instance.primaryFocus?.context
?.findAncestorStateOfType<EditableTextState>(),
isNull,
);
await press(tester, LogicalKeyboardKey.space);
expect(controller.calls, ['play']);
});
testWidgets('select destinations, search and settings', (tester) async {
await pumpApp(tester);
await press(tester, LogicalKeyboardKey.digit2, control: true);
await press(tester, LogicalKeyboardKey.digit1, control: true);
await press(tester, LogicalKeyboardKey.comma, control: true);
await press(tester, LogicalKeyboardKey.keyF, control: true);
expect(requested, [
ShellTab.library,
ShellTab.home,
ShellTab.settings,
ShellTab.search,
]);
});
testWidgets('Escape and Back close the top page', (tester) async {
await pumpApp(tester);
for (final close in [
() => press(tester, LogicalKeyboardKey.escape),
() => press(tester, LogicalKeyboardKey.bracketLeft, control: true),
]) {
unawaited(
navigatorKey.currentState!.push(
MaterialPageRoute<void>(
builder: (_) => const Scaffold(body: Text('page')),
),
),
);
await tester.pumpAndSettle();
expect(find.text('page'), findsOneWidget);
await close();
await tester.pumpAndSettle();
expect(find.text('page'), findsNothing);
expect(find.text('home'), findsOneWidget);
}
});
});
test('shortcut labels follow the platform', () {
final next = desktopCommandShortcut(
DesktopCommand.next,
TargetPlatform.macOS,
)!;
expect(next.meta, isTrue);
expect(desktopShortcutLabel(next, TargetPlatform.macOS), '⌘→');
expect(
desktopShortcutLabel(
desktopCommandShortcut(DesktopCommand.lyrics, TargetPlatform.windows)!,
TargetPlatform.windows,
),
'Ctrl+Shift+L',
);
expect(
desktopShortcutLabel(
desktopCommandShortcut(
DesktopCommand.toggleSidebar,
TargetPlatform.macOS,
)!,
TargetPlatform.macOS,
),
'⌃⌘S',
);
expect(
desktopCommandShortcut(
DesktopCommand.toggleSidebar,
TargetPlatform.linux,
),
isNull,
);
});
testWidgets('desktop mini player drops the touch gestures', (tester) async {
Future<void> pump() => tester.pumpWidget(
ProviderScope(
overrides: overrides(),
child: MaterialApp(
theme: AppTheme.light(),
localizationsDelegates: AppLocalizations.localizationsDelegates,
supportedLocales: AppLocalizations.supportedLocales,
home: const Scaffold(body: Center(child: MiniPlayer())),
),
),
);
await pump();
await tester.pumpAndSettle();
expect(find.byType(Dismissible), findsNothing);
debugDesktopPlatformOverride = false;
await tester.pumpWidget(const SizedBox());
await pump();
await tester.pumpAndSettle();
expect(find.byType(Dismissible), findsOneWidget);
});
}