feat: docker build enhancements. (#37)

* feat: docker build enhancements.

* fix: refactored build

* fix: linting

Author: cofin

.dockerignore

@@ -3,3 +3,5 @@ venv
 node_modules
 __pycache__
 *.pyc
+dist/
+tmp/

.env.example

@@ -1,26 +1,11 @@
 
 LITESTAR_APP=app.asgi:create_app
 SECRET_KEY='secret-key'
-BUILD_NUMBER=0
-DEBUG=False
-DEV_MODE=false
-DEFAULT_PAGINATION_LIMIT=100
-ENVIRONMENT=local
-LOG_LEVEL=20
-NAME=Litestar Application
+ENVIRONMENT=docker
 OPENAPI_CONTACT_EMAIL=admin@app
 OPENAPI_CONTACT_NAME="Administrator"
 OPENAPI_TITLE="Reference Application for Litestar"
-OPENAPI_VERSION=1.0.0
 # Database
-DB_USER=app
-DB_PASSWORD=app
-DB_HOST=db
-DB_PORT=5432
-DB_NAME=app
-DB_ECHO=true
-DB_ECHO_POOL=true
-DB_POOL_DISABLE=false
 DB_POOL_MAX_OVERFLOW=10
 DB_POOL_SIZE=5
 DB_POOL_TIMEOUT=30

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.275"
+    rev: "v0.0.277"
     hooks:
       - id: ruff
         args: ["--fix"]
@@ -33,12 +33,12 @@ repos:
     rev: v0.3.0
     hooks:
       - id: ensure-dunder-all
-        exclude: "test*|examples*|tools"
+        exclude: "test*|examples*|tools|scripts"
   - repo: https://github.com/ariebovenberg/slotscheck
     rev: v0.16.5
     hooks:
       - id: slotscheck
-        exclude: "test_*|docs|migrations"
+        exclude: "test_*|docs|migrations|scripts"
         entry: env PYTHONPATH=src slotscheck
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v1.4.1"

Dockerfile

@@ -2,13 +2,9 @@
 .ONESHELL:
 ENV_PREFIX=$(shell python3 -c "if __import__('pathlib').Path('.venv/bin/pip').exists(): print('.venv/bin/')")
 USING_POETRY=$(shell grep "tool.poetry" pyproject.toml && echo "yes")
-USING_DOCKER=$(shell grep "USE_DOCKER=true" .env && echo "yes")
-USING_PNPM=$(shell python3 -c "if __import__('pathlib').Path('pnpm-lock.yaml').exists(): print('yes')")
-USING_YARN=$(shell python3 -c "if __import__('pathlib').Path('yarn.lock').exists(): print('yes')")
 USING_NPM=$(shell python3 -c "if __import__('pathlib').Path('package-lock.json').exists(): print('yes')")
 VENV_EXISTS=$(shell python3 -c "if __import__('pathlib').Path('.venv/bin/activate').exists(): print('yes')")
 NODE_MODULES_EXISTS=$(shell python3 -c "if __import__('pathlib').Path('node_modules').exists(): print('yes')")
-PYTHON_PACKAGES=$(shell if poetry --version > /dev/null; then poetry export -f requirements.txt  --without-hashes |cut -d'=' -f1 |cut -d ' ' -f1; fi)
 VERSION := $(shell grep -m 1 version pyproject.toml | tr -s ' ' | tr -d '"' | tr -d "'" | cut -d' ' -f3)
 SRC_DIR=src
 BUILD_DIR=dist
@@ -20,9 +16,6 @@ ifndef VERBOSE
 endif
 
 
-REPO_INFO ?= $(shell git config --get remote.origin.url)
-COMMIT_SHA ?= git-$(shell git rev-parse --short HEAD)
-
 help:  ## Display this help
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
@@ -32,8 +25,6 @@ upgrade:       ## Upgrade all dependencies to the latest stable versions
 	@if [ "$(USING_POETRY)" ]; then poetry update; fi
 	@echo "Python Dependencies Updated"
 	@if [ "$(USING_NPM)" ]; then npm upgrade --latest; fi
-	@if [ "$(USING_YARN)" ]; then yarn upgrade; fi
-	@if [ "$(USING_PNPM)" ]; then pnpm upgrade --latest; fi
 	@echo "Node Dependencies Updated"
 	$(ENV_PREFIX)pre-commit autoupdate
 	@echo "Updated Pre-commit"
@@ -44,10 +35,8 @@ install:          ## Install the project in dev mode.
 	@if [ "$(VENV_EXISTS)" ]; then echo "Removing existing virtual environment"; fi
 	@if [ "$(NODE_MODULES_EXISTS)" ]; then echo "Removing existing node environment"; fi
 	if [ "$(VENV_EXISTS)" ]; then rm -Rf .venv; fi
-	if [ "$(USING_POETRY)" ]; then poetry config virtualenvs.in-project true --local  && poetry config virtualenvs.options.always-copy true --local && python3 -m venv --copies .venv && source .venv/bin/activate && .venv/bin/pip install -U wheel setuptools cython pip && poetry install --with lint,dev,docs && mkdir -p {./src/app/domain/web/public,./src/app/domain/web/resources}; fi
-	if [ "$(USING_NPM)" ]; then npm ci && npm run build; fi
-	if [ "$(USING_YARN)" ]; then yarn install && yarn run build; fi
-	if [ "$(USING_PNPM)" ]; then pnpm install && pnpm run build; fi
+	if [ "$(USING_POETRY)" ]; then poetry config virtualenvs.in-project true --local  && poetry config virtualenvs.options.always-copy true --local && python3 -m venv --copies .venv && source .venv/bin/activate && .venv/bin/pip install -U wheel setuptools cython pip && poetry install --with lint,dev,docs; fi
+	if [ "$(USING_NPM)" ]; then npm ci; fi
 	@echo "=> Install complete.  ** If you want to re-install re-run 'make install'"
 
 
@@ -60,20 +49,20 @@ migrations:       ## Generate database migrations
 .PHONY: migrate
 migrate:          ## Generate database migrations
 	@echo "ATTENTION: Will apply all database migrations."
-	@env PYTHONPATH=src $(ENV_PREFIX)/app database upgrade-database
+	@env PYTHONPATH=src $(ENV_PREFIX)app database upgrade-database
 
 .PHONY: squash-migrations
 squash-migrations:       ## Generate database migrations
 	@echo "ATTENTION: This operation will wipe all migrations and recreate from an empty state."
 	@env PYTHONPATH=src $(ENV_PREFIX)app database purge-database --no-prompt
 	rm -Rf src/app/lib/db/migrations/versions/*.py
 	@while [ -z "$$MIGRATION_MESSAGE" ]; do read -r -p "Initial migration message: " MIGRATION_MESSAGE; done ;
-	@env PYTHONPATH=src $(ENV_PREFIX)/alembic -c src/app/lib/db/alembic.ini revision --autogenerate -m "$${MIGRATION_MESSAGE}"
+	@env PYTHONPATH=src $(ENV_PREFIX)alembic -c src/app/lib/db/alembic.ini revision --autogenerate -m "$${MIGRATION_MESSAGE}"
 
 
 .PHONY: build
 build:
-	if [ "$(USING_NPM)" ]; then npm run build; fi
+	@echo "=> Building package..."
 	if [ "$(USING_POETRY)" ]; then poetry build; fi
 
 .PHONY: test

Makefile

@@ -1,27 +1,54 @@
 version: "3.3"
+x-development-volumes: &development-volumes
+  volumes:
+    - ./docs:/workspace/app/docs/
+    - ./tests:/workspace/app/tests/
+    - ./src:/workspace/app/src/
+    - ./Makefile:/workspace/app/Makefile
+    - ./pyproject.toml:/workspace/app/pyproject.toml
+    - ./poetry.lock:/workspace/app/poetry.lock
+    - ./mkdocs.yml:/workspace/app/mkdocs.yml
+    - ./tsconfig.json:/workspace/app/tsconfig.json
+    - ./package.json:/workspace/app/package.json
+    - ./vite.config.ts:/workspace/app/vite.config.ts
 services:
+  localmail:
+    image: mailhog/mailhog:v1.0.0
+    container_name: localmail
+    ports:
+      - "8025:8025"
   app:
     build:
       context: .
-      target: build-image
-      dockerfile: ./Dockerfile
+      dockerfile: deploy/docker/dev/Dockerfile
       args:
         # remove this to build for production.
         POETRY_INSTALL_ARGS: --with=dev,docs,lint
-    ports:
-      - "8000:8000"
-    volumes:
-      - ./docs:/workspace/app/docs/
-      - ./tests:/workspace/app/tests/
-      - ./src:/workspace/app/src/
-      - ./Makefile:/workspace/app/Makefile
-      - ./pyproject.toml:/workspace/app/pyproject.toml
-      - ./poetry.lock:/workspace/app/poetry.lock
-      - ./mkdocs.yml:/workspace/app/mkdocs.yml
-    command: run-all --reload
-
-  localmail:
-    image: mailhog/mailhog:v1.0.0
-    container_name: localmail
-    ports:
-      - "8025:8025"
+    image: app:latest-dev
+    command: litestar run --reload
+    restart: always
+    <<: *development-volumes
+  worker:
+    image: app:latest-dev
+    command: litestar worker run
+    restart: always
+    <<: *development-volumes
+    depends_on:
+      db:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+    env_file:
+      - .env.example
+  migrator:
+    image: app:latest-dev
+    command: litestar database upgrade-database
+    restart: "no"
+    <<: *development-volumes
+    env_file:
+      - .env.example
+    depends_on:
+      db:
+        condition: service_healthy
+      cache:
+        condition: service_healthy

docker-compose.override.yml

@@ -51,7 +51,7 @@ services:
   app:
     build:
       context: .
-      dockerfile: Dockerfile
+      dockerfile: deploy/docker/run/Dockerfile
     image: app:latest
     restart: always
     depends_on:
@@ -63,14 +63,21 @@ services:
       - "8000:8000"
     env_file:
       - .env.example
-
+  worker:
+    image: app:latest
+    command: litestar worker run
+    restart: always
+    depends_on:
+      db:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+    env_file:
+      - .env.example
   migrator:
-    build:
-      context: .
-      dockerfile: Dockerfile
     image: app:latest
     restart: "no"
-    command: database upgrade-database
+    command: litestar database upgrade-database
     env_file:
       - .env.example
     depends_on: