web_test.dart 18.5 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
import 'package:file_testing/file_testing.dart';
6
import 'package:flutter_tools/src/artifacts.dart';
7
import 'package:flutter_tools/src/base/file_system.dart';
8

9
import 'package:flutter_tools/src/build_system/build_system.dart';
10
import 'package:flutter_tools/src/build_system/depfile.dart';
11 12
import 'package:flutter_tools/src/build_system/targets/dart.dart';
import 'package:flutter_tools/src/build_system/targets/web.dart';
13
import 'package:flutter_tools/src/dart/package_map.dart';
14
import 'package:flutter_tools/src/globals.dart' as globals;
15 16
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
17
import 'package:platform/platform.dart';
18 19

import '../../../src/common.dart';
20
import '../../../src/context.dart';
21 22 23
import '../../../src/mocks.dart';
import '../../../src/testbed.dart';

24 25 26 27 28 29
const List<String> kDart2jsLinuxArgs = <String>[
  'bin/cache/dart-sdk/bin/dart',
  'bin/cache/dart-sdk/bin/snapshots/dart2js.dart.snapshot',
  '--libraries-spec=bin/cache/flutter_web_sdk/libraries.json',
];

30 31 32
void main() {
  Testbed testbed;
  Environment environment;
33 34 35 36 37 38 39 40 41
  FakeProcessManager processManager;
  final Platform linux = FakePlatform(
    operatingSystem: 'linux',
    environment: <String, String>{},
  );
  final Platform windows = FakePlatform(
    operatingSystem: 'windows',
    environment: <String, String>{},
  );
42
  DepfileService depfileService;
43 44 45

  setUp(() {
    testbed = Testbed(setup: () {
46
      final File packagesFile = globals.fs.file(globals.fs.path.join('foo', '.packages'))
47 48
        ..createSync(recursive: true)
        ..writeAsStringSync('foo:lib/\n');
49
      globalPackagesPath = packagesFile.path;
50
      globals.fs.currentDirectory.childDirectory('bar').createSync();
51
      processManager = FakeProcessManager.list(<FakeCommand>[]);
52

53 54
      environment = Environment.test(
        globals.fs.currentDirectory,
55
        projectDir: globals.fs.currentDirectory.childDirectory('foo'),
56
        outputDir: globals.fs.currentDirectory.childDirectory('bar'),
57
        defines: <String, String>{
58
          kTargetFile: globals.fs.path.join('foo', 'lib', 'main.dart'),
59 60 61 62 63
        },
        artifacts: MockArtifacts(),
        processManager: FakeProcessManager.any(),
        logger: globals.logger,
        fileSystem: globals.fs,
64
      );
65 66 67 68
      depfileService = DepfileService(
      fileSystem: globals.fs,
      logger: globals.logger,
    );
69 70
      environment.buildDir.createSync(recursive: true);
    }, overrides: <Type, Generator>{
71
      Platform: () => linux,
72 73 74 75 76 77 78 79 80 81 82
    });
  });

  test('WebEntrypointTarget generates an entrypoint with plugins and init platform', () => testbed.run(() async {
    environment.defines[kHasWebPlugins] = 'true';
    environment.defines[kInitializePlatform] = 'true';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Plugins
83
    expect(generated, contains("import 'package:foo/generated_plugin_registrant.dart';"));
84 85 86 87 88 89 90 91 92
    expect(generated, contains('registerPlugins(webPluginRegistry);'));

    // Platform
    expect(generated, contains('if (true) {'));

    // Main
    expect(generated, contains('entrypoint.main();'));

    // Import.
93
    expect(generated, contains("import 'package:foo/main.dart' as entrypoint;"));
94 95
  }));

96
  test('WebReleaseBundle copies dart2js output and resource files to output directory', () => testbed.run(() async {
97
    environment.defines[kBuildMode] = 'release';
98 99
    final Directory webResources = environment.projectDir.childDirectory('web');
    webResources.childFile('index.html')
100
      .createSync(recursive: true);
101
    webResources.childFile('foo.txt')
102
      .writeAsStringSync('A');
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
    environment.buildDir.childFile('main.dart.js').createSync();

    await const WebReleaseBundle().build(environment);

    expect(environment.outputDir.childFile('foo.txt')
      .readAsStringSync(), 'A');
    expect(environment.outputDir.childFile('main.dart.js')
      .existsSync(), true);
    expect(environment.outputDir.childDirectory('assets')
      .childFile('AssetManifest.json').existsSync(), true);

    // Update to arbitary resource file triggers rebuild.
    webResources.childFile('foo.txt').writeAsStringSync('B');

    await const WebReleaseBundle().build(environment);

    expect(environment.outputDir.childFile('foo.txt')
      .readAsStringSync(), 'B');
  }));

123
  test('WebEntrypointTarget generates an entrypoint for a file outside of main', () => testbed.run(() async {
124
    environment.defines[kTargetFile] = globals.fs.path.join('other', 'lib', 'main.dart');
125 126 127 128 129 130 131 132
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Import.
    expect(generated, contains("import 'file:///other/lib/main.dart' as entrypoint;"));
  }));

133 134 135 136 137 138 139 140 141
  test('WebEntrypointTarget generates a plugin registrant for a file outside of main', () => testbed.run(() async {
    environment.defines[kTargetFile] = globals.fs.path.join('other', 'lib', 'main.dart');
    environment.defines[kHasWebPlugins] = 'true';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Import.
    expect(generated, contains("import 'file:///other/lib/main.dart' as entrypoint;"));
142
    expect(generated, contains("import 'package:foo/generated_plugin_registrant.dart';"));
143 144
  }));

145

146 147 148 149 150 151 152 153
  test('WebEntrypointTarget generates an entrypoint with plugins and init platform on windows', () => testbed.run(() async {
    environment.defines[kHasWebPlugins] = 'true';
    environment.defines[kInitializePlatform] = 'true';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Plugins
154
    expect(generated, contains("import 'package:foo/generated_plugin_registrant.dart';"));
155 156 157 158 159 160 161 162 163
    expect(generated, contains('registerPlugins(webPluginRegistry);'));

    // Platform
    expect(generated, contains('if (true) {'));

    // Main
    expect(generated, contains('entrypoint.main();'));

    // Import.
164
    expect(generated, contains("import 'package:foo/main.dart' as entrypoint;"));
165
  }, overrides: <Type, Generator>{
166
    Platform: () => windows,
167 168 169 170 171 172 173 174 175 176
  }));

  test('WebEntrypointTarget generates an entrypoint without plugins and init platform', () => testbed.run(() async {
    environment.defines[kHasWebPlugins] = 'false';
    environment.defines[kInitializePlatform] = 'true';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Plugins
177
    expect(generated, isNot(contains("import 'package:foo/generated_plugin_registrant.dart';")));
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
    expect(generated, isNot(contains('registerPlugins(webPluginRegistry);')));

    // Platform
    expect(generated, contains('if (true) {'));

    // Main
    expect(generated, contains('entrypoint.main();'));
  }));

  test('WebEntrypointTarget generates an entrypoint with plugins and without init platform', () => testbed.run(() async {
    environment.defines[kHasWebPlugins] = 'true';
    environment.defines[kInitializePlatform] = 'false';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Plugins
195
    expect(generated, contains("import 'package:foo/generated_plugin_registrant.dart';"));
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    expect(generated, contains('registerPlugins(webPluginRegistry);'));

    // Platform
    expect(generated, contains('if (false) {'));

    // Main
    expect(generated, contains('entrypoint.main();'));
  }));

  test('WebEntrypointTarget generates an entrypoint without plugins and without init platform', () => testbed.run(() async {
    environment.defines[kHasWebPlugins] = 'false';
    environment.defines[kInitializePlatform] = 'false';
    await const WebEntrypointTarget().build(environment);

    final String generated = environment.buildDir.childFile('main.dart').readAsStringSync();

    // Plugins
213
    expect(generated, isNot(contains("import 'package:foo/generated_plugin_registrant.dart';")));
214 215 216 217 218 219 220 221 222
    expect(generated, isNot(contains('registerPlugins(webPluginRegistry);')));

    // Platform
    expect(generated, contains('if (false) {'));

    // Main
    expect(generated, contains('entrypoint.main();'));
  }));

223 224 225
  test('Dart2JSTarget calls dart2js with expected args with csp', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'profile';
    environment.defines[kCspMode] = 'true';
226 227 228 229 230
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
231 232
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.profile=true',
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O4',
        '-Ddart.vm.profile=true',
        '--no-minify',
        '--csp',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
249

250
    await const Dart2JSTarget().build(environment);
251
  }, overrides: <Type, Generator>{
252
    ProcessManager: () => processManager,
253 254 255
  }));


256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
  test('Dart2JSTarget calls dart2js with expected args with enabled experiment', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'profile';
    environment.defines[kEnableExperiment] = 'non-nullable';
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '--enable-experiment=non-nullable',
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.profile=true',
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '--enable-experiment=non-nullable',
        '-O4',
        '-Ddart.vm.profile=true',
        '--no-minify',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));

    await const Dart2JSTarget().build(environment);
  }, overrides: <Type, Generator>{
    ProcessManager: () => processManager,
  }));

289 290
  test('Dart2JSTarget calls dart2js with expected args in profile mode', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'profile';
291 292 293 294 295
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
296 297
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.profile=true',
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O4',
        '-Ddart.vm.profile=true',
        '--no-minify',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
313

314
    await const Dart2JSTarget().build(environment);
315
  }, overrides: <Type, Generator>{
316
    ProcessManager: () => processManager,
317 318 319 320
  }));

  test('Dart2JSTarget calls dart2js with expected args in release mode', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'release';
321 322 323 324 325
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
326 327
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.product=true',
328 329 330 331 332 333 334 335 336 337 338 339 340 341
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O4',
        '-Ddart.vm.product=true',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
342

343
    await const Dart2JSTarget().build(environment);
344
  }, overrides: <Type, Generator>{
345
    ProcessManager: () => processManager,
346 347 348 349 350
  }));

  test('Dart2JSTarget calls dart2js with expected args in release with dart2js optimization override', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'release';
    environment.defines[kDart2jsOptimization] = 'O3';
351 352 353 354 355
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
356 357
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.product=true',
358 359 360 361 362 363 364 365 366 367 368 369 370 371
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O3',
        '-Ddart.vm.product=true',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
372

373
    await const Dart2JSTarget().build(environment);
374
  }, overrides: <Type, Generator>{
375
    ProcessManager: () => processManager,
376
  }));
377 378 379

  test('Dart2JSTarget produces expected depfile', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'release';
380
    when(globals.processManager.run(any)).thenAnswer((Invocation invocation) async {
381
      environment.buildDir.childFile('app.dill.deps')
382
        .writeAsStringSync('file:///a.dart');
383 384 385 386
      return FakeProcessResult(exitCode: 0);
    });
    await const Dart2JSTarget().build(environment);

387
    expect(environment.buildDir.childFile('dart2js.d'), exists);
388
    final Depfile depfile = depfileService.parse(environment.buildDir.childFile('dart2js.d'));
389

390
    expect(depfile.inputs.single.path, globals.fs.path.absolute('a.dart'));
391 392 393 394 395
    expect(depfile.outputs.single.path,
      environment.buildDir.childFile('main.dart.js').absolute.path);
  }, overrides: <Type, Generator>{
    ProcessManager: () => MockProcessManager(),
  }));
396 397 398

  test('Dart2JSTarget calls dart2js with Dart defines in release mode', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'release';
399
    environment.defines[kDartDefines] = 'FOO=bar,BAZ=qux';
400 401 402 403 404
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
405 406
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.product=true',
407 408
        '-DFOO=bar',
        '-DBAZ=qux',
409
       '--cfe-only',
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O4',
        '-Ddart.vm.product=true',
        '-DFOO=bar',
        '-DBAZ=qux',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
425

426
    await const Dart2JSTarget().build(environment);
427
  }, overrides: <Type, Generator>{
428
    ProcessManager: () => processManager,
429 430 431 432
  }));

  test('Dart2JSTarget calls dart2js with Dart defines in profile mode', () => testbed.run(() async {
    environment.defines[kBuildMode] = 'profile';
433
    environment.defines[kDartDefines] = 'FOO=bar,BAZ=qux';
434 435 436 437 438
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-o',
        environment.buildDir.childFile('app.dill').absolute.path,
439 440
        '--packages=${globals.fs.path.join('foo', '.packages')}',
        '-Ddart.vm.profile=true',
441 442
        '-DFOO=bar',
        '-DBAZ=qux',
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
        '--cfe-only',
        environment.buildDir.childFile('main.dart').absolute.path,
      ]
    ));
    processManager.addCommand(FakeCommand(
      command: <String>[
        ...kDart2jsLinuxArgs,
        '-O4',
        '-Ddart.vm.profile=true',
        '-DFOO=bar',
        '-DBAZ=qux',
        '--no-minify',
        '-o',
        environment.buildDir.childFile('main.dart.js').absolute.path,
        environment.buildDir.childFile('app.dill').absolute.path,
      ]
    ));
460

461
    await const Dart2JSTarget().build(environment);
462
  }, overrides: <Type, Generator>{
463
    ProcessManager: () => processManager,
464 465
  }));

466 467 468 469 470 471 472
  test('Generated service worker correctly inlines file hashes', () {
    final String result = generateServiceWorker(<String, String>{'/foo': 'abcd'});

    expect(result, contains('{\n  "/foo": "abcd"\n};'));
  });

  test('WebServiceWorker generates a service_worker for a web resource folder', () => testbed.run(() async {
473
    environment.outputDir.childDirectory('a').childFile('a.txt')
474 475 476 477 478 479 480
      ..createSync(recursive: true)
      ..writeAsStringSync('A');
    await const WebServiceWorker().build(environment);

    expect(environment.outputDir.childFile('flutter_service_worker.js'), exists);
    // Contains file hash.
    expect(environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(),
481
      contains('"a/a.txt": "7fc56270e7a70fa81a5935b72eacbe29"'));
482 483
    expect(environment.buildDir.childFile('service_worker.d'), exists);
    // Depends on resource file.
484
    expect(environment.buildDir.childFile('service_worker.d').readAsStringSync(), contains('a/a.txt'));
485
  }));
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

  test('WebServiceWorker contains baseUrl cache', () => testbed.run(() async {
    environment.outputDir
      .childFile('index.html')
      .createSync(recursive: true);
    await const WebServiceWorker().build(environment);

    expect(environment.outputDir.childFile('flutter_service_worker.js'), exists);
    // Contains file hash for both `/` and index.html.
    expect(environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(),
      contains('"/": "d41d8cd98f00b204e9800998ecf8427e"'));
    expect(environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(),
      contains('"index.html": "d41d8cd98f00b204e9800998ecf8427e"'));
    expect(environment.buildDir.childFile('service_worker.d'), exists);
  }));
501 502 503
}

class MockProcessManager extends Mock implements ProcessManager {}
504
class MockArtifacts extends Mock implements Artifacts {}