import 'package:flutter/material.dart'; import 'package:flutter/services.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:pipelines_app/core/api_gateway.dart'; import 'package:pipelines_app/features/search/search_screen.dart'; import 'package:pipelines_app/features/search/ui/search_bar_controls.dart'; import 'package:pipelines_app/features/settings/keyboard_shortcuts_help.dart'; import 'package:pipelines_app/shell/adaptive_shell.dart'; import 'package:pipelines_app/shell/destination.dart'; import 'package:pipelines_app/ui/input/keyboard_owner.dart'; class _Gateway implements ApiGateway { @override Stream get frames => const Stream.empty(); @override Future call(String type, [JsonMap fields = const {}]) async => { 'search_results': {'results': [], 'truncated': false}, }; } /// Presses [key] with [modifiers] held, as one chord. Future _chord( WidgetTester tester, List modifiers, LogicalKeyboardKey key, ) async { for (final modifier in modifiers) { await tester.sendKeyDownEvent(modifier); } await tester.sendKeyEvent(key); for (final modifier in modifiers.reversed) { await tester.sendKeyUpEvent(modifier); } await tester.pumpAndSettle(); } /// Ctrl+? as a US keyboard types it: Shift with the slash key. Future _cheatsheetChord( WidgetTester tester, LogicalKeyboardKey primary, ) => _chord(tester, [ primary, LogicalKeyboardKey.shiftLeft, ], LogicalKeyboardKey.slash); Future _pumpShell( WidgetTester tester, { required Map bodies, AppDestination destination = AppDestination.pipelines, TargetPlatform? platform, }) async { await tester.pumpWidget( MaterialApp( theme: platform == null ? null : ThemeData(platform: platform), home: AdaptiveShell(destination: destination, destinationBodies: bodies), ), ); await tester.pumpAndSettle(); } void main() { for (final platform in [TargetPlatform.macOS, TargetPlatform.windows]) { final primary = platform == TargetPlatform.macOS ? LogicalKeyboardKey.metaLeft : LogicalKeyboardKey.controlLeft; testWidgets( 'Ctrl+? opens the cheatsheet from another destination on $platform', (tester) async { await _pumpShell( tester, destination: AppDestination.runs, bodies: { AppDestination.runs: (_) => const Text('runs body'), AppDestination.pipelines: (_) => const Text('pipelines body'), }, ); expect(find.byType(KeyboardShortcutsHelp), findsNothing); await _cheatsheetChord(tester, primary); expect(find.byType(KeyboardShortcutsHelp), findsOneWidget); expect(find.text('Keyboard shortcuts'), findsOneWidget); }, variant: TargetPlatformVariant.only(platform), ); testWidgets( 'Ctrl+? opens the cheatsheet from a focused composer on $platform', (tester) async { final composer = TextEditingController(text: 'draft'); final focus = FocusNode(); addTearDown(composer.dispose); addTearDown(focus.dispose); await _pumpShell( tester, destination: AppDestination.chat, platform: platform, bodies: { AppDestination.chat: (_) => TextField(controller: composer, focusNode: focus), }, ); focus.requestFocus(); await tester.pump(); await _cheatsheetChord(tester, primary); expect(find.byType(KeyboardShortcutsHelp), findsOneWidget); expect(composer.text, 'draft'); }, variant: TargetPlatformVariant.only(platform), ); testWidgets( 'Ctrl+/ still opens Search, not the cheatsheet, on $platform', (tester) async { final composer = TextEditingController(); final focus = FocusNode(); addTearDown(composer.dispose); addTearDown(focus.dispose); await _pumpShell( tester, destination: AppDestination.chat, platform: platform, bodies: { AppDestination.chat: (_) => TextField(controller: composer, focusNode: focus), AppDestination.search: (_) => SearchScreen( gateway: _Gateway(), onOpen: (_) {}, embedded: true, ), }, ); await _chord(tester, [primary], LogicalKeyboardKey.slash); expect(find.byType(KeyboardShortcutsHelp), findsNothing); final search = tester.widget(find.byKey(searchFieldKey)); expect(search.focusNode!.hasFocus, isTrue); }, variant: TargetPlatformVariant.only(platform), ); testWidgets( 'Ctrl+Shift+/ opens the cheatsheet and not Search on $platform', (tester) async { await _pumpShell( tester, destination: AppDestination.chat, platform: platform, bodies: { AppDestination.chat: (_) => const Text('chat body'), AppDestination.search: (_) => SearchScreen( gateway: _Gateway(), onOpen: (_) {}, embedded: true, ), }, ); await _cheatsheetChord(tester, primary); expect(find.byType(KeyboardShortcutsHelp), findsOneWidget); expect(find.byKey(searchFieldKey), findsNothing); }, variant: TargetPlatformVariant.only(platform), ); } testWidgets('Ctrl+? is ignored while a terminal has the keyboard', ( tester, ) async { final seen = []; final terminal = FocusNode(); addTearDown(terminal.dispose); await _pumpShell( tester, destination: AppDestination.chat, bodies: { AppDestination.chat: (_) => TypingSurface( child: Focus( focusNode: terminal, autofocus: true, onKeyEvent: (node, event) { if (event is KeyDownEvent) seen.add(event.logicalKey); return KeyEventResult.ignored; }, child: const SizedBox.expand(), ), ), }, ); await _cheatsheetChord(tester, LogicalKeyboardKey.controlLeft); expect(find.byType(KeyboardShortcutsHelp), findsNothing); expect(seen, contains(LogicalKeyboardKey.slash)); }); testWidgets('Escape and a second Ctrl+? close the cheatsheet', ( tester, ) async { await _pumpShell( tester, destination: AppDestination.chat, bodies: {AppDestination.chat: (_) => const Text('chat body')}, ); await _cheatsheetChord(tester, LogicalKeyboardKey.controlLeft); expect(find.byType(KeyboardShortcutsHelp), findsOneWidget); await tester.sendKeyEvent(LogicalKeyboardKey.escape); await tester.pumpAndSettle(); expect(find.byType(KeyboardShortcutsHelp), findsNothing); await _cheatsheetChord(tester, LogicalKeyboardKey.controlLeft); expect(find.byType(KeyboardShortcutsHelp), findsOneWidget); await _cheatsheetChord(tester, LogicalKeyboardKey.controlLeft); expect(find.byType(KeyboardShortcutsHelp), findsNothing); }); }