Pass filesystem-root, filesystem-scheme options through `flutter run, build` and gradle. (#15592)

* Pass filesystem-root, filesystem-scheme options through flutter run/build/gradle.

packages/flutter_tools/gradle/flutter.gradle

@@ -260,6 +260,14 @@ class FlutterPlugin implements Plugin<Project> {
         if (project.hasProperty('preview-dart-2')) {
             previewDart2Value = project.property('preview-dart-2')
         }
+        String[] fileSystemRootsValue = null
+        if (project.hasProperty('filesystem-roots')) {
+            fileSystemRootsValue = project.property('filesystem-roots').split('\\|')
+        }
+        String fileSystemSchemeValue = null
+        if (project.hasProperty('filesystem-scheme')) {
+            fileSystemSchemeValue = project.property('filesystem-scheme')
+        }
         Boolean trackWidgetCreationValue = false
         if (project.hasProperty('track-widget-creation')) {
             trackWidgetCreationValue = project.property('track-widget-creation')
@@ -302,6 +310,8 @@ class FlutterPlugin implements Plugin<Project> {
                 localEngineSrcPath this.localEngineSrcPath
                 targetPath target
                 previewDart2 previewDart2Value
+                fileSystemRoots fileSystemRootsValue
+                fileSystemScheme fileSystemSchemeValue
                 trackWidgetCreation trackWidgetCreationValue
                 preferSharedLibrary preferSharedLibraryValue
                 targetPlatform targetPlatformValue
@@ -320,6 +330,8 @@ class FlutterPlugin implements Plugin<Project> {
                 localEngineSrcPath this.localEngineSrcPath
                 targetPath target
                 previewDart2 previewDart2Value
+                fileSystemRoots fileSystemRootsValue
+                fileSystemScheme fileSystemSchemeValue
                 trackWidgetCreation trackWidgetCreationValue
                 preferSharedLibrary preferSharedLibraryValue
                 targetPlatform targetPlatformValue
@@ -357,6 +369,10 @@ abstract class BaseFlutterTask extends DefaultTask {
     @Optional @Input
     Boolean previewDart2
     @Optional @Input
+    String[] fileSystemRoots
+    @Optional @Input
+    String fileSystemScheme
+    @Optional @Input
     Boolean trackWidgetCreation
     @Optional @Input
     Boolean preferSharedLibrary
@@ -433,6 +449,14 @@ abstract class BaseFlutterTask extends DefaultTask {
             if (previewDart2) {
                 args "--preview-dart-2"
             }
+            if (fileSystemRoots != null) {
+                for (root in fileSystemRoots) {
+                    args "--filesystem-root", root
+                }
+            }
+            if (fileSystemScheme != null) {
+                args "--filesystem-scheme", fileSystemScheme
+            }
             if (trackWidgetCreation) {
                 args "--track-widget-creation"
             }

packages/flutter_tools/lib/src/android/gradle.dart

@@ -303,6 +303,10 @@ Future<Null> _buildGradleProjectV2(String gradle, BuildInfo buildInfo, String ta
       command.add('-Pextra-front-end-options=${buildInfo.extraFrontEndOptions}');
     if (buildInfo.extraGenSnapshotOptions != null)
       command.add('-Pextra-gen-snapshot-options=${buildInfo.extraGenSnapshotOptions}');
+    if (buildInfo.fileSystemRoots != null)
+      command.add('-Pfilesystem-roots=${buildInfo.fileSystemRoots.join('|')}');
+    if (buildInfo.fileSystemScheme != null)
+      command.add('-Pfilesystem-scheme=${buildInfo.fileSystemScheme}');
   }
   if (buildInfo.preferSharedLibrary && androidSdk.ndkCompiler != null) {
     command.add('-Pprefer-shared-library=true');

packages/flutter_tools/lib/src/build_info.dart

@@ -17,6 +17,8 @@ class BuildInfo {
     this.extraGenSnapshotOptions,
     this.preferSharedLibrary,
     this.targetPlatform,
+    this.fileSystemRoots,
+    this.fileSystemScheme,
   });
 
   final BuildMode mode;
@@ -32,6 +34,9 @@ class BuildInfo {
   /// Whether build should be done using Dart2 Frontend parser.
   final bool previewDart2;
 
+  final List<String> fileSystemRoots;
+  final String fileSystemScheme;
+
   /// Whether the build should track widget creation locations.
   final bool trackWidgetCreation;
 

packages/flutter_tools/lib/src/commands/build_flx.dart

@@ -29,6 +29,18 @@ class BuildFlxCommand extends BuildSubCommand {
     );
     argParser.addOption('working-dir', defaultsTo: getAssetBuildDirectory());
     argParser.addFlag('report-licensed-packages', help: 'Whether to report the names of all the packages that are included in the application\'s LICENSE file.', defaultsTo: false);
+    argParser.addMultiOption('filesystem-root',
+        hide: !verboseHelp,
+        help: 'Specify the path, that is used as root in a virtual file system\n'
+            'for compilation. Input file name should be specified as Uri in\n'
+            'filesystem-scheme scheme. Use only in Dart 2 mode.\n'
+            'Requires --output-dill option to be explicitly specified.\n');
+
+    argParser.addOption('filesystem-scheme',
+        defaultsTo: 'org-dartlang-root',
+        hide: !verboseHelp,
+        help: 'Specify the scheme that is used for virtual file system used in\n'
+            'compilation. See more details on filesystem-root option.\n');
     usesPubOption();
   }
 
@@ -60,6 +72,8 @@ class BuildFlxCommand extends BuildSubCommand {
       precompiledSnapshot: argResults['precompiled'],
       reportLicensedPackages: argResults['report-licensed-packages'],
       trackWidgetCreation: argResults['track-widget-creation'],
+      fileSystemScheme: argResults['filesystem-scheme'],
+      fileSystemRoots: argResults['filesystem-root'],
     );
   }
 }

packages/flutter_tools/lib/src/commands/run.dart

@@ -151,6 +151,19 @@ class RunCommand extends RunCommandBase {
         hide: !verboseHelp,
         help: 'Specify the path to frontend server output kernel file.');
 
+    argParser.addMultiOption('filesystem-root',
+        hide: !verboseHelp,
+        help: 'Specify the path, that is used as root in a virtual file system\n'
+              'for compilation. Input file name should be specified as Uri in\n'
+              'filesystem-scheme scheme. Use only in Dart 2 mode.\n'
+              'Requires --output-dill option to be explicitly specified.\n');
+
+    argParser.addOption('filesystem-scheme',
+        defaultsTo: 'org-dartlang-root',
+        hide: !verboseHelp,
+        help: 'Specify the scheme that is used for virtual file system used in\n'
+            'compilation. See more details on filesystem-root option.\n');
+
     argParser.addOption(FlutterOptions.kExtraFrontEndOptions, hide: true);
     argParser.addOption(FlutterOptions.kExtraGenSnapshotOptions, hide: true);
   }
@@ -325,6 +338,8 @@ class RunCommand extends RunCommandBase {
         previewDart2: argResults['preview-dart-2'],
         trackWidgetCreation: argResults['track-widget-creation'],
         dillOutputPath: argResults['output-dill'],
+        fileSystemRoots: argResults['filesystem-root'],
+        fileSystemScheme: argResults['filesystem-scheme'],
       );
     }).toList();
 

packages/flutter_tools/lib/src/compile.dart

@@ -52,7 +52,9 @@ Future<String> compile(
     bool trackWidgetCreation: false,
     List<String> extraFrontEndOptions,
     String incrementalCompilerByteStorePath,
-    String packagesPath}) async {
+    String packagesPath,
+    List<String> fileSystemRoots,
+    String fileSystemScheme}) async {
   final String frontendServer = artifacts.getArtifactPath(
     Artifact.frontendServerSnapshotForEngineDartSdk
   );
@@ -90,9 +92,17 @@ Future<String> compile(
   if (outputFilePath != null) {
     command.addAll(<String>['--output-dill', outputFilePath]);
   }
-  if (depFilePath != null) {
+  if (depFilePath != null && fileSystemRoots == null) {
     command.addAll(<String>['--depfile', depFilePath]);
   }
+  if (fileSystemRoots != null) {
+    for (String root in fileSystemRoots) {
+      command.addAll(<String>['--filesystem-root', root]);
+    }
+  }
+  if (fileSystemScheme != null) {
+    command.addAll(<String>['--filesystem-scheme', fileSystemScheme]);
+  }
 
   if (extraFrontEndOptions != null)
     command.addAll(extraFrontEndOptions);
@@ -124,10 +134,12 @@ Future<String> compile(
 /// restarts the Flutter app.
 class ResidentCompiler {
   ResidentCompiler(this._sdkRoot, {bool trackWidgetCreation: false,
-      String packagesPath})
+      String packagesPath, List<String> fileSystemRoots, String fileSystemScheme })
     : assert(_sdkRoot != null),
       _trackWidgetCreation = trackWidgetCreation,
-      _packagesPath = packagesPath {
+      _packagesPath = packagesPath,
+      _fileSystemRoots = fileSystemRoots,
+      _fileSystemScheme = fileSystemScheme {
     // This is a URI, not a file path, so the forward slash is correct even on Windows.
     if (!_sdkRoot.endsWith('/'))
       _sdkRoot = '$_sdkRoot/';
@@ -135,6 +147,8 @@ class ResidentCompiler {
 
   final bool _trackWidgetCreation;
   final String _packagesPath;
+  final List<String> _fileSystemRoots;
+  final String _fileSystemScheme;
   String _sdkRoot;
   Process _server;
   final _StdoutHandler stdoutHandler = new _StdoutHandler();
@@ -153,11 +167,13 @@ class ResidentCompiler {
     // First time recompile is called we actually have to compile the app from
     // scratch ignoring list of invalidated files.
     if (_server == null)
-      return _compile(mainPath, outputPath, packagesFilePath);
+      return _compile(_mapFilename(mainPath), outputPath, _mapFilename(packagesFilePath));
 
     final String inputKey = new Uuid().generateV4();
-    _server.stdin.writeln('recompile ${mainPath != null ? mainPath + " ": ""}$inputKey');
-    invalidatedFiles.forEach(_server.stdin.writeln);
+    _server.stdin.writeln('recompile ${mainPath != null ? _mapFilename(mainPath) + " ": ""}$inputKey');
+    for (String uri in invalidatedFiles) {
+      _server.stdin.writeln(_mapFilename(Uri.parse(uri).toFilePath()));
+    }
     _server.stdin.writeln(inputKey);
 
     return stdoutHandler.outputFilename.future;
@@ -188,6 +204,14 @@ class ResidentCompiler {
     if (_packagesPath != null) {
       args.addAll(<String>['--packages', _packagesPath]);
     }
+    if (_fileSystemRoots != null) {
+      for (String root in _fileSystemRoots) {
+        args.addAll(<String>['--filesystem-root', root]);
+      }
+    }
+    if (_fileSystemScheme != null) {
+      args.addAll(<String>['--filesystem-scheme', _fileSystemScheme]);
+    }
     _server = await processManager.start(args);
     _server.stdout
       .transform(utf8.decoder)
@@ -233,4 +257,15 @@ class ResidentCompiler {
   void reset() {
     _server.stdin.writeln('reset');
   }
+
+  String _mapFilename(String filename) {
+    if (_fileSystemRoots != null) {
+      for (String root in _fileSystemRoots) {
+        if (filename.startsWith(root)) {
+          return new Uri(scheme: _fileSystemScheme, path: filename.substring(root.length)).toString();
+        }
+      }
+    }
+    return filename;
+  }
 }

packages/flutter_tools/lib/src/flx.dart

@@ -44,6 +44,8 @@ Future<Null> build({
   bool precompiledSnapshot: false,
   bool reportLicensedPackages: false,
   bool trackWidgetCreation: false,
+  List<String> fileSystemRoots,
+  String fileSystemScheme,
 }) async {
   outputPath ??= defaultFlxOutputPath;
   snapshotPath ??= defaultSnapshotPath;
@@ -82,6 +84,9 @@ Future<Null> build({
       outputFilePath: applicationKernelFilePath,
       depFilePath: depfilePath,
       trackWidgetCreation: trackWidgetCreation,
+      fileSystemRoots: fileSystemRoots,
+      fileSystemScheme: fileSystemScheme,
+      packagesPath: packagesPath,
     );
     if (kernelBinaryFilename == null) {
       throwToolExit('Compiler terminated unexpectedly on $mainPath');

packages/flutter_tools/lib/src/resident_runner.dart

@@ -36,6 +36,8 @@ class FlutterDevice {
   ApplicationPackage package;
   ResidentCompiler generator;
   String dillOutputPath;
+  List<String> fileSystemRoots;
+  String fileSystemScheme;
 
   StreamSubscription<String> _loggingSubscription;
 
@@ -43,11 +45,14 @@ class FlutterDevice {
     @required bool previewDart2,
     @required bool trackWidgetCreation,
     this.dillOutputPath,
+    this.fileSystemRoots,
+    this.fileSystemScheme,
   }) {
     if (previewDart2) {
       generator = new ResidentCompiler(
         artifacts.getArtifactPath(Artifact.flutterPatchedSdkPath),
         trackWidgetCreation: trackWidgetCreation,
+        fileSystemRoots: fileSystemRoots, fileSystemScheme: fileSystemScheme
       );
     }
   }

packages/flutter_tools/lib/src/run_hot.dart

@@ -392,7 +392,7 @@ class HotRunner extends ResidentRunner {
     // We are now running from source.
     _runningFromSnapshot = false;
     final String launchPath = debuggingOptions.buildInfo.previewDart2
-        ? dillOutputPath ?? mainPath + '.dill'
+        ? mainPath + '.dill'
         : mainPath;
     await _launchFromDevFS(launchPath);
     restartTimer.stop();

packages/flutter_tools/lib/src/runner/flutter_command.dart

@@ -61,6 +61,8 @@ class FlutterCommandResult {
 class FlutterOptions {
   static const String kExtraFrontEndOptions = 'extra-front-end-options';
   static const String kExtraGenSnapshotOptions = 'extra-gen-snapshot-options';
+  static const String kFileSystemRoot = 'filesystem-root';
+  static const String kFileSystemScheme = 'filesystem-scheme';
 }
 
 abstract class FlutterCommand extends Command<Null> {
@@ -194,7 +196,12 @@ abstract class FlutterCommand extends Command<Null> {
       preferSharedLibrary: argParser.options.containsKey('prefer-shared-library')
         ? argResults['prefer-shared-library']
         : false,
-      targetPlatform: targetPlatform);
+      targetPlatform: targetPlatform,
+      fileSystemRoots: argParser.options.containsKey(FlutterOptions.kFileSystemRoot)
+          ? argResults[FlutterOptions.kFileSystemRoot] : null,
+      fileSystemScheme: argParser.options.containsKey(FlutterOptions.kFileSystemScheme)
+          ? argResults[FlutterOptions.kFileSystemScheme] : null,
+    );
   }
 
   void setupApplicationPackages() {

packages/flutter_tools/test/compile_test.dart

@@ -5,6 +5,7 @@
 import 'dart:async';
 import 'dart:convert';
 
+import 'package:flutter_tools/src/base/file_system.dart' show fs;
 import 'package:flutter_tools/src/base/io.dart';
 import 'package:flutter_tools/src/base/context.dart';
 import 'package:flutter_tools/src/base/logger.dart';
@@ -227,7 +228,8 @@ Future<Null> _recompile(StreamController<List<int>> streamController,
   final String output = await generator.recompile(null /* mainPath */, <String>['/path/to/main.dart']);
   expect(output, equals('/path/to/main.dart.dill'));
   final String commands = mockFrontendServerStdIn.getAndClear();
-  final RegExp re = new RegExp(r'^recompile (.*)\n/path/to/main.dart\n(.*)\n$');
+  final String sep = fs.path.separator;
+  final RegExp re = new RegExp('^recompile (.*)\\n\\${sep}path\\${sep}to\\${sep}main.dart\\n(.*)\\n\$');
   expect(commands, matches(re));
   final Match match = re.firstMatch(commands);
   expect(match[1] == match[2], isTrue);