@eggjs/mock 6.0.7 → 6.1.0-beta.3

package/src/index.ts

@@ -1,112 +0,0 @@
-import mm from 'mm';
-import { mock as _mock } from 'mm';
-import { createCluster } from './lib/cluster.js';
-import { createApp } from './lib/app.js';
-// import { getMockAgent } from './lib/mock_agent.js';
-import { restore } from './lib/restore.js';
-import { setGetAppCallback } from './lib/app_handler.js';
-import ApplicationUnittest from './app/extend/application.js';
-
-export * from './lib/types.js';
-
-// egg-bin will set this flag to require files for instrument
-// if (process.env.EGG_BIN_PREREQUIRE) {
-//   require('./lib/prerequire');
-// }
-
-// inherit & extends mm
-const mock = {
-  ...mm,
-  restore,
-
-  /**
-   * Create a egg mocked application
-   * @function mm#app
-   * @param {Object} [options]
-   * - {String} baseDir - The directory of the application
-   * - {Object} plugins - Custom you plugins
-   * - {String} framework - The directory of the egg framework
-   * - {Boolean} [true] cache - Cache application based on baseDir
-   * - {Boolean} [true] coverage - Switch on process coverage, but it'll be slower
-   * - {Boolean} [true] clean - Remove $baseDir/logs
-   * @return {App} return {@link Application}
-   * @example
-   * ```js
-   * const app = mm.app();
-   * ```
-   */
-  app: createApp,
-
-  /**
-   * Create a egg mocked cluster application
-   * @function mm#cluster
-   * @see ClusterApplication
-   */
-  cluster: createCluster,
-
-  /**
-   * mock the serverEnv of Egg
-   * @member {Function} mm#env
-   * @param {String} env - contain default, test, prod, local, unittest
-   * @see https://github.com/eggjs/egg-core/blob/master/lib/loader/egg_loader.js#L78
-   */
-  env(env: string) {
-    _mock(process.env, 'EGG_MOCK_SERVER_ENV', env);
-    _mock(process.env, 'EGG_SERVER_ENV', env);
-  },
-
-  /**
-   * mock console level
-   * @param {String} level - logger level
-   */
-  consoleLevel(level: string) {
-    level = (level || '').toUpperCase();
-    _mock(process.env, 'EGG_LOG', level);
-  },
-
-  home(homePath?: string) {
-    if (homePath) {
-      _mock(process.env, 'EGG_HOME', homePath);
-    }
-  },
-
-  setGetAppCallback,
-};
-
-// import mm from '@eggjs/mock';
-const proxyMock = new Proxy(_mock, {
-  apply(target, _, args) {
-    return target(args[0], args[1], args[2]);
-  },
-  get(_target, property, receiver) {
-    // import mm from '@eggjs/mock';
-    // mm.isMocked(foo, 'bar')
-    return Reflect.get(mock, property, receiver);
-  },
-}) as unknown as ((target: any, property: PropertyKey, value?: any) => void) & typeof mock;
-
-export default proxyMock;
-
-export {
-  proxyMock as mock,
-  // alias to mm
-  proxyMock as mm,
-  ApplicationUnittest as MockApplication,
-  setGetAppCallback,
-  createApp,
-  createCluster,
-};
-
-process.setMaxListeners(100);
-
-process.once('SIGQUIT', () => {
-  process.exit(0);
-});
-
-process.once('SIGTERM', () => {
-  process.exit(0);
-});
-
-process.once('SIGINT', () => {
-  process.exit(0);
-});

package/src/lib/agent_handler.ts

@@ -1,28 +0,0 @@
-import { debuglog } from 'node:util';
-import { createAgent, MockAgent } from './parallel/agent.js';
-import { getEggOptions } from './utils.js';
-
-const debug = debuglog('@eggjs/mock/lib/agent_handler');
-
-let agent: MockAgent;
-
-export async function setupAgent() {
-  debug('setupAgent call, env.ENABLE_MOCHA_PARALLEL: %s, process.env.AUTO_AGENT: %s, agent: %s',
-    process.env.ENABLE_MOCHA_PARALLEL, process.env.AUTO_AGENT, !!agent);
-  if (agent) {
-    await agent.ready();
-    return agent;
-  }
-  if (process.env.ENABLE_MOCHA_PARALLEL && process.env.AUTO_AGENT) {
-    agent = createAgent(getEggOptions());
-    await agent.ready();
-  }
-  return agent;
-}
-
-export async function closeAgent() {
-  debug('setupAgent call, agent: %s', !!agent);
-  if (agent) {
-    await agent.close();
-  }
-}

package/src/lib/app.ts

@@ -1,314 +0,0 @@
-import { debuglog } from 'node:util';
-import { strict as assert } from 'node:assert';
-import os from 'node:os';
-import path from 'node:path';
-import { Base } from 'sdk-base';
-import { detectPort } from 'detect-port';
-import { importModule } from '@eggjs/utils';
-import { sleep, rimraf, getProperty, getSourceDirname } from './utils.js';
-import { formatOptions } from './format_options.js';
-import { context } from './context.js';
-import { setCustomLoader } from './mock_custom_loader.js';
-import { createServer } from './mock_http_server.js';
-import type { MockOptions, MockApplicationOptions } from './types.js';
-import ApplicationUnittest from '../app/extend/application.js';
-import AgentUnittest from '../app/extend/agent.js';
-
-const debug = debuglog('@eggjs/mock/lib/app');
-
-const apps = new Map<string, ApplicationUnittest>();
-const APP_INIT = Symbol('appInit');
-const MESSENGER = Symbol('messenger');
-const MOCK_APP_METHOD = [
-  'ready',
-  'closed',
-  'isClosed',
-  'close',
-  '_agent',
-  '_app',
-  'on',
-  'once',
-  'then',
-];
-
-class MockApplicationWorker extends Base {
-  _agent: AgentUnittest;
-  _app: ApplicationUnittest;
-  declare options: MockApplicationOptions;
-  baseDir: string;
-  [APP_INIT] = false;
-  _initOnListeners: Set<any[]>;
-  _initOnceListeners: Set<any[]>;
-
-  constructor(options: MockApplicationOptions) {
-    super({
-      initMethod: '_init',
-      ...options,
-    });
-    this.baseDir = options.baseDir;
-    this._initOnListeners = new Set();
-    this._initOnceListeners = new Set();
-  }
-
-  async _init() {
-    if (this.options.beforeInit) {
-      await this.options.beforeInit(this);
-      // init once
-      this.options.beforeInit = undefined;
-    }
-    if (this.options.clean !== false) {
-      const logDir = path.join(this.options.baseDir, 'logs');
-      try {
-        if (os.platform() === 'win32') {
-          await sleep(1000);
-        }
-        await rimraf(logDir);
-      } catch (err: any) {
-        console.error(`remove log dir ${logDir} failed: ${err.stack}`);
-      }
-      const runDir = path.join(this.options.baseDir, 'run');
-      try {
-        if (os.platform() === 'win32') {
-          await sleep(1000);
-        }
-        await rimraf(runDir);
-      } catch (err: any) {
-        console.error(`remove run dir ${runDir} failed: ${err.stack}`);
-      }
-    }
-
-    this.options.clusterPort = await detectPort();
-    debug('get clusterPort %s', this.options.clusterPort);
-    const egg = await importModule(this.options.framework);
-    assert(egg.Agent, `should export Agent class from framework ${this.options.framework}`);
-
-    const Agent = egg.Agent;
-    const agent = this._agent = new Agent({ ...this.options }) as AgentUnittest;
-    debug('agent instantiate');
-    await agent.ready();
-    debug('agent ready');
-
-    const ApplicationClass = bindMessenger(egg.Application, agent);
-    const app = this._app = new ApplicationClass({ ...this.options }) as unknown as ApplicationUnittest;
-
-    // https://github.com/eggjs/egg/blob/8bb7c7e7d59d6aeca4b2ed1eb580368dcb731a4d/lib/egg.js#L125
-    // egg single mode mount this at start(), so egg-mock should impel it.
-    app.agent = agent;
-    Reflect.set(agent, 'app', app);
-
-    // egg-mock plugin need to override egg context
-    Object.assign(app.context, context);
-
-    debug('app instantiate');
-    this[APP_INIT] = true;
-    debug('this[APP_INIT] = true');
-    this.#bindEvent();
-    debug('http server instantiate');
-    createServer(app);
-    await app.ready();
-    // work for config ready
-    setCustomLoader(app);
-
-    const msg = {
-      action: 'egg-ready',
-      data: this.options,
-    };
-    app.messenger.onMessage(msg);
-    agent.messenger.onMessage(msg);
-    debug('app ready');
-  }
-
-  #bindEvent() {
-    debug('bind cache events to app');
-    for (const args of this._initOnListeners) {
-      debug('on(%s), use cache and pass to app', args);
-      this._app.on(args[0], args[1]);
-      this.removeListener(args[0], args[1]);
-    }
-    for (const args of this._initOnceListeners) {
-      debug('once(%s), use cache and pass to app', args);
-      this._app.once(args[0], args[1]);
-      this.removeListener(args[0], args[1]);
-    }
-  }
-
-  on(...args: any[]) {
-    if (this[APP_INIT]) {
-      debug('on(%s), pass to app', args);
-      this._app.on(args[0], args[1]);
-    } else {
-      debug('on(%s), cache it because app has not init', args);
-      this._initOnListeners.add(args);
-      super.on(args[0], args[1]);
-    }
-    return this;
-  }
-
-  once(...args: any[]) {
-    if (this[APP_INIT]) {
-      debug('once(%s), pass to app', args);
-      this._app.once(args[0], args[1]);
-    } else {
-      debug('once(%s), cache it because app has not init', args);
-      this._initOnceListeners.add(args);
-      // maybe some edge case bug here
-      super.on(args[0], args[1]);
-    }
-    return this;
-  }
-
-  /**
-   * close app
-   */
-  async _close() {
-    const baseDir = this.baseDir;
-    if (this._app) {
-      await this._app.close();
-    } else {
-      // when app init throws an exception, must wait for app quit gracefully
-      await sleep(200);
-    }
-
-    if (this._agent) {
-      await this._agent.close();
-    }
-
-    apps.delete(baseDir);
-    debug('delete app cache %s, remain %s', baseDir, [ ...apps.keys() ]);
-
-    if (os.platform() === 'win32') {
-      await sleep(1000);
-    }
-  }
-
-  /**
-   * @deprecated please use isClosed instead, keep compatible with old version
-   */
-  get closed() {
-    return this.isClosed;
-  }
-}
-
-export function createApp(createOptions?: MockOptions): ApplicationUnittest {
-  const options = formatOptions(createOptions);
-  if (options.cache && apps.has(options.baseDir)) {
-    const app = apps.get(options.baseDir);
-    // return cache when it hasn't been killed
-    if (app && !app.isClosed) {
-      debug('use cache app %s', options.baseDir);
-      return app;
-    }
-    // delete the cache when it's closed
-    apps.delete(options.baseDir);
-  }
-
-  const appWorker = new MockApplicationWorker(options);
-  const proxyApp = new Proxy(appWorker, {
-    get(target: any, prop: string) {
-      // don't delegate properties on MockApplication
-      if (MOCK_APP_METHOD.includes(prop)) {
-        return getProperty(target, prop);
-      }
-      if (!target[APP_INIT]) {
-        throw new Error(`can't get ${prop} before ready`);
-      }
-      // it's asynchronous when agent and app are loading,
-      // so should get the properties after loader ready
-      debug('proxy handler.get %s', prop);
-      return target._app[prop];
-    },
-    set(target, prop: string, value) {
-      if (MOCK_APP_METHOD.includes(prop)) return true;
-      if (!target[APP_INIT]) throw new Error(`can't set ${prop} before ready`);
-      debug('proxy handler.set %s', prop);
-      target._app[prop] = value;
-      return true;
-    },
-    defineProperty(target, prop: string, descriptor) {
-      // can't define properties on MockApplication
-      if (MOCK_APP_METHOD.includes(prop)) return true;
-      if (!target[APP_INIT]) throw new Error(`can't defineProperty ${prop} before ready`);
-      debug('proxy handler.defineProperty %s', prop);
-      Object.defineProperty(target._app, prop, descriptor);
-      return true;
-    },
-    deleteProperty(target, prop: string) {
-      // can't delete properties on MockApplication
-      if (MOCK_APP_METHOD.includes(prop)) return true;
-      if (!target[APP_INIT]) throw new Error(`can't delete ${prop} before ready`);
-      debug('proxy handler.deleteProperty %s', prop);
-      delete target._app[prop];
-      return true;
-    },
-    getOwnPropertyDescriptor(target, prop: string) {
-      if (MOCK_APP_METHOD.includes(prop)) {
-        return Object.getOwnPropertyDescriptor(target, prop);
-      }
-      if (!target[APP_INIT]) {
-        throw new Error(`can't getOwnPropertyDescriptor ${prop} before ready`);
-      }
-      debug('proxy handler.getOwnPropertyDescriptor %s', prop);
-      return Object.getOwnPropertyDescriptor(target._app, prop);
-    },
-    getPrototypeOf(target) {
-      if (!target[APP_INIT]) {
-        throw new Error('can\'t getPrototypeOf before ready');
-      }
-      debug('proxy handler.getPrototypeOf %s');
-      return Object.getPrototypeOf(target._app);
-    },
-  });
-
-  apps.set(options.baseDir, proxyApp);
-  return proxyApp;
-}
-
-function bindMessenger(ApplicationClass: any, agent: AgentUnittest) {
-  const agentMessenger = agent.messenger;
-  return class MessengerApplication extends ApplicationClass {
-    [MESSENGER]: any;
-
-    constructor(options: any) {
-      super(options);
-
-      // enable app to send to a random agent
-      this.messenger.sendRandom = (action: string, data: unknown) => {
-        this.messenger.sendToAgent(action, data);
-      };
-      // enable agent to send to a random app
-      agentMessenger.on('egg-ready', () => {
-        agentMessenger.sendRandom = (action: string, data: unknown) => {
-          agentMessenger.sendToApp(action, data);
-          return agentMessenger;
-        };
-      });
-
-      agentMessenger.send = new Proxy(agentMessenger.send, {
-        apply: this._sendMessage.bind(this),
-      });
-    }
-    _sendMessage(_target: any, _thisArg: unknown, [ action, data, to ]: [ string, unknown | undefined, string]) {
-      const appMessenger = this.messenger;
-      setImmediate(() => {
-        if (to === 'app') {
-          appMessenger.onMessage({ action, data });
-        } else {
-          agentMessenger.onMessage({ action, data });
-        }
-      });
-    }
-    get messenger() {
-      return this[MESSENGER];
-    }
-    set messenger(m) {
-      m.send = new Proxy(m.send, {
-        apply: this._sendMessage.bind(this),
-      });
-      this[MESSENGER] = m;
-    }
-
-    get [Symbol.for('egg#eggPath')]() {
-      return path.join(getSourceDirname(), 'lib/tmp');
-    }
-  };
-}

package/src/lib/app_handler.ts

@@ -1,77 +0,0 @@
-import { debuglog } from 'node:util';
-import { createApp as createParallelApp } from './parallel/app.js';
-import { setupAgent } from './agent_handler.js';
-import { createApp } from './app.js';
-import { restore } from './restore.js';
-import { getEggOptions } from './utils.js';
-import ApplicationUnittest from '../app/extend/application.js';
-
-const debug = debuglog('@eggjs/mock/lib/app_handler');
-
-declare namespace globalThis {
-  let __eggMockAppInstance: ApplicationUnittest | null;
-}
-
-globalThis.__eggMockAppInstance = null;
-
-export function setupApp() {
-  let app = globalThis.__eggMockAppInstance!;
-  if (app) {
-    debug('return exists app');
-    return app;
-  }
-
-  const options = getEggOptions();
-  debug('env.ENABLE_MOCHA_PARALLEL: %s, process.env.AUTO_AGENT: %s',
-    process.env.ENABLE_MOCHA_PARALLEL, process.env.AUTO_AGENT);
-  if (process.env.ENABLE_MOCHA_PARALLEL && process.env.AUTO_AGENT) {
-    // setup agent first
-    app = createParallelApp({
-      ...options,
-      beforeInit: async parallelApp => {
-        const agent = await setupAgent();
-        parallelApp.options.clusterPort = agent.options.clusterPort;
-        debug('mockParallelApp beforeInit get clusterPort: %s', parallelApp.options.clusterPort);
-      },
-    });
-    debug('mockParallelApp app: %s', !!app);
-  } else {
-    app = createApp(options) as unknown as ApplicationUnittest;
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    if (typeof beforeAll === 'function') {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      // jest
-      beforeAll(() => app.ready());
-    }
-    if (typeof afterEach === 'function') {
-      // mocha and jest
-      afterEach(() => app.backgroundTasksFinished());
-      afterEach(restore);
-    }
-  }
-  globalThis.__eggMockAppInstance = app;
-  return app;
-}
-
-let getAppCallback: (suite: unknown, test?: unknown) => any;
-
-export function setGetAppCallback(cb: (suite: unknown, test?: unknown) => any) {
-  getAppCallback = cb;
-}
-
-export async function getApp(suite?: unknown, test?: unknown) {
-  if (getAppCallback) {
-    return getAppCallback(suite, test);
-  }
-  const app = globalThis.__eggMockAppInstance!;
-  if (app) {
-    await app.ready();
-  }
-  return app;
-}
-
-export function getBootstrapApp() {
-  return globalThis.__eggMockAppInstance!;
-}