Macro. Pass 'packagesFileUri' when compiling using KernelCompilationS…

…ervice. Change-Id: I2cdb9864a2c824ca568ded1a8b7c2c7b0d74de5d Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/366402 Reviewed-by: Morgan :) <[email protected]> Reviewed-by: Phil Quitslund <[email protected]> Reviewed-by: Jake Macdonald <[email protected]> Commit-Queue: Konstantin Shcheglov <[email protected]> Reviewed-by: Brian Wilkerson <[email protected]>
dart-lang · May 14, 2024 · 3db9fd3 · 3db9fd3
1 parent d45304c
commit 3db9fd3
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 17 deletions.
diff --git a/pkg/analyzer/lib/src/dart/analysis/driver.dart b/pkg/analyzer/lib/src/dart/analysis/driver.dart
@@ -376,6 +376,7 @@ class AnalysisDriver {
       declaredVariables: declaredVariables,
       sourceFactory: _sourceFactory,
       macroSupport: macroSupport,
+      packagesFile: analysisContext?.contextRoot.packagesFile,
       externalSummaries: _externalSummaries,
       fileSystemState: _fsState,
     );

diff --git a/pkg/analyzer/lib/src/dart/analysis/library_context.dart b/pkg/analyzer/lib/src/dart/analysis/library_context.dart
@@ -8,6 +8,7 @@ import 'dart:typed_data';
 import 'package:analyzer/dart/analysis/declared_variables.dart';
 import 'package:analyzer/dart/element/element.dart'
     show CompilationUnitElement, LibraryElement;
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/context/context.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options_map.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart';
@@ -41,6 +42,7 @@ class LibraryContext {
   final InfoDeclarationStore infoDeclarationStore;
   final FileSystemState fileSystemState;
   final MacroSupport? macroSupport;
+  final File? packagesFile;
   final SummaryDataStore store = SummaryDataStore();
 
   late final AnalysisContextImpl analysisContext;
@@ -59,6 +61,7 @@ class LibraryContext {
     required DeclaredVariables declaredVariables,
     required SourceFactory sourceFactory,
     required this.macroSupport,
+    required this.packagesFile,
     required SummaryDataStore? externalSummaries,
   }) {
     analysisContext = AnalysisContextImpl(
@@ -233,14 +236,18 @@ class LibraryContext {
 
       // If we can compile to kernel, check if there are macros.
       var macroSupport = this.macroSupport;
-      if (macroSupport is KernelMacroSupport && macroLibraries.isNotEmpty) {
+      var packagesFile = this.packagesFile;
+      if (macroSupport is KernelMacroSupport &&
+          packagesFile != null &&
+          macroLibraries.isNotEmpty) {
         var kernelBytes = byteStore.get(cycle.macroKey);
         if (kernelBytes == null) {
           kernelBytes = await performance.runAsync<Uint8List>(
             'macroCompileKernel',
             (performance) async {
               return await macroSupport.builder.build(
                 fileSystem: _MacroFileSystem(fileSystemState),
+                packageFilePath: packagesFile.path,
                 libraries: macroLibraries,
               );
             },

diff --git a/pkg/analyzer/lib/src/dart/micro/resolve_file.dart b/pkg/analyzer/lib/src/dart/micro/resolve_file.dart
@@ -784,6 +784,7 @@ class FileResolver {
         sourceFactory: sourceFactory,
         externalSummaries: SummaryDataStore(),
         macroSupport: null,
+        packagesFile: null,
         testData: testData?.libraryContext,
       );
 

diff --git a/pkg/analyzer/lib/src/summary2/kernel_compilation_service.dart b/pkg/analyzer/lib/src/summary2/kernel_compilation_service.dart
@@ -92,6 +92,7 @@ class KernelCompilationService {
   /// be requested again using [dispose] or [disposeDelayed].
   static Future<Uint8List> compile({
     required MacroFileSystem fileSystem,
+    required String packageFilePath,
     required String path,
   }) {
     _disposeDelayTimer?.cancel();
@@ -101,9 +102,10 @@ class KernelCompilationService {
       var instance = await _instance;
       var requestChannel = instance.requestChannel;
 
+      var pathContext = fileSystem.pathContext;
       MacroFileEntry uriStrToFile(Object? uriStr) {
         var uri = uriCache.parse(uriStr as String);
-        var path = fileSystem.pathContext.fromUri(uri);
+        var path = pathContext.fromUri(uri);
         return fileSystem.getFile(path);
       }
 
@@ -122,7 +124,8 @@ class KernelCompilationService {
       // Now we can compile.
       return await requestChannel.sendRequest<Uint8List>('kernelForProgram', {
         'sdkSummary': 'dill:vm',
-        'uri': fileSystem.pathContext.toUri(path).toString(),
+        'packagesFileUri': pathContext.toUri(packageFilePath).toString(),
+        'uri': pathContext.toUri(path).toString(),
       });
     });
   }

diff --git a/pkg/analyzer/lib/src/summary2/macro.dart b/pkg/analyzer/lib/src/summary2/macro.dart
@@ -227,6 +227,7 @@ class MacroKernelBuilder {
 
   Future<Uint8List> build({
     required MacroFileSystem fileSystem,
+    required String packageFilePath,
     required List<MacroLibrary> libraries,
   }) async {
     var macroMainContent = macro.bootstrapMacroIsolate(
@@ -245,6 +246,7 @@ class MacroKernelBuilder {
 
     return KernelCompilationService.compile(
       fileSystem: overlayFileSystem,
+      packageFilePath: packageFilePath,
       path: macroMainPath,
     );
   }

diff --git a/pkg/analyzer/test/src/dart/resolution/context_collection_resolution.dart b/pkg/analyzer/test/src/dart/resolution/context_collection_resolution.dart
@@ -357,6 +357,24 @@ class PubPackageResolutionTest extends ContextResolutionTest
 
   String get workspaceRootPath => '/home';
 
+  /// Creates `package:macro` and `package:_macro` files, adds to [config].
+  void addMacrosEnvironment(
+    PackageConfigFileBuilder config,
+    MacrosEnvironment macrosEnvironment,
+  ) {
+    var packagesRootFolder = getFolder(packagesRootPath);
+    macrosEnvironment.publicMacrosFolder.copyTo(packagesRootFolder);
+    macrosEnvironment.privateMacrosFolder.copyTo(packagesRootFolder);
+    config.add(
+      name: '_macros',
+      rootPath: getFolder('$packagesRootPath/_macros').path,
+    );
+    config.add(
+      name: 'macros',
+      rootPath: getFolder('$packagesRootPath/macros').path,
+    );
+  }
+
   /// Build summary bundle for a single URI `package:foo/foo.dart`.
   Future<File> buildPackageFooSummary({
     required Map<String, String> files,
@@ -512,17 +530,7 @@ class PubPackageResolutionTest extends ContextResolutionTest
     }
 
     if (macrosEnvironment != null) {
-      var packagesRootFolder = getFolder(packagesRootPath);
-      macrosEnvironment.publicMacrosFolder.copyTo(packagesRootFolder);
-      macrosEnvironment.privateMacrosFolder.copyTo(packagesRootFolder);
-      config.add(
-        name: '_macros',
-        rootPath: getFolder('$packagesRootPath/_macros').path,
-      );
-      config.add(
-        name: 'macros',
-        rootPath: getFolder('$packagesRootPath/macros').path,
-      );
+      addMacrosEnvironment(config, macrosEnvironment);
     }
 
     writePackageConfig(testPackageRootPath, config);

diff --git a/pkg/analyzer/test/src/dart/resolution/macro_test.dart b/pkg/analyzer/test/src/dart/resolution/macro_test.dart
@@ -1204,6 +1204,44 @@ class X {}
     ]);
   }
 
+  /// Test that macros are compiled using the packages file of the package
+  /// that uses the macro.
+  test_macroInPackage() async {
+    var myMacroRootPath = '$workspaceRootPath/my_macro';
+    writePackageConfig(
+      myMacroRootPath,
+      PackageConfigFileBuilder()
+        ..add(name: 'my_macro', rootPath: myMacroRootPath),
+    );
+
+    newAnalysisOptionsYamlFile(
+      myMacroRootPath,
+      AnalysisOptionsFileConfig(
+        experiments: experiments,
+      ).toContent(),
+    );
+
+    newFile(
+      '$myMacroRootPath/lib/append.dart',
+      getMacroCode('append.dart'),
+    );
+
+    writeTestPackageConfig(
+      PackageConfigFileBuilder()
+        ..add(name: 'my_macro', rootPath: myMacroRootPath),
+      macrosEnvironment: MacrosEnvironment.instance,
+    );
+
+    await assertNoErrorsInCode(r'''
+import 'package:my_macro/append.dart';
+
+@DeclareType('B', 'class B {}')
+class A {}
+
+void f(B b) {}
+''');
+  }
+
   test_withLints() async {
     writeTestPackageAnalysisOptionsFile(AnalysisOptionsFileConfig(
       lints: ['unnecessary_this'],

diff --git a/pkg/analyzer/test/src/summary/macro_test.dart b/pkg/analyzer/test/src/summary/macro_test.dart
@@ -15147,11 +15147,16 @@ elementFactory
     }
 
     var otherRootPath = '$workspaceRootPath/other';
+    var otherPackageConfig = PackageConfigFileBuilder()
+      ..add(name: 'test', rootPath: testPackageRootPath)
+      ..add(name: 'other', rootPath: otherRootPath);
+    addMacrosEnvironment(
+      otherPackageConfig,
+      MacrosEnvironment.instance,
+    );
     writePackageConfig(
       otherRootPath,
-      PackageConfigFileBuilder()
-        ..add(name: 'test', rootPath: testPackageRootPath)
-        ..add(name: 'other', rootPath: otherRootPath),
+      otherPackageConfig,
     );
 
     newAnalysisOptionsYamlFile(