// 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. import 'dart:async'; import 'package:meta/meta.dart'; import 'package:package_config/package_config.dart'; import 'package:usage/uuid/uuid.dart'; import 'artifacts.dart'; import 'base/common.dart'; import 'base/context.dart'; import 'base/io.dart'; import 'base/terminal.dart'; import 'build_info.dart'; import 'codegen.dart'; import 'convert.dart'; import 'globals.dart' as globals; import 'project.dart'; KernelCompilerFactory get kernelCompilerFactory => context.get(); class KernelCompilerFactory { const KernelCompilerFactory(); Future create(FlutterProject flutterProject) async { if (flutterProject == null || !flutterProject.hasBuilders) { return const KernelCompiler(); } return const CodeGeneratingKernelCompiler(); } } typedef CompilerMessageConsumer = void Function(String message, { bool emphasis, TerminalColor color }); /// The target model describes the set of core libraries that are available within /// the SDK. class TargetModel { /// Parse a [TargetModel] from a raw string. /// /// Throws an [AssertionError] if passed a value other than 'flutter' or /// 'flutter_runner'. factory TargetModel(String rawValue) { switch (rawValue) { case 'flutter': return flutter; case 'flutter_runner': return flutterRunner; case 'vm': return vm; case 'dartdevc': return dartdevc; } assert(false); return null; } const TargetModel._(this._value); /// The flutter patched dart SDK static const TargetModel flutter = TargetModel._('flutter'); /// The fuchsia patched SDK. static const TargetModel flutterRunner = TargetModel._('flutter_runner'); /// The Dart vm. static const TargetModel vm = TargetModel._('vm'); /// The development compiler for JavaScript. static const TargetModel dartdevc = TargetModel._('dartdevc'); final String _value; @override String toString() => _value; } class CompilerOutput { const CompilerOutput(this.outputFilename, this.errorCount, this.sources); final String outputFilename; final int errorCount; final List sources; } enum StdoutState { CollectDiagnostic, CollectDependencies } /// Handles stdin/stdout communication with the frontend server. class StdoutHandler { StdoutHandler({this.consumer = globals.printError}) { reset(); } bool compilerMessageReceived = false; final CompilerMessageConsumer consumer; String boundaryKey; StdoutState state = StdoutState.CollectDiagnostic; Completer compilerOutput; final List sources = []; bool _suppressCompilerMessages; bool _expectSources; bool _badState = false; void handler(String message) { if (_badState) { return; } const String kResultPrefix = 'result '; if (boundaryKey == null && message.startsWith(kResultPrefix)) { boundaryKey = message.substring(kResultPrefix.length); return; } // Invalid state, see commented issue below for more information. // NB: both the completeError and _badState flags are required to avoid // filling the console with exceptions. if (boundaryKey == null) { // Throwing a synchronous exception via throwToolExit will fail to cancel // the stream. Instead use completeError so that the error is returned // from the awaited future that the compiler consumers are expecting. compilerOutput.completeError(ToolExit( 'The Dart compiler encountered an internal problem. ' 'The Flutter team would greatly appreciate if you could leave a ' 'comment on the issue https://github.com/flutter/flutter/issues/35924 ' 'describing what you were doing when the crash happened.\n\n' 'Additional debugging information:\n' ' StdoutState: $state\n' ' compilerMessageReceived: $compilerMessageReceived\n' ' _expectSources: $_expectSources\n' ' sources: $sources\n' )); // There are several event turns before the tool actually exits from a // tool exception. Normally, the stream should be cancelled to prevent // more events from entering the bad state, but because the error // is coming from handler itself, there is no clean way to pipe this // through. Instead, we set a flag to prevent more messages from // registering. _badState = true; return; } if (message.startsWith(boundaryKey)) { if (_expectSources) { if (state == StdoutState.CollectDiagnostic) { state = StdoutState.CollectDependencies; return; } } if (message.length <= boundaryKey.length) { compilerOutput.complete(null); return; } final int spaceDelimiter = message.lastIndexOf(' '); compilerOutput.complete( CompilerOutput( message.substring(boundaryKey.length + 1, spaceDelimiter), int.parse(message.substring(spaceDelimiter + 1).trim()), sources)); return; } if (state == StdoutState.CollectDiagnostic) { if (!_suppressCompilerMessages) { if (compilerMessageReceived == false) { consumer('\nCompiler message:'); compilerMessageReceived = true; } consumer(message); } } else { assert(state == StdoutState.CollectDependencies); switch (message[0]) { case '+': sources.add(Uri.parse(message.substring(1))); break; case '-': sources.remove(Uri.parse(message.substring(1))); break; default: globals.printTrace('Unexpected prefix for $message uri - ignoring'); } } } // This is needed to get ready to process next compilation result output, // with its own boundary key and new completer. void reset({ bool suppressCompilerMessages = false, bool expectSources = true }) { boundaryKey = null; compilerMessageReceived = false; compilerOutput = Completer(); _suppressCompilerMessages = suppressCompilerMessages; _expectSources = expectSources; state = StdoutState.CollectDiagnostic; } } /// List the preconfigured build options for a given build mode. List buildModeOptions(BuildMode mode) { switch (mode) { case BuildMode.debug: return [ '-Ddart.vm.profile=false', '-Ddart.vm.product=false', '--bytecode-options=source-positions,local-var-info,debugger-stops,instance-field-initializers,keep-unreachable-code,avoid-closure-call-instructions', '--enable-asserts', ]; case BuildMode.profile: return [ '-Ddart.vm.profile=true', '-Ddart.vm.product=false', '--bytecode-options=source-positions', ]; case BuildMode.release: return [ '-Ddart.vm.profile=false', '-Ddart.vm.product=true', '--bytecode-options=source-positions', ]; } throw Exception('Unknown BuildMode: $mode'); } class KernelCompiler { const KernelCompiler(); Future compile({ String sdkRoot, String mainPath, String outputFilePath, String depFilePath, TargetModel targetModel = TargetModel.flutter, bool linkPlatformKernelIn = false, bool aot = false, List extraFrontEndOptions, List fileSystemRoots, String fileSystemScheme, String initializeFromDill, String platformDill, @required String packagesPath, @required BuildMode buildMode, @required bool trackWidgetCreation, @required List dartDefines, @required PackageConfig packageConfig, }) async { final String frontendServer = globals.artifacts.getArtifactPath( Artifact.frontendServerSnapshotForEngineDartSdk ); // This is a URI, not a file path, so the forward slash is correct even on Windows. if (!sdkRoot.endsWith('/')) { sdkRoot = '$sdkRoot/'; } final String engineDartPath = globals.artifacts.getArtifactPath(Artifact.engineDartBinary); if (!globals.processManager.canRun(engineDartPath)) { throwToolExit('Unable to find Dart binary at $engineDartPath'); } Uri mainUri; if (packagesPath != null) { mainUri = packageConfig.toPackageUri(globals.fs.file(mainPath).uri); } // TODO(jonahwilliams): The output file must already exist, but this seems // unnecessary. if (outputFilePath != null && !globals.fs.isFileSync(outputFilePath)) { globals.fs.file(outputFilePath).createSync(recursive: true); } final List command = [ engineDartPath, frontendServer, '--sdk-root', sdkRoot, '--target=$targetModel', '-Ddart.developer.causal_async_stacks=${buildMode == BuildMode.debug}', for (final Object dartDefine in dartDefines) '-D$dartDefine', ...buildModeOptions(buildMode), if (trackWidgetCreation) '--track-widget-creation', if (!linkPlatformKernelIn) '--no-link-platform', if (aot) ...[ '--aot', '--tfa', ], if (packagesPath != null) ...[ '--packages', packagesPath, ], if (outputFilePath != null) ...[ '--output-dill', outputFilePath, ], if (depFilePath != null && (fileSystemRoots == null || fileSystemRoots.isEmpty)) ...[ '--depfile', depFilePath, ], if (fileSystemRoots != null) for (final String root in fileSystemRoots) ...[ '--filesystem-root', root, ], if (fileSystemScheme != null) ...[ '--filesystem-scheme', fileSystemScheme, ], if (initializeFromDill != null) ...[ '--initialize-from-dill', initializeFromDill, ], if (platformDill != null) ...[ '--platform', platformDill, ], ...?extraFrontEndOptions, mainUri?.toString() ?? mainPath, ]; globals.printTrace(command.join(' ')); final Process server = await globals.processManager.start(command); final StdoutHandler _stdoutHandler = StdoutHandler(); server.stderr .transform(utf8.decoder) .listen(globals.printError); server.stdout .transform(utf8.decoder) .transform(const LineSplitter()) .listen(_stdoutHandler.handler); final int exitCode = await server.exitCode; if (exitCode == 0) { return _stdoutHandler.compilerOutput.future; } return null; } } /// Class that allows to serialize compilation requests to the compiler. abstract class _CompilationRequest { _CompilationRequest(this.completer); Completer completer; Future _run(DefaultResidentCompiler compiler); Future run(DefaultResidentCompiler compiler) async { completer.complete(await _run(compiler)); } } class _RecompileRequest extends _CompilationRequest { _RecompileRequest( Completer completer, this.mainUri, this.invalidatedFiles, this.outputPath, this.packageConfig, ) : super(completer); Uri mainUri; List invalidatedFiles; String outputPath; PackageConfig packageConfig; @override Future _run(DefaultResidentCompiler compiler) async => compiler._recompile(this); } class _CompileExpressionRequest extends _CompilationRequest { _CompileExpressionRequest( Completer completer, this.expression, this.definitions, this.typeDefinitions, this.libraryUri, this.klass, this.isStatic, ) : super(completer); String expression; List definitions; List typeDefinitions; String libraryUri; String klass; bool isStatic; @override Future _run(DefaultResidentCompiler compiler) async => compiler._compileExpression(this); } class _CompileExpressionToJsRequest extends _CompilationRequest { _CompileExpressionToJsRequest( Completer completer, this.libraryUri, this.line, this.column, this.jsModules, this.jsFrameValues, this.moduleName, this.expression, ) : super(completer); final String libraryUri; final int line; final int column; final Map jsModules; final Map jsFrameValues; final String moduleName; final String expression; @override Future _run(DefaultResidentCompiler compiler) async => compiler._compileExpressionToJs(this); } class _RejectRequest extends _CompilationRequest { _RejectRequest(Completer completer) : super(completer); @override Future _run(DefaultResidentCompiler compiler) async => compiler._reject(); } /// Wrapper around incremental frontend server compiler, that communicates with /// server via stdin/stdout. /// /// The wrapper is intended to stay resident in memory as user changes, reloads, /// restarts the Flutter app. abstract class ResidentCompiler { factory ResidentCompiler(String sdkRoot, { @required BuildMode buildMode, bool trackWidgetCreation, String packagesPath, List fileSystemRoots, String fileSystemScheme, CompilerMessageConsumer compilerMessageConsumer, String initializeFromDill, TargetModel targetModel, bool unsafePackageSerialization, List experimentalFlags, String platformDill, List dartDefines, String librariesSpec, }) = DefaultResidentCompiler; // TODO(jonahwilliams): find a better way to configure additional file system // roots from the runner. // See: https://github.com/flutter/flutter/issues/50494 void addFileSystemRoot(String root); /// If invoked for the first time, it compiles Dart script identified by /// [mainPath], [invalidatedFiles] list is ignored. /// On successive runs [invalidatedFiles] indicates which files need to be /// recompiled. If [mainPath] is [null], previously used [mainPath] entry /// point that is used for recompilation. /// Binary file name is returned if compilation was successful, otherwise /// null is returned. Future recompile( Uri mainUri, List invalidatedFiles, { @required String outputPath, @required PackageConfig packageConfig, }); Future compileExpression( String expression, List definitions, List typeDefinitions, String libraryUri, String klass, bool isStatic, ); /// Compiles [expression] in [libraryUri] at [line]:[column] to JavaScript /// in [moduleName]. /// /// Values listed in [jsFrameValues] are substituted for their names in the /// [expression]. /// /// Ensures that all [jsModules] are loaded and accessible inside the /// expression. /// /// Example values of parameters: /// [moduleName] is of the form '/packages/hello_world_main.dart' /// [jsFrameValues] is a map from js variable name to its primitive value /// or another variable name, for example /// { 'x': '1', 'y': 'y', 'o': 'null' } /// [jsModules] is a map from variable name to the module name, where /// variable name is the name originally used in JavaScript to contain the /// module object, for example: /// { 'dart':'dart_sdk', 'main': '/packages/hello_world_main.dart' } /// Returns a [CompilerOutput] including the name of the file containing the /// compilation result and a number of errors Future compileExpressionToJs( String libraryUri, int line, int column, Map jsModules, Map jsFrameValues, String moduleName, String expression, ); /// Should be invoked when results of compilation are accepted by the client. /// /// Either [accept] or [reject] should be called after every [recompile] call. void accept(); /// Should be invoked when results of compilation are rejected by the client. /// /// Either [accept] or [reject] should be called after every [recompile] call. Future reject(); /// Should be invoked when frontend server compiler should forget what was /// accepted previously so that next call to [recompile] produces complete /// kernel file. void reset(); Future shutdown(); } @visibleForTesting class DefaultResidentCompiler implements ResidentCompiler { DefaultResidentCompiler( String sdkRoot, { @required this.buildMode, this.trackWidgetCreation = true, this.packagesPath, this.fileSystemRoots, this.fileSystemScheme, CompilerMessageConsumer compilerMessageConsumer = globals.printError, this.initializeFromDill, this.targetModel = TargetModel.flutter, this.unsafePackageSerialization, this.experimentalFlags, this.platformDill, List dartDefines, this.librariesSpec, }) : assert(sdkRoot != null), _stdoutHandler = StdoutHandler(consumer: compilerMessageConsumer), dartDefines = dartDefines ?? const [], // This is a URI, not a file path, so the forward slash is correct even on Windows. sdkRoot = sdkRoot.endsWith('/') ? sdkRoot : '$sdkRoot/'; final BuildMode buildMode; final bool trackWidgetCreation; final String packagesPath; final TargetModel targetModel; final List fileSystemRoots; final String fileSystemScheme; final String initializeFromDill; final bool unsafePackageSerialization; final List experimentalFlags; final List dartDefines; final String librariesSpec; @override void addFileSystemRoot(String root) { fileSystemRoots.add(root); } /// The path to the root of the Dart SDK used to compile. /// /// This is used to resolve the [platformDill]. final String sdkRoot; /// The path to the platform dill file. /// /// This does not need to be provided for the normal Flutter workflow. final String platformDill; Process _server; final StdoutHandler _stdoutHandler; bool _compileRequestNeedsConfirmation = false; final StreamController<_CompilationRequest> _controller = StreamController<_CompilationRequest>(); @override Future recompile( Uri mainUri, List invalidatedFiles, { @required String outputPath, @required PackageConfig packageConfig, }) async { assert(outputPath != null); if (!_controller.hasListener) { _controller.stream.listen(_handleCompilationRequest); } final Completer completer = Completer(); _controller.add( _RecompileRequest(completer, mainUri, invalidatedFiles, outputPath, packageConfig) ); return completer.future; } Future _recompile(_RecompileRequest request) async { _stdoutHandler.reset(); _compileRequestNeedsConfirmation = true; if (_server == null) { return _compile( request.packageConfig.toPackageUri(request.mainUri)?.toString() ?? request.mainUri.toString(), request.outputPath, ); } final String inputKey = Uuid().generateV4(); final String mainUri = request.packageConfig.toPackageUri(request.mainUri)?.toString() ?? request.mainUri.toString(); _server.stdin.writeln('recompile $mainUri $inputKey'); globals.printTrace('<- recompile $mainUri $inputKey'); for (final Uri fileUri in request.invalidatedFiles) { String message; if (fileUri.scheme == 'package') { message = fileUri.toString(); } else { message = request.packageConfig.toPackageUri(fileUri)?.toString() ?? fileUri.toString(); } _server.stdin.writeln(message); globals.printTrace(message); } _server.stdin.writeln(inputKey); globals.printTrace('<- $inputKey'); return _stdoutHandler.compilerOutput.future; } final List<_CompilationRequest> _compilationQueue = <_CompilationRequest>[]; Future _handleCompilationRequest(_CompilationRequest request) async { 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) { while (_compilationQueue.isNotEmpty) { final _CompilationRequest request = _compilationQueue.first; await request.run(this); _compilationQueue.removeAt(0); } } } Future _compile( String scriptUri, String outputPath, ) async { final String frontendServer = globals.artifacts.getArtifactPath( Artifact.frontendServerSnapshotForEngineDartSdk ); final List command = [ globals.artifacts.getArtifactPath(Artifact.engineDartBinary), frontendServer, '--sdk-root', sdkRoot, '--incremental', '--target=$targetModel', // TODO(jonahwilliams): remove once this becomes the default behavior // in the frontend_server. // https://github.com/flutter/flutter/issues/52693 '--debugger-module-names', '-Ddart.developer.causal_async_stacks=${buildMode == BuildMode.debug}', for (final Object dartDefine in dartDefines) '-D$dartDefine', if (outputPath != null) ...[ '--output-dill', outputPath, ], if (librariesSpec != null) ...[ '--libraries-spec', librariesSpec, ], if (packagesPath != null) ...[ '--packages', packagesPath, ], ...buildModeOptions(buildMode), if (trackWidgetCreation) '--track-widget-creation', if (fileSystemRoots != null) for (final String root in fileSystemRoots) ...[ '--filesystem-root', root, ], if (fileSystemScheme != null) ...[ '--filesystem-scheme', fileSystemScheme, ], if (initializeFromDill != null) ...[ '--initialize-from-dill', initializeFromDill, ], if (platformDill != null) ...[ '--platform', platformDill, ], if (unsafePackageSerialization == true) '--unsafe-package-serialization', if ((experimentalFlags != null) && experimentalFlags.isNotEmpty) '--enable-experiment=${experimentalFlags.join(',')}', ]; globals.printTrace(command.join(' ')); _server = await globals.processManager.start(command); _server.stdout .transform(utf8.decoder) .transform(const LineSplitter()) .listen( _stdoutHandler.handler, onDone: () { // when outputFilename future is not completed, but stdout is closed // process has died unexpectedly. if (!_stdoutHandler.compilerOutput.isCompleted) { _stdoutHandler.compilerOutput.complete(null); throwToolExit('the Dart compiler exited unexpectedly.'); } }); _server.stderr .transform(utf8.decoder) .transform(const LineSplitter()) .listen((String message) { globals.printError(message); }); unawaited(_server.exitCode.then((int code) { if (code != 0) { throwToolExit('the Dart compiler exited unexpectedly.'); } })); _server.stdin.writeln('compile $scriptUri'); globals.printTrace('<- compile $scriptUri'); return _stdoutHandler.compilerOutput.future; } @override Future compileExpression( String expression, List definitions, List typeDefinitions, String libraryUri, String klass, bool isStatic, ) { if (!_controller.hasListener) { _controller.stream.listen(_handleCompilationRequest); } final Completer completer = Completer(); _controller.add( _CompileExpressionRequest( completer, expression, definitions, typeDefinitions, libraryUri, klass, isStatic) ); return completer.future; } Future _compileExpression(_CompileExpressionRequest request) async { _stdoutHandler.reset(suppressCompilerMessages: true, expectSources: false); // 'compile-expression' should be invoked after compiler has been started, // program was compiled. if (_server == null) { return null; } final String inputKey = Uuid().generateV4(); _server.stdin.writeln('compile-expression $inputKey'); _server.stdin.writeln(request.expression); request.definitions?.forEach(_server.stdin.writeln); _server.stdin.writeln(inputKey); request.typeDefinitions?.forEach(_server.stdin.writeln); _server.stdin.writeln(inputKey); _server.stdin.writeln(request.libraryUri ?? ''); _server.stdin.writeln(request.klass ?? ''); _server.stdin.writeln(request.isStatic ?? false); return _stdoutHandler.compilerOutput.future; } @override Future compileExpressionToJs( String libraryUri, int line, int column, Map jsModules, Map jsFrameValues, String moduleName, String expression, ) { if (!_controller.hasListener) { _controller.stream.listen(_handleCompilationRequest); } final Completer completer = Completer(); _controller.add( _CompileExpressionToJsRequest( completer, libraryUri, line, column, jsModules, jsFrameValues, moduleName, expression) ); return completer.future; } Future _compileExpressionToJs(_CompileExpressionToJsRequest request) async { _stdoutHandler.reset(suppressCompilerMessages: false, expectSources: false); // 'compile-expression-to-js' should be invoked after compiler has been started, // program was compiled. if (_server == null) { return null; } final String inputKey = Uuid().generateV4(); _server.stdin.writeln('compile-expression-to-js $inputKey'); _server.stdin.writeln(request.libraryUri ?? ''); _server.stdin.writeln(request.line); _server.stdin.writeln(request.column); request.jsModules?.forEach((String k, String v) { _server.stdin.writeln('$k:$v'); }); _server.stdin.writeln(inputKey); request.jsFrameValues?.forEach((String k, String v) { _server.stdin.writeln('$k:$v'); }); _server.stdin.writeln(inputKey); _server.stdin.writeln(request.moduleName ?? ''); _server.stdin.writeln(request.expression ?? ''); return _stdoutHandler.compilerOutput.future; } @override void accept() { if (_compileRequestNeedsConfirmation) { _server.stdin.writeln('accept'); globals.printTrace('<- accept'); } _compileRequestNeedsConfirmation = false; } @override Future reject() { if (!_controller.hasListener) { _controller.stream.listen(_handleCompilationRequest); } final Completer completer = Completer(); _controller.add(_RejectRequest(completer)); return completer.future; } Future _reject() { if (!_compileRequestNeedsConfirmation) { return Future.value(null); } _stdoutHandler.reset(expectSources: false); _server.stdin.writeln('reject'); globals.printTrace('<- reject'); _compileRequestNeedsConfirmation = false; return _stdoutHandler.compilerOutput.future; } @override void reset() { _server?.stdin?.writeln('reset'); globals.printTrace('<- reset'); } @override Future shutdown() async { // Server was never successfully created. if (_server == null) { return 0; } globals.printTrace('killing pid ${_server.pid}'); _server.kill(); return _server.exitCode; } }