flutter/packages/flutter_tools/test/web.shard/hot_reload_web_test.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.

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

import 'dart:async';

import 'package:file/file.dart';
import 'package:flutter_tools/src/web/compile.dart';

import '../integration.shard/test_data/hot_reload_project.dart';
import '../integration.shard/test_driver.dart';
import '../integration.shard/test_utils.dart';
import '../src/common.dart';

import 'test_data/hot_reload_index_html_samples.dart';

void main() async {
  await _testProject(HotReloadProject()); // default
  await _testProject(
    HotReloadProject(constApp: true),
    name: 'Default) (with `const MyApp()`)',
  ); // runApp(const MyApp());
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlFlutterJsCallback),
    name: 'flutter.js (callback)',
  );
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlFlutterJsPromisesFull),
    name: 'flutter.js (promises)',
  );
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlFlutterJsPromisesShort),
    name: 'flutter.js (promises, short)',
  );
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlFlutterJsLoad),
    name: 'flutter.js (load)',
  );
  await _testProject(HotReloadProject(indexHtml: indexHtmlNoFlutterJs), name: 'No flutter.js');
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlWithFlutterBootstrapScriptTag),
    name: 'Using flutter_bootstrap.js script tag',
  );
  await _testProject(
    HotReloadProject(indexHtml: indexHtmlWithInlinedFlutterBootstrapScript),
    name: 'Using inlined flutter_bootstrap.js',
  );
}

Future<void> _testProject(HotReloadProject project, {String name = 'Default'}) async {
  late Directory tempDir;
  late FlutterRunTestDriver flutter;

  final String testName = 'Hot reload (index.html: $name)';

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

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

  testWithoutContext('$testName: hot restart works without error', () async {
    flutter.stdout.listen(printOnFailure);
    await flutter.run(chrome: true, additionalCommandArgs: <String>['--verbose']);
    await flutter.hotRestart();
  });

  testWithoutContext(
    '$testName: newly added code executes during hot restart - html (legacy)',
    () async {
      final Completer<void> completer = Completer<void>();
      final StreamSubscription<String> subscription = flutter.stdout.listen((String line) {
        printOnFailure(line);
        if (line.contains('(((((RELOAD WORKED)))))')) {
          completer.complete();
        }
      });
      await flutter.run(
        chrome: true,
        additionalCommandArgs: <String>['--verbose', ...WebRendererMode.html.toCliDartDefines],
      );
      project.uncommentHotReloadPrint();
      try {
        await flutter.hotRestart();
        await completer.future.timeout(const Duration(seconds: 15));
      } finally {
        await subscription.cancel();
      }
    },
  );

  testWithoutContext(
    '$testName: newly added code executes during hot restart - canvaskit',
    () async {
      final Completer<void> completer = Completer<void>();
      final StreamSubscription<String> subscription = flutter.stdout.listen((String line) {
        printOnFailure(line);
        if (line.contains('(((((RELOAD WORKED)))))')) {
          completer.complete();
        }
      });
      await flutter.run(chrome: true, additionalCommandArgs: <String>['--verbose']);
      project.uncommentHotReloadPrint();
      try {
        await flutter.hotRestart();
        await completer.future.timeout(const Duration(seconds: 15));
      } finally {
        await subscription.cancel();
      }
    },
    // Skipped for https://github.com/flutter/flutter/issues/110879.
    skip: true,
  );
}