Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#404 Node.js 버전 18로 올리기, #414 GitHub Actions 캐시 사용 #413

Merged
merged 15 commits into from
Oct 9, 2023

Conversation

withSang
Copy link
Member

@withSang withSang commented Oct 7, 2023

Summary

It closes #404

  • Node.js 18 버전 이상에서만 taxi-back이 실행되도록 강제하였습니다.
  • 취약한 의존성 버전을 올리고, Mongoose, express-rate-limit의 설정 문제로 발생하는 경고를 해결하였습니다.
  • taxi-sample-generator는 수정 없이도 모든 기능이 잘 동작하기 때문에 수정하지 않았습니다.
  • modules/ 내의 소스코드에 대해서 유닛 테스트가 가능하도록 test/ 내에 서브디렉토리를 추가했습니다.
    • jwt 라이브러리의 메이저 버전이 바뀌어 breaking change가 있습니다. 문제가 없음을 보장하기 위해 테스트 케이스를 추가해보았습니다.
  • taxi-infra의 Dockerfile은 아직 수정하지 않았습니다. 사용되지 않으니 지워도 괜찮지 않을까 생각해요.

It closes #414 - 위 이슈를 해결할 때 Dockerfile 수정이 필요했어서, 하는 김에 같이 작업했습니다.

  • CI/CD GitHub Action에 캐시를 도입하였습니다.
  • 캐시를 최대한 활용하기 위해 Dockerfile의 커맨드 순서를 변경합니다.
  • 마찬가지로 taxi-infra의 Dockerfile은 아직 수정하지 않았습니다. 사용되지 않으니 지워도 괜찮지 않을까 생각해요.
  • CD 워크플로의 경우 작업은 끝났으나 워크플로가 잘 실행되는지 시험해보면 좋겠습니다. Zabo에서 이미 잘 쓰이는 workflow를 그대로 옮겨오기는 했지만(파일 보기), 워크플로 실행에 실패하면 급하게 수정해야 할 수도 있어요.

Extra info

이 PR 머지 이후 GitHub Actions Secret에서 "FRONT_URL"을 안전하게 삭제할 수 있습니다(저는 권한이 없어요 ㅠ).

Images or Screenshots

  1. Node.js 엔진과 의존성 업데이트
    image
  2. CI workflow에서 pnpm 캐시 사용 ( https://github.com/sparcs-kaist/taxi-back/actions/runs/6441630325/job/17491633547?pr=413 )
    image
    image

Further Work

@withSang withSang linked an issue Oct 7, 2023 that may be closed by this pull request
3 tasks
@withSang withSang self-assigned this Oct 7, 2023
@withSang withSang added ⚒ enhancement New feature or request 🖥 working 아직 작업 중인 상태 labels Oct 7, 2023
@withSang withSang changed the title #404 Node.js 버전 18로 올리기 #404 Node.js 버전 18로 올리기, #414 GitHub Actions 캐시 사용 Oct 7, 2023
@withSang withSang marked this pull request as ready for review October 7, 2023 13:59
@withSang withSang removed the 🖥 working 아직 작업 중인 상태 label Oct 7, 2023
@withSang withSang requested review from cokia, 14KGun and chlehdwon October 7, 2023 13:59
Comment on lines +25 to +35
- 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-

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

오 캐시 도입이 되면 빌드가 훨씬 빨라지겠네요 :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

감사합니다! 배포가 더 빨라질 수 있어 기대돼요 ㅎㅎ

Comment on lines +17 to +20
"engines": {
"node": ">=18.0.0",
"pnpm": ">=8.0.0"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

크.. 버전업 고생하셨습니다 :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

히히 다른 의존성 안 올려도 바로 잘 돌아가더라구요 ㅎㅎ 옛날엔 이슈가 많았던 것 같은데 다행이었습니다..

Copy link
Contributor

@cokia cokia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 고생많으셨습니다 ~~ :D

@@ -5,6 +5,10 @@ const limiter = rateLimit({
max: 1500, // Limit each IP to 1500 requests per `window` (here, per 15 minutes)
standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
legacyHeaders: false, // Disable the `X-RateLimit-*` headers
validate: {
default: true,
trustProxy: false, // Disable the validation error caused by 'trust proxy' set to true
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nginx를 리버스 프록시로 사용할 경우 trustProxy validation을 꺼도 문제 없습니다.
몇몇 리버스 프록시의 경우 문제가 될 수 있는데, https://github.com/express-rate-limit/express-rate-limit/wiki/Troubleshooting-Proxy-Issues 에 자세하게 설명이 되어 있습니다.

COPY pnpm-lock.yaml .

# Note: devDependencies are not fetched
RUN pnpm fetch --prod
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pnpm fetch 명령어는 lockfile만으로도 의존성을 virtual store(node_modules/.pnpm 디렉토리)에 저장할 수 있습니다. lockfile이 바뀌지 않는 이상, package.json의 내용(taxi-back 패키지 버전, 커맨드 등)이 바뀌어도 image layer가 유효합니다.
참조: https://pnpm.io/cli/fetch

Comment on lines +25 to +35
- 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-

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

감사합니다! 배포가 더 빨라질 수 있어 기대돼요 ㅎㅎ

Comment on lines +17 to +20
"engines": {
"node": ">=18.0.0",
"pnpm": ">=8.0.0"
},
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

히히 다른 의존성 안 올려도 바로 잘 돌아가더라구요 ㅎㅎ 옛날엔 이슈가 많았던 것 같은데 다행이었습니다..

Copy link
Member

@14KGun 14KGun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 수고하셨습니다
많이 고치셨네요 ㅋㅋㅋ

test/modules/auths/jwt.js Show resolved Hide resolved
@withSang withSang merged commit 2b772c4 into dev Oct 9, 2023
@withSang withSang deleted the #404-update-nodejs-to-18 branch October 9, 2023 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚒ enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub Actions 캐시 사용 Node.js 버전 18로 올리기
3 participants