feat: upgrade to egg v4

.github/workflows/ci.yml

@@ -3,16 +3,13 @@ name: CI
 on:
   push:
     branches: [ master ]
-
   pull_request:
     branches: [ master ]
 
-  workflow_dispatch: {}
-
 jobs:
   Job:
     name: Node.js
-    uses: artusjs/github-actions/.github/workflows/node-test.yml@master
+    uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest'
-      version: '14, 16, 18'
+      version: '20, 22'

README.md

@@ -1,16 +1,12 @@
 # Examples for [egg](https://github.com/eggjs/egg)
 
----
-
-[![build status][travis-image]][travis-url]
+[![CI](https://github.com/eggjs/examples/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/eggjs/examples/actions/workflows/ci.yml)
 [![node version][node-image]][node-url]
 [![egg version][egg-image]][egg-url]
 
-[travis-image]: https://img.shields.io/travis/eggjs/examples.svg?style=flat-square
-[travis-url]: https://travis-ci.org/eggjs/examples
-[node-image]: https://img.shields.io/badge/node.js-%3E=_8-green.svg?style=flat-square
+[node-image]: https://img.shields.io/badge/node.js-%3E=_18-green.svg?style=flat-square
 [node-url]: http://nodejs.org/download/
-[egg-image]: https://img.shields.io/badge/egg-%3E=_1-green.svg?style=flat-square
+[egg-image]: https://img.shields.io/badge/egg-%3E=_4-green.svg?style=flat-square
 [egg-url]: https://github.com/eggjs/egg
 
 ## Usage
@@ -23,7 +19,7 @@ $ npm install
 $ npm run dev
 ```
 
-**Recommend to use Node >= 8**
+**Recommend to use Node >= 18**
 
 ## List of examples
 
@@ -64,12 +60,6 @@ You can use `--verbose` to show more infomation
 $ npm test -- --verbose
 ```
 
-### Generate dependencies
-
-```bash
-$ npm run autod
-```
-
 ### Show list of examples
 
 ```bash

bin/test.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -eux -o pipefail
+
+test() {
+  echo "Test $1"
+  cd "$1"
+  pwd
+  rm -rf node_modules package-lock.json
+  npm install --registry=https://registry.npmmirror.com
+  npm run ci
+  cd ..
+}
+
+test body-parser-example
+test helloworld
+test hello-tegg

bodyParser/app/controller/home.js → body-parser-example/app/controller/home.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const Controller = require('egg').Controller;
+const { Controller } = require('egg');
 const { xml2js } = require('xml-js');
 
 class HomeController extends Controller {

bodyParser/config/config.default.js → body-parser-example/config/config.default.js

@@ -1,5 +1,3 @@
-'use strict';
-
 exports.keys = '123456';
 
 exports.bodyParser = {

bodyParser/package.json → body-parser-example/package.json

@@ -1,18 +1,18 @@
 {
-  "name": "bodyParser",
+  "name": "body-parser-example",
   "version": "1.0.0",
   "dependencies": {
-    "egg": "^2",
+    "egg": "4",
     "xml-js": "^1.6.9"
   },
   "devDependencies": {
-    "egg-bin": "^4.3.5",
-    "egg-mock": "^3.13.1"
+    "@eggjs/bin": "7",
+    "@eggjs/mock": "6"
   },
   "scripts": {
     "dev": "egg-bin dev",
     "test": "egg-bin test",
-    "cov": "egg-bin cov"
+    "ci": "egg-bin cov"
   },
   "private": true
 }

bodyParser/test/home.test.js → body-parser-example/test/home.test.js

@@ -1,9 +1,6 @@
-'use strict';
-
-const { app } = require('egg-mock/bootstrap');
-
-describe('test/app/controller/home.test.js', () => {
+const { app } = require('@eggjs/mock/bootstrap');
 
+describe('test/home.test.js', () => {
   beforeEach(() => app.mockCsrf());
 
   it('should parse form', () => {

hello-tegg/.gitignore

@@ -19,3 +19,4 @@ test/**/*.map
 config/**/*.map
 *.d.ts
 *.tsbuildinfo
+.egg/

hello-tegg/app/biz/package.json

@@ -2,5 +2,6 @@
   "name": "biz-module",
   "eggModule": {
     "name": "biz"
-  }
+  },
+  "type": "module"
 }

hello-tegg/app/controller/HelloController.ts

@@ -9,8 +9,8 @@ import {
   Inject,
 } from '@eggjs/tegg';
 import { EggLogger } from 'egg';
-import { traceMethod } from 'app/middleware/trace_method';
-import { HelloService } from 'app/biz/HelloService';
+import { traceMethod } from '../middleware/trace_method.js';
+import { HelloService } from '../biz/HelloService.js';
 
 @HTTPController()
 @Middleware(traceMethod)

hello-tegg/config/config.default.ts

@@ -1,6 +1,6 @@
-import { EggAppConfig, PowerPartial } from 'egg';
+import { EggAppInfo, EggAppConfig, PowerPartial } from 'egg';
 
-export default (appInfo: EggAppConfig) => {
+export default (appInfo: EggAppInfo) => {
   const config = {} as PowerPartial<EggAppConfig>;
 
   // override config from framework / plugin

hello-tegg/package.json

@@ -1,41 +1,46 @@
 {
   "name": "hello-tegg",
   "private": true,
+  "type": "module",
   "description": "tegg application example",
   "scripts": {
-    "start": "egg-scripts start",
-    "stop": "egg-scripts stop",
+    "start": "eggctl start --daemon",
+    "stop": "eggctl stop",
     "dev": "egg-bin dev",
-    "debug": "egg-bin debug",
-    "test-local": "egg-bin test",
-    "test": "npm run lint -- --fix && npm run test-local",
-    "cov": "egg-bin cov",
-    "tsc": "tsc -p tsconfig.json",
-    "ci": "npm run lint && npm run cov && npm run tsc",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "egg-bin test",
+    "tsc": "tsc -p tsconfig.prod.json",
+    "preci": "npm run clean && npm run lint",
+    "ci": "egg-bin cov",
+    "postci": "npm run tsc && npm run clean",
     "lint": "eslint .",
-    "clean": "tsc -b --clean"
+    "clean": "tsc -b --clean",
+    "prepublishOnly": "npm run clean && tsc"
   },
   "egg": {
     "typescript": true
   },
   "license": "MIT",
   "dependencies": {
-    "@eggjs/tegg": "^3.2.1",
-    "@eggjs/tegg-controller-plugin": "^3.2.1",
-    "@eggjs/tegg-plugin": "^3.2.1",
-    "@eggjs/tsconfig": "^1.2.0",
-    "@eggjs/tegg-config": "^3.1.0",
-    "egg": "^3.9.1",
-    "egg-scripts": "^2.17.0"
+    "@eggjs/scripts": "^4.0.0",
+    "@eggjs/tegg": "^4.0.0-beta.2",
+    "@eggjs/tegg-config": "^4.0.0-beta.2",
+    "@eggjs/tegg-controller-plugin": "^4.0.0-beta.2",
+    "@eggjs/tegg-plugin": "^4.0.0-beta.2",
+    "egg": "^4.0.10"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^16.18.10",
-    "egg-bin": "^6.0.0",
-    "egg-mock": "^5.4.0",
-    "eslint": "^8.30.0",
-    "eslint-config-egg": "^12.1.0",
-    "typescript": "^4.9.4"
+    "@types/mocha": "10",
+    "@types/node": "22",
+    "@eggjs/tsconfig": "2",
+    "@eggjs/bin": "7",
+    "@eggjs/mock": "6",
+    "eslint": "8",
+    "eslint-config-egg": "14",
+    "typescript": "5"
   },
-  "repository": "[email protected]:eggjs/examples.git"
+  "repository": "[email protected]:eggjs/examples.git",
+  "engines": {
+    "node": ">=20.0.0"
+  }
 }

hello-tegg/test/biz/HelloService.test.ts

@@ -1,23 +1,16 @@
-import { Context } from 'egg';
-import assert from 'assert';
-import { app } from 'egg-mock/bootstrap';
-import { HelloService } from '../../app/biz/HelloService';
+import assert from 'node:assert/strict';
+import { app } from '@eggjs/mock/bootstrap';
+import { HelloService } from '../../app/biz/HelloService.js';
 
 describe('test/biz/HelloService.test.ts', () => {
-  let ctx: Context;
   let helloService: HelloService;
 
-  beforeEach(async () => {
-    ctx = await app.mockModuleContext();
-    helloService = await ctx.getEggObject(HelloService);
-  });
-
-  afterEach(async () => {
-    await app.destroyModuleContext(ctx);
+  before(async () => {
+    helloService = await app.getEggObject(HelloService);
   });
 
   it('should work', async () => {
     const msg = await helloService.hello('killa');
-    assert(msg === 'hello, killa');
+    assert.equal(msg, 'hello, killa');
   });
 });

hello-tegg/test/controller/HelloController.test.ts

@@ -1,18 +1,16 @@
-import { app } from 'egg-mock/bootstrap';
-import assert from 'assert';
+import assert from 'node:assert/strict';
+import { app } from '@eggjs/mock/bootstrap';
 
 describe('test/controller/HelloController.test.ts', () => {
   it('should work', async () => {
-    await app.httpRequest()
+    const res = await app.httpRequest()
       .get('/hello?name=killa')
-      .expect(200)
-      .expect(res => {
-        assert.deepStrictEqual(res.body, {
-          success: true,
-          data: {
-            message: 'hello, killa (GET)',
-          },
-        });
-      });
+      .expect(200);
+    assert.deepEqual(res.body, {
+      success: true,
+      data: {
+        message: 'hello, killa (GET)',
+      },
+    });
   });
 });

hello-tegg/tsconfig.json

@@ -1,6 +1,8 @@
 {
   "extends": "@eggjs/tsconfig",
   "compilerOptions": {
-    "baseUrl": "./"
-  }
+    "baseUrl": ".",
+    "declaration": false
+  },
+  "exclude": []
 }

hello-tegg/tsconfig.prod.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@eggjs/tsconfig",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declaration": false
+  },
+  "exclude": []
+}

helloworld/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "eslint-config-egg/typescript",
+    "eslint-config-egg/lib/rules/enforce-node-prefix"
+  ]
+}

helloworld/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+*.js

helloworld/app/controller/foo.ts

@@ -0,0 +1,11 @@
+import { Controller } from 'egg';
+
+export default class FooController extends Controller {
+  async render() {
+    const ctx = this.ctx;
+    ctx.status = 400;
+    ctx.body = {
+      foo: 'bar',
+    };
+  }
+}

helloworld/app/controller/home.ts

@@ -0,0 +1,8 @@
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  async render() {
+    const ctx = this.ctx;
+    ctx.body = 'Hello World';
+  }
+}