db 마이그레이션 기능 (#17)

db 마이그레이션 기능 추가

Reviewed-on: #17

packages/dbtype/src/api.ts

@@ -53,6 +53,12 @@ export const UserSchema = z.object({
 
 export type User = z.infer<typeof UserSchema>;
 
+export const UserSettingSchema = z.object({
+	fileDeepLinkRegex: z.string().optional(),
+});
+
+export type UserSetting = z.infer<typeof UserSettingSchema>;
+
 export const SchemaMigrationSchema = z.object({
 	version: z.string().nullable(),
 	dirty: z.boolean(),

packages/dbtype/src/types.ts

@@ -45,6 +45,11 @@ export interface Users {
   username: string | null;
 }
 
+export interface UserSettings {
+  username: string;
+  settings: string | null;
+}
+
 export interface DB {
   doc_tag_relation: DocTagRelation;
   document: Document;
@@ -52,4 +57,5 @@ export interface DB {
   schema_migration: SchemaMigration;
   tags: Tags;
   users: Users;
+  user_settings: UserSettings;
 }

packages/server/gen_conf_schema.ts

@@ -1,50 +0,0 @@
-// import { promises } from "fs";
-// const { readdir, writeFile } = promises;
-// import { dirname, join } from "path";
-// import { createGenerator } from "ts-json-schema-generator";
-
-// async function genSchema(path: string, typename: string) {
-// 	const gen = createGenerator({
-// 		path: path,
-// 		type: typename,
-// 		tsconfig: "tsconfig.json",
-// 	});
-// 	const schema = gen.createSchema(typename);
-// 	if (schema.definitions != undefined) {
-// 		const definitions = schema.definitions;
-// 		const definition = definitions[typename];
-// 		if (typeof definition == "object") {
-// 			let property = definition.properties;
-// 			if (property) {
-// 				property["$schema"] = {
-// 					type: "string",
-// 				};
-// 			}
-// 		}
-// 	}
-// 	const text = JSON.stringify(schema);
-// 	await writeFile(join(dirname(path), `${typename}.schema.json`), text);
-// }
-// function capitalize(s: string) {
-// 	return s.charAt(0).toUpperCase() + s.slice(1);
-// }
-// async function setToALL(path: string) {
-// 	console.log(`scan ${path}`);
-// 	const direntry = await readdir(path, { withFileTypes: true });
-// 	const works = direntry
-// 		.filter((x) => x.isFile() && x.name.endsWith("Config.ts"))
-// 		.map((x) => {
-// 			const name = x.name;
-// 			const m = /(.+)\.ts/.exec(name);
-// 			if (m !== null) {
-// 				const typename = m[1];
-// 				return genSchema(join(path, typename), capitalize(typename));
-// 			}
-// 		});
-// 	await Promise.all(works);
-// 	const subdir = direntry.filter((x) => x.isDirectory()).map((x) => x.name);
-// 	for (const x of subdir) {
-// 		await setToALL(join(path, x));
-// 	}
-// }
-// setToALL("src");

packages/server/migrations/2024-12-27.ts

@@ -65,8 +65,8 @@ export async function up(db: Kysely<any>) {
     await db
         .insertInto('schema_migration')
         .values({
-            version: '0.0.1',
-            dirty: false,
+            version: '2024-12-27',
+            dirty: 0,
         })
         .execute();
 

packages/server/migrations/2025-06-26.ts

@@ -0,0 +1,18 @@
+import { Kysely, sql } from 'kysely';
+
+export async function up(db: Kysely<any>) {
+    await db.schema
+        .createTable("user_settings")
+        .addColumn("username", "varchar(256)", col => col.notNull().primaryKey())
+        .addColumn("settings", "json", col => col.notNull())
+        .addForeignKeyConstraint("user_settings_username_fk", ["username"], "users", ["username"])
+        .execute();
+
+    await db.updateTable("schema_migration")
+        .set({ version: "2025-06-26", dirty: 0 })
+        .execute();
+}
+
+export async function down(db: Kysely<any>) {
+    throw new Error('Downward migrations are not supported. Restore from backup.');
+}

packages/server/package.json

@@ -6,37 +6,37 @@
 	"type": "module",
 	"scripts": {
 		"dev": "tsx watch src/app.ts",
-		"start": "tsx src/app.ts"
+		"start": "tsx src/app.ts",
+		"migrate": "tsx tools/migration.ts"
 	},
 	"author": "",
 	"license": "ISC",
 	"dependencies": {
-		"@std/async": "npm:@jsr/std__async@^1.0.12",
-		"@zip.js/zip.js": "^2.7.60",
+		"@std/async": "npm:@jsr/std__async@^1.0.13",
+		"@zip.js/zip.js": "^2.7.62",
 		"better-sqlite3": "^9.6.0",
 		"chokidar": "^3.6.0",
 		"dbtype": "workspace:dbtype",
-		"dotenv": "^16.4.5",
-		"jose": "^5.9.3",
-		"koa": "^2.15.3",
+		"dotenv": "^16.5.0",
+		"jose": "^5.10.0",
+		"koa": "^2.16.1",
 		"koa-bodyparser": "^4.4.1",
 		"koa-compose": "^4.1.0",
 		"koa-router": "^12.0.1",
-		"kysely": "^0.27.4",
+		"kysely": "^0.27.6",
 		"natural-orderby": "^2.0.3",
 		"tiny-async-pool": "^1.3.0"
 	},
 	"devDependencies": {
-		"@types/better-sqlite3": "^7.6.11",
+		"@types/better-sqlite3": "^7.6.13",
 		"@types/jsonwebtoken": "^8.5.9",
 		"@types/koa": "^2.15.0",
 		"@types/koa-bodyparser": "^4.3.12",
 		"@types/koa-compose": "^3.2.8",
 		"@types/koa-router": "^7.4.8",
-		"@types/node": "^22.15.3",
+		"@types/node": "^22.15.33",
 		"@types/tiny-async-pool": "^1.0.5",
-		"nodemon": "^3.1.7",
-		"tsx": "^4.19.1",
-		"typescript": "^5.6.2"
+		"tsx": "^4.20.3",
+		"typescript": "^5.8.3"
 	}
 }

packages/server/preload.ts

@@ -1,7 +0,0 @@
-// import { contextBridge, ipcRenderer } from "electron";
-
-// contextBridge.exposeInMainWorld("electron", {
-// 	passwordReset: async (username: string, toPw: string) => {
-// 		return await ipcRenderer.invoke("reset_password", username, toPw);
-// 	},
-// });

packages/server/src/database.ts

@@ -1,14 +1,16 @@
 import { Kysely } from "kysely";
 import { getKysely } from "./db/kysely.ts";
+import fs from "node:fs/promises";
+import path from "path";
 
 export async function connectDB() {
 	const kysely = getKysely();
 
 	let tries = 0;
-	for (;;) {
+	for (; ;) {
 		try {
 			console.log("try to connect db");
-			await kysely.selectNoFrom(eb=> eb.val(1).as("dummy")).execute();
+			await kysely.selectNoFrom(eb => eb.val(1).as("dummy")).execute();
 			console.log("connect success");
 		} catch (err) {
 			if (tries < 3) {
@@ -25,20 +27,72 @@ export async function connectDB() {
 }
 
 async function checkTableExists(kysely: Kysely<any>, table: string) {
-	const result = await kysely.selectFrom("sqlite_master").where("type", "=", "table").where("name", "=", table).executeTakeFirst();
+	const result = await kysely.selectFrom("sqlite_master")
+		.selectAll()
+		.where("type", "=", "table")
+		.where("name", "=", table)
+		.executeTakeFirst();
 	return result !== undefined;
-} 
+}
 
 export async function migrateDB() {
 	const kysely = getKysely();
-	let version_number = 0;
 	// is schema_migration exists?
 	const hasTable = await checkTableExists(kysely, "schema_migration");
 	if (!hasTable) {
-		// migrate from 0
-		// create schema_migration
+		// 2. 마이그레이션 실행 (최초 마이그레이션)
+		const migration = await import("../migrations/2024-12-27.ts");
+		await migration.up(kysely);
+		console.log("최초 마이그레이션 완료");
+		return;
 	}
 
-	const version = await kysely.selectFrom("schema_migration").executeTakeFirst();
+	// 현재 버전 확인
+	const row = await kysely.selectFrom("schema_migration").selectAll().executeTakeFirst();
+	const currentVersion = row?.version ?? "0001-01-01"; // 기본값 설정
 
+	// 마이그레이션 목록 정의 (버전순 정렬 필수)
+	const migrations = await readMigrations();
+
+	// 현재 버전보다 높은 migration만 실행
+	let lastestVersion = currentVersion;
+	console.log(`현재 DB 버전: ${currentVersion}`);
+	for (const m of migrations) {
+		if (compareVersion(m.version, currentVersion) > 0) {
+			console.log(`마이그레이션 실행: ${m.version}`);
+			const migration = await import(m.file);
+			await migration.up(kysely);
+			await kysely.updateTable("schema_migration")
+				.set({ version: m.version, dirty: 0 })
+				.execute();
+			lastestVersion = m.version;
+			console.log(`마이그레이션 완료: ${m.version}`);
+		}
+	}
+	if (lastestVersion !== currentVersion) {
+		console.log(`마이그레이션 완료. ${currentVersion} -> ${lastestVersion}`);
+	} else {
+		console.log("마이그레이션 필요 없음");
+	}
+	return;
+}
+
+async function readMigrations(): Promise<{ version: string; file: string }[]> {
+	const migrationsDir = path.join(import.meta.dirname, "../migrations");
+	const files = (await fs.readdir(migrationsDir))
+		.filter(file => file.endsWith(".ts"))
+		.map(file => {
+			const version = file.match(/(\d{4}-\d{2}-\d{2})/)?.[0] || "0001-01-01";
+			return { version, file: `../migrations/${file}` };
+		});
+	return files.sort((a, b) => compareVersion(a.version, b.version));
+}
+
+// Date 기반 버전 비교 함수. 
+function compareVersion(a: string, b: string): number {
+	const dateA = new Date(a);
+	const dateB = new Date(b);
+	if (dateA < dateB) return -1;
+	if (dateA > dateB) return 1;
+	return 0; // 같을 경우
 }

packages/server/src/db/user.ts

@@ -1,5 +1,5 @@
 import { getKysely } from "./kysely.ts";
-import { type IUser, Password, type UserAccessor, type UserCreateInput } from "../model/user.ts";
+import { type IUser, IUserSettings, Password, type UserAccessor, type UserCreateInput } from "../model/user.ts";
 
 class SqliteUser implements IUser {
 	readonly username: string;
@@ -41,6 +41,24 @@ class SqliteUser implements IUser {
 			.executeTakeFirst();
 		return (result.numDeletedRows ?? 0n) > 0;
 	}
+	async get_settings(): Promise<IUserSettings | undefined> {
+		const settings = await this.kysely
+			.selectFrom("user_settings")
+			.select("settings")
+			.where("username", "=", this.username)
+			.executeTakeFirst();
+		if (!settings) return undefined;
+		return settings.settings ? JSON.parse(settings.settings) as IUserSettings : undefined;
+	}
+	async set_settings(settings: IUserSettings) {
+		const settingsJson = JSON.stringify(settings);
+		const result = await this.kysely
+			.insertInto("user_settings")
+			.values({ username: this.username, settings: settingsJson })
+			.onConflict((oc) => oc.doUpdateSet({ settings: settingsJson }))
+			.executeTakeFirst();
+		return (result.numInsertedOrUpdatedRows ?? 0n) > 0;
+	}
 }
 
 export const createSqliteUserController = (kysely = getKysely()): UserAccessor => {

packages/server/src/login.ts

@@ -76,7 +76,7 @@ function setToken(ctx: Koa.Context, token_name: string, token_payload: string |
 	});
 }
 
-export const createLoginMiddleware = (userController: UserAccessor) => async (ctx: Koa.Context, _next: Koa.Next) => {
+export const createLoginHandler = (userController: UserAccessor) => async (ctx: Koa.Context, _next: Koa.Next) => {
 	const setting = get_setting();
 	const secretKey = setting.jwt_secretkey;
 	const body = ctx.request.body;
@@ -115,7 +115,7 @@ export const createLoginMiddleware = (userController: UserAccessor) => async (ct
 	return;
 };
 
-export const LogoutMiddleware = (ctx: Koa.Context, next: Koa.Next) => {
+export const LogoutHandler = (ctx: Koa.Context, _next: Koa.Next) => {
 	const setting = get_setting();
 	ctx.cookies.set(accessTokenName, null);
 	ctx.cookies.set(refreshTokenName, null);
@@ -127,9 +127,9 @@ export const LogoutMiddleware = (ctx: Koa.Context, next: Koa.Next) => {
 	return;
 };
 
-export const createUserMiddleWare =
+export const createUserHandler =
 	(userController: UserAccessor) => async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
-		const refreshToken = refreshTokenHandler(userController);
+		const refreshToken = makeRefreshToken(userController);
 		const setting = get_setting();
 		const setGuest = async () => {
 			setToken(ctx, accessTokenName, null, 0);
@@ -140,7 +140,7 @@ export const createUserMiddleWare =
 		return await refreshToken(ctx, setGuest, next);
 	};
 
-const refreshTokenHandler = (cntr: UserAccessor) => async (ctx: Koa.Context, fail: Koa.Next, next: Koa.Next) => {
+const makeRefreshToken = (cntr: UserAccessor) => async (ctx: Koa.Context, fail: Koa.Next, next: Koa.Next) => {
 	const accessPayload = ctx.cookies.get(accessTokenName);
 	const setting = get_setting();
 	const secretKey = setting.jwt_secretkey;
@@ -200,7 +200,7 @@ const refreshTokenHandler = (cntr: UserAccessor) => async (ctx: Koa.Context, fai
 	}
 };
 export const createRefreshTokenMiddleware = (cntr: UserAccessor) => async (ctx: Koa.Context, next: Koa.Next) => {
-	const handler = refreshTokenHandler(cntr);
+	const handler = makeRefreshToken(cntr);
 	await handler(ctx, fail, success);
 	async function fail() {
 		const user = ctx.state.user as PayloadInfo;
@@ -242,12 +242,54 @@ export const resetPasswordMiddleware = (cntr: UserAccessor) => async (ctx: Koa.C
 	ctx.type = "json";
 };
 
+export function getUserSettingHandler(userController: UserAccessor) {
+	return async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
+		const username = ctx.state.user.username;
+		if (!username) {
+			return sendError(403, "not authorized");
+		}
+		const user = await userController.findUser(username);
+		if (user === undefined) {
+			return sendError(403, "not authorized");
+		}
+		const settings = await user.get_settings();
+		if (settings === undefined) {
+			ctx.body = {};
+			ctx.type = "json";
+			return;
+		}
+		ctx.body = settings;
+		ctx.type = "json";
+		await next();
+	};
+}
+export function setUserSettingHandler(userController: UserAccessor) {
+	return async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
+		const username = ctx.state.user.username;
+		if (!username) {
+			return sendError(403, "not authorized");
+		}
+		const user = await userController.findUser(username);
+		if (user === undefined) {
+			return sendError(403, "not authorized");
+		}
+		const body = ctx.request.body;
+		const settings = body as Record<string, unknown>;
+		await user.set_settings(settings);
+		ctx.body = { ok: true };
+		ctx.type = "json";
+		await next();
+	};
+}
+
 export function createLoginRouter(userController: UserAccessor) {
 	const router = new Router();
-	router.post("/login", createLoginMiddleware(userController));
-	router.post("/logout", LogoutMiddleware);
+	router.post("/login", createLoginHandler(userController));
+	router.post("/logout", LogoutHandler);
 	router.post("/refresh", createRefreshTokenMiddleware(userController));
 	router.post("/reset", resetPasswordMiddleware(userController));
+	router.get("/settings", getUserSettingHandler(userController));
+	router.post("/settings", setUserSettingHandler(userController));
 	return router;
 }
 

packages/server/src/model/user.ts

@@ -1,3 +1,4 @@
+import { UserSetting } from "dbtype";
 import { createHmac, randomBytes } from "node:crypto";
 
 function hashForPassword(salt: string, password: string) {
@@ -41,6 +42,8 @@ export interface UserCreateInput {
 	password: string;
 }
 
+export type IUserSettings = UserSetting;
+
 export interface IUser {
 	readonly username: string;
 	readonly password: Password;
@@ -65,6 +68,18 @@ export interface IUser {
 	 * @param password password to set
 	 */
 	reset_password(password: string): Promise<void>;
+
+	/**
+	 * get user settings
+	 * @returns user settings, or undefined if not set
+	 */
+	get_settings(): Promise<IUserSettings | undefined>;
+	/**
+	 * set user settings
+	 * @param settings user settings to set
+	 * @returns if settings updated, return true
+	 */
+	set_settings(settings: IUserSettings): Promise<boolean>;
 }
 
 export interface UserAccessor {

packages/server/src/permission/permission.ts

@@ -36,20 +36,21 @@ export enum Permission {
 
 export const createPermissionCheckMiddleware =
 	(...permissions: string[]) =>
-	async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
-		const user = ctx.state.user;
-		if (user.username === "admin") {
-			return await next();
-		}
-		const user_permission = user.permission;
-		// if permissions is not subset of user permission
-		if (!permissions.map((p) => user_permission.includes(p)).every((x) => x)) {
-			if (user.username === "") {
-				return sendError(401, "you are guest. login needed.");
-			}return sendError(403, "do not have permission");
-		}
-		await next();
-	};
+		async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
+			const user = ctx.state.user;
+			if (user.username === "admin") {
+				return await next();
+			}
+			const user_permission = user.permission;
+			// if permissions is not subset of user permission
+			if (!permissions.map((p) => user_permission.includes(p)).every((x) => x)) {
+				if (user.username === "") {
+					return sendError(401, "you are guest. login needed.");
+				} return sendError(403, "do not have permission");
+			}
+			await next();
+		};
+
 export const AdminOnlyMiddleware = async (ctx: Koa.ParameterizedContext<UserState>, next: Koa.Next) => {
 	const user = ctx.state.user;
 	if (user.username !== "admin") {

packages/server/src/server.ts

@@ -8,7 +8,7 @@ import { get_setting, SettingConfig } from "./SettingConfig.ts";
 import { createReadStream, readFileSync } from "node:fs";
 import bodyparser from "koa-bodyparser";
 import { createSqliteDocumentAccessor, createSqliteTagController, createSqliteUserController } from "./db/mod.ts";
-import { createLoginRouter, createUserMiddleWare, getAdmin, isAdminFirst } from "./login.ts";
+import { createLoginRouter, createUserHandler, getAdmin, isAdminFirst } from "./login.ts";
 import getContentRouter from "./route/contents.ts";
 import { error_handler } from "./route/error_handler.ts";
 
@@ -63,7 +63,7 @@ class ServerApplication {
 		}
 		app.use(bodyparser());
 		app.use(error_handler);
-		app.use(createUserMiddleWare(this.userController));
+		app.use(createUserHandler(this.userController));
 
 		const diff_router = createDiffRouter(this.diffManger);
 		this.diffManger.register("comic", createComicWatcher());
@@ -238,8 +238,6 @@ class ServerApplication {
 	static async createServer() {
 		const db = await connectDB();
 
-		// todo : db migration
-
 		const app = new ServerApplication({
 			userController: createSqliteUserController(db),
 			documentController: createSqliteDocumentAccessor(db),

packages/server/tools/migration.ts

@@ -0,0 +1,16 @@
+import { migrateDB } from "../src/database.ts";
+import { config } from "dotenv";
+
+config(); // Load environment variables from .env file
+
+export async function runMigration() {
+    try {
+        await migrateDB();
+        console.log("Database migration completed successfully.");
+    } catch (error) {
+        console.error("Database migration failed:", error);
+        process.exit(1);
+    }
+}
+
+await runMigration();