feature: DB 설정 및 모델 정의 (#205)

* chore: typeorm, typeorm-naming-strategies, mysql2 설치

* chore: TypeORM 설정

* feat: 데이터 모델 정의

* chore: redis 연결 성공시 콘솔 메시지 추가

* chore: yarn install 정리

* chore: 모든 DB 스키마에 updateAt 필드 추가

* chore: 패키지 충돌 해결

packages/slack/package.json

@@ -26,9 +26,12 @@
     "dotenv": "^16.3.1",
     "express": "^4.18.2",
     "express-async-errors": "^3.1.1",
+    "mysql2": "^3.6.1",
     "redis": "^4.6.8",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
+    "typeorm": "^0.3.17",
+    "typeorm-naming-strategies": "^4.1.0",
     "typescript": "^5.2.2",
     "zod": "^3.22.2"
   },

packages/slack/src/app.ts

@@ -1,12 +1,17 @@
 import 'dotenv/config';
+import '@/configs/redis';
 import app from '@/configs/express';
+import AppDataSource from '@/configs/database';
 import router from '@/routes';
-import '@/configs/redis';
 
 const PORT = process.env.PORT;
 
 app.use('/', router);
 
+AppDataSource.initialize()
+  .then(() => console.log('Database connected!'))
+  .catch((err) => console.log(err));
+
 app.listen(PORT, () => {
   console.log(`Server is running in ${PORT} port.`);
 });

packages/slack/src/configs/database.ts

@@ -0,0 +1,22 @@
+import { DataSource } from 'typeorm';
+import { SnakeNamingStrategy } from 'typeorm-naming-strategies';
+import { User } from '@/models/User';
+import { Post } from '@/models/Post';
+import { Comment } from '@/models/Comment';
+
+const AppDataSource = new DataSource({
+  type: 'mysql',
+  port: 3306,
+  host: process.env.NODE_ENV === 'production' ? process.env.DEPLOY_DB_HOST : 'localhost',
+  username: process.env.NODE_ENV === 'production' ? process.env.DEPLOY_DB_USERNAME : process.env.LOCAL_DB_USERNAME,
+  password: process.env.NODE_ENV === 'production' ? process.env.DEPLOY_DB_PASSWORD : process.env.LOCAL_DB_PASSWORD,
+  database: process.env.DB_DATABASE,
+  synchronize: true,
+  // logging: true,
+  entities: [User, Post, Comment],
+  subscribers: [],
+  migrations: [],
+  namingStrategy: new SnakeNamingStrategy()
+});
+
+export default AppDataSource;

packages/slack/src/configs/redis.ts

@@ -5,7 +5,8 @@ const redisClient = createClient({
   password: process.env.NODE_ENV === 'production' ? process.env.DEPLOY_REDIS_PASSWORD : undefined
 });
 
-redisClient.on('error', (err) => console.log('Redis Client Error', err));
+redisClient.on('connect', () => console.log('Redis Connected'));
+redisClient.on('error', (err) => console.log('Redis Error', err));
 redisClient.connect();
 
 export default redisClient;

packages/slack/src/models/Comment.ts

@@ -0,0 +1,34 @@
+import { Entity, Column, PrimaryGeneratedColumn, ManyToOne } from 'typeorm';
+import { Post } from './Post';
+
+@Entity()
+export class Comment {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Column({ length: 50 })
+  author!: string;
+
+  @Column({ length: 500 })
+  content!: string;
+
+  @Column({ length: 50 })
+  imageName!: string;
+
+  @Column()
+  positionX!: number;
+
+  @Column()
+  positionY!: number;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  createdAt!: Date;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  updatedAt!: Date;
+
+  @ManyToOne(() => Post, (post) => post.comments, {
+    cascade: true
+  })
+  post!: Post;
+}

packages/slack/src/models/Post.ts

@@ -0,0 +1,32 @@
+import { Entity, Column, PrimaryGeneratedColumn, OneToMany, ManyToOne } from 'typeorm';
+import { User } from './User';
+import { Comment } from './Comment';
+
+@Entity()
+export class Post {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Column({ length: 50 })
+  title!: string;
+
+  @Column({ length: 500 })
+  content!: string;
+
+  @Column({ length: 50, nullable: true })
+  imageName!: string;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  createdAt!: Date;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  updatedAt!: Date;
+
+  @ManyToOne(() => User, (user) => user.posts, {
+    cascade: true
+  })
+  author!: User;
+
+  @OneToMany(() => Comment, (comment) => comment.id)
+  comments!: Comment[];
+}

packages/slack/src/models/User.ts

@@ -0,0 +1,44 @@
+import { Entity, Column, PrimaryGeneratedColumn, OneToMany } from 'typeorm';
+import { Post } from './Post';
+
+@Entity()
+export class User {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Column({ length: 50, unique: true })
+  username!: string;
+
+  @Column()
+  password!: string;
+
+  @Column()
+  salt!: string;
+
+  @Column({ length: 20 })
+  role!: string;
+
+  @Column({ length: 20 })
+  name!: string;
+
+  @Column()
+  introduce!: string;
+
+  @Column({ length: 50 })
+  imageName!: string;
+
+  @Column({ length: 50 })
+  slackId!: string;
+
+  @Column({ length: 20 })
+  slackWorkspace!: string;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  createdAt!: Date;
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP' })
+  updatedAt!: Date;
+
+  @OneToMany(() => Post, (post) => post.author)
+  posts!: Post[];
+}

packages/slack/src/types/env.d.ts

@@ -15,6 +15,11 @@ declare namespace NodeJS {
     SLACK_HOOK_ENDPOINT: string;
     SLACK_BOT_TOKEN: string;
     SLACK_SIGNING_SECRET: string;
-    SESSION_SECRET: string;
+    DB_DATABASE: string;
+    LOCAL_DB_USERNAME: string;
+    LOCAL_DB_PASSWORD: string;
+    DEPLOY_DB_HOST: string;
+    DEPLOY_DB_USERNAME: string;
+    DEPLOY_DB_PASSWORD: string;
   }
 }

packages/slack/tsconfig.json

@@ -3,16 +3,13 @@
   "ts-node": {
     "files": true
   },
-  "files": [
-    "src/types/env.d.ts",
-    "src/types/express.d.ts"
-  ],
+  "files": ["src/types/env.d.ts", "src/types/express.d.ts"],
   "compilerOptions": {
     "baseUrl": "src",
     "rootDir": "src",
     "outDir": "dist",
     "paths": {
-      "@/*": ["./*"],
+      "@/*": ["./*"]
     },
     "target": "ES2020",
     "useDefineForClassFields": true,
@@ -28,6 +25,9 @@
     "isolatedModules": true,
     // "noEmit": true,
 
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+
     /* Linting */
     "strict": true,
     "noFallthroughCasesInSwitch": true