Remove deprecated instrumentation message

Sources/ShopifyCheckoutSheetKit/CheckoutBridge.swift

@@ -25,11 +25,9 @@
 
 enum BridgeError: Swift.Error {
     case invalidBridgeEvent(Swift.Error? = nil)
-    case unencodableInstrumentation(Swift.Error? = nil)
 }
 
 protocol CheckoutBridgeProtocol {
-    static func instrument(_ webView: WKWebView, _ instrumentation: InstrumentationPayload)
     static func sendMessage(_ webView: WKWebView, messageName: String, messageBody: String?)
 }
 
@@ -76,12 +74,7 @@
         }
     }
 
-    static func instrument(_ webView: WKWebView, _ instrumentation: InstrumentationPayload) {
-        if let payload = instrumentation.toBridgeEvent() {
-            sendMessage(webView, messageName: "instrumentation", messageBody: payload)
-        }
-    }
 
     static func sendMessage(_ webView: WKWebView, messageName: String, messageBody: String?) {
         let dispatchMessageBody: String
         if let body = messageBody {
@@ -180,23 +173,7 @@
     }
 }
 
-struct InstrumentationPayload: Codable {
-    var name: String
-    var value: Int
-    var type: InstrumentationType
-    var tags: [String: String] = [:]
-}
-
-enum InstrumentationType: String, Codable {
-    case histogram
-}
-
-extension InstrumentationPayload {
-    func toBridgeEvent() -> String? {
-        SdkToWebEvent(detail: self).toJson()
-    }
-}
 
 struct SdkToWebEvent<T: Codable>: Codable {
     var detail: T
 }
@@ -207,9 +184,9 @@
             let jsonData = try JSONEncoder().encode(self)
             return String(data: jsonData, encoding: .utf8)
         } catch {
-            print(#function, BridgeError.unencodableInstrumentation(error))
+            return nil
         }
 
         return nil
     }
 }

Sources/ShopifyCheckoutSheetKit/CheckoutWebView.swift

@@ -222,11 +222,7 @@
         }
     }
 
-    func instrument(_ payload: InstrumentationPayload) {
-        OSLogger.shared.debug("Emitting instrumentation event with payload: \(payload)")
-        checkoutBridge.instrument(self, payload)
-    }
 
     // MARK: -
 
     func load(checkout url: URL, isPreload: Bool = false) {
@@ -403,19 +399,10 @@
             let endTime = Date()
             let diff = endTime.timeIntervalSince(startTime)
             let message = "Loaded checkout in \(String(format: "%.2f", diff))s"
             let preload = String(isPreloadRequest)
 
             ShopifyCheckoutSheetKit.configuration.logger.log(message)
 
-            if isBridgeAttached {
-                instrument(
-                    InstrumentationPayload(
-                        name: "checkout_finished_loading",
-                        value: Int(diff * 1000),
-                        type: .histogram,
-                        tags: ["preloading": preload]
-                    ))
-            }
         }
         checkoutDidLoad = true
         timer = nil

Tests/ShopifyCheckoutSheetKitTests/CheckoutBridgeTests.swift

@@ -302,20 +302,7 @@
         }
     }
 
-    func testInstrumentationPayloadToBridgeEvent() {
-        let payload = InstrumentationPayload(name: "test", value: 1, type: .histogram)
-        let jsonString = payload.toBridgeEvent()
-        XCTAssertNotNil(jsonString)
-
-        if let jsonData = jsonString?.data(using: .utf8) {
-            let decodedPayload = try? JSONDecoder().decode(SdkToWebEvent<InstrumentationPayload>.self, from: jsonData)
-            XCTAssertNotNil(decodedPayload)
-            XCTAssertEqual(decodedPayload?.detail.name, "test")
-            XCTAssertEqual(decodedPayload?.detail.value, 1)
-            XCTAssertEqual(decodedPayload?.detail.type, .histogram)
-        }
-    }
 
     func testSendMessageShouldCallEvaluateJavaScriptPresented() {
         let webView = MockWebView()
         webView.expectedScript = expectedPresentedScript()

Tests/ShopifyCheckoutSheetKitTests/CheckoutWebViewTests.swift

@@ -375,56 +375,9 @@
         XCTAssertFalse(webView.isPreloadRequest)
     }
 
-    func testInstrumentRequestWithPreloadingTag() {
-        let webView = LoadedRequestObservableWebView()
 
-        webView.load(
-            checkout: URL(string: "https://checkout-sdk.myshopify.io")!,
-            isPreload: true
-        )
 
-        webView.timer = Date()
-        webView.webView(webView, didFinish: nil)
-
-        XCTAssertTrue(webView.isPreloadRequest)
-        XCTAssertEqual(webView.lastInstrumentationPayload?.name, "checkout_finished_loading")
-        XCTAssertEqual(webView.lastInstrumentationPayload?.type, .histogram)
-        XCTAssertEqual(webView.lastInstrumentationPayload?.tags, ["preloading": "true"])
-    }
-
-    func testDoesNotInstrumentRequestWithPreloadingTag() {
-        let webView = LoadedRequestObservableWebView()
-
-        webView.load(
-            checkout: URL(string: "https://checkout-sdk.myshopify.io")!,
-            isPreload: false
-        )
-
-        webView.timer = Date()
-        webView.webView(webView, didFinish: nil)
-
-        XCTAssertFalse(webView.isPreloadRequest)
-        XCTAssertEqual(webView.lastInstrumentationPayload?.name, "checkout_finished_loading")
-        XCTAssertEqual(webView.lastInstrumentationPayload?.type, .histogram)
-        XCTAssertEqual(webView.lastInstrumentationPayload?.tags, ["preloading": "false"])
-    }
-
-    func testDoesNotInstrumentPreloadingTagIfDisabled() {
-        let webView = LoadedRequestObservableWebView()
-        ShopifyCheckoutSheetKit.configuration.preloading.enabled = false
-
-        webView.load(
-            checkout: URL(string: "https://checkout-sdk.myshopify.io")!,
-            /// This is not respected if preloading is disabled at a config level
-            isPreload: true
-        )
-
-        webView.timer = Date()
-        webView.webView(webView, didFinish: nil)
-
-        XCTAssertEqual(webView.lastInstrumentationPayload?.tags, ["preloading": "false"])
-    }
 
     func testDetachBridgeCalledOnInit() {
         ShopifyCheckoutSheetKit.configuration.preloading.enabled = false
         let url = URL(string: "http://shopify1.shopify.com/checkouts/cn/123")
@@ -486,26 +439,16 @@
 
 class LoadedRequestObservableWebView: CheckoutWebView {
     var lastLoadedURLRequest: URLRequest?
-    var lastInstrumentationPayload: InstrumentationPayload?
 
     override func load(_ request: URLRequest) -> WKNavigation? {
         lastLoadedURLRequest = request
         return nil
     }
-
-    override func instrument(_ payload: InstrumentationPayload) {
-        lastInstrumentationPayload = payload
-    }
 }
 
 class MockCheckoutBridge: CheckoutBridgeProtocol {
-    static var instrumentCalled = false
     static var sendMessageCalled = false
 
-    static func instrument(_: WKWebView, _: InstrumentationPayload) {
-        instrumentCalled = true
-    }
-
     static func sendMessage(_: WKWebView, messageName _: String, messageBody _: String?) {
         sendMessageCalled = true
     }