sonamu 0.5.7 → 0.7.0

package/src/database/base-model.types.ts

@@ -0,0 +1,155 @@
+/**
+ * BaseModel 타입 시스템
+ *
+ * BaseModelClass에서 사용하는 타입 유틸리티들.
+ * Enhancer, SubsetQuery 교집합 등 Model 계층에서 필요한 타입 정의.
+ */
+
+import type { DatabaseSchemaExtend } from "../types/types";
+import type { Puri } from "./puri";
+import type { PuriSubsetFn } from "./puri-subset.types";
+
+// ============================================================================
+// Puri 테이블 추출 유틸리티
+// ============================================================================
+
+/**
+ * Puri 인스턴스에서 TTables 타입 추출
+ */
+export type ExtractPuriTables<T> = T extends Puri<any, infer TTables, any> ? TTables : never;
+
+/**
+ * SubsetQueries에서 모든 TTables의 유니온 추출
+ * getSubsetQueries의 qb 타입 정의에 사용
+ */
+export type UnionExtractedTTables<
+  TSubsetKey extends string,
+  TSubsetQueries extends Record<TSubsetKey, PuriSubsetFn>,
+> = ExtractPuriTables<ReturnType<TSubsetQueries[TSubsetKey]>>;
+
+// ============================================================================
+// Subset 교집합 계산 (onSubset 메서드용)
+// ============================================================================
+
+/**
+ * 두 Puri의 테이블 교집합을 가진 새로운 Puri 생성
+ */
+type MergePuriTables<A, B, TA = ExtractPuriTables<A>, TB = ExtractPuriTables<B>> = Puri<
+  DatabaseSchemaExtend,
+  Pick<TA, Extract<keyof TA, keyof TB>>,
+  any
+>;
+
+/**
+ * 서브셋 키 배열을 순회하며 테이블 교집합 Puri 계산
+ *
+ * onSubset(['A', 'P'])와 같이 여러 subset을 지정했을 때,
+ * 공통으로 사용 가능한 테이블만 포함된 Puri 타입 반환
+ */
+export type ResolveSubsetIntersection<
+  Keys extends readonly string[],
+  Queries extends Record<string, (...args: any) => any>,
+> = Keys extends [infer Head extends string, ...infer Tail extends string[]]
+  ? Tail extends []
+    ? ReturnType<Queries[Head]>
+    : MergePuriTables<ReturnType<Queries[Head]>, ResolveSubsetIntersection<Tail, Queries>>
+  : never;
+
+// ============================================================================
+// Enhancer
+// ============================================================================
+
+/**
+ * 단일 Enhancer 함수 타입
+ * computed 결과를 받아 최종 mapping 타입으로 변환
+ */
+export type EnhancerFn<TComputed, TMapping> = (row: TComputed) => TMapping | Promise<TMapping>;
+
+/**
+ * Enhancer가 필수인 SubsetKey 추출
+ *
+ * ComputedResults[K]가 SubsetMapping[K]에 할당 불가능하면 해당 K는 필수
+ * (즉, virtual 필드 등 추가 변환이 필요한 경우)
+ */
+export type RequiredEnhancerKeys<
+  TSubsetKey extends string,
+  TComputedResults extends Record<TSubsetKey, any>,
+  TSubsetMapping extends Record<TSubsetKey, any>,
+> = {
+  [K in TSubsetKey]: TComputedResults[K] extends TSubsetMapping[K] ? never : K;
+}[TSubsetKey];
+
+/**
+ * Enhancer 객체 타입 정의
+ *
+ * - ComputedResults[K]가 SubsetMapping[K]에 assignable하면 → enhancer 선택적
+ * - 그렇지 않으면 → enhancer 필수
+ *
+ * @example
+ * // virtual 필드 employee_count가 있는 경우
+ * type Computed = { id: number; name: string }
+ * type Mapping = { id: number; name: string; employee_count: number }
+ * // → Enhancer 필수 (employee_count 계산 필요)
+ */
+export type EnhancerMap<
+  TSubsetKey extends string,
+  TComputedResults extends Record<TSubsetKey, any>,
+  TSubsetMapping extends Record<TSubsetKey, any>,
+> = {
+  // Computed가 Mapping에 호환되면 선택적
+  [K in TSubsetKey as TComputedResults[K] extends TSubsetMapping[K] ? K : never]?: EnhancerFn<
+    TComputedResults[K],
+    TSubsetMapping[K]
+  >;
+} & {
+  // 호환되지 않으면 필수
+  [K in TSubsetKey as TComputedResults[K] extends TSubsetMapping[K] ? never : K]: EnhancerFn<
+    TComputedResults[K],
+    TSubsetMapping[K]
+  >;
+};
+
+// ============================================================================
+// executeSubsetQuery
+// ============================================================================
+
+/**
+ * executeSubsetQuery 기본 파라미터
+ */
+export type ExecuteSubsetQueryBaseParams<TSubsetKey extends string> = {
+  subset: TSubsetKey;
+  qb: Puri<any, any, any>;
+  params: {
+    num?: number;
+    page?: number;
+    queryMode?: "list" | "count" | "both";
+  };
+  debug?: boolean;
+  optimizeCountQuery?: boolean;
+};
+
+/**
+ * executeSubsetQuery 파라미터 (Enhancer 포함)
+ *
+ * RequiredEnhancerKeys가 없으면 enhancers 선택적, 있으면 필수
+ */
+export type ExecuteSubsetQueryParams<
+  TSubsetKey extends string,
+  TComputedResults extends Record<TSubsetKey, any>,
+  TSubsetMapping extends Record<TSubsetKey, any>,
+  T extends TSubsetKey,
+> = ExecuteSubsetQueryBaseParams<T> &
+  ([RequiredEnhancerKeys<TSubsetKey, TComputedResults, TSubsetMapping>] extends [never]
+    ? { enhancers?: EnhancerMap<TSubsetKey, TComputedResults, TSubsetMapping> }
+    : { enhancers: EnhancerMap<TSubsetKey, TComputedResults, TSubsetMapping> });
+
+/**
+ * executeSubsetQuery 반환 타입
+ */
+export type ExecuteSubsetQueryResult<
+  TSubsetMapping extends Record<string, any>,
+  T extends string,
+> = {
+  rows: TSubsetMapping[T][];
+  total: number;
+};

package/src/database/code-generator.ts

@@ -1,12 +1,10 @@
-import _ from "lodash";
 import equal from "fast-deep-equal";
-import { MigrationColumn, MigrationIndex } from "../types/types";
+import { diff } from "radashi";
+import type { MigrationColumn, MigrationIndex } from "../types/types";
+import { differenceWith, intersectionBy } from "../utils/utils";
 
 export class CodeGenerator {
-  getAlterColumnsTo(
-    entityColumns: MigrationColumn[],
-    dbColumns: MigrationColumn[]
-  ) {
+  getAlterColumnsTo(entityColumns: MigrationColumn[], dbColumns: MigrationColumn[]) {
     const columnsTo = {
       add: [] as MigrationColumn[],
       drop: [] as MigrationColumn[],
@@ -15,8 +13,8 @@ export class CodeGenerator {
 
     // 컬럼명 기준 비교
     const extraColumns = {
-      db: _.differenceBy(dbColumns, entityColumns, (col) => col.name),
-      entity: _.differenceBy(entityColumns, dbColumns, (col) => col.name),
+      db: diff(dbColumns, entityColumns, (col) => col.name),
+      entity: diff(entityColumns, dbColumns, (col) => col.name),
     };
     if (extraColumns.entity.length > 0) {
       columnsTo.add = columnsTo.add.concat(extraColumns.entity);
@@ -26,39 +24,22 @@ export class CodeGenerator {
     }
 
     // 동일 컬럼명의 세부 필드 비교
-    const sameDbColumns = _.intersectionBy(
-      dbColumns,
-      entityColumns,
-      (col) => col.name
-    );
-    const sameMdColumns = _.intersectionBy(
-      entityColumns,
-      dbColumns,
-      (col) => col.name
-    );
-    columnsTo.alter = _.differenceWith(sameDbColumns, sameMdColumns, (a, b) =>
-      equal(a, b)
-    );
+    const sameDbColumns = intersectionBy(dbColumns, entityColumns, (col) => col.name);
+    const sameMdColumns = intersectionBy(entityColumns, dbColumns, (col) => col.name);
+    columnsTo.alter = differenceWith(sameDbColumns, sameMdColumns, (a, b) => equal(a, b));
 
     return columnsTo;
   }
 
-  getAlterIndexesTo(
-    entityIndexes: MigrationIndex[],
-    dbIndexes: MigrationIndex[]
-  ) {
+  getAlterIndexesTo(entityIndexes: MigrationIndex[], dbIndexes: MigrationIndex[]) {
     // 인덱스 비교
-    let indexesTo = {
+    const indexesTo = {
       add: [] as MigrationIndex[],
       drop: [] as MigrationIndex[],
     };
     const extraIndexes = {
-      db: _.differenceBy(dbIndexes, entityIndexes, (col) =>
-        [col.type, col.columns.join("-")].join("//")
-      ),
-      entity: _.differenceBy(entityIndexes, dbIndexes, (col) =>
-        [col.type, col.columns.join("-")].join("//")
-      ),
+      db: diff(dbIndexes, entityIndexes, (col) => [col.type, col.columns.join("-")].join("//")),
+      entity: diff(entityIndexes, dbIndexes, (col) => [col.type, col.columns.join("-")].join("//")),
     };
     if (extraIndexes.entity.length > 0) {
       indexesTo.add = indexesTo.add.concat(extraIndexes.entity);

package/src/database/db.ts

@@ -1,44 +1,22 @@
-export type DBPreset = "w" | "r";
-import knex, { Knex } from "knex";
-import path from "path";
-import _ from "lodash";
-import { Sonamu } from "../api";
-import { ServiceUnavailableException } from "../exceptions/so-exceptions";
 import { AsyncLocalStorage } from "async_hooks";
+import knex, { type Knex } from "knex";
+import { assign } from "radashi";
+import { Sonamu } from "../api";
+import type { DatabaseConfig, SonamuConfig } from "../api/config";
 import { TransactionContext } from "./transaction-context";
 
-type MySQLConfig = Omit<Knex.Config, "connection"> & {
-  connection?: Knex.MySql2ConnectionConfig;
-};
-
-export type SonamuDBBaseConfig = {
-  // 기본 데이터베이스 이름
-  database: string;
-
-  // 모든 환경에 적용될 기본 Knex 옵션
-  defaultOptions?: MySQLConfig;
-
-  // 환경별 설정
-  environments?: {
-    development?: MySQLConfig;
-    development_slave?: MySQLConfig;
-    production?: MySQLConfig;
-    production_slave?: MySQLConfig;
-    remote_fixture?: MySQLConfig;
-  };
-};
+export type DBPreset = "w" | "r";
 
 export type SonamuDBConfig = {
   development_master: Knex.Config;
   development_slave: Knex.Config;
   test: Knex.Config;
-  fixture_local: Knex.Config;
   fixture_remote: Knex.Config;
   production_master: Knex.Config;
   production_slave: Knex.Config;
 };
 
-class DBClass {
+export class DBClass {
   private wdb?: Knex;
   private rdb?: Knex;
 
@@ -52,25 +30,6 @@ class DBClass {
     return this.transactionStorage.getStore() ?? new TransactionContext();
   }
 
-  async readKnexfile(): Promise<SonamuDBConfig> {
-    const dbConfigPath: string = path.join(
-      Sonamu.apiRootPath,
-      "/dist/configs/db.js"
-    );
-    try {
-      const knexfileModule = await import(dbConfigPath);
-      const config =
-        knexfileModule.default?.default ??
-        knexfileModule.default ??
-        knexfileModule;
-      return this.generateDBConfig(config);
-    } catch {}
-
-    throw new ServiceUnavailableException(
-      `다음 경로에서 DB설정 파일을 찾을 수 없습니다: ${dbConfigPath}. 먼저 빌드(yarn build)를 수행해주세요.`
-    );
-  }
-
   getDB(which: DBPreset): Knex {
     const dbConfig = Sonamu.dbConfig;
 
@@ -81,15 +40,15 @@ class DBClass {
       } else if (this.wdb) {
         return this.wdb;
       } else {
-        this["wdb"] = knex({
-          ...dbConfig["test"],
+        this.wdb = knex({
+          ...dbConfig.test,
           // 단일 풀
           pool: {
             min: 1,
             max: 1,
           },
         });
-        return this["wdb"];
+        return this.wdb;
       }
     }
 
@@ -102,25 +61,22 @@ class DBClass {
         case "staging":
           config =
             which === "w"
-              ? dbConfig["development_master"]
-              : (dbConfig["development_slave"] ??
-                dbConfig["development_master"]);
+              ? dbConfig.development_master
+              : (dbConfig.development_slave ?? dbConfig.development_master);
           break;
         case "production":
           config =
             which === "w"
-              ? dbConfig["production_master"]
-              : (dbConfig["production_slave"] ?? dbConfig["production_master"]);
+              ? dbConfig.production_master
+              : (dbConfig.production_slave ?? dbConfig.production_master);
           break;
         default:
-          throw new Error(
-            `현재 ENV ${process.env.NODE_ENV}에는 설정 가능한 DB설정이 없습니다.`
-          );
+          throw new Error(`현재 ENV ${process.env.NODE_ENV}에는 설정 가능한 DB설정이 없습니다.`);
       }
       this[instanceName] = knex(config);
     }
 
-    return this[instanceName]!;
+    return this[instanceName];
   }
 
   async destroy(): Promise<void> {
@@ -134,37 +90,29 @@ class DBClass {
     }
   }
 
-  private generateDBConfig(config: SonamuDBBaseConfig): SonamuDBConfig {
-    const defaultKnexConfig: Partial<MySQLConfig> = _.merge(
+  public generateDBConfig(config: SonamuConfig["database"]): SonamuDBConfig {
+    const defaultKnexConfig: Partial<DatabaseConfig> = assign(
       {
-        client: "mysql2",
+        client: "pg",
         pool: {
           min: 1,
           max: 5,
         },
         migrations: {
-          extension: "js",
-          directory: "./dist/migrations",
+          directory: "./src/migrations",
         },
         connection: {
-          database: config.database,
+          database: config.name,
           ...config.defaultOptions?.connection,
         },
       },
-      config.defaultOptions
+      config.defaultOptions,
     );
 
     // 로컬 환경 설정
-    const test: MySQLConfig = _.merge({}, defaultKnexConfig, {
-      connection: {
-        database: `${config.database}_test`,
-        ...config.defaultOptions?.connection,
-      },
-    });
-
-    const fixture_local = _.merge({}, defaultKnexConfig, {
+    const test: DatabaseConfig = assign(defaultKnexConfig, {
       connection: {
-        database: `${config.database}_fixture_local`,
+        database: `${config.name}_test`,
         ...config.defaultOptions?.connection,
       },
     });
@@ -172,40 +120,32 @@ class DBClass {
     // 개발 환경 설정
     const devMasterOptions = config.environments?.development;
     const devSlaveOptions = config.environments?.development_slave;
-    const development_master = _.merge({}, defaultKnexConfig, devMasterOptions);
-    const development_slave = _.merge(
-      {},
-      defaultKnexConfig,
-      devMasterOptions,
-      devSlaveOptions
+    const development_master = assign(defaultKnexConfig, devMasterOptions ?? {});
+    const development_slave = assign(
+      assign(defaultKnexConfig, devMasterOptions ?? {}),
+      devSlaveOptions ?? {},
     );
     // NOTE: fixture remote는 default connection의 DB를 override해선 안됨.
-    const fixture_remote = _.merge(
-      {},
-      defaultKnexConfig,
-      devMasterOptions,
-      {
+    const fixture_remote = assign(
+      assign(assign(defaultKnexConfig, devMasterOptions ?? {}), {
         connection: {
-          database: `${config.database}_fixture_remote`,
+          database: `${config.name}_fixture_remote`,
         },
-      },
-      config.environments?.remote_fixture
+      }),
+      config.environments?.remote_fixture ?? {},
     );
 
     // 프로덕션 환경 설정
     const prodMasterOptions = config.environments?.production ?? {};
     const prodSlaveOptions = config.environments?.production_slave ?? {};
-    const production_master = _.merge({}, defaultKnexConfig, prodMasterOptions);
-    const production_slave = _.merge(
-      {},
-      defaultKnexConfig,
-      prodMasterOptions,
-      prodSlaveOptions
+    const production_master = assign(defaultKnexConfig, prodMasterOptions);
+    const production_slave = assign(
+      assign(defaultKnexConfig, prodMasterOptions),
+      prodSlaveOptions ?? {},
     );
 
     return {
       test,
-      fixture_local,
       fixture_remote,
       development_master,
       development_slave,
@@ -225,5 +165,9 @@ class DBClass {
     await this.testTransaction?.rollback();
     this.testTransaction = null;
   }
+  async getTestConnection(): Promise<Knex> {
+    const db = this.getDB("w");
+    return db;
+  }
 }
 export const DB = new DBClass();