Fine. Tracking for LibraryElementImpl.metadata

Change-Id: I07f3b4827f58293c9c324d284c4b7d5ca011fa8d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/449683
Commit-Queue: Konstantin Shcheglov <[email protected]>
Reviewed-by: Johnni Winther <[email protected]>

Author: scheglov

pkg/analyzer/lib/src/dart/element/element.dart

@@ -6301,8 +6301,10 @@ class LibraryElementImpl extends ElementImpl
   String? get lookupName => null;
 
   @override
+  @trackedDirectly
   MetadataImpl get metadata {
     _ensureReadResolution();
+    globalResultRequirements?.record_library_metadata(element: this);
     return _metadata;
   }
 

pkg/analyzer/lib/src/fine/library_manifest.dart

@@ -26,6 +26,7 @@ class LibraryManifest {
   final String? name;
   final Uint8List featureSet;
   final ManifestLibraryLanguageVersion languageVersion;
+  final LibraryMetadataItem libraryMetadata;
 
   final List<Uri> exportedLibraryUris;
 
@@ -54,6 +55,7 @@ class LibraryManifest {
     required this.name,
     required this.featureSet,
     required this.languageVersion,
+    required this.libraryMetadata,
     required this.exportedLibraryUris,
     required this.reExportMap,
     required this.reExportDeprecatedOnly,
@@ -75,6 +77,7 @@ class LibraryManifest {
       name: reader.readOptionalStringUtf8(),
       featureSet: reader.readUint8List(),
       languageVersion: ManifestLibraryLanguageVersion.read(reader),
+      libraryMetadata: LibraryMetadataItem.read(reader),
       exportedLibraryUris: reader.readUriList(),
       reExportMap: reader.readLookupNameToIdMap(),
       reExportDeprecatedOnly: reader.readLookupNameSet(),
@@ -156,6 +159,7 @@ class LibraryManifest {
     sink.writeOptionalStringUtf8(name);
     sink.writeUint8List(featureSet);
     languageVersion.write(sink);
+    libraryMetadata.write(sink);
     sink.writeUriList(exportedLibraryUris);
     reExportMap.write(sink);
     reExportDeprecatedOnly.write(sink);
@@ -784,12 +788,19 @@ class LibraryManifestBuilder {
       var newTopLevelFunctions = <LookupName, TopLevelFunctionItem>{};
       var newTopLevelVariables = <LookupName, TopLevelVariableItem>{};
 
+      var libraryMetadataItem = _getOrBuildElementItem(libraryElement, () {
+        return LibraryMetadataItem.encode(
+          id: ManifestItemId.generate(),
+          context: encodingContext,
+          metadata: libraryElement.metadata,
+        );
+      });
+
       for (var element in libraryElement.children) {
         var lookupName = element.lookupName?.asLookupName;
         if (lookupName == null) {
           continue;
         }
-
         switch (element) {
           case ClassElementImpl():
             _addClass(
@@ -870,6 +881,7 @@ class LibraryManifestBuilder {
         languageVersion: ManifestLibraryLanguageVersion.encode(
           libraryElement.languageVersion,
         ),
+        libraryMetadata: libraryMetadataItem,
         exportedLibraryUris: libraryElement.exportedLibraries
             .map((e) => e.uri)
             .toList(),
@@ -1093,6 +1105,7 @@ class LibraryManifestBuilder {
           name: null,
           featureSet: Uint8List(0),
           languageVersion: ManifestLibraryLanguageVersion.empty(),
+          libraryMetadata: LibraryMetadataItem.empty(),
           exportedLibraryUris: [],
           reExportMap: {},
           reExportDeprecatedOnly: <LookupName>{},
@@ -1222,6 +1235,10 @@ class _LibraryMatch {
   });
 
   void compareStructures() {
+    if (!_matchLibraryMetadata()) {
+      structureMismatched.add(library);
+    }
+
     for (var element in library.children) {
       var name = element.lookupName?.asLookupName;
       switch (element) {
@@ -1584,6 +1601,18 @@ class _LibraryMatch {
     }
   }
 
+  bool _matchLibraryMetadata() {
+    var item = manifest.libraryMetadata;
+
+    var matchContext = MatchContext(parent: null);
+    if (!item.match(matchContext, library)) {
+      return false;
+    }
+
+    _addMatchingElementItem(library, item, matchContext);
+    return true;
+  }
+
   bool _matchMixin({
     required LookupName? name,
     required MixinElementImpl element,

pkg/analyzer/lib/src/fine/manifest_item.dart

@@ -848,6 +848,44 @@ sealed class InterfaceItem<E extends InterfaceElementImpl>
   }
 }
 
+class LibraryMetadataItem extends ManifestItem<LibraryElementImpl> {
+  LibraryMetadataItem({
+    required super.id,
+    required super.flags,
+    required super.metadata,
+  });
+
+  factory LibraryMetadataItem.empty() {
+    return LibraryMetadataItem(
+      id: ManifestItemId.generate(),
+      flags: _ManifestItemFlags.empty(),
+      metadata: ManifestMetadata(annotations: []),
+    );
+  }
+
+  factory LibraryMetadataItem.encode({
+    required ManifestItemId id,
+    required EncodeContext context,
+    required MetadataImpl metadata,
+  }) {
+    return LibraryMetadataItem(
+      id: id,
+      flags: _ManifestItemFlags.empty(),
+      metadata: ManifestMetadata.encode(context, metadata),
+    );
+  }
+
+  factory LibraryMetadataItem.read(SummaryDataReader reader) {
+    return LibraryMetadataItem(
+      id: ManifestItemId.read(reader),
+      flags: _ManifestItemFlags.read(reader),
+      metadata: ManifestMetadata.read(reader),
+    );
+  }
+
+  bool get isEmpty => metadata.annotations.isEmpty;
+}
+
 class ManifestAnnotation {
   final ManifestNode ast;
 
@@ -1946,6 +1984,10 @@ extension type _ManifestItemFlags._(int _bits) {
   static final int _base = 0;
   static final int _next = _base + _ManifestItemFlag.values.length;
 
+  factory _ManifestItemFlags.empty() {
+    return _ManifestItemFlags._(0);
+  }
+
   factory _ManifestItemFlags.encode(ElementImpl element) {
     var bits = 0;
     if (element.isSynthetic) {
@@ -1954,6 +1996,10 @@ extension type _ManifestItemFlags._(int _bits) {
     return _ManifestItemFlags._(bits);
   }
 
+  factory _ManifestItemFlags.read(SummaryDataReader reader) {
+    return _ManifestItemFlags._(reader.readUint30());
+  }
+
   bool get isSynthetic {
     return _has(_ManifestItemFlag.isSynthetic);
   }

pkg/analyzer/lib/src/fine/requirement_failure.dart

@@ -352,6 +352,15 @@ class LibraryLanguageVersionMismatch extends RequirementFailure {
   }
 }
 
+class LibraryMetadataMismatch extends RequirementFailure {
+  final Uri libraryUri;
+
+  LibraryMetadataMismatch({required this.libraryUri});
+
+  @override
+  String toString() => 'LibraryMetadataMismatch(libraryUri: $libraryUri)';
+}
+
 class LibraryMissing extends RequirementFailure {
   final Uri uri;
 

pkg/analyzer/lib/src/fine/requirements.dart

@@ -374,6 +374,7 @@ class LibraryRequirements {
   String? name;
   Uint8List? featureSet;
   ManifestLibraryLanguageVersion? languageVersion;
+  ManifestItemId? libraryMetadataId;
 
   List<Uri>? exportedLibraryUris;
 
@@ -418,6 +419,7 @@ class LibraryRequirements {
     required this.name,
     required this.featureSet,
     required this.languageVersion,
+    required this.libraryMetadataId,
     required this.exportedLibraryUris,
     required this.exportedTopLevels,
     required this.instances,
@@ -451,6 +453,7 @@ class LibraryRequirements {
       name: null,
       featureSet: null,
       languageVersion: null,
+      libraryMetadataId: null,
       exportedLibraryUris: null,
       exportedTopLevels: {},
       instances: {},
@@ -485,6 +488,7 @@ class LibraryRequirements {
       name: reader.readOptionalStringUtf8(),
       featureSet: reader.readOptionalUint8List(),
       languageVersion: ManifestLibraryLanguageVersion.readOptional(reader),
+      libraryMetadataId: ManifestItemId.readOptional(reader),
       exportedLibraryUris: reader.readOptionalUriList(),
       exportedTopLevels: reader.readNameToOptionalIdMap(),
       instances: reader.readMap(
@@ -527,6 +531,7 @@ class LibraryRequirements {
     sink.writeOptionalStringUtf8(name);
     sink.writeOptionalUint8List(featureSet);
     sink.writeOptionalObject(languageVersion, (it) => it.write(sink));
+    libraryMetadataId.writeOptional(sink);
     sink.writeOptionalUriList(exportedLibraryUris);
     sink.writeNameToIdMap(exportedTopLevels);
 
@@ -743,6 +748,13 @@ class RequirementsManifest {
         }
       }
 
+      if (libraryRequirements.libraryMetadataId case var expectedId?) {
+        var actualId = libraryManifest.libraryMetadata.id;
+        if (actualId != expectedId) {
+          return LibraryMetadataMismatch(libraryUri: libraryUri);
+        }
+      }
+
       for (var topLevelEntry in libraryRequirements.exportedTopLevels.entries) {
         var name = topLevelEntry.key;
         var actualId = libraryManifest.getExportedId(name);
@@ -2048,6 +2060,20 @@ class RequirementsManifest {
     requirements.languageVersion = manifest.languageVersion;
   }
 
+  void record_library_metadata({required LibraryElementImpl element}) {
+    if (_recordingLockLevel != 0) {
+      return;
+    }
+
+    var manifest = element.manifest;
+    if (manifest == null) {
+      return;
+    }
+
+    var requirements = _getLibraryRequirements(element);
+    requirements.libraryMetadataId ??= manifest.libraryMetadata.id;
+  }
+
   /// Record that all accessible extensions inside a [LibraryFragmentImpl]
   /// are requested, which means dependency on all extensions exported
   /// from [importedLibraries].