test_compiler.dart 7.08 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 8 9 10 11 12 13 14 15
import 'dart:async';

import 'package:meta/meta.dart';

import '../artifacts.dart';
import '../base/file_system.dart';
import '../build_info.dart';
import '../bundle.dart';
import '../compile.dart';
16
import '../globals_null_migrated.dart' as globals;
17 18 19
import '../project.dart';

/// A request to the [TestCompiler] for recompilation.
20 21
class CompilationRequest {
  CompilationRequest(this.mainUri, this.result);
22 23

  Uri mainUri;
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
  Completer<String> result;
}

/// A frontend_server wrapper for the flutter test runner.
///
/// This class is a wrapper around compiler that allows multiple isolates to
/// enqueue compilation requests, but ensures only one compilation at a time.
class TestCompiler {
  /// Creates a new [TestCompiler] which acts as a frontend_server proxy.
  ///
  /// [trackWidgetCreation] configures whether the kernel transform is applied
  /// to the output. This also changes the output file to include a '.track`
  /// extension.
  ///
  /// [flutterProject] is the project for which we are running tests.
39 40 41
  ///
  /// If [precompiledDillPath] is passed, it will be used to initialize the
  /// compiler.
42
  TestCompiler(
43
    this.buildInfo,
44
    this.flutterProject,
45 46
    { String precompiledDillPath }
  ) : testFilePath = precompiledDillPath ?? globals.fs.path.join(
47 48 49 50 51 52 53
        flutterProject.directory.path,
        getBuildDirectory(),
        'test_cache',
        getDefaultCachedKernelPath(
          trackWidgetCreation: buildInfo.trackWidgetCreation,
          dartDefines: buildInfo.dartDefines,
          extraFrontEndOptions: buildInfo.extraFrontEndOptions,
54 55
        )),
       shouldCopyDillFile = precompiledDillPath == null {
56 57 58
    // Compiler maintains and updates single incremental dill file.
    // Incremental compilation requests done for each test copy that file away
    // for independent execution.
59
    final Directory outputDillDirectory = globals.fs.systemTempDirectory.createTempSync('flutter_test_compiler.');
60
    outputDill = outputDillDirectory.childFile('output.dill');
61 62
    globals.printTrace('Compiler will use the following file as its incremental dill file: ${outputDill.path}');
    globals.printTrace('Listening to compiler controller...');
63
    compilerController.stream.listen(_onCompilationRequest, onDone: () {
64
      globals.printTrace('Deleting ${outputDillDirectory.path}...');
65 66 67 68
      outputDillDirectory.deleteSync(recursive: true);
    });
  }

69 70
  final StreamController<CompilationRequest> compilerController = StreamController<CompilationRequest>();
  final List<CompilationRequest> compilationQueue = <CompilationRequest>[];
71
  final FlutterProject flutterProject;
72
  final BuildInfo buildInfo;
73
  final String testFilePath;
74
  final bool shouldCopyDillFile;
75 76 77 78 79


  ResidentCompiler compiler;
  File outputDill;

80
  Future<String> compile(Uri mainDart) {
81
    final Completer<String> completer = Completer<String>();
82 83 84
    if (compilerController.isClosed) {
      return null;
    }
85
    compilerController.add(CompilationRequest(mainDart, completer));
86 87 88 89 90 91 92 93 94 95 96 97 98 99
    return completer.future;
  }

  Future<void> _shutdown() async {
    // Check for null in case this instance is shut down before the
    // lazily-created compiler has been created.
    if (compiler != null) {
      await compiler.shutdown();
      compiler = null;
    }
  }

  Future<void> dispose() async {
    await compilerController.close();
100
    await _shutdown();
101 102 103 104 105
  }

  /// Create the resident compiler used to compile the test.
  @visibleForTesting
  Future<ResidentCompiler> createCompiler() async {
106
    final ResidentCompiler residentCompiler = ResidentCompiler(
107
      globals.artifacts.getArtifactPath(Artifact.flutterPatchedSdkPath),
108 109 110
      artifacts: globals.artifacts,
      logger: globals.logger,
      processManager: globals.processManager,
111 112
      buildMode: buildInfo.mode,
      trackWidgetCreation: buildInfo.trackWidgetCreation,
113 114
      initializeFromDill: testFilePath,
      unsafePackageSerialization: false,
115
      dartDefines: buildInfo.dartDefines,
116
      packagesPath: buildInfo.packagesPath,
117
      extraFrontEndOptions: buildInfo.extraFrontEndOptions,
118
      platform: globals.platform,
119
      testCompilation: true,
120
      fileSystem: globals.fs,
121 122
      fileSystemRoots: buildInfo.fileSystemRoots,
      fileSystemScheme: buildInfo.fileSystemScheme,
123
    );
124
    return residentCompiler;
125 126 127
  }

  // Handle a compilation request.
128
  Future<void> _onCompilationRequest(CompilationRequest request) async {
129 130 131 132 133 134 135 136 137
    final bool isEmpty = compilationQueue.isEmpty;
    compilationQueue.add(request);
    // Only trigger processing if queue was empty - i.e. no other requests
    // are currently being processed. This effectively enforces "one
    // compilation request at a time".
    if (!isEmpty) {
      return;
    }
    while (compilationQueue.isNotEmpty) {
138
      final CompilationRequest request = compilationQueue.first;
139
      globals.printTrace('Compiling ${request.mainUri}');
140 141 142 143 144 145 146
      final Stopwatch compilerTime = Stopwatch()..start();
      bool firstCompile = false;
      if (compiler == null) {
        compiler = await createCompiler();
        firstCompile = true;
      }
      final CompilerOutput compilerOutput = await compiler.recompile(
147 148
        request.mainUri,
        <Uri>[request.mainUri],
149
        outputPath: outputDill.path,
150
        packageConfig: buildInfo.packageConfig,
151
        projectRootPath: flutterProject?.directory?.absolute?.path,
152
        fs: globals.fs,
153 154 155 156 157 158 159 160 161 162 163
      );
      final String outputPath = compilerOutput?.outputFilename;

      // In case compiler didn't produce output or reported compilation
      // errors, pass [null] upwards to the consumer and shutdown the
      // compiler to avoid reusing compiler that might have gotten into
      // a weird state.
      if (outputPath == null || compilerOutput.errorCount > 0) {
        request.result.complete(null);
        await _shutdown();
      } else {
164 165 166 167 168 169 170 171 172 173 174 175 176
        if (shouldCopyDillFile) {
          final String path = request.mainUri.toFilePath(windows: globals.platform.isWindows);
          final File outputFile = globals.fs.file(outputPath);
          final File kernelReadyToRun = await outputFile.copy('$path.dill');
          final File testCache = globals.fs.file(testFilePath);
          if (firstCompile || !testCache.existsSync() || (testCache.lengthSync() < outputFile.lengthSync())) {
            // The idea is to keep the cache file up-to-date and include as
            // much as possible in an effort to re-use as many packages as
            // possible.
            if (!testCache.parent.existsSync()) {
              testCache.parent.createSync(recursive: true);
            }
            await outputFile.copy(testFilePath);
177
          }
178 179 180
          request.result.complete(kernelReadyToRun.path);
        } else {
          request.result.complete(outputPath);
181 182 183 184
        }
        compiler.accept();
        compiler.reset();
      }
185
      globals.printTrace('Compiling ${request.mainUri} took ${compilerTime.elapsedMilliseconds}ms');
186 187 188 189 190
      // Only remove now when we finished processing the element
      compilationQueue.removeAt(0);
    }
  }
}