[PART 2] Networking Refactor - Unify REST & GraphQL networking implementation
#182
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import Foundation | ||
|
|
||
| // TODO: - Rename to `NetworkingClient`. Now that we have `<PPaaS>API.swift` classes, ths responsibility of this class really is to coordinate networking. It transforms REST & GraphQL into HTTP requests. | ||
| /// :nodoc: This method is exposed for internal PayPal use only. Do not use. It is not covered by Semantic Versioning and may change or be removed at any time. | ||
| /// | ||
| /// `APIClient` is the entry point for each payment method feature to perform API requests. It also offers convenience methods for API requests used across multiple payment methods / modules. | ||
|
|
@@ -29,7 +30,7 @@ public class APIClient { | |
|
|
||
| /// :nodoc: | ||
| public func fetch(request: RESTRequest) async throws -> HTTPResponse { | ||
| let url = try constructRestURL(path: request.path, queryParameters: request.queryParameters ?? [:]) | ||
|
|
||
| let base64EncodedCredentials = Data(coreConfig.clientID.appending(":").utf8).base64EncodedString() | ||
|
|
||
|
|
@@ -51,12 +52,26 @@ public class APIClient { | |
| return try await http.performRequest(httpRequest) | ||
| } | ||
|
|
||
| /// :nodoc: | ||
| public func fetch(request: GraphQLRequest) async throws -> HTTPResponse { | ||
| let url = try constructGraphQLURL(queryName: request.queryNameForURL) | ||
|
|
||
| let postBody = GraphQLHTTPPostBody(query: request.query, variables: request.variables) | ||
|
|
||
| let postData = try JSONEncoder().encode(postBody) | ||
|
|
||
| let httpRequest = HTTPRequest( | ||
|
There was a problem hiding this comment. If we single line this is it above our linter line length? May be nice to just group all of the properties together but not sure if this is more readable this way. There was a problem hiding this comment. It does not violate our line length, but I thought it was a little cleaner. Happy to go either way though! There was a problem hiding this comment. Either way is fine, was more just curious. If it makes more sense to have things grouped together a particular way that's fine too. There was a problem hiding this comment. Not sure what you mean by "group all of these properties together"? You mean single line it? There was a problem hiding this comment. Ok I single-lined both the There was a problem hiding this comment.
Ah, sorry was referencing this comment There was a problem hiding this comment. That link takes me back to:
Do you mean to remove the newlines between these variables? There was a problem hiding this comment. Weird, idk why GH is linking to that. This comment above is the one I was trying to reference:
Not a blocker though, whatever you feel is best |
||
| headers: [.contentType: "application/json"], | ||
| method: .post, | ||
| url: url, | ||
| body: postData | ||
| ) | ||
|
|
||
| return try await http.performRequest(httpRequest) | ||
| } | ||
|
|
||
| // MARK: - Private Methods | ||
|
|
||
| private func constructRestURL(path: String, queryParameters: [String: String]) throws -> URL { | ||
jaxdesmarais marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let urlString = coreConfig.environment.baseURL.appendingPathComponent(path) | ||
| var urlComponents = URLComponents(url: urlString, resolvingAgainstBaseURL: false) | ||
|
|
||
|
|
@@ -70,4 +85,16 @@ public class APIClient { | |
|
|
||
| return url | ||
| } | ||
|
|
||
| private func constructGraphQLURL(queryName: String? = nil) throws -> URL { | ||
| guard let queryName else { | ||
| return coreConfig.environment.graphQLURL | ||
| } | ||
|
|
||
| if let url = URL(string: coreConfig.environment.graphQLURL.absoluteString + "?" + queryName) { | ||
scannillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return url | ||
| } else { | ||
| throw CorePaymentsError.urlEncodingFailed | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import Foundation | ||
|
|
||
| /// Used to parse error message details out of GraphQL HTTP response body | ||
| struct GraphQLErrorResponse: Decodable { | ||
|
|
||
| let error: String | ||
| let correlationId: String? | ||
scannillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import Foundation | ||
|
|
||
| /// The GraphQL query and variable details encoded to be sent in the POST body of a HTTP request | ||
| struct GraphQLHTTPPostBody: Encodable { | ||
|
|
||
| let query: String | ||
| let variables: Data | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| /// Used to decode the HTTP reponse body of GraphQL requests | ||
| struct GraphQLHTTPResponse<T: Codable>: Codable { | ||
|
|
||
| let data: T? | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import Foundation | ||
|
|
||
| /// :nodoc: Values needed to initiate a GraphQL network request | ||
| public struct GraphQLRequest { | ||
|
|
||
| let query: String | ||
| let variables: Data | ||
|
|
||
| /// This is non-standard in the GraphQL language, but sometimes required by PayPal's GraphQL API. | ||
| /// Some requests are sent to `https://www.api.paypal.com/graphql?<queryNameForURL>` | ||
| let queryNameForURL: String? | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure if we need this extra space but up to you:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did it intentionally to group
postBodyandpostDatatogether, but down to remove this newline if it's harder to read