Docker improvements (#620)

## Status

Ready for review

## What's changed?

- Bump docker postgres to v17
- Add a healthcheck to the db container and ensure the api depends on
that
- Move the bundle and node_moduels to volumes for easier installs,
automate install & db migrations via the entrypoints
- Add an example override and update docs for dev containers
- Force copilot to be installed to prevent corrupted state resulting in
error: `Cannot find module
'/root/.vscode-server/extensions/github.copilot-chat-0.33.1/dist/tikTokenizerWorker.js'`

## Steps to perform after deploying to production

- Run `docker compose down -v --remove-orphans` to remove the volumes
(especially postgres)
- Run `docker compose build` to upgrade postgres

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Upgrade to Postgres 17 with healthchecks, add persistent
bundle/node_modules volumes with automated installs via new entrypoints,
and enhance dev-container config and docs.
> 
> - **Docker/Compose**:
> - Upgrade database image to `postgres:17` and client to
`postgresql-client-17`.
>   - Add DB `healthcheck` and make `api` depend on healthy DB.
> - Mount `bundle-data` and `node_modules` as named volumes; add tmpfs
for `tmp/pids` and `tmp/cache`.
> - **Entrypoints**:
> - New `bin/docker-entrypoint.sh` and `bin/docker-debug-entrypoint.sh`
run in strict mode, auto-run `bundle install`/`yarn install`, prepare
DB, and start Rails (debug variant uses `rdbg`).
> - **Dev Container**:
> - Add GitHub Copilot extensions in `.devcontainer/devcontainer.json`.
> - Provide `.devcontainer/docker-compose.yml` override and
`docker-compose.override.yml.example` for using the `dev-container`
target.
> - **Docs**:
> - Update `README.md` with dev-container usage and gem install
guidance.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
565e417. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Adrian Lansdown <adrian.lansdown@raspberrypi.org>

Author: danhalson

.devcontainer/devcontainer.json

@@ -67,7 +67,9 @@
         "shopify.ruby-lsp",
         "koichisasada.vscode-rdbg",
         "postman.postman-for-vscode",
-        "ninoseki.vscode-mogami"
+        "ninoseki.vscode-mogami",
+        "GitHub.copilot",
+        "GitHub.copilot-chat"
       ],
       "settings": {
         "terminal.integrated.defaultProfile.linux": "zsh",
@@ -79,7 +81,7 @@
         }
       }
     }
-  }
+  },
 
   // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
   // "remoteUser": "devcontainer"

Dockerfile

@@ -1,14 +1,15 @@
-FROM ruby:3.2-slim-bullseye as base
+FROM ruby:3.2-slim-bullseye AS base
 RUN gem install bundler \
   && apt-get update \
   && apt-get upgrade --yes \
   && apt-get install --yes --no-install-recommends \
   libpq5 libxml2 libxslt1.1 libvips \
   curl gnupg graphviz nodejs \
-  && echo "deb http://apt.postgresql.org/pub/repos/apt bullseye-pgdg main" > /etc/apt/sources.list.d/pgdg.list \
-  && curl -sL https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - \
+  && mkdir -p /usr/share/keyrings \
+  && curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor -o /usr/share/keyrings/postgresql-archive-keyring.gpg \
+  && echo "deb [signed-by=/usr/share/keyrings/postgresql-archive-keyring.gpg] http://apt.postgresql.org/pub/repos/apt bullseye-pgdg main" > /etc/apt/sources.list.d/pgdg.list \
   && apt-get update \
-  && apt-get install --yes --no-install-recommends postgresql-client-15 \
+  && apt-get install --yes --no-install-recommends postgresql-client-17 \
   && rm -rf /var/lib/apt/lists/* /var/lib/apt/archives/*.deb
 ENV TZ='Europe/London'
 ENV RUBYOPT='-W:no-deprecated -W:no-experimental'
@@ -31,11 +32,11 @@ FROM builder AS dev-container
 RUN apt-get update \
   && apt-get install --yes --no-install-recommends sudo git vim zsh ssh curl less
 RUN sh -c "$(curl -L https://github.com/deluan/zsh-in-docker/releases/download/v1.1.5/zsh-in-docker.sh)" -- \
-    -t robbyrussell \
-    -p git -p docker-compose -p yarn \
-    -p https://github.com/zsh-users/zsh-autosuggestions \
-    # -p https://github.com/marlonrichert/zsh-autocomplete \
-    -p https://github.com/unixorn/fzf-zsh-plugin
+  -t robbyrussell \
+  -p git -p docker-compose -p yarn \
+  -p https://github.com/zsh-users/zsh-autosuggestions \
+  # -p https://github.com/marlonrichert/zsh-autocomplete \
+  -p https://github.com/unixorn/fzf-zsh-plugin
 RUN chsh -s $(which zsh) ${USER}
 
 # Slim application image without development dependencies

README.md

@@ -33,15 +33,48 @@ Start the application and its dependencies via docker:
 docker-compose up
 ```
 
+### Using the dev-container
+
+There is a dedicated image called `dev-container`, and the easiest way to use this is to use the override:
+
+`cp docker-compose.override.yml.example docker-compose.override.yml`
+
+Now when you run `docker compose up -d` it will always use the `dev-container` image.
+
+When adding a vscode project the dev-container should be automatically found and a dialog will show asking if
+you want to use this, but failing that you can open the cmd palette with `cmd + shift + p` and call:
+
+`Dev Containers: Reopen in Container`
+
+If there's an issue, do check the logs, but you can run:
+
+`Dev Containers: Rebuild and Reopen in Container`
+
+and there's also a 'without cache' variant, to ensure packages are re-built.
+
 #### Updating gems inside the container
 
-This can be done with the `bin/with-builder.sh` script:
+If running inside a dev-container:
+
+```
+bundle install
+```
+
+or outside with:
+
+```
+docker compose run --rm --no-deps api bundle install
+```
+
+This can also be done with the `bin/with-builder.sh` script:
 
 ```
 ./bin/with-builder.sh bundle update
 ```
 
-which should update the Gems in the container, without the need for rebuilding.
+which should update the Gems in the container.
+
+None of these methods require rebuilding.
 
 ### Seeding
 

bin/docker-debug-entrypoint.sh

@@ -1,4 +1,15 @@
 #!/bin/bash
+set -euo pipefail # Use strict-mode in based to ensure errors are surfaced early
 
-rails db:prepare
-rdbg -n -o -c -- bin/rails s -p 3009 -b '0.0.0.0'
+# Check if bundle install needs to be run
+bundle check >/dev/null 2>&1 || bundle install --jobs "${BUNDLE_JOBS:-4}"
+
+# Check if yarn install needs to be run
+if [ -f package.json ] && command -v yarn >/dev/null 2>&1; then
+	yarn install --check-files --frozen-lockfile || yarn install --check-files
+fi
+
+# Prepare the database
+bundle exec rails db:prepare
+
+exec rdbg -n -o -c -- bundle exec rails s -p 3009 -b '0.0.0.0'

bin/docker-entrypoint.sh

@@ -1,4 +1,15 @@
 #!/bin/bash
+set -euo pipefail # Use strict-mode in based to ensure errors are surfaced early
 
-rails db:prepare
-rails server --port 3009 --binding 0.0.0.0
+# Check if bundle install needs to be run
+bundle check >/dev/null 2>&1 || bundle install --jobs "${BUNDLE_JOBS:-4}"
+
+# Check if yarn install needs to be run
+if [ -f package.json ] && command -v yarn >/dev/null 2>&1; then
+	yarn install --check-files --frozen-lockfile || yarn install --check-files
+fi
+
+# Prepare the database
+bundle exec rails db:prepare
+
+exec bundle exec rails server --port 3009 --binding 0.0.0.0

docker-compose.override.yml.example

@@ -0,0 +1,14 @@
+services:
+  api:
+    build:
+      context: .
+      target: dev-container
+    command: bash bin/docker-debug-entrypoint.sh
+    volumes:
+      # - ${HOME}/.bashrc:/root/.bashrc:ro # Map a ~/.bashrc in your home directory for customising bash
+      - ${HOME}/.ssh:/root/.ssh:ro # To share any ssh keys with the container
+      - /var/run/docker.sock:/var/run/docker.sock
+      - node_modules:/app/node_modules
+
+volumes:
+  node_modules: null

docker-compose.yml

@@ -1,10 +1,16 @@
 services:
   db:
-    image: postgres:14
+    image: postgres:17
     environment:
       - POSTGRES_DB
       - POSTGRES_PASSWORD
       - POSTGRES_USER
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-postgres}"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+      start_period: 5s
     ports:
       - "5434:5432"
     volumes:
@@ -16,9 +22,12 @@ services:
       target: builder
     image: editor-api:builder
     depends_on:
-      - db
+      db:
+        condition: service_healthy
     volumes:
       - .:/app
+      - bundle-data:/usr/local/bundle
+      - node_modules:/app/node_modules
       # This is here to avoid rails finding stale pid-files in tmp/pids and then
       # thinking it is already running:
       - type: tmpfs
@@ -46,3 +55,5 @@ services:
 
 volumes:
   postgres-data:
+  bundle-data:
+  node_modules: