Issues #184 and #198: error with custom class out of plugin classpath

Author: etienne-sf

CHANGELOG.md

@@ -1,35 +1,11 @@
 
+# 1.18.12
 
-# 2.0
-
-Change of some plugin parameters value (please read either [[Client migration from 1.x to 2.x|client_migrate_1-x_to_2-x]] or [[Server migration from 1.x to 2.x|server_migrate_1-x_to_2-x]] for more information) changed of default value:
-* copyRuntimeSources: false _(both client and server mode)_
-* generateBatchLoaderEnvironment: true _(server only)_
-* generateDeprecatedRequestResponse: false _(client only)_
-* skipGenerationIfSchemaHasNotChanged: true _(both client and server mode)_
-It was initially planned to force their value to the new default valye. But this would have too much impact on the existing code. Changing the default value allows 'old' users to minimize the impact when switching to the 2.0 version, while new user will use cleaner code.
-
-
-# 2.0RC1
-
-Release Candidate version for the 2.x versions.
-
-Main changes:
-* Based on [spring-graphql](https://spring.io/projects/spring-graphql)
-* Upgrade of dependencies, based on [spring-boot 2.7.10](https://docs.spring.io/spring-boot/docs/2.7.10/reference/html/)
-* Needs JDK 17 to be build, but the generated artifact is compatible with Java 8
-* Compatibility with Spring Boot 3.
-    * For a sample of this, you can check the [graphql-maven-plugin-samples-Forum-client](https://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master_2.x/graphql-maven-plugin-samples/graphql-maven-plugin-samples-Forum-client) and the [graphql-maven-plugin-samples-Forum-server](https://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master_2.x/graphql-maven-plugin-samples/graphql-maven-plugin-samples-Forum-server) samples that are part of the build.
-* __gradle plugin__: The id changed from `com.graphql_java_generator.graphql-gradle-plugin` to `com.graphql-java-generator.graphql-gradle-plugin`
-
-You can check these pages for more information on how to migrate from 1.x versions:
-* [[Client migration from 1.x to 2.x|client_migrate_1-x_to_2-x]]
-* [[Server migration from 1.x to 2.x|server_migrate_1-x_to_2-x]]
-
-Know issues:
-* All builds for servers should be executed with a clean (_mvn clean install_ or _gradlew clean build_), otherwise the GraphQL schema available at runtime becomes invalid. The server won't start.
-* For Spring 3, in client mode, copyRuntimeSources should be manually to false, to avoid compilation errors
+Client and server modes:
+* Correction of issues #184 and #198: error with custom scalars, when the custom scalar's class is not in the plugin's classpath
 
+Client mode:
+* Issue 199: the generated code would not compile if the GraphQL schema is too big
 
 
 # 1.18.11

graphql-java-common-runtime/src/main/java/com/graphql_java_generator/util/GraphqlUtils.java

@@ -127,6 +127,159 @@ public GraphqlUtils() {
 		javaKeywords.add("void");
 		javaKeywords.add("volatile");
 		javaKeywords.add("while");
+		this.javaKeywords.add("abstract");
+		this.javaKeywords.add("assert");
+		this.javaKeywords.add("boolean");
+		this.javaKeywords.add("break");
+		this.javaKeywords.add("byte");
+		this.javaKeywords.add("case");
+		this.javaKeywords.add("catch");
+		this.javaKeywords.add("char");
+		this.javaKeywords.add("class");
+		this.javaKeywords.add("const");
+		this.javaKeywords.add("continue");
+		this.javaKeywords.add("default");
+		this.javaKeywords.add("do");
+		this.javaKeywords.add("double");
+		this.javaKeywords.add("else");
+		this.javaKeywords.add("enum");
+		this.javaKeywords.add("extends");
+		this.javaKeywords.add("final");
+		this.javaKeywords.add("finally");
+		this.javaKeywords.add("float");
+		this.javaKeywords.add("for");
+		this.javaKeywords.add("goto");
+		this.javaKeywords.add("if");
+		this.javaKeywords.add("implements");
+		this.javaKeywords.add("import");
+		this.javaKeywords.add("instanceof");
+		this.javaKeywords.add("int");
+		this.javaKeywords.add("interface");
+		this.javaKeywords.add("long");
+		this.javaKeywords.add("native");
+		this.javaKeywords.add("new");
+		this.javaKeywords.add("null");
+		this.javaKeywords.add("package");
+		this.javaKeywords.add("private");
+		this.javaKeywords.add("protected");
+		this.javaKeywords.add("public");
+		this.javaKeywords.add("return");
+		this.javaKeywords.add("short");
+		this.javaKeywords.add("static");
+		this.javaKeywords.add("strictfp");
+		this.javaKeywords.add("super");
+		this.javaKeywords.add("switch");
+		this.javaKeywords.add("synchronized");
+		this.javaKeywords.add("this");
+		this.javaKeywords.add("throw");
+		this.javaKeywords.add("throws");
+		this.javaKeywords.add("transient");
+		this.javaKeywords.add("try");
+		this.javaKeywords.add("void");
+		this.javaKeywords.add("volatile");
+		this.javaKeywords.add("while");
+		this.javaKeywords.add("abstract");
+		this.javaKeywords.add("assert");
+		this.javaKeywords.add("boolean");
+		this.javaKeywords.add("break");
+		this.javaKeywords.add("byte");
+		this.javaKeywords.add("case");
+		this.javaKeywords.add("catch");
+		this.javaKeywords.add("char");
+		this.javaKeywords.add("class");
+		this.javaKeywords.add("const");
+		this.javaKeywords.add("continue");
+		this.javaKeywords.add("default");
+		this.javaKeywords.add("do");
+		this.javaKeywords.add("double");
+		this.javaKeywords.add("else");
+		this.javaKeywords.add("enum");
+		this.javaKeywords.add("extends");
+		this.javaKeywords.add("final");
+		this.javaKeywords.add("finally");
+		this.javaKeywords.add("float");
+		this.javaKeywords.add("for");
+		this.javaKeywords.add("goto");
+		this.javaKeywords.add("if");
+		this.javaKeywords.add("implements");
+		this.javaKeywords.add("import");
+		this.javaKeywords.add("instanceof");
+		this.javaKeywords.add("int");
+		this.javaKeywords.add("interface");
+		this.javaKeywords.add("long");
+		this.javaKeywords.add("native");
+		this.javaKeywords.add("new");
+		this.javaKeywords.add("null");
+		this.javaKeywords.add("package");
+		this.javaKeywords.add("private");
+		this.javaKeywords.add("protected");
+		this.javaKeywords.add("public");
+		this.javaKeywords.add("return");
+		this.javaKeywords.add("short");
+		this.javaKeywords.add("static");
+		this.javaKeywords.add("strictfp");
+		this.javaKeywords.add("super");
+		this.javaKeywords.add("switch");
+		this.javaKeywords.add("synchronized");
+		this.javaKeywords.add("this");
+		this.javaKeywords.add("throw");
+		this.javaKeywords.add("throws");
+		this.javaKeywords.add("transient");
+		this.javaKeywords.add("try");
+		this.javaKeywords.add("void");
+		this.javaKeywords.add("volatile");
+		this.javaKeywords.add("while");
+		this.javaKeywords.add("abstract");
+		this.javaKeywords.add("assert");
+		this.javaKeywords.add("boolean");
+		this.javaKeywords.add("break");
+		this.javaKeywords.add("byte");
+		this.javaKeywords.add("case");
+		this.javaKeywords.add("catch");
+		this.javaKeywords.add("char");
+		this.javaKeywords.add("class");
+		this.javaKeywords.add("const");
+		this.javaKeywords.add("continue");
+		this.javaKeywords.add("default");
+		this.javaKeywords.add("do");
+		this.javaKeywords.add("double");
+		this.javaKeywords.add("else");
+		this.javaKeywords.add("enum");
+		this.javaKeywords.add("extends");
+		this.javaKeywords.add("final");
+		this.javaKeywords.add("finally");
+		this.javaKeywords.add("float");
+		this.javaKeywords.add("for");
+		this.javaKeywords.add("goto");
+		this.javaKeywords.add("if");
+		this.javaKeywords.add("implements");
+		this.javaKeywords.add("import");
+		this.javaKeywords.add("instanceof");
+		this.javaKeywords.add("int");
+		this.javaKeywords.add("interface");
+		this.javaKeywords.add("long");
+		this.javaKeywords.add("native");
+		this.javaKeywords.add("new");
+		this.javaKeywords.add("null");
+		this.javaKeywords.add("package");
+		this.javaKeywords.add("private");
+		this.javaKeywords.add("protected");
+		this.javaKeywords.add("public");
+		this.javaKeywords.add("return");
+		this.javaKeywords.add("short");
+		this.javaKeywords.add("static");
+		this.javaKeywords.add("strictfp");
+		this.javaKeywords.add("super");
+		this.javaKeywords.add("switch");
+		this.javaKeywords.add("synchronized");
+		this.javaKeywords.add("this");
+		this.javaKeywords.add("throw");
+		this.javaKeywords.add("throws");
+		this.javaKeywords.add("transient");
+		this.javaKeywords.add("try");
+		this.javaKeywords.add("void");
+		this.javaKeywords.add("volatile");
+		this.javaKeywords.add("while");
 	}
 
 	/**
@@ -141,17 +294,17 @@ public String getRuntimeVersion() {
 	 * Loads the runtime properties file, from the graphql-java-runtime.properties file.
 	 */
 	private Properties getProperties() {
-		if (properties == null) {
-			properties = new Properties();
+		if (this.properties == null) {
+			this.properties = new Properties();
 			try (InputStream res = getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE)) {
-				properties.load(res);
+				this.properties.load(res);
 			} catch (IOException e) {
 				String msg = "Error while reading the '" + PROPERTIES_FILE + "' properties file: " + e.getMessage();
 				logger.error(msg);
 				throw new RuntimeException(msg, e);
 			}
 		}
-		return properties;
+		return this.properties;
 	}
 
 	/**
@@ -919,7 +1072,7 @@ public String getJavaName(String name) {
 	 * @return
 	 */
 	public boolean isJavaReservedWords(String name) {
-		return javaKeywords.contains(name);
+		return this.javaKeywords.contains(name);
 	}
 
 	/**
@@ -968,14 +1121,8 @@ public String getPackageName(String classFullNameParam) {
 			return null; // No package for primitive types
 		}
 
-		try {
-			Class<?> cls = Class.forName(classFullName);
-			return cls.getPackage().getName();
-		} catch (ClassNotFoundException e) {
-			throw new RuntimeException(
-					"Could not find the package for the class '" + classFullNameParam + "', due to: " + e.getMessage(),
-					e);
-		}
+		int lstPointPosition = classFullName.lastIndexOf('.');
+		return classFullName.substring(0, lstPointPosition);
 	}
 
 	/**

graphql-maven-plugin-logic/src/test/java/com/generated/graphql/samples/customscalar/CustomId.java

@@ -0,0 +1,33 @@
+/**
+ * 
+ */
+package com.generated.graphql.samples.customscalar;
+
+/**
+ * A class that override a String, to check custom scalars, where the Java type is not known of the plugin while
+ * generating the code. As explained in the issues
+ * <a href="https://github.com/graphql-java-generator/graphql-maven-plugin-project/issues/184">184</a> and
+ * <a href="https://github.com/graphql-java-generator/graphql-maven-plugin-project/issues/198">198</a>, it would
+ * generate an error.
+ * 
+ * @author etienne-sf
+ *
+ */
+public class CustomId {
+
+	final private String id;
+
+	public CustomId(String id) {
+		this.id = id;
+	}
+
+	public String getId() {
+		return this.id;
+	}
+
+	@Override
+	public String toString() {
+		return this.id;
+	}
+
+}

graphql-maven-plugin-logic/src/test/java/com/generated/graphql/samples/customscalar/GraphQLScalarTypeCustomId.java

@@ -0,0 +1,115 @@
+/**
+ * 
+ */
+package com.generated.graphql.samples.customscalar;
+
+import graphql.language.StringValue;
+import graphql.schema.Coercing;
+import graphql.schema.CoercingParseLiteralException;
+import graphql.schema.CoercingParseValueException;
+import graphql.schema.CoercingSerializeException;
+import graphql.schema.GraphQLScalarType;
+
+/**
+ * A scalar to test the correction of the issues
+ * <a href="https://github.com/graphql-java-generator/graphql-maven-plugin-project/issues/184">184</a> and
+ * <a href="https://github.com/graphql-java-generator/graphql-maven-plugin-project/issues/198">198</a>, it would
+ * generate an error.
+ * 
+ * @author etienne-sf
+ */
+public class GraphQLScalarTypeCustomId {
+
+	/**
+	 * Useless String scalar.<BR/>
+	 * It's used both as a sample, to be completed by a developper, according to his/her needs, and for the use in some
+	 * tests of the plugin logic (like in the Shopify sample, to handle (badly) various scalar as based on
+	 * strings).<BR/>
+	 * It's actually a bad management, as this custom scalars does nothing, but read basic strings. It's just for test.
+	 */
+	public static GraphQLScalarType CustomIdScalarType = GraphQLScalarType.newScalar().name("CustomId") //$NON-NLS-1$
+			.description("Useless Custom Scalar for CustomId management").coercing( //$NON-NLS-1$
+
+					new Coercing<CustomId, String>() {
+
+						/**
+						 * Called to convert a Java object result of a DataFetcher to a valid runtime value for the
+						 * scalar type. <br/>
+						 * Note : Throw {@link graphql.schema.CoercingSerializeException} if there is fundamental
+						 * problem during serialisation, don't return null to indicate failure. <br/>
+						 * Note : You should not allow {@link java.lang.RuntimeException}s to come out of your serialize
+						 * method, but rather catch them and fire them as
+						 * {@link graphql.schema.CoercingSerializeException} instead as per the method contract.
+						 *
+						 * @param dataFetcherResult
+						 *            is never null
+						 *
+						 * @return a serialized value which may be null.
+						 *
+						 * @throws graphql.schema.CoercingSerializeException
+						 *             if value input can't be serialized
+						 */
+						@Override
+						public String serialize(Object input) throws CoercingSerializeException {
+							if (!(input instanceof CustomId)) {
+								throw new CoercingSerializeException(
+										"Can't parse the '" + input.toString() + "' to a String"); //$NON-NLS-1$ //$NON-NLS-2$
+							} else {
+								return input.toString();
+							}
+						}
+
+						/**
+						 * Called to resolve an input from a query variable into a Java object acceptable for the scalar
+						 * type. <br/>
+						 * Note : You should not allow {@link java.lang.RuntimeException}s to come out of your
+						 * parseValue method, but rather catch them and fire them as
+						 * {@link graphql.schema.CoercingParseValueException} instead as per the method contract.
+						 *
+						 * @param input
+						 *            is never null
+						 *
+						 * @return a parsed value which is never null
+						 *
+						 * @throws graphql.schema.CoercingParseValueException
+						 *             if value input can't be parsed
+						 */
+						@Override
+						public CustomId parseValue(Object o) throws CoercingParseValueException {
+							if (!(o instanceof String)) {
+								throw new CoercingParseValueException(
+										"Can't parse the '" + o.toString() + "' string to a String"); //$NON-NLS-1$ //$NON-NLS-2$
+							} else {
+								return new CustomId((String) o);
+							}
+						}
+
+						/**
+						 * Called during query validation to convert a query input AST node into a Java object
+						 * acceptable for the scalar type. The input object will be an instance of
+						 * {@link graphql.language.Value}. <br/>
+						 * Note : You should not allow {@link java.lang.RuntimeException}s to come out of your
+						 * parseLiteral method, but rather catch them and fire them as
+						 * {@link graphql.schema.CoercingParseLiteralException} instead as per the method contract.
+						 *
+						 * @param input
+						 *            is never null
+						 *
+						 * @return a parsed value which is never null
+						 *
+						 * @throws graphql.schema.CoercingParseLiteralException
+						 *             if input literal can't be parsed
+						 */
+						@Override
+						public CustomId parseLiteral(Object o) throws CoercingParseLiteralException {
+							// o is an AST, that is: an instance of a class that implements graphql.language.Value
+							if (!(o instanceof StringValue)) {
+								throw new CoercingParseValueException(
+										"Can't parse the '" + o.toString() + "' string to a CustomId"); //$NON-NLS-1$ //$NON-NLS-2$
+							} else {
+								return new CustomId(((StringValue) o).getValue());
+							}
+						}
+					})
+			.build();
+}