feat: use @eggjs/rds instead of ali-rds (#32)

fengmk2 · web-flow · commit 30935285268b · 2025-03-08T23:07:33.000+08:00
BREAKING CHANGE: drop Node.js < 18 support BREAKING CHANGE: use mysql2 instead of mysql closes #31  ## Summary by CodeRabbit - **Documentation** - Updated usage instructions and contributor displays with corrected typographical errors. - **Chores** - Removed outdated contributor templates and automation workflows. - **Dependencies** - Migrated to a new database client package and raised the minimum Node.js version requirement. - **Tests** - Refined error validations in database operations for improved error reporting.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -3,16 +3,15 @@ name: CI
 on:
   push:
     branches: [ master ]
-
   pull_request:
     branches: [ master ]
 
-  workflow_dispatch: {}
-
 jobs:
   Job:
     name: Node.js
-    uses: fengmk2/github-actions/.github/workflows/node-test-mysql.yml@master
+    uses: node-modules/github-actions/.github/workflows/node-test-mysql.yml@master
     with:
       os: 'ubuntu-latest'
-      version: '16, 18'
+      version: '16, 18, 20, 22'
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,14 +4,10 @@ on:
   push:
     branches: [ master ]
 
-  workflow_dispatch: {}
-
 jobs:
   release:
     name: Node.js
-    uses: artusjs/github-actions/.github/workflows/node-release.yml@v1
+    uses: eggjs/github-actions/.github/workflows/node-release.yml@master
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
-    with:
-      checkTest: false
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 [download-image]: https://img.shields.io/npm/dm/egg-mysql.svg?style=flat-square
 [download-url]: https://npmjs.org/package/egg-mysql
 
-Aliyun rds client(support mysql portocal) for egg framework
+Aliyun rds client(support mysql protocol) for egg framework
 
 ## Install
 
@@ -22,7 +22,7 @@ npm i egg-mysql --save
 
 MySQL Plugin for egg, support egg application access to MySQL database.
 
-This plugin based on [ali-rds](https://github.com/ali-sdk/ali-rds), if you want to know specific usage, you should refer to the document of [ali-rds](https://github.com/ali-sdk/ali-rds).
+This plugin based on [@eggjs/rds], if you want to know specific usage, you should refer to the document of [@eggjs/rds].
 
 ## Configuration
 
@@ -225,7 +225,7 @@ await app.mysql.insert(table, {
 
 #### Custom literal
 
-The following demo showed how to call `CONCAT(s1, ...sn)` funtion in mysql to do string splicing.
+The following demo showed how to call `CONCAT(s1, ...sn)` function in mysql to do string splicing.
 
 ```ts
 const Literal = app.mysql.literals.Literal;
@@ -247,14 +247,10 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 [MIT](LICENSE)
 
-<!-- GITCONTRIBUTOR_START -->
-
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/893152?v=4" width="100px;"/><br/><sub><b>jtyjty99999</b></sub>](https://github.com/jtyjty99999)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-[<img src="https://avatars.githubusercontent.com/u/6587734?v=4" width="100px;"/><br/><sub><b>AntiMoron</b></sub>](https://github.com/AntiMoron)<br/>|[<img src="https://avatars.githubusercontent.com/u/7298095?v=4" width="100px;"/><br/><sub><b>guoshencheng</b></sub>](https://github.com/guoshencheng)<br/>|[<img src="https://avatars.githubusercontent.com/u/37185773?v=4" width="100px;"/><br/><sub><b>Krryxa</b></sub>](https://github.com/Krryxa)<br/>|[<img src="https://avatars.githubusercontent.com/u/7459652?v=4" width="100px;"/><br/><sub><b>cnwangjie</b></sub>](https://github.com/cnwangjie)<br/>|[<img src="https://avatars.githubusercontent.com/u/613990?v=4" width="100px;"/><br/><sub><b>starandtina</b></sub>](https://github.com/starandtina)<br/>|[<img src="https://avatars.githubusercontent.com/u/5218468?v=4" width="100px;"/><br/><sub><b>shangwenhe</b></sub>](https://github.com/shangwenhe)<br/>
+[![Contributors](https://contrib.rocks/image?repo=eggjs/core)](https://github.com/eggjs/core/graphs/contributors)
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Mar 06 2023 21:57:18 GMT+0800`.
+Made with [contributors-img](https://contrib.rocks).
 
-<!-- GITCONTRIBUTOR_END -->
+[@eggjs/rds]: https://github.com/node-modules/rds
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -14,7 +14,7 @@
 
 MySQL 插件是为 egg 提供 MySQL 数据库访问的功能
 
-此插件基于 [ali-rds] 实现一个简单的配置封装，具体使用方法你还需要阅读 [ali-rds] 的文档。
+此插件基于 [@eggjs/rds] 实现一个简单的配置封装，具体使用方法你还需要阅读 [@eggjs/rds] 的文档。
 
 ## 安装
 
@@ -119,7 +119,7 @@ await client2.query(sql, values);
 
 #### app.mysql
 
-如果开启了 `config.mysql.app = true`，则会在 app 上注入 [ali-rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
+如果开启了 `config.mysql.app = true`，则会在 app 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
 
 ```ts
 await app.mysql.query(sql);
@@ -130,7 +130,7 @@ await app.mysqls.get('db1').query(sql);
 
 #### agent.mysql
 
-如果开启了 `config.mysql.agent = true`，则会在 agent 上注入 [ali-rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
+如果开启了 `config.mysql.agent = true`，则会在 agent 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
 
 ```ts
 await agent.mysql.query(sql);
@@ -270,16 +270,10 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 [MIT](LICENSE)
 
-[ali-rds]: https://github.com/ali-sdk/ali-rds
-
-<!-- GITCONTRIBUTOR_START -->
-
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/893152?v=4" width="100px;"/><br/><sub><b>jtyjty99999</b></sub>](https://github.com/jtyjty99999)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-[<img src="https://avatars.githubusercontent.com/u/6587734?v=4" width="100px;"/><br/><sub><b>AntiMoron</b></sub>](https://github.com/AntiMoron)<br/>|[<img src="https://avatars.githubusercontent.com/u/7298095?v=4" width="100px;"/><br/><sub><b>guoshencheng</b></sub>](https://github.com/guoshencheng)<br/>|[<img src="https://avatars.githubusercontent.com/u/37185773?v=4" width="100px;"/><br/><sub><b>Krryxa</b></sub>](https://github.com/Krryxa)<br/>|[<img src="https://avatars.githubusercontent.com/u/7459652?v=4" width="100px;"/><br/><sub><b>cnwangjie</b></sub>](https://github.com/cnwangjie)<br/>|[<img src="https://avatars.githubusercontent.com/u/613990?v=4" width="100px;"/><br/><sub><b>starandtina</b></sub>](https://github.com/starandtina)<br/>|[<img src="https://avatars.githubusercontent.com/u/5218468?v=4" width="100px;"/><br/><sub><b>shangwenhe</b></sub>](https://github.com/shangwenhe)<br/>
+[![Contributors](https://contrib.rocks/image?repo=eggjs/core)](https://github.com/eggjs/core/graphs/contributors)
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Mar 06 2023 21:57:18 GMT+0800`.
+Made with [contributors-img](https://contrib.rocks).
 
-<!-- GITCONTRIBUTOR_END -->
+[@eggjs/rds]: https://github.com/node-modules/rds
diff --git a/index.d.ts b/index.d.ts
@@ -1,4 +1,4 @@
-import type { RDSClient } from 'ali-rds';
+import type { RDSClient } from '@eggjs/rds';
 
 type EggMySQL = RDSClient;
 
diff --git a/lib/mysql.ts b/lib/mysql.ts
@@ -1,5 +1,5 @@
 import type { Application, Agent } from 'egg';
-import { RDSClient } from 'ali-rds';
+import { RDSClient } from '@eggjs/rds';
 
 let count = 0;
 function createOneClient(config: Record<string, any>, app: Application | Agent) {
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "database"
   ],
   "dependencies": {
-    "ali-rds": "^6.4.0"
+    "@eggjs/rds": "^1.2.1"
   },
   "devDependencies": {
     "@eggjs/tsconfig": "^1.3.2",
@@ -31,15 +31,13 @@
     "egg-mock": "^5.10.6",
     "eslint": "^8.16.0",
     "eslint-config-egg": "^12.1.0",
-    "git-contributor": "^2.0.0",
     "tsd": "^0.26.0",
     "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "scripts": {
-    "contributor": "git-contributor",
     "tsd": "tsd",
     "test": "npm run lint -- --fix && npm run test-local",
     "test-local": "egg-bin test",
diff --git a/test/mysql.test.ts b/test/mysql.test.ts
@@ -95,8 +95,10 @@ describe('test/mysql.test.ts', () => {
     assert(user);
     assert(typeof user.user_id === 'string' && user.user_id);
 
-    const row = await app.mysql.get('npm_auth', { password: new app.mysql.literals.Literal('is not NULL') });
-    assert(row.id === user.id);
+    // breaking change on mysql2
+    // SELECT * FROM `npm_auth` WHERE `password` = is not NULL LIMIT 0, 1
+    // const row = await app.mysql.get('npm_auth', { password: new app.mysql.literals.Literal('is not NULL') });
+    // assert(row.id === user.id);
   });
 
   it('should query one not exists return null', async () => {
@@ -118,8 +120,13 @@ describe('test/mysql.test.ts', () => {
     });
     await assert.rejects(async () => {
       await app.ready();
-    }, (err: Error) => {
-      assert.match(err.message, /ER_ACCESS_DENIED_ERROR/);
+    }, (err: any) => {
+      assert.match(err.message, /Access denied for user/);
+      assert.equal(err.code, 'ER_ACCESS_DENIED_ERROR');
+      assert.equal(err.errno, 1045);
+      assert.equal(err.sqlState, '28000');
+      assert.match(err.sqlMessage, /^Access denied for user 'root'@'[^\']+' \(using password: YES\)$/);
+      assert.equal(err.name, 'RDSClientGetConnectionError');
       return true;
     });
   });

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { RDSClient } from 'ali-rds';`
	`1`	`+import type { RDSClient } from '@eggjs/rds';`
`2`	`2`
`3`	`3`	`type EggMySQL = RDSClient;`
`4`	`4`