GitHub Actions를 활용한 CD 파이프라인 작성 (#10)

* feat: cd 스크립트 작성

* chore: cd스크립트  workflows폴더로 이동

* chore: 버전 수정

* chore: serverless 버전 3.38.0으로 고정 및 credential 과정 삭제

- serverless v4부터 로그인/라이선스 키가 필요해 v3.38.0으로 고정
- AWS 인증은 환경 변수만으로 처리하도록 변경

* chore: prisma deploy과정에 Prisma CLI 설치 추가

* chore: 프리즈마 스키마 파일 위치 설정

* chore: 경로 추가

* chore: 환경 변수 이름 수정

* fix: serverless 배포 명령어 수정. 플러그인 충돌 해결

- npx --no-install 옵션을 사용하여 serverless 버전 충돌 문제 해결

* chore: 플러그인 주석

* chore: 서버리스 버전 수정

* chore: 노드 버전 수정

* chore: 플러그인 충돌로 인해 주석처리

* chore: AWS 자격 증명 설정

* chore: serverless secret key 추가

* chore: 서버리스 버전 수정

* chore: 대시보드 비활성화

* chore: 대시보드 모드 비활성화

* chore: --no-console 제거

* chore: pakage할때 제외 pnpm제외

* chore: remove @generated from code config

* fix: build type error

* feat: bcrypt -> bcryptjs로 변경

- lambda 환경에서 bcrypt는 호환 이슈가 있어요
ref: kelektiv/node.bcrypt.js#505 (comment)

* feat: 필요한 환경변수 재설정

* feat: aws-lambda 를 serverless 배포에서 제외

* chore: only import type

* feat: 민감한 정보 masking

* feat: use dotenv plugin

* feat: build / deploy workflow 나눔

- npx prisma generate 는 삭제 -> yarn install 시 prisma 내부 postinstall 로 shcema에 따라 자동 생성

* feat: install serverless in local

* chore: remove no use

* chore: 필요없는 환경변수 제거

* chore: 주석 삭제

* chore: remove this branch from workflow triggers

* chore: remove useless

---------

Co-authored-by: ain <ain.jo@kmpns.com>
Co-authored-by: Joo-Byungho <kjcoco13@gmail.com>

Author: 3 people

.example.env

@@ -1,14 +1,6 @@
-# DB
 DB_URL="postgresql://postgres:1q2w3e4r@localhost:5432/postgres?schema=public"
-DB_HOST=localhost
-DB_PORT=5432
-DB_USER=postgres
-DB_PASSWORD=1q2w3e4r
-DB_NAME=postgres
-DB_SCHEMA=public
 
 PORT=8000
 
-# JWT
 ACCESS_TOKEN_SECRET=
 REFRESH_TOKEN_SECRET=

.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+name: Deploy serverless application
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run Prisma migrations
+        run: npx prisma migrate deploy 2>&1 | grep -v 'Datasource "db":' | grep -v 'PostgreSQL database'
+        env:
+          DB_URL: ${{ secrets.DB_URL }}
+
+      - name: Create .env file
+        run: |
+          echo "ACCESS_TOKEN_SECRET=${{ secrets.ACCESS_TOKEN_SECRET }}" >> .env
+          echo "REFRESH_TOKEN_SECRET=${{ secrets.REFRESH_TOKEN_SECRET }}" >> .env
+          echo "DB_URL=${{ secrets.DB_URL }}" >> .env
+
+      - name: Run build
+        run: yarn build
+
+      - name: Configure serverless credentials
+        run: npx serverless config credentials --provider aws --key ${{ secrets.AWS_ACCESS_KEY_ID }} --secret ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+
+      - name: Deploy serverless app
+        run: npx serverless deploy 2>&1 | grep -v 'endpoint:'

.github/workflows/validate.yml

@@ -0,0 +1,28 @@
+name: Run build & test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Lint code
+        run: yarn lint
+
+      - name: Build project
+        run: yarn build

.gitignore

@@ -61,5 +61,3 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 postgres-data/
 
 graphql-schema.gql
-
-@generated

.prettierignore

@@ -1,2 +1 @@
-graphql-schema.gql
-@generated
+graphql-schema.gql

package.json

@@ -25,6 +25,7 @@
   },
   "dependencies": {
     "@fastify/aws-lambda": "5.1.4",
+    "@nestjs/cli": "^11.0.6",
     "@nestjs/common": "^11.0.1",
     "@nestjs/config": "^4.0.2",
     "@nestjs/core": "^11.0.1",
@@ -35,8 +36,7 @@
     "@nestjs/platform-express": "^11.0.1",
     "@nestjs/platform-fastify": "11.0.12",
     "@prisma/client": "^6.5.0",
-    "aws-lambda": "^1.0.7",
-    "bcrypt": "^5.1.1",
+    "bcryptjs": "^3.0.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "fastify": "5.2.1",
@@ -52,7 +52,6 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.18.0",
-    "@nestjs/cli": "^11.0.0",
     "@nestjs/schematics": "^11.0.0",
     "@nestjs/testing": "^11.0.1",
     "@swc/cli": "^0.6.0",
@@ -71,6 +70,7 @@
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "prettier": "^3.4.2",
+    "serverless": "3.38.0",
     "serverless-dotenv-plugin": "^6.0.0",
     "source-map-support": "^0.5.21",
     "supertest": "^7.0.0",
@@ -98,4 +98,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}

serverless.yml

@@ -1,6 +1,3 @@
-org: hospace
-app: mashup-node
-
 service: nest-graphql-mercurius-fastify
 
 plugins:
@@ -30,3 +27,4 @@ package:
     - 'node_modules/.prisma/client/libquery_engine-rhel-*'
     - '!node_modules/prisma/libquery_engine-*'
     - '!node_modules/@prisma/engines/**'
+    - '!node_modules/aws-lambda'

src/auth/auth.service.ts

@@ -1,7 +1,7 @@
 import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { PrismaService } from '../prisma/prisma.service';
-import * as bcrypt from 'bcrypt';
+import * as bcrypt from 'bcryptjs';
 import { SignInInput, SignUpInput } from './inputs/auth.input';
 import { JwtService } from '@nestjs/jwt';
 import { User } from '@prisma/client';

src/common/decorators/current-user.decorator.ts

@@ -1,9 +1,12 @@
 import { ExecutionContext, createParamDecorator } from '@nestjs/common';
 import { GqlExecutionContext } from '@nestjs/graphql';
+import { GraphQLContext } from '../config/graphql.context';
 
 export const CurrentUser = createParamDecorator(
-  (data: unknown, context: ExecutionContext) => {
-    const ctx = GqlExecutionContext.create(context);
-    return ctx.getContext().req.user;
+  (_: unknown, context: ExecutionContext) => {
+    const gqlContext = GqlExecutionContext.create(context);
+    const { user } = gqlContext.getContext<GraphQLContext>();
+
+    return user;
   },
 );

src/lambda.ts

@@ -2,7 +2,7 @@ import awsLambdaFastify, {
   LambdaResponse,
   PromiseHandler,
 } from '@fastify/aws-lambda';
-import {
+import type {
   APIGatewayProxyEvent,
   APIGatewayProxyResult,
   Context,