refactor: refactor headers declaration

Author: huturen

README-CN.MD

@@ -639,7 +639,10 @@ it('should match object`', async () => {
  * @status 200
  *
  * http响应头信息，支持重复配置
- * @header content-type: application/json
+ * @headers content-type: application/json
+ *
+ * 远程mock请求头信息，只有在设置了 @remote 时才有效，允许重复设置
+ * @remoteRequestHeaders content-type: application/json
  *
  * http响应延迟，模拟网络延时，单位毫秒，默认0
  * @delay 100

README.MD

@@ -651,7 +651,7 @@ it('should match object`', async () => {
  *
  * Request headers, request headers, only available for @remote tag
  * It can be set repeatedly.
- * @requestHeaders content-type: application/json
+ * @remoteRequestHeaders content-type: application/json
  *
  * Simulate network latency in milliseconds.
  * Default: 0

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-mock",
-  "version": "1.8.28",
+  "version": "2.0.0",
   "description": "Intercept & mock http requests issued by XMLHttpRequest, fetch, nodejs https/http module, axios, jquery, superagent, ky, node-fetch, request, got or any other request libraries by intercepting XMLHttpRequest, fetch and nodejs native requests in low level.",
   "main": "src/index.js",
   "module": "http-request-mock.esm.mjs",

package.json

@@ -3,7 +3,7 @@ import InterceptorWxRequest from './interceptor/wx-request';
 import InterceptorXhr from './interceptor/xml-http-request';
 import Mocker from './mocker/mocker';
 
-export type { HttpVerb, Method, MockItemExt, MockItemInfo, RequestInfo } from './types';
+export type { HttpVerb, MockItemExt, MockItemInfo, RequestInfo } from './types';
 export { Mocker };
 
 export default class BrowserPureIndex {

src/browser.pure.ts

@@ -3,7 +3,7 @@ import faker from '../tool/plugin/faker.js';
 import BrowserPureIndex from './browser.pure';
 import Mocker from './mocker/mocker';
 
-export type { HttpVerb, Method, MockItemExt, MockItemInfo, RequestInfo } from './types';
+export type { HttpVerb, MockItemExt, MockItemInfo, RequestInfo } from './types';
 export { Mocker };
 
 /**

src/browser.ts

@@ -3,7 +3,7 @@ import { IncomingMessage } from 'http';
 import Stream from 'stream';
 import { URL } from 'url';
 import * as zlib from 'zlib';
-import { AnyObject, OriginalResponse } from './../types';
+import type { AnyObject, Headers, OriginalResponse } from '../types';
 import { str2arrayBuffer, tryToParseJson } from './utils';
 
 /**
@@ -22,7 +22,7 @@ import { str2arrayBuffer, tryToParseJson } from './utils';
 export default function request(requestConfig: {
   url: string | URL,
   method: string,
-  headers?: Record<string, string>,
+  headers?: Headers,
   body?: unknown,
   opts?: Record<string, string>
 }): Promise<{body: string, json: AnyObject, response: IncomingMessage}> {

src/common/request.ts

@@ -1,5 +1,5 @@
 
-import { Query } from '../types';
+import type { Query } from '../types';
 
 /**
  * Get query parameters from the specified request url.
@@ -87,6 +87,25 @@ export function tryToParseObject(body: unknown) {
   }
 }
 
+export function tryToParsePostBody(body: unknown): unknown {
+  if (!body) {
+    return body;
+  }
+
+  if (typeof body === 'string') {
+    const info = tryToParseObject(body);
+    if (info && typeof info === 'object') {
+      return info;
+    }
+  }
+
+  if (typeof body === 'string' && body.includes('&') && body.includes('=')) {
+    return getQuery(body);
+  }
+
+  return body;
+}
+
 /**
  * Try to parse a JSON string
  * @param {unknown} body
@@ -224,9 +243,11 @@ export function isImported(obj: unknown) {
  * Get caller file from error stack
  */
 export function getCallerFile() {
+  type SimplifiedStackInfo = { getFileName: () => string };
+
   const oldPrepareStackTrace = Error.prepareStackTrace;
   Error.prepareStackTrace = (_, stack)  => stack;
-  const stack = new Error().stack as unknown as Record<string, { getFileName: () => string }>;
+  const stack = new Error().stack as unknown as Record<string, SimplifiedStackInfo>;
   Error.prepareStackTrace = oldPrepareStackTrace;
 
 
@@ -240,3 +261,22 @@ export function getCallerFile() {
     }
   }
 }
+
+export function get<T>(obj: object, path: string | Array<string | number>, defaultValue?: unknown): T {
+  if (typeof path === 'string') {
+    path = path.replace(/\[(\w+)\]/g, '.$1');
+    path = path.split('.').filter(Boolean);
+  }
+
+  let result: unknown = obj;
+  for (const key of path as Array<string | number>) {
+    if (result && result[key as keyof typeof result] !== undefined) {
+      result = result[key as keyof typeof result];
+    } else {
+      result = undefined;
+      break;
+    }
+  }
+
+  return (result === undefined ? defaultValue : result) as T;
+}

src/common/utils.ts

@@ -4,7 +4,7 @@ import Dummy from './dummy';
 import NodeHttpAndHttps from './interceptor/node/http-and-https';
 import Mocker from './mocker/mocker-for-node';
 
-export type { HttpVerb, Method, MockItemExt, MockItemInfo, RequestInfo } from './types';
+export type { HttpVerb, MockItemExt, MockItemInfo, RequestInfo } from './types';
 export { Mocker };
 
 export default class Index extends Browser{

src/index.ts

@@ -1,4 +1,4 @@
-import { getQuery, tryToParseObject } from '../common/utils';
+import { get, getQuery, tryToParsePostBody } from '../common/utils';
 import MockItem from '../mocker/mock-item';
 import Mocker from '../mocker/mocker';
 import { HttpVerb, RequestInfo } from '../types';
@@ -73,11 +73,12 @@ export default class BaseInterceptor {
       method: requestInfo.method || 'GET',
       query: getQuery(requestInfo.url),
     };
-    if (requestInfo.headers || requestInfo.header) {
-      info.headers = requestInfo.headers || requestInfo.header;
+    if (get(requestInfo, 'headers') || get(requestInfo, 'header')) {
+      info.headers = get(requestInfo, 'headers') || get(requestInfo, 'header');
     }
     if (requestInfo.body !== undefined) {
-      info.body = tryToParseObject(requestInfo.body);
+      info.rawBody = requestInfo.body;
+      info.body = tryToParsePostBody(requestInfo.body);
     }
     return info;
   }