fix: request query params in log har object (#20)

* fix: request params in log har object

* chore: use query params instead of query string for har query params

* chore: multiple query entry in case array has value array has multiple values

Author: nsrCodes

src/components/proxy-middleware/helpers/harObectCreator.js

@@ -12,9 +12,27 @@ const createHarHeaders = (request_headers_obj) => {
   return headers;
 };
 
-const createHarQueryStrings = (path) => {
-  // TODO -> http://www.softwareishard.com/blog/har-12-spec/#queryString
-  return [];
+const createHarQueryStrings = (query_params) => {
+  let res = []
+
+  Object.keys(query_params).forEach(query => {
+    const query_value = query_params[query]
+    if(Array.isArray(query_value)) {
+      query_value.forEach(val => {
+        res.push({
+          "name" : query,
+          "value": val
+        })
+      })
+    } else {
+      res.push({
+        "name" : query,
+        "value": query_value
+      })
+    }
+  })
+
+  return res
 };
 
 const getContentType = (headers) => {
@@ -90,6 +108,7 @@ export const createRequestHarObject = (
     body,
     headers,
     agent,
+    query_params
   } = proxyToServerRequestOptions;
 
   return {
@@ -99,7 +118,7 @@ export const createRequestHarObject = (
     cookies: [], // TODO: add support for Cookies
     headers: requestHarObject.headers || createHarHeaders(headers),
     method: requestHarObject.method || method,
-    queryString: requestHarObject.queryString || createHarQueryStrings(path),
+    queryString: requestHarObject.queryString || createHarQueryStrings(query_params),
     url:
       requestHarObject.url || (agent?.protocol || "http:") + "//" + host + path,
     postData:
@@ -109,25 +128,25 @@ export const createRequestHarObject = (
 };
 
 
-export const createHar = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders) => {
+export const createHar = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams) => {
   return {
     "log": {
       "version" : "1.2",
       "creator" : {},
       "browser" : {},
       "pages": [],
-      "entries": [createHarEntry(requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders)],
+      "entries": [createHarEntry(requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams)],
       "comment": ""
     }
   };
 }
 
-export const createHarEntry = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders) => {
+export const createHarEntry = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams) => {
   return {
       // "pageref": "page_0",
       "startedDateTime": new Date().toISOString(),
       // "time": 50,
-      "request": createHarRequest(requestHeaders, method, protocol, host, path, requestBody),
+      "request": createHarRequest(requestHeaders, method, protocol, host, path, requestBody, requestParams),
       "response": createHarResponse(responseStatusCode, response, responseHeaders),
       "cache": {},
       "timings": {},
@@ -137,15 +156,15 @@ export const createHarEntry = (requestHeaders, method, protocol, host, path, req
   };
 }
 
-export const createHarRequest = (requestHeaders, method, protocol, host, path, requestBody) => {
+export const createHarRequest = (requestHeaders, method, protocol, host, path, requestBody, requestParams) => {
   return {
     bodySize: -1, // TODO: calculate the body size
     headersSize: -1, // TODO: calculate the header size
     httpVersion: "HTTP/1.1",
     cookies: [], // TODO: add support for Cookies
     headers: createHarHeaders(requestHeaders),
     method: method,
-    queryString: createHarQueryStrings(path),
+    queryString: createHarQueryStrings(requestParams),
     url:
       protocol + "://" + host + path,
     postData:

src/components/proxy-middleware/helpers/proxy_ctx_helper.js

@@ -5,6 +5,65 @@
 // } from "../../../../../../../common/components/utils/utils";
 // const CONSTANTS = require("../../../../../../../common/constants");
 
+import { 
+  CONSTANTS as GLOBAL_CONSTANTS,
+} from "@requestly/requestly-core"
+
+
+function extractUrlComponent(url, name) { // need this in proxy
+  const myUrl = new URL(url);
+
+  switch (name) {
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.URL:
+      return url;
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.PROTOCOL:
+      return myUrl.protocol;
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.HOST:
+      return myUrl.host;
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.PATH:
+      return myUrl.pathname;
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.QUERY:
+      return myUrl.search;
+    case GLOBAL_CONSTANTS.URL_COMPONENTS.HASH:
+      return myUrl.hash;
+  }
+
+  console.error("Invalid source key", url, name);
+}
+
+/**
+ *
+ * @param queryString e.g. ?a=1&b=2 or a=1 or ''
+ * @returns object { paramName -> [value1, value2] }
+ */
+export function getQueryParamsMap(queryString) {
+  var map = {},
+    queryParams;
+
+  if (!queryString || queryString === "?") {
+    return map;
+  }
+
+  if (queryString[0] === "?") {
+    queryString = queryString.substr(1);
+  }
+
+  queryParams = queryString.split("&");
+
+  queryParams.forEach(function (queryParam) {
+    var paramName = queryParam.split("=")[0],
+      paramValue = queryParam.split("=")[1];
+
+    // We are keeping value of param as array so that in future we can support multiple param values of same name
+    // And we do not want to lose the params if url already contains multiple params of same name
+    map[paramName] = map[paramName] || [];
+    map[paramName].push(paramValue);
+  });
+
+  return map;
+}
+
+
 export const get_request_url = (ctx) => {
   return (
     (ctx.isSSL ? "https://" : "http://") +
@@ -52,15 +111,15 @@ export const get_response_options = (ctx) => {
 export const get_request_options = (ctx) => {
   return {
     ...ctx.proxyToServerRequestOptions,
-    // query_params: get_json_query_params(ctx),
+    query_params: get_json_query_params(ctx),
   };
 };
 
-// export const get_json_query_params = (ctx) => {
-//   const url = get_request_url(ctx);
-//   let queryString = extractUrlComponent(url, CONSTANTS.URL_COMPONENTS.QUERY);
-//   return getQueryParamsMap(queryString) || null;
-// };
+export const get_json_query_params = (ctx) => {
+  const url = get_request_url(ctx);
+  let queryString = extractUrlComponent(url, GLOBAL_CONSTANTS.URL_COMPONENTS.QUERY);
+  return getQueryParamsMap(queryString) || null;
+};
 
 export const getRequestHeaders = (ctx) => {
   if (ctx && ctx.proxyToServerRequestOptions) {

src/components/proxy-middleware/middlewares/logger_middleware.js

@@ -86,6 +86,7 @@ class LoggerMiddleware {
         ctx.rq.final_response.status_code,
         ctx.rq.final_response.body,
         ctx.rq.final_response.headers || {},
+        ctx.rq.final_request.query_params
       ),
       requestShellCurl: this.generate_curl_from_har(ctx?.rq?.final_request?.requestHarObject), // TODO: Move this to client side
       actions: get_success_actions_from_action_results(action_result_objs),