今回Dockerを利用して、Node×PostgreSQL×Typescript環境を作るときの手順を解説します。私自身バックエンドエンジニアとしては初学者レベルですが学んだことのアウトプットとして記載したいと思います。主な開発環境としては以下となります。

ゴール

今回のゴールはDockerでNode環境、Postgres環境を作成し、http://localhost:3000を叩くと下記のような結果をPostgreSQLを通して取得できるところまでとなります。実際に開発する場合はセキュリティやDB設計、API設計などが重要になってくると思いますが、今回はその辺は特に記載しません。

[
  {
    "id": 1,
    "created_at": "2022-02-05T10:22:44.994Z",
    "updated_at": "2022-02-05T10:22:44.994Z",
    "email": "test@gmail.com",
    "password": "password"
  }
]

またフォルダ構成としては最終的に下記のような形になります。appフォルダ、initdbフォルダ、docker-compose.ymlファイルを作成しておきましょう。

.
├── app
│   ├── Dockerfile
│   ├── package.json
│   └── src
│       └── index.ts
├── docker-compose.yml
└── initdb
    └── setup.sql

Node環境の作成

次にnode環境を作るためにappフォルダに移動して、下記コマンドを打ちましょう。「-y」コマンドはnpm init時に出てくる質問に全てyesで回答するためのコマンドです。今回は特別設定することは無いので、-yをつけています。

cd app
npm init -y 

これでpackage.jsonが作られたと思いますので、次は必要なパッケージ類をインストールしましょう。
1行目のexpressはWebアプリケーションを作成するためのフレームワークで、pgはPostgreSQLを利用するためのライブラリとなります。また、2行目はTypescriptを利用するためのライブラリとなります。

npm install --save express pg 
npm install --save-dev typescript ts-node @types/express @types/node @types/pg

次にappフォルダ配下に、src/index.tsファイルを作成し、下記コードを記載しましょう。ある程度コードを見れば分かると思いますが、expressを利用して’/’にリクエストが来た際に、PostgreSQLのusersテーブルを読込、レスポンスとして返すシンプルなルーティングです。

import express from 'express'
import { Pool } from 'pg'
const app: express.Express = express()

const pool = new Pool({
  host: 'postgres',
  database: 'postgres_db',
  user: 'postgres',
  password: 'password',
  port: 5432
})

// ルーティングの設定
app.get('/', async (req, res) => {
  const { rows } = await pool.query('select * from users')
  return res.send(rows)
})

const PORT = 3000
app.listen(PORT, () => {
  console.log(`server started on port ${PORT}`)
})

最後にnodeを実行するために、package.jsonファイルのscriptsの部分に以下を付け足しましょう。これでTypescriptのnodeを実行できます。

"start": "npx ts-node ./src/index.ts"

Docker環境の作成

appフォルダと同じ階層に、docker-compose.ymlを作成したと思いますので、中身に下記を記載しましょう。構成としてはnode環境とpostgers環境を作るためのコードを記載しています。
ちなみに後にinitdb内にsqlファイルを作成しますが、docker-entrypoint-initdb.dという場所にsqlファイルを置くと初期設定時に自動でsqlを実行してくれます。

version: "3.7"
services:
  node:
    container_name: node_express
    build: ./app
    volumes:
      - ./app:/app
    tty:  true
    ports:
      - 3000:3000

  postgres:
    container_name: postgres
    image: postgres:13
    ports:
      - 5432:5432
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
      POSTGRES_DB: postgres_db
    volumes:
      - db_data:/var/lib/posrgresql/data
      - ./initdb:/docker-entrypoint-initdb.d

volumes:
  db_data: {}

次にappフォルダ内にDockerfileという名前のファイルを作成し、以下を記載しましょう。下記でdocker起動時に[npm run start]コマンドを実行し、nodeを実行するようにしています。

FROM node:14-slim
RUN npm install
WORKDIR /app
CMD ["npm", "run","start"]

初期DB設定

docker作成時にdb設定を行うため、initdbフォルダにsetup.sqlというファイルを作成しましょう。そしてその中に下記を記載しましょう。内容としてはシンプルで、usersテーブルを作成しサンプルとして1つINSERTを行っています。

set
    client_encoding = 'UTF8';

create table users(
    id serial primary key,
    created_at timestamp not null default current_timestamp,
    updated_at timestamp not null default current_timestamp,
    email text not null,
    password text not null
);

INSERT INTO
    users (email, password)
VALUES
    ('test@gmail.com', 'password');

実行してみる

最後に、docker-compose.ymlと同じ階層に戻り下記コマンドを打ちましょう。実行するとimageのダウンロードとdockerコンテナが起動します。

docker-compose up -d

無事に終わりましたら、ブラウザでhttp://localhost:3000を開くと下記が返されるようになったと思います。

[
  {
    "id": 1,
    "created_at": "2022-02-05T10:22:44.994Z",
    "updated_at": "2022-02-05T10:22:44.994Z",
    "email": "test@gmail.com",
    "password": "password"
  }
]

まとめ

Dockerやnodeもまだまだ経験不足でしたが、自在に使えるようになるとかなり便利だなと思いました。次はPrismaなどのORマッパーも利用してみたいと思います。

Dockerfile作成

　今回はSQSと互換性のある、ElasticMQというものを使ってSQSをローカルで実現します。下記のコードをDockerfileにコピペしてください。
　※最新のelasticmq-serverのバージョンが変わっているかもしれないので、変わっている場合はバージョンを変更してください。

GitHub - softwaremill/elasticmq: In-memory message queue with an Amazon SQS-compatible interface. Runs stand-alone or embedded.

In-memory message queue with an Amazon SQS-compatible interface. Runs stand-alone or embedded. - softwaremill/elasticmq

github.com

FROM java:8

ADD https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-1.2.0.jar /elasticmq/elasticmq-server-1.2.0.jar
EXPOSE 9324
ENTRYPOINT ["java","-jar","/elasticmq/elasticmq-server-1.2.0.jar"]

Dockerのビルド

　Dockerfileがあるディレクトリで、下記コマンドを叩きます。 [-t]はタグ名をつけるためのオプションなので、好きなものに変更して大丈夫です。

docker build -t sqs/elasticmq:1.2.0 .

　これで、Dockerの構築が終わったので、次からAWS SQSのCLIで確認していきます。

AWS SQSのコマンド実行

SQSの動作確認

　まず下記コマンドを叩いてみましょう。もし何も表示されなければ動作しているので問題ありません。

aws sqs list-queues --endpoint-url http://localhost:9324

　下記が表示されてしまっている場合は、AWSの公式を参考に[aws configure]で設定しましょう。

Configuring settings for the AWS CLI - AWS Command Line Interface

AWS CLI が AWS とやり取りするのに使用する設定を構成します。

docs.aws.amazon.com

You must specify a region. You can also configure your region by running "aws configure".

キューの作成

　キューの作成は[create-queue]で実行します。 キューの名前を[–queue-name]で設定するので、好きなものをつけてください。今回は[queue]という名前を設定しています。

aws sqs create-queue --queue-name queue --endpoint-url http://localhost:9324

　キューの作成に成功したら、QueueUrlが返されるので、こちらは後ほども使うので取っておきましょう。

{
    "QueueUrl": "http://localhost:9324/000000000000/queue"
}

メッセージの作成

　メッセージの作成は[send-message]コマンドで実行します。また、[–queue-url]には先ほどキューを作成したときのURLを代入しましょう。

aws sqs send-message --queue-url http://localhost:9324/000000000000/queue --message-body "123456789012345" --endpoint-url http://localhost:9324

　メッセージが作成されると下記のようなレスポンスが返ってきます

{
    "MD5OfMessageBody": "ad5222e305a2d133d529f038caa88e1a",
    "MessageId": "38a69463-55be-46ab-9e59-81357491a8df"
}

メッセージの取得

　メッセージの取得には[receive-message]コマンドを使います。

aws sqs receive-message --queue-url http://localhost:9324/000000000000/queue --endpoint-url http://localhost:9324

　レスポンスは下記のようになります。メッセージは配列で返されます。また、ReceiptHandleはメッセージを一意に特定するもので、メッセージの削除などにも利用されます。

{
    "Messages": [
        {
            "MessageId": "38a69463-55be-46ab-9e59-81357491a8df",
            "ReceiptHandle": "38a69463-55be-46ab-9e59-81357491a8df#83dc385b-9cf9-4d39-8312-5881d683d40c",
            "MD5OfBody": "ad5222e305a2d133d529f038caa88e1a",
            "Body": "123456789012345"
        }
    ]
}

　※SQSは可視性タイムアウトがデフォルトで30秒のため、一度取得したメッセージは30秒経つまで取得できないので、ご注意ください。

メッセージの削除

　メッセージの削除は[delete-message]コマンドを使います。[–receipt-handle]にメーセージのReceiptHandleを代入するとメッセージが削除できます。

aws sqs delete-message --queue-url http://localhost:9324/000000000000/queue --receipt-handle 38a69463-55be-46ab-9e59-81357491a8df#83dc385b-9cf9-4d39-8312-5881d683d40c --endpoint-url http://localhost:9324

　削除後のレスポンスはありません。

メッセージの可視性タイムアウトの変更

　メッセージの可視性タイムアウトを変更したい場合は、[change-message-visibility]コマンドを使います。[–visibility-timeout]に変更する値をいれましょう。

aws sqs change-message-visibility --queue-url http://localhost:9324/000000000000/queue --visibility-timeout 0 --receipt-handle 38a69463-55be-46ab-9e59-81357491a8df#83dc385b-9cf9-4d39-8312-5881d683d40c --endpoint-url http://localhost:9324

　削除後のレスポンスはありません。

キューのURLを忘れた場合

　キューのURLを忘れた場合は、[get-queue-url]を使います。[–queue-name]に知りたいキューの名前を入れます。

aws sqs get-queue-url --queue-name queue --endpoint-url http://localhost:9324

　レスポンスは下記のようになります。

{
    "QueueUrl": "http://localhost:9324/000000000000/queue"
}

queue を消したい場合

　キューを消したい場合は、[delete-queue]を使います。

aws sqs delete-queue --queue-url http://localhost:9324/000000000000/queue --endpoint-url http://localhost:9324

　削除後のレスポンスはありません。

queue の一覧を表示したい場合

　キューの一覧を表示したい場合は、[list-queues]コマンドを使います。

aws sqs list-queues --endpoint-url http://localhost:9324

　QueueUrlsの中に、配列でキューのURLの一覧が返されます。

{
    "QueueUrls": [
        "http://localhost:9324/000000000000/queue"
    ]
}

キューのattributeを取得したい時

　キューのattributeを取得したいときは、[get-queue-attributes]を使用します。

aws sqs get-queue-attributes --queue-url http://localhost:9324/000000000000/queue --attribute-names All --endpoint-url http://localhost:9324

{
    "Attributes": {
        "VisibilityTimeout": "30",
        "DelaySeconds": "0",
        "ReceiveMessageWaitTimeSeconds": "0",
        "ApproximateNumberOfMessages": "0",
        "ApproximateNumberOfMessagesNotVisible": "1",
        "ApproximateNumberOfMessagesDelayed": "0",
        "CreatedTimestamp": "1629253476",
        "LastModifiedTimestamp": "1629253476",
        "QueueArn": "arn:aws:sqs:elasticmq:000000000000:queue"
    }
}