Preserve *partially* parseable query strings too

Author: pimterry

src/index.js

@@ -216,13 +216,16 @@ HTTPSnippet.prototype.prepare = function (request) {
   // eslint-disable-next-line node/no-deprecated-api
   request.uriObj = url.parse(request.url, true, true)
 
-  // merge all possible queryString values
-  request.queryObj = Object.assign(request.queryObj, request.uriObj.query)
+  // In some cases (unparseable/partially parseable query string) we want to fully preserve the
+  // original string (as it may not follow qs conventions at all). We assume any scenario where
+  // qs cannot reproduce the original value is this case.
+  const simpleQueryString = !request.uriObj.search ||
+    (qs.stringify(request.uriObj.query) === request.uriObj.search.slice(1))
+
+  if (simpleQueryString) {
+    // merge all possible queryString values
+    request.queryObj = Object.assign(request.queryObj, request.uriObj.query)
 
-  // In some cases (unparseable query - preference to use raw in exporter) the queryString might
-  // be empty while the URL search is not. In that case, we prefer the URL search.
-  const hasQueryObj = Object.keys(request.queryObj).length > 0
-  if (hasQueryObj || !request.uriObj.search) {
     // reset uriObj values for a clean url
     request.uriObj.query = null
     request.uriObj.search = null

test/fixtures/output/c/libcurl/unparseable-query.c

@@ -1,6 +1,6 @@
 CURL *hnd = curl_easy_init();
 
 curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "http://mockbin.com/har?&&&");
+curl_easy_setopt(hnd, CURLOPT_URL, "http://mockbin.com/har?&&a=b&&");
 
 CURLcode ret = curl_easy_perform(hnd);

test/fixtures/output/clojure/clj_http/unparseable-query.clj

@@ -1,3 +1,3 @@
 (require '[clj-http.client :as client])
 
-(client/get "http://mockbin.com/har?&&&")
+(client/get "http://mockbin.com/har?&&a=b&&")

test/fixtures/output/csharp/httpclient/unparseable-query.cs

@@ -2,7 +2,7 @@
 var request = new HttpRequestMessage
 {
     Method = HttpMethod.Get,
-    RequestUri = new Uri("http://mockbin.com/har?&&&"),
+    RequestUri = new Uri("http://mockbin.com/har?&&a=b&&"),
 };
 using (var response = await client.SendAsync(request))
 {

test/fixtures/output/csharp/restsharp/unparseable-query.cs

@@ -1,3 +1,3 @@
-var client = new RestClient("http://mockbin.com/har?&&&");
+var client = new RestClient("http://mockbin.com/har?&&a=b&&");
 var request = new RestRequest(Method.GET);
 IRestResponse response = client.Execute(request);

test/fixtures/output/go/native/unparseable-query.go

@@ -8,7 +8,7 @@ import (
 
 func main() {
 
-	url := "http://mockbin.com/har?&&&"
+	url := "http://mockbin.com/har?&&a=b&&"
 
 	req, _ := http.NewRequest("GET", url, nil)
 

test/fixtures/output/http/1.1/unparseable-query

@@ -1,2 +1,2 @@
-GET /har?&&& HTTP/1.1
+GET /har?&&a=b&& HTTP/1.1
 Host: mockbin.com

test/fixtures/output/java/asynchttp/unparseable-query.java

@@ -1,5 +1,5 @@
 AsyncHttpClient client = new DefaultAsyncHttpClient();
-client.prepare("GET", "http://mockbin.com/har?&&&")
+client.prepare("GET", "http://mockbin.com/har?&&a=b&&")
   .execute()
   .toCompletableFuture()
   .thenAccept(System.out::println)

test/fixtures/output/java/nethttp/unparseable-query.java

@@ -1,5 +1,5 @@
 HttpRequest request = HttpRequest.newBuilder()
-    .uri(URI.create("http://mockbin.com/har?&&&"))
+    .uri(URI.create("http://mockbin.com/har?&&a=b&&"))
     .method("GET", HttpRequest.BodyPublishers.noBody())
     .build();
 HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

test/fixtures/output/java/okhttp/unparseable-query.java

@@ -1,7 +1,7 @@
 OkHttpClient client = new OkHttpClient();
 
 Request request = new Request.Builder()
-  .url("http://mockbin.com/har?&&&")
+  .url("http://mockbin.com/har?&&a=b&&")
   .get()
   .build();