[v2] [10/X] Remove RequestContext

Tests/ApolloInternalTestHelpers/MockNetworkTransport.swift

@@ -19,24 +19,20 @@ public final class MockNetworkTransport: NetworkTransport {
   public func send<Query>(
     query: Query,
     cachePolicy: CachePolicy,
-    context: (any RequestContext)?
   ) throws -> AsyncThrowingStream<GraphQLResult<Query.Data>, any Error> where Query: GraphQLQuery {
     try requestChainTransport.send(
       query: query,
-      cachePolicy: cachePolicy,
-      context: context
+      cachePolicy: cachePolicy
     )
   }
 
   public func send<Mutation>(
     mutation: Mutation,
     cachePolicy: CachePolicy,
-    context: (any RequestContext)?
   ) throws -> AsyncThrowingStream<GraphQLResult<Mutation.Data>, any Error> where Mutation: GraphQLMutation {
     try requestChainTransport.send(
       mutation: mutation,
-      cachePolicy: cachePolicy,
-      context: context
+      cachePolicy: cachePolicy
     )
   }
 

Tests/ApolloTests/Network/ApolloURLSessionTests.swift

@@ -28,7 +28,6 @@ class ApolloURLSessionTests: XCTestCase, MockResponseProvider {
     var operation = MockQuery<MockSelectionSet>.mock()
     var additionalHeaders: [String: String] = [:]
     var cachePolicy: Apollo.CachePolicy = .fetchIgnoringCacheCompletely
-    var context: (any RequestContext)? = nil
     var clientAwarenessMetadata: ClientAwarenessMetadata = .none
 
     var urlRequest: URLRequest

apollo-ios/Sources/Apollo/ApolloClient.swift

@@ -43,7 +43,7 @@
 }
 
 /// The `ApolloClient` class implements the core API for Apollo by conforming to `ApolloClientProtocol`.
 public final class ApolloClient: ApolloClientProtocol, Sendable {
 
   let networkTransport: any NetworkTransport
 
@@ -117,13 +117,11 @@
   public func fetch<Query: GraphQLQuery>(
     query: Query,
     cachePolicy: CachePolicy? = nil,
-    context: (any RequestContext)? = nil
   ) async throws -> GraphQLResult<Query.Data>
   where Query.ResponseFormat == SingleResponseFormat {
     for try await result in try self.networkTransport.send(
       query: query,
       cachePolicy: cachePolicy ?? self.defaultCachePolicy,
-      context: context
     ) {
       return result
     }
@@ -132,14 +130,12 @@
 
   public func fetch<Query: GraphQLQuery>(
     query: Query,
-    cachePolicy: CachePolicy? = nil,
-    context: (any RequestContext)? = nil
+    cachePolicy: CachePolicy? = nil
   ) throws -> AsyncThrowingStream<GraphQLResult<Query.Data>, any Error>
   where Query.ResponseFormat == IncrementalDeferredResponseFormat {
     return try self.networkTransport.send(
       query: query,
-      cachePolicy: cachePolicy ?? self.defaultCachePolicy,
-      context: context
+      cachePolicy: cachePolicy ?? self.defaultCachePolicy
     )
   }
 
@@ -158,15 +154,13 @@
     query: Query,
     cachePolicy: CachePolicy? = nil,
     refetchOnFailedUpdates: Bool = true,
-    context: (any RequestContext)? = nil,
     callbackQueue: DispatchQueue = .main,
     resultHandler: @escaping GraphQLResultHandler<Query.Data>
   ) -> GraphQLQueryWatcher<Query> {
     let watcher = GraphQLQueryWatcher(
       client: self,
       query: query,
       refetchOnFailedUpdates: refetchOnFailedUpdates,
-      context: context,
       callbackQueue: callbackQueue,
       resultHandler: resultHandler
     )
@@ -178,7 +172,6 @@
   public func perform<Mutation: GraphQLMutation>(
     mutation: Mutation,
     publishResultToStore: Bool = true,
-    context: (any RequestContext)? = nil,
     queue: DispatchQueue = .main,
     resultHandler: GraphQLResultHandler<Mutation.Data>? = nil
   ) -> (any Cancellable) {
@@ -187,7 +180,6 @@
         try self.networkTransport.send(
           mutation: mutation,
           cachePolicy: publishResultToStore ? self.defaultCachePolicy : .networkOnly,  // TODO: should be NoCache
-          context: context
         )
       },
       callbackQueue: queue,
@@ -199,7 +191,6 @@
   public func upload<Operation: GraphQLOperation>(
     operation: Operation,
     files: [GraphQLFile],
-    context: (any RequestContext)? = nil,
     queue: DispatchQueue = .main,
     resultHandler: GraphQLResultHandler<Operation.Data>? = nil
   ) -> (any Cancellable) {
@@ -217,8 +208,7 @@
       {
         try uploadingTransport.upload(
           operation: operation,
-          files: files,
-          context: context
+          files: files
         )
       },
       callbackQueue: queue,
@@ -228,7 +218,6 @@
 
   public func subscribe<Subscription: GraphQLSubscription>(
     subscription: Subscription,
-    context: (any RequestContext)? = nil,
     queue: DispatchQueue = .main,
     resultHandler: @escaping GraphQLResultHandler<Subscription.Data>
   ) -> any Cancellable {
@@ -247,7 +236,6 @@
         try networkTransport.send(
           subscription: subscription,
           cachePolicy: self.defaultCachePolicy,  // TODO: should this just be networkOnly?
-          context: context
         )
       },
       callbackQueue: queue,
@@ -280,8 +268,7 @@
       {
         try self.networkTransport.send(
           query: query,
-          cachePolicy: cachePolicy ?? self.defaultCachePolicy,
-          context: context
+          cachePolicy: cachePolicy ?? self.defaultCachePolicy
         )
       },
       callbackQueue: queue,

apollo-ios/Sources/Apollo/ApolloClientProtocol.swift

@@ -28,7 +28,6 @@ public protocol ApolloClientProtocol: AnyObject {
   /// - Returns: An object that can be used to cancel an in progress fetch.
   func fetch<Query: GraphQLQuery>(query: Query,
                                   cachePolicy: CachePolicy?,
-                                  context: (any RequestContext)?,
                                   queue: DispatchQueue,
                                   resultHandler: GraphQLResultHandler<Query.Data>?) -> (any Cancellable)
 
@@ -43,7 +42,6 @@ public protocol ApolloClientProtocol: AnyObject {
   /// - Returns: A query watcher object that can be used to control the watching behavior.
   func watch<Query: GraphQLQuery>(query: Query,
                                   cachePolicy: CachePolicy?,
-                                  context: (any RequestContext)?,
                                   callbackQueue: DispatchQueue,
                                   resultHandler: @escaping GraphQLResultHandler<Query.Data>) -> GraphQLQueryWatcher<Query>
 
@@ -58,7 +56,6 @@ public protocol ApolloClientProtocol: AnyObject {
   /// - Returns: An object that can be used to cancel an in progress mutation.
   func perform<Mutation: GraphQLMutation>(mutation: Mutation,
                                           publishResultToStore: Bool,
-                                          context: (any RequestContext)?,
                                           queue: DispatchQueue,
                                           resultHandler: GraphQLResultHandler<Mutation.Data>?) -> (any Cancellable)
 
@@ -73,7 +70,6 @@ public protocol ApolloClientProtocol: AnyObject {
   /// - Returns: An object that can be used to cancel an in progress request.
   func upload<Operation: GraphQLOperation>(operation: Operation,
                                            files: [GraphQLFile],
-                                           context: (any RequestContext)?,
                                            queue: DispatchQueue,
                                            resultHandler: GraphQLResultHandler<Operation.Data>?) -> (any Cancellable)
 
@@ -87,7 +83,6 @@ public protocol ApolloClientProtocol: AnyObject {
   ///   - resultHandler: An optional closure that is called when mutation results are available or when an error occurs.
   /// - Returns: An object that can be used to cancel an in progress subscription.
   func subscribe<Subscription: GraphQLSubscription>(subscription: Subscription,
-                                                    context: (any RequestContext)?,
                                                     queue: DispatchQueue,
                                                     resultHandler: @escaping GraphQLResultHandler<Subscription.Data>) -> any Cancellable
 }

apollo-ios/Sources/Apollo/GraphQLQueryWatcher.swift

@@ -1,6 +1,7 @@
 import Foundation
+
 #if !COCOAPODS
-import ApolloAPI
+  import ApolloAPI
 #endif
 
 /// A `GraphQLQueryWatcher` is responsible for watching the store, and calling the result handler with a new result whenever any of the data the previous result depends on changes.
@@ -23,7 +24,6 @@
   private let callbackQueue: DispatchQueue
 
   private let contextIdentifier = UUID()
-  private let context: (any RequestContext)?
 
   private actor WeakFetchTaskContainer {
     weak var cancellable: (any Cancellable)?
@@ -52,24 +52,24 @@
   ///   - context: [optional] A context that is being passed through the request chain. Defaults to `nil`.
   ///   - callbackQueue: The queue for the result handler. Defaults to the main queue.
   ///   - resultHandler: The result handler to call with changes.
-  public init(client: any ApolloClientProtocol,
-              query: Query,
-              refetchOnFailedUpdates: Bool = true,
-              context: (any RequestContext)? = nil,
-              callbackQueue: DispatchQueue = .main,
-              resultHandler: @escaping GraphQLResultHandler<Query.Data>) {
+  public init(
+    client: any ApolloClientProtocol,
+    query: Query,
+    refetchOnFailedUpdates: Bool = true,
+    callbackQueue: DispatchQueue = .main,
+    resultHandler: @escaping GraphQLResultHandler<Query.Data>
+  ) {
     self.client = client
     self.query = query
     self.refetchOnFailedUpdates = refetchOnFailedUpdates
     self.resultHandler = resultHandler
     self.callbackQueue = callbackQueue
-    self.context = context
 
     client.store.subscribe(self)
   }
 
   /// Refetch a query from the server.
   public func refetch(cachePolicy: CachePolicy = .fetchIgnoringCacheData) {
     fetch(cachePolicy: cachePolicy)
   }
 
@@ -120,13 +120,13 @@
     _ store: ApolloStore,
     didChangeKeys changedKeys: Set<CacheKey>
   ) {
-    if
-      let incomingIdentifier = QueryWatcherContext.identifier,
-      incomingIdentifier == self.contextIdentifier {
-        // This is from changes to the keys made from the `fetch` method above,
-        // changes will be returned through that and do not need to be returned
-        // here as well.
-        return
+    if let incomingIdentifier = QueryWatcherContext.identifier,
+      incomingIdentifier == self.contextIdentifier
+    {
+      // This is from changes to the keys made from the `fetch` method above,
+      // changes will be returned through that and do not need to be returned
+      // here as well.
+      return
     }
 
     Task { [store] in
@@ -147,7 +147,7 @@
                 return
               }
 
-    #warning("TODO: temp Task encapsulation to move forward; this probably is not right?")
+              #warning("TODO: temp Task encapsulation to move forward; this probably is not right?")
               Task {
                 await self.fetching.mutate {
                   $0.dependentKeys = graphQLResult.dependentKeys
@@ -157,7 +157,7 @@
             }
 
           case .failure:
-#warning("TODO: temp Task encapsulation to move forward; this probably is not right?")
+            #warning("TODO: temp Task encapsulation to move forward; this probably is not right?")
             Task {
               let cachePolicy = await fetching.cachePolicy
               if self.refetchOnFailedUpdates && cachePolicy != .returnCacheDataDontFetch {
@@ -175,6 +175,26 @@
 // MARK: - Task Local Values
 
 private enum QueryWatcherContext {
-  @TaskLocal
-  static var identifier: UUID?
+  @TaskLocal static var identifier: UUID?
+}
+
+// MARK: - Deprecation
+
+extension GraphQLQueryWatcher {
+  @available(*, deprecated)
+  public convenience init(
+    client: any ApolloClientProtocol,
+    query: Query,
+    refetchOnFailedUpdates: Bool = true,
+    context: (any RequestContext)? = nil,
+    callbackQueue: DispatchQueue = .main,
+    resultHandler: @escaping GraphQLResultHandler<Query.Data>
+  ) {
+    self.init(
+      client: client,
+      query: query,
+      refetchOnFailedUpdates: refetchOnFailedUpdates,
+      resultHandler: resultHandler
+    )
+  }
 }

apollo-ios/Sources/Apollo/GraphQLRequest.swift

@@ -18,9 +18,6 @@ public protocol GraphQLRequest<Operation>: Sendable {
   /// The `FetchBehavior` to use for this request. Determines if fetching will include cache/network.
   var fetchBehavior: FetchBehavior { get set }
 
-  /// [optional] A context that is being passed through the request chain.
-  var context: (any RequestContext)? { get set }
-
   /// The telemetry metadata about the client. This is used by GraphOS Studio's
   /// [client awareness](https://www.apollographql.com/docs/graphos/platform/insights/client-segmentation)
   /// feature.

apollo-ios/Sources/Apollo/Interceptors/ApolloInterceptor.swift

@@ -59,8 +59,7 @@
   typealias NextHTTPInterceptorFunction = @Sendable (URLRequest) async throws -> HTTPResponse
 
   func intercept(
-    request: URLRequest,
-    context: (any RequestContext)?,
+    request: URLRequest,    
     next: NextHTTPInterceptorFunction
   ) async throws -> HTTPResponse
 
@@ -75,7 +74,7 @@
     self.stream = stream
   }
 
   init<S: AsyncSequence & Sendable>(stream wrapped: sending S) where S.Element == T {
     self.stream = AsyncThrowingStream { continuation in
       let task = Task { [wrapped] in
         do {
@@ -192,7 +191,7 @@
 extension TaskLocal {
 
   @_disfavoredOverload
   final public func withValue<R: ~Copyable>(
     _ valueDuringOperation: Value,
     operation: () async throws -> R
   ) async rethrows -> R {
@@ -206,7 +205,7 @@
   }
 
   @_disfavoredOverload
   final public func withValue<R: ~Copyable>(
     _ valueDuringOperation: Value,
     operation: () throws -> R
   ) rethrows -> R {

apollo-ios/Sources/Apollo/Interceptors/ResponseCodeInterceptor.swift

@@ -33,7 +33,6 @@ public struct ResponseCodeInterceptor: HTTPInterceptor {
 
   public func intercept(
     request: URLRequest,
-    context: (any RequestContext)?,
     next: NextHTTPInterceptorFunction
   ) async throws -> HTTPResponse {
     return try await next(request).mapChunks { (response, chunk) in

apollo-ios/Sources/Apollo/JSONRequest.swift

@@ -17,9 +17,6 @@ public struct JSONRequest<Operation: GraphQLOperation>: GraphQLRequest, AutoPers
 
   /// The `FetchBehavior` to use for this request. Determines if fetching will include cache/network.
   public var fetchBehavior: FetchBehavior
-
-  /// [optional] A context that is being passed through the request chain.
-  public var context: (any RequestContext)?
 
   public let requestBodyCreator: any JSONRequestBodyCreator
 
@@ -48,7 +45,6 @@ public struct JSONRequest<Operation: GraphQLOperation>: GraphQLRequest, AutoPers
   ///   - clientName: The name of the client to send with the `"apollographql-client-name"` header
   ///   - clientVersion:  The version of the client to send with the `"apollographql-client-version"` header
   ///   - cachePolicy: The `CachePolicy` to use for this request.
-  ///   - context: [optional] A context that is being passed through the request chain. Defaults to `nil`.
   ///   - apqConfig: A configuration struct used by a `GraphQLRequest` to configure the usage of
   ///   [Automatic Persisted Queries (APQs).](https://www.apollographql.com/docs/apollo-server/performance/apq) By default, APQs
   ///   are disabled.
@@ -58,7 +54,6 @@ public struct JSONRequest<Operation: GraphQLOperation>: GraphQLRequest, AutoPers
     operation: Operation,
     graphQLEndpoint: URL,
     fetchBehavior: FetchBehavior,
-    context: (any RequestContext)? = nil,
     apqConfig: AutoPersistedQueryConfiguration = .init(),
     useGETForQueries: Bool = false,
     requestBodyCreator: any JSONRequestBodyCreator = DefaultRequestBodyCreator(),

apollo-ios/Sources/Apollo/NetworkTransport.swift

@@ -15,14 +15,12 @@ public protocol NetworkTransport: AnyObject, Sendable {
   /// - Returns: A stream of `GraphQLResult`s for each response.
   func send<Query: GraphQLQuery>(
     query: Query,
-    cachePolicy: CachePolicy,
-    context: (any RequestContext)?
+    cachePolicy: CachePolicy
   ) throws -> AsyncThrowingStream<GraphQLResult<Query.Data>, any Error>
 
   func send<Mutation: GraphQLMutation>(
     mutation: Mutation,
-    cachePolicy: CachePolicy,
-    context: (any RequestContext)?
+    cachePolicy: CachePolicy
   ) throws -> AsyncThrowingStream<GraphQLResult<Mutation.Data>, any Error>
 
 }
@@ -33,8 +31,7 @@ public protocol SubscriptionNetworkTransport: NetworkTransport {
 
   func send<Subscription: GraphQLSubscription>(
     subscription: Subscription,
-    cachePolicy: CachePolicy,
-    context: (any RequestContext)?
+    cachePolicy: CachePolicy
   ) throws -> AsyncThrowingStream<GraphQLResult<Subscription.Data>, any Error>
 
 }
@@ -54,7 +51,6 @@ public protocol UploadingNetworkTransport: NetworkTransport {
 #warning("TODO: should support query and mutation as seperate functions")
   func upload<Operation: GraphQLOperation>(
     operation: Operation,
-    files: [GraphQLFile],
-    context: (any RequestContext)?
+    files: [GraphQLFile]
   ) throws -> AsyncThrowingStream<GraphQLResult<Operation.Data>, any Error>
 }