stop reading .packages files, dont require them to exist at all (#3306)

_test/test/common/utils.dart

@@ -34,7 +34,7 @@ Future<void> startServer({bool? ensureCleanBuild, List<String>? buildArgs}) =>
     _startServer(
       'dart',
       [
-        '--packages=.packages',
+        '--packages=.dart_tool/package_config.json',
         p.join('..', 'build_runner', 'bin', 'build_runner.dart'),
         'serve',
         '--verbose',

build_runner/CHANGELOG.md

@@ -1,5 +1,6 @@
-## 2.1.11-dev
+## 2.1.11
 
+- Stop reading or requiring `.packages` files.
 - Use an explicit `dynamic` generic type for collections in default builder
   options to reduce behavior differences between reading default options and
   user provided options.

build_runner/lib/src/entrypoint/run_script.dart

@@ -141,7 +141,8 @@ class RunCommand extends BuildRunnerCommand {
 
         // Find the path of the script to run.
         var scriptPath = p.join(tempPath, scriptName);
-        var packageConfigPath = p.join(tempPath, '.packages');
+        var packageConfigPath =
+            p.join(tempPath, '.dart_tool/package_config.json');
 
         onExit = ReceivePort();
         onError = ReceivePort();

build_runner/lib/src/generate/build.dart

@@ -26,7 +26,7 @@ import 'watch_impl.dart' as watch_impl;
 /// A [packageGraph] may be supplied, otherwise one will be constructed using
 /// [PackageGraph.forThisPackage]. The default functionality assumes you are
 /// running in the root directory of a package, with both a `pubspec.yaml` and
-/// `.packages` file present.
+/// `.dart_tool/package_config.json` file present.
 ///
 /// A [reader] and [writer] may also be supplied, which can read/write assets
 /// to arbitrary locations or file systems. By default they will write directly

build_runner/lib/src/generate/watch_impl.dart

@@ -255,9 +255,7 @@ class WatchImpl implements BuildState {
       _logger.info('Terminating. No further builds will be scheduled\n');
     });
 
-    Digest? originalRootPackagesDigest;
     Digest? originalRootPackageConfigDigest;
-    final rootPackagesId = AssetId(packageGraph.root.name, '.packages');
     final rootPackageConfigId =
         AssetId(packageGraph.root.name, '.dart_tool/package_config.json');
 
@@ -275,11 +273,8 @@ class WatchImpl implements BuildState {
         })
         .asyncMap<AssetChange>((change) {
           var id = change.id;
-          if (id == rootPackagesId || id == rootPackageConfigId) {
-            var digest = id == rootPackagesId
-                ? originalRootPackagesDigest
-                : originalRootPackageConfigDigest;
-            assert(digest != null);
+          if (id == rootPackageConfigId) {
+            var digest = originalRootPackageConfigDigest!;
             // Kill future builds if the root packages file changes.
             //
             // We retry the reads for a little bit to handle the case where a
@@ -337,8 +332,6 @@ class WatchImpl implements BuildState {
     () async {
       await logTimedAsync(_logger, 'Waiting for all file watchers to be ready',
           () => graphWatcher.ready);
-      originalRootPackagesDigest = md5
-          .convert(await watcherEnvironment.reader.readAsBytes(rootPackagesId));
       originalRootPackageConfigDigest = md5.convert(
           await watcherEnvironment.reader.readAsBytes(rootPackageConfigId));
 

build_runner/pubspec.yaml

@@ -1,5 +1,5 @@
 name: build_runner
-version: 2.1.11-dev
+version: 2.1.11
 description: A build system for Dart code generation and modular compilation.
 repository: https://github.com/dart-lang/build/tree/master/build_runner
 

build_runner/test/generate/build_test.dart

@@ -21,10 +21,6 @@ void main() {
 
   setUp(() async {
     writer = InMemoryRunnerAssetWriter();
-    await writer.writeAsString(makeAssetId('a|.packages'), '''
-# Fake packages file
-a:file://fake/pkg/path
-''');
     await writer.writeAsString(packageConfigId, jsonEncode(_packageConfig));
   });
 

build_runner/test/generate/serve_test.dart

@@ -22,10 +22,6 @@ void main() {
     setUp(() async {
       _terminateServeController = StreamController();
       writer = InMemoryRunnerAssetWriter();
-      await writer.writeAsString(makeAssetId('a|.packages'), '''
-# Fake packages file
-a:file://fake/pkg/path
-''');
       await writer.writeAsString(
           makeAssetId('a|.dart_tool/package_config.json'),
           jsonEncode({

build_runner/test/generate/watch_test.dart

@@ -30,10 +30,6 @@ void main() {
 
   setUp(() async {
     writer = InMemoryRunnerAssetWriter();
-    await writer.writeAsString(makeAssetId('a|.packages'), '''
-# Fake packages file
-a:file://fake/pkg/path
-''');
     await writer.writeAsString(packageConfigId, jsonEncode(_packageConfig));
   });
 
@@ -364,30 +360,6 @@ a:file://fake/pkg/path
         checkBuild(result, outputs: {'a|web/a.txt.copy': 'b'}, writer: writer);
       });
 
-      test('edits to .packages prevent future builds and ask you to restart',
-          () async {
-        var logs = <LogRecord>[];
-        var buildState = await startWatch(
-            [copyABuildApplication], {'a|web/a.txt': 'a'}, writer,
-            logLevel: Level.SEVERE, onLog: logs.add);
-        var results = StreamQueue(buildState.buildResults);
-
-        var result = await results.next;
-        checkBuild(result, outputs: {'a|web/a.txt.copy': 'a'}, writer: writer);
-
-        await writer.writeAsString(AssetId('a', '.packages'), '''
-# Fake packages file
-a:file://different/fake/pkg/path
-''');
-
-        expect(await results.hasNext, isFalse);
-        expect(logs, hasLength(1));
-        expect(
-            logs.first.message,
-            contains('Terminating builds due to package graph update, '
-                'please restart the build.'));
-      });
-
       test(
           'edits to .dart_tool/package_config.json prevent future builds '
           'and ask you to restart', () async {

build_runner/test/server/serve_integration_test.dart

@@ -35,10 +35,6 @@ void main() {
       ..cacheStringAsset(AssetId('example', 'web/initial.txt'), 'initial')
       ..cacheStringAsset(AssetId('example', 'web/large.txt'),
           List.filled(10000, 'large').join(''))
-      ..cacheStringAsset(
-          AssetId('example', '.packages'),
-          '# Fake packages file\n'
-          'example:file://fake/pkg/path')
       ..cacheStringAsset(
           makeAssetId('example|.dart_tool/package_config.json'),
           jsonEncode({

build_runner_core/test/environment/create_merged_dir_test.dart

@@ -205,7 +205,6 @@ void main() {
         'packages/a/a.txt.copy': 'a',
         'packages/b/c.txt': 'c',
         'packages/b/c.txt.copy': 'c',
-        '.packages': 'a:packages/a/\r\nb:packages/b/\r\n\$sdk:packages/\$sdk/',
         '.dart_tool/package_config.json':
             _expectedPackageConfig('a', ['a', 'b']),
       };
@@ -290,7 +289,6 @@ void main() {
         'packages/a/a.txt': 'a',
         'packages/b/c.txt': 'c',
         'web/b.txt': 'b',
-        '.packages': 'a:packages/a/\r\nb:packages/b/\r\n\$sdk:packages/\$sdk/',
         '.dart_tool/package_config.json':
             _expectedPackageConfig('a', ['a', 'b'])
       };
@@ -477,7 +475,6 @@ void _expectAllFiles(Directory dir) {
     'packages/b/c.txt.copy': 'c',
     'web/b.txt': 'b',
     'web/b.txt.copy': 'b',
-    '.packages': 'a:packages/a/\r\nb:packages/b/\r\n\$sdk:packages/\$sdk/',
     '.dart_tool/package_config.json': _expectedPackageConfig('a', ['a', 'b'])
   };
   _expectFiles(expectedFiles, dir);

build_runner_core/test/generate/build_definition_test.dart

@@ -77,7 +77,6 @@ void main() {
         'pkg_a',
         [
           await pubspec('a'),
-          d.file('.packages', '\na:./lib/\nb:../pkg_b/lib/'),
           d.file('pubspec.lock', 'packages: {}'),
           d.dir('.dart_tool', [
             d.dir('build', [
@@ -594,8 +593,6 @@ targets:
             'pubspec.yaml',
             (await readFile('pubspec.yaml'))
                 .replaceFirst('name: a', 'name: c'));
-        await modifyFile('.packages',
-            (await readFile('.packages')).replaceFirst('a:', 'c:'));
         await modifyFile(
             '.dart_tool/package_config.json',
             (await readFile('.dart_tool/package_config.json'))

build_runner_core/test/package_graph/package_graph_test.dart

@@ -128,7 +128,7 @@ void main() {
           throwsA(anything));
     });
 
-    test('missing .packages file throws on create', () {
+    test('missing .dart_tool/package_config.json file throws on create', () {
       expect(
           () => PackageGraph.forPath(
               p.join('test', 'fixtures', 'no_packages_file')),

build_test/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 2.1.6-dev
+
 ## 2.1.5
 
 - Allow the latest analyzer.

build_test/lib/src/package_reader.dart

@@ -15,8 +15,8 @@ import 'package:stream_transform/stream_transform.dart';
 /// Resolves using a [PackageConfig] before reading from the file system.
 ///
 /// For a simple implementation that uses the current isolate's package
-/// resolution logic (i.e. whatever you have generated in `.packages` in most
-/// cases), use [currentIsolate]:
+/// resolution logic (i.e. whatever you have generated in
+/// `.dart_tool/package_config.json` in most cases), use [currentIsolate]:
 /// ```dart
 /// var assetReader = await PackageAssetReader.currentIsolate();
 /// ```
@@ -74,12 +74,12 @@ class PackageAssetReader extends AssetReader
   /// A [rootPackage] should be provided for full API compatibility.
   static Future<PackageAssetReader> currentIsolate(
       {String? rootPackage}) async {
-    final packageConfig = await Isolate.packageConfig ??
+    final packageConfigUri = await Isolate.packageConfig ??
         (throw UnsupportedError('No package config found'));
-    final configUri = await findPackageConfigUri(packageConfig) ??
+    final packageConfig = await findPackageConfigUri(packageConfigUri) ??
         (throw UnsupportedError('Package configuration file not found'));
 
-    return PackageAssetReader(configUri, rootPackage);
+    return PackageAssetReader(packageConfig, rootPackage);
   }
 
   File? _resolve(AssetId id) {

build_test/pubspec.yaml

@@ -1,6 +1,6 @@
 name: build_test
 description: Utilities for writing unit tests of Builders.
-version: 2.1.5
+version: 2.1.6-dev
 repository: https://github.com/dart-lang/build/tree/master/build_test
 
 environment:

build_web_compilers/lib/src/common.dart

@@ -2,11 +2,9 @@
 // for details. 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 'dart:io';
 
 import 'package:build/build.dart';
-import 'package:build_modules/build_modules.dart';
 import 'package:path/path.dart' as p;
 import 'package:scratch_space/scratch_space.dart';
 
@@ -24,20 +22,6 @@ String sdkDdcKernelPath(bool soundNullSafety) => p.url.join('lib', '_internal',
 String soundnessExt(bool soundNullSafety) =>
     soundNullSafety ? '.sound' : '.unsound';
 
-// TODO: better solution for a .packages file, today we just create a new one
-// for every kernel build action.
-Future<File> createPackagesFile(Iterable<AssetId> allAssets) async {
-  var allPackages = allAssets.map((id) => id.package).toSet();
-  var packagesFileDir =
-      await Directory.systemTemp.createTemp('kernel_builder_');
-  var packagesFile = File(p.join(packagesFileDir.path, '.packages'));
-  await packagesFile.create();
-  await packagesFile.writeAsString(allPackages
-      .map((pkg) => '$pkg:$multiRootScheme:///packages/$pkg')
-      .join('\r\n'));
-  return packagesFile;
-}
-
 /// Validates that [config] only has the top level keys [supportedOptions].
 ///
 /// Throws an [ArgumentError] if not.