Sort URL query items (pointfreeco#491)

* Sort URL query items

* Update Sources/SnapshotTesting/Snapshotting/URLRequest.swift

* Update Sources/SnapshotTesting/Snapshotting/URLRequest.swift

* Update Sources/SnapshotTesting/Snapshotting/URLRequest.swift

* Update Sources/SnapshotTesting/Snapshotting/URLRequest.swift

* Sort query items for curl

Co-authored-by: Brandon Williams <[email protected]>

Author: 2 people

Sources/SnapshotTesting/Snapshotting/URLRequest.swift

@@ -12,7 +12,7 @@ extension Snapshotting where Value == URLRequest, Format == String {
   /// - Parameter pretty: Attempts to pretty print the body of the request (supports JSON).
   public static func raw(pretty: Bool) -> Snapshotting {
     return SimplySnapshotting.lines.pullback { (request: URLRequest) in
-      let method = "\(request.httpMethod ?? "GET") \(request.url?.absoluteString ?? "(null)")"
+      let method = "\(request.httpMethod ?? "GET") \(request.url?.sortingQueryItems()?.absoluteString ?? "(null)")"
 
       let headers = (request.allHTTPHeaderFields ?? [:])
         .map { key, value in "\(key): \(value)" }
@@ -76,8 +76,18 @@ extension Snapshotting where Value == URLRequest, Format == String {
     }
 
     // URL
-    components.append("\"\(request.url!.absoluteString)\"")
+    components.append("\"\(request.url!.sortingQueryItems()!.absoluteString)\"")
 
     return components.joined(separator: " \\\n\t")
   }
 }
+
+private extension URL {
+  func sortingQueryItems() -> URL? {
+    var components = URLComponents(url: self, resolvingAgainstBaseURL: false)
+    let sortedQueryItems = components?.queryItems?.sorted { $0.name < $1.name }
+    components?.queryItems = sortedQueryItems
+
+    return components?.url
+  }
+}

Tests/SnapshotTestingTests/SnapshotTestingTests.swift

@@ -968,6 +968,13 @@ final class SnapshotTestingTests: XCTestCase {
     assertSnapshot(matching: get, as: .raw, named: "get")
     assertSnapshot(matching: get, as: .curl, named: "get-curl")
 
+    var getWithQuery = URLRequest(url: URL(string: "https://www.pointfree.co?key_2=value_2&key_1=value_1&key_3=value_3")!)
+    getWithQuery.addValue("pf_session={}", forHTTPHeaderField: "Cookie")
+    getWithQuery.addValue("text/html", forHTTPHeaderField: "Accept")
+    getWithQuery.addValue("application/json", forHTTPHeaderField: "Content-Type")
+    assertSnapshot(matching: getWithQuery, as: .raw, named: "get-with-query")
+    assertSnapshot(matching: getWithQuery, as: .curl, named: "get-with-query-curl")
+
     var post = URLRequest(url: URL(string: "https://www.pointfree.co/subscribe")!)
     post.httpMethod = "POST"
     post.addValue("pf_session={\"user_id\":\"0\"}", forHTTPHeaderField: "Cookie")

Tests/SnapshotTestingTests/__Snapshots__/SnapshotTestingTests/testURLRequest.get-with-query-curl.txt

@@ -0,0 +1,5 @@
+curl \
+	--header "Accept: text/html" \
+	--header "Content-Type: application/json" \
+	--cookie "pf_session={}" \
+	"https://www.pointfree.co?key_1=value_1&key_2=value_2&key_3=value_3"

Tests/SnapshotTestingTests/__Snapshots__/SnapshotTestingTests/testURLRequest.get-with-query.txt

@@ -0,0 +1,4 @@
+GET https://www.pointfree.co?key_1=value_1&key_2=value_2&key_3=value_3
+Accept: text/html
+Content-Type: application/json
+Cookie: pf_session={}