Skip to content

Create Hot Restart over websocket test #173852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+288 −122
Open

Create Hot Restart over websocket test #173852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb12c41
implemented hot restart over websocket test
jyameo Aug 15, 2025
3ffc6b0
Merge branch 'main' into hot-restart-test
jyameo Aug 15, 2025
e881a55
addressed gemini code assist comment
jyameo Aug 15, 2025
d4fd191
Merge branch 'master' into hot-restart-test
srujzs Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 13 additions & 122 deletions packages/flutter_tools/test/integration.shard/hot_reload_websocket_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@
library;

import 'dart:async';
import 'dart:io' as io;

import 'package:file/file.dart';
import 'package:flutter_tools/src/web/chrome.dart';
import 'package:flutter_tools/src/web/web_device.dart' show WebServerDevice;

import '../src/common.dart';
import 'test_data/hot_reload_project.dart';
import 'test_data/websocket_dwds_test_common.dart';
import 'test_driver.dart';
import 'test_utils.dart';
import 'transition_test_utils.dart';
Expand All @@ -26,8 +24,6 @@ void testAll({List<String> additionalCommandArgs = const <String>[]}) {
group('WebSocket DWDS connection'
'${additionalCommandArgs.isEmpty ? '' : ' with args: $additionalCommandArgs'}', () {
// Test configuration constants
const debugUrlTimeout = Duration(seconds: 20);
const appStartTimeout = Duration(seconds: 15);
const hotReloadTimeout = Duration(seconds: 10);

late Directory tempDir;
Expand All @@ -48,62 +44,17 @@ void testAll({List<String> additionalCommandArgs = const <String>[]}) {
testWithoutContext(
'hot reload with headless Chrome WebSocket connection',
() async {
debugPrint('Starting WebSocket DWDS test with headless Chrome...');

// Set up listening for app output before starting
final stdout = StringBuffer();
final sawDebugUrl = Completer<String>();
final StreamSubscription<String> subscription = flutter.stdout.listen((String e) {
stdout.writeln(e);
// Extract the debug connection URL
if (e.contains('Waiting for connection from Dart debug extension at http://')) {
final debugUrlPattern = RegExp(
r'Waiting for connection from Dart debug extension at (http://[^\s]+)',
);
final Match? match = debugUrlPattern.firstMatch(e);
if (match != null && !sawDebugUrl.isCompleted) {
sawDebugUrl.complete(match.group(1)!);
}
}
});

io.Process? chromeProcess;
try {
// Step 1: Start Flutter app with web-server device (will wait for debug connection)
debugPrint('Step 1: Starting Flutter app with web-server device...');
// Start the app but don't wait for it to complete - it won't complete until Chrome connects
final Future<void> appStartFuture = runFlutterWithWebServerDevice(
flutter,
additionalCommandArgs: [...additionalCommandArgs, '--no-web-resources-cdn'],
);
debugPrint('Starting WebSocket DWDS test with headless Chrome for hot reload...');

// Step 2: Wait for DWDS debug URL to be available
debugPrint('Step 2: Waiting for DWDS debug service URL...');
final String debugUrl = await sawDebugUrl.future.timeout(
debugUrlTimeout,
onTimeout: () {
throw Exception('DWDS debug URL not found - app may not have started correctly');
},
);
debugPrint('✓ DWDS debug service available at: $debugUrl');

// Step 3: Launch headless Chrome to connect to DWDS
debugPrint('Step 3: Launching headless Chrome to connect to DWDS...');
chromeProcess = await _launchHeadlessChrome(debugUrl);
debugPrint('✓ Headless Chrome launched and connecting to DWDS');

// Step 4: Wait for app to start (Chrome connection established)
debugPrint('Step 4: Waiting for Flutter app to start after Chrome connection...');
await appStartFuture.timeout(
appStartTimeout,
onTimeout: () {
throw Exception('App startup did not complete after Chrome connection');
},
);
debugPrint('✓ Flutter app started successfully with WebSocket connection');
// Set up WebSocket connection
final WebSocketDwdsTestSetup setup = await WebSocketDwdsTestUtils.setupWebSocketConnection(
flutter,
additionalCommandArgs: additionalCommandArgs,
);

// Step 5: Test hot reload functionality
debugPrint('Step 5: Testing hot reload with WebSocket connection...');
try {
// Test hot reload functionality
debugPrint('Step 6: Testing hot reload with WebSocket connection...');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having step numbers here requires keeping all these files in sync. If the common file changes then we would have to update this one too. I think for the actual testing we can omit the step numbers.

await flutter.hotReload().timeout(
hotReloadTimeout,
onTimeout: () {
Expand All @@ -114,80 +65,20 @@ void testAll({List<String> additionalCommandArgs = const <String>[]}) {
// Give some time for logs to capture
await Future<void>.delayed(const Duration(seconds: 2));

final output = stdout.toString();
final output = setup.stdout.toString();
expect(output, contains('Reloaded'), reason: 'Hot reload should complete successfully');
debugPrint('✓ Hot reload completed successfully with WebSocket connection');

// Verify the correct infrastructure was used
expect(
output,
contains('Waiting for connection from Dart debug extension'),
reason: 'Should wait for debug connection (WebSocket infrastructure)',
);
expect(output, contains('web-server'), reason: 'Should use web-server device');
WebSocketDwdsTestUtils.verifyWebSocketInfrastructure(output);

debugPrint('✓ WebSocket DWDS test completed successfully');
debugPrint('✓ Verified: web-server device + DWDS + WebSocket connection + hot reload');
} finally {
await _cleanupResources(chromeProcess, subscription);
await cleanupWebSocketTestResources(setup.chromeProcess, setup.subscription);
}
},
skip: !platform.isMacOS, // Skip on non-macOS platforms where Chrome paths may differ
);
});
}

/// Launches headless Chrome with the given debug URL.
/// Uses findChromeExecutable to locate Chrome on the current platform.
Future<io.Process> _launchHeadlessChrome(String debugUrl) async {
const chromeArgs = [
'--headless',
'--disable-gpu',
'--no-sandbox',
'--disable-extensions',
'--disable-dev-shm-usage',
'--remote-debugging-port=0',
];

final String chromePath = findChromeExecutable(platform, fileSystem);

try {
return await io.Process.start(chromePath, [...chromeArgs, debugUrl]);
} on Exception catch (e) {
throw Exception(
'Could not launch Chrome at $chromePath: $e. Please ensure Chrome is installed.',
);
}
}

/// Cleans up test resources (Chrome process and stdout subscription).
Future<void> _cleanupResources(
io.Process? chromeProcess,
StreamSubscription<String> subscription,
) async {
if (chromeProcess != null) {
try {
chromeProcess.kill();
await chromeProcess.exitCode;
debugPrint('Chrome process cleaned up');
} on Exception catch (e) {
debugPrint('Warning: Failed to clean up Chrome process: $e');
}
}
await subscription.cancel();
}

// Helper to run flutter with web-server device using WebSocket connection.
Future<void> runFlutterWithWebServerDevice(
FlutterRunTestDriver flutter, {
bool verbose = false,
bool withDebugger = true, // Enable debugger by default for WebSocket connection
bool startPaused = false, // Don't start paused for this test
List<String> additionalCommandArgs = const <String>[],
}) => flutter.run(
verbose: verbose,
withDebugger: withDebugger, // Enable debugger to establish WebSocket connection
startPaused: startPaused, // Let the app start normally after debugger connects
device: WebServerDevice.kWebServerDeviceId,
additionalCommandArgs: additionalCommandArgs,
);
88 changes: 88 additions & 0 deletions packages/flutter_tools/test/integration.shard/hot_restart_websocket_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
// 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.

@Tags(<String>['flutter-test-driver'])
library;

import 'dart:async';

import 'package:file/file.dart';

import '../src/common.dart';
import 'test_data/hot_reload_project.dart';
import 'test_data/websocket_dwds_test_common.dart';
import 'test_driver.dart';
import 'test_utils.dart';
import 'transition_test_utils.dart';

void main() {
testAll();
}

void testAll({List<String> additionalCommandArgs = const <String>[]}) {
group('WebSocket DWDS connection for hot restart'
'${additionalCommandArgs.isEmpty ? '' : ' with args: $additionalCommandArgs'}', () {
// Test configuration constants
const hotRestartTimeout = Duration(seconds: 15);

late Directory tempDir;
final project = HotReloadProject();
late FlutterRunTestDriver flutter;

setUp(() async {
tempDir = createResolvedTempDirectorySync('hot_restart_websocket_test.');
await project.setUpIn(tempDir);
flutter = FlutterRunTestDriver(tempDir);
});

tearDown(() async {
await flutter.stop();
tryToDelete(tempDir);
});

testWithoutContext(
'hot restart with headless Chrome WebSocket connection',
() async {
debugPrint('Starting WebSocket DWDS test with headless Chrome for hot restart...');

// Set up WebSocket connection
final WebSocketDwdsTestSetup setup = await WebSocketDwdsTestUtils.setupWebSocketConnection(
flutter,
additionalCommandArgs: additionalCommandArgs,
);

try {
// Test hot restart functionality
debugPrint('Step 6: Testing hot restart with WebSocket connection...');
await flutter.hotRestart().timeout(
hotRestartTimeout,
onTimeout: () {
throw Exception('Hot restart timed out');
},
);

// Give some time for logs to capture
await Future<void>.delayed(const Duration(seconds: 2));

final output = setup.stdout.toString();
expect(
output,
contains('Restarted application'),
reason: 'Hot restart should complete successfully',
);
debugPrint('✓ Hot restart completed successfully with WebSocket connection');

// Verify the correct infrastructure was used
WebSocketDwdsTestUtils.verifyWebSocketInfrastructure(output);

debugPrint('✓ WebSocket DWDS test completed successfully');
debugPrint('✓ Verified: web-server device + DWDS + WebSocket connection + hot restart');
} finally {
await cleanupWebSocketTestResources(setup.chromeProcess, setup.subscription);
}
},
skip: !platform.isMacOS, // Skip on non-macOS platforms where Chrome paths may differ
);
});
}
Loading