Reland "Load parent package config" (flutter#153754)

Reverts flutter#153752
Relands flutter#150850

Now with attached g3fix

Author: sigurdm

packages/flutter_tools/bin/fuchsia_asset_builder.dart

@@ -14,6 +14,7 @@ import 'package:flutter_tools/src/bundle.dart';
 import 'package:flutter_tools/src/bundle_builder.dart';
 import 'package:flutter_tools/src/cache.dart';
 import 'package:flutter_tools/src/context_runner.dart';
+import 'package:flutter_tools/src/dart/package_map.dart';
 import 'package:flutter_tools/src/globals.dart' as globals;
 import 'package:flutter_tools/src/reporting/reporting.dart';
 
@@ -44,7 +45,7 @@ Future<void> writeAssetFile(libfs.File outputFile, AssetBundleEntry asset) async
 
 Future<void> run(List<String> args) async {
   final ArgParser parser = ArgParser()
-    ..addOption(_kOptionPackages, help: 'The .packages file')
+    ..addOption(_kOptionPackages, help: 'The .dart_tool/package_config file')
     ..addOption(_kOptionAsset,
         help: 'The directory where to put temporary files')
     ..addOption(_kOptionManifest, help: 'The manifest file')
@@ -63,7 +64,8 @@ Future<void> run(List<String> args) async {
   final AssetBundle? assets = await buildAssets(
     manifestPath: argResults[_kOptionManifest] as String? ?? defaultManifestPath,
     assetDirPath: assetDir,
-    packagesPath: argResults[_kOptionPackages] as String?,
+    packageConfigPath: argResults[_kOptionPackages] as String? ??
+        findPackageConfigFileOrDefault(globals.fs.currentDirectory).path,
     targetPlatform: TargetPlatform.fuchsia_arm64 // This is not arch specific.
   );
 

packages/flutter_tools/lib/src/asset.dart

@@ -125,7 +125,7 @@ abstract class AssetBundle {
   /// Returns 0 for success; non-zero for failure.
   Future<int> build({
     String manifestPath = defaultManifestPath,
-    required String packagesPath,
+    required String packageConfigPath,
     bool deferredComponentsEnabled = false,
     TargetPlatform? targetPlatform,
     String? flavor,
@@ -246,7 +246,7 @@ class ManifestAssetBundle implements AssetBundle {
   Future<int> build({
     String manifestPath = defaultManifestPath,
     FlutterProject? flutterProject,
-    required String packagesPath,
+    required String packageConfigPath,
     bool deferredComponentsEnabled = false,
     TargetPlatform? targetPlatform,
     String? flavor,
@@ -293,7 +293,7 @@ class ManifestAssetBundle implements AssetBundle {
     }
 
     final String assetBasePath = _fileSystem.path.dirname(_fileSystem.path.absolute(manifestPath));
-    final File packageConfigFile = _fileSystem.file(packagesPath);
+    final File packageConfigFile = _fileSystem.file(packageConfigPath);
     inputFiles.add(packageConfigFile);
     final PackageConfig packageConfig = await loadPackageConfigWithLogging(
       packageConfigFile,

packages/flutter_tools/lib/src/build_system/build_system.dart

@@ -334,6 +334,7 @@ class Environment {
   /// [engineVersion] should be set to null for local engine builds.
   factory Environment({
     required Directory projectDir,
+    required String packageConfigPath,
     required Directory outputDir,
     required Directory cacheDir,
     required Directory flutterRootDir,
@@ -374,6 +375,7 @@ class Environment {
     return Environment._(
       outputDir: outputDir,
       projectDir: projectDir,
+      packageConfigPath: packageConfigPath,
       buildDir: buildDirectory,
       rootBuildDir: rootBuildDir,
       cacheDir: cacheDir,
@@ -398,6 +400,7 @@ class Environment {
   @visibleForTesting
   factory Environment.test(Directory testDirectory, {
     Directory? projectDir,
+    String? packageConfigPath,
     Directory? outputDir,
     Directory? cacheDir,
     Directory? flutterRootDir,
@@ -416,6 +419,7 @@ class Environment {
   }) {
     return Environment(
       projectDir: projectDir ?? testDirectory,
+      packageConfigPath: packageConfigPath ?? '.dart_tool/package_config.json',
       outputDir: outputDir ?? testDirectory,
       cacheDir: cacheDir ?? testDirectory,
       flutterRootDir: flutterRootDir ?? testDirectory,
@@ -437,6 +441,7 @@ class Environment {
   Environment._({
     required this.outputDir,
     required this.projectDir,
+    required this.packageConfigPath,
     required this.buildDir,
     required this.rootBuildDir,
     required this.cacheDir,
@@ -457,6 +462,11 @@ class Environment {
   /// The [Source] value which is substituted with the path to [projectDir].
   static const String kProjectDirectory = '{PROJECT_DIR}';
 
+  /// The [Source] value which is substituted with the path to the directory
+  /// that contains `.dart_tool/package_config.json1`.
+  /// That is the grand-parent of [BuildInfo.packageConfigPath].
+  static const String kWorkspaceDirectory = '{WORKSPACE_DIR}';
+
   /// The [Source] value which is substituted with the path to [buildDir].
   static const String kBuildDirectory = '{BUILD_DIR}';
 
@@ -475,10 +485,16 @@ class Environment {
   /// can be located.
   final Directory projectDir;
 
+  /// The path to the package configuration file to use for compilation.
+  ///
+  /// This is used by package:package_config to locate the actual package_config.json
+  /// file. If not provided, defaults to `.dart_tool/package_config.json`.
+  final String packageConfigPath;
+
   /// The `BUILD_DIR` environment variable.
   ///
   /// The root of the output directory where build step intermediates and
-  /// outputs are written. Current usages of assemble configure ths to be
+  /// outputs are written. Current usages of assemble configure this to be
   /// a unique directory under `.dart_tool/flutter_build`, though it can
   /// be placed anywhere. The uniqueness is only enforced by callers, and
   /// is currently done by hashing the build configuration.

packages/flutter_tools/lib/src/build_system/source.dart

@@ -99,6 +99,12 @@ class SourceVisitor implements ResolvedFiles {
         // flutter root will not contain a symbolic link.
         Environment.kFlutterRootDirectory => environment.flutterRootDir.absolute.path,
         Environment.kProjectDirectory     => environment.projectDir.resolveSymbolicLinksSync(),
+        Environment.kWorkspaceDirectory   =>
+          environment.fileSystem.path.dirname(
+            environment.fileSystem.path.dirname(
+              environment.packageConfigPath,
+            ),
+          ),
         Environment.kBuildDirectory       => environment.buildDir.resolveSymbolicLinksSync(),
         Environment.kCacheDirectory       => environment.cacheDir.resolveSymbolicLinksSync(),
         Environment.kOutputDirectory      => environment.outputDir.resolveSymbolicLinksSync(),

packages/flutter_tools/lib/src/build_system/targets/assets.dart

@@ -11,6 +11,7 @@ import '../../base/file_system.dart';
 import '../../base/logger.dart';
 import '../../build_info.dart';
 import '../../convert.dart';
+import '../../dart/package_map.dart';
 import '../../devfs.dart';
 import '../../flutter_manifest.dart';
 import '../build_system.dart';
@@ -60,7 +61,7 @@ Future<Depfile> copyAssets(
   ).createBundle();
   final int resultCode = await assetBundle.build(
     manifestPath: pubspecFile.path,
-    packagesPath: environment.projectDir.childFile('.packages').path,
+    packageConfigPath: findPackageConfigFileOrDefault(environment.projectDir).path,
     deferredComponentsEnabled: environment.defines[kDeferredComponents] == 'true',
     targetPlatform: targetPlatform,
     flavor: flavor,

packages/flutter_tools/lib/src/build_system/targets/common.dart

@@ -181,9 +181,7 @@ class KernelSnapshotProgram extends Target {
     }
     final BuildMode buildMode = BuildMode.fromCliName(buildModeEnvironment);
     final String targetFile = environment.defines[kTargetFile] ?? environment.fileSystem.path.join('lib', 'main.dart');
-    final File packagesFile = environment.projectDir
-      .childDirectory('.dart_tool')
-      .childFile('package_config.json');
+    final File packagesFile = findPackageConfigFileOrDefault(environment.projectDir);
     final String targetFileAbsolute = environment.fileSystem.file(targetFile).absolute.path;
     // everything besides 'false' is considered to be enabled.
     final bool trackWidgetCreation = environment.defines[kTrackWidgetCreation] != 'false';
@@ -340,9 +338,7 @@ class KernelSnapshotNativeAssets extends Target {
       throw MissingDefineException(kTargetPlatform, 'kernel_snapshot');
     }
     final BuildMode buildMode = BuildMode.fromCliName(buildModeEnvironment);
-    final File packagesFile = environment.projectDir
-      .childDirectory('.dart_tool')
-      .childFile('package_config.json');
+    final File packageConfigFile = findPackageConfigFileOrDefault(environment.projectDir);
 
     final TargetPlatform targetPlatform = getTargetPlatformForName(targetPlatformEnvironment);
 
@@ -355,7 +351,7 @@ class KernelSnapshotNativeAssets extends Target {
     environment.logger.printTrace('Embedding native assets mapping $nativeAssets in kernel.');
 
     final PackageConfig packageConfig = await loadPackageConfigWithLogging(
-      packagesFile,
+      packageConfigFile,
       logger: environment.logger,
     );
 
@@ -371,7 +367,7 @@ class KernelSnapshotNativeAssets extends Target {
       buildMode: buildMode,
       trackWidgetCreation: false,
       outputFilePath: dillPath,
-      packagesPath: packagesFile.path,
+      packagesPath: packageConfigFile.path,
       frontendServerStarterPath: frontendServerStarterPath,
       packageConfig: packageConfig,
       buildDir: environment.buildDir,

packages/flutter_tools/lib/src/build_system/targets/dart_plugin_registrant.dart

@@ -31,8 +31,9 @@ class DartPluginRegistrantTarget extends Target {
     assert(environment.generateDartPluginRegistry);
     final FlutterProject project = _project
       ?? FlutterProject.fromDirectory(environment.projectDir);
+    final File packageConfigFile = findPackageConfigFileOrDefault(environment.projectDir);
     final PackageConfig packageConfig = await loadPackageConfigWithLogging(
-      project.packageConfigFile,
+      packageConfigFile,
       logger: environment.logger,
     );
     final String targetFilePath = environment.defines[kTargetFile] ??
@@ -73,7 +74,7 @@ class DartPluginRegistrantTarget extends Target {
 
   @override
   List<Source> get inputs => <Source>[
-    const Source.pattern('{PROJECT_DIR}/.dart_tool/package_config_subset'),
+    const Source.pattern('{WORKSPACE_DIR}/.dart_tool/package_config_subset'),
   ];
 
   @override

packages/flutter_tools/lib/src/build_system/targets/native_assets.dart

@@ -64,17 +64,15 @@ class NativeAssets extends Target {
       }
       final TargetPlatform targetPlatform = getTargetPlatformForName(targetPlatformEnvironment);
       final Uri projectUri = environment.projectDir.uri;
-      final File packagesFile = fileSystem
-          .directory(projectUri)
-          .childDirectory('.dart_tool')
-          .childFile('package_config.json');
+
       final PackageConfig packageConfig = await loadPackageConfigWithLogging(
-        packagesFile,
+        fileSystem.file(environment.packageConfigPath),
         logger: environment.logger,
       );
       final NativeAssetsBuildRunner buildRunner = _buildRunner ??
           NativeAssetsBuildRunnerImpl(
             projectUri,
+            environment.packageConfigPath,
             packageConfig,
             fileSystem,
             environment.logger,
@@ -380,7 +378,7 @@ class NativeAssets extends Target {
   List<Source> get inputs => const <Source>[
     Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/native_assets.dart'),
     // If different packages are resolved, different native assets might need to be built.
-    Source.pattern('{PROJECT_DIR}/.dart_tool/package_config_subset'),
+    Source.pattern('{WORKSPACE_DIR}/.dart_tool/package_config_subset'),
     // TODO(mosuem): Should consume resources.json. https://github.com/flutter/flutter/issues/146263
   ];
 

packages/flutter_tools/lib/src/build_system/targets/web.dart

@@ -54,10 +54,10 @@ class WebEntrypointTarget extends Target {
   Future<void> build(Environment environment) async {
     final String? targetFile = environment.defines[kTargetFile];
     final Uri importUri = environment.fileSystem.file(targetFile).absolute.uri;
-    // TODO(zanderso): support configuration of this file.
-    const String packageFile = '.packages';
+    final File packageConfigFile = findPackageConfigFileOrDefault(environment.projectDir);
+
     final PackageConfig packageConfig = await loadPackageConfigWithLogging(
-      environment.fileSystem.file(packageFile),
+      packageConfigFile,
       logger: environment.logger,
     );
     final FlutterProject flutterProject = FlutterProject.current();
@@ -129,7 +129,7 @@ abstract class Dart2WebTarget extends Target {
     compilerSnapshot,
     const Source.artifact(Artifact.engineDartBinary),
     const Source.pattern('{BUILD_DIR}/main.dart'),
-    const Source.pattern('{PROJECT_DIR}/.dart_tool/package_config_subset'),
+    const Source.pattern('{WORKSPACE_DIR}/.dart_tool/package_config_subset'),
   ];
 
   @override
@@ -188,7 +188,7 @@ class Dart2JSTarget extends Dart2WebTarget {
       ...compilerConfig.toSharedCommandOptions(buildMode),
       '-o',
       environment.buildDir.childFile('app.dill').path,
-      '--packages=.dart_tool/package_config.json',
+      '--packages=${findPackageConfigFileOrDefault(environment.projectDir).path}',
       '--cfe-only',
       environment.buildDir.childFile('main.dart').path, // dartfile
     ];
@@ -302,7 +302,7 @@ class Dart2WasmTarget extends Dart2WebTarget {
       artifacts.getArtifactPath(Artifact.engineDartBinary, platform: TargetPlatform.web_javascript),
       'compile',
       'wasm',
-      '--packages=.dart_tool/package_config.json',
+      '--packages=${findPackageConfigFileOrDefault(environment.projectDir).path}',
       '--extra-compiler-option=--platform=$platformFilePath',
       '--extra-compiler-option=--delete-tostring-package-uri=dart:ui',
       '--extra-compiler-option=--delete-tostring-package-uri=package:flutter',

packages/flutter_tools/lib/src/bundle_builder.dart

@@ -55,6 +55,7 @@ class BundleBuilder {
     // If the precompiled flag was not passed, force us into debug mode.
     final Environment environment = Environment(
       projectDir: project.directory,
+      packageConfigPath: buildInfo.packageConfigPath,
       outputDir: globals.fs.directory(assetDirPath),
       buildDir: project.dartTool.childDirectory('flutter_build'),
       cacheDir: globals.cache.getRoot(),
@@ -115,18 +116,17 @@ class BundleBuilder {
 Future<AssetBundle?> buildAssets({
   required String manifestPath,
   String? assetDirPath,
-  String? packagesPath,
+  required String packageConfigPath,
   TargetPlatform? targetPlatform,
   String? flavor,
 }) async {
   assetDirPath ??= getAssetBuildDirectory();
-  packagesPath ??= globals.fs.path.absolute('.packages');
 
   // Build the asset bundle.
   final AssetBundle assetBundle = AssetBundleFactory.instance.createBundle();
   final int result = await assetBundle.build(
     manifestPath: manifestPath,
-    packagesPath: packagesPath,
+    packageConfigPath: packageConfigPath,
     targetPlatform: targetPlatform,
     flavor: flavor,
   );