Squashed 'apollo-ios/' changes from 52c5a41b..d82b2305

d82b2305 feature: Enhanced Client Awareness (#638)

git-subtree-dir: apollo-ios
git-subtree-split: d82b2305173ac6dd5a059595bfdcb07b9163c58e

Author: gh-action-runner

Sources/Apollo/ApolloClient.swift

@@ -34,6 +34,8 @@ public class ApolloClient {
 
   public let store: ApolloStore
 
+  private let sendEnhancedClientAwareness: Bool
+
   public enum ApolloClientError: Error, LocalizedError, Hashable {
     case noUploadTransport
 
@@ -49,22 +51,40 @@ public class ApolloClient {
   ///
   /// - Parameters:
   ///   - networkTransport: A network transport used to send operations to a server.
-  ///   - store: A store used as a local cache. Note that if the `NetworkTransport` or any of its dependencies takes a store, you should make sure the same store is passed here so that it can be cleared properly.
-  public init(networkTransport: any NetworkTransport, store: ApolloStore) {
+  ///   - store: A store used as a local cache. Note that if the `NetworkTransport` or any of its dependencies takes
+  ///   a store, you should make sure the same store is passed here so that it can be cleared properly.
+  ///   - sendEnhancedClientAwareness: Specifies whether client library metadata is sent in each request `extensions`
+  ///   key. Client library metadata is the Apollo iOS library name and version. Defaults to `true`.
+  public init(
+    networkTransport: any NetworkTransport,
+    store: ApolloStore,
+    sendEnhancedClientAwareness: Bool = true
+  ) {
     self.networkTransport = networkTransport
     self.store = store
+    self.sendEnhancedClientAwareness = sendEnhancedClientAwareness
   }
 
   /// Creates a client with a `RequestChainNetworkTransport` connecting to the specified URL.
   ///
   /// - Parameter url: The URL of a GraphQL server to connect to.
-  public convenience init(url: URL) {
+  public convenience init(
+    url: URL,
+    sendEnhancedClientAwareness: Bool = true
+  ) {
     let store = ApolloStore(cache: InMemoryNormalizedCache())
     let provider = DefaultInterceptorProvider(store: store)
-    let transport = RequestChainNetworkTransport(interceptorProvider: provider,
-                                                 endpointURL: url)
-    
-    self.init(networkTransport: transport, store: store)
+    let transport = RequestChainNetworkTransport(
+      interceptorProvider: provider,
+      endpointURL: url,
+      sendEnhancedClientAwareness: sendEnhancedClientAwareness
+    )
+
+    self.init(
+      networkTransport: transport,
+      store: store,
+      sendEnhancedClientAwareness: sendEnhancedClientAwareness
+    )
   }
 }
 

Sources/Apollo/Constants.swift

@@ -1,5 +1,9 @@
 import Foundation
 
 public enum Constants {
-    public static let ApolloVersion: String = "1.20.0"
+  public static let ApolloClientName = "apollo-ios"
+  public static let ApolloClientVersion: String = "1.20.0"
+
+  @available(*, deprecated, renamed: "ApolloClientVersion")
+  public static let ApolloVersion: String = ApolloClientVersion
 }

Sources/Apollo/JSONRequest.swift

@@ -5,12 +5,15 @@ import ApolloAPI
 
 /// A request which sends JSON related to a GraphQL operation.
 open class JSONRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
-  
+
   public let requestBodyCreator: any RequestBodyCreator
-  
   public let autoPersistQueries: Bool
   public let useGETForQueries: Bool
   public let useGETForPersistedQueryRetry: Bool
+  public let serializationFormat = JSONSerializationFormat.self
+
+  private let sendEnhancedClientAwareness: Bool
+
   public var isPersistedQueryRetry = false {
     didSet {
       _body = nil
@@ -25,8 +28,6 @@ open class JSONRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
       return _body!
   }
 
-  public let serializationFormat = JSONSerializationFormat.self
-  
   /// Designated initializer
   ///
   /// - Parameters:
@@ -54,12 +55,14 @@ open class JSONRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
     autoPersistQueries: Bool = false,
     useGETForQueries: Bool = false,
     useGETForPersistedQueryRetry: Bool = false,
-    requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator()
+    requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator(),
+    sendEnhancedClientAwareness: Bool = true
   ) {
     self.autoPersistQueries = autoPersistQueries
     self.useGETForQueries = useGETForQueries
     self.useGETForPersistedQueryRetry = useGETForPersistedQueryRetry
     self.requestBodyCreator = requestBodyCreator
+    self.sendEnhancedClientAwareness = sendEnhancedClientAwareness
 
     super.init(
       graphQLEndpoint: graphQLEndpoint,
@@ -120,6 +123,7 @@ open class JSONRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
   private func createBody() -> JSONEncodableDictionary {
     let sendQueryDocument: Bool
     let autoPersistQueries: Bool
+
     switch Operation.operationType {
     case .query:
       if isPersistedQueryRetry {
@@ -142,12 +146,16 @@ open class JSONRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
       autoPersistQueries = false
     }
 
-    let body = self.requestBodyCreator.requestBody(
+    var body = self.requestBodyCreator.requestBody(
       for: operation,
       sendQueryDocument: sendQueryDocument,
       autoPersistQuery: autoPersistQueries
     )
-    
+
+    if self.sendEnhancedClientAwareness {
+      addEnhancedClientAwarenessExtension(to: &body)
+    }
+
     return body
   }
 

Sources/Apollo/RequestChainNetworkTransport.swift

@@ -41,24 +41,36 @@ open class RequestChainNetworkTransport: NetworkTransport {
   ///
   /// Defaults to an ``ApolloRequestBodyCreator`` initialized with the default configuration.
   public var requestBodyCreator: any RequestBodyCreator
-  
+
+  private let sendEnhancedClientAwareness: Bool
+
   /// Designated initializer
   ///
   /// - Parameters:
   ///   - interceptorProvider: The interceptor provider to use when constructing a request chain
   ///   - endpointURL: The GraphQL endpoint URL to use
-  ///   - additionalHeaders: Any additional headers that should be automatically added to every request. Defaults to an empty dictionary.
-  ///   - autoPersistQueries: Pass `true` if Automatic Persisted Queries should be used to send a query hash instead of the full query body by default. Defaults to `false`.
-  ///   - requestBodyCreator: The `RequestBodyCreator` object to use to build your `URLRequest`. Defaults to the provided `ApolloRequestBodyCreator` implementation.
-  ///   - useGETForQueries: Pass `true` if you want to use `GET` instead of `POST` for queries, for example to take advantage of a CDN. Defaults to `false`.
-  ///   - useGETForPersistedQueryRetry: Pass `true` to use `GET` instead of `POST` for a retry of a persisted query. Defaults to `false`. 
-  public init(interceptorProvider: any InterceptorProvider,
-              endpointURL: URL,
-              additionalHeaders: [String: String] = [:],
-              autoPersistQueries: Bool = false,
-              requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator(),
-              useGETForQueries: Bool = false,
-              useGETForPersistedQueryRetry: Bool = false) {
+  ///   - additionalHeaders: Any additional headers that should be automatically added to every request. Defaults to
+  ///   an empty dictionary.
+  ///   - autoPersistQueries: Pass `true` if Automatic Persisted Queries should be used to send a query hash instead
+  ///   of the full query body by default. Defaults to `false`.
+  ///   - requestBodyCreator: The `RequestBodyCreator` object to use to build your `URLRequest`. Defaults to the
+  ///   provided `ApolloRequestBodyCreator` implementation.
+  ///   - useGETForQueries: Pass `true` if you want to use `GET` instead of `POST` for queries, for example to take
+  ///   advantage of a CDN. Defaults to `false`.
+  ///   - useGETForPersistedQueryRetry: Pass `true` to use `GET` instead of `POST` for a retry of a persisted query.
+  ///   Defaults to `false`.
+  ///   - sendEnhancedClientAwareness: Specifies whether client library metadata is sent in each request `extensions`
+  ///   key. Client library metadata is the Apollo iOS library name and version. Defaults to `true`.
+  public init(
+    interceptorProvider: any InterceptorProvider,
+    endpointURL: URL,
+    additionalHeaders: [String: String] = [:],
+    autoPersistQueries: Bool = false,
+    requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator(),
+    useGETForQueries: Bool = false,
+    useGETForPersistedQueryRetry: Bool = false,
+    sendEnhancedClientAwareness: Bool = true
+  ) {
     self.interceptorProvider = interceptorProvider
     self.endpointURL = endpointURL
 
@@ -67,6 +79,7 @@ open class RequestChainNetworkTransport: NetworkTransport {
     self.requestBodyCreator = requestBodyCreator
     self.useGETForQueries = useGETForQueries
     self.useGETForPersistedQueryRetry = useGETForPersistedQueryRetry
+    self.sendEnhancedClientAwareness = sendEnhancedClientAwareness
   }
 
   /// Constructs a GraphQL request for the given operation.
@@ -97,7 +110,8 @@ open class RequestChainNetworkTransport: NetworkTransport {
       autoPersistQueries: self.autoPersistQueries,
       useGETForQueries: self.useGETForQueries,
       useGETForPersistedQueryRetry: self.useGETForPersistedQueryRetry,
-      requestBodyCreator: self.requestBodyCreator
+      requestBodyCreator: self.requestBodyCreator,
+      sendEnhancedClientAwareness: self.sendEnhancedClientAwareness
     )
 
     if Operation.operationType == .subscription {
@@ -169,16 +183,19 @@ extension RequestChainNetworkTransport: UploadingNetworkTransport {
     with files: [GraphQLFile],
     context: (any RequestContext)? = nil,
     manualBoundary: String? = nil) -> HTTPRequest<Operation> {
-    
-    UploadRequest(graphQLEndpoint: self.endpointURL,
-                  operation: operation,
-                  clientName: self.clientName,
-                  clientVersion: self.clientVersion,
-                  additionalHeaders: self.additionalHeaders,
-                  files: files,
-                  manualBoundary: manualBoundary,
-                  context: context,
-                  requestBodyCreator: self.requestBodyCreator)
+
+      UploadRequest(
+        graphQLEndpoint: self.endpointURL,
+        operation: operation,
+        clientName: self.clientName,
+        clientVersion: self.clientVersion,
+        additionalHeaders: self.additionalHeaders,
+        files: files,
+        manualBoundary: manualBoundary,
+        context: context,
+        requestBodyCreator: self.requestBodyCreator,
+        sendEnhancedClientAwareness: self.sendEnhancedClientAwareness
+      )
   }
 
   public func upload<Operation: GraphQLOperation>(

Sources/Apollo/RequestClientMetadata.swift

@@ -0,0 +1,34 @@
+import Foundation
+#if !COCOAPODS
+import ApolloAPI
+#endif
+
+extension JSONRequest {
+  /// Adds client metadata to the request body in the `extensions` key.
+  ///
+  /// - Parameter body: The previously generated JSON body.
+  func addEnhancedClientAwarenessExtension(to body: inout JSONEncodableDictionary) {
+    _addEnhancedClientAwarenessExtension(to: &body)
+  }
+}
+
+extension UploadRequest {
+  /// Adds client metadata to the request body in the `extensions` key.
+  ///
+  /// - Parameter body: The previously generated JSON body.
+  func addEnhancedClientAwarenessExtension(to body: inout JSONEncodableDictionary) {
+    _addEnhancedClientAwarenessExtension(to: &body)
+  }
+}
+
+fileprivate func _addEnhancedClientAwarenessExtension(to body: inout JSONEncodableDictionary) {
+  let clientLibraryMetadata: JSONEncodableDictionary = [
+    "name": Constants.ApolloClientName,
+    "version": Constants.ApolloClientVersion
+  ]
+
+  var extensions = body["extensions"] as? JSONEncodableDictionary ?? JSONEncodableDictionary()
+  extensions["clientLibrary"] = clientLibraryMetadata
+
+  body["extensions"] = extensions
+}

Sources/Apollo/RequestContext.swift

@@ -13,8 +13,9 @@ public protocol RequestContext {}
 
 /// A request context specialization protocol that specifies options for configuring the timeout of a `URLRequest`.
 ///
-/// A `RequestContext` object can conform to this protocol to provide a custom `requestTimeout` for an individual request.
-/// If the `RequestContext` for a request does not conform to this protocol, the default request timeout of `URLRequest` will be used.
+/// A `RequestContext` object can conform to this protocol to provide a custom `requestTimeout` for an individual
+/// request. If the `RequestContext` for a request does not conform to this protocol, the default request timeout
+/// of `URLRequest` will be used.
 public protocol RequestContextTimeoutConfigurable: RequestContext {
   /// The timeout interval specifies the limit on the idle interval allotted to a request in the process of
   /// loading. This timeout interval is measured in seconds.

Sources/Apollo/UploadRequest.swift

@@ -9,9 +9,10 @@ open class UploadRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
   public let requestBodyCreator: any RequestBodyCreator
   public let files: [GraphQLFile]
   public let manualBoundary: String?
-  
   public let serializationFormat = JSONSerializationFormat.self
-  
+
+  private let sendEnhancedClientAwareness: Bool
+
   /// Designated Initializer
   ///
   /// - Parameters:
@@ -24,25 +25,32 @@ open class UploadRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
   ///   - manualBoundary: [optional] A manual boundary to pass in. A default boundary will be used otherwise. Defaults to nil.
   ///   - context: [optional] A context that is being passed through the request chain. Should default to `nil`.
   ///   - requestBodyCreator: An object conforming to the `RequestBodyCreator` protocol to assist with creating the request body. Defaults to the provided `ApolloRequestBodyCreator` implementation.
-  public init(graphQLEndpoint: URL,
-              operation: Operation,
-              clientName: String,
-              clientVersion: String,
-              additionalHeaders: [String: String] = [:],
-              files: [GraphQLFile],
-              manualBoundary: String? = nil,
-              context: (any RequestContext)? = nil,
-              requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator()) {
+  public init(
+    graphQLEndpoint: URL,
+    operation: Operation,
+    clientName: String,
+    clientVersion: String,
+    additionalHeaders: [String: String] = [:],
+    files: [GraphQLFile],
+    manualBoundary: String? = nil,
+    context: (any RequestContext)? = nil,
+    requestBodyCreator: any RequestBodyCreator = ApolloRequestBodyCreator(),
+    sendEnhancedClientAwareness: Bool = true
+  ) {
     self.requestBodyCreator = requestBodyCreator
     self.files = files
     self.manualBoundary = manualBoundary
-    super.init(graphQLEndpoint: graphQLEndpoint,
-               operation: operation,
-               contentType: "multipart/form-data",
-               clientName: clientName,
-               clientVersion: clientVersion,
-               additionalHeaders: additionalHeaders,
-               context: context)
+    self.sendEnhancedClientAwareness = sendEnhancedClientAwareness
+
+    super.init(
+      graphQLEndpoint: graphQLEndpoint,
+      operation: operation,
+      contentType: "multipart/form-data",
+      clientName: clientName,
+      clientVersion: clientVersion,
+      additionalHeaders: additionalHeaders,
+      context: context
+    )
   }
 
   public override func toURLRequest() throws -> URLRequest {
@@ -88,6 +96,10 @@ open class UploadRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
     }
     fields["variables"] = variables
 
+    if self.sendEnhancedClientAwareness {
+      addEnhancedClientAwarenessExtension(to: &fields)
+    }
+
     let operationData = try serializationFormat.serialize(value: fields)
     formData.appendPart(data: operationData, name: "operations")
 

scripts/get-version.sh

@@ -4,5 +4,5 @@ directory=$(dirname "$0")
 source "$directory/version-constants.sh"
 
 constantsFile=$(cat "$directory/../$APOLLO_CONSTANTS_FILE")
-currentVersion=$(echo $constantsFile | sed 's/^.*ApolloVersion: String = "\([^"]*\).*/\1/')
+currentVersion=$(echo $constantsFile | sed 's/^.*ApolloClientVersion: String = "\([^"]*\).*/\1/')
 echo $currentVersion