[vm] Make dart run --resident work in SDK checkout

Resident runner used to look either for pubspec.yaml
or .dart_tool/package_config.json to find package root.

However it does not make much sense to look for pubspec.yaml
you can't resolve packages using just pubspec anyway - you
need package_config.json. This was making it impossible
to use resident runner with packages in Dart SDK checkout:
each package contains pubspec.yaml, but package_config.json
is generated at the root of SDK checkout instead.

This CL also removes support for .packages file - we have
deprecated and removed this file in 2022.

[email protected]

TEST=manually

Change-Id: I18ce7a1a82bc72bbc944d8ab2d40f40cdb15cc1e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/357620
Commit-Queue: Slava Egorov <[email protected]>
Reviewed-by: Martin Kustermann <[email protected]>

Author: mraleph

pkg/dartdev/lib/src/generate_kernel.dart

@@ -5,7 +5,6 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:package_config/package_config.dart';
 import 'package:path/path.dart' as p;
 import 'package:pub/pub.dart';
 
@@ -51,12 +50,12 @@ Future<DartExecutableWithPackageConfig> generateKernel(
   final packageRoot = _packageRootFor(executable);
   if (packageRoot == null) {
     throw FrontendCompilerException._(
-        'resident mode is only supported for Dart packages.',
+        'Unable to locate .dart_tool/package_config.json in any parent folder.'
+        'Did you run `pub get`?',
         CompilationIssue.standaloneProgramError);
   }
   await ensureCompilationServerIsRunning(serverInfoFile);
-  // TODO: allow custom package paths with a --packages flag
-  final packageConfig = await _resolvePackageConfig(executable, packageRoot);
+  final packageConfig = p.join(packageRoot, packageConfigName);
   final cachedKernel = _cachedKernelPath(executable.executable, packageRoot);
   Map<String, dynamic> result;
   try {
@@ -185,35 +184,14 @@ String? _packageRootFor(DartExecutableWithPackageConfig executable) {
       Directory(p.dirname(p.canonicalize(executable.executable)));
 
   while (currentDirectory.parent.path != currentDirectory.path) {
-    if (File(p.join(currentDirectory.path, 'pubspec.yaml')).existsSync() ||
-        File(p.join(currentDirectory.path, packageConfigName)).existsSync()) {
+    if (File(p.join(currentDirectory.path, packageConfigName)).existsSync()) {
       return currentDirectory.path;
     }
     currentDirectory = currentDirectory.parent;
   }
   return null;
 }
 
-/// Resolves the absolute path to [packageRoot]'s package_config.json file,
-/// returning null if the package does not contain one, or if the source
-/// being compiled is a standalone dart script not inside a package.
-Future<String?> _resolvePackageConfig(
-    DartExecutableWithPackageConfig executable, String packageRoot) async {
-  final packageConfig = await findPackageConfigUri(
-    Uri.file(p.canonicalize(executable.executable)),
-    recurse: true,
-    onError: (_) {},
-  );
-  if (packageConfig != null) {
-    final dotPackageFile = File(p.join(packageRoot, '.packages'));
-    final packageConfigFile = File(p.join(packageRoot, packageConfigName));
-    return packageConfigFile.existsSync()
-        ? packageConfigFile.path
-        : dotPackageFile.path;
-  }
-  return null;
-}
-
 /// Indicates the type of issue encountered with the
 /// Resident Frontend Compiler
 enum CompilationIssue {

pkg/dartdev/pubspec.yaml

@@ -26,7 +26,6 @@ dependencies:
   meta: any
   native_assets_builder: any
   native_assets_cli: any
-  package_config: any
   path: any
   pub: any
   telemetry: any

pkg/dartdev/test/commands/run_test.dart

@@ -1050,15 +1050,15 @@ void residentRun() {
 
   test('standalone dart program', () async {
     p = project(mainSrc: 'void main() {}');
-    p.deleteFile('pubspec.yaml');
+    p.deleteFile('.dart_tool/package_config.json');
     final runResult = await p.run([
       'run',
       '--$serverInfoOption=$serverInfoFile',
       p.relativeFilePath,
     ]);
 
     expect(runResult.stderr,
-        contains('resident mode is only supported for Dart packages.'));
+        contains('Unable to locate .dart_tool/package_config.json'));
     expect(runResult.exitCode, isNot(0));
     expect(File(serverInfoFile).existsSync(), true);
   });

pkg/dartdev/test/core_test.dart

@@ -134,7 +134,6 @@ void _project() {
 
   test('hasPackageConfigFile positive', () {
     final p = project();
-    p.file('.dart_tool/package_config.json', _packageData);
     Project coreProj = Project.fromDirectory(p.dir);
     expect(coreProj.hasPackageConfigFile, isTrue);
     expect(coreProj.packageConfig, isNotNull);
@@ -143,6 +142,9 @@ void _project() {
 
   test('hasPackageConfigFile negative', () {
     final p = project();
+    var packageConfig =
+        File(path.join(p.dirPath, '.dart_tool/package_config.json'));
+    packageConfig.deleteSync();
     Project coreProj = Project.fromDirectory(p.dir);
     expect(coreProj.hasPackageConfigFile, isFalse);
   });

pkg/dartdev/test/utils.dart

@@ -90,6 +90,23 @@ class TestProject {
         },
       ),
     );
+    file(
+      '.dart_tool/package_config.json',
+      JsonEncoder.withIndent('  ').convert(
+        {
+          'configVersion': 2,
+          'generator': 'utils.dart',
+          'packages': [
+            {
+              'name': name,
+              'rootUri': '../',
+              'packageUri': 'lib/',
+              'languageVersion': '3.2',
+            },
+          ],
+        },
+      ),
+    );
     if (analysisOptions != null) {
       file('analysis_options.yaml', analysisOptions);
     }