@milkio/template-milkio 1.3.59 → 1.3.63
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/template/app/bootstrap/drizzle/index.ts +38 -0
- package/template/app/contexts/common.context.ts +9 -0
- package/template/app/modules/index.action.test.ts +5 -0
- package/template/app/modules/user/$databases/user.table.ts +24 -0
- package/template/app/utils/astra.ts +22 -8
- package/template/app/utils/drizzle-test.ts +80 -0
- package/template/app/utils/redis-test.ts +17 -0
- package/template/index.ts +2 -1
- package/template/package.json +9 -1
package/package.json
CHANGED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import mysql from 'mysql2/promise';
|
|
2
|
+
import { drizzle } from 'drizzle-orm/mysql2';
|
|
3
|
+
import { getTestDatabaseId, withTestDatabase } from '@milkio/drizzle';
|
|
4
|
+
import * as schema from '../../../.milkio/drizzle-schema.ts';
|
|
5
|
+
import type { MilkioWorld } from 'milkio';
|
|
6
|
+
import type { generated } from '../../../.milkio/index.ts';
|
|
7
|
+
|
|
8
|
+
// 数据库连接池按「连接 URL」懒建,测试环境下每个随机库一个连接。
|
|
9
|
+
// 这是样板代码,你可以按项目需要自由修改(换 pg/sqlite、加 SQL 日志、调连接数等)。
|
|
10
|
+
const pools = new Map<string, mysql.Pool | mysql.Connection>();
|
|
11
|
+
|
|
12
|
+
export function loadDrizzle(world: MilkioWorld<typeof generated>) {
|
|
13
|
+
world.on('milkio:executeBefore', async (event) => {
|
|
14
|
+
const baseUrl = world.config.drizzle.url;
|
|
15
|
+
|
|
16
|
+
// 测试模式下,astra 会携带 x-milkio-test-db 请求头指明本次请求的随机数据库;
|
|
17
|
+
// 没有携带时(本地网页调试 / 生产环境)走默认库,行为与旧版完全一致。
|
|
18
|
+
const databaseId = getTestDatabaseId(event.context.headers);
|
|
19
|
+
const url = withTestDatabase(baseUrl, databaseId);
|
|
20
|
+
|
|
21
|
+
let pool = pools.get(url);
|
|
22
|
+
if (!pool) {
|
|
23
|
+
if (world.isTestMode) {
|
|
24
|
+
// 本地 test 库会话时区非 UTC:用单连接并显式固定 UTC+0,
|
|
25
|
+
// 保证 seed 写入的墙钟与读取口径统一。
|
|
26
|
+
const connection = await mysql.createConnection({ uri: url, timezone: '+00:00' });
|
|
27
|
+
await connection.query("SET time_zone = '+00:00'");
|
|
28
|
+
pool = connection;
|
|
29
|
+
} else {
|
|
30
|
+
pool = mysql.createPool({ uri: url, connectionLimit: 8 });
|
|
31
|
+
}
|
|
32
|
+
pools.set(url, pool);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// 只挂 context.db(不挂全局 tx)。事务请在业务代码里用 db.transaction 显式管理。
|
|
36
|
+
event.context.db = drizzle(pool, { schema, mode: 'default' });
|
|
37
|
+
});
|
|
38
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { MySql2Database } from 'drizzle-orm/mysql2';
|
|
2
|
+
import type * as schema from '../../.milkio/drizzle-schema.ts';
|
|
3
|
+
|
|
4
|
+
// 项目自定义的 context 挂载点。这里只挂 db,不挂全局 tx:
|
|
5
|
+
// 事务应通过 `context.db.transaction(async (tx) => { ... })` 由调用方显式传递 tx 对象。
|
|
6
|
+
// 如需切换到 pg / sqlite,请把类型换成对应的 drizzle 数据库类型并安装相应驱动。
|
|
7
|
+
export interface _ {
|
|
8
|
+
db: MySql2Database<typeof schema>;
|
|
9
|
+
}
|
|
@@ -3,6 +3,11 @@ import { astra } from '../utils/astra.ts';
|
|
|
3
3
|
|
|
4
4
|
test('basic', async () => {
|
|
5
5
|
const [context, reject, world] = await astra.createMirrorWorld(import.meta.url);
|
|
6
|
+
|
|
7
|
+
// 每次显式调用都会新建一个随机测试库、完整迁移并 seed,然后切换过去。
|
|
8
|
+
// 如果你的项目不使用数据库,可以删除这一行。
|
|
9
|
+
await world.cleanDatabase();
|
|
10
|
+
|
|
6
11
|
const [error, result] = await world.execute('/', {
|
|
7
12
|
generateParams: true,
|
|
8
13
|
});
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { relations, sql } from 'drizzle-orm';
|
|
2
|
+
import { char, datetime, mysqlTable, varchar } from 'drizzle-orm/mysql-core';
|
|
3
|
+
|
|
4
|
+
// 示例表:可按需修改或删除。
|
|
5
|
+
const tableName = 'user';
|
|
6
|
+
|
|
7
|
+
export const userTable = mysqlTable(
|
|
8
|
+
tableName,
|
|
9
|
+
{
|
|
10
|
+
// 主键 ID,24 位随机字符串
|
|
11
|
+
id: char({ length: 24 }).notNull().primaryKey(),
|
|
12
|
+
// 名称
|
|
13
|
+
name: varchar({ length: 32 }).notNull(),
|
|
14
|
+
// 创建时间
|
|
15
|
+
createdAt: datetime({ fsp: 3 }).notNull().default(sql`CURRENT_TIMESTAMP(3)`),
|
|
16
|
+
// 更新时间
|
|
17
|
+
updatedAt: datetime({ fsp: 3 }).notNull().default(sql`CURRENT_TIMESTAMP(3) ON UPDATE CURRENT_TIMESTAMP(3)`),
|
|
18
|
+
},
|
|
19
|
+
() => [],
|
|
20
|
+
);
|
|
21
|
+
|
|
22
|
+
export const userRelations = relations(userTable, () => ({}));
|
|
23
|
+
|
|
24
|
+
export type User = typeof userTable.$inferSelect;
|
|
@@ -1,14 +1,28 @@
|
|
|
1
|
-
import { createAstra } from
|
|
2
|
-
import { createStargate } from
|
|
3
|
-
import type { generated } from
|
|
1
|
+
import { createAstra } from '@milkio/astra';
|
|
2
|
+
import { createStargate } from '@milkio/stargate';
|
|
3
|
+
import type { generated } from '../../.milkio/index.ts';
|
|
4
|
+
import { drizzleCleanHook, dropAllTestDatabases } from './drizzle-test.ts';
|
|
5
|
+
import { redisCleanHook } from './redis-test.ts';
|
|
4
6
|
|
|
5
7
|
export const stargate = await createStargate<typeof generated>({
|
|
6
|
-
|
|
8
|
+
baseUrl: 'http://localhost:9000',
|
|
7
9
|
});
|
|
8
10
|
|
|
9
11
|
export const astra = await createAstra({
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
stargate,
|
|
13
|
+
bootstrap: async (hooks) => {
|
|
14
|
+
// 每次运行测试前,先删掉上一次遗留的全部随机测试库。
|
|
15
|
+
// 如果你的项目不使用数据库,可以删除下面这两行。
|
|
16
|
+
await dropAllTestDatabases('mysql://root:a58423c29020@127.0.0.1:3306/');
|
|
17
|
+
|
|
18
|
+
// 订阅 cleanDatabase 钩子:world.cleanDatabase() 每次都会新建一个随机库并切换,
|
|
19
|
+
// 然后并行执行这里注册的所有 hook(建库+迁移+seed、清 redis 等)。
|
|
20
|
+
hooks.onCleanDatabase(drizzleCleanHook({
|
|
21
|
+
baseUrl: () => 'mysql://root:a58423c29020@127.0.0.1:3306/',
|
|
22
|
+
migrationsFolder: './drizzle',
|
|
23
|
+
}));
|
|
24
|
+
hooks.onCleanDatabase(redisCleanHook({ url: () => 'redis://127.0.0.1:6379/1' }));
|
|
25
|
+
|
|
26
|
+
return {};
|
|
27
|
+
},
|
|
14
28
|
});
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { drizzle } from 'drizzle-orm/mysql2';
|
|
2
|
+
import { migrate } from 'drizzle-orm/mysql2/migrator';
|
|
3
|
+
import mysql from 'mysql2/promise';
|
|
4
|
+
import { sql } from 'drizzle-orm';
|
|
5
|
+
import { TEST_DATABASE_PREFIX, withTestDatabase } from '@milkio/drizzle';
|
|
6
|
+
import type { CleanDatabaseHook } from '@milkio/astra';
|
|
7
|
+
import * as schema from '../../.milkio/drizzle-schema.ts';
|
|
8
|
+
import { executeSeed } from '../../.milkio/seed.ts';
|
|
9
|
+
|
|
10
|
+
// 本文件是「测试数据库基建」样板代码:建库、完整迁移、seed、清库、删库都在这里,
|
|
11
|
+
// 全部由你掌控,可按项目实际方言(mysql/pg/sqlite)自由修改。
|
|
12
|
+
|
|
13
|
+
/** 建一个 admin 连接(不带库名),用于 CREATE / DROP DATABASE。 */
|
|
14
|
+
async function createAdminConnection(baseUrl: string) {
|
|
15
|
+
const url = new URL(baseUrl);
|
|
16
|
+
url.pathname = '/';
|
|
17
|
+
return mysql.createConnection({ uri: url.toString() });
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/** 删除上一次测试遗留的所有随机测试库。 */
|
|
21
|
+
export async function dropAllTestDatabases(baseUrl: string) {
|
|
22
|
+
const admin = await createAdminConnection(baseUrl);
|
|
23
|
+
try {
|
|
24
|
+
const [rows] = await admin.query(`SHOW DATABASES LIKE '${TEST_DATABASE_PREFIX}_%'`);
|
|
25
|
+
for (const row of rows as Array<Record<string, string>>) {
|
|
26
|
+
const name = Object.values(row)[0];
|
|
27
|
+
await admin.query(`DROP DATABASE IF EXISTS \`${name}\``);
|
|
28
|
+
}
|
|
29
|
+
} finally {
|
|
30
|
+
await admin.end();
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** 创建数据库(IF NOT EXISTS)。 */
|
|
35
|
+
export async function ensureDatabase(baseUrl: string, databaseId: string) {
|
|
36
|
+
const admin = await createAdminConnection(baseUrl);
|
|
37
|
+
try {
|
|
38
|
+
await admin.query(`CREATE DATABASE IF NOT EXISTS \`${databaseId}\``);
|
|
39
|
+
} finally {
|
|
40
|
+
await admin.end();
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** 清空指定库中的所有业务表(跳过 drizzle 迁移表)。 */
|
|
45
|
+
async function truncateAll(db: any) {
|
|
46
|
+
const tables = (await db.execute(sql`SELECT table_name FROM information_schema.tables WHERE table_schema = DATABASE();`))[0] as unknown as Array<any>;
|
|
47
|
+
await db.execute(sql`SET FOREIGN_KEY_CHECKS = 0;`);
|
|
48
|
+
for (const table of tables) {
|
|
49
|
+
if (!table.TABLE_NAME.startsWith('__drizzle_migrations')) {
|
|
50
|
+
await db.execute(sql.raw(`TRUNCATE TABLE \`${table.TABLE_NAME}\`;`));
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
await db.execute(sql`SET FOREIGN_KEY_CHECKS = 1;`);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* astra 的 cleanDatabase 钩子:每次显式调用 world.cleanDatabase() 都会
|
|
58
|
+
* 生成一个全新随机库并切换到这里。该钩子负责建库、完整迁移、seed。
|
|
59
|
+
* 这是样板实现,你可以按需修改(换方言、跳过 seed、控制迁移目录等)。
|
|
60
|
+
*/
|
|
61
|
+
export function drizzleCleanHook(options: {
|
|
62
|
+
baseUrl: () => string | Promise<string>;
|
|
63
|
+
migrationsFolder: string;
|
|
64
|
+
}): CleanDatabaseHook {
|
|
65
|
+
return async ({ databaseId }) => {
|
|
66
|
+
const baseUrl = await options.baseUrl();
|
|
67
|
+
await ensureDatabase(baseUrl, databaseId);
|
|
68
|
+
|
|
69
|
+
const url = withTestDatabase(baseUrl, databaseId);
|
|
70
|
+
const connection = await mysql.createConnection({ uri: url, timezone: '+00:00' });
|
|
71
|
+
await connection.query("SET time_zone = '+00:00'");
|
|
72
|
+
const db = drizzle(connection, { schema, mode: 'default' });
|
|
73
|
+
|
|
74
|
+
await migrate(db, { migrationsFolder: options.migrationsFolder });
|
|
75
|
+
await truncateAll(db);
|
|
76
|
+
await db.transaction(async (tx) => executeSeed({ db: tx }));
|
|
77
|
+
|
|
78
|
+
await connection.end();
|
|
79
|
+
};
|
|
80
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { createClient } from 'redis';
|
|
2
|
+
import type { CleanDatabaseHook } from '@milkio/astra';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* astra 的 cleanDatabase 钩子(Redis):清空缓存。
|
|
6
|
+
* 这是样板实现,你可以按需修改(例如只删指定前缀的 key,而不是 flushDb)。
|
|
7
|
+
*/
|
|
8
|
+
export function redisCleanHook(options: { url: () => string | Promise<string> }): CleanDatabaseHook {
|
|
9
|
+
return async () => {
|
|
10
|
+
const url = await options.url();
|
|
11
|
+
const client = createClient({ url });
|
|
12
|
+
client.on('error', (err) => console.error('Redis Client Error', err));
|
|
13
|
+
await client.connect();
|
|
14
|
+
await client.flushDb();
|
|
15
|
+
await client.close();
|
|
16
|
+
};
|
|
17
|
+
}
|
package/template/index.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { createWorld, type MilkioInit } from "milkio";
|
|
2
2
|
import { configSchema } from "./.milkio/config-schema.ts";
|
|
3
3
|
import { generated } from "./.milkio/index.ts";
|
|
4
|
+
import { loadDrizzle } from "./app/bootstrap/drizzle/index.ts";
|
|
4
5
|
|
|
5
6
|
export async function create(options: MilkioInit) {
|
|
6
7
|
const world = await createWorld(generated, configSchema, {
|
|
7
8
|
...options,
|
|
8
|
-
bootstraps: [],
|
|
9
|
+
bootstraps: [loadDrizzle],
|
|
9
10
|
});
|
|
10
11
|
|
|
11
12
|
return world;
|
package/template/package.json
CHANGED
|
@@ -8,6 +8,14 @@
|
|
|
8
8
|
"build": "vite build"
|
|
9
9
|
},
|
|
10
10
|
"trustedDependencies": [],
|
|
11
|
-
"dependencies": {
|
|
11
|
+
"dependencies": {
|
|
12
|
+
"@milkio/astra": "1.3.63",
|
|
13
|
+
"@milkio/drizzle": "1.3.63",
|
|
14
|
+
"@milkio/redis": "1.3.63",
|
|
15
|
+
"@milkio/stargate": "1.3.63",
|
|
16
|
+
"drizzle-orm": "^0.43.1",
|
|
17
|
+
"mysql2": "^3.11.0",
|
|
18
|
+
"redis": "^4.7.0"
|
|
19
|
+
},
|
|
12
20
|
"devDependencies": {}
|
|
13
21
|
}
|