플러그와 카우보이만 사용해서 미니멀한 엘릭서 웹 앱을 만들고 허로쿠에 배포하기

이 글에서는 얼랭/OTP로 만들어진 HTTP서버인 카우보이(Cowboy), 그리고 엘릭서로 만들어진 조합형 웹 미들웨어인 플러그(Plug)만 사용해서 미니멀한 엘릭서 웹 앱을 만들고 이를 허로쿠에 배포하는 방법을 소개합니다.

이 글을 읽는 이는 미니멀한 웹 앱에 대해서 찾아볼 정도의 사람이니 엘릭서와 웹 개발에 대한 기본적인 지식을 갖추고 있다고 가정하겠습니다.

글 작성 시점에서 엘릭서 1.4.1 버전을 사용하고 있습니다. 엘릭서 1.4에서 어플리케이션 디렉토리 구조와 mix.exs 파일 설정이 바뀌었으므로 설정 차이점을 최소화하기 위해서 엘릭서 1.4 버전 이상을 사용할 것을 권장합니다.

완성된 샘플 앱의 소스 코드는 여기에서 받을 수 있습니다. 완성되어서 구동 중인 허로쿠 앱은 여기 있습니다.

엘릭서 앱 만들기

날짜/시간을 iso8601 형식과 unix 형식 사이에서 변환할 수 있는 매우 간단한 앱을 만들 것입니다.

먼저 쉘에서 mix new timeconverter --sup을 실행해서 수퍼비전 트리를 내장한 새 엘릭서 앱을 만듭니다.

HTTP 서버 추가하기

카우보이와 플러그를 설치합니다. mix.exs를 열어서 해당 패키지를 추가해주세요.

그리고 mix deps.get을 실행해서 필요한 패키지를 설치합니다.

이어서 앱의 HTTP 인터페이스 기능을 수행할 Timeconverter.Router 모듈을 생성합니다. router.ex 파일을 lib/timeconverter 디렉토리 안에 생성한 뒤에 다음 코드를 입력해 주세요.

Plug.Router는 HTTP 요청에 응답하는 경로를 생성할 수 있는 매크로를 제공합니다. matchdispatchPlug.Router를 사용할 때 반드시 넣어야 하는 플러그들입니다.

get "/"는 루트 주소에 대한 GET 요청에만 반응합니다. 그 외의 모든 요청은 match _로 연결됩니다.

Plug.Router에 대한 문서는 여기에서 살펴보세요.

start_link/3Plug.Router가 아니라 GenServer 모듈에 정의된 함수입니다. Timeconverter.Router 모듈이 수퍼비전 트리 안에서 실행되었을 때 어떤 일을 할 지 지정합니다. 이 앱에서는 카우보이를 HTTP 모드로 실행하도록 설정해두었습니다.

앱이 실행되면 Timeconverter.Router도 자동으로 실행되도록 어플리케이션 수퍼비전 트리에 넣어줍니다. lib/timeconverter/application.ex를 열고 Timeconverter.Router 워커를 추가합니다.

이제 Timeconverter 앱이 실행되면 카우보이 HTTP 서버도 실행될 것입니다.

쉘에서 mix run --no-halt를 실행해보세요. 혹시 rebar 패키지를 설치해야한다는 안내가 뜨면 설치하면 됩니다. 앱이 실행되면 localhost:4000을 브라우저에서 실행해보세요. 앱이 성공적으로 구동되었다면 “wow!”라는 간단한 텍스트를 보여줄 것입니다.

날짜/시간 형식을 변환하는 도메인 로직 추가하기

미니멀한 웹 앱을 만들고 배포하는 것이 이 글의 목적이니 도메인 로직은 대충 건너뛰도록 하겠습니다. 어차피 별로 재미도 없는 예시니까요.

lib/timeconverter.ex 파일의 내용을 다음 코드로 대체해 주세요. 글 서두에 적었듯이 이 코드는 깃헙에서도 제공하고 있습니다.

Regex와 DateTime 모듈의 함수를 사용하는 별로 특별할 것 없는 코드입니다. 이제 HTTP 경로와 도메인 로직을 연결해봅시다. lib/timeconverter/router.ex 파일을 열고 경로 관련 함수를 변경해주세요.

Plug.Conn은 HTTP 요청과 응답을 나타낸다고 보면 됩니다. 각 Plug.Conn 스트럭트에는 하나의 HTTP 연결에 관련된 모든 유용한 정보가 포함되어 있으며 필요에 따라 그 정보를 사용할 수 있습니다.

파라미터 값은 conn.params에서 받을 수 있는데, Plug.Conn.fetch_query_params/1 함수를 실행한 이후에만 쿼리 파라미터를 받을 수 있습니다. 쿼리 파라미터를 받은 뒤 conn.params를 도메인 로직 함수인 Timeconverter.convert_datetime/1에 전달합니다. HTTP 엔드포인트 레이어와 도메인 로직을 이렇게 간단히 연결할 수 있습니다.

앱을 종료한 뒤 다시 실행해보세요. 이제 앱이 timeformat 쿼리 파라미터에 따라 다르게 반응할 것입니다.

허로쿠에 배포하기

이 단계를 진행하기 위해서는 허로쿠 계정과 커맨드 라인 인터페이스가 필요합니다. 아직 설치하지 않았다면 허로쿠 개발자 센터에 나온대로 설치 및 설정을 해주세요.

허로쿠에 배포하기 위해서는 빌드팩이 필요합니다. 허로쿠에서 엘릭서를 공식적으로 지원하지는 않지만 HashNuke가 제작한 엘릭서용 오픈소스 빌드팩이 있습니다. 그 빌드팩을 사용해서 허로쿠에 배포하도록 하겠습니다. HashNuke의 빌드팩 관련 문서는 여기에서 살펴 보세요.

배포하기 전에 몇 가지 더 준비할 것이 있습니다. 먼저 앱의 루트 디렉토리에 elixir_buildpack.config 파일을 생성하고, 다음 설정을 입력해주세요.

엘릭서 버전을 명시하지 않을 경우 빌드팩에서는 2017년 2월 시점에서 엘릭서 1.3 버전을 기본적으로 사용합니다. 우리 앱은 엘릭서 1.4를 사용하고 있으므로 엘릭서 버전을 빌드팩에 명시해줘야 합니다. 그렇지 않으면 빌드에 실패합니다.

이어서 lib/timeconverter/router.ex 파일을 열고 허로쿠용 포트 설정을 추가해주세요.

허로쿠는 환경 변수 PORT를 통해서 앱이 사용할 포트를 지정해줍니다. System.get_env("PORT") 함수를 사용해서 지정된 포트 값을 받아와야 앱을 허로쿠에서 실행할 수 있습니다. get_port/0if문은 PORT 환경 변수가 없는 로컬 환경에서 앱을 실행할 때에도 포트 넘버가 지정되도록 해줍니다.

앱의 루트 디렉토리로 가서 heroku create --buildpack "https://github.com/HashNuke/heroku-buildpack-elixir.git"을 실행해서 빌드팩을 통해서 허로쿠 앱을 생성합니다.

스크립트가 허로쿠 앱을 만들고 heroku라는 깃 리모트 리포도 자동으로 설정할 것입니다. git push heroku master를 실행하면 앱이 허로쿠로 배포됩니다. heroku open을 실행해서 앱을 웹브라우저에서 열어보고 제대로 동작하는지 확인해보세요.