Generator: use analyzer 8 element APIs #154

Author: greenrobot-team

generator/lib/src/entity_resolver.dart

@@ -2,7 +2,7 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:analyzer/dart/constant/value.dart';
-import 'package:analyzer/dart/element/element2.dart';
+import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/nullability_suffix.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:build/build.dart';
@@ -92,10 +92,10 @@ class EntityResolver extends Builder {
   }
 
   ModelEntity generateForAnnotatedElement(
-    Element2 classElement,
+    Element classElement,
     ConstantReader annotation,
   ) {
-    if (classElement is! ClassElement2) {
+    if (classElement is! ClassElement) {
       throw InvalidGenerationSourceError(
         "Entity '${classElement.displayName}': annotated element must be a class.",
       );
@@ -108,7 +108,7 @@ class EntityResolver extends Builder {
       IdUid(0, entityUid.isNull ? 0 : entityUid.intValue),
       entityRealClass.isNull
           ? classElement.displayName
-          : entityRealClass.typeValue.element3!.displayName,
+          : entityRealClass.typeValue.element!.displayName,
       null,
       uidRequest: !entityUid.isNull && entityUid.intValue == 0,
     );
@@ -130,7 +130,7 @@ class EntityResolver extends Builder {
 
     // Note: if there is no unnamed constructor this list will just be empty
     entity.constructorParams = constructorParams(
-      classElement.unnamedConstructor2,
+      classElement.unnamedConstructor,
     );
 
     // Make sure all stored fields are writable when reading object from DB.
@@ -139,8 +139,8 @@ class EntityResolver extends Builder {
     //   * don't have a corresponding argument in the constructor.
     // Note: the corresponding setter is also null for final fields.
     final readOnlyFields = <String>{};
-    for (var f in classElement.getters2) {
-      if (f.correspondingSetter2 == null &&
+    for (var f in classElement.getters) {
+      if (f.correspondingSetter == null &&
           !entity.constructorParams.any(
             (String param) => param.startsWith('${f.displayName} '),
           )) {
@@ -149,12 +149,12 @@ class EntityResolver extends Builder {
     }
 
     // read all suitable annotated properties
-    for (var f in classElement.fields2) {
+    for (var f in classElement.fields) {
       // The field might be implicitly defined by a getter, aka it is synthetic
       // and does not exist in code. So always resolve the actual non-synthetic
       // element that exists in code (here a getter) as only it will have any
       // annotations.
-      final annotated = f.nonSynthetic2;
+      final annotated = f.nonSynthetic;
 
       if (_transientChecker.hasAnnotationOfExact(annotated)) {
         log.info(
@@ -163,7 +163,7 @@ class EntityResolver extends Builder {
         continue;
       }
 
-      if (readOnlyFields.contains(f.name3) && !isRelationField(f)) {
+      if (readOnlyFields.contains(f.name) && !isRelationField(f)) {
         log.info(
           "  Skipping property '${f.displayName}': is read-only/getter.",
         );
@@ -225,10 +225,7 @@ class EntityResolver extends Builder {
           continue;
         }
         relTargetName =
-            (f.type as ParameterizedType)
-                .typeArguments[0]
-                .element3!
-                .displayName;
+            (f.type as ParameterizedType).typeArguments[0].element!.displayName;
       }
 
       final backlinkAnnotations = _backlinkChecker.annotationsOfExact(
@@ -339,7 +336,7 @@ class EntityResolver extends Builder {
 
         // for code generation
         prop.dartFieldType =
-            f.type.element3!.displayName + (isNullable(f.type) ? '?' : '');
+            f.type.element!.displayName + (isNullable(f.type) ? '?' : '');
         entity.properties.add(prop);
       }
     }
@@ -350,10 +347,10 @@ class EntityResolver extends Builder {
     // for `setId()` won't compile. The only exception is when user uses
     // self-assigned IDs, then a different setter will be generated - one that
     // checks the ID being set is already the same, otherwise it must throw.
-    final idField = classElement.fields2.singleWhere(
-      (FieldElement2 f) => f.displayName == entity.idProperty.name,
+    final idField = classElement.fields.singleWhere(
+      (FieldElement f) => f.displayName == entity.idProperty.name,
     );
-    if (idField.setter2 == null) {
+    if (idField.setter == null) {
       if (!entity.idProperty.hasFlag(OBXPropertyFlags.ID_SELF_ASSIGNABLE)) {
         throw InvalidGenerationSourceError(
           "@Id field '${idField.displayName}' must be writable,"
@@ -384,7 +381,7 @@ class EntityResolver extends Builder {
   /// For fields that do not have a [Property.type] declared in their [Property]
   /// annotation tries to determine the ObjectBox database type based on the
   /// Dart type. May return null if no supported type is detected.
-  int? detectObjectBoxType(FieldElement2 field, String classDisplayName) {
+  int? detectObjectBoxType(FieldElement field, String classDisplayName) {
     final dartType = field.type;
 
     if (dartType.isDartCoreInt) {
@@ -420,28 +417,28 @@ class EntityResolver extends Builder {
     } else if ([
       'Int8List',
       'Uint8List',
-    ].contains(dartType.element3!.displayName)) {
+    ].contains(dartType.element!.displayName)) {
       return OBXPropertyType.ByteVector;
     } else if ([
       'Int16List',
       'Uint16List',
-    ].contains(dartType.element3!.displayName)) {
+    ].contains(dartType.element!.displayName)) {
       return OBXPropertyType.ShortVector;
     } else if ([
       'Int32List',
       'Uint32List',
-    ].contains(dartType.element3!.displayName)) {
+    ].contains(dartType.element!.displayName)) {
       return OBXPropertyType.IntVector;
     } else if ([
       'Int64List',
       'Uint64List',
-    ].contains(dartType.element3!.displayName)) {
+    ].contains(dartType.element!.displayName)) {
       return OBXPropertyType.LongVector;
-    } else if (dartType.element3!.displayName == 'Float32List') {
+    } else if (dartType.element!.displayName == 'Float32List') {
       return OBXPropertyType.FloatVector;
-    } else if (dartType.element3!.displayName == 'Float64List') {
+    } else if (dartType.element!.displayName == 'Float64List') {
       return OBXPropertyType.DoubleVector;
-    } else if (dartType.element3!.displayName == 'DateTime') {
+    } else if (dartType.element!.displayName == 'DateTime') {
       log.warning(
         "  DateTime property '${field.displayName}' in entity '$classDisplayName' is stored and read using millisecond precision. "
         'To silence this warning, add an explicit type using @Property(type: PropertyType.date) or @Property(type: PropertyType.dateNano) annotation.',
@@ -455,7 +452,7 @@ class EntityResolver extends Builder {
     return null;
   }
 
-  void processIdProperty(ModelEntity entity, ClassElement2 classElement) {
+  void processIdProperty(ModelEntity entity, ClassElement classElement) {
     // check properties explicitly annotated with @Id()
     final annotated = entity.properties.where(
       (p) => p.hasFlag(OBXPropertyFlags.ID),
@@ -500,10 +497,10 @@ class EntityResolver extends Builder {
   }
 
   void processAnnotationIndexUnique(
-    FieldElement2 f,
-    Element2 annotatedElement,
+    FieldElement f,
+    Element annotatedElement,
     int? fieldType,
-    Element2 elementBare,
+    Element elementBare,
     ModelProperty prop,
   ) {
     IndexType? indexType;
@@ -598,7 +595,7 @@ class EntityResolver extends Builder {
 
   void ensureSingleUniqueReplace(
     ModelEntity entity,
-    ClassElement2 classElement,
+    ClassElement classElement,
   ) {
     final uniqueReplaceProps = entity.properties.where(
       (p) => p.hasFlag(OBXPropertyFlags.UNIQUE_ON_CONFLICT_REPLACE),
@@ -613,7 +610,7 @@ class EntityResolver extends Builder {
 
   void ifSyncEnsureAllUniqueAreReplace(
     ModelEntity entity,
-    ClassElement2 classElement,
+    ClassElement classElement,
   ) {
     if (!entity.hasFlag(OBXEntityFlags.SYNC_ENABLED)) return;
     final uniqueButNotReplaceProps = entity.properties.where((p) {
@@ -659,20 +656,19 @@ class EntityResolver extends Builder {
     return typeArgs.length == 1 ? typeArgs[0] : null;
   }
 
-  bool isRelationField(FieldElement2 f) =>
+  bool isRelationField(FieldElement f) =>
       isToOneRelationField(f) || isToManyRelationField(f);
 
-  bool isToOneRelationField(FieldElement2 f) =>
-      f.type.element3!.name3 == 'ToOne';
+  bool isToOneRelationField(FieldElement f) => f.type.element!.name == 'ToOne';
 
-  bool isToManyRelationField(FieldElement2 f) =>
-      f.type.element3!.name3 == 'ToMany';
+  bool isToManyRelationField(FieldElement f) =>
+      f.type.element!.name == 'ToMany';
 
   bool isNullable(DartType type) =>
       type.nullabilitySuffix == NullabilitySuffix.star ||
       type.nullabilitySuffix == NullabilitySuffix.question;
 
-  List<String> constructorParams(ConstructorElement2? constructor) {
+  List<String> constructorParams(ConstructorElement? constructor) {
     if (constructor == null) return List.empty();
     return constructor.formalParameters
         .map((param) {
@@ -739,7 +735,7 @@ class EntityResolver extends Builder {
 }
 
 extension _TypeCheckerExtensions on TypeChecker {
-  void runIfMatches(Element2 element, void Function(DartObject) fn) {
+  void runIfMatches(Element element, void Function(DartObject) fn) {
     final annotations = annotationsOfExact(element);
     if (annotations.isNotEmpty) fn(annotations.first);
   }

objectbox/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## latest
 
+* Migrate generator to analyzer 8 APIs. Require at least analyzer 8.1.1 and source_gen 4.0.1.
+
 ## 5.0.0 (2025-10-01)
 
 **To upgrade to this major release** run `flutter pub upgrade objectbox --major-versions`