Adding tests to proove scalars are ommited if not used

simeonleatherland · simeonleatherland · commit e9067f71f0c0 · 2020-01-30T09:41:36.000+11:00
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -146,7 +146,7 @@ public boolean isUseAstDefinitions() {
         }
 
         public static Options defaultOptions() {
-            return new Options(false, false, false,
+            return new Options(false, true, true,
                     false, false, false,
                     directive -> true, DefaultGraphqlTypeComparatorRegistry.defaultComparators());
         }
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -24,6 +24,7 @@ import spock.lang.Specification
 
 import java.util.function.UnaryOperator
 
+import static graphql.Scalars.GraphQLInt
 import static graphql.Scalars.GraphQLString
 import static graphql.TestUtil.mockScalar
 import static graphql.TestUtil.mockTypeRuntimeWiring
@@ -165,7 +166,6 @@ class SchemaPrinterTest extends Specification {
 
         expect:
         result != null
-        !result.contains("scalar")
         !result.contains("__TypeKind")
     }
 
@@ -766,6 +766,9 @@ enum Episode {
   JEDI
   NEWHOPE
 }
+
+"Asteroid"
+scalar Asteroid
 """
     }
 
@@ -1390,5 +1393,154 @@ type Query {
 '''
     }
 
+    def "omit unused built-in scalars by default - created by sdl string"(){
+        given:
+        def sdl = '''type Query {scalarcustom : RandomScalar} scalar RandomScalar'''
+
+        def registry = new SchemaParser().parse(sdl)
+        def runtimeWiring = newRuntimeWiring().scalar(mockScalar("RandomScalar")).build()
+        def options = SchemaGenerator.Options.defaultOptions().enforceSchemaDirectives(false)
+
+        def schema = new SchemaGenerator().makeExecutableSchema(options, registry, runtimeWiring)
+
+        def result = new SchemaPrinter(noDirectivesOption).print(schema)
+
+        expect:
+
+        ScalarInfo.STANDARD_SCALARS.forEach({
+            scalarType -> assert !result.contains(scalarType.name)
+        })
+
+        result ==
+'''type Query {
+  scalarcustom: RandomScalar
+}
+
+"RandomScalar"
+scalar RandomScalar
+'''
+        }
+
+    def "omit unused custom scalars when unused - created by sdl string"(){
+        given:
+        def sdl = '''type Query {astring : String aInt : Int} "Some Scalar" scalar CustomScalar'''
+
+        def registry = new SchemaParser().parse(sdl)
+        def runtimeWiring = newRuntimeWiring().scalar(mockScalar("CustomScalar")).build()
+        def options = SchemaGenerator.Options.defaultOptions().enforceSchemaDirectives(false)
+
+        def schema = new SchemaGenerator().makeExecutableSchema(options, registry, runtimeWiring)
 
+        def result = new SchemaPrinter(noDirectivesOption).print(schema)
+
+        expect:
+        assert !result.contains("ID") && !result.contains("Float") && !result.contains("Boolean")
+        result ==
+                '''type Query {
+  aInt: Int
+  astring: String
 }
+'''
+    }
+
+    def "show graphql-java extended scalar types by default when used - created by sdl string"(){
+        given:
+        def sdl = '''type Query {aInt : BigInteger}'''
+
+        def registry = new SchemaParser().parse(sdl)
+        def runtimeWiring = newRuntimeWiring().build()
+        def options = SchemaGenerator.Options.defaultOptions().enforceSchemaDirectives(false)
+
+        def schema = new SchemaGenerator().makeExecutableSchema(options, registry, runtimeWiring)
+
+        def result = new SchemaPrinter(defaultOptions().includeDirectives(false)).print(schema)
+
+        expect:
+        result ==
+                '''type Query {
+  aInt: BigInteger
+}
+
+"Built-in java.math.BigInteger"
+scalar BigInteger
+'''
+    }
+
+    def "omit unused built-in by default - created programmatically"(){
+        given:
+        GraphQLScalarType myScalar = new GraphQLScalarType("RandomScalar", "about scalar", new Coercing() {
+            @Override
+            Object serialize(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseValue(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseLiteral(Object input) {
+                return null
+            }
+        })
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
+                .name("scalarType").type(myScalar).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
+
+        def schema = GraphQLSchema.newSchema().query(queryType).additionalType(myScalar).build()
+
+        def result = new SchemaPrinter(defaultOptions().includeDirectives(false)).print(schema)
+
+        expect:
+        ScalarInfo.STANDARD_SCALARS.forEach({
+            scalarType -> assert !result.contains(scalarType.name)
+        })
+        result ==
+                '''type Query {
+  scalarType: RandomScalar
+}
+
+"about scalar"
+scalar RandomScalar
+'''
+    }
+
+    def "omit unused custom scalars when unused - created programmatically"(){
+        given:
+        GraphQLScalarType myScalar = new GraphQLScalarType("Scalar", "about scalar", new Coercing() {
+            @Override
+            Object serialize(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseValue(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseLiteral(Object input) {
+                return null
+            }
+        })
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
+                .name("someType").type(GraphQLInt).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
+
+        def schema = GraphQLSchema.newSchema().query(queryType).additionalType(myScalar).build()
+        
+        def result = new SchemaPrinter(defaultOptions().includeScalarTypes(true).includeDirectives(false)).print(schema)
+
+        expect:
+        result ==
+                '''type Query {
+  someType: Int
+}
+
+"about scalar"
+scalar Scalar
+'''
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public boolean isUseAstDefinitions() {`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`public static Options defaultOptions() {`
`149`		`- return new Options(false, false, false,`
	`149`	`+ return new Options(false, true, true,`
`150`	`150`	`false, false, false,`
`151`	`151`	`directive -> true, DefaultGraphqlTypeComparatorRegistry.defaultComparators());`
`152`	`152`	`}`