feat!: Removes Instrumentation

The intent is to replace it with swift-distributed-tracing integration.

Author: NeedleInAJayStack

MIGRATION.md

@@ -20,6 +20,10 @@ This was changed to `ConcurrentFieldExecutionStrategy`, and takes no parameters.
 
 The `EventStream` abstraction used to provide pre-concurrency subscription support has been removed. This means that `graphqlSubscribe(...).stream` will now be an `AsyncThrowingStream<GraphQLResult, Error>` type, instead of an `EventStream` type, and that downcasting to `ConcurrentEventStream` is no longer necessary.
 
+### Instrumentation removal
+
+The `Instrumentation` type has been removed, with anticipated support for tracing using [`swift-distributed-tracing`](https://github.com/apple/swift-distributed-tracing). `instrumentation` arguments must be removed from `graphql` and `graphqlSubscribe` calls.
+
 ## 2 to 3
 
 ### TypeReference removal

Sources/GraphQL/Execution/Execute.swift

@@ -31,7 +31,6 @@ public final class ExecutionContext {
     let queryStrategy: QueryFieldExecutionStrategy
     let mutationStrategy: MutationFieldExecutionStrategy
     let subscriptionStrategy: SubscriptionFieldExecutionStrategy
-    let instrumentation: Instrumentation
     public let schema: GraphQLSchema
     public let fragments: [String: FragmentDefinition]
     public let rootValue: Any
@@ -54,7 +53,6 @@ public final class ExecutionContext {
         queryStrategy: QueryFieldExecutionStrategy,
         mutationStrategy: MutationFieldExecutionStrategy,
         subscriptionStrategy: SubscriptionFieldExecutionStrategy,
-        instrumentation: Instrumentation,
         schema: GraphQLSchema,
         fragments: [String: FragmentDefinition],
         rootValue: Any,
@@ -66,7 +64,6 @@ public final class ExecutionContext {
         self.queryStrategy = queryStrategy
         self.mutationStrategy = mutationStrategy
         self.subscriptionStrategy = subscriptionStrategy
-        self.instrumentation = instrumentation
         self.schema = schema
         self.fragments = fragments
         self.rootValue = rootValue
@@ -180,15 +177,13 @@ func execute(
     queryStrategy: QueryFieldExecutionStrategy,
     mutationStrategy: MutationFieldExecutionStrategy,
     subscriptionStrategy: SubscriptionFieldExecutionStrategy,
-    instrumentation: Instrumentation,
     schema: GraphQLSchema,
     documentAST: Document,
     rootValue: Any,
     context: Any,
     variableValues: [String: Map] = [:],
     operationName: String? = nil
 ) async throws -> GraphQLResult {
-    let executeStarted = instrumentation.now
     let buildContext: ExecutionContext
 
     do {
@@ -198,7 +193,6 @@ func execute(
             queryStrategy: queryStrategy,
             mutationStrategy: mutationStrategy,
             subscriptionStrategy: subscriptionStrategy,
-            instrumentation: instrumentation,
             schema: schema,
             documentAST: documentAST,
             rootValue: rootValue,
@@ -207,20 +201,6 @@ func execute(
             operationName: operationName
         )
     } catch let error as GraphQLError {
-        instrumentation.operationExecution(
-            processId: processId(),
-            threadId: threadId(),
-            started: executeStarted,
-            finished: instrumentation.now,
-            schema: schema,
-            document: documentAST,
-            rootValue: rootValue,
-            variableValues: variableValues,
-            operation: nil,
-            errors: [error],
-            result: nil
-        )
-
         return GraphQLResult(errors: [error])
     } catch {
         return GraphQLResult(errors: [GraphQLError(error)])
@@ -264,7 +244,6 @@ func buildExecutionContext(
     queryStrategy: QueryFieldExecutionStrategy,
     mutationStrategy: MutationFieldExecutionStrategy,
     subscriptionStrategy: SubscriptionFieldExecutionStrategy,
-    instrumentation: Instrumentation,
     schema: GraphQLSchema,
     documentAST: Document,
     rootValue: Any,
@@ -318,7 +297,6 @@ func buildExecutionContext(
         queryStrategy: queryStrategy,
         mutationStrategy: mutationStrategy,
         subscriptionStrategy: subscriptionStrategy,
-        instrumentation: instrumentation,
         schema: schema,
         fragments: fragments,
         rootValue: rootValue,
@@ -641,8 +619,6 @@ public func resolveField(
         variableValues: exeContext.variableValues
     )
 
-//    let resolveFieldStarted = exeContext.instrumentation.now
-
     // Get the resolve func, regardless of if its result is normal
     // or abrupt (error).
     let result = await resolveOrError(
@@ -653,17 +629,6 @@ public func resolveField(
         info: info
     )
 
-//    exeContext.instrumentation.fieldResolution(
-//        processId: processId(),
-//        threadId: threadId(),
-//        started: resolveFieldStarted,
-//        finished: exeContext.instrumentation.now,
-//        source: source,
-//        args: args,
-//        info: info,
-//        result: result
-//    )
-
     return try await completeValueCatchingError(
         exeContext: exeContext,
         returnType: returnType,

Sources/GraphQL/GraphQL.swift

@@ -67,8 +67,6 @@ public struct SubscriptionResult {
 /// - parameter queryStrategy:        The field execution strategy to use for query requests
 /// - parameter mutationStrategy:     The field execution strategy to use for mutation requests
 /// - parameter subscriptionStrategy: The field execution strategy to use for subscription requests
-/// - parameter instrumentation:      The instrumentation implementation to call during the parsing,
-/// validating, execution, and field resolution stages.
 /// - parameter schema:               The GraphQL type system to use when validating and executing a
 /// query.
 /// - parameter request:              A GraphQL language formatted string representing the requested
@@ -93,7 +91,6 @@ public func graphql(
     queryStrategy: QueryFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     mutationStrategy: MutationFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     subscriptionStrategy: SubscriptionFieldExecutionStrategy = SerialFieldExecutionStrategy(),
-    instrumentation: Instrumentation = NoOpInstrumentation,
     validationRules: [(ValidationContext) -> Visitor] = [],
     schema: GraphQLSchema,
     request: String,
@@ -103,9 +100,8 @@ public func graphql(
     operationName: String? = nil
 ) async throws -> GraphQLResult {
     let source = Source(body: request, name: "GraphQL request")
-    let documentAST = try parse(instrumentation: instrumentation, source: source)
+    let documentAST = try parse(source: source)
     let validationErrors = validate(
-        instrumentation: instrumentation,
         schema: schema,
         ast: documentAST,
         rules: validationRules
@@ -119,7 +115,6 @@ public func graphql(
         queryStrategy: queryStrategy,
         mutationStrategy: mutationStrategy,
         subscriptionStrategy: subscriptionStrategy,
-        instrumentation: instrumentation,
         schema: schema,
         documentAST: documentAST,
         rootValue: rootValue,
@@ -135,8 +130,6 @@ public func graphql(
 /// - parameter queryStrategy:        The field execution strategy to use for query requests
 /// - parameter mutationStrategy:     The field execution strategy to use for mutation requests
 /// - parameter subscriptionStrategy: The field execution strategy to use for subscription requests
-/// - parameter instrumentation:      The instrumentation implementation to call during the parsing,
-/// validating, execution, and field resolution stages.
 /// - parameter queryRetrieval:       The PersistedQueryRetrieval instance to use for looking up
 /// queries
 /// - parameter queryId:              The id of the query to execute
@@ -160,7 +153,6 @@ public func graphql<Retrieval: PersistedQueryRetrieval>(
     queryStrategy: QueryFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     mutationStrategy: MutationFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     subscriptionStrategy: SubscriptionFieldExecutionStrategy = SerialFieldExecutionStrategy(),
-    instrumentation: Instrumentation = NoOpInstrumentation,
     queryRetrieval: Retrieval,
     queryId: Retrieval.Id,
     rootValue: Any = (),
@@ -180,7 +172,6 @@ public func graphql<Retrieval: PersistedQueryRetrieval>(
             queryStrategy: queryStrategy,
             mutationStrategy: mutationStrategy,
             subscriptionStrategy: subscriptionStrategy,
-            instrumentation: instrumentation,
             schema: schema,
             documentAST: documentAST,
             rootValue: rootValue,
@@ -202,8 +193,6 @@ public func graphql<Retrieval: PersistedQueryRetrieval>(
 /// - parameter queryStrategy:        The field execution strategy to use for query requests
 /// - parameter mutationStrategy:     The field execution strategy to use for mutation requests
 /// - parameter subscriptionStrategy: The field execution strategy to use for subscription requests
-/// - parameter instrumentation:      The instrumentation implementation to call during the parsing,
-/// validating, execution, and field resolution stages.
 /// - parameter schema:               The GraphQL type system to use when validating and executing a
 /// query.
 /// - parameter request:              A GraphQL language formatted string representing the requested
@@ -232,7 +221,6 @@ public func graphqlSubscribe(
     queryStrategy: QueryFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     mutationStrategy: MutationFieldExecutionStrategy = SerialFieldExecutionStrategy(),
     subscriptionStrategy: SubscriptionFieldExecutionStrategy = SerialFieldExecutionStrategy(),
-    instrumentation: Instrumentation = NoOpInstrumentation,
     validationRules: [(ValidationContext) -> Visitor] = [],
     schema: GraphQLSchema,
     request: String,
@@ -242,9 +230,8 @@ public func graphqlSubscribe(
     operationName: String? = nil
 ) async throws -> SubscriptionResult {
     let source = Source(body: request, name: "GraphQL Subscription request")
-    let documentAST = try parse(instrumentation: instrumentation, source: source)
+    let documentAST = try parse(source: source)
     let validationErrors = validate(
-        instrumentation: instrumentation,
         schema: schema,
         ast: documentAST,
         rules: validationRules
@@ -258,7 +245,6 @@ public func graphqlSubscribe(
         queryStrategy: queryStrategy,
         mutationStrategy: mutationStrategy,
         subscriptionStrategy: subscriptionStrategy,
-        instrumentation: instrumentation,
         schema: schema,
         documentAST: documentAST,
         rootValue: rootValue,

Sources/GraphQL/GraphQLRequest.swift

@@ -37,7 +37,6 @@ public struct GraphQLRequest: Equatable, Codable {
     /// - Returns: The operation type performed by the request
     public func operationType() throws -> OperationType {
         let documentAST = try GraphQL.parse(
-            instrumentation: NoOpInstrumentation,
             source: Source(body: query, name: "GraphQL request")
         )
         let firstOperation = documentAST.definitions.compactMap { $0 as? OperationDefinition }.first