Merge pull request #932 from jmartisk/main-issue-871

Fragment support for dynamic clients

Author: phillip-kruger

client/api/src/main/java/io/smallrye/graphql/client/core/Document.java

@@ -10,7 +10,7 @@ public interface Document extends Buildable {
     /*
      * Static factory methods
      */
-    static Document document(Operation... operations) {
+    static Document document(FragmentOrOperation... operations) {
         Document document = getNewInstanceOf(Document.class);
 
         document.setOperations(asList(operations));
@@ -21,7 +21,7 @@ static Document document(Operation... operations) {
     /*
      * Getter/Setter
      */
-    List<Operation> getOperations();
+    List<FragmentOrOperation> getOperations();
 
-    void setOperations(List<Operation> operations);
+    void setOperations(List<FragmentOrOperation> operations);
 }

client/api/src/main/java/io/smallrye/graphql/client/core/Field.java

@@ -6,7 +6,7 @@
 
 import java.util.List;
 
-public interface Field extends Buildable {
+public interface Field extends FieldOrFragment {
     /*
      * Static factory methods
      */
@@ -26,7 +26,7 @@ static Field field(String name) {
     }
 
     // (name, subfields)
-    static Field field(String name, Field... fields) {
+    static Field field(String name, FieldOrFragment... fields) {
         Field field = getNewInstanceOf(Field.class);
 
         field.setName(name);
@@ -69,7 +69,7 @@ static Field field(String name, List<Argument> args, Field... fields) {
 
     void setArguments(List<Argument> arguments);
 
-    List<Field> getFields();
+    List<FieldOrFragment> getFields();
 
-    void setFields(List<Field> fields);
+    void setFields(List<FieldOrFragment> fields);
 }

client/api/src/main/java/io/smallrye/graphql/client/core/FieldOrFragment.java

@@ -0,0 +1,10 @@
+package io.smallrye.graphql.client.core;
+
+/**
+ * Represents one of these nodes in a GraphQL document:
+ * - regular field (name), for example "color"
+ * - reference to a named fragment, for example "...comparisonFields"
+ * - an inline fragment, for example ("... on Person { name } ")
+ */
+public interface FieldOrFragment extends Buildable {
+}

client/api/src/main/java/io/smallrye/graphql/client/core/Fragment.java

@@ -0,0 +1,65 @@
+package io.smallrye.graphql.client.core;
+
+import static io.smallrye.graphql.client.core.utils.ServiceUtils.getNewInstanceOf;
+import static java.util.Arrays.asList;
+
+import java.util.List;
+
+/**
+ * Represents a named fragment definition in a GraphQL document. Such definition consists of a name,
+ * target type, and a set of fields.
+ */
+public interface Fragment extends FragmentOrOperation {
+    /*
+     * Static factory methods
+     */
+    static List<Fragment> fragments(Fragment... fragments) {
+        return asList(fragments);
+    }
+
+    static FragmentBuilder fragment(String name) {
+        return new FragmentBuilder(name);
+    }
+
+    /*
+     * Getter/Setter
+     */
+    String getName();
+
+    void setName(String name);
+
+    String getTargetType();
+
+    void setTargetType(String name);
+
+    List<FieldOrFragment> getFields();
+
+    void setFields(List<FieldOrFragment> fields);
+
+    class FragmentBuilder {
+
+        private String name;
+
+        private String targetType;
+
+        private List<FieldOrFragment> fields;
+
+        FragmentBuilder(String name) {
+            this.name = name;
+        }
+
+        public Fragment on(String targetType, FieldOrFragment... fields) {
+            this.targetType = targetType;
+            this.fields = asList(fields);
+            return build();
+        }
+
+        Fragment build() {
+            Fragment fragment = getNewInstanceOf(Fragment.class);
+            fragment.setName(name);
+            fragment.setTargetType(targetType);
+            fragment.setFields(fields);
+            return fragment;
+        }
+    }
+}

client/api/src/main/java/io/smallrye/graphql/client/core/FragmentOrOperation.java

@@ -0,0 +1,9 @@
+package io.smallrye.graphql.client.core;
+
+/**
+ * Represents a node in a GraphQL document that can contain either an operation (query/mutation/subscription),
+ * or a definition of a named fragment. On the top level, a GraphQL document basically consists of a list
+ * of these nodes.
+ */
+public interface FragmentOrOperation extends Buildable {
+}

client/api/src/main/java/io/smallrye/graphql/client/core/FragmentReference.java

@@ -0,0 +1,35 @@
+package io.smallrye.graphql.client.core;
+
+import static io.smallrye.graphql.client.core.utils.ServiceUtils.getNewInstanceOf;
+
+/**
+ * Represents a reference to a named fragment.
+ */
+public interface FragmentReference extends FieldOrFragment {
+
+    /**
+     * Create a fragment reference by specifying the name of the target fragment.
+     * In the resulting document, this will appear as `...FRAGMENTNAME`
+     */
+    static FragmentReference fragmentRef(String name) {
+        FragmentReference ref = getNewInstanceOf(FragmentReference.class);
+        ref.setName(name);
+        return ref;
+    }
+
+    /**
+     * Create a fragment reference by providing a built instance of a named fragment.
+     * This will actually only use the name of the fragment - in the resulting document,
+     * this will appear as `...FRAGMENTNAME`
+     */
+    static FragmentReference fragmentRef(Fragment fragment) {
+        FragmentReference ref = getNewInstanceOf(FragmentReference.class);
+        ref.setName(fragment.getName());
+        return ref;
+    }
+
+    String getName();
+
+    void setName(String name);
+
+}

client/api/src/main/java/io/smallrye/graphql/client/core/InlineFragment.java

@@ -0,0 +1,31 @@
+package io.smallrye.graphql.client.core;
+
+import static io.smallrye.graphql.client.core.utils.ServiceUtils.getNewInstanceOf;
+import static java.util.Arrays.asList;
+
+import java.util.List;
+
+/**
+ * Represents an inline fragment in a GraphQL document. This can be used
+ * anywhere where a field is expected (thus it implements `FieldOrFragment`).
+ */
+public interface InlineFragment extends FieldOrFragment {
+
+    static InlineFragment on(String type, FieldOrFragment... fields) {
+        InlineFragment fragment = getNewInstanceOf(InlineFragment.class);
+
+        fragment.setType(type);
+        fragment.setFields(asList(fields));
+
+        return fragment;
+    }
+
+    String getType();
+
+    void setType(String name);
+
+    List<FieldOrFragment> getFields();
+
+    void setFields(List<FieldOrFragment> fields);
+
+}

client/api/src/main/java/io/smallrye/graphql/client/core/Operation.java

@@ -7,7 +7,7 @@
 
 import java.util.List;
 
-public interface Operation extends Buildable {
+public interface Operation extends FragmentOrOperation {
     /*
      * Helpers
      */
@@ -16,7 +16,7 @@ static List<Operation> operations(Operation... operations) {
     }
 
     // (fields)
-    static Operation operation(Field... fields) {
+    static Operation operation(FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(QUERY);
@@ -28,7 +28,7 @@ static Operation operation(Field... fields) {
     }
 
     // (vars, fields)
-    static Operation operation(List<Variable> vars, Field... fields) {
+    static Operation operation(List<Variable> vars, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(QUERY);
@@ -40,7 +40,7 @@ static Operation operation(List<Variable> vars, Field... fields) {
     }
 
     // (type, fields)
-    static Operation operation(OperationType type, Field... fields) {
+    static Operation operation(OperationType type, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(type);
@@ -52,7 +52,7 @@ static Operation operation(OperationType type, Field... fields) {
     }
 
     // (type, vars, fields)
-    static Operation operation(OperationType type, List<Variable> vars, Field... fields) {
+    static Operation operation(OperationType type, List<Variable> vars, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(type);
@@ -64,7 +64,7 @@ static Operation operation(OperationType type, List<Variable> vars, Field... fie
     }
 
     // (name, fields)
-    static Operation operation(String name, Field... fields) {
+    static Operation operation(String name, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(QUERY);
@@ -76,7 +76,7 @@ static Operation operation(String name, Field... fields) {
     }
 
     // (type, name, fields)
-    static Operation operation(OperationType type, String name, Field... fields) {
+    static Operation operation(OperationType type, String name, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(type);
@@ -88,7 +88,7 @@ static Operation operation(OperationType type, String name, Field... fields) {
     }
 
     // (name, vars, fields)
-    static Operation operation(String name, List<Variable> vars, Field... fields) {
+    static Operation operation(String name, List<Variable> vars, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(QUERY);
@@ -100,7 +100,7 @@ static Operation operation(String name, List<Variable> vars, Field... fields) {
     }
 
     // (type, name, vars, fields)
-    static Operation operation(OperationType type, String name, List<Variable> vars, Field... fields) {
+    static Operation operation(OperationType type, String name, List<Variable> vars, FieldOrFragment... fields) {
         Operation operation = getNewInstanceOf(Operation.class);
 
         operation.setType(type);
@@ -126,7 +126,7 @@ static Operation operation(OperationType type, String name, List<Variable> vars,
 
     void setVariables(List<Variable> vars);
 
-    List<Field> getFields();
+    List<FieldOrFragment> getFields();
 
-    void setFields(List<Field> fields);
+    void setFields(List<FieldOrFragment> fields);
 }

client/implementation/src/main/java/io/smallrye/graphql/client/dynamic/core/AbstractDocument.java

@@ -3,19 +3,19 @@
 import java.util.List;
 
 import io.smallrye.graphql.client.core.Document;
-import io.smallrye.graphql.client.core.Operation;
+import io.smallrye.graphql.client.core.FragmentOrOperation;
 
 public abstract class AbstractDocument implements Document {
-    private List<Operation> operations;
+    private List<FragmentOrOperation> operations;
 
     public AbstractDocument() {
     }
 
-    public List<Operation> getOperations() {
+    public List<FragmentOrOperation> getOperations() {
         return operations;
     }
 
-    public void setOperations(List<Operation> operations) {
+    public void setOperations(List<FragmentOrOperation> operations) {
         this.operations = operations;
     }
 }

client/implementation/src/main/java/io/smallrye/graphql/client/dynamic/core/AbstractField.java

@@ -4,11 +4,12 @@
 
 import io.smallrye.graphql.client.core.Argument;
 import io.smallrye.graphql.client.core.Field;
+import io.smallrye.graphql.client.core.FieldOrFragment;
 
 public abstract class AbstractField implements Field {
     private String name;
     private List<Argument> arguments;
-    private List<Field> fields;
+    private List<FieldOrFragment> fields;
 
     public AbstractField() {
     }
@@ -29,11 +30,11 @@ public void setArguments(List<Argument> arguments) {
         this.arguments = arguments;
     }
 
-    public List<Field> getFields() {
+    public List<FieldOrFragment> getFields() {
         return fields;
     }
 
-    public void setFields(List<Field> fields) {
+    public void setFields(List<FieldOrFragment> fields) {
         this.fields = fields;
     }
 }