Merge pull request #303 from comigor/bugfix/union-generation

Bugfix/union generation
comigor · May 4, 2021 · d92d3f2 · d92d3f2
2 parents aa066f6 + 8173c7b
commit d92d3f2
Show file tree

Hide file tree

Showing 13 changed files with 409 additions and 57 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 7.0.0-beta.10
+
+- union generation fix for https://github.com/comigor/artemis/issues/284
+
 ## 7.0.0-beta.9
 
 - nullable scalar_mapping types

diff --git a/lib/generator.dart b/lib/generator.dart
@@ -1,5 +1,6 @@
 import 'package:artemis/generator/data/data.dart';
 import 'package:artemis/generator/data/enum_value_definition.dart';
+import 'package:artemis/generator/data/nullable.dart';
 import 'package:artemis/visitor/canonical_visitor.dart';
 import 'package:artemis/visitor/generator_visitor.dart';
 import 'package:artemis/visitor/object_type_definition_visitor.dart';
@@ -179,19 +180,15 @@ Iterable<QueryDefinition> generateDefinitions(
                 .value ??
             suffix;
 
-    // if (rootTypeName == null) {
-    //   throw Exception(
-    //       '''No root type was found for ${operation.type} $operationName.''');
-    // }
-
     final TypeDefinitionNode parentType =
         objectVisitor.getByName(rootTypeName)!;
 
     final name = QueryName.fromPath(
-        path: createPathName([
-      ClassName(name: operationName),
-      ClassName(name: parentType.name.value)
-    ], schemaMap.namingScheme));
+      path: createPathName([
+        ClassName(name: operationName),
+        ClassName(name: parentType.name.value)
+      ], schemaMap.namingScheme),
+    );
 
     final context = Context(
       schema: schema,
@@ -298,8 +295,7 @@ ClassProperty createClassProperty({
 Make sure your query is correct and your schema is updated.''');
   }
 
-  final nextType =
-      gql.getTypeByName(context.schema, fieldType, context: 'field node');
+  final nextType = gql.getTypeByName(context.schema, fieldType);
 
   final aliasedContext = context.withAlias(
     nextFieldName: fieldName,
@@ -335,6 +331,7 @@ Make sure your query is correct and your schema is updated.''');
         nextFieldName: nextFieldName,
         nextClassName: ClassName(name: nextType.name.value),
         alias: fieldAlias,
+        ofUnion: Nullable<TypeDefinitionNode?>(null),
       ),
     );
   }

diff --git a/lib/generator/data/nullable.dart b/lib/generator/data/nullable.dart
@@ -0,0 +1,12 @@
+/// Allows to reset values back to null in `copyWith` pattern
+class Nullable<T> {
+  final T _value;
+
+  /// Sets desired value
+  Nullable(this._value);
+
+  /// Gets the real value
+  T get value {
+    return _value;
+  }
+}
diff --git a/lib/generator/ephemeral_data.dart b/lib/generator/ephemeral_data.dart
@@ -1,4 +1,5 @@
 import 'package:artemis/generator/data/data.dart';
+import 'package:artemis/generator/data/nullable.dart';
 import 'package:gql/ast.dart';
 import '../schema/options.dart';
 
@@ -113,7 +114,7 @@ class Context {
     required TypeDefinitionNode nextType,
     required Name? nextFieldName,
     required Name? nextClassName,
-    TypeDefinitionNode? ofUnion,
+    Nullable<TypeDefinitionNode?>? ofUnion,
     Name? alias,
     List<Definition>? generatedClasses,
     List<QueryInput>? inputsClasses,
@@ -127,7 +128,7 @@ class Context {
         currentType: nextType,
         currentFieldName: nextFieldName,
         currentClassName: nextClassName,
-        ofUnion: ofUnion ?? this.ofUnion,
+        ofUnion: ofUnion == null ? this.ofUnion : ofUnion.value,
         generatedClasses: generatedClasses ?? this.generatedClasses,
         inputsClasses: inputsClasses ?? this.inputsClasses,
         fragments: fragments ?? this.fragments,
@@ -142,7 +143,7 @@ class Context {
     Name? nextFieldName,
     Name? nextClassName,
     Name? alias,
-    TypeDefinitionNode? ofUnion,
+    Nullable<TypeDefinitionNode?>? ofUnion,
     List<Definition>? generatedClasses,
     List<QueryInput>? inputsClasses,
     List<FragmentDefinitionNode>? fragments,
@@ -163,7 +164,7 @@ class Context {
       currentType: nextType,
       currentFieldName: nextFieldName,
       currentClassName: nextClassName,
-      ofUnion: ofUnion ?? this.ofUnion,
+      ofUnion: ofUnion == null ? this.ofUnion : ofUnion.value,
       generatedClasses: generatedClasses ?? this.generatedClasses,
       inputsClasses: inputsClasses ?? this.inputsClasses,
       fragments: fragments ?? this.fragments,
@@ -202,7 +203,7 @@ class Context {
     Name? nextFieldName,
     Name? nextClassName,
     Name? alias,
-    TypeDefinitionNode? ofUnion,
+    Nullable<TypeDefinitionNode?>? ofUnion,
     List<Definition>? generatedClasses,
     List<QueryInput>? inputsClasses,
     List<FragmentDefinitionNode>? fragments,
@@ -224,7 +225,7 @@ class Context {
       currentType: currentType,
       currentFieldName: nextFieldName ?? currentFieldName,
       currentClassName: nextClassName ?? currentClassName,
-      ofUnion: ofUnion ?? this.ofUnion,
+      ofUnion: ofUnion == null ? this.ofUnion : ofUnion.value,
       alias: alias ?? this.alias,
       generatedClasses: generatedClasses ?? this.generatedClasses,
       inputsClasses: inputsClasses ?? this.inputsClasses,
@@ -260,7 +261,7 @@ class Context {
   /// Returns a copy of this context, with the same type, but on the first path.
   Context sameTypeWithNoPath({
     Name? alias,
-    TypeDefinitionNode? ofUnion,
+    Nullable<TypeDefinitionNode?>? ofUnion,
     List<Definition>? generatedClasses,
     List<QueryInput>? inputsClasses,
     List<FragmentDefinitionNode>? fragments,
@@ -273,7 +274,7 @@ class Context {
         currentType: currentType,
         currentFieldName: currentFieldName,
         currentClassName: currentClassName,
-        ofUnion: ofUnion ?? this.ofUnion,
+        ofUnion: ofUnion == null ? this.ofUnion : ofUnion.value,
         alias: alias ?? this.alias,
         generatedClasses: generatedClasses ?? this.generatedClasses,
         inputsClasses: inputsClasses ?? this.inputsClasses,
@@ -288,7 +289,7 @@ class Context {
     required TypeDefinitionNode nextType,
     required Name nextFieldName,
     required Name nextClassName,
-    TypeDefinitionNode? ofUnion,
+    Nullable<TypeDefinitionNode?>? ofUnion,
     Name? alias,
     List<Definition>? generatedClasses,
     List<QueryInput>? inputsClasses,
@@ -302,7 +303,7 @@ class Context {
         currentType: nextType,
         currentFieldName: nextFieldName,
         currentClassName: nextClassName,
-        ofUnion: ofUnion ?? this.ofUnion,
+        ofUnion: ofUnion == null ? this.ofUnion : ofUnion.value,
         alias: alias ?? this.alias,
         generatedClasses: generatedClasses ?? this.generatedClasses,
         inputsClasses: inputsClasses ?? this.inputsClasses,

diff --git a/lib/generator/graphql_helpers.dart b/lib/generator/graphql_helpers.dart
@@ -7,12 +7,11 @@ import '../schema/options.dart';
 import 'data/definition.dart';
 
 /// Get a full [TypeDefinitionNode] from a type node.
-TypeDefinitionNode getTypeByName(DocumentNode schema, TypeNode typeNode,
-    {String? context}) {
+TypeDefinitionNode getTypeByName(DocumentNode schema, TypeNode typeNode) {
   late NamedTypeNode namedNode;
 
   if (typeNode is ListTypeNode) {
-    return getTypeByName(schema, typeNode.type, context: context);
+    return getTypeByName(schema, typeNode.type);
   }
 
   if (typeNode is NamedTypeNode) {

diff --git a/lib/visitor/canonical_visitor.dart b/lib/visitor/canonical_visitor.dart
@@ -1,6 +1,7 @@
 import 'package:artemis/generator.dart';
 import 'package:artemis/generator/data/data.dart';
 import 'package:artemis/generator/data/enum_value_definition.dart';
+import 'package:artemis/generator/data/nullable.dart';
 import 'package:artemis/generator/ephemeral_data.dart';
 import 'package:artemis/generator/helpers.dart';
 import 'package:artemis/generator/graphql_helpers.dart' as gql;
@@ -26,7 +27,10 @@ class CanonicalVisitor extends RecursiveVisitor {
   void visitEnumTypeDefinitionNode(EnumTypeDefinitionNode node) {
     final enumName = EnumName(name: node.name.value);
 
-    final nextContext = context.sameTypeWithNoPath(alias: enumName);
+    final nextContext = context.sameTypeWithNoPath(
+      alias: enumName,
+      ofUnion: Nullable<TypeDefinitionNode?>(null),
+    );
 
     logFn(context, nextContext.align, '-> Enum');
     logFn(context, nextContext.align,
@@ -47,7 +51,10 @@ class CanonicalVisitor extends RecursiveVisitor {
   @override
   void visitInputObjectTypeDefinitionNode(InputObjectTypeDefinitionNode node) {
     final name = ClassName(name: node.name.value);
-    final nextContext = context.sameTypeWithNoPath(alias: name);
+    final nextContext = context.sameTypeWithNoPath(
+      alias: name,
+      ofUnion: Nullable<TypeDefinitionNode?>(null),
+    );
 
     logFn(context, nextContext.align, '-> Input class');
     logFn(context, nextContext.align,
@@ -62,6 +69,7 @@ class CanonicalVisitor extends RecursiveVisitor {
           nextType: node,
           nextClassName: ClassName(name: nextType.name.value),
           nextFieldName: ClassName(name: i.name.value),
+          ofUnion: Nullable<TypeDefinitionNode?>(null),
         ),
         markAsUsed: false,
       );

diff --git a/lib/visitor/generator_visitor.dart b/lib/visitor/generator_visitor.dart
@@ -1,5 +1,6 @@
 import 'package:artemis/generator.dart';
 import 'package:artemis/generator/data/data.dart';
+import 'package:artemis/generator/data/nullable.dart';
 import 'package:artemis/generator/ephemeral_data.dart';
 import 'package:artemis/generator/graphql_helpers.dart' as gql;
 import 'package:artemis/generator/helpers.dart';
@@ -93,16 +94,15 @@ class GeneratorVisitor extends RecursiveVisitor {
   void visitInlineFragmentNode(InlineFragmentNode node) {
     logFn(context, context.align + 1,
         '${context.path}: ... on ${node.typeCondition!.on.name.value}');
-    final nextType = gql.getTypeByName(context.schema, node.typeCondition!.on,
-        context: 'inline fragment');
+    final nextType = gql.getTypeByName(context.schema, node.typeCondition!.on);
 
     if (nextType.name.value == context.currentType!.name.value) {
       final visitor = GeneratorVisitor(
         context: context.nextTypeWithSamePath(
           nextType: nextType,
           nextClassName: null,
           nextFieldName: null,
-          ofUnion: context.currentType,
+          ofUnion: Nullable<TypeDefinitionNode?>(context.currentType),
           inputsClasses: [],
           fragments: [],
         ),
@@ -114,7 +114,7 @@ class GeneratorVisitor extends RecursiveVisitor {
           nextType: nextType,
           nextClassName: ClassName(name: nextType.name.value),
           nextFieldName: ClassPropertyName(name: nextType.name.value),
-          ofUnion: context.currentType,
+          ofUnion: Nullable<TypeDefinitionNode?>(context.currentType),
           inputsClasses: [],
           fragments: [],
         ),
@@ -142,14 +142,14 @@ class GeneratorVisitor extends RecursiveVisitor {
 
   @override
   void visitVariableDefinitionNode(VariableDefinitionNode node) {
-    final leafType = gql.getTypeByName(context.schema, node.type,
-        context: 'variable definition');
+    final leafType = gql.getTypeByName(context.schema, node.type);
 
     final nextClassName = context
         .nextTypeWithNoPath(
           nextType: leafType,
           nextClassName: ClassName(name: leafType.name.value),
           nextFieldName: ClassName(name: node.variable.name.value),
+          ofUnion: Nullable<TypeDefinitionNode?>(null),
         )
         .fullPathName();
 
@@ -232,13 +232,17 @@ class GeneratorVisitor extends RecursiveVisitor {
         '${context.path}: ... expanding ${node.name.value}');
     final fragmentName = FragmentName.fromPath(
         path: context
-            .sameTypeWithNoPath(alias: FragmentName(name: node.name.value))
+            .sameTypeWithNoPath(
+              alias: FragmentName(name: node.name.value),
+              ofUnion: Nullable<TypeDefinitionNode?>(null),
+            )
             .fullPathName());
 
     final visitor = GeneratorVisitor(
       context: context.sameTypeWithNextPath(
         alias: fragmentName,
         generatedClasses: [],
+        ofUnion: Nullable<TypeDefinitionNode?>(null),
         log: false,
       ),
     );
@@ -254,16 +258,18 @@ class GeneratorVisitor extends RecursiveVisitor {
   @override
   void visitFragmentDefinitionNode(FragmentDefinitionNode node) {
     final partName = FragmentName(name: node.name.value);
-    final nextContext = context.sameTypeWithNoPath(alias: partName);
+    final nextContext = context.sameTypeWithNoPath(
+      alias: partName,
+      ofUnion: Nullable<TypeDefinitionNode?>(null),
+    );
 
     logFn(context, nextContext.align, '-> Fragment');
     logFn(context, nextContext.align,
         '┌ ${nextContext.path}[${node.name.value}]');
     nextContext.fragments.add(node);
 
-    final nextType = gql.getTypeByName(
-        nextContext.schema, node.typeCondition.on,
-        context: 'fragment definition');
+    final nextType =
+        gql.getTypeByName(nextContext.schema, node.typeCondition.on);
 
     final visitorContext = Context(
       schema: context.schema,

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: artemis
-version: 7.0.0-beta.9
+version: 7.0.0-beta.10
 
 description: Build dart types from GraphQL schemas and queries (using Introspection Query).
 homepage: https://github.com/comigor/artemis

diff --git a/test/query_generator/deprecated/deprecated_interface_field_test.dart b/test/query_generator/deprecated/deprecated_interface_field_test.dart
@@ -86,7 +86,6 @@ final LibraryDefinition libraryDefinition =
             isInput: false),
         ClassDefinition(
             name: ClassName(name: r'Custom$_Query$_Node$_ChatMessage$_User'),
-            extension: ClassName(name: r'Custom$_Query$_Node$_ChatMessage'),
             mixins: [FragmentName(name: r'UserFragMixin')],
             factoryPossibilities: {},
             typeNameField: ClassPropertyName(name: r'__typename'),
@@ -191,7 +190,7 @@ class Custom$Query$Node$User extends Custom$Query$Node
 }
 
 @JsonSerializable(explicitToJson: true)
-class Custom$Query$Node$ChatMessage$User extends Custom$Query$Node$ChatMessage
+class Custom$Query$Node$ChatMessage$User extends JsonSerializable
     with EquatableMixin, UserFragMixin {
   Custom$Query$Node$ChatMessage$User();
 

diff --git a/test/query_generator/interfaces/interface_fragment_glob_test.dart b/test/query_generator/interfaces/interface_fragment_glob_test.dart
@@ -93,7 +93,6 @@ final LibraryDefinition libraryDefinition =
         ClassDefinition(
             name:
                 ClassName(name: r'Custom$_Query$_nodeById$_chatMessage$_user'),
-            extension: ClassName(name: r'Custom$_Query$_nodeById$_chatMessage'),
             mixins: [FragmentName(name: r'UserFragMixin')],
             factoryPossibilities: {},
             typeNameField: ClassPropertyName(name: r'__typename'),
@@ -196,8 +195,7 @@ class Custom$Query$NodeById$User extends Custom$Query$NodeById
 }
 
 @JsonSerializable(explicitToJson: true)
-class Custom$Query$NodeById$ChatMessage$User
-    extends Custom$Query$NodeById$ChatMessage
+class Custom$Query$NodeById$ChatMessage$User extends JsonSerializable
     with EquatableMixin, UserFragMixin {
   Custom$Query$NodeById$ChatMessage$User();
 

diff --git a/test/query_generator/interfaces/interface_test.dart b/test/query_generator/interfaces/interface_test.dart
@@ -84,7 +84,6 @@ final LibraryDefinition libraryDefinition =
             isInput: false),
         ClassDefinition(
             name: ClassName(name: r'Custom$_Query$_Node$_ChatMessage$_User'),
-            extension: ClassName(name: r'Custom$_Query$_Node$_ChatMessage'),
             mixins: [FragmentName(name: r'UserFragMixin')],
             factoryPossibilities: {},
             typeNameField: ClassPropertyName(name: r'__typename'),
@@ -187,7 +186,7 @@ class Custom$Query$Node$User extends Custom$Query$Node
 }
 
 @JsonSerializable(explicitToJson: true)
-class Custom$Query$Node$ChatMessage$User extends Custom$Query$Node$ChatMessage
+class Custom$Query$Node$ChatMessage$User extends JsonSerializable
     with EquatableMixin, UserFragMixin {
   Custom$Query$Node$ChatMessage$User();