Restrict overriding custom scalar types (#140)

Author: sav007

apollo-api/src/main/java/com/apollographql/android/api/graphql/Field.java

@@ -13,7 +13,7 @@ public final class Field {
   private final ObjectReader objectReader;
   private final ListReader listReader;
   private final boolean optional;
-  private final TypeMapping typeMapping;
+  private final ScalarType scalarType;
 
   public static Field forString(String responseName, String fieldName, Map<String, Object> arguments,
       boolean optional) {
@@ -55,12 +55,12 @@ public static <T> Field forList(String responseName, String fieldName, Map<Strin
   }
 
   public static <T> Field forCustomType(String responseName, String fieldName, Map<String, Object> arguments,
-      boolean optional, TypeMapping typeMapping) {
-    return new Field(Type.CUSTOM, responseName, fieldName, arguments, null, null, optional, typeMapping);
+      boolean optional, ScalarType scalarType) {
+    return new Field(Type.CUSTOM, responseName, fieldName, arguments, null, null, optional, scalarType);
   }
 
   private Field(Type type, String responseName, String fieldName, Map<String, Object> arguments,
-      ObjectReader objectReader, ListReader listReader, boolean optional, TypeMapping typeMapping) {
+      ObjectReader objectReader, ListReader listReader, boolean optional, ScalarType scalarType) {
     this.type = type;
     this.responseName = responseName;
     this.fieldName = fieldName;
@@ -69,7 +69,7 @@ private Field(Type type, String responseName, String fieldName, Map<String, Obje
     this.objectReader = objectReader;
     this.listReader = listReader;
     this.optional = optional;
-    this.typeMapping = typeMapping;
+    this.scalarType = scalarType;
   }
 
   public Type type() {
@@ -100,8 +100,8 @@ public ListReader listReader() {
     return listReader;
   }
 
-  public TypeMapping typeMapping() {
-    return typeMapping;
+  public ScalarType scalarType() {
+    return scalarType;
   }
 
   public static enum Type {
@@ -135,6 +135,6 @@ public interface ListItemReader {
 
     Boolean readBoolean() throws IOException;
 
-    <T> T readCustomType(TypeMapping typeMapping) throws IOException;
+    <T> T readCustomType(ScalarType scalarType) throws IOException;
   }
 }

apollo-api/src/main/java/com/apollographql/android/api/graphql/ScalarType.java

@@ -0,0 +1,5 @@
+package com.apollographql.android.api.graphql;
+
+public interface ScalarType {
+  String typeName();
+}

apollo-api/src/main/java/com/apollographql/android/api/graphql/ScalarTypeMapping.java

@@ -1,6 +1,6 @@
 package com.apollographql.android.compiler
 
-import com.apollographql.android.api.graphql.TypeMapping
+import com.apollographql.android.api.graphql.ScalarType
 import com.apollographql.android.compiler.ir.CodeGenerationContext
 import com.squareup.javapoet.ClassName
 import com.squareup.javapoet.MethodSpec
@@ -13,32 +13,26 @@ class CustomEnumTypeSpecBuilder(
   fun build(): TypeSpec =
       TypeSpec.enumBuilder(className(context))
           .addAnnotation(Annotations.GENERATED_BY_APOLLO)
-          .addSuperinterface(TypeMapping::class.java)
+          .addSuperinterface(ScalarType::class.java)
           .addModifiers(Modifier.PUBLIC)
           .addEnumConstants()
           .build()
 
   private fun TypeSpec.Builder.addEnumConstants(): TypeSpec.Builder {
     context.customTypeMap.forEach { mapping ->
       val constantName = mapping.key.removeSuffix("!").toUpperCase()
-      addEnumConstant(constantName, scalarMappingTypeSpec(mapping.key, mapping.value))
+      addEnumConstant(constantName, scalarMappingTypeSpec(mapping.key))
     }
     return this
   }
 
-  private fun scalarMappingTypeSpec(scalarType: String, javaClassName: String) =
+  private fun scalarMappingTypeSpec(scalarType: String) =
       TypeSpec.anonymousClassBuilder("")
-          .addMethod(MethodSpec.methodBuilder("type")
+          .addMethod(MethodSpec.methodBuilder("typeName")
               .addModifiers(Modifier.PUBLIC)
               .returns(java.lang.String::class.java)
               .addStatement("return \$S", scalarType)
               .build())
-          .addMethod(MethodSpec.methodBuilder("clazz")
-              .addModifiers(Modifier.PUBLIC)
-              .returns(Class::class.java)
-              .addStatement("return \$T.class", ClassName.get(javaClassName.substringBeforeLast("."),
-                  javaClassName.substringAfterLast(".")))
-              .build())
           .build()
 
   companion object {

apollo-api/src/main/java/com/apollographql/android/api/graphql/TypeMapping.java

@@ -15,26 +15,22 @@ open class GraphQLCompiler {
     val irPackageName = irFile.absolutePath.formatPackageName()
     val fragmentsPackage = if (irPackageName.length > 0) "$irPackageName.fragment" else "fragment"
     val typesPackage = if (irPackageName.length > 0) "$irPackageName.type" else "type"
+    val supportedScalarTypeMapping = customTypeMap.supportedScalarTypeMapping(ir.typesUsed)
     val codeGenerationContext = CodeGenerationContext(!generateClasses, emptyList(), ir.typesUsed, fragmentsPackage,
-        typesPackage, customTypeMap)
+        typesPackage, supportedScalarTypeMapping)
     val operationTypeBuilders = ir.operations.map { OperationTypeSpecBuilder(it, ir.fragments) }
-    (operationTypeBuilders + ir.fragments + ir.typesUsed).forEach {
+    (operationTypeBuilders + ir.fragments + ir.typesUsed.supportedTypeDeclarations()).forEach {
       val packageName = javaFilePackageName(it, irPackageName, fragmentsPackage, typesPackage)
       val typeSpec = it.toTypeSpec(codeGenerationContext)
       JavaFile.builder(packageName, typeSpec).build().writeTo(outputDir)
     }
 
-    if (customTypeMap.isNotEmpty()) {
+    if (supportedScalarTypeMapping.isNotEmpty()) {
       val typeSpec = CustomEnumTypeSpecBuilder(codeGenerationContext).build()
       JavaFile.builder(typesPackage, typeSpec).build().writeTo(outputDir)
     }
   }
 
-  companion object {
-    const val FILE_EXTENSION = "graphql"
-    val OUTPUT_DIRECTORY = listOf("generated", "source", "apollo")
-  }
-
   private fun String.formatPackageName(): String {
     val parts = split(File.separatorChar)
     (parts.size - 1 downTo 2)
@@ -52,4 +48,17 @@ open class GraphQLCompiler {
     }
     return irPackage
   }
+
+  private fun List<TypeDeclaration>.supportedTypeDeclarations() =
+    filter { it.kind == TypeDeclaration.KIND_ENUM || it.kind == TypeDeclaration.KIND_INPUT_OBJECT_TYPE }
+
+  private fun Map<String, String>.supportedScalarTypeMapping(typeDeclarations: List<TypeDeclaration>): Map<String, String> {
+    val customScalarTypes = typeDeclarations.filter { it.kind == TypeDeclaration.KIND_SCALAR_TYPE }.map { it.name }
+    return filter { customScalarTypes.contains(it.key) }
+  }
+
+  companion object {
+    const val FILE_EXTENSION = "graphql"
+    val OUTPUT_DIRECTORY = listOf("generated", "source", "apollo")
+  }
 }

apollo-compiler/src/main/kotlin/com/apollographql/android/compiler/CustomEnumTypeSpecBuilder.kt

@@ -13,9 +13,9 @@ data class TypeDeclaration(
     val fields: List<TypeDeclarationField>?
 ) : CodeGenerator {
   override fun toTypeSpec(context: CodeGenerationContext): TypeSpec {
-    if (kind == "EnumType") {
+    if (kind == KIND_ENUM) {
       return enumTypeToTypeSpec()
-    } else if (kind == "InputObjectType") {
+    } else if (kind == KIND_INPUT_OBJECT_TYPE) {
       return inputObjectToTypeSpec(context)
     } else {
       throw UnsupportedOperationException("unsupported $kind type declaration")
@@ -42,4 +42,10 @@ data class TypeDeclaration(
 
   private fun inputObjectToTypeSpec(context: CodeGenerationContext) =
       InputObjectTypeSpecBuilder(name, fields ?: emptyList(), context).build()
+
+  companion object {
+    val KIND_INPUT_OBJECT_TYPE : String = "InputObjectType"
+    val KIND_ENUM : String = "EnumType"
+    val KIND_SCALAR_TYPE : String = "ScalarType"
+  }
 }

apollo-compiler/src/main/kotlin/com/apollographql/android/compiler/GraphQLCompiler.kt

@@ -1,20 +1,14 @@
 package com.example.custom_scalar_type.type;
 
-import com.apollographql.android.api.graphql.TypeMapping;
-import java.lang.Class;
+import com.apollographql.android.api.graphql.ScalarType;
 import java.lang.String;
-import java.util.Date;
 import javax.annotation.Generated;
 
 @Generated("Apollo GraphQL")
-public enum CustomType implements TypeMapping {
+public enum CustomType implements ScalarType {
   DATE {
-    public String type() {
+    public String typeName() {
       return "Date";
     }
-
-    public Class clazz() {
-      return Date.class;
-    }
   }
 }

apollo-compiler/src/main/kotlin/com/apollographql/android/compiler/ir/TypeDeclaration.kt

@@ -36,5 +36,11 @@
     }
   ],
   "fragments": [],
-  "typesUsed": []
+  "typesUsed": [
+    {
+      "kind": "ScalarType",
+      "name": "Date",
+      "description": null
+    }
+  ]
 }

apollo-compiler/src/test/graphql/com/example/custom_scalar_type/CustomTypeExpected.java

@@ -1,20 +1,14 @@
 package com.example.pojo_custom_scalar_type.type;
 
-import com.apollographql.android.api.graphql.TypeMapping;
-import java.lang.Class;
+import com.apollographql.android.api.graphql.ScalarType;
 import java.lang.String;
-import java.util.Date;
 import javax.annotation.Generated;
 
 @Generated("Apollo GraphQL")
-public enum CustomType implements TypeMapping {
+public enum CustomType implements ScalarType {
   DATE {
-    public String type() {
+    public String typeName() {
       return "Date";
     }
-
-    public Class clazz() {
-      return Date.class;
-    }
   }
 }

apollo-compiler/src/test/graphql/com/example/custom_scalar_type/TestQuery.json

@@ -36,5 +36,11 @@
     }
   ],
   "fragments": [],
-  "typesUsed": []
+  "typesUsed": [
+    {
+      "kind": "ScalarType",
+      "name": "Date",
+      "description": null
+    }
+  ]
 }

apollo-compiler/src/test/graphql/com/example/pojo_custom_scalar_type/CustomTypeExpected.java

@@ -71,9 +71,9 @@ class CodeGenTest(val testDir: File, val pkgName: String, val generatePOJO: Bool
           .filter { it.isDirectory }
           .map {
             if (it.name == "custom_scalar_type") {
-              arrayOf(it, it.name, false, mapOf("Date" to "java.util.Date"))
+              arrayOf(it, it.name, false, mapOf("Date" to "java.util.Date", "UnsupportedType" to "java.lang.Object"))
             } else if (it.name == "pojo_custom_scalar_type") {
-              arrayOf(it, it.name, true, mapOf("Date" to "java.util.Date"))
+              arrayOf(it, it.name, true, mapOf("Date" to "java.util.Date", "UnsupportedType" to "java.lang.Object"))
             } else {
               arrayOf(it, it.name, it.name.startsWith("pojo"), emptyMap<String, String>())
             }

apollo-compiler/src/test/graphql/com/example/pojo_custom_scalar_type/TestQuery.json

@@ -2,7 +2,7 @@
 
 import com.apollographql.android.api.graphql.Operation;
 import com.apollographql.android.api.graphql.Response;
-import com.apollographql.android.api.graphql.TypeMapping;
+import com.apollographql.android.api.graphql.ScalarType;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.ParameterizedType;
@@ -18,9 +18,9 @@
 
 /** TODO */
 public final class ApolloConverterFactory extends Converter.Factory {
-  private final Map<TypeMapping, CustomTypeAdapter> customTypeAdapters;
+  private final Map<ScalarType, CustomTypeAdapter> customTypeAdapters;
 
-  private ApolloConverterFactory(Map<TypeMapping, CustomTypeAdapter> customTypeAdapters) {
+  private ApolloConverterFactory(Map<ScalarType, CustomTypeAdapter> customTypeAdapters) {
     this.customTypeAdapters = customTypeAdapters;
   }
 
@@ -36,11 +36,11 @@ private ApolloConverterFactory(Map<TypeMapping, CustomTypeAdapter> customTypeAda
   }
 
   public static class Builder {
-    private final Map<TypeMapping, CustomTypeAdapter> customTypeAdapters = new HashMap<>();
+    private final Map<ScalarType, CustomTypeAdapter> customTypeAdapters = new HashMap<>();
 
-    public Builder withCustomTypeAdapter(@Nonnull TypeMapping typeMapping,
+    public Builder withCustomTypeAdapter(@Nonnull ScalarType scalarType,
         @Nonnull CustomTypeAdapter customTypeAdapter) {
-      customTypeAdapters.put(typeMapping, customTypeAdapter);
+      customTypeAdapters.put(scalarType, customTypeAdapter);
       return this;
     }
 

apollo-compiler/src/test/kotlin/com/apollographql/android/compiler/CodegenTest.kt

@@ -5,7 +5,7 @@
 import com.apollographql.android.api.graphql.Operation;
 import com.apollographql.android.api.graphql.Response;
 import com.apollographql.android.api.graphql.ResponseReader;
-import com.apollographql.android.api.graphql.TypeMapping;
+import com.apollographql.android.api.graphql.ScalarType;
 
 import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
@@ -18,9 +18,9 @@
 
 class ApolloResponseBodyConverter implements Converter<ResponseBody, Response<? extends Operation.Data>> {
   private final Type type;
-  private final Map<TypeMapping, CustomTypeAdapter> customTypeAdapters;
+  private final Map<ScalarType, CustomTypeAdapter> customTypeAdapters;
 
-  ApolloResponseBodyConverter(Type type, Map<TypeMapping, CustomTypeAdapter> customTypeAdapters) {
+  ApolloResponseBodyConverter(Type type, Map<ScalarType, CustomTypeAdapter> customTypeAdapters) {
     this.type = type;
     this.customTypeAdapters = customTypeAdapters;
   }

apollo-converters/pojo/src/main/java/com/apollographql/android/converter/pojo/ApolloConverterFactory.java

@@ -2,7 +2,7 @@
 
 import com.apollographql.android.api.graphql.Field;
 import com.apollographql.android.api.graphql.ResponseReader;
-import com.apollographql.android.api.graphql.TypeMapping;
+import com.apollographql.android.api.graphql.ScalarType;
 
 import java.io.IOException;
 import java.math.BigDecimal;
@@ -12,9 +12,9 @@
 
 @SuppressWarnings("WeakerAccess") final class BufferedResponseReader implements ResponseReader {
   private final Map<String, Object> buffer;
-  private final Map<TypeMapping, CustomTypeAdapter> customTypeAdapters;
+  private final Map<ScalarType, CustomTypeAdapter> customTypeAdapters;
 
-  BufferedResponseReader(Map<String, Object> buffer, Map<TypeMapping, CustomTypeAdapter> customTypeAdapters) {
+  BufferedResponseReader(Map<String, Object> buffer, Map<ScalarType, CustomTypeAdapter> customTypeAdapters) {
     this.buffer = buffer;
     this.customTypeAdapters = customTypeAdapters;
   }
@@ -145,9 +145,9 @@ Boolean readBoolean(Field field) throws IOException {
     if (value == null) {
       return null;
     } else {
-      CustomTypeAdapter<T> typeAdapter = customTypeAdapters.get(field.typeMapping());
+      CustomTypeAdapter<T> typeAdapter = customTypeAdapters.get(field.scalarType());
       if (typeAdapter == null) {
-        throw new RuntimeException("Can't resolve custom type adapter for " + field.typeMapping().type());
+        throw new RuntimeException("Can't resolve custom type adapter for " + field.scalarType().typeName());
       }
       return typeAdapter.decode(value.toString());
     }
@@ -162,9 +162,9 @@ private void checkValue(Object value, boolean optional) {
 
   private static class BufferedListItemReader implements Field.ListItemReader {
     private final Object value;
-    private final Map<TypeMapping, CustomTypeAdapter> customTypeAdapters;
+    private final Map<ScalarType, CustomTypeAdapter> customTypeAdapters;
 
-    BufferedListItemReader(Object value, Map<TypeMapping, CustomTypeAdapter> customTypeAdapters) {
+    BufferedListItemReader(Object value, Map<ScalarType, CustomTypeAdapter> customTypeAdapters) {
       this.value = value;
       this.customTypeAdapters = customTypeAdapters;
     }
@@ -189,10 +189,10 @@ private static class BufferedListItemReader implements Field.ListItemReader {
       return (Boolean) value;
     }
 
-    @SuppressWarnings("unchecked") @Override public <T> T readCustomType(TypeMapping typeMapping) throws IOException {
-      CustomTypeAdapter<T> typeAdapter = customTypeAdapters.get(typeMapping);
+    @SuppressWarnings("unchecked") @Override public <T> T readCustomType(ScalarType scalarType) throws IOException {
+      CustomTypeAdapter<T> typeAdapter = customTypeAdapters.get(scalarType);
       if (typeAdapter == null) {
-        throw new RuntimeException("Can't resolve custom type adapter for " + typeMapping.type());
+        throw new RuntimeException("Can't resolve custom type adapter for " + scalarType.typeName());
       }
       return typeAdapter.decode(value.toString());
     }