resident_web_runner_test.dart 47.6 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
// @dart = 2.8

7
import 'dart:async';
8
import 'dart:convert';
9
import 'dart:io';
10 11

import 'package:dwds/dwds.dart';
12
import 'package:file/memory.dart';
13
import 'package:flutter_tools/src/base/common.dart';
14
import 'package:flutter_tools/src/base/file_system.dart';
15
import 'package:flutter_tools/src/base/logger.dart';
16
import 'package:flutter_tools/src/base/platform.dart';
17
import 'package:flutter_tools/src/base/time.dart';
18
import 'package:flutter_tools/src/build_info.dart';
19 20
import 'package:flutter_tools/src/compile.dart';
import 'package:flutter_tools/src/devfs.dart';
21
import 'package:flutter_tools/src/device.dart';
22
import 'package:flutter_tools/src/globals_null_migrated.dart' as globals;
23 24
import 'package:flutter_tools/src/isolated/devfs_web.dart';
import 'package:flutter_tools/src/isolated/resident_web_runner.dart';
25
import 'package:flutter_tools/src/project.dart';
26
import 'package:flutter_tools/src/reporting/reporting.dart';
27
import 'package:flutter_tools/src/resident_runner.dart';
28
import 'package:flutter_tools/src/vmservice.dart';
29
import 'package:flutter_tools/src/web/chrome.dart';
30
import 'package:flutter_tools/src/web/web_device.dart';
31
import 'package:mockito/mockito.dart';
32
import 'package:vm_service/vm_service.dart' as vm_service;
33
import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
34 35

import '../src/common.dart';
36
import '../src/context.dart';
37
import '../src/fake_vm_services.dart';
38
import '../src/fakes.dart';
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
const List<VmServiceExpectation> kAttachLogExpectations = <VmServiceExpectation>[
  FakeVmServiceRequest(
    method: 'streamListen',
    args: <String, Object>{
      'streamId': 'Stdout',
    },
  ),
  FakeVmServiceRequest(
    method: 'streamListen',
    args: <String, Object>{
      'streamId': 'Stderr',
    },
  )
];

const List<VmServiceExpectation> kAttachIsolateExpectations = <VmServiceExpectation>[
  FakeVmServiceRequest(
    method: 'streamListen',
    args: <String, Object>{
      'streamId': 'Isolate'
    }
  ),
62
  FakeVmServiceRequest(
63
    method: 'registerService',
64
    args: <String, Object>{
65 66 67
      'service': 'reloadSources',
      'alias': 'Flutter Tools',
    }
68
  ),
69 70 71
  FakeVmServiceRequest(
    method: 'registerService',
    args: <String, Object>{
72 73
      'service': 'flutterVersion',
      'alias': 'Flutter Tools',
74
    }
75 76 77 78 79 80 81 82 83 84 85 86 87 88
  ),
  FakeVmServiceRequest(
    method: 'registerService',
    args: <String, Object>{
      'service': 'flutterMemoryInfo',
      'alias': 'Flutter Tools',
    }
  ),
  FakeVmServiceRequest(
    method: 'streamListen',
    args: <String, Object>{
      'streamId': 'Extension',
    },
  ),
89 90 91 92 93 94 95
];

const List<VmServiceExpectation> kAttachExpectations = <VmServiceExpectation>[
  ...kAttachLogExpectations,
  ...kAttachIsolateExpectations,
];

96 97
void main() {
  MockDebugConnection mockDebugConnection;
98
  MockChromeDevice mockChromeDevice;
99
  MockAppConnection mockAppConnection;
100 101 102
  MockFlutterDevice mockFlutterDevice;
  MockWebDevFS mockWebDevFS;
  MockResidentCompiler mockResidentCompiler;
103 104
  FakeChromeConnection chromeConnection;
  FakeChromeTab chromeTab;
105
  MockWebServerDevice mockWebServerDevice;
106
  MockDevice mockDevice;
107
  FakeVmServiceHost fakeVmServiceHost;
108 109
  FileSystem fileSystem;
  ProcessManager processManager;
110
  TestUsage testUsage;
111 112

  setUp(() {
113
    testUsage = TestUsage();
114 115
    fileSystem = MemoryFileSystem.test();
    processManager = FakeProcessManager.any();
116
    mockDebugConnection = MockDebugConnection();
117
    mockDevice = MockDevice();
118
    mockAppConnection = MockAppConnection();
119 120 121
    mockFlutterDevice = MockFlutterDevice();
    mockWebDevFS = MockWebDevFS();
    mockResidentCompiler = MockResidentCompiler();
122 123
    chromeConnection = FakeChromeConnection();
    chromeTab = FakeChromeTab('index.html');
124
    mockWebServerDevice = MockWebServerDevice();
125 126 127
    when(mockFlutterDevice.devFS).thenReturn(mockWebDevFS);
    when(mockFlutterDevice.device).thenReturn(mockDevice);
    when(mockWebDevFS.connect(any)).thenAnswer((Invocation invocation) async {
128 129 130 131 132
      return ConnectionResult(
        mockAppConnection,
        mockDebugConnection,
        mockDebugConnection.vmService,
      );
133
    });
134
    fileSystem.file('.packages').writeAsStringSync('\n');
135 136
  });

137
  void _setupMocks() {
138 139 140
    fileSystem.file('pubspec.yaml').createSync();
    fileSystem.file('lib/main.dart').createSync(recursive: true);
    fileSystem.file('web/index.html').createSync(recursive: true);
141
    when(mockWebDevFS.update(
142
      mainUri: anyNamed('mainUri'),
143 144 145 146 147 148 149 150 151 152
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
153
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
154
      packageConfig: anyNamed('packageConfig'),
155
    )).thenAnswer((Invocation _) async {
156
      return UpdateFSReport(success: true,  syncedBytes: 0);
157
    });
158
    when(mockDebugConnection.vmService).thenAnswer((Invocation invocation) {
159
      return fakeVmServiceHost.vmService.service;
160
    });
161 162 163
    when(mockDebugConnection.onDone).thenAnswer((Invocation invocation) {
      return Completer<void>().future;
    });
164
    when(mockDebugConnection.uri).thenReturn('ws://127.0.0.1/abcd/');
165 166
    when(mockFlutterDevice.devFS).thenReturn(mockWebDevFS);
    when(mockWebDevFS.sources).thenReturn(<Uri>[]);
167
    when(mockWebDevFS.baseUri).thenReturn(Uri.parse('http://localhost:12345'));
168
    when(mockFlutterDevice.generator).thenReturn(mockResidentCompiler);
169
    chromeConnection.tabs.add(chromeTab);
170 171
  }

172 173
  testUsingContext('runner with web server device does not support debugging without --start-paused', () {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
174 175 176
    when(mockFlutterDevice.device).thenReturn(WebServerDevice(
      logger: BufferLogger.test(),
    ));
177
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
178
    final ResidentRunner profileResidentWebRunner = ResidentWebRunner(
179
      mockFlutterDevice,
180
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
181 182
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
183
      stayResident: true,
184
      urlTunneller: null,
185 186 187 188 189
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
190 191

    expect(profileResidentWebRunner.debuggingEnabled, false);
192 193

    when(mockFlutterDevice.device).thenReturn(MockChromeDevice());
194

195
    expect(residentWebRunner.debuggingEnabled, true);
196
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
197 198 199 200
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
201

202 203 204 205
  testUsingContext('runner with web server device supports debugging with --start-paused', () {
    fileSystem.file('.packages')
      ..createSync(recursive: true)
      ..writeAsStringSync('\n');
206
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
207
    _setupMocks();
208 209 210
    when(mockFlutterDevice.device).thenReturn(WebServerDevice(
      logger: BufferLogger.test(),
    ));
211
    final ResidentRunner profileResidentWebRunner = ResidentWebRunner(
212
      mockFlutterDevice,
213
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
214 215 216
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug, startPaused: true),
      ipv6: true,
      stayResident: true,
217
      urlTunneller: null,
218 219 220 221
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
222 223
    );

224
    expect(profileResidentWebRunner.uri, mockWebDevFS.baseUri);
225
    expect(profileResidentWebRunner.debuggingEnabled, true);
226 227 228 229 230 231 232 233
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
  testUsingContext('profile does not supportsServiceProtocol', () {
    fileSystem.file('.packages')
      ..createSync(recursive: true)
      ..writeAsStringSync('\n');
234
    final ResidentRunner residentWebRunner = ResidentWebRunner(
235
      mockFlutterDevice,
236
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
237 238 239 240
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
      stayResident: true,
      urlTunneller: null,
241 242 243 244 245
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
246
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
247
    when(mockFlutterDevice.device).thenReturn(mockChromeDevice);
248
    final ResidentRunner profileResidentWebRunner = ResidentWebRunner(
249
      mockFlutterDevice,
250
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
251 252
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.profile),
      ipv6: true,
253
      stayResident: true,
254
      urlTunneller: null,
255 256 257 258
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
259 260 261 262
    );

    expect(profileResidentWebRunner.supportsServiceProtocol, false);
    expect(residentWebRunner.supportsServiceProtocol, true);
263 264 265 266
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
267

268
  testUsingContext('Can successfully run and connect to vmservice', () async {
269 270
    final BufferLogger bufferLogger = BufferLogger.test();
    final FakeStatusLogger logger = FakeStatusLogger(bufferLogger);
271 272 273
    fileSystem.file('.packages')
      ..createSync(recursive: true)
      ..writeAsStringSync('\n');
274
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: logger);
275
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
276
    _setupMocks();
277
    final MockStatus status = MockStatus();
278
    logger.status = status;
279 280 281 282 283 284
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    final DebugConnectionInfo debugConnectionInfo = await connectionInfoCompleter.future;

285
    verify(mockAppConnection.runMain()).called(1);
286
    verify(status.stop()).called(1);
287
    expect(bufferLogger.statusText, contains('Debug service listening on ws://127.0.0.1/abcd/'));
288
    expect(debugConnectionInfo.wsUri.toString(), 'ws://127.0.0.1/abcd/');
289
  }, overrides: <Type, Generator>{
290
    Logger: () => FakeStatusLogger(BufferLogger.test()),
291 292 293
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
294

295 296
  testUsingContext('WebRunner copies compiled app.dill to cache during startup', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
297 298 299 300 301 302 303 304 305 306
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
    _setupMocks();

    residentWebRunner.artifactDirectory.childFile('app.dill').writeAsStringSync('ABC');
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

307 308 309 310 311
    expect(await fileSystem.file(fileSystem.path.join('build', 'cache.dill')).readAsString(), 'ABC');
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
312

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
  // Regression test for https://github.com/flutter/flutter/issues/60613
  testUsingContext('ResidentWebRunner calls appFailedToStart if initial compilation fails', () async {
    _setupMocks();
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
    fileSystem.file(globals.fs.path.join('lib', 'main.dart'))
      .createSync(recursive: true);
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
    when(mockWebDevFS.update(
      mainUri: anyNamed('mainUri'),
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
      packageConfig: anyNamed('packageConfig'),
    )).thenAnswer((Invocation _) async {
335
      return UpdateFSReport(success: false, syncedBytes: 0);
336 337 338 339 340 341 342 343 344 345
    });

    expect(await residentWebRunner.run(), 1);
    // Completing this future ensures that the daemon can exit correctly.
    expect(await residentWebRunner.waitForAppToFinish(), 1);
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });

346
  testUsingContext('Can successfully run without an index.html including status warning', () async {
347
    final BufferLogger logger = BufferLogger.test();
348 349
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
    _setupMocks();
350
    fileSystem.file(fileSystem.path.join('web', 'index.html'))
351
      .deleteSync();
352
    final ResidentWebRunner residentWebRunner = ResidentWebRunner(
353
      mockFlutterDevice,
354
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
355 356 357 358
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
      stayResident: false,
      urlTunneller: null,
359 360 361 362 363
      fileSystem: fileSystem,
      logger: logger,
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
364 365

    expect(await residentWebRunner.run(), 0);
366
    expect(logger.statusText,
367
      contains('This application is not configured to build on the web'));
368 369 370 371
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
372

373
  testUsingContext('Can successfully run and disconnect with --no-resident', () async {
374
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
375
    _setupMocks();
376
    final ResidentRunner residentWebRunner = ResidentWebRunner(
377
      mockFlutterDevice,
378
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
379 380 381
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
      stayResident: false,
382
      urlTunneller: null,
383 384 385 386 387
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
388 389

    expect(await residentWebRunner.run(), 0);
390 391 392 393
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
394

395
  testUsingContext('Listens to stdout and stderr streams before running main', () async {
396 397
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: logger);
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachLogExpectations,
      FakeVmServiceStreamResponse(
        streamId: 'Stdout',
        event: vm_service.Event(
          timestamp: 0,
          kind: vm_service.EventStreams.kStdout,
          bytes: base64.encode(utf8.encode('THIS MESSAGE IS IMPORTANT'))
        ),
      ),
      FakeVmServiceStreamResponse(
        streamId: 'Stderr',
        event: vm_service.Event(
          timestamp: 0,
          kind: vm_service.EventStreams.kStderr,
          bytes: base64.encode(utf8.encode('SO IS THIS'))
        ),
      ),
      ...kAttachIsolateExpectations,
    ]);
418 419 420 421 422 423 424
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

425 426
    expect(logger.statusText, contains('THIS MESSAGE IS IMPORTANT'));
    expect(logger.statusText, contains('SO IS THIS'));
427 428 429 430
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
431

432
  testUsingContext('Listens to extension events with structured errors', () async {
433
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: testLogger);
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
    final Map<String, String> extensionData = <String, String>{
      'test': 'data',
      'renderedErrorText': 'error text',
    };
    final Map<String, String> emptyExtensionData = <String, String>{
      'test': 'data',
      'renderedErrorText': '',
    };
    final Map<String, String> nonStructuredErrorData = <String, String>{
      'other': 'other stuff',
    };
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
      FakeVmServiceStreamResponse(
        streamId: 'Extension',
        event: vm_service.Event(
          timestamp: 0,
          extensionKind: 'Flutter.Error',
          extensionData: vm_service.ExtensionData.parse(extensionData),
          kind: vm_service.EventStreams.kExtension,
        ),
      ),
      // Empty error text should not break anything.
      FakeVmServiceStreamResponse(
        streamId: 'Extension',
        event: vm_service.Event(
          timestamp: 0,
          extensionKind: 'Flutter.Error',
          extensionData: vm_service.ExtensionData.parse(emptyExtensionData),
          kind: vm_service.EventStreams.kExtension,
        ),
      ),
      // This is not Flutter.Error kind data, so it should not be logged.
      FakeVmServiceStreamResponse(
        streamId: 'Extension',
        event: vm_service.Event(
          timestamp: 0,
          extensionKind: 'Other',
          extensionData: vm_service.ExtensionData.parse(nonStructuredErrorData),
          kind: vm_service.EventStreams.kExtension,
        ),
      ),
    ]);

    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;
    await null;

    expect(testLogger.statusText, contains('\nerror text'));
    expect(testLogger.statusText, isNot(contains('other stuff')));
488 489 490 491
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
492

493
  testUsingContext('Does not run main with --start-paused', () async {
494
    final ResidentRunner residentWebRunner = ResidentWebRunner(
495
      mockFlutterDevice,
496
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
497 498
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug, startPaused: true),
      ipv6: true,
499
      stayResident: true,
500
      urlTunneller: null,
501 502 503 504 505
      fileSystem: fileSystem,
      logger: BufferLogger.test(),
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
506
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
507 508
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
509

510 511 512 513 514 515
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

    verifyNever(mockAppConnection.runMain());
516 517 518 519
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
520

521
  testUsingContext('Can hot reload after attaching', () async {
522 523 524 525 526 527
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(
      mockFlutterDevice,
      logger: logger,
      systemClock: SystemClock.fixed(DateTime(2001, 1, 1)),
    );
528 529 530 531 532 533 534 535 536
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
      const FakeVmServiceRequest(
        method: 'hotRestart',
        jsonResponse: <String, Object>{
          'type': 'Success',
        }
      ),
    ]);
537
    _setupMocks();
538
    final TestChromiumLauncher chromiumLauncher = TestChromiumLauncher();
539
    final Chromium chrome = Chromium(1, chromeConnection, chromiumLauncher: chromiumLauncher);
540 541
    chromiumLauncher.instance = chrome;

542
    when(mockFlutterDevice.device).thenReturn(GoogleChromeDevice(
543
      fileSystem: fileSystem,
544
      chromiumLauncher: chromiumLauncher,
545
      logger: BufferLogger.test(),
546 547 548
      platform: FakePlatform(operatingSystem: 'linux'),
      processManager: FakeProcessManager.any(),
    ));
549
    when(mockWebDevFS.update(
550
      mainUri: anyNamed('mainUri'),
551 552 553 554 555 556 557 558 559 560 561
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
562
      packageConfig: anyNamed('packageConfig'),
563
    )).thenAnswer((Invocation invocation) async {
Dan Field's avatar
Dan Field committed
564
      // Generated entrypoint file in temp dir.
565
      expect(invocation.namedArguments[#mainUri].toString(), contains('entrypoint.dart'));
566
      return UpdateFSReport(success: true);
567 568 569 570 571
    });
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
572 573 574 575
    final DebugConnectionInfo debugConnectionInfo = await connectionInfoCompleter.future;

    expect(debugConnectionInfo, isNotNull);

576 577
    final OperationResult result = await residentWebRunner.restart(fullRestart: false);

578
    expect(logger.statusText, contains('Restarted application in'));
579 580
    expect(result.code, 0);
    verify(mockResidentCompiler.accept()).called(2);
581 582

    // ensure that analytics are sent.
583 584
    expect(testUsage.events, <TestUsageEvent>[
      TestUsageEvent('hot', 'restart', parameters: CustomDimensions.fromMap(<String, String>{'cd27': 'web-javascript', 'cd28': '', 'cd29': 'false', 'cd30': 'true', 'cd13': '0'})),
585 586 587 588
    ]);
    expect(testUsage.timings, const <TestTimingEvent>[
      TestTimingEvent('hot', 'web-incremental-restart', Duration.zero),
    ]);
589
  }, overrides: <Type, Generator>{
590
    Usage: () => testUsage,
591 592 593
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
594

595
  testUsingContext('Can hot restart after attaching', () async {
596 597 598 599 600 601
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(
      mockFlutterDevice,
      logger: logger,
      systemClock: SystemClock.fixed(DateTime(2001, 1, 1)),
    );
602 603 604 605 606 607 608 609 610
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
      const FakeVmServiceRequest(
        method: 'hotRestart',
        jsonResponse: <String, Object>{
          'type': 'Success',
        }
      ),
    ]);
611
    _setupMocks();
612
    final TestChromiumLauncher chromiumLauncher = TestChromiumLauncher();
613
    final Chromium chrome = Chromium(1, chromeConnection, chromiumLauncher: chromiumLauncher);
614 615
    chromiumLauncher.instance = chrome;

616
    when(mockFlutterDevice.device).thenReturn(GoogleChromeDevice(
617
      fileSystem: fileSystem,
618
      chromiumLauncher: chromiumLauncher,
619
      logger: BufferLogger.test(),
620 621 622
      platform: FakePlatform(operatingSystem: 'linux'),
      processManager: FakeProcessManager.any(),
    ));
623
    Uri entrypointFileUri;
624
    when(mockWebDevFS.update(
625
      mainUri: anyNamed('mainUri'),
626 627 628 629 630 631 632 633 634 635 636
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
637
      packageConfig: anyNamed('packageConfig'),
638
    )).thenAnswer((Invocation invocation) async {
639
      entrypointFileUri = invocation.namedArguments[#mainUri] as Uri;
640
      return UpdateFSReport(success: true);
641 642 643 644 645 646 647 648
    });
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;
    final OperationResult result = await residentWebRunner.restart(fullRestart: true);

649
    // Ensure that generated entrypoint is generated correctly.
650
    expect(entrypointFileUri, isNotNull);
651
    final String entrypointContents = fileSystem.file(entrypointFileUri).readAsStringSync();
652 653 654
    expect(entrypointContents, contains('// Flutter web bootstrap script'));
    expect(entrypointContents, contains("import 'dart:ui' as ui;"));
    expect(entrypointContents, contains('await ui.webOnlyInitializePlatform();'));
655

656
    expect(logger.statusText, contains('Restarted application in'));
657 658
    expect(result.code, 0);
    verify(mockResidentCompiler.accept()).called(2);
659

660
	  // ensure that analytics are sent.
661 662
    expect(testUsage.events, <TestUsageEvent>[
      TestUsageEvent('hot', 'restart', parameters: CustomDimensions.fromMap(<String, String>{'cd27': 'web-javascript', 'cd28': '', 'cd29': 'false', 'cd30': 'true', 'cd13': '0'})),
663 664 665 666
    ]);
    expect(testUsage.timings, const <TestTimingEvent>[
      TestTimingEvent('hot', 'web-incremental-restart', Duration.zero),
    ]);
667
  }, overrides: <Type, Generator>{
668
    Usage: () => testUsage,
669 670 671
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
672

673
  testUsingContext('Can hot restart after attaching with web-server device', () async {
674 675 676 677 678 679
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(
      mockFlutterDevice,
      logger: logger,
      systemClock: SystemClock.fixed(DateTime(2001, 1, 1)),
    );
680
    fakeVmServiceHost = FakeVmServiceHost(requests :kAttachExpectations);
681 682 683
    _setupMocks();
    when(mockFlutterDevice.device).thenReturn(mockWebServerDevice);
    when(mockWebDevFS.update(
684
      mainUri: anyNamed('mainUri'),
685 686 687 688 689 690 691 692 693 694 695
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
696
      packageConfig: anyNamed('packageConfig'),
697
    )).thenAnswer((Invocation invocation) async {
698
      return UpdateFSReport(success: true);
699 700 701 702 703 704 705 706
    });
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;
    final OperationResult result = await residentWebRunner.restart(fullRestart: true);

707
    expect(logger.statusText, contains('Restarted application in'));
708 709
    expect(result.code, 0);
    verify(mockResidentCompiler.accept()).called(2);
710 711 712 713

	  // web-server device does not send restart analytics
    expect(testUsage.events, isEmpty);
    expect(testUsage.timings, isEmpty);
714
  }, overrides: <Type, Generator>{
715
    Usage: () => testUsage,
716 717 718
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
719

720 721
  testUsingContext('web resident runner is debuggable', () {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
722 723
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());

724
    expect(residentWebRunner.debuggingEnabled, true);
725 726 727 728
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
729

730 731
  testUsingContext('Exits when initial compile fails', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
732
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
733
    _setupMocks();
734
    when(mockWebDevFS.update(
735
      mainUri: anyNamed('mainUri'),
736 737 738 739 740 741 742 743 744 745
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
746
      packageConfig: anyNamed('packageConfig'),
747
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
748
    )).thenAnswer((Invocation _) async {
749
      return UpdateFSReport(success: false,  syncedBytes: 0);
750
    });
751
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
752
    unawaited(residentWebRunner.run(
753 754 755
      connectionInfoCompleter: connectionInfoCompleter,
    ));

756
    expect(await residentWebRunner.run(), 1);
757 758
    expect(testUsage.events, isEmpty);
    expect(testUsage.timings, isEmpty);
759
  }, overrides: <Type, Generator>{
760
    Usage: () => testUsage,
761 762 763
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
764

765
  testUsingContext('Faithfully displays stdout messages with leading/trailing spaces', () async {
766 767
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: logger);
768 769 770 771 772 773 774 775 776 777 778 779 780 781
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachLogExpectations,
      FakeVmServiceStreamResponse(
        streamId: 'Stdout',
        event: vm_service.Event(
          timestamp: 0,
          kind: vm_service.EventStreams.kStdout,
          bytes: base64.encode(
            utf8.encode('    This is a message with 4 leading and trailing spaces    '),
          ),
        ),
      ),
      ...kAttachIsolateExpectations,
    ]);
782 783 784 785 786 787 788
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

789
    expect(logger.statusText,
790
      contains('    This is a message with 4 leading and trailing spaces    '));
791
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
792 793 794 795
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
796

797 798
  testUsingContext('Fails on compilation errors in hot restart', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
799
    fakeVmServiceHost = FakeVmServiceHost(requests: kAttachExpectations.toList());
800 801
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
802
    unawaited(residentWebRunner.run(
803 804 805
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;
806
    when(mockWebDevFS.update(
807
      mainUri: anyNamed('mainUri'),
808 809 810 811 812 813 814 815 816 817
      target: anyNamed('target'),
      bundle: anyNamed('bundle'),
      firstBuildTime: anyNamed('firstBuildTime'),
      bundleFirstUpload: anyNamed('bundleFirstUpload'),
      generator: anyNamed('generator'),
      fullRestart: anyNamed('fullRestart'),
      dillOutputPath: anyNamed('dillOutputPath'),
      projectRootPath: anyNamed('projectRootPath'),
      pathToReload: anyNamed('pathToReload'),
      invalidatedFiles: anyNamed('invalidatedFiles'),
818
      packageConfig: anyNamed('packageConfig'),
819
      trackWidgetCreation: anyNamed('trackWidgetCreation'),
820
    )).thenAnswer((Invocation _) async {
821
      return UpdateFSReport(success: false,  syncedBytes: 0);
822 823 824 825 826
    });

    final OperationResult result = await residentWebRunner.restart(fullRestart: true);

    expect(result.code, 1);
827
    expect(result.message, contains('Failed to recompile application.'));
828 829
    expect(testUsage.events, isEmpty);
    expect(testUsage.timings, isEmpty);
830
  }, overrides: <Type, Generator>{
831
    Usage: () => testUsage,
832 833 834
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
835

836 837
  testUsingContext('Fails non-fatally on vmservice response error for hot restart', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
838 839 840 841 842 843 844 845 846
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
      const FakeVmServiceRequest(
        method: 'hotRestart',
        jsonResponse: <String, Object>{
          'type': 'Failed',
        }
      )
    ]);
847 848 849 850 851 852 853 854 855
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

    final OperationResult result = await residentWebRunner.restart(fullRestart: false);

856
    expect(result.code, 0);
857 858 859 860
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
861

862 863
  testUsingContext('Fails fatally on Vm Service error response', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
864 865 866 867 868 869 870 871
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
      const FakeVmServiceRequest(
        method: 'hotRestart',
        // Failed response,
        errorCode: RPCErrorCodes.kInternalError,
      ),
    ]);
872 873 874 875 876 877 878 879 880
    _setupMocks();
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;
    final OperationResult result = await residentWebRunner.restart(fullRestart: false);

    expect(result.code, 1);
881 882
    expect(result.message,
      contains(RPCErrorCodes.kInternalError.toString()));
883 884 885 886
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
887

888
  testUsingContext('printHelp without details shows hot restart help message', () async {
889 890
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: logger);
891 892 893
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
    residentWebRunner.printHelp(details: false);

894
    expect(logger.statusText, contains('To hot restart changes'));
895 896 897 898 899
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });

900 901
  testUsingContext('cleanup of resources is safe to call multiple times', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
902 903 904
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
    ]);
905 906
    _setupMocks();
    bool debugClosed = false;
907
    when(mockDevice.stopApp(any, userIdentifier: anyNamed('userIdentifier'))).thenAnswer((Invocation invocation) async {
908 909 910 911
      if (debugClosed) {
        throw StateError('debug connection closed twice');
      }
      debugClosed = true;
912
      return true;
913 914
    });
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
915
    unawaited(residentWebRunner.run(
916 917 918 919 920 921
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

    await residentWebRunner.exit();
    await residentWebRunner.exit();
922 923

    verifyNever(mockDebugConnection.close());
924
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
925 926 927 928
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
929

930 931
  testUsingContext('cleans up Chrome if tab is closed', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
932 933 934
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
    ]);
935 936 937 938 939 940 941 942 943 944 945 946 947
    _setupMocks();
    final Completer<void> onDone = Completer<void>();
    when(mockDebugConnection.onDone).thenAnswer((Invocation invocation) {
      return onDone.future;
    });
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    final Future<int> result = residentWebRunner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    );
    await connectionInfoCompleter.future;
    onDone.complete();

    await result;
948
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
949 950 951 952
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
953

954
  testUsingContext('Prints target and device name on run', () async {
955 956
    final BufferLogger logger = BufferLogger.test();
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: logger);
957 958 959
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachExpectations,
    ]);
960
    _setupMocks();
961
    when(mockDevice.name).thenReturn('Chromez');
962
    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
963
    unawaited(residentWebRunner.run(
964 965 966 967
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

968
    expect(logger.statusText, contains(
969
      'Launching ${fileSystem.path.join('lib', 'main.dart')} on '
970 971 972
      'Chromez in debug mode',
    ));
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
973 974 975 976
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
977

978
  testUsingContext('Sends launched app.webLaunchUrl event for Chrome device', () async {
979
    final BufferLogger logger = BufferLogger.test();
980 981
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
      ...kAttachLogExpectations,
982
      ...kAttachIsolateExpectations,
983
    ]);
984
    _setupMocks();
985
    final FakeChromeConnection chromeConnection = FakeChromeConnection();
986
    final TestChromiumLauncher chromiumLauncher = TestChromiumLauncher();
987
    final Chromium chrome = Chromium(1, chromeConnection, chromiumLauncher: chromiumLauncher);
988 989
    chromiumLauncher.instance = chrome;

990
    when(mockFlutterDevice.device).thenReturn(GoogleChromeDevice(
991
      fileSystem: fileSystem,
992
      chromiumLauncher: chromiumLauncher,
993
      logger: logger,
994 995 996
      platform: FakePlatform(operatingSystem: 'linux'),
      processManager: FakeProcessManager.any(),
    ));
997 998 999
    when(mockWebDevFS.create()).thenAnswer((Invocation invocation) async {
      return Uri.parse('http://localhost:8765/app/');
    });
1000 1001
    final FakeChromeTab chromeTab = FakeChromeTab('index.html');
    chromeConnection.tabs.add(chromeTab);
1002

1003
    final ResidentWebRunner runner = ResidentWebRunner(
1004
      mockFlutterDevice,
1005
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
1006 1007 1008
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
      stayResident: true,
1009
      urlTunneller: null,
1010 1011 1012 1013 1014
      fileSystem: fileSystem,
      logger: logger,
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
1015 1016 1017 1018 1019 1020 1021 1022

    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(runner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

    // Ensure we got the URL and that it was already launched.
1023
    expect(logger.eventText,
1024 1025 1026 1027 1028 1029 1030 1031
      contains(json.encode(<String, Object>{
        'name': 'app.webLaunchUrl',
        'args': <String, Object>{
          'url': 'http://localhost:8765/app/',
          'launched': true,
        },
      },
    )));
1032
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1033
  }, overrides: <Type, Generator>{
1034
    Logger: () => FakeStatusLogger(BufferLogger.test()),
1035 1036 1037
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1038

1039
  testUsingContext('Sends unlaunched app.webLaunchUrl event for Web Server device', () async {
1040
    final BufferLogger logger = BufferLogger.test();
1041
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
1042
    _setupMocks();
1043
    when(mockFlutterDevice.device).thenReturn(WebServerDevice(
1044
      logger: logger,
1045
    ));
1046 1047 1048
    when(mockWebDevFS.create()).thenAnswer((Invocation invocation) async {
      return Uri.parse('http://localhost:8765/app/');
    });
1049

1050
    final ResidentWebRunner runner = ResidentWebRunner(
1051
      mockFlutterDevice,
1052
      flutterProject: FlutterProject.fromDirectoryTest(fileSystem.currentDirectory),
1053 1054 1055
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
      ipv6: true,
      stayResident: true,
1056
      urlTunneller: null,
1057 1058 1059 1060 1061
      fileSystem: fileSystem,
      logger: logger,
      usage: globals.flutterUsage,
      systemClock: globals.systemClock,
    );
1062 1063 1064 1065 1066 1067 1068 1069

    final Completer<DebugConnectionInfo> connectionInfoCompleter = Completer<DebugConnectionInfo>();
    unawaited(runner.run(
      connectionInfoCompleter: connectionInfoCompleter,
    ));
    await connectionInfoCompleter.future;

    // Ensure we got the URL and that it was not already launched.
1070
    expect(logger.eventText,
1071 1072 1073 1074 1075 1076 1077 1078
      contains(json.encode(<String, Object>{
        'name': 'app.webLaunchUrl',
        'args': <String, Object>{
          'url': 'http://localhost:8765/app/',
          'launched': false,
        },
      },
    )));
1079
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1080
  }, overrides: <Type, Generator>{
1081 1082 1083
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1084

1085 1086
  testUsingContext('Successfully turns WebSocketException into ToolExit', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
1087
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
1088 1089
    _setupMocks();

1090 1091
    when(mockWebDevFS.connect(any))
      .thenThrow(const WebSocketException());
1092

1093
    await expectLater(residentWebRunner.run, throwsToolExit());
1094
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1095 1096 1097 1098
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1099

1100 1101
  testUsingContext('Successfully turns AppConnectionException into ToolExit', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
1102
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
1103 1104
    _setupMocks();

1105 1106
    when(mockWebDevFS.connect(any))
      .thenThrow(AppConnectionException(''));
1107

1108
    await expectLater(residentWebRunner.run, throwsToolExit());
1109
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1110 1111 1112 1113
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1114

1115 1116
  testUsingContext('Successfully turns ChromeDebugError into ToolExit', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
1117 1118
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
    _setupMocks();
1119

1120 1121
    when(mockWebDevFS.connect(any))
      .thenThrow(ChromeDebugException(<String, dynamic>{}));
1122

1123
    await expectLater(residentWebRunner.run, throwsToolExit());
1124
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1125 1126 1127 1128
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1129

1130 1131
  testUsingContext('Rethrows unknown Exception type from dwds', () async {
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice);
1132
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
1133
    _setupMocks();
1134
    when(mockWebDevFS.connect(any)).thenThrow(Exception());
1135

1136
    await expectLater(residentWebRunner.run, throwsException);
1137
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1138 1139 1140 1141
  }, overrides: <Type, Generator>{
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
1142

1143
  testUsingContext('Rethrows unknown Error type from dwds tooling', () async {
1144 1145 1146
    final BufferLogger logger = BufferLogger.test();
    final FakeStatusLogger fakeStatusLogger = FakeStatusLogger(logger);
    final ResidentRunner residentWebRunner = setUpResidentRunner(mockFlutterDevice, logger: fakeStatusLogger);
1147
    fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[]);
1148 1149
    _setupMocks();
    final MockStatus mockStatus = MockStatus();
1150
    fakeStatusLogger.status = mockStatus;
1151

1152
    when(mockWebDevFS.connect(any)).thenThrow(StateError(''));
1153

1154
    await expectLater(residentWebRunner.run, throwsStateError);
1155
    verify(mockStatus.stop()).called(1);
1156
    expect(fakeVmServiceHost.hasRemainingExpectations, false);
1157
  }, overrides: <Type, Generator>{
1158 1159 1160 1161 1162
    FileSystem: () => fileSystem,
    ProcessManager: () => processManager,
  });
}

1163 1164 1165 1166 1167
ResidentRunner setUpResidentRunner(FlutterDevice flutterDevice, {
  Logger logger,
  SystemClock systemClock,
}) {
  return ResidentWebRunner(
1168
    flutterDevice,
1169
    flutterProject: FlutterProject.fromDirectoryTest(globals.fs.currentDirectory),
1170 1171 1172 1173
    debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
    ipv6: true,
    stayResident: true,
    urlTunneller: null,
1174 1175 1176 1177 1178
    usage: globals.flutterUsage,
    systemClock: systemClock ?? SystemClock.fixed(DateTime.now()),
    fileSystem: globals.fs,
    logger: logger ?? BufferLogger.test(),
  );
1179 1180
}

1181
class MockChromeDevice extends Mock implements ChromiumDevice {}
1182
class MockDebugConnection extends Mock implements DebugConnection {}
1183
class MockAppConnection extends Mock implements AppConnection {}
1184
class MockStatus extends Mock implements Status {}
1185
class MockFlutterDevice extends Mock implements FlutterDevice {}
1186
class MockWebDevFS extends Mock implements WebDevFS {}
1187
class MockResidentCompiler extends Mock implements ResidentCompiler {}
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217

class FakeChromeConnection extends Fake implements ChromeConnection {
  final List<ChromeTab> tabs = <ChromeTab>[];

  @override
  Future<ChromeTab> getTab(bool Function(ChromeTab tab) accept, {Duration retryFor}) async {
    return tabs.firstWhere(accept);
  }
}

class FakeChromeTab extends Fake implements ChromeTab {
  FakeChromeTab(this.url);

  @override
  final String url;
  final FakeWipConnection connection = FakeWipConnection();

  @override
  Future<WipConnection> connect() async {
    return connection;
  }
}

class FakeWipConnection extends Fake implements WipConnection {
  @override
  final WipDebugger debugger = FakeWipDebugger();
}

class FakeWipDebugger extends Fake implements WipDebugger {}

1218
class MockWebServerDevice extends Mock implements WebServerDevice {}
1219
class MockDevice extends Mock implements Device {}
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254

/// A test implementation of the [ChromiumLauncher] that launches a fixed instance.
class TestChromiumLauncher implements ChromiumLauncher {
  TestChromiumLauncher();

  set instance(Chromium chromium) {
    _hasInstance = true;
    currentCompleter.complete(chromium);
  }
  bool _hasInstance = false;

  @override
  Completer<Chromium> currentCompleter = Completer<Chromium>();

  @override
  bool canFindExecutable() {
    return true;
  }

  @override
  Future<Chromium> get connectedInstance => currentCompleter.future;

  @override
  String findExecutable() {
    return 'chrome';
  }

  @override
  bool get hasChromeInstance => _hasInstance;

  @override
  Future<Chromium> launch(String url, {bool headless = false, int debugPort, bool skipCheck = false, Directory cacheDir}) async {
    return currentCompleter.future;
  }
}