Add uploadURL to UploadEvent (#42)

* Add uploadURL to upload event

* Report uploadURL, add test to validate payload

* Back out UIDevice and Locale from UploadEvent initializer

* Reuse JSONEncoder across uploads

* Add todo

* More todos

Author: andrewjl-mux

Sources/MuxUploadSDK/InternalUtilities/Reporter.swift

@@ -6,20 +6,59 @@
 //
 
 import Foundation
+import UIKit
 
 class Reporter: NSObject {
     var session: URLSession?
     var pendingUploadEvent: UploadEvent?
 
+    var jsonEncoder: JSONEncoder
+
     override init() {
+        let jsonEncoder = JSONEncoder()
+        jsonEncoder.keyEncodingStrategy = JSONEncoder.KeyEncodingStrategy.convertToSnakeCase
+        jsonEncoder.outputFormatting = .sortedKeys
+        self.jsonEncoder = jsonEncoder
+
         super.init()
 
         let sessionConfig: URLSessionConfiguration = URLSessionConfiguration.default
         session = URLSession(configuration: sessionConfig, delegate: self, delegateQueue: nil)
     }
 
-    func report(startTime: TimeInterval, endTime: TimeInterval, fileSize: UInt64, videoDuration: Double) -> Void {
-        self.pendingUploadEvent = UploadEvent(startTime: startTime, endTime: endTime, fileSize: fileSize, videoDuration: videoDuration)
+    func report(
+        startTime: TimeInterval,
+        endTime: TimeInterval,
+        fileSize: UInt64,
+        videoDuration: Double,
+        uploadURL: URL
+    ) -> Void {
+
+        // TODO: Set these using dependency Injection
+        let locale = Locale.current
+        let device = UIDevice.current
+
+        let regionCode: String?
+        if #available(iOS 16, *) {
+            regionCode = locale.language.region?.identifier
+        } else {
+            regionCode = locale.regionCode
+        }
+
+        self.pendingUploadEvent = UploadEvent(
+            startTime: startTime,
+            endTime: endTime,
+            fileSize: fileSize,
+            videoDuration: videoDuration,
+            uploadURL: uploadURL,
+            sdkVersion: Version.versionString,
+            osName: device.systemName,
+            osVersion: device.systemVersion,
+            deviceModel: device.model,
+            appName: Bundle.main.bundleIdentifier,
+            appVersion: Bundle.main.appVersion,
+            regionCode: regionCode
+        )
 
         let request = self.generateRequest(url: URL(string: "https://mobile.muxanalytics.com")!)
 
@@ -29,6 +68,10 @@ class Reporter: NSObject {
         dataTask?.resume()
     }
 
+    func serializePendingEvent() throws -> Data {
+        return try jsonEncoder.encode(pendingUploadEvent)
+    }
+
     private func generateRequest(url: URL) -> URLRequest {
         let request = NSMutableURLRequest(url: url,
                                           cachePolicy: .useProtocolCachePolicy,
@@ -37,17 +80,19 @@ class Reporter: NSObject {
         request.setValue("application/json", forHTTPHeaderField: "Accept")
         request.setValue("application/json", forHTTPHeaderField: "Content-Type")
 
+        // FIXME: If this fails, an event without a payload
+        // is sent which probably isn't what we want
         do {
-            let encoder = JSONEncoder()
-            encoder.keyEncodingStrategy = JSONEncoder.KeyEncodingStrategy.convertToSnakeCase
-            let jsonData = try encoder.encode(self.pendingUploadEvent)
+            let jsonData = try serializePendingEvent()
             request.httpBody = jsonData
         } catch _ as NSError {}
 
         return request as URLRequest
     }
 }
 
+// TODO: Implement as a separate object so the URLSession
+// can become non-optional, which removes a bunch of edge cases
 extension Reporter: URLSessionDelegate, URLSessionTaskDelegate {
     public func urlSession(_ session: URLSession, task: URLSessionTask, willPerformHTTPRedirection response: HTTPURLResponse, newRequest request: URLRequest, completionHandler: @escaping (URLRequest?) -> Swift.Void) {
         if(self.pendingUploadEvent != nil) {

Sources/MuxUploadSDK/InternalUtilities/UploadEvent.swift

@@ -6,14 +6,14 @@
 //
 
 import Foundation
-import UIKit
 
 struct UploadEvent: Codable {
     var type = "upload"
     var startTime: TimeInterval
     var endTime: TimeInterval
     var fileSize: UInt64
     var videoDuration: Double
+    var uploadURL: URL
 
     var sdkVersion: String
 
@@ -26,32 +26,6 @@ struct UploadEvent: Codable {
     var appVersion: String?
 
     var regionCode: String?
-
-    init(startTime: TimeInterval, endTime: TimeInterval, fileSize: UInt64, videoDuration: Double) {
-        let locale = Locale.current
-        let device = UIDevice.current
-
-        self.startTime = startTime
-        self.endTime = endTime
-        self.fileSize = fileSize
-        self.videoDuration = videoDuration
-
-        self.sdkVersion = Version.versionString
-
-        self.osName = device.systemName
-        self.osVersion = device.systemVersion
-
-        self.deviceModel = device.model
-
-        self.appName = Bundle.main.bundleIdentifier
-        self.appVersion = Bundle.main.appVersion
-
-        if #available(iOS 16, *) {
-            self.regionCode = locale.language.region?.identifier
-        } else {
-            self.regionCode = locale.regionCode
-        }
-    }
 }
 
 extension Bundle {

Sources/MuxUploadSDK/Upload/ChunkedFileUploader.swift

@@ -113,7 +113,8 @@ class ChunkedFileUploader {
                         startTime: success.startTime,
                         endTime: success.finishTime,
                         fileSize: fileSize,
-                        videoDuration: duration.seconds
+                        videoDuration: duration.seconds,
+                        uploadURL: uploadInfo.uploadURL
                     )
                 }
 

Tests/MuxUploadSDKTests/Upload Tests/ReporterTests.swift

@@ -0,0 +1,45 @@
+//
+//  ReporterTests.swift
+//
+
+import Foundation
+import XCTest
+
+@testable import MuxUploadSDK
+
+class ReporterTests: XCTestCase {
+
+    func testUploadEventSerialization() throws {
+        let reporter = Reporter()
+        reporter.pendingUploadEvent = UploadEvent(
+            startTime: 100,
+            endTime: 103,
+            fileSize: 1_500_000,
+            videoDuration: 3.14,
+            uploadURL: URL(string: "https://www.example.com")!,
+            sdkVersion: "0.3.1",
+            osName: "iPadOS",
+            osVersion: "16.2",
+            deviceModel: "iPad",
+            appName: "foo",
+            appVersion: "14.3.1",
+            regionCode: "US"
+        )
+
+        let serializedUploadEvent = try reporter.serializePendingEvent()
+
+        let json = try XCTUnwrap(
+            String(
+                data: serializedUploadEvent,
+                encoding: .utf8
+            )
+        )
+
+        XCTAssertEqual(
+            json,
+            "{\"app_name\":\"foo\",\"app_version\":\"14.3.1\",\"device_model\":\"iPad\",\"end_time\":103,\"file_size\":1500000,\"os_name\":\"iPadOS\",\"os_version\":\"16.2\",\"region_code\":\"US\",\"sdk_version\":\"0.3.1\",\"start_time\":100,\"type\":\"upload\",\"upload_url\":\"https:\\/\\/www.example.com\",\"video_duration\":3.1400000000000001}"
+        )
+
+    }
+
+}