[3656] Add the ability to customize the GraphQL type resolver

Bug: #3656 Signed-off-by: Stéphane Bégaudeau <[email protected]>
eclipse-sirius · Jun 20, 2024 · 94eba3c · 94eba3c
1 parent 89166ea
commit 94eba3c
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 5 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -107,6 +107,8 @@ image:doc/screenshots/insideLabelPositions.png[Inside label positions, 70%]
 - https://github.com/eclipse-sirius/sirius-web/issues/3561[#3561] [diagram] Add support for background and border on diagram labels
 - https://github.com/eclipse-sirius/sirius-web/issues/3604[#3604] [diagram] Make node overlap resolution faster during "Arrange All"
 - https://github.com/eclipse-sirius/sirius-web/issues/3634[#3634] [sirius-web] Simplifying the contribution to the GraphQL subscription of the diagram for custom nodes
+- https://github.com/eclipse-sirius/sirius-web/issues/3656[#3656] [core] Add the ability to customize the GraphQL type resolver
+
 
 == v2024.5.0
 

diff --git a/...ql-api/src/main/java/org/eclipse/sirius/components/graphql/api/ITypeResolverDelegate.java b/...ql-api/src/main/java/org/eclipse/sirius/components/graphql/api/ITypeResolverDelegate.java
@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.components.graphql.api;
+
+import graphql.TypeResolutionEnvironment;
+import graphql.schema.GraphQLObjectType;
+
+/**
+ * Used to find GraphQL object type not found by the reflective type resolver.
+ *
+ * @author sbegaudeau
+ */
+public interface ITypeResolverDelegate {
+    GraphQLObjectType getType(TypeResolutionEnvironment environment);
+}
diff --git a/...l-api/src/main/java/org/eclipse/sirius/components/graphql/api/ReflectiveTypeResolver.java b/...l-api/src/main/java/org/eclipse/sirius/components/graphql/api/ReflectiveTypeResolver.java
@@ -12,6 +12,9 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.graphql.api;
 
+import java.util.List;
+import java.util.Objects;
+
 import graphql.TypeResolutionEnvironment;
 import graphql.schema.GraphQLObjectType;
 import graphql.schema.GraphQLSchema;
@@ -24,11 +27,27 @@
  */
 public class ReflectiveTypeResolver implements TypeResolver {
 
+    private final List<ITypeResolverDelegate> typeResolverDelegates;
+
+    public ReflectiveTypeResolver(List<ITypeResolverDelegate> typeResolverDelegates) {
+        this.typeResolverDelegates = Objects.requireNonNull(typeResolverDelegates);
+    }
+
     @Override
     public GraphQLObjectType getType(TypeResolutionEnvironment environment) {
         GraphQLSchema graphQLSchema = environment.getSchema();
         Object object = environment.getObject();
-        return graphQLSchema.getObjectType(object.getClass().getSimpleName());
+        var graphQLObjectType = graphQLSchema.getObjectType(object.getClass().getSimpleName());
+
+        if (graphQLObjectType == null) {
+            graphQLObjectType = this.typeResolverDelegates.stream()
+                    .map(typeResolverDelegate -> typeResolverDelegate.getType(environment))
+                    .filter(Objects::nonNull)
+                    .findFirst()
+                    .orElse(null);
+        }
+
+        return graphQLObjectType;
     }
 
 }
diff --git a/...phql/src/main/java/org/eclipse/sirius/web/graphql/configuration/GraphQLWiringFactory.java b/...phql/src/main/java/org/eclipse/sirius/web/graphql/configuration/GraphQLWiringFactory.java
@@ -12,6 +12,10 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.graphql.configuration;
 
+import java.util.List;
+import java.util.Objects;
+
+import org.eclipse.sirius.components.graphql.api.ITypeResolverDelegate;
 import org.eclipse.sirius.components.graphql.api.ReflectiveTypeResolver;
 import org.springframework.stereotype.Service;
 
@@ -28,14 +32,20 @@
 @Service
 public class GraphQLWiringFactory implements WiringFactory {
 
+    private final List<ITypeResolverDelegate> typeResolverDelegates;
+
+    public GraphQLWiringFactory(List<ITypeResolverDelegate> typeResolverDelegates) {
+        this.typeResolverDelegates = Objects.requireNonNull(typeResolverDelegates);
+    }
+
     @Override
     public boolean providesTypeResolver(InterfaceWiringEnvironment environment) {
         return true;
     }
 
     @Override
     public TypeResolver getTypeResolver(InterfaceWiringEnvironment environment) {
-        return new ReflectiveTypeResolver();
+        return new ReflectiveTypeResolver(this.typeResolverDelegates);
     }
 
     @Override
@@ -45,6 +55,6 @@ public boolean providesTypeResolver(UnionWiringEnvironment environment) {
 
     @Override
     public TypeResolver getTypeResolver(UnionWiringEnvironment environment) {
-        return new ReflectiveTypeResolver();
+        return new ReflectiveTypeResolver(this.typeResolverDelegates);
     }
 }
diff --git a/...ure/src/main/java/org/eclipse/sirius/web/infrastructure/graphql/GraphQLWiringFactory.java b/...ure/src/main/java/org/eclipse/sirius/web/infrastructure/graphql/GraphQLWiringFactory.java
@@ -12,6 +12,10 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.infrastructure.graphql;
 
+import java.util.List;
+import java.util.Objects;
+
+import org.eclipse.sirius.components.graphql.api.ITypeResolverDelegate;
 import org.eclipse.sirius.components.graphql.api.ReflectiveTypeResolver;
 import org.springframework.stereotype.Service;
 
@@ -28,14 +32,20 @@
 @Service
 public class GraphQLWiringFactory implements WiringFactory {
 
+    private final List<ITypeResolverDelegate> typeResolverDelegates;
+
+    public GraphQLWiringFactory(List<ITypeResolverDelegate> typeResolverDelegates) {
+        this.typeResolverDelegates = Objects.requireNonNull(typeResolverDelegates);
+    }
+
     @Override
     public boolean providesTypeResolver(InterfaceWiringEnvironment environment) {
         return true;
     }
 
     @Override
     public TypeResolver getTypeResolver(InterfaceWiringEnvironment environment) {
-        return new ReflectiveTypeResolver();
+        return new ReflectiveTypeResolver(this.typeResolverDelegates);
     }
 
     @Override
@@ -45,6 +55,6 @@ public boolean providesTypeResolver(UnionWiringEnvironment environment) {
 
     @Override
     public TypeResolver getTypeResolver(UnionWiringEnvironment environment) {
-        return new ReflectiveTypeResolver();
+        return new ReflectiveTypeResolver(this.typeResolverDelegates);
     }
 }