[EB/Error] EB에 배포한 Node.js 실행 안 됨

🧐 상황

경험차 캡스톤 디자인에 사용할 서버를 Node.js - Docker - AWS ElasticBeanstalk으로 배포하고자 했다.

Dockerfile이라던가 배포를 위한 .yml 파일 다 맞게 한 것 같은데 EB에만 올리면 실행이 되지 않았다.

 

👻 문제

추측되는 원인은 다음과 같았다.

1. Node.js 프로젝트 자체가 잘못되었다.

2. Docker 이미지가 잘못 빌드되었다.

3. DockerHub에 있는 이미지를 EB에서 pull 하지 못한다.

4. EB가 Docker 이미지 또는 Node.js 프로젝트를 실행하지 못한다.

 

1. Node.js 프로젝트 자체가 잘못되었다. ❌

로컬에서 npm start로 프로젝트를 실행했을 때 문제 없이 실행되었기 때문에 제외

 

2. Docker 이미지가 잘못 빌드되었다. ❌

 

 

로컬로 빌드 후 실행했을 땐 로컬 8080 포트로 접속했을 때 잘 실행이 되었다.

 

3. DockerHub에 있는 이미지를 EB에서 pull 하지 못한다. ❔

이걸 확인하려면 EB에서 생성한 EC2 콘솔에 접속하던가 해야할 것 같은데 귀찮아서(...) 4번부터 확인하고 다시 오기로 했다.

 

4. EB가 Docker 이미지 또는 Node.js 프로젝트를 실행하지 못한다.

Docker 이미지라서 문제가 생겼나 싶어서 EB를 Node.js용으로 다시 생성해서 수동으로 프로젝트를 업로드 해봤는데 여전히 실행되지 않았다. Docker 이미지 빌드 과정에서 npm install을 실행하므로 모듈 설치의 문제도 아닌 거 같고.. npm install이 됐으면 같은 Dockerfile에 있던 npm start 명령어도 실행이 됐을텐데 무슨 이유에선지 npm start 명령이 제대로 실행되지 않는 것 같았다.

 

{
  "name": "ci_test",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "nodemon index.js"
  },
  "author": "",
  "license": "ISC",
  "description": "",
  "dependencies": {
    "cors": "^2.8.5",
    "dotenv": "^16.4.5",
    "express": "^4.19.2",
    "http-status-codes": "^2.3.0"
  },
  "devDependencies": {
    "nodemon": "^3.1.4"
  },
  "type": "module"
}

다음은 CI 테스트를 위해 만든 프로젝트의 package.json이다. npm start는 nodemon index.js라는 명령어를 실행한다. 

프로젝트가 실행이 안 되는 것이라면 nodemon index.js라는 명령어가 제대로 동작하지 않았음을 의미한다.

갑자기 라이브러리가 버그가 날 리는 없으므로 Docker 이미지 안에서 nodemon 라이브러리가 설치가 되지 않았다고 봐야한다.

nodemon은 devDependencies 안에 있다. 로컬에서 이미지를 실행했을 땐 잘 됐으니까 다른 모듈들은 잘 설치가 됐다고 보고 그냥 dependencies 속 라이브러리는 설치가 됐고 devDependencies 속 라이브러리는 설치가 되지 않은 것이라 가정했다.

 

그렇다면 여기서 드는 생각은.. npm install은 devDependencies 속 라이브러리를 설치하지 않는가?

일반적으로 npm install은 devDependencies 속 라이브러리도 설치한다. 다만 NODE_ENV 환경변수가 production이라면 devDependencies는 무시한다. EB의 환경을 생성할 때 내가 따로 추가한 환경변수는 없으므로 AWS ElasticBeanstalk 자체의 설정을 살펴봤다.

 

 

...

그렇다. 애초에 devDependencies는 설치가 되지 않는 것이었다.

나는 그럼 무얼 위한 삽질을 한 건지... 참나

 

💞 해결

devDependencies 패키지를 설치하지 않는 것이 문제이므로 두 가지 선택지가 있다.

1. Dockerfile에 nodemon을 설치하는 커맨드를 추가한다.

2. package.json의 npm start script를 수정한다.

 

둘 중 어떤 것을 골라도 어렵지는 않지만 EB에 올리는 것은 api 확인이 끝난 서버이므로 굳이 nodemon이 필요하지 않다는 생각이 들어 2번 방식으로 해결하기로 하였다.

 

{
  "_comment": "수정 전",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "nodemon index.js"
  }
},
{
  "_comment": "수정 후",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node index.js"
  }
}

nodemon에서 단 세 글자를 뺐다..ㅎ

이제 nodemon을 따로 설치할 필요가 없다.

 

다시 Github Action을 통해 EB에 배포를 해보면,

다음과 같이 잘 출력이 되는 것을 확인할 수 있다!

 

이렇게 간단한 걸로 며칠을 고생한건지..

구글링도 구글링이지만 개발 문서도 잘 읽어봐야겠다.

 

 

 

 

 

 

npm-install | npm Docs

 

애플리케이션의 종속 항목 구성 - AWS Elastic Beanstalk