feat!: Deletes GraphQLTypeReference

Author: NeedleInAJayStack

Sources/GraphQL/Execution/Execute.swift

@@ -969,21 +969,6 @@ func completeValue(
                 )
             }
 
-            // If field type is a TypeReference, find the type itself.
-            if
-                let returnType = returnType as? GraphQLTypeReference,
-                let referencedType = info.schema.typeMap[returnType.name]
-            {
-                return try completeValue(
-                    exeContext: exeContext,
-                    returnType: referencedType,
-                    fieldASTs: fieldASTs,
-                    info: info,
-                    path: path,
-                    result: .success(exeContext.eventLoopGroup.any().makeSucceededFuture(result))
-                )
-            }
-
             // Not reachable. All possible output types have been considered.
             throw GraphQLError(
                 message: "Cannot complete value of unexpected type \"\(returnType)\"."

Sources/GraphQL/Execution/Values.swift

@@ -91,13 +91,6 @@ func getVariableValue(
     var type = typeFromAST(schema: schema, inputTypeAST: definitionAST.type)
     let variable = definitionAST.variable
 
-    if let typeReference = type as? GraphQLTypeReference {
-        guard let referencedType = schema.typeMap[typeReference.name] else {
-            throw GraphQLError(message: "Referenced type \(typeReference.name) not found")
-        }
-        type = referencedType
-    }
-
     guard let inputType = type as? GraphQLInputType else {
         throw GraphQLError(
             message:

Sources/GraphQL/Type/Definition.swift

@@ -77,14 +77,6 @@ extension GraphQLObjectType: GraphQLCompositeType {}
 extension GraphQLInterfaceType: GraphQLCompositeType {}
 extension GraphQLUnionType: GraphQLCompositeType {}
 
-protocol GraphQLTypeReferenceContainer: GraphQLNamedType {
-    func replaceTypeReferences(typeMap: TypeMap) throws
-}
-
-extension GraphQLObjectType: GraphQLTypeReferenceContainer {}
-extension GraphQLInterfaceType: GraphQLTypeReferenceContainer {}
-extension GraphQLInputObjectType: GraphQLTypeReferenceContainer {}
-
 /**
  * These types may describe the parent context of a selection set.
  */
@@ -339,15 +331,6 @@ public final class GraphQLObjectType {
     func getInterfaces() throws -> [GraphQLInterfaceType] {
         return try interfaces()
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws {
-        for field in try getFields() {
-            try field.value.replaceTypeReferences(typeMap: typeMap)
-        }
-        for interface in try getInterfaces() {
-            try interface.replaceTypeReferences(typeMap: typeMap)
-        }
-    }
 }
 
 extension GraphQLObjectType: CustomDebugStringConvertible {
@@ -570,18 +553,6 @@ public final class GraphQLFieldDefinition {
         self.astNode = astNode
     }
 
-    func replaceTypeReferences(typeMap: TypeMap) throws {
-        let resolvedType = try resolveTypeReference(type: type, typeMap: typeMap)
-
-        guard let outputType = resolvedType as? GraphQLOutputType else {
-            throw GraphQLError(
-                message: "Resolved type \"\(resolvedType)\" is not a valid output type."
-            )
-        }
-
-        type = outputType
-    }
-
     func toField() -> GraphQLField {
         return .init(
             type: type,
@@ -742,12 +713,6 @@ public final class GraphQLInterfaceType {
     func getInterfaces() throws -> [GraphQLInterfaceType] {
         return try interfaces()
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws {
-        for field in try getFields() {
-            try field.value.replaceTypeReferences(typeMap: typeMap)
-        }
-    }
 }
 
 extension GraphQLInterfaceType: CustomDebugStringConvertible {
@@ -1144,12 +1109,6 @@ public final class GraphQLInputObjectType {
             fields: fields()
         )
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws {
-        for field in try getFields() {
-            try field.value.replaceTypeReferences(typeMap: typeMap)
-        }
-    }
 }
 
 extension GraphQLInputObjectType: CustomDebugStringConvertible {
@@ -1239,18 +1198,6 @@ public final class InputObjectFieldDefinition {
         self.deprecationReason = deprecationReason
         self.astNode = astNode
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws {
-        let resolvedType = try resolveTypeReference(type: type, typeMap: typeMap)
-
-        guard let inputType = resolvedType as? GraphQLInputType else {
-            throw GraphQLError(
-                message: "Resolved type \"\(resolvedType)\" is not a valid input type."
-            )
-        }
-
-        type = inputType
-    }
 }
 
 public func isRequiredInputField(_ field: InputObjectFieldDefinition) -> Bool {
@@ -1288,19 +1235,9 @@ public final class GraphQLList {
         ofType = type
     }
 
-    @available(*, deprecated, message: "Just reference type directly.")
-    public init(_ name: String) {
-        ofType = GraphQLTypeReference(name)
-    }
-
     var wrappedType: GraphQLType {
         return ofType
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws -> GraphQLList {
-        let resolvedType = try resolveTypeReference(type: ofType, typeMap: typeMap)
-        return GraphQLList(resolvedType)
-    }
 }
 
 extension GraphQLList: CustomDebugStringConvertible {
@@ -1354,26 +1291,9 @@ public final class GraphQLNonNull {
         ofType = type
     }
 
-    @available(*, deprecated, message: "Just reference type directly.")
-    public init(_ name: String) {
-        ofType = GraphQLTypeReference(name)
-    }
-
     var wrappedType: GraphQLType {
         return ofType
     }
-
-    func replaceTypeReferences(typeMap: TypeMap) throws -> GraphQLNonNull {
-        let resolvedType = try resolveTypeReference(type: ofType, typeMap: typeMap)
-
-        guard let nullableType = resolvedType as? GraphQLNullableType else {
-            throw GraphQLError(
-                message: "Resolved type \"\(resolvedType)\" is not a valid nullable type."
-            )
-        }
-
-        return GraphQLNonNull(nullableType)
-    }
 }
 
 extension GraphQLNonNull: CustomDebugStringConvertible {
@@ -1391,25 +1311,3 @@ extension GraphQLNonNull: Hashable {
         return lhs.hashValue == rhs.hashValue
     }
 }
-
-/**
- * A special type to allow object/interface/input types to reference itself. It's replaced with the real type
- * object when the schema is built.
- */
-@available(*, deprecated, message: "Use `fields` closure to lazily reference types.")
-public final class GraphQLTypeReference: GraphQLType, GraphQLOutputType, GraphQLInputType,
-    GraphQLNullableType, GraphQLNamedType
-{
-    public let name: String
-    public let kind: TypeKind = .typeReference
-
-    public init(_ name: String) {
-        self.name = name
-    }
-}
-
-extension GraphQLTypeReference: CustomDebugStringConvertible {
-    public var debugDescription: String {
-        return name
-    }
-}

Sources/GraphQL/Type/Introspection.swift

@@ -435,7 +435,6 @@ public enum TypeKind: String, Encodable {
     case inputObject = "INPUT_OBJECT"
     case list = "LIST"
     case nonNull = "NON_NULL"
-    case typeReference = "TYPE_REFERENCE"
 }
 
 let __TypeKind = try! GraphQLEnumType(

Sources/GraphQL/Type/Schema.swift

@@ -104,7 +104,6 @@ public final class GraphQLSchema {
         }
 
         allReferencedTypes = try typeMapReducer(typeMap: allReferencedTypes, type: __Schema)
-        try replaceTypeReferences(typeMap: allReferencedTypes)
 
         // Storing the resulting map for reference by the schema.
         var typeMap = TypeMap()
@@ -326,26 +325,15 @@ func typeMapReducer(typeMap: TypeMap, type: GraphQLType) throws -> TypeMap {
     }
 
     if let existingType = typeMap[type.name] {
-        if existingType is GraphQLTypeReference {
-            if type is GraphQLTypeReference {
-                // Just short circuit because they're both type references
-                return typeMap
-            }
-            // Otherwise, fall through and override the type reference
+        if !(existingType == type) {
+            throw GraphQLError(
+                message:
+                "Schema must contain unique named types but contains multiple " +
+                    "types named \"\(type.name)\"."
+            )
         } else {
-            if type is GraphQLTypeReference {
-                // Just ignore the reference and keep the concrete one
-                return typeMap
-            } else if !(existingType == type) {
-                throw GraphQLError(
-                    message:
-                    "Schema must contain unique named types but contains multiple " +
-                        "types named \"\(type.name)\"."
-                )
-            } else {
-                // Otherwise, it's already been defined so short circuit
-                return typeMap
-            }
+            // Otherwise, it's already been defined so short circuit
+            return typeMap
         }
     }
 
@@ -390,56 +378,6 @@ func typeMapReducer(typeMap: TypeMap, type: GraphQLType) throws -> TypeMap {
     return typeMap
 }
 
-func replaceTypeReferences(typeMap: TypeMap) throws {
-    for type in typeMap {
-        if let typeReferenceContainer = type.value as? GraphQLTypeReferenceContainer {
-            try typeReferenceContainer.replaceTypeReferences(typeMap: typeMap)
-        }
-    }
-
-    // Check that no type names map to TypeReferences. That is, they have all been resolved to
-    // actual types.
-    for (typeName, graphQLNamedType) in typeMap {
-        if graphQLNamedType is GraphQLTypeReference {
-            throw GraphQLError(
-                message: "Type \"\(typeName)\" was referenced but not defined."
-            )
-        }
-    }
-}
-
-func resolveTypeReference(type: GraphQLType, typeMap: TypeMap) throws -> GraphQLType {
-    if let type = type as? GraphQLTypeReference {
-        guard let resolvedType = typeMap[type.name] else {
-            throw GraphQLError(
-                message: "Type \"\(type.name)\" not found in schema."
-            )
-        }
-
-        return resolvedType
-    }
-
-    if let type = type as? GraphQLList {
-        return try type.replaceTypeReferences(typeMap: typeMap)
-    }
-
-    if let type = type as? GraphQLNonNull {
-        return try type.replaceTypeReferences(typeMap: typeMap)
-    }
-
-    return type
-}
-
-func resolveTypeReferences(types: [GraphQLType], typeMap: TypeMap) throws -> [GraphQLType] {
-    var resolvedTypes: [GraphQLType] = []
-
-    for type in types {
-        try resolvedTypes.append(resolveTypeReference(type: type, typeMap: typeMap))
-    }
-
-    return resolvedTypes
-}
-
 class GraphQLSchemaNormalizedConfig {
     var description: String?
     var query: GraphQLObjectType?

Sources/GraphQL/Utilities/TypeComparators.swift

@@ -55,10 +55,6 @@ func == (lhs: GraphQLType, rhs: GraphQLType) -> Bool {
         if let r = rhs as? GraphQLNonNull {
             return l == r
         }
-    case let l as GraphQLTypeReference:
-        if let r = rhs as? GraphQLTypeReference {
-            return l.name == r.name
-        }
     default:
         return false
     }

Tests/GraphQLTests/TypeTests/GraphQLSchemaTests.swift

@@ -153,30 +153,8 @@ class GraphQLSchemaTests: XCTestCase {
             ]
         )
 
-        let schema = try GraphQLSchema(query: query, types: [object1, object2])
-        for (_, graphQLNamedType) in schema.typeMap {
-            XCTAssertFalse(graphQLNamedType is GraphQLTypeReference)
-        }
-    }
-
-    func testAssertSchemaFailsWhenObjectNotDefined() throws {
-        let object1 = try GraphQLObjectType(
-            name: "Object1",
-            fields: [
-                "object2": GraphQLField(
-                    type: GraphQLTypeReference("Object2")
-                ),
-            ]
-        )
-        let query = try GraphQLObjectType(
-            name: "Query",
-            fields: [
-                "object1": GraphQLField(type: GraphQLTypeReference("Object1")),
-            ]
-        )
-
-        XCTAssertThrowsError(
-            _ = try GraphQLSchema(query: query, types: [object1])
+        XCTAssertNoThrow(
+            try GraphQLSchema(query: query, types: [object1, object2])
         )
     }
 }