@requestly/requestly-proxy 1.1.19 → 1.1.21

package/dist/components/proxy-middleware/helpers/harObectCreator.d.ts

@@ -9,7 +9,7 @@ export function createRequestHarObject(requestHarObject: any, proxyToServerReque
     url: any;
     postData: any;
 };
-export function createHar(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any, responseStatusCode: any, response: any, responseHeaders: any): {
+export function createHar(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any, responseStatusCode: any, response: any, responseHeaders: any, requestParams: any): {
     log: {
         version: string;
         creator: {};
@@ -60,7 +60,7 @@ export function createHar(requestHeaders: any, method: any, protocol: any, host:
         comment: string;
     };
 };
-export function createHarEntry(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any, responseStatusCode: any, response: any, responseHeaders: any): {
+export function createHarEntry(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any, responseStatusCode: any, response: any, responseHeaders: any, requestParams: any): {
     startedDateTime: string;
     request: {
         bodySize: number;
@@ -102,7 +102,7 @@ export function createHarEntry(requestHeaders: any, method: any, protocol: any,
     timings: {};
     comment: string;
 };
-export function createHarRequest(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any): {
+export function createHarRequest(requestHeaders: any, method: any, protocol: any, host: any, path: any, requestBody: any, requestParams: any): {
     bodySize: number;
     headersSize: number;
     httpVersion: string;

package/dist/components/proxy-middleware/helpers/harObectCreator.js

@@ -14,9 +14,26 @@ 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) => {
     let contentType = null;
@@ -78,7 +95,7 @@ const createHarPostData = (body, headers) => {
 // create standard request har object: http://www.softwareishard.com/blog/har-12-spec/#request
 // URL: https://github.com/hoppscotch/hoppscotch/blob/75ab7fdb00c0129ad42d45165bd3ad0af1faca2e/packages/hoppscotch-app/helpers/new-codegen/har.ts#L26
 const createRequestHarObject = (requestHarObject, proxyToServerRequestOptions) => {
-    const { method, host, path, body, headers, agent, } = proxyToServerRequestOptions;
+    const { method, host, path, body, headers, agent, query_params } = proxyToServerRequestOptions;
     return {
         bodySize: -1,
         headersSize: -1,
@@ -86,32 +103,32 @@ const createRequestHarObject = (requestHarObject, proxyToServerRequestOptions) =
         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 === null || agent === void 0 ? void 0 : agent.protocol) || "http:") + "//" + host + path,
         postData: requestHarObject.postData ||
             createHarPostData(body, requestHarObject.headers),
     };
 };
 exports.createRequestHarObject = createRequestHarObject;
-const createHar = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders) => {
+const createHar = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams) => {
     return {
         "log": {
             "version": "1.2",
             "creator": {},
             "browser": {},
             "pages": [],
-            "entries": [(0, exports.createHarEntry)(requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders)],
+            "entries": [(0, exports.createHarEntry)(requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams)],
             "comment": ""
         }
     };
 };
 exports.createHar = createHar;
-const createHarEntry = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders) => {
+const createHarEntry = (requestHeaders, method, protocol, host, path, requestBody, responseStatusCode, response, responseHeaders, requestParams) => {
     return {
         // "pageref": "page_0",
         "startedDateTime": new Date().toISOString(),
         // "time": 50,
-        "request": (0, exports.createHarRequest)(requestHeaders, method, protocol, host, path, requestBody),
+        "request": (0, exports.createHarRequest)(requestHeaders, method, protocol, host, path, requestBody, requestParams),
         "response": (0, exports.createHarResponse)(responseStatusCode, response, responseHeaders),
         "cache": {},
         "timings": {},
@@ -121,7 +138,7 @@ const createHarEntry = (requestHeaders, method, protocol, host, path, requestBod
     };
 };
 exports.createHarEntry = createHarEntry;
-const createHarRequest = (requestHeaders, method, protocol, host, path, requestBody) => {
+const createHarRequest = (requestHeaders, method, protocol, host, path, requestBody, requestParams) => {
     return {
         bodySize: -1,
         headersSize: -1,
@@ -129,7 +146,7 @@ const createHarRequest = (requestHeaders, method, protocol, host, path, requestB
         cookies: [],
         headers: createHarHeaders(requestHeaders),
         method: method,
-        queryString: createHarQueryStrings(path),
+        queryString: createHarQueryStrings(requestParams),
         url: protocol + "://" + host + path,
         postData: createHarPostData(requestBody, createHarHeaders(requestHeaders)),
     };

package/dist/components/proxy-middleware/helpers/proxy_ctx_helper.d.ts

@@ -1,3 +1,9 @@
+/**
+ *
+ * @param queryString e.g. ?a=1&b=2 or a=1 or ''
+ * @returns object { paramName -> [value1, value2] }
+ */
+export function getQueryParamsMap(queryString: any): {};
 export function get_request_url(ctx: any): string;
 export function get_original_request_headers(ctx: any): any;
 export function get_original_response_headers(ctx: any): any;
@@ -7,6 +13,7 @@ export function get_response_options(ctx: any): {
     headers: any;
 };
 export function get_request_options(ctx: any): any;
+export function get_json_query_params(ctx: any): {};
 export function getRequestHeaders(ctx: any): any;
 export function getRequestContentTypeHeader(ctx: any): any;
 export function getResponseHeaders(ctx: any): any;

package/dist/components/proxy-middleware/helpers/proxy_ctx_helper.js

@@ -6,7 +6,50 @@
 // } from "../../../../../../../common/components/utils/utils";
 // const CONSTANTS = require("../../../../../../../common/constants");
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getResponseStatusCode = exports.getResponseContentTypeHeader = exports.getResponseHeaders = exports.getRequestContentTypeHeader = exports.getRequestHeaders = exports.get_request_options = exports.get_response_options = exports.is_request_preflight = exports.get_original_response_headers = exports.get_original_request_headers = exports.get_request_url = void 0;
+exports.getResponseStatusCode = exports.getResponseContentTypeHeader = exports.getResponseHeaders = exports.getRequestContentTypeHeader = exports.getRequestHeaders = exports.get_json_query_params = exports.get_request_options = exports.get_response_options = exports.is_request_preflight = exports.get_original_response_headers = exports.get_original_request_headers = exports.get_request_url = exports.getQueryParamsMap = void 0;
+const requestly_core_1 = require("@requestly/requestly-core");
+function extractUrlComponent(url, name) {
+    const myUrl = new URL(url);
+    switch (name) {
+        case requestly_core_1.CONSTANTS.URL_COMPONENTS.URL:
+            return url;
+        case requestly_core_1.CONSTANTS.URL_COMPONENTS.PROTOCOL:
+            return myUrl.protocol;
+        case requestly_core_1.CONSTANTS.URL_COMPONENTS.HOST:
+            return myUrl.host;
+        case requestly_core_1.CONSTANTS.URL_COMPONENTS.PATH:
+            return myUrl.pathname;
+        case requestly_core_1.CONSTANTS.URL_COMPONENTS.QUERY:
+            return myUrl.search;
+        case requestly_core_1.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] }
+ */
+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;
+}
+exports.getQueryParamsMap = getQueryParamsMap;
 const get_request_url = (ctx) => {
     return ((ctx.isSSL ? "https://" : "http://") +
         ctx.clientToProxyRequest.headers.host +
@@ -49,14 +92,15 @@ const get_response_options = (ctx) => {
 };
 exports.get_response_options = get_response_options;
 const get_request_options = (ctx) => {
-    return Object.assign({}, ctx.proxyToServerRequestOptions);
+    return Object.assign(Object.assign({}, ctx.proxyToServerRequestOptions), { query_params: (0, exports.get_json_query_params)(ctx) });
 };
 exports.get_request_options = get_request_options;
-// 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;
-// };
+const get_json_query_params = (ctx) => {
+    const url = (0, exports.get_request_url)(ctx);
+    let queryString = extractUrlComponent(url, requestly_core_1.CONSTANTS.URL_COMPONENTS.QUERY);
+    return getQueryParamsMap(queryString) || null;
+};
+exports.get_json_query_params = get_json_query_params;
 const getRequestHeaders = (ctx) => {
     if (ctx && ctx.proxyToServerRequestOptions) {
         return ctx.proxyToServerRequestOptions.headers || {};

package/dist/components/proxy-middleware/index.js

@@ -160,18 +160,11 @@ class ProxyMiddlewareManager {
                         const contentTypeHeader = (0, proxy_ctx_helper_1.getResponseContentTypeHeader)(ctx);
                         const contentType = (0, http_helpers_1.getContentType)(contentTypeHeader);
                         const parsedBody = (0, http_helpers_1.bodyParser)(contentTypeHeader, body);
+                        ctx.rq.set_original_response({ body: parsedBody });
                         ctx.rq_response_body = body;
+                        ctx.rq_parsed_response_body = parsedBody;
                         ctx.rq_response_status_code = (0, proxy_ctx_helper_1.getResponseStatusCode)(ctx);
-                        if (constants_1.RQ_INTERCEPTED_CONTENT_TYPES.includes(contentType) && parsedBody) {
-                            ctx.rq.set_original_response({ body: parsedBody });
-                            // Body and status code before any modifications
-                            ctx.rq_response_body = parsedBody;
-                            const { action_result_objs, continue_request } = yield rules_middleware.on_response_end(ctx);
-                            // ctx.rq_response_body, ctx.rq_response_status_code after modifications
-                            // TODO: @sahil to investigate why this is need
-                            // Remove some conflicting headers like content-length, if any
-                            delete (0, proxy_ctx_helper_1.getResponseHeaders)(ctx)["content-length"];
-                        }
+                        const { action_result_objs, continue_request } = yield rules_middleware.on_response_end(ctx);
                         const statusCode = ctx.rq_response_status_code || (0, proxy_ctx_helper_1.getResponseStatusCode)(ctx);
                         ctx.proxyToClientResponse.writeHead(statusCode, http_1.default.STATUS_CODES[statusCode], (0, proxy_ctx_helper_1.getResponseHeaders)(ctx));
                         ctx.proxyToClientResponse.write(ctx.rq_response_body);

package/dist/components/proxy-middleware/middlewares/logger_middleware.js

@@ -75,7 +75,7 @@ class LoggerMiddleware {
             const rqLog = {
                 id: ctx.uuid,
                 timestamp: Math.floor(Date.now() / 1000),
-                finalHar: (0, harObectCreator_1.createHar)(ctx.rq.final_request.headers, ctx.rq.final_request.method, protocol, ctx.rq.final_request.host, ctx.rq.final_request.path, ctx.rq.final_request.body, ctx.rq.final_response.status_code, ctx.rq.final_response.body, ctx.rq.final_response.headers || {}),
+                finalHar: (0, harObectCreator_1.createHar)(ctx.rq.final_request.headers, ctx.rq.final_request.method, protocol, ctx.rq.final_request.host, ctx.rq.final_request.path, ctx.rq.final_request.body, 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((_b = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.rq) === null || _a === void 0 ? void 0 : _a.final_request) === null || _b === void 0 ? void 0 : _b.requestHarObject),
                 actions: (0, utils_1.get_success_actions_from_action_results)(action_result_objs),
                 consoleLogs: (_c = ctx === null || ctx === void 0 ? void 0 : ctx.rq) === null || _c === void 0 ? void 0 : _c.consoleLogs,

package/dist/components/proxy-middleware/rule_action_processor/processors/modify_response_processor.js

@@ -20,6 +20,7 @@ const fs_1 = __importDefault(require("fs"));
 const http_helpers_1 = require("../../helpers/http_helpers");
 const capture_console_logs_1 = __importDefault(require("capture-console-logs"));
 const utils_2 = require("../../../../utils");
+const constants_1 = require("../../constants");
 const { types } = require("util");
 const process_modify_response_action = (action, ctx) => __awaiter(void 0, void 0, void 0, function* () {
     const allowed_handlers = [proxy_1.PROXY_HANDLER_TYPE.ON_REQUEST, proxy_1.PROXY_HANDLER_TYPE.ON_RESPONSE_END, proxy_1.PROXY_HANDLER_TYPE.ON_ERROR];
@@ -47,18 +48,32 @@ const process_modify_response_action = (action, ctx) => __awaiter(void 0, void 0
     }
     if (action.responseType &&
         action.responseType === requestly_core_1.CONSTANTS.RESPONSE_BODY_TYPES.CODE) {
-        yield modify_response_using_code(action, ctx);
-        return (0, utils_1.build_action_processor_response)(action, true);
+        const contentTypeHeader = (0, proxy_ctx_helper_1.getResponseContentTypeHeader)(ctx);
+        const contentType = (0, http_helpers_1.getContentType)(contentTypeHeader);
+        if (constants_1.RQ_INTERCEPTED_CONTENT_TYPES.includes(contentType) || contentType == null) {
+            yield modify_response_using_code(action, ctx);
+            delete_breaking_headers(ctx);
+            return (0, utils_1.build_action_processor_response)(action, true);
+        }
+        // Sentry not working
+        // Sentry.captureException(new Error(`Content Type ${contentType} not supported for modification in programmatic mode`));
+        console.log(`Content Type ${contentType} not supported for modification in programmatic mode`);
+        return (0, utils_1.build_action_processor_response)(action, false);
     }
     else if (action.responseType === requestly_core_1.CONSTANTS.RESPONSE_BODY_TYPES.LOCAL_FILE) {
         modify_response_using_local(action, ctx);
+        delete_breaking_headers(ctx);
         return (0, utils_1.build_action_processor_response)(action, true);
     }
     else {
         modify_response(ctx, action.response, action.statusCode);
+        delete_breaking_headers(ctx);
         return (0, utils_1.build_action_processor_response)(action, true);
     }
 });
+const delete_breaking_headers = (ctx) => {
+    delete (0, proxy_ctx_helper_1.getResponseHeaders)(ctx)['content-length'];
+};
 const modify_response = (ctx, new_resp, status_code) => {
     ctx.rq_response_body = new_resp;
     ctx.rq_response_status_code = status_code;
@@ -97,7 +112,7 @@ const modify_response_using_code = (action, ctx) => __awaiter(void 0, void 0, vo
                     ? ctx.clientToProxyRequest.method
                     : null
                 : null,
-            response: ctx === null || ctx === void 0 ? void 0 : ctx.rq_response_body,
+            response: ctx === null || ctx === void 0 ? void 0 : ctx.rq_parsed_response_body,
             url: (0, proxy_ctx_helper_1.get_request_url)(ctx),
             responseType: (_c = (_b = ctx === null || ctx === void 0 ? void 0 : ctx.serverToProxyResponse) === null || _b === void 0 ? void 0 : _b.headers) === null || _c === void 0 ? void 0 : _c["content-type"],
             requestHeaders: ctx.clientToProxyRequest.headers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@requestly/requestly-proxy",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Proxy that gives superpowers to all the Requestly clients",
   "main": "dist/index.js",
   "scripts": {