Merge branch 'dev' into #322-AWS-SDK-V3-MIGRATE

.env.example

@@ -1,14 +1,18 @@
+# required environment variables
 PORT=[back의 port(e.g. 80)]
 DB_PATH=[mongoDB path(e.g. mongodb://localhost:27017/local)]
-REDIS_PATH=[redis path(e.g. redis://127.0.0.1:6379)]
-SESSION_KEY=[세션 비밀번호(임의 값 아무거나 설정하면 된다)]
-SPARCSSSO_CLIENT_ID=[스팍스SSO ID]
-SPARCSSSO_CLIENT_KEY=[스팍스SSO PW]
-FRONT_URL=[front url(e.g. http://localhost:3000)]
 AWS_ACCESS_KEY_ID=[AWS Access key ID]
 AWS_SECRET_ACCESS_KEY=[AWS Secret access key]
-AWS_S3_BUCKET_NAME=[AWS S3 Buck name]
+AWS_S3_BUCKET_NAME=[AWS S3 Bucket name]
 AWS_S3_URL=[AWS S3 url(e.g. https://<bucket-name>.s3.<region>.amazonaws.com)]
-JWT_SECRET_KEY=[JWT SERCRET KEY]
-APP_URI_SCHEME=[APP_URI_SCHEME]
-GOOGLE_APPLICATION_CREDENTIALS=[GOOGLE APPLICATION CREDENTIALS JSON]
+
+# optional environment variables
+REDIS_PATH=[redis path(e.g. redis://127.0.0.1:6379)]
+SESSION_KEY=[세션 관리에 사용되는 키(임의 값 아무거나 설정하면 된다)]
+JWT_SECRET_KEY=[JWT 관리에 사용되는 키(임의 값 아무거나 설정하면 된다)]
+SPARCSSSO_CLIENT_ID=[스팍스SSO ID]
+SPARCSSSO_CLIENT_KEY=[스팍스SSO PW]
+CORS_WHITELIST=[CORS 정책에서 허용하는 도메인의 목록(e.g. ["http://localhost:3000"])]
+GOOGLE_APPLICATION_CREDENTIALS=[GOOGLE_APPLICATION_CREDENTIALS JSON]
+TEST_ACCOUNTS=[스팍스SSO로 로그인시 무조건 테스트로 로그인이 가능한 허용 아이디 목록]
+SLACK_REPORT_WEBHOOK_URL=[Slack 웹훅 URL들이 담긴 JSON]

.github/workflows/push_image_ecr.yml

@@ -22,6 +22,17 @@ jobs:
       with:
         fetch-depth: 0
 
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Cache Docker layers
+      uses: actions/cache@v3
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+    
     - name: Get previous tag-version
       id: previous_tag
       uses: WyriHaximus/github-action-get-previous-tag@v1
@@ -47,15 +58,23 @@ jobs:
       id: login-ecr
       uses: aws-actions/amazon-ecr-login@v1
 
-    - name: Build and Push to AWS ECR
-      id: build_image
+    - name: Build Image and Push to AWS ECR
+      id: build_image_and_push
+      uses: docker/build-push-action@v5
       env:
         ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
         IMAGE_TAG: ${{ steps.tag.outputs.tag }}
         ECR_REPOSITORY: taxi-back
+      with:
+        push: true
+        tags: |
+          "${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}"
+          "${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:latest"
+        cache-from: type=local,src=/tmp/.buildx-cache
+        cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+    - name: Remove old cache
       run: |
-        docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
-        docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:latest .
-        docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
-        docker push $ECR_REGISTRY/$ECR_REPOSITORY:latest
-        echo "Push iamge : $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG and latest"
+        rm -rf /tmp/.buildx-cache
+        mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+  

.github/workflows/push_image_ecr_dev.yml

@@ -20,7 +20,18 @@ jobs:
       uses: actions/checkout@v3
       with:
         fetch-depth: 0
-
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Cache Docker layers
+      uses: actions/cache@v3
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+
     - name: Configure AWS credentials
       uses: aws-actions/configure-aws-credentials@v1
       with:
@@ -31,13 +42,20 @@ jobs:
     - name: Login to AWS ECR
       id: login-ecr
       uses: aws-actions/amazon-ecr-login@v1
-
-    - name: Build and Push to AWS ECR
-      id: build_image
+
+    - name: Build Image and Push to AWS ECR
+      id: build_image_and_push
+      uses: docker/build-push-action@v5
       env:
         ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
         ECR_REPOSITORY: taxi-back
+      with:
+        push: true
+        tags: "${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:dev"
+        cache-from: type=local,src=/tmp/.buildx-cache
+        cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+    - name: Remove old cache
       run: |
-        docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:dev .
-        docker push $ECR_REGISTRY/$ECR_REPOSITORY:dev
-        echo "Push iamge : $ECR_REGISTRY/$ECR_REPOSITORY:dev"
+        rm -rf /tmp/.buildx-cache
+        mv /tmp/.buildx-cache-new /tmp/.buildx-cache

.github/workflows/test_ci.yml

@@ -12,24 +12,23 @@ jobs:
     strategy:
       matrix:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-        node-version: [16.x]
+        node-version: ['18.x']
         mongodb-version: ['5.0']
     steps:
     - name: Start MongoDB  
       run: sudo docker run --name mongodb -d -p 27017:27017 mongo:${{ matrix.mongodb-version }}
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/checkout@v3
+    - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Install Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16
-
-    - uses: pnpm/action-setup@v2
-      name: Install pnpm
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
       with:
         version: 8
+    - name: Install Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
     - id: submodule-local
       name: Save local version of submodule
       run: echo "ver=`cd sampleGenerator && git log --pretty="%h" -1 && cd ..`" >> $GITHUB_OUTPUT
@@ -53,6 +52,5 @@ jobs:
         AWS_S3_BUCKET_NAME: ${{ secrets.AWS_S3_BUCKET_NAME }} 
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         DB_PATH: ${{ secrets.DB_PATH }}
-        FRONT_URL: ${{ secrets.FRONT_URL }}
         PORT: ${{ secrets.PORT }}
         SESSION_KEY: ${{ secrets.SESSION_KEY }}

.gitignore

@@ -6,6 +6,7 @@
 *.code-workspace
 *.swp
 /logs/*.log
+.vscode
 
 # AdminJS 관련 디렉토리
 .adminjs

.npmrc

@@ -0,0 +1,2 @@
+# Force Node.js and pnpm versions according to package.json
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+v18.17.0

Dockerfile

@@ -1,18 +1,21 @@
-FROM node:16-alpine
+FROM node:18-alpine
 
-# Copy repository
 WORKDIR /usr/src/app
-COPY . .
 
-# Install curl (for taxi-docker)
-RUN apk update && apk add curl
-RUN npm install --global [email protected] [email protected]
+# Install curl(for taxi-watchtower) and pnpm
+RUN apk update && apk add curl && npm install --global [email protected]
 
-# Install requirements
-RUN pnpm i --force --frozen-lockfile
+# pnpm fetch does require only lockfile
+COPY pnpm-lock.yaml .
+
+# Note: devDependencies are not fetched
+RUN pnpm fetch --prod
+
+# Copy repository and install dependencies
+ADD . ./
+RUN pnpm install --offline --prod
 
 # Run container
 EXPOSE 80
 ENV PORT 80
 CMD ["pnpm", "run", "serve"]
-

README.md

@@ -9,10 +9,11 @@ Taxi는 KAIST 구성원들의 택시 동승 인원 모집을 위한 서비스입
 - Notion : [Sparcs Notion Taxi page](https://www.notion.so/sparcs/Taxi-9d371e8ac5ac4f0c9b9c35869682a0eb) (Only SPARCS members can access it)
 - Slack : #taxi-main, #taxi-notice, #taxi-bug-report, #taxi-github-bot, #taxi-notion-bot (Only SPARCS members can access it)
 
-## Prerequisites
-- Recommended npm version : 8.5.5 (with node v.16.15.0)
-- Recommended mognoDB version : 5.0.8
-- [Issue with node version](https://github.com/sparcs-kaist/taxi-front/issues/76)
+## Prerequisite
+
+- Recommended node version : >=18.0.0 (Node v18.18.0, for example)
+- Recommended pnpm version : >=8.0.0 (pmpm v8.8.0, for example)
+- Recommended mongoDB version : 5.0.8
 
 ## Project Setup
 
@@ -24,15 +25,17 @@ $ git clone https://github.com/sparcs-kaist/taxi-back
 
 ### Install Requirements
 ```bash
-$ npm install --save
+$ pnpm install
 ```
 
 ### Set Environment Configuration
 See [notion page](https://www.notion.so/sparcs/Environment-Variables-1b404bd385fa495bac6d5517b57d72bf).
-Refer to [.env.example](.env.example) and write your own `.env.development` and `.env.test`.
+Refer to [.env.example](.env.example) and write your own `.env`.
 
 ## Backend Route Information
-See [Backend Route Documentation](src/routes/docs/README.md)
+API specification is defined on Swagger.
+Start development server and visit `/docs` to see the specification of each endpoint.
+Some endpoints are not documented in Swagger yet. For those endpoints, refer to [routes/docs/README.md](./src/routes/docs/README.md).
 
 ## License
 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

app.js

@@ -1,8 +1,9 @@
 // 모듈 require
 const express = require("express");
 const http = require("http");
-const { port: httpPort } = require("./loadenv");
+const { port: httpPort, eventConfig } = require("./loadenv");
 const logger = require("./src/modules/logger");
+const { connectDatabase } = require("./src/modules/stores/mongo");
 const { startSocketServer } = require("./src/modules/socket");
 
 // Firebase Admin 초기설정
@@ -11,14 +12,18 @@ require("./src/modules/fcm").initializeApp();
 // 익스프레스 서버 생성
 const app = express();
 
+// 데이터베이스 연결
+connectDatabase();
+
 // [Middleware] request body 파싱
 app.use(express.urlencoded({ extended: false }));
 app.use(express.json());
 
+// reverse proxy가 설정한 헤더를 신뢰합니다.
+app.set("trust proxy", true);
+
 // [Middleware] CORS 설정
-app.use(
-  require("cors")({ origin: true, credentials: true, exposedHeaders: ["Date"] })
-);
+app.use(require("./src/middlewares/cors"));
 
 // [Middleware] 세션 및 쿠키
 const session = require("./src/middlewares/session");
@@ -40,6 +45,16 @@ app.use(require("./src/middlewares/limitRate"));
 // [Router] Swagger (API 문서)
 app.use("/docs", require("./src/routes/docs"));
 
+// 2023 추석 이벤트 전용 라우터입니다.
+eventConfig &&
+  app.use(
+    `/events/${eventConfig.mode}`,
+    require("./src/lottery").lotteryRouter
+  );
+
+// [Middleware] 모든 API 요청에 대하여 origin 검증
+app.use(require("./src/middlewares/originValidator"));
+
 // [Router] APIs
 app.use("/auth", require("./src/routes/auth"));
 app.use("/logininfo", require("./src/routes/logininfo"));
@@ -50,12 +65,18 @@ app.use("/locations", require("./src/routes/locations"));
 app.use("/reports", require("./src/routes/reports"));
 app.use("/notifications", require("./src/routes/notifications"));
 
+// [Middleware] 전역 에러 핸들러. 에러 핸들러는 router들보다 아래에 등록되어야 합니다.
+app.use(require("./src/middlewares/errorHandler"));
+
 // express 서버 시작
 const serverHttp = http
   .createServer(app)
   .listen(httpPort, () =>
     logger.info(`Express 서버가 ${httpPort}번 포트에서 시작됨.`)
   );
 
-// socket.io 서버 시작 및 app 인스턴스에 저장
+// socket.io 서버 시작
 app.set("io", startSocketServer(serverHttp));
+
+// [Schedule] 스케줄러 시작
+require("./src/schedules")(app);

loadenv.js

@@ -1,6 +1,5 @@
 // 환경 변수에 따라 .env.production 또는 .env.development 파일을 읽어옴
 require("dotenv").config({ path: `./.env.${process.env.NODE_ENV}` });
-
 module.exports = {
   nodeEnv: process.env.NODE_ENV,
   mongo: process.env.DB_PATH, // required
@@ -11,7 +10,8 @@ module.exports = {
     key: process.env.SPARCSSSO_CLIENT_KEY || "", // optional
   },
   port: process.env.PORT || 80, // optional (default = 80)
-  frontUrl: process.env.FRONT_URL || "http://localhost:3000", // optional (default = "http://localhost:3000")
+  corsWhiteList: (process.env.CORS_WHITELIST &&
+    JSON.parse(process.env.CORS_WHITELIST)) || [true], // optional (default = [true])
   aws: {
     accessKeyId: process.env.AWS_ACCESS_KEY_ID, // required
     secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY, // required
@@ -24,18 +24,20 @@ module.exports = {
     secretKey: process.env.JWT_SECRET_KEY || "TAXI_JWT_KEY",
     option: {
       algorithm: "HS256",
+      // FIXME: remove FRONT_URL from issuer. 단, issuer를 변경하면 이전에 발급했던 모든 JWT가 무효화됩니다.
+      // See https://github.com/sparcs-kaist/taxi-back/issues/415
       issuer: process.env.FRONT_URL || "http://localhost:3000", // optional (default = "http://localhost:3000")
     },
     TOKEN_EXPIRED: -3,
     TOKEN_INVALID: -2,
   },
-  appUriScheme: process.env.APP_URI_SCHEME, // FIXME: 사용하지 않음
   googleApplicationCredentials:
     process.env.GOOGLE_APPLICATION_CREDENTIALS &&
-    JSON.parse(process.env.GOOGLE_APPLICATION_CREDENTIALS),
+    JSON.parse(process.env.GOOGLE_APPLICATION_CREDENTIALS), // optional
   testAccounts:
-    process.env.TEST_ACCOUNTS && JSON.parse(process.env.TEST_ACCOUNTS),
+    (process.env.TEST_ACCOUNTS && JSON.parse(process.env.TEST_ACCOUNTS)) || [], // optional
   slackWebhookUrl: {
     report: process.env.SLACK_REPORT_WEBHOOK_URL || "", // optional
   },
+  eventConfig: (process.env.EVENT_CONFIG && JSON.parse(process.env.EVENT_CONFIG))
 };