refactor: Separate ClassDefinition into specialization classes. (serverpod#3270)

Author: SandPod

tools/serverpod_cli/lib/analyzer.dart

@@ -10,6 +10,8 @@ export 'src/analyzer/models/definitions.dart'
     show
         SerializableModelDefinition,
         ClassDefinition,
+        ModelClassDefinition,
+        ExceptionClassDefinition,
         SerializableModelFieldDefinition,
         ModelFieldScopeDefinition,
         SerializableModelIndexDefinition,

tools/serverpod_cli/lib/src/analyzer/models/checker/analyze_checker.dart

@@ -19,8 +19,8 @@ class AnalyzeChecker {
   }
 
   static List<SerializableModelFieldDefinition> filterRelationByName(
-    ClassDefinition classDefinition,
-    ClassDefinition foreignClass,
+    ModelClassDefinition classDefinition,
+    ModelClassDefinition foreignClass,
     String relationFieldName,
     String? relationName,
   ) {

tools/serverpod_cli/lib/src/analyzer/models/definitions.dart

@@ -34,28 +34,44 @@ sealed class SerializableModelDefinition {
 ///
 /// See also:
 /// - [EnumDefinition]
-class ClassDefinition extends SerializableModelDefinition {
+sealed class ClassDefinition extends SerializableModelDefinition {
+  /// The fields of this class / exception.
+  List<SerializableModelFieldDefinition> fields;
+
+  /// The documentation of this class, line by line.
+  final List<String>? documentation;
+
+  /// Create a new [ClassDefinition].
+  ClassDefinition({
+    required super.fileName,
+    required super.sourceFileName,
+    required super.className,
+    required this.fields,
+    required super.serverOnly,
+    required super.type,
+    super.subDirParts,
+    this.documentation,
+  });
+
+  SerializableModelFieldDefinition? findField(String name) {
+    return fields.where((element) => element.name == name).firstOrNull;
+  }
+}
+
+/// A [ClassDefinition] specialization that represents a model class.
+final class ModelClassDefinition extends ClassDefinition {
   /// If set, the name of the table, this class should be stored in, in the
   /// database.
   final String? tableName;
 
-  /// The fields of this class / exception.
-  List<SerializableModelFieldDefinition> fields;
-
   /// The indexes that should be created for the table [tableName] representing
   /// this class.
   ///
   /// The index over the primary key `id` is not part of this list.
   final List<SerializableModelIndexDefinition> indexes;
 
-  /// The documentation of this class, line by line.
-  final List<String>? documentation;
-
   final bool manageMigration;
 
-  /// `true` if this is an exception and not a class.
-  final bool isException;
-
   /// If set to true the class is sealed.
   final bool isSealed;
 
@@ -65,34 +81,29 @@ class ClassDefinition extends SerializableModelDefinition {
   /// If set to [InheritanceDefinitions] the class extends another class and stores the [ClassDefinition] of it's parent.
   InheritanceDefinition? extendsClass;
 
-  List<ClassDefinition>? _descendantClasses;
+  List<ModelClassDefinition>? _descendantClasses;
 
-  /// Create a new [ClassDefinition].
-  ClassDefinition({
+  /// Create a new [ModelClassDefinition].
+  ModelClassDefinition({
     required super.fileName,
     required super.sourceFileName,
     required super.className,
-    required this.fields,
+    required super.fields,
     required super.serverOnly,
     required this.manageMigration,
-    required this.isException,
     required super.type,
     required this.isSealed,
     List<InheritanceDefinition>? childClasses,
     this.extendsClass,
     this.tableName,
     this.indexes = const [],
     super.subDirParts,
-    this.documentation,
+    super.documentation,
   }) : childClasses = childClasses ?? <InheritanceDefinition>[];
 
-  SerializableModelFieldDefinition? findField(String name) {
-    return fields.where((element) => element.name == name).firstOrNull;
-  }
-
-  /// Returns the `ClassDefinition` of the parent class.
+  /// Returns the `ModelClassDefinition` of the parent class.
   /// If there is no parent class, `null` is returned.
-  ClassDefinition? get parentClass {
+  ModelClassDefinition? get parentClass {
     var extendsClass = this.extendsClass;
     if (extendsClass is! ResolvedInheritanceDefinition) return null;
 
@@ -152,12 +163,12 @@ class ClassDefinition extends SerializableModelDefinition {
   /// Returns a list of all descendant classes.
   /// This includes all child classes and their descendants.
   /// If the class has no child classes, an empty list is returned.
-  List<ClassDefinition> get descendantClasses {
+  List<ModelClassDefinition> get descendantClasses {
     return _descendantClasses ??= _computeDescendantClasses();
   }
 
-  List<ClassDefinition> _computeDescendantClasses() {
-    List<ClassDefinition> descendants = [];
+  List<ModelClassDefinition> _computeDescendantClasses() {
+    List<ModelClassDefinition> descendants = [];
 
     var resolvedChildClasses =
         childClasses.whereType<ResolvedInheritanceDefinition>();
@@ -171,6 +182,21 @@ class ClassDefinition extends SerializableModelDefinition {
   }
 }
 
+/// A [ClassDefinition] specialization that represents an exception.
+final class ExceptionClassDefinition extends ClassDefinition {
+  /// Create a new [ExceptionClassDefinition].
+  ExceptionClassDefinition({
+    required super.className,
+    required super.fields,
+    required super.fileName,
+    required super.serverOnly,
+    required super.sourceFileName,
+    required super.type,
+    super.documentation,
+    super.subDirParts,
+  });
+}
+
 /// Describes a single field of a [ClassDefinition].
 class SerializableModelFieldDefinition {
   /// The name of the field.
@@ -354,7 +380,7 @@ class UnresolvedInheritanceDefinition extends InheritanceDefinition {
 }
 
 class ResolvedInheritanceDefinition extends InheritanceDefinition {
-  final ClassDefinition classDefinition;
+  final ModelClassDefinition classDefinition;
 
   ResolvedInheritanceDefinition(this.classDefinition);
 }

tools/serverpod_cli/lib/src/analyzer/models/entity_dependency_resolver.dart

@@ -12,11 +12,21 @@ class ModelDependencyResolver {
     List<SerializableModelDefinition> modelDefinitions,
   ) {
     modelDefinitions.whereType<ClassDefinition>().forEach((classDefinition) {
-      _resolveInheritance(classDefinition, modelDefinitions);
-      for (var fieldDefinition in classDefinition.fieldsIncludingInherited) {
-        _resolveFieldIndexes(fieldDefinition, classDefinition);
+      if (classDefinition is ModelClassDefinition) {
+        _resolveInheritance(classDefinition, modelDefinitions);
+      }
+
+      var fields = classDefinition is ModelClassDefinition
+          ? classDefinition.fieldsIncludingInherited
+          : classDefinition.fields;
+
+      for (var fieldDefinition in fields) {
         _resolveProtocolReference(fieldDefinition, modelDefinitions);
         _resolveEnumType(fieldDefinition.type, modelDefinitions);
+
+        if (classDefinition is! ModelClassDefinition) continue;
+
+        _resolveFieldIndexes(fieldDefinition, classDefinition);
         _resolveObjectRelationReference(
           classDefinition,
           fieldDefinition,
@@ -32,7 +42,7 @@ class ModelDependencyResolver {
   }
 
   static void _resolveInheritance(
-    ClassDefinition classDefinition,
+    ModelClassDefinition classDefinition,
     List<SerializableModelDefinition> modelDefinitions,
   ) {
     var extendedClass = classDefinition.extendsClass;
@@ -42,7 +52,7 @@ class ModelDependencyResolver {
     var parentClassName = extendedClass.className;
 
     var parentClass = modelDefinitions
-        .whereType<ClassDefinition>()
+        .whereType<ModelClassDefinition>()
         .where((element) => element.className == parentClassName)
         .firstOrNull;
 
@@ -59,7 +69,7 @@ class ModelDependencyResolver {
 
   static void _resolveFieldIndexes(
     SerializableModelFieldDefinition fieldDefinition,
-    ClassDefinition classDefinition,
+    ModelClassDefinition classDefinition,
   ) {
     var indexes = classDefinition.indexes;
     if (indexes.isEmpty) return;
@@ -101,7 +111,7 @@ class ModelDependencyResolver {
   }
 
   static void _resolveObjectRelationReference(
-    ClassDefinition classDefinition,
+    ModelClassDefinition classDefinition,
     SerializableModelFieldDefinition fieldDefinition,
     List<SerializableModelDefinition> modelDefinitions,
   ) {
@@ -116,7 +126,7 @@ class ModelDependencyResolver {
                 model?.type.moduleAlias == fieldDefinition.type.moduleAlias,
             orElse: () => null);
 
-    if (referenceClass is! ClassDefinition) return;
+    if (referenceClass is! ModelClassDefinition) return;
 
     var tableName = referenceClass.tableName;
     if (tableName is! String) return;
@@ -196,8 +206,8 @@ class ModelDependencyResolver {
   }
 
   static void _resolveImplicitDefinedRelation(
-    ClassDefinition classDefinition,
-    ClassDefinition referenceDefinition,
+    ModelClassDefinition classDefinition,
+    ModelClassDefinition referenceDefinition,
     SerializableModelFieldDefinition fieldDefinition,
     UnresolvedObjectRelationDefinition relation,
     String tableName,
@@ -252,8 +262,8 @@ class ModelDependencyResolver {
   }
 
   static void _resolveManualDefinedRelation(
-    ClassDefinition classDefinition,
-    ClassDefinition referenceDefinition,
+    ModelClassDefinition classDefinition,
+    ModelClassDefinition referenceDefinition,
     SerializableModelFieldDefinition fieldDefinition,
     UnresolvedObjectRelationDefinition relation,
     String tableName,
@@ -302,8 +312,8 @@ class ModelDependencyResolver {
   }
 
   static SerializableModelFieldDefinition? _findForeignFieldByRelationName(
-    ClassDefinition classDefinition,
-    ClassDefinition foreignClass,
+    ModelClassDefinition classDefinition,
+    ModelClassDefinition foreignClass,
     String fieldName,
     String? relationName,
   ) {
@@ -335,7 +345,7 @@ class ModelDependencyResolver {
   }
 
   static void _resolveListRelationReference(
-    ClassDefinition classDefinition,
+    ModelClassDefinition classDefinition,
     SerializableModelFieldDefinition fieldDefinition,
     List<SerializableModelDefinition> modelDefinitions,
   ) {
@@ -359,7 +369,7 @@ class ModelDependencyResolver {
               orElse: () => null,
             );
 
-    if (referenceClass is! ClassDefinition) return;
+    if (referenceClass is! ModelClassDefinition) return;
 
     var tableName = classDefinition.tableName;
     if (tableName == null) return;

tools/serverpod_cli/lib/src/analyzer/models/model_analyzer.dart

@@ -59,7 +59,7 @@ class SerializableModelAnalyzer {
 
     switch (definitionType) {
       case Keyword.classType:
-        return ModelParser.serializeClassFile(
+        return ModelParser.serializeModelClassFile(
           Keyword.classType,
           modelSource,
           outFileName,
@@ -68,7 +68,7 @@ class SerializableModelAnalyzer {
           extraClasses,
         );
       case Keyword.exceptionType:
-        return ModelParser.serializeClassFile(
+        return ModelParser.serializeExceptionClassFile(
           Keyword.exceptionType,
           modelSource,
           outFileName,