Merge pull request #1450 from apollographql/fix/protocol-default-implementation

Fix request body creator non-default implementations getting hammered by compiler

Author: designatednerd

Sources/Apollo/RequestBodyCreator.swift

@@ -8,27 +8,24 @@ public protocol RequestBodyCreator {
   ///
   /// - Parameters:
   ///   - operation: The operation to use
-  ///   - sendOperationIdentifiers: Whether or not to send operation identifiers. Defaults to false.
+  ///   - sendOperationIdentifiers: Whether or not to send operation identifiers. Should default to `false`.
+  ///   - sendQueryDocument: Whether or not to send the full query document. Should default to `true`.
+  ///   - autoPersistQuery: Whether to use auto-persisted query information. Should default to `false`.
   /// - Returns: The created `GraphQLMap`
   func requestBody<Operation: GraphQLOperation>(for operation: Operation,
                                                 sendOperationIdentifiers: Bool,
                                                 sendQueryDocument: Bool,
                                                 autoPersistQuery: Bool) -> GraphQLMap
 }
 
+// MARK: - Default Implementation
+
 extension RequestBodyCreator {
-  /// Creates a `GraphQLMap` out of the passed-in operation
-  ///
-  /// - Parameters:
-  ///   - operation: The operation to use
-  ///   - sendOperationIdentifiers: Whether or not to send operation identifiers. Defaults to false.
-  ///   - sendQueryDocument: Whether or not to send the full query document. Defaults to true.
-  ///   - autoPersistQuery: Whether to use auto-persisted query information. Defaults to false.
-  /// - Returns: The created `GraphQLMap`
+  
   public func requestBody<Operation: GraphQLOperation>(for operation: Operation,
-                                                       sendOperationIdentifiers: Bool = false,
-                                                       sendQueryDocument: Bool = true,
-                                                       autoPersistQuery: Bool = false) -> GraphQLMap {
+                                                       sendOperationIdentifiers: Bool,
+                                                       sendQueryDocument: Bool,
+                                                       autoPersistQuery: Bool) -> GraphQLMap {
     var body: GraphQLMap = [
       "variables": operation.variables,
       "operationName": operation.operationName,

Sources/Apollo/UploadRequest.swift

@@ -69,7 +69,10 @@ open class UploadRequest<Operation: GraphQLOperation>: HTTPRequest<Operation> {
     // Make sure all fields for files are set to null, or the server won't look
     // for the files in the rest of the form data
     let fieldsForFiles = Set(files.map { $0.fieldName }).sorted()
-    var fields = self.requestBodyCreator.requestBody(for: operation, sendOperationIdentifiers: shouldSendOperationID)
+    var fields = self.requestBodyCreator.requestBody(for: operation,
+                                                     sendOperationIdentifiers: shouldSendOperationID,
+                                                     sendQueryDocument: true,
+                                                     autoPersistQuery: false)
     var variables = fields["variables"] as? GraphQLMap ?? GraphQLMap()
     for fieldName in fieldsForFiles {
       if

Sources/ApolloWebSocket/WebSocketTransport.swift

@@ -270,7 +270,10 @@ public class WebSocketTransport {
   }
 
   func sendHelper<Operation: GraphQLOperation>(operation: Operation, resultHandler: @escaping (_ result: Result<JSONObject, Error>) -> Void) -> String? {
-    let body = requestBodyCreator.requestBody(for: operation, sendOperationIdentifiers: self.sendOperationIdentifiers)
+    let body = requestBodyCreator.requestBody(for: operation,
+                                              sendOperationIdentifiers: self.sendOperationIdentifiers,
+                                              sendQueryDocument: true,
+                                              autoPersistQuery: false)
     let sequenceNumber = "\(sequenceNumberCounter.increment())"
 
     guard let message = OperationMessage(payload: body, id: sequenceNumber).rawMessage else {

Tests/ApolloTests/GETTransformerTests.swift

@@ -17,7 +17,10 @@ class GETTransformerTests: XCTestCase {
 
   func testEncodingQueryWithSingleParameter() {
     let operation = HeroNameQuery(episode: .empire)
-    let body = requestBodyCreator.requestBody(for: operation, sendOperationIdentifiers: false)
+    let body = requestBodyCreator.requestBody(for: operation,
+                                              sendOperationIdentifiers: false,
+                                              sendQueryDocument: true,
+                                              autoPersistQuery: false)
 
     let transformer = GraphQLGETTransformer(body: body, url: self.url)
 
@@ -28,7 +31,10 @@ class GETTransformerTests: XCTestCase {
 
   func testEncodingQueryWithMoreThanOneParameterIncludingNonHashableValue() throws {
     let operation = HeroNameTypeSpecificConditionalInclusionQuery(episode: .jedi, includeName: true)
-    let body = requestBodyCreator.requestBody(for: operation, sendOperationIdentifiers: false)
+    let body = requestBodyCreator.requestBody(for: operation,
+                                              sendOperationIdentifiers: false,
+                                              sendQueryDocument: true,
+                                              autoPersistQuery: false)
 
     let transformer = GraphQLGETTransformer(body: body, url: self.url)
 
@@ -195,7 +201,10 @@ class GETTransformerTests: XCTestCase {
 
   func testEncodingQueryWithNullDefaultParameter() {
     let operation = HeroNameQuery()
-    let body = requestBodyCreator.requestBody(for: operation, sendOperationIdentifiers: false)
+    let body = requestBodyCreator.requestBody(for: operation,
+                                              sendOperationIdentifiers: false,
+                                              sendQueryDocument: true,
+                                              autoPersistQuery: false)
 
     let transformer = GraphQLGETTransformer(body: body, url: self.url)
 

Tests/ApolloTests/RequestBodyCreatorTests.swift

@@ -15,18 +15,25 @@ class RequestBodyCreatorTests: XCTestCase {
   private let customRequestBodyCreator = TestCustomRequestBodyCreator()
   private let apolloRequestBodyCreator = ApolloRequestBodyCreator()
 
+  func create<Operation: GraphQLOperation>(with creator: RequestBodyCreator, for query: Operation) -> GraphQLMap {
+    creator.requestBody(for: query,
+                        sendOperationIdentifiers: false,
+                        sendQueryDocument: true,
+                        autoPersistQuery: false)
+  }
+  
   // MARK: - Tests
 
   func testRequestBodyWithApolloRequestBodyCreator() {
     let query = HeroNameQuery()
-    let req = apolloRequestBodyCreator.requestBody(for: query, sendOperationIdentifiers: false)
+    let req = self.create(with: apolloRequestBodyCreator, for: query)
 
     XCTAssertEqual(query.queryDocument, req["query"] as? String)
   }
 
   func testRequestBodyWithCustomRequestBodyCreator() {
     let query = HeroNameQuery()
-    let req = customRequestBodyCreator.requestBody(for: query, sendOperationIdentifiers: false)
+    let req = self.create(with: customRequestBodyCreator, for: query)
 
     XCTAssertEqual(query.queryDocument, req["test_query"] as? String)
   }

Tests/ApolloTests/TestCustomRequestBodyCreator.swift

@@ -9,7 +9,11 @@
 import Apollo
 
 struct TestCustomRequestBodyCreator: RequestBodyCreator {
-  public func requestBody<Operation: GraphQLOperation>(for operation: Operation, sendOperationIdentifiers: Bool) -> GraphQLMap {
+  func requestBody<Operation: GraphQLOperation>(
+    for operation: Operation,
+    sendOperationIdentifiers: Bool,
+    sendQueryDocument: Bool, autoPersistQuery: Bool) -> GraphQLMap {
+    
     var body: GraphQLMap = [
       "test_variables": operation.variables,
       "test_operationName": operation.operationName,