mock httpClient work

Author: fengmk2

package.json

@@ -40,15 +40,12 @@
     "globby": "^11.1.0",
     "is-type-of": "^2.2.0",
     "merge-descriptors": "^2.0.0",
-    "methods": "^1.1.2",
     "mm": "^4.0.1",
     "sdk-base": "^5.0.0",
     "utility": "^2.3.0"
   },
   "peerDependencies": {
-    "egg": "beta",
-    "mocha": "^10.2.0",
-    "urllib": "^4"
+    "mocha": "^10.2.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",

src/app/extend/application.ts

@@ -5,6 +5,7 @@ import assert from 'node:assert';
 import mergeDescriptors from 'merge-descriptors';
 import { isAsyncFunction, isObject } from 'is-type-of';
 import { mock, restore } from 'mm';
+import type { HttpClient } from 'urllib';
 import { Transport, Logger, LoggerLevel, LoggerMeta } from 'egg-logger';
 import { EggCore, EggCoreOptions, ContextDelegation } from '@eggjs/core';
 import { getMockAgent, restoreMockAgent } from '../../lib/mock_agent.js';
@@ -47,6 +48,8 @@ export default abstract class ApplicationUnittest extends EggCore {
   _mockHttpClient: MockHttpClientMethod;
   declare logger: Logger;
   abstract getLogger(name: string): Logger;
+  declare httpClient: HttpClient;
+  declare httpclient: HttpClient;
 
   /**
    * mock Context

src/lib/mock_agent.ts

@@ -6,38 +6,52 @@ import {
 
 const debug = debuglog('@eggjs/mock/lib/mock_agent');
 
-let _mockAgent: MockAgent | null = null;
-let _global: Dispatcher;
-const httpClientDispatchers = new Map<HttpClient, Dispatcher>();
+declare namespace globalThis {
+  let __mockAgent: MockAgent | null;
+  let __globalDispatcher: Dispatcher;
+  let __httpClientDispatchers: Map<HttpClient, Dispatcher>;
+}
+
+globalThis.__mockAgent = null;
+globalThis.__httpClientDispatchers = new Map<HttpClient, Dispatcher>();
 
-export function getMockAgent(app?: { httpclient?: HttpClient }) {
-  if (!_global) {
-    _global = getGlobalDispatcher();
+export function getMockAgent(app?: { httpClient?: HttpClient }) {
+  debug('getMockAgent');
+  if (!globalThis.__globalDispatcher) {
+    globalThis.__globalDispatcher = getGlobalDispatcher();
+    debug('create global dispatcher');
   }
-  if (app?.httpclient && !httpClientDispatchers.has(app.httpclient)) {
-    httpClientDispatchers.set(app.httpclient, app.httpclient.getDispatcher());
-    debug('add new httpClient, size: %d', httpClientDispatchers.size);
+  if (app?.httpClient && !globalThis.__httpClientDispatchers.has(app.httpClient)) {
+    globalThis.__httpClientDispatchers.set(app.httpClient, app.httpClient.getDispatcher());
+    debug('add new httpClient, size: %d', globalThis.__httpClientDispatchers.size);
   }
-  if (!_mockAgent) {
-    _mockAgent = new MockAgent();
-    setGlobalDispatcher(_mockAgent);
-    if (typeof app?.httpclient?.setDispatcher === 'function') {
-      app.httpclient.setDispatcher(_mockAgent);
+  if (!globalThis.__mockAgent) {
+    globalThis.__mockAgent = new MockAgent();
+    setGlobalDispatcher(globalThis.__mockAgent);
+    if (typeof app?.httpClient?.setDispatcher === 'function') {
+      app.httpClient.setDispatcher(globalThis.__mockAgent);
     }
+    debug('create new mockAgent');
   }
-  return _mockAgent;
+  return globalThis.__mockAgent;
 }
 
 export async function restoreMockAgent() {
-  if (!_mockAgent) return;
-  if (_global) {
-    setGlobalDispatcher(_global);
+  debug('restoreMockAgent start');
+  if (globalThis.__globalDispatcher) {
+    setGlobalDispatcher(globalThis.__globalDispatcher);
+    debug('restore global dispatcher');
   }
-  for (const [ httpClient, dispatcher ] of httpClientDispatchers) {
+  debug('restore httpClient, size: %d', globalThis.__httpClientDispatchers.size);
+  for (const [ httpClient, dispatcher ] of globalThis.__httpClientDispatchers) {
     httpClient.setDispatcher(dispatcher);
   }
-  debug('restore httpClient, size: %d', httpClientDispatchers.size);
-  const agent = _mockAgent;
-  _mockAgent = null;
-  await agent.close();
+  globalThis.__httpClientDispatchers.clear();
+  if (globalThis.__mockAgent) {
+    const agent = globalThis.__mockAgent;
+    globalThis.__mockAgent = null;
+    await agent.close();
+    debug('close mockAgent');
+  }
+  debug('restoreMockAgent end');
 }

src/lib/mock_httpclient.ts

@@ -1,5 +1,6 @@
 import { mm } from 'mm';
 import { extend } from 'extend2';
+import type { Dispatcher, Headers, BodyInit } from 'urllib';
 import { getMockAgent } from './mock_agent.js';
 
 export interface MockResultOptions {
@@ -26,7 +27,17 @@ export interface MockResultOptions {
   repeats?: number;
 }
 
-export type MockResultFunction = (url: string, options: any) => MockResultOptions;
+export interface MockResponseCallbackOptions {
+  path: string;
+  method: string;
+  headers?: Headers | Record<string, string>;
+  origin?: string;
+  body?: BodyInit | Dispatcher.DispatchOptions['body'] | null;
+  maxRedirections?: number;
+}
+
+export type MockResultFunction =
+  (url: string, options: MockResponseCallbackOptions) => MockResultOptions | string;
 
 function normalizeResult(result: string | MockResultOptions) {
   if (typeof result === 'string') {

src/lib/restore.ts

@@ -1,10 +1,14 @@
+import { debuglog } from 'node:util';
 import { restore as mmRestore } from 'mm';
 import { restoreMockAgent } from './mock_agent.js';
 import { restore as clusterRestore } from './cluster.js';
 
+const debug = debuglog('@eggjs/mock/lib/restore');
+
 export async function restore() {
   // keep mm.restore execute in the current event loop
   mmRestore();
   await clusterRestore();
   await restoreMockAgent();
+  debug('restore all');
 }

test/fixtures/demo_next_h2/app/context.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   getResult(result) {
     return {

test/fixtures/demo_next_h2/app/controller/file.js

@@ -1,7 +1,5 @@
-'use strict';
-
-module.exports = function* () {
-  const stream = yield this.getFileStream();
+module.exports = async function() {
+  const stream = await this.getFileStream();
   const fields = stream.fields;
   this.body = {
     fields,

test/fixtures/demo_next_h2/app/controller/home.js

@@ -1,41 +1,39 @@
-'use strict';
-
-exports.get = function* () {
+exports.get = async function() {
   this.body = {
     cookieValue: this.getCookie('foo') || undefined,
     cookiesValue: this.cookies.get('foo') || undefined,
     sessionValue: this.session.foo,
   };
 };
 
-exports.post = function* () {
+exports.post = async function() {
   this.body = 'done';
 };
 
-exports.hello = function* () {
+exports.hello = async function() {
   this.body = 'hi';
 };
 
-exports.service = function* () {
+exports.service = async function() {
   this.body = {
-    foo1: yield this.service.foo.get(),
-    foo2: yield this.service.bar.foo.get(),
+    foo1: await this.service.foo.get(),
+    foo2: await this.service.bar.foo.get(),
     foo3: this.service.foo.getSync(),
-    thirdService: yield this.service.third.bar.foo.get(),
+    thirdService: await this.service.third.bar.foo.get(),
   };
 };
 
-exports.serviceOld = function* () {
-  this.body = yield this.service.old.test();
+exports.serviceOld = async function() {
+  this.body = await this.service.old.test();
 };
 
-exports.header = function* () {
+exports.header = async function() {
   this.body = {
     header: this.get('customheader'),
   };
 };
 
-exports.urllib = function* () {
+exports.urllib = async function() {
   const url = 'http://' + this.host;
   const method = this.query.method || 'request';
   const data = this.query.data ? JSON.parse(this.query.data) : undefined;
@@ -50,8 +48,8 @@ exports.urllib = function* () {
     data,
   });
   if (method === 'request') r = r.then(d => d);
-  const r1 = yield r;
-  const r2 = yield this.app.httpclient[method](requestUrl, {
+  const r1 = await r;
+  const r2 = await this.app.httpclient[method](requestUrl, {
     method: 'POST',
     dataType,
     data,
@@ -75,7 +73,7 @@ exports.streaming = async ctx => {
   ctx.body = response.res;
 };
 
-exports.mockUrlGet = function* () {
+exports.mockUrlGet = async function() {
   const foo = this.query.foo;
   if (foo) {
     this.body = `url get with foo: ${foo}`;
@@ -84,20 +82,20 @@ exports.mockUrlGet = function* () {
   this.body = 'url get';
 };
 
-exports.mockUrlPost = function* () {
+exports.mockUrlPost = async function() {
   this.body = 'url post';
 };
 
-exports.mockUrllibHeaders = function* () {
+exports.mockUrllibHeaders = async function() {
   const url = 'http://' + this.host;
   const method = this.query.method || 'request';
-  const res = yield this.app.httpclient[method](url + '/mock_url');
+  const res = await this.app.httpclient[method](url + '/mock_url');
   this.body = res.headers;
 };
 
-exports.dataType = function* () {
+exports.dataType = async function() {
   const url = 'http://' + this.host;
-  const res = yield this.app.httpclient.request(url + '/mock_url', {
+  const res = await this.app.httpclient.request(url + '/mock_url', {
     dataType: 'json',
   });
   this.body = res.data;

test/fixtures/demo_next_h2/app/controller/session.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = function* () {
+module.exports = async function() {
   this.session.save();
   this.body = this.session;
 };

test/fixtures/demo_next_h2/app/controller/user.js

@@ -1,10 +1,8 @@
-'use strict';
-
-exports.get = function* () {
+exports.get = async function() {
   this.body = this.user;
 };
 
-exports.post = function* () {
+exports.post = async function() {
   this.body = {
     user: this.user,
     params: this.request.body,

test/fixtures/demo_next_h2/app/extend/application.js

@@ -1,12 +1,10 @@
-'use strict';
-
 module.exports = {
   mockDevice(obj) {
     obj.mock = true;
     return obj;
   },
 
-  * mockGenerator(obj) {
+  async mockGenerator(obj) {
     obj.mock = true;
     return obj;
   },

test/fixtures/demo_next_h2/app/service/bar/foo.js

@@ -1,8 +1,6 @@
-'use strict';
-
 module.exports = function(app) {
   class Foo extends app.Service {
-    * get() {
+    async get() {
       return 'bar';
     }
   }

test/fixtures/demo_next_h2/app/service/foo.js

@@ -1,8 +1,6 @@
-'use strict';
-
 module.exports = function(app) {
   class Foo extends app.Service {
-    * get() {
+    async get() {
       return 'bar';
     }
 

test/fixtures/demo_next_h2/app/service/old.js

@@ -1,7 +1,5 @@
-'use strict';
-
 module.exports = () => {
-  exports.test = function* () {
+  exports.test = async function() {
     return 'hello';
   };
 

test/fixtures/demo_next_h2/app/service/third/bar/foo.js

@@ -1,8 +1,6 @@
-'use strict';
-
 module.exports = function(app) {
   class Main extends app.Service {
-    * get() {
+    async get() {
       return 'third';
     }
   }

test/mock_headers.test.js renamed to test/mock_headers.test.ts

@@ -1,19 +1,13 @@
-'use strict';
+import { strict as assert } from 'node:assert';
+import { request } from '@eggjs/supertest';
+import mm, { MockApplication } from '../src/index.js';
+import { getFixtures } from './helper.js';
 
-const request = require('supertest');
-const path = require('path');
-const assert = require('assert');
-const mm = require('..');
-const fixtures = path.join(__dirname, 'fixtures');
-
-describe('test/mock_headers.test.js', () => {
-
-  afterEach(mm.restore);
-
-  let app;
+describe('test/mock_headers.test.ts', () => {
+  let app: MockApplication;
   before(() => {
     app = mm.app({
-      baseDir: path.join(fixtures, 'demo'),
+      baseDir: getFixtures('demo'),
     });
     return app.ready();
   });