Merge pull request #1426 from nextcloud/refactor/dynamite/reduce_allO…

…f_interfaces refactor(dynamite)!: remove unecessary allOf interfaces
nextcloud · Jan 9, 2024 · 3b37ed7 · 3b37ed7
2 parents 40ccec5 + 62fe418
commit 3b37ed7
Show file tree

Hide file tree

Showing 16 changed files with 1,141 additions and 1,517 deletions.
diff --git a/packages/dynamite/dynamite/example/lib/petstore.openapi.dart b/packages/dynamite/dynamite/example/lib/petstore.openapi.dart
@@ -332,13 +332,10 @@ abstract class NewPet implements $NewPetInterface, Built<NewPet, NewPetBuilder>
 }
 
 @BuiltValue(instantiable: false)
-abstract interface class $Pet_1Interface {
+abstract interface class $PetInterface implements $NewPetInterface {
   int get id;
 }
 
-@BuiltValue(instantiable: false)
-abstract interface class $PetInterface implements $NewPetInterface, $Pet_1Interface {}
-
 abstract class Pet implements $PetInterface, Built<Pet, PetBuilder> {
   /// Creates a new Pet object using the builder pattern.
   factory Pet([void Function(PetBuilder)? b]) = _$Pet;

diff --git a/packages/dynamite/dynamite/example/lib/petstore.openapi.g.dart b/packages/dynamite/dynamite/example/lib/petstore.openapi.g.dart
diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_interface.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_interface.dart
@@ -1,65 +1,9 @@
 import 'package:built_collection/built_collection.dart';
 import 'package:code_builder/code_builder.dart';
-import 'package:dynamite/src/builder/resolve_type.dart';
-import 'package:dynamite/src/builder/state.dart';
 import 'package:dynamite/src/helpers/built_value.dart';
 import 'package:dynamite/src/helpers/dart_helpers.dart';
-import 'package:dynamite/src/helpers/dynamite.dart';
-import 'package:dynamite/src/models/openapi.dart' as openapi;
 import 'package:dynamite/src/models/type_result.dart';
 
-TypeResultObject resolveInterface(
-  openapi.OpenAPI spec,
-  State state,
-  String identifier,
-  openapi.Schema schema,
-) {
-  final properties = schema.properties?.entries;
-
-  if (properties == null || properties.isEmpty) {
-    throw StateError('The schema must have a non empty properties field.');
-  }
-
-  final result = TypeResultObject(
-    identifier,
-  );
-
-  if (state.resolvedInterfaces.add(result)) {
-    final $interface = buildInterface(
-      identifier,
-      methods: BuiltList.build((b) {
-        b.addAll(
-          properties.map((property) {
-            final propertyName = property.key;
-            final propertySchema = property.value;
-
-            final result = resolveType(
-              spec,
-              state,
-              '${identifier}_${toDartName(propertyName, uppercaseFirstCharacter: true)}',
-              propertySchema,
-              nullable: isDartParameterNullable(
-                schema.required.contains(propertyName),
-                propertySchema,
-              ),
-            );
-
-            return generateProperty(
-              result,
-              propertyName,
-              propertySchema.formattedDescription,
-            );
-          }),
-        );
-      }),
-    );
-
-    state.output.add($interface);
-  }
-
-  return result;
-}
-
 Method generateProperty(
   TypeResult type,
   String propertyName,

diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_ofs.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_ofs.dart
@@ -5,6 +5,8 @@ import 'package:dynamite/src/builder/resolve_interface.dart';
 import 'package:dynamite/src/builder/resolve_type.dart';
 import 'package:dynamite/src/builder/state.dart';
 import 'package:dynamite/src/helpers/built_value.dart';
+import 'package:dynamite/src/helpers/dart_helpers.dart';
+import 'package:dynamite/src/helpers/dynamite.dart';
 import 'package:dynamite/src/models/openapi.dart' as openapi;
 import 'package:dynamite/src/models/type_result.dart';
 
@@ -76,13 +78,31 @@ TypeResult resolveAllOf(
 
     for (final s in schema.allOf!) {
       if (s.properties != null) {
-        final interfaceClass = resolveInterface(
-          spec,
-          state,
-          '${identifier}_${schema.allOf!.indexOf(s)}',
-          s,
+        final properties = s.properties!.entries;
+
+        methods.addAll(
+          properties.map((property) {
+            final propertyName = property.key;
+            final propertySchema = property.value;
+
+            final result = resolveType(
+              spec,
+              state,
+              '${identifier}_${toDartName(propertyName, uppercaseFirstCharacter: true)}',
+              propertySchema,
+              nullable: isDartParameterNullable(
+                s.required.contains(propertyName),
+                propertySchema,
+              ),
+            );
+
+            return generateProperty(
+              result,
+              propertyName,
+              propertySchema.formattedDescription,
+            );
+          }),
         );
-        interfaces.add(interfaceClass);
       } else {
         final object = resolveType(
           spec,

diff --git a/packages/dynamite/dynamite_end_to_end_test/lib/all_of.openapi.dart b/packages/dynamite/dynamite_end_to_end_test/lib/all_of.openapi.dart
@@ -16,20 +16,13 @@ import 'package:meta/meta.dart' as _i1;
 part 'all_of.openapi.g.dart';
 
 @BuiltValue(instantiable: false)
-abstract interface class $ObjectAllOf_0Interface {
+abstract interface class $ObjectAllOfInterface {
   @BuiltValueField(wireName: 'attribute1-allOf')
   String get attribute1AllOf;
-}
-
-@BuiltValue(instantiable: false)
-abstract interface class $ObjectAllOf_1Interface {
   @BuiltValueField(wireName: 'attribute2-allOf')
   String get attribute2AllOf;
 }
 
-@BuiltValue(instantiable: false)
-abstract interface class $ObjectAllOfInterface implements $ObjectAllOf_0Interface, $ObjectAllOf_1Interface {}
-
 /// All of with objects only.
 abstract class ObjectAllOf implements $ObjectAllOfInterface, Built<ObjectAllOf, ObjectAllOfBuilder> {
   /// Creates a new ObjectAllOf object using the builder pattern.
@@ -52,14 +45,11 @@ abstract class ObjectAllOf implements $ObjectAllOfInterface, Built<ObjectAllOf,
 }
 
 @BuiltValue(instantiable: false)
-abstract interface class $OneObjectAllOf_0Interface {
+abstract interface class $OneObjectAllOfInterface {
   @BuiltValueField(wireName: 'attribute-allOf')
   String get attributeAllOf;
 }
 
-@BuiltValue(instantiable: false)
-abstract interface class $OneObjectAllOfInterface implements $OneObjectAllOf_0Interface {}
-
 /// All of with one object value.
 abstract class OneObjectAllOf implements $OneObjectAllOfInterface, Built<OneObjectAllOf, OneObjectAllOfBuilder> {
   /// Creates a new OneObjectAllOf object using the builder pattern.
@@ -111,15 +101,11 @@ abstract class PrimitiveAllOf implements $PrimitiveAllOfInterface, Built<Primiti
 }
 
 @BuiltValue(instantiable: false)
-abstract interface class $MixedAllOf_1Interface {
-  @BuiltValueField(wireName: 'attribute-allOf')
-  String get attributeAllOf;
-}
-
-@BuiltValue(instantiable: false)
-abstract interface class $MixedAllOfInterface implements $MixedAllOf_1Interface {
+abstract interface class $MixedAllOfInterface {
   @BuiltValueField(wireName: 'String')
   String get string;
+  @BuiltValueField(wireName: 'attribute-allOf')
+  String get attributeAllOf;
 }
 
 /// All of with object and primitive value.