fix: auto set mocha @eggjs/mock/register on application project type (#…

…281)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Added support for automatically registering `@eggjs/mock/register` in
test environments
- Introduced ESM (ECMAScript Module) test fixture for enhanced testing
capabilities

- **Bug Fixes**
	- Refined test file handling for changed files
	- Updated dependency versions for compatibility

- **Documentation**
- Added new test cases to verify mock registration in CommonJS and ESM
environments

- **Chores**
- Updated `.gitignore` to allow tracking specific `node_modules`
directory
	- Updated package dependencies and peer dependencies

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

.gitignore

@@ -18,6 +18,7 @@ test/fixtures/ts/node_modules/aliyun-egg/
 !test/fixtures/example-ts-simple/node_modules/
 !test/fixtures/test-files/node_modules/
 !test/fixtures/test-demo-app/node_modules/
+!test/fixtures/test-demo-app-esm/node_modules/
 
 .mochawesome-reports
 run

package.json

@@ -18,7 +18,7 @@
     "node": ">= 18.19.0"
   },
   "dependencies": {
-    "@eggjs/utils": "^4.1.2",
+    "@eggjs/utils": "^4.2.0",
     "@oclif/core": "^4.2.0",
     "@types/mocha": "^10.0.10",
     "@types/supertest": "^6.0.2",
@@ -35,7 +35,7 @@
     "utility": "^2.4.0"
   },
   "peerDependencies": {
-    "@eggjs/mock": "beta"
+    "@eggjs/mock": "6"
   },
   "peerDependenciesMeta": {
     "@eggjs/mock": {
@@ -44,7 +44,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
-    "@eggjs/mock": "beta",
+    "@eggjs/mock": "6",
     "@eggjs/tsconfig": "1",
     "@swc-node/register": "^1.6.1",
     "@swc/core": "^1.3.35",

src/commands/test.ts

@@ -4,7 +4,7 @@ import os from 'node:os';
 import fs from 'node:fs/promises';
 import { Args, Flags } from '@oclif/core';
 import globby from 'globby';
-import { importResolve } from '@eggjs/utils';
+import { importResolve, detectType, EggType } from '@eggjs/utils';
 import { getChangedFilesForRoots } from 'jest-changed-files';
 import { BaseCommand } from '../baseCommand.js';
 
@@ -115,15 +115,19 @@ export default class Test<T extends typeof Test> extends BaseCommand<T> {
     const { args, flags } = this;
     // collect require
     const requires = await this.formatRequires();
-    // try {
-    //   const eggMockRegister = importResolve('@eggjs/mock/register', { paths: [ this.base ] });
-    //   requires.push(eggMockRegister);
-    //   debug('auto register @eggjs/mock/register: %o', eggMockRegister);
-    // } catch (err) {
-    //   // ignore @eggjs/mock not exists
-    //   debug('auto register @eggjs/mock fail, can not require @eggjs/mock on %o, error: %s',
-    //     this.base, (err as Error).message);
-    // }
+    const eggType = await detectType(flags.base);
+    debug('eggType: %s', eggType);
+    if (eggType === EggType.application) {
+      try {
+        const eggMockRegister = importResolve('@eggjs/mock/register', { paths: [ flags.base ] });
+        requires.push(eggMockRegister);
+        debug('auto register @eggjs/mock/register: %o', eggMockRegister);
+      } catch (err: any) {
+        // ignore @eggjs/mock not exists
+        debug('auto register @eggjs/mock fail, can not require @eggjs/mock on %o, error: %s',
+          flags.base, err.message);
+      }
+    }
 
     // handle mochawesome enable
     let reporter = this.env.TEST_REPORTER;

test/commands/test.test.ts

@@ -20,6 +20,30 @@ describe('test/commands/test.test.ts', () => {
         .end();
     });
 
+    it('should work on auto require @eggjs/mock/register on CommonJS', () => {
+      if (process.platform === 'win32') return;
+      return coffee.fork(eggBin, [ 'test' ], {
+        cwd: getFixtures('test-demo-app'),
+      })
+        .debug()
+        .expect('stdout', /should work/)
+        .expect('stdout', /a\.test\.js/)
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should work on auto require @eggjs/mock/register on ESM', () => {
+      if (process.platform === 'win32') return;
+      return coffee.fork(eggBin, [ 'test' ], {
+        cwd: getFixtures('test-demo-app-esm'),
+      })
+        .debug()
+        .expect('stdout', /should work/)
+        .expect('stdout', /a\.test\.js/)
+        .expect('code', 0)
+        .end();
+    });
+
     it('should success when no changed files', () => {
       return coffee.fork(eggBin, [ 'test', '-c' ], { cwd })
         // .debug()

test/fixtures/test-demo-app-esm/app/router.js

@@ -0,0 +1,8 @@
+export default app => {
+  app.get('/', async function() {
+    this.body = {
+      fooPlugin: app.fooPlugin,
+      foo: 'bar',
+    };
+  });
+};

test/fixtures/test-demo-app-esm/config/config.default.js

@@ -0,0 +1,3 @@
+export default {
+  keys: '123',
+};

test/fixtures/test-demo-app-esm/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "demo-app-esm",
+  "type": "module"
+}

test/fixtures/test-demo-app-esm/test/a.test.js

@@ -0,0 +1,10 @@
+import { app } from '@eggjs/mock/bootstrap';
+
+describe('a.test.js', () => {
+  it('should work', async () => {
+    await app.httpRequest()
+      .get('/')
+      .expect(200)
+      .expect({ foo: 'bar' });
+  });
+});

test/fixtures/test-demo-app/app/router.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = function(app) {
   app.get('/', async function() {
     this.body = {

test/fixtures/test-demo-app/test/a.test.js

@@ -2,7 +2,6 @@ const { app } = require('@eggjs/mock/bootstrap');
 
 describe('a.test.js', () => {
   it('should work', async () => {
-    await app.ready();
     await app.httpRequest()
       .get('/')
       .expect(200)