fix: log query parameter - WPB-22183 (#4074)

Author: netbe

WireLogging/Sources/WireLogging/Network/RequestLog.swift

@@ -79,8 +79,38 @@ struct RequestLog: Codable {
 }
 
 public extension URL {
+
     var endpointRemoteLogDescription: String {
-        absoluteString
+        var components = URLComponents(string: absoluteString)
+        let searchContactPath = "/search/contacts"
+
+        let path = components?.path ?? ""
+        guard path.contains(searchContactPath) else {
+            return absoluteString
+        }
+
+        // redact query param
+        var queryComponents = components?.queryItems ?? []
+        queryComponents.enumerated().forEach { item in
+            var redactedItem = item.element
+            if redactedItem.name == "q" {
+                redactedItem.value = "***"
+            }
+            queryComponents[item.offset] = redactedItem
+        }
+
+        components?.queryItems = queryComponents
+
+        var endpoint = [
+            "\(components?.scheme ?? ""):/",
+            components?.host,
+            path.trimmingCharacters(in: CharacterSet(charactersIn: "/"))
+        ]
+        .compactMap(\.self)
+        .filter { !$0.isEmpty }
+        .joined(separator: "/")
+        endpoint.append(components?.query?.isEmpty == false ? "?\(components!.query!)" : "")
+        return endpoint
     }
 }
 

WireLogging/Tests/WireLogging/Network/RequestLogTests.swift

@@ -50,6 +50,24 @@ class RequestLogTests: XCTestCase {
         )
     }
 
+    func testParsingEndpointWithSearchContactsRedactedQueryParams() throws {
+        let request =
+            NSURLRequest(
+                url: URL(
+                    string: "https://prod-nginz-https.wire.com/v13/search/contacts?q=test&size=10"
+                )!
+            )
+        guard let sut: RequestLog = .init(request) else {
+            XCTFail("could not create RequestLog")
+            return
+        }
+
+        XCTAssertEqual(
+            sut.endpoint,
+            "https://prod-nginz-https.wire.com/v13/search/contacts?q=***&size=10"
+        )
+    }
+
     func testAuthorizationHeaderValueIsRedacted() throws {
         let request = NSMutableURLRequest(url: URL(string: "https://prod-nginz-https.wire.com/push/tokens")!)
         request.addValue("Bearer wertrtetetr42343242432456789p", forHTTPHeaderField: "Authorization")