[V3] Add Networking to Send Analytics #75
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,42 @@ | ||
| import Foundation | ||
|
|
||
| protocol AnalyticsServiceable { | ||
| func sendAnalyticsEvent(_ eventName: String, sessionID: String) | ||
richherrera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| final class AnalyticsService: AnalyticsServiceable { | ||
|
|
||
| // MARK: - Private Properties | ||
|
|
||
| /// The FPTI URL to post all analytic events. | ||
| private let url = URL(string: "https://api.paypal.com/v1/tracking/batch/events")! | ||
|
There was a problem hiding this comment. Since we aren't actually batching, FPTI has a separate endpoint for single event upload To see the structure of each, you can look at the API details in PPAAS (I also have it in a Postman collection) There was a problem hiding this comment. Yes, it's the endpoint used in PPCP, however, we would need a custom encode method. I did a POC with those changes and was thinking that it would be better to have the same implementation we have in BT, which is why I opted for this implementation. While working on BT v7, we chose not to use a custom encode method. Do you think we could use it for this repo? |
||
| private let networkClient: Networkable | ||
|
|
||
| // MARK: - Initializer | ||
|
|
||
| init(networkClient: Networkable = NetworkClient()) { | ||
| self.networkClient = networkClient | ||
| } | ||
|
|
||
| // MARK: - Internal Methods | ||
|
|
||
| func sendAnalyticsEvent(_ eventName: String, sessionID: String) { | ||
| Task(priority: .background) { | ||
| await performEventRequest(eventName, sessionID: sessionID) | ||
| } | ||
| } | ||
|
|
||
| func performEventRequest(_ eventName: String, sessionID: String) async { | ||
| let body = createAnalyticsEvent(eventName: eventName, sessionID: sessionID) | ||
| try? await networkClient.post(url: url, body: body) | ||
richherrera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // MARK: - Private Methods | ||
|
|
||
| /// Constructs POST params to be sent to FPTI | ||
| private func createAnalyticsEvent(eventName: String, sessionID: String) -> Codable { | ||
| let batchMetadata = FPTIBatchData.Metadata(sessionID: sessionID) | ||
| let event = FPTIBatchData.Event(eventName: eventName) | ||
| return FPTIBatchData(metadata: batchMetadata, events: [event]) | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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,40 @@ | ||
| import Foundation | ||
|
|
||
| protocol Networkable { | ||
| func post<T: Encodable>(url: URL, body: T) async throws | ||
| } | ||
|
|
||
| final class NetworkClient: Networkable { | ||
|
There was a problem hiding this comment. If we know that PopupBridge doesn't do any other networking besides just sending a single POST for analytics, do we think it's worth having this as a separate layer from AnalyticsService? Thinking of the KISS principe There was a problem hiding this comment. Updated: 7bc9147 |
||
|
|
||
| // MARK: - Private Properties | ||
|
|
||
| private let session: Sessionable | ||
|
|
||
| // MARK: - Initializer | ||
|
|
||
| init(session: Sessionable = URLSession.shared) { | ||
richherrera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| self.session = session | ||
| } | ||
|
|
||
| // MARK: - Internal Methods | ||
|
|
||
| func post<T: Encodable>(url: URL, body: T) async throws { | ||
richherrera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| var request = URLRequest(url: url) | ||
| request.httpMethod = "POST" | ||
| request.allHTTPHeaderFields = ["Content-Type": "application/json"] | ||
|
|
||
| do { | ||
| let encodedBody = try JSONEncoder().encode(body) | ||
| request.httpBody = encodedBody | ||
| } catch let encodingError { | ||
| throw NetworkError.encodingError(encodingError) | ||
| } | ||
richherrera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| let (_, response) = try await session.data(for: request) | ||
|
|
||
| guard let httpResponse = response as? HTTPURLResponse, | ||
| (200...299).contains(httpResponse.statusCode) else { | ||
| throw NetworkError.invalidResponse | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Can we add all of the new files that were specifically added for analytics to an
Analyticsfolder underSources/PopupBridge? nitpick, but would help navigation of the PopupBridge source filesThere 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.
Updated: c8fd4cf