fix: address review comments
CI / verify (pull_request) Successful in 4m16s

This commit is contained in:
2026-09-25 11:46:02 +03:00
parent 09779a53ae
commit 6d5ac9e81d
26 changed files with 683 additions and 666 deletions
+11 -13
View File
@@ -4,7 +4,7 @@ on:
pull_request:
branches: [main]
push:
branches: [main, solution/bvt2303-plastinin]
branches: [main]
workflow_dispatch:
concurrency:
@@ -16,8 +16,11 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 20
env:
COMPOSE_FILE: compose.ci.yaml
COMPOSE_PROJECT_NAME: mtusi2026lab2-${{ github.run_id }}
API_BIND_ADDRESS: 127.0.0.1:0
SWAGGER_BIND_ADDRESS: 127.0.0.1:0
PROMETHEUS_BIND_ADDRESS: 127.0.0.1:0
GRAFANA_BIND_ADDRESS: 127.0.0.1:0
steps:
- name: Checkout exact commit
run: |
@@ -64,17 +67,12 @@ jobs:
docker network connect "$network" "$HOSTNAME"
printf '%s\n' "$network" > .ci-network
- name: Public smoke
run: make test BASE_URL=http://api:8080
- name: PostgreSQL and Valkey integration tests
run: docker compose --profile tests run --rm --build tests
- name: Dependency outage recovery
run: go run ./cmd/dependencycheck -base-url=http://api:8080
- name: Persistence test
run: make test-persistence ACTION_SCRIPT=scripts/restart.sh BASE_URL=http://api:8080
- name: Integration checks
run: |
make test BASE_URL=http://api:8080
docker compose --profile tests run --rm --build tests
go run ./cmd/dependencycheck -base-url=http://api:8080
make test-persistence ACTION_SCRIPT=scripts/restart.sh BASE_URL=http://api:8080
- name: Container logs
if: failure()
+25 -117
View File
@@ -1,11 +1,8 @@
name: Deploy production
on:
workflow_dispatch:
inputs:
confirmation:
description: Type DEPLOY to release main
required: true
push:
branches: [main]
concurrency:
group: production
@@ -13,120 +10,31 @@ concurrency:
jobs:
deploy:
if: github.ref == 'refs/heads/main' && inputs.confirmation == 'DEPLOY'
name: Deploy to server
runs-on: ubuntu-latest
timeout-minutes: 20
env:
COMPOSE_FILE: compose.ci.yaml
COMPOSE_PROJECT_NAME: mtusi2026lab2-${{ github.run_id }}
steps:
- name: Checkout exact commit
run: |
git init .
git remote add origin https://gitea.privcloud.tech/${{ github.repository }}.git
git fetch --depth=1 origin ${{ github.sha }}
git checkout --detach FETCH_HEAD
- uses: actions/setup-go@v5
- name: Deploy
uses: appleboy/ssh-action@master
with:
go-version-file: go.mod
cache: false
host: ${{ secrets.DEPLOY_HOST }}
username: ${{ secrets.DEPLOY_USER }}
key: ${{ secrets.DEPLOY_SSH_KEY }}
script: |
cd ~/mtusi2026lab2
git fetch origin main
git reset --hard origin/main
git clean -fd
docker compose down
docker compose build
docker compose up -d --wait --wait-timeout 120
- name: Verify release
run: |
make check
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements-dev.txt
make validate PYTHON=.venv/bin/python
test -z "$(gofmt -l cmd internal migrations)"
go test -race ./...
go build ./cmd/messenger
- name: Lint
uses: golangci/golangci-lint-action@v7
- name: Verify deployment
uses: appleboy/ssh-action@master
with:
version: v2.13.2
args: --timeout=5m
skip-cache: true
- name: Verify release stack
run: |
cp lab2.env.example .env
docker compose up -d --build --wait --wait-timeout 120
network=$(docker inspect --format '{{range $name, $_ := .NetworkSettings.Networks}}{{$name}}{{end}}' "$(docker compose ps -q api)")
docker network connect "$network" "$HOSTNAME"
printf '%s\n' "$network" > .ci-network
make test BASE_URL=http://api:8080
docker compose --profile tests run --rm --build tests
go run ./cmd/dependencycheck -base-url=http://api:8080
make test-persistence ACTION_SCRIPT=scripts/restart.sh BASE_URL=http://api:8080
- name: Stop release stack
if: always()
run: |
if [ -f .ci-network ]; then docker network disconnect "$(cat .ci-network)" "$HOSTNAME"; fi
if [ -f .env ]; then docker compose --profile tests down -v --remove-orphans; fi
- name: Configure SSH
run: |
install -d -m 700 ~/.ssh
printf '%s\n' '${{ secrets.DEPLOY_SSH_KEY }}' > ~/.ssh/id_ed25519
chmod 600 ~/.ssh/id_ed25519
printf '%s\n' '${{ secrets.DEPLOY_KNOWN_HOSTS }}' > ~/.ssh/known_hosts
- name: Pack release
run: tar --exclude=.git --exclude=.env --exclude=secrets --exclude=.venv -czf /tmp/mtusi-lab2-${{ github.sha }}.tar.gz .
- name: Upload release
run: scp /tmp/mtusi-lab2-${{ github.sha }}.tar.gz '${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}:/tmp/'
- name: Deploy exact commit
env:
DEPLOY_HOST: ${{ secrets.DEPLOY_HOST }}
DEPLOY_USER: ${{ secrets.DEPLOY_USER }}
RELEASE_SHA: ${{ github.sha }}
RELEASE_ATTEMPT: ${{ github.run_attempt }}
run: |
ssh "$DEPLOY_USER@$DEPLOY_HOST" sh -s -- "$RELEASE_SHA" "$RELEASE_ATTEMPT" <<'REMOTE'
set -eu
release_sha=$1
release_attempt=$2
deploy_root=/opt/mtusi-lab2
release_dir=$deploy_root/releases/$release_sha-$release_attempt
archive=/tmp/mtusi-lab2-$release_sha.tar.gz
mkdir -p "$deploy_root/releases" "$deploy_root/shared/backups"
exec 9>"$deploy_root/deploy.lock"
flock -x 9
previous=
previous_image=
if [ -L "$deploy_root/current" ]; then
previous=$(basename "$(readlink "$deploy_root/current")")
previous_image=$(cat "$deploy_root/current/.release-sha")
cd "$deploy_root/current"
docker compose -p mtusi-lab2 exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
pg_dump --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" --format custom
' > "$deploy_root/shared/backups/pre-$release_sha.dump"
fi
mkdir -p "$release_dir"
tar -xzf "$archive" -C "$release_dir"
printf '%s\n' "$release_sha" > "$release_dir/.release-sha"
ln -s "$deploy_root/shared/.env" "$release_dir/.env"
ln -s "$deploy_root/shared/secrets" "$release_dir/secrets"
cd "$release_dir"
if ! API_IMAGE="mtusi-messenger:$release_sha" docker compose -p mtusi-lab2 up -d --build --wait --wait-timeout 120; then
if [ -n "$previous" ]; then
cd "$deploy_root/releases/$previous"
API_IMAGE="mtusi-messenger:$previous_image" docker compose -p mtusi-lab2 up -d --wait --wait-timeout 120
fi
exit 1
fi
ln -sfn "$release_dir" "$deploy_root/current"
rm -f "$archive"
REMOTE
host: ${{ secrets.DEPLOY_HOST }}
username: ${{ secrets.DEPLOY_USER }}
key: ${{ secrets.DEPLOY_SSH_KEY }}
script: |
cd ~/mtusi2026lab2
git log --oneline -3
docker compose ps
+14
View File
@@ -12,6 +12,20 @@ FROM build AS experiment
CMD ["go", "run", "./cmd/lab2experiment"]
FROM swaggerapi/swagger-ui:v5.31.2 AS swagger
COPY contracts/openapi.json /spec/openapi.json
ENV SWAGGER_JSON=/spec/openapi.json
FROM prom/prometheus:v3.13.3 AS prometheus
COPY monitoring/prometheus.yml /etc/prometheus/prometheus.yml
FROM grafana/grafana:13.1.6 AS grafana
COPY monitoring/grafana/provisioning /etc/grafana/provisioning
COPY monitoring/grafana/dashboards /etc/grafana/dashboards
FROM alpine:3.24.2
RUN addgroup -S app && adduser -S -G app -u 10001 app
+43 -17
View File
@@ -3,9 +3,8 @@
- Автор, группа: Пластинин Денис, БВТ2303
- Целевая оценка: 5; трек 2 «План запроса и восстановление»
- Ветка: `solution/bvt2303-plastinin`; ссылка на PR указывается при публикации
- Основные библиотеки: pgx v5, valkey-go, x/crypto/argon2, Prometheus client_golang
- Основные библиотеки: pgx v5, valkey-go, Viper, x/crypto/argon2, Prometheus client_golang
- Источники: документация PostgreSQL по [транзакциям](https://www.postgresql.org/docs/current/tutorial-transactions.html) и [EXPLAIN](https://www.postgresql.org/docs/current/using-explain.html), документация [Valkey persistence](https://valkey.io/topics/persistence/), [RFC 7617](https://www.rfc-editor.org/info/rfc7617/)
- Помощь ИИ: применялась для анализа задания и проверки реализации; команды и наблюдаемые результаты проверены локально
## Запуск из чистого clone
@@ -13,7 +12,6 @@
```sh
cp lab2.env.example .env
./scripts/init-local-secrets.sh
docker compose config --quiet
docker compose up -d --build --wait --wait-timeout 120
make test
@@ -28,24 +26,18 @@ API доступен на `http://localhost:8080`, Swagger UI — на `http://l
docker compose --profile tests run --rm --build tests
```
Мониторинг не входит в обязательный путь запуска и включается явно:
```sh
docker compose --profile monitoring up -d
```
После запуска Prometheus доступен на `http://localhost:9090`, Grafana — на `http://localhost:3000`. Пользователь Grafana — `admin`, пароль хранится только в `secrets/grafana_admin_password`. Дашборд `Highload / Messenger overview` создаётся автоматически.
Основной Compose одновременно запускает API, PostgreSQL, Valkey, Swagger UI, exporters, Prometheus и Grafana. Prometheus доступен на `http://localhost:9090`, Grafana — на `http://localhost:3000`. Пользователь Grafana — `admin`, пароль задаётся в локальном `.env`. Дашборд `Highload / Messenger overview` создаётся автоматически.
Безопасная остановка сохраняет именованные volumes:
```sh
docker compose --profile monitoring down
docker compose down
```
Намеренное удаление всех локальных учебных данных выполняется отдельно:
```sh
docker compose --profile monitoring down -v
docker compose down -v
```
## Архитектура и решения
@@ -62,6 +54,40 @@ flowchart LR
G[Grafana] --> M
```
Схема базы данных:
```mermaid
erDiagram
users ||--o{ chat_members : participates
chats ||--|{ chat_members : contains
chat_members ||--o{ messages : allows_sender
users {
uuid id PK
text username UK
text display_name
text password_hash
timestamptz created_at
}
chats {
uuid id PK
text title
timestamptz created_at
}
chat_members {
uuid chat_id PK,FK
uuid user_id PK,FK
smallint position
}
messages {
uuid id PK
uuid chat_id FK
uuid sender_id FK
text text
timestamptz created_at
}
```
PostgreSQL является источником истины для пользователей, чатов, участников и сообщений. Внешние ключи не позволяют сообщению ссылаться на отсутствующий чат, пользователя вне чата или удалённое членство. `username` защищён уникальным ограничением базы, поэтому конкурентные запросы не могут создать дубликаты.
Valkey хранит только сессии. Клиент получает 32 случайных байта в виде opaque Base64URL-токена, а в ключе Valkey используется SHA-256 токена. Значение содержит ID пользователя и срок действия. На ключ устанавливается TTL; logout удаляет ключ. Включены AOF и `appendfsync everysec`, поэтому штатный перезапуск сохраняет сессии. При аварийной остановке граница потери последних изменений AOF составляет примерно одну секунду.
@@ -72,7 +98,7 @@ Valkey хранит только сессии. Клиент получает 32
История сообщений использует keyset pagination по `(created_at, id)`. Cursor содержит позицию последней строки, тип ресурса и область чата; сервер проверяет его целостность и принадлежность текущему запросу. Запрос использует индекс `(chat_id, created_at, id)` и не пересчитывает полный offset для каждой страницы.
Преподавательский `.env.example` сохранён без изменений. Рабочее соответствие параметров находится в `lab2.env.example`: `SESSION_STORE=valkey`, пути Docker secrets задаются Compose, `SESSION_TTL_SECONDS` задаёт срок сессии, `DB_MIN_CONNS`/`DB_MAX_CONNS` ограничивают пул, `DEPENDENCY_TIMEOUT_SECONDS` ограничивает подключение и каждую операцию с зависимостями.
Преподавательский `.env.example` сохранён без изменений. Рабочие параметры находятся в `lab2.env.example`; каждое поле снабжено пояснением. Viper читает настройки из окружения и завершает запуск с ошибкой, если обязательного значения нет. В репозитории находятся только учебные значения, а серверный `.env` хранится вне Git.
## Доказательства критериев
@@ -131,11 +157,11 @@ Valkey хранит только сессии. Клиент получает 32
## CI/CD и мониторинг
`.gitea/workflows/ci.yml` запускается для PR в `main`, push в solution/main и вручную. Он проверяет контракт, OpenAPI, форматирование, golangci-lint, race unit-тесты, сборку, public smoke, реальные PostgreSQL/Valkey integration-тесты и persistence.
`.gitea/workflows/ci.yml` запускается для PR в `main`, push в `main` и вручную. Он проверяет контракт, OpenAPI, форматирование, golangci-lint, race unit-тесты, сборку, public smoke, реальные PostgreSQL/Valkey integration-тесты и persistence.
Production deployment вынесен в `.gitea/workflows/deploy.yml`. Gitea 1.27 не поддерживает обязательное подтверждение environment, поэтому подтверждением служит ручной `workflow_dispatch` со строкой `DEPLOY`. Workflow разрешает только ветку `main` и для exact SHA повторяет OpenAPI, lint, race, smoke, integration, реальный dependency outage и persistence. После зелёных проверок он делает backup, создаёт release-каталог по SHA и номеру попытки и выполняет health check. Для включения требуются repository secrets `DEPLOY_HOST`, `DEPLOY_USER`, `DEPLOY_SSH_KEY`, `DEPLOY_KNOWN_HOSTS`; на сервере заранее создаются `/opt/mtusi-lab2/shared/.env` и `/opt/mtusi-lab2/shared/secrets`.
`.gitea/workflows/deploy.yml` запускается после push в защищённую ветку `main`. Через `appleboy/ssh-action` он обновляет серверный clone до `origin/main`, пересобирает единый Compose-стек и выводит состояние контейнеров. Для запуска требуются repository secrets `DEPLOY_HOST`, `DEPLOY_USER`, `DEPLOY_SSH_KEY`; на сервере заранее создаются каталог `~/mtusi2026lab2` и локальный `.env` с рабочими паролями.
Профиль monitoring собирает метрики без пользовательских ID и raw URL в labels. Дашборд содержит RPS, классы HTTP-ответов, p95, in-flight, Go heap, соединения и транзакции PostgreSQL, размер БД, память, ключи и команды Valkey. Мониторинг не участвует в readiness приложения.
Мониторинг собирает метрики без пользовательских ID и raw URL в labels. Дашборд содержит RPS, классы HTTP-ответов, p95, in-flight, Go heap, соединения и транзакции PostgreSQL, размер БД, память, ключи и команды Valkey. Мониторинг не участвует в readiness приложения.
## Ограничения и следующие шаги
@@ -143,7 +169,7 @@ Production deployment вынесен в `.gitea/workflows/deploy.yml`. Gitea 1.2
- Локальный HTTP не шифруется. На сервере Basic и Bearer должны передаваться только через TLS reverse proxy; это будет частью эксплуатационной защиты последующих лабораторных.
- Valkey AOF `everysec` сохраняет сессии при штатном рестарте, но допускает потерю примерно последней секунды при аварии процесса или узла.
- PostgreSQL `COMMIT` подтверждает фиксацию согласно `synchronous_commit`, `fsync` и надёжности диска. Он не заменяет внешние backup и репликацию.
- Exporters в локальном профиле используют учебные credentials сервисов. Для production следует создать отдельного пользователя PostgreSQL с ролью `pg_monitor` и ограничить сетевой доступ к Prometheus/Grafana.
- Exporters в локальном Compose используют учебные credentials сервисов. Для production следует создать отдельного пользователя PostgreSQL с ролью `pg_monitor` и ограничить сетевой доступ к Prometheus/Grafana.
- Эксперимент измеряет один запрос и короткие локальные серии. Для production нужны длительные прогоны, несколько объёмов данных, холодный cache, конкурентное чтение и запись.
## Ответы на вопросы защиты
+4 -5
View File
@@ -54,7 +54,7 @@ func main() {
}
func run() error {
urlFile := flag.String("database-url-file", "secrets/database_url", "file containing the PostgreSQL URL")
databaseURL := flag.String("database-url", os.Getenv("DATABASE_URL"), "PostgreSQL URL")
output := flag.String("output", "evidence/lab2-track2.json", "result JSON path")
messages := flag.Int("messages", 100000, "number of messages")
writeRows := flag.Int("write-rows", 10000, "rows per write test")
@@ -66,11 +66,10 @@ func run() error {
return fmt.Errorf("write-rows must be at least 1000")
}
data, err := os.ReadFile(*urlFile)
if err != nil {
return fmt.Errorf("read database URL: %w", err)
if strings.TrimSpace(*databaseURL) == "" {
return fmt.Errorf("database URL is required")
}
pool, err := pgxpool.New(context.Background(), strings.TrimSpace(string(data)))
pool, err := pgxpool.New(context.Background(), strings.TrimSpace(*databaseURL))
if err != nil {
return fmt.Errorf("open database: %w", err)
}
+21 -13
View File
@@ -8,10 +8,10 @@ import (
"os"
"os/signal"
"syscall"
"time"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/config"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/database"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/logger"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/messenger"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/password"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/postgres"
@@ -19,9 +19,9 @@ import (
)
func main() {
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
if err := run(logger); err != nil {
logger.Error("server stopped", "error", err)
appLogger := logger.New()
if err := run(appLogger); err != nil {
appLogger.Error("server stopped", "error", err)
os.Exit(1)
}
}
@@ -33,9 +33,9 @@ func run(logger *slog.Logger) error {
}
pool, err := database.Open(context.Background(), database.Config{
URL: settings.DatabaseURL, MinConnections: settings.DBMinConns, MaxConnections: settings.DBMaxConns,
MaxConnectionAge: 30 * time.Minute, MaxConnectionIdle: 5 * time.Minute,
HealthCheckPeriod: 30 * time.Second, ConnectTimeout: settings.ConnectTimeout,
MigrationTimeout: 30 * time.Second,
MaxConnectionAge: settings.DBMaxConnectionAge, MaxConnectionIdle: settings.DBMaxConnectionIdle,
HealthCheckPeriod: settings.DBHealthCheckPeriod, ConnectTimeout: settings.DependencyTimeout,
MigrationTimeout: settings.MigrationTimeout,
})
if err != nil {
return err
@@ -46,11 +46,19 @@ func run(logger *slog.Logger) error {
return err
}
defer func() { _ = sessions.Close() }()
passwords, err := password.New(password.Config{
MemoryKiB: settings.PasswordMemoryKiB, Iterations: settings.PasswordIterations,
Parallelism: settings.PasswordParallelism, SaltLength: settings.PasswordSaltLength,
KeyLength: settings.PasswordKeyLength,
})
if err != nil {
return err
}
app := messenger.NewServer(
logger,
postgres.New(pool),
sessions,
password.Hasher{},
passwords,
settings.SessionTTL,
settings.RequestTimeout,
settings.SwaggerPort,
@@ -58,10 +66,10 @@ func run(logger *slog.Logger) error {
server := &http.Server{
Addr: settings.Address,
Handler: app.Handler(),
ReadHeaderTimeout: 5 * time.Second,
ReadTimeout: 10 * time.Second,
WriteTimeout: settings.RequestTimeout + 5*time.Second,
IdleTimeout: 60 * time.Second,
ReadHeaderTimeout: settings.HTTPReadHeaderTimeout,
ReadTimeout: settings.HTTPReadTimeout,
WriteTimeout: settings.HTTPWriteTimeout,
IdleTimeout: settings.HTTPIdleTimeout,
}
listener, err := net.Listen("tcp", server.Addr)
if err != nil {
@@ -80,7 +88,7 @@ func run(logger *slog.Logger) error {
case <-ctx.Done():
logger.Info("shutdown requested")
app.SetReady(false)
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
shutdownCtx, cancel := context.WithTimeout(context.Background(), settings.HTTPShutdownTimeout)
defer cancel()
if err := server.Shutdown(shutdownCtx); err != nil {
_ = server.Close()
-28
View File
@@ -1,28 +0,0 @@
package main
import (
"strings"
"testing"
)
func TestRunRequiresAddress(t *testing.T) {
tests := []struct {
name string
host string
port string
want string
}{
{name: "missing host", port: "8080", want: "APP_HOST is required"},
{name: "missing port", host: "127.0.0.1", want: "APP_PORT is required"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Setenv("APP_HOST", tt.host)
t.Setenv("APP_PORT", tt.port)
if err := run(nil); err == nil || !strings.Contains(err.Error(), tt.want) {
t.Fatalf("run() error = %v, want %q", err, tt.want)
}
})
}
}
-63
View File
@@ -1,63 +0,0 @@
services:
postgres:
image: postgres:17.6-alpine3.22
environment:
POSTGRES_USER: messenger
POSTGRES_DB: messenger
POSTGRES_PASSWORD: ci-postgres-password
volumes:
- postgres_data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U messenger -d messenger"]
interval: 5s
timeout: 3s
retries: 20
valkey:
image: valkey/valkey:8.1.4-alpine
command: ["valkey-server", "--appendonly", "yes", "--appendfsync", "everysec", "--requirepass", "ci-valkey-password"]
volumes:
- valkey_data:/data
healthcheck:
test: ["CMD", "valkey-cli", "--no-auth-warning", "-a", "ci-valkey-password", "ping"]
interval: 5s
timeout: 3s
retries: 20
api:
build: .
env_file: .env
entrypoint: ["/bin/sh", "-eu", "-c"]
command:
- |
printf '%s' "$$DATABASE_URL" > /tmp/database_url
printf '%s' "$$CACHE_URL" > /tmp/cache_url
exec /app/messenger
environment:
DATABASE_URL: postgres://messenger:ci-postgres-password@postgres:5432/messenger?sslmode=disable
DATABASE_URL_FILE: /tmp/database_url
CACHE_URL: redis://default:ci-valkey-password@valkey:6379/0
CACHE_URL_FILE: /tmp/cache_url
depends_on:
postgres:
condition: service_healthy
valkey:
condition: service_healthy
tests:
profiles: ["tests"]
build:
context: .
target: test
environment:
TEST_DATABASE_URL: postgres://messenger:ci-postgres-password@postgres:5432/messenger?sslmode=disable
TEST_CACHE_URL: redis://default:ci-valkey-password@valkey:6379/0
depends_on:
postgres:
condition: service_healthy
valkey:
condition: service_healthy
volumes:
postgres_data:
valkey_data:
+28 -70
View File
@@ -4,9 +4,7 @@ services:
environment:
POSTGRES_USER: ${POSTGRES_USER}
POSTGRES_DB: ${POSTGRES_DB}
POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password
secrets:
- postgres_password
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
volumes:
- postgres_data:/var/lib/postgresql/data
healthcheck:
@@ -20,16 +18,13 @@ services:
valkey:
image: valkey/valkey:8.1.4-alpine
command:
- sh
- -c
- exec valkey-server --appendonly yes --appendfsync everysec --requirepass "$$(cat /run/secrets/valkey_password)"
secrets:
- valkey_password
command: ["valkey-server", "--appendonly", "yes", "--appendfsync", "everysec", "--requirepass", "${VALKEY_PASSWORD}"]
environment:
VALKEY_PASSWORD: ${VALKEY_PASSWORD}
volumes:
- valkey_data:/data
healthcheck:
test: ["CMD-SHELL", "valkey-cli --no-auth-warning -a \"$$(cat /run/secrets/valkey_password)\" ping | grep -q PONG"]
test: ["CMD-SHELL", "valkey-cli --no-auth-warning -a \"$$VALKEY_PASSWORD\" ping | grep -q PONG"]
interval: 5s
timeout: 3s
retries: 20
@@ -41,14 +36,8 @@ services:
build: .
image: ${API_IMAGE:-mtusi-messenger:lab2}
env_file: .env
environment:
DATABASE_URL_FILE: /run/secrets/database_url
CACHE_URL_FILE: /run/secrets/cache_url
secrets:
- database_url
- cache_url
ports:
- "127.0.0.1:8080:${APP_PORT}"
- "${API_BIND_ADDRESS}:${APP_PORT}"
depends_on:
postgres:
condition: service_healthy
@@ -60,13 +49,11 @@ services:
restart: unless-stopped
swagger:
image: swaggerapi/swagger-ui:v5.31.2
environment:
SWAGGER_JSON: /spec/openapi.json
volumes:
- ./contracts/openapi.json:/spec/openapi.json:ro
build:
context: .
target: swagger
ports:
- "127.0.0.1:${SWAGGER_PORT}:8080"
- "${SWAGGER_BIND_ADDRESS}:8080"
depends_on:
api:
condition: service_healthy
@@ -78,11 +65,8 @@ services:
context: .
target: test
environment:
TEST_DATABASE_URL_FILE: /run/secrets/database_url
TEST_CACHE_URL_FILE: /run/secrets/cache_url
secrets:
- database_url
- cache_url
TEST_DATABASE_URL: ${DATABASE_URL}
TEST_CACHE_URL: ${CACHE_URL}
depends_on:
postgres:
condition: service_healthy
@@ -94,14 +78,8 @@ services:
build:
context: .
target: experiment
command:
- go
- run
- ./cmd/lab2experiment
- -database-url-file=/run/secrets/database_url
- -output=/output/lab2-track2.json
secrets:
- database_url
env_file: .env
command: ["go", "run", "./cmd/lab2experiment", "-output=/output/lab2-track2.json"]
volumes:
- ./evidence:/output
depends_on:
@@ -109,45 +87,40 @@ services:
condition: service_healthy
postgres-exporter:
profiles: ["monitoring"]
image: quay.io/prometheuscommunity/postgres-exporter:v0.20.1
environment:
DATA_SOURCE_URI: postgres:5432/${POSTGRES_DB}?sslmode=disable
DATA_SOURCE_USER: ${POSTGRES_USER}
DATA_SOURCE_PASS_FILE: /run/secrets/postgres_password
DATA_SOURCE_PASS: ${POSTGRES_PASSWORD}
PG_EXPORTER_COLLECTION_TIMEOUT: 5s
secrets:
- postgres_password
depends_on:
postgres:
condition: service_healthy
restart: unless-stopped
valkey-exporter:
profiles: ["monitoring"]
image: oliver006/redis_exporter:v1.89.0-alpine
entrypoint: ["/bin/sh", "-c"]
command:
- export REDIS_PASSWORD="$$(cat /run/secrets/valkey_password)"; exec /redis_exporter --redis.addr=redis://valkey:6379 --redis.user=default --connection-timeout=5s
secrets:
- valkey_password
environment:
REDIS_ADDR: redis://valkey:6379
REDIS_USER: default
REDIS_PASSWORD: ${VALKEY_PASSWORD}
depends_on:
valkey:
condition: service_healthy
restart: unless-stopped
prometheus:
profiles: ["monitoring"]
image: prom/prometheus:v3.13.3
build:
context: .
target: prometheus
command:
- --config.file=/etc/prometheus/prometheus.yml
- --storage.tsdb.path=/prometheus
- --storage.tsdb.retention.time=7d
volumes:
- ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml:ro
- prometheus_data:/prometheus
ports:
- "127.0.0.1:${PROMETHEUS_PORT}:9090"
- "${PROMETHEUS_BIND_ADDRESS}:9090"
depends_on:
- api
- postgres-exporter
@@ -155,36 +128,21 @@ services:
restart: unless-stopped
grafana:
profiles: ["monitoring"]
image: grafana/grafana:13.1.6
build:
context: .
target: grafana
environment:
GF_SECURITY_ADMIN_USER: admin
GF_SECURITY_ADMIN_PASSWORD__FILE: /run/secrets/grafana_admin_password
GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_ADMIN_PASSWORD}
GF_USERS_ALLOW_SIGN_UP: "false"
secrets:
- grafana_admin_password
volumes:
- ./monitoring/grafana/provisioning:/etc/grafana/provisioning:ro
- ./monitoring/grafana/dashboards:/var/lib/grafana/dashboards:ro
- grafana_data:/var/lib/grafana
ports:
- "127.0.0.1:${GRAFANA_PORT}:3000"
- "${GRAFANA_BIND_ADDRESS}:3000"
depends_on:
- prometheus
restart: unless-stopped
secrets:
postgres_password:
file: ./secrets/postgres_password
valkey_password:
file: ./secrets/valkey_password
database_url:
file: ./secrets/database_url
cache_url:
file: ./secrets/cache_url
grafana_admin_password:
file: ./secrets/grafana_admin_password
volumes:
postgres_data:
valkey_data:
+11 -1
View File
@@ -6,6 +6,7 @@ require (
github.com/google/uuid v1.6.0
github.com/jackc/pgx/v5 v5.11.0
github.com/prometheus/client_golang v1.23.2
github.com/spf13/viper v1.21.0
github.com/valkey-io/valkey-go v1.0.78
golang.org/x/crypto v0.57.0
)
@@ -13,15 +14,24 @@ require (
require (
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/fsnotify/fsnotify v1.9.0 // indirect
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
github.com/jackc/pgpassfile v1.0.0 // indirect
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
github.com/jackc/puddle/v2 v2.2.2 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
github.com/prometheus/client_model v0.6.2 // indirect
github.com/prometheus/common v0.66.1 // indirect
github.com/prometheus/procfs v0.16.1 // indirect
github.com/sagikazarmark/locafero v0.11.0 // indirect
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
github.com/spf13/afero v1.15.0 // indirect
github.com/spf13/cast v1.10.0 // indirect
github.com/spf13/pflag v1.0.10 // indirect
github.com/subosito/gotenv v1.6.0 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
go.yaml.in/yaml/v3 v3.0.5 // indirect
golang.org/x/sync v0.23.0 // indirect
golang.org/x/sys v0.48.0 // indirect
golang.org/x/text v0.42.0 // indirect
+22 -1
View File
@@ -2,10 +2,15 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=
github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
@@ -30,6 +35,8 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
github.com/onsi/gomega v1.42.1 h1:iN1rCUX+44NZ1Dc97MPoeFYbFR0vh8zxoxMFwKdyZ6I=
github.com/onsi/gomega v1.42.1/go.mod h1:REff/hsDsodHoKlWsP2mAPhu1+5/6hVYNf9rIEBpeSg=
github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o=
@@ -42,11 +49,25 @@ github.com/prometheus/procfs v0.16.1 h1:hZ15bTNuirocR6u0JZ6BAHHmwS1p8B4P6MRqxtzM
github.com/prometheus/procfs v0.16.1/go.mod h1:teAbpZRB1iIAJYREa1LsoWUXykVXA1KlTmWl8x/U+Is=
github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
github.com/sagikazarmark/locafero v0.11.0 h1:1iurJgmM9G3PA/I+wWYIOw/5SyBtxapeHDcg+AAIFXc=
github.com/sagikazarmark/locafero v0.11.0/go.mod h1:nVIGvgyzw595SUSUE6tvCp3YYTeHs15MvlmU87WwIik=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 h1:+jumHNA0Wrelhe64i8F6HNlS8pkoyMv5sreGx2Ry5Rw=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8/go.mod h1:3n1Cwaq1E1/1lhQhtRK2ts/ZwZEhjcQeJQ1RuC6Q/8U=
github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I=
github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg=
github.com/spf13/cast v1.10.0 h1:h2x0u2shc1QuLHfxi+cTJvs30+ZAHOGRic8uyGTDWxY=
github.com/spf13/cast v1.10.0/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU=
github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
github.com/valkey-io/valkey-go v1.0.78 h1:1Ce8hRaaNXpKfqmqZQRhnbVh1eW8MGR873pdXVvE4y8=
github.com/valkey-io/valkey-go v1.0.78/go.mod h1:gvC/r2m3eW4Hbj0YnjogTzNtFdPSM/D+NCqen+5OABM=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
+135 -74
View File
@@ -4,145 +4,206 @@ import (
"errors"
"fmt"
"net"
"os"
"strconv"
"strings"
"time"
"github.com/spf13/viper"
)
type Config struct {
Address string
DatabaseURL string
CacheURL string
SessionTTL time.Duration
DBMaxConns int32
DBMinConns int32
ConnectTimeout time.Duration
RequestTimeout time.Duration
SwaggerPort string
Address string
DatabaseURL string
CacheURL string
SessionTTL time.Duration
DBMaxConns int32
DBMinConns int32
DBMaxConnectionAge time.Duration
DBMaxConnectionIdle time.Duration
DBHealthCheckPeriod time.Duration
DependencyTimeout time.Duration
MigrationTimeout time.Duration
RequestTimeout time.Duration
HTTPReadHeaderTimeout time.Duration
HTTPReadTimeout time.Duration
HTTPWriteTimeout time.Duration
HTTPIdleTimeout time.Duration
HTTPShutdownTimeout time.Duration
PasswordMemoryKiB uint32
PasswordIterations uint32
PasswordParallelism uint8
PasswordSaltLength uint32
PasswordKeyLength uint32
SwaggerPort string
}
func Load() (Config, error) {
host, err := requiredEnv("APP_HOST")
values := viper.New()
values.AutomaticEnv()
host, err := requiredString(values, "APP_HOST")
if err != nil {
return Config{}, err
}
port, err := requiredPort("APP_PORT")
port, err := requiredPort(values, "APP_PORT")
if err != nil {
return Config{}, err
}
databaseURL, err := secretFromEnv("DATABASE_URL_FILE")
databaseURL, err := requiredString(values, "DATABASE_URL")
if err != nil {
return Config{}, err
}
cacheURL, err := secretFromEnv("CACHE_URL_FILE")
cacheURL, err := requiredString(values, "CACHE_URL")
if err != nil {
return Config{}, err
}
if store, err := requiredEnv("SESSION_STORE"); err != nil {
store, err := requiredString(values, "SESSION_STORE")
if err != nil {
return Config{}, err
} else if store != "valkey" {
}
if store != "valkey" {
return Config{}, errors.New("SESSION_STORE must be valkey")
}
ttlSeconds, err := requiredPositiveInt("SESSION_TTL_SECONDS")
sessionTTL, err := seconds(values, "SESSION_TTL_SECONDS", 1, 86400*30)
if err != nil {
return Config{}, err
}
maxConns, err := intEnv("DB_MAX_CONNS", 10, 1, 100)
maxConns, err := integer(values, "DB_MAX_CONNS", 1, 100)
if err != nil {
return Config{}, err
}
minConns, err := intEnv("DB_MIN_CONNS", 1, 0, maxConns)
minConns, err := integer(values, "DB_MIN_CONNS", 0, maxConns)
if err != nil {
return Config{}, err
}
connectSeconds, err := intEnv("DEPENDENCY_TIMEOUT_SECONDS", 5, 1, 60)
maxConnectionAge, err := seconds(values, "DB_MAX_CONNECTION_AGE_SECONDS", 1, 86400)
if err != nil {
return Config{}, err
}
swaggerPort := os.Getenv("SWAGGER_PORT")
if swaggerPort == "" {
swaggerPort = "8081"
maxConnectionIdle, err := seconds(values, "DB_MAX_CONNECTION_IDLE_SECONDS", 1, 86400)
if err != nil {
return Config{}, err
}
if _, err := parsePort(swaggerPort); err != nil {
return Config{}, fmt.Errorf("SWAGGER_PORT: %w", err)
healthCheckPeriod, err := seconds(values, "DB_HEALTH_CHECK_SECONDS", 1, 3600)
if err != nil {
return Config{}, err
}
dependencyTimeout, err := seconds(values, "DEPENDENCY_TIMEOUT_SECONDS", 1, 60)
if err != nil {
return Config{}, err
}
migrationTimeout, err := seconds(values, "MIGRATION_TIMEOUT_SECONDS", 1, 600)
if err != nil {
return Config{}, err
}
requestTimeout, err := seconds(values, "REQUEST_TIMEOUT_SECONDS", 1, 300)
if err != nil {
return Config{}, err
}
readHeaderTimeout, err := seconds(values, "HTTP_READ_HEADER_TIMEOUT_SECONDS", 1, 300)
if err != nil {
return Config{}, err
}
readTimeout, err := seconds(values, "HTTP_READ_TIMEOUT_SECONDS", 1, 300)
if err != nil {
return Config{}, err
}
writeTimeout, err := seconds(values, "HTTP_WRITE_TIMEOUT_SECONDS", 1, 300)
if err != nil {
return Config{}, err
}
idleTimeout, err := seconds(values, "HTTP_IDLE_TIMEOUT_SECONDS", 1, 3600)
if err != nil {
return Config{}, err
}
shutdownTimeout, err := seconds(values, "HTTP_SHUTDOWN_TIMEOUT_SECONDS", 1, 300)
if err != nil {
return Config{}, err
}
passwordMemory, err := integer(values, "PASSWORD_MEMORY_KIB", 8*1024, 1024*1024)
if err != nil {
return Config{}, err
}
passwordIterations, err := integer(values, "PASSWORD_ITERATIONS", 1, 20)
if err != nil {
return Config{}, err
}
passwordParallelism, err := integer(values, "PASSWORD_PARALLELISM", 1, 255)
if err != nil {
return Config{}, err
}
passwordSaltLength, err := integer(values, "PASSWORD_SALT_LENGTH", 8, 1024)
if err != nil {
return Config{}, err
}
passwordKeyLength, err := integer(values, "PASSWORD_KEY_LENGTH", 16, 1024)
if err != nil {
return Config{}, err
}
swaggerPort, err := requiredPort(values, "SWAGGER_PORT")
if err != nil {
return Config{}, err
}
return Config{
Address: net.JoinHostPort(host, port),
DatabaseURL: databaseURL,
CacheURL: cacheURL,
SessionTTL: time.Duration(ttlSeconds) * time.Second,
DBMaxConns: int32(maxConns),
DBMinConns: int32(minConns),
ConnectTimeout: time.Duration(connectSeconds) * time.Second,
RequestTimeout: time.Duration(connectSeconds) * time.Second,
SwaggerPort: swaggerPort,
Address: net.JoinHostPort(host, port), DatabaseURL: databaseURL, CacheURL: cacheURL,
SessionTTL: sessionTTL, DBMaxConns: int32(maxConns), DBMinConns: int32(minConns),
DBMaxConnectionAge: maxConnectionAge, DBMaxConnectionIdle: maxConnectionIdle,
DBHealthCheckPeriod: healthCheckPeriod, DependencyTimeout: dependencyTimeout,
MigrationTimeout: migrationTimeout, RequestTimeout: requestTimeout,
HTTPReadHeaderTimeout: readHeaderTimeout, HTTPReadTimeout: readTimeout,
HTTPWriteTimeout: writeTimeout, HTTPIdleTimeout: idleTimeout,
HTTPShutdownTimeout: shutdownTimeout, PasswordMemoryKiB: uint32(passwordMemory),
PasswordIterations: uint32(passwordIterations), PasswordParallelism: uint8(passwordParallelism),
PasswordSaltLength: uint32(passwordSaltLength), PasswordKeyLength: uint32(passwordKeyLength),
SwaggerPort: swaggerPort,
}, nil
}
func requiredEnv(name string) (string, error) {
value := strings.TrimSpace(os.Getenv(name))
func requiredString(values *viper.Viper, name string) (string, error) {
value := strings.TrimSpace(values.GetString(name))
if value == "" {
return "", fmt.Errorf("%s is required", name)
}
return value, nil
}
func requiredPort(name string) (string, error) {
value, err := requiredEnv(name)
func requiredPort(values *viper.Viper, name string) (string, error) {
value, err := requiredString(values, name)
if err != nil {
return "", err
}
if _, err := parsePort(value); err != nil {
if _, err := integerValue(value, 1, 65535); err != nil {
return "", fmt.Errorf("%s: %w", name, err)
}
return value, nil
}
func parsePort(value string) (int, error) {
port, err := strconv.Atoi(value)
if err != nil || port < 1 || port > 65535 {
return 0, errors.New("must be between 1 and 65535")
}
return port, nil
}
func requiredPositiveInt(name string) (int, error) {
value, err := requiredEnv(name)
func seconds(values *viper.Viper, name string, minimum, maximum int) (time.Duration, error) {
value, err := integer(values, name, minimum, maximum)
if err != nil {
return 0, err
}
parsed, err := strconv.Atoi(value)
if err != nil || parsed <= 0 {
return 0, fmt.Errorf("%s must be a positive integer", name)
return time.Duration(value) * time.Second, nil
}
func integer(values *viper.Viper, name string, minimum, maximum int) (int, error) {
value, err := requiredString(values, name)
if err != nil {
return 0, err
}
parsed, err := integerValue(value, minimum, maximum)
if err != nil {
return 0, fmt.Errorf("%s: %w", name, err)
}
return parsed, nil
}
func intEnv(name string, fallback, minimum, maximum int) (int, error) {
value := os.Getenv(name)
if value == "" {
return fallback, nil
}
func integerValue(value string, minimum, maximum int) (int, error) {
parsed, err := strconv.Atoi(value)
if err != nil || parsed < minimum || parsed > maximum {
return 0, fmt.Errorf("%s must be between %d and %d", name, minimum, maximum)
return 0, fmt.Errorf("must be between %d and %d", minimum, maximum)
}
return parsed, nil
}
func secretFromEnv(name string) (string, error) {
path, err := requiredEnv(name)
if err != nil {
return "", err
}
data, err := os.ReadFile(path)
if err != nil {
return "", fmt.Errorf("read %s: %w", name, err)
}
value := strings.TrimSpace(string(data))
if value == "" {
return "", fmt.Errorf("%s points to an empty file", name)
}
return value, nil
}
+22 -9
View File
@@ -2,6 +2,7 @@ package database
import (
"context"
"errors"
"fmt"
"time"
@@ -10,6 +11,18 @@ import (
"gitea.privcloud.tech/dizi/mtusi2026lab2/migrations"
)
var (
errURLRequired = errors.New("database URL is required")
errMinConnections = errors.New("minimum database connections must not be negative")
errMaxConnections = errors.New("maximum database connections must be positive")
errConnectionRange = errors.New("minimum database connections exceed maximum")
errMaxConnectionAge = errors.New("maximum database connection age must be positive")
errMaxConnectionIdle = errors.New("maximum database connection idle time must be positive")
errHealthCheckPeriod = errors.New("database health check period must be positive")
errConnectionTimeout = errors.New("database connection timeout must be positive")
errMigrationTimeout = errors.New("database migration timeout must be positive")
)
type Config struct {
URL string
MinConnections int32
@@ -58,23 +71,23 @@ func Open(ctx context.Context, config Config) (*pgxpool.Pool, error) {
func validateConfig(config Config) error {
switch {
case config.URL == "":
return fmt.Errorf("database URL is required")
return errURLRequired
case config.MinConnections < 0:
return fmt.Errorf("minimum database connections must not be negative")
return errMinConnections
case config.MaxConnections < 1:
return fmt.Errorf("maximum database connections must be positive")
return errMaxConnections
case config.MinConnections > config.MaxConnections:
return fmt.Errorf("minimum database connections exceed maximum")
return errConnectionRange
case config.MaxConnectionAge <= 0:
return fmt.Errorf("maximum database connection age must be positive")
return errMaxConnectionAge
case config.MaxConnectionIdle <= 0:
return fmt.Errorf("maximum database connection idle time must be positive")
return errMaxConnectionIdle
case config.HealthCheckPeriod <= 0:
return fmt.Errorf("database health check period must be positive")
return errHealthCheckPeriod
case config.ConnectTimeout <= 0:
return fmt.Errorf("database connection timeout must be positive")
return errConnectionTimeout
case config.MigrationTimeout <= 0:
return fmt.Errorf("database migration timeout must be positive")
return errMigrationTimeout
default:
return nil
}
+10
View File
@@ -0,0 +1,10 @@
package logger
import (
"log/slog"
"os"
)
func New() *slog.Logger {
return slog.New(slog.NewJSONHandler(os.Stdout, nil))
}
+113
View File
@@ -0,0 +1,113 @@
package messenger
import (
"errors"
"io"
"net/http"
"strings"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/model"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/postgres"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/session"
)
func (s *Server) createSession(w http.ResponseWriter, r *http.Request) *apiError {
if r.Method != http.MethodPost {
return methodNotAllowed(w, http.MethodPost)
}
body, err := io.ReadAll(io.LimitReader(r.Body, 1))
if err != nil || len(body) != 0 {
return invalidRequest()
}
username, passwordValue, ok := singleBasicAuth(r)
if !ok {
return unauthorized()
}
credentials, err := s.messengerStore.UserByUsername(r.Context(), username)
if errors.Is(err, postgres.ErrNotFound) {
if _, verifyErr := s.passwords.Verify(passwordValue, s.passwords.DummyHash()); verifyErr != nil {
return internalError()
}
return unauthorized()
}
if err != nil {
return unavailable()
}
verified, err := s.passwords.Verify(passwordValue, credentials.PasswordHash)
if err != nil {
return internalError()
}
if !verified {
return unauthorized()
}
token, expiresAt, err := s.sessions.Create(r.Context(), credentials.ID, s.sessionTTL)
if err != nil {
return unavailable()
}
writeJSON(w, http.StatusCreated, struct {
Token string `json:"token"`
TokenType string `json:"token_type"`
ExpiresAt string `json:"expires_at"`
User User `json:"user"`
}{token, "Bearer", model.FormatTime(expiresAt), credentials.User})
return nil
}
func singleBasicAuth(r *http.Request) (string, string, bool) {
if len(r.Header.Values("Authorization")) != 1 {
return "", "", false
}
username, passwordValue, ok := r.BasicAuth()
return username, passwordValue, ok && username != ""
}
func (s *Server) revokeSession(w http.ResponseWriter, r *http.Request) *apiError {
if r.Method != http.MethodDelete {
return methodNotAllowed(w, http.MethodDelete)
}
_, token, authErr := s.authenticate(r)
if authErr != nil {
return authErr
}
if err := s.sessions.Delete(r.Context(), token); errors.Is(err, session.ErrNotFound) {
return unauthorized()
} else if err != nil {
return unavailable()
}
w.WriteHeader(http.StatusNoContent)
return nil
}
func (s *Server) authenticate(r *http.Request) (User, string, *apiError) {
values := r.Header.Values("Authorization")
if len(values) != 1 {
return User{}, "", unauthorized()
}
scheme, token, found := strings.Cut(values[0], " ")
if !found || !strings.EqualFold(scheme, "Bearer") || token == "" || strings.ContainsAny(token, " \t\r\n") {
return User{}, "", unauthorized()
}
userID, err := s.sessions.UserID(r.Context(), token)
if errors.Is(err, session.ErrNotFound) || errors.Is(err, session.ErrInvalidToken) {
return User{}, "", unauthorized()
}
if err != nil {
return User{}, "", unavailable()
}
user, err := s.messengerStore.UserByID(r.Context(), userID)
if errors.Is(err, postgres.ErrNotFound) {
_ = s.sessions.Delete(r.Context(), token)
return User{}, "", unauthorized()
}
if err != nil {
return User{}, "", unavailable()
}
return user, token, nil
}
func authenticationChallenge(r *http.Request) string {
if r.URL.Path == "/api/v1/auth/sessions" {
return `Basic realm="messenger", charset="UTF-8"`
}
return `Bearer realm="messenger"`
}
+7 -103
View File
@@ -3,7 +3,6 @@ package messenger
import (
"context"
"errors"
"io"
"net/http"
"regexp"
"strings"
@@ -12,7 +11,6 @@ import (
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/model"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/postgres"
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/session"
)
var usernamePattern = regexp.MustCompile(`^[a-z0-9_]{3,32}$`)
@@ -34,7 +32,7 @@ func (s *Server) readiness(w http.ResponseWriter, r *http.Request) *apiError {
}
ctx, cancel := context.WithTimeout(r.Context(), 2*time.Second)
defer cancel()
if err := s.repository.Ping(ctx); err != nil {
if err := s.messengerStore.Ping(ctx); err != nil {
return unavailable()
}
if err := s.sessions.Ping(ctx); err != nil {
@@ -63,7 +61,7 @@ func (s *Server) users(w http.ResponseWriter, r *http.Request) *apiError {
if err != nil {
return internalError()
}
user, err := s.repository.CreateUser(r.Context(), input.Username, input.DisplayName, passwordHash)
user, err := s.messengerStore.CreateUser(r.Context(), input.Username, input.DisplayName, passwordHash)
if errors.Is(err, postgres.ErrConflict) {
return &apiError{http.StatusConflict, errorCodeConflict, "username already exists"}
}
@@ -79,73 +77,6 @@ func validPassword(value string) bool {
return utf8.ValidString(value) && strings.TrimSpace(value) != "" && length >= 12 && length <= 128
}
func (s *Server) createSession(w http.ResponseWriter, r *http.Request) *apiError {
if r.Method != http.MethodPost {
return methodNotAllowed(w, http.MethodPost)
}
body, err := io.ReadAll(io.LimitReader(r.Body, 1))
if err != nil || len(body) != 0 {
return invalidRequest()
}
username, passwordValue, ok := singleBasicAuth(r)
if !ok {
return unauthorized()
}
credentials, err := s.repository.UserByUsername(r.Context(), username)
if errors.Is(err, postgres.ErrNotFound) {
if _, verifyErr := s.passwords.Verify(passwordValue, s.passwords.DummyHash()); verifyErr != nil {
return internalError()
}
return unauthorized()
}
if err != nil {
return unavailable()
}
verified, err := s.passwords.Verify(passwordValue, credentials.PasswordHash)
if err != nil {
return internalError()
}
if !verified {
return unauthorized()
}
token, expiresAt, err := s.sessions.Create(r.Context(), credentials.ID, s.sessionTTL)
if err != nil {
return unavailable()
}
writeJSON(w, http.StatusCreated, struct {
Token string `json:"token"`
TokenType string `json:"token_type"`
ExpiresAt string `json:"expires_at"`
User User `json:"user"`
}{token, "Bearer", model.FormatTime(expiresAt), credentials.User})
return nil
}
func singleBasicAuth(r *http.Request) (string, string, bool) {
if len(r.Header.Values("Authorization")) != 1 {
return "", "", false
}
username, passwordValue, ok := r.BasicAuth()
return username, passwordValue, ok && username != ""
}
func (s *Server) revokeSession(w http.ResponseWriter, r *http.Request) *apiError {
if r.Method != http.MethodDelete {
return methodNotAllowed(w, http.MethodDelete)
}
_, token, authErr := s.authenticate(r)
if authErr != nil {
return authErr
}
if err := s.sessions.Delete(r.Context(), token); errors.Is(err, session.ErrNotFound) {
return unauthorized()
} else if err != nil {
return unavailable()
}
w.WriteHeader(http.StatusNoContent)
return nil
}
func (s *Server) me(w http.ResponseWriter, r *http.Request) *apiError {
if r.Method != http.MethodGet {
return methodNotAllowed(w, http.MethodGet)
@@ -194,7 +125,7 @@ func (s *Server) chats(w http.ResponseWriter, r *http.Request) *apiError {
if _, included := members[user.ID]; !included {
return invalidRequest()
}
chat, err := s.repository.CreateChat(r.Context(), input.Title, input.MemberIDs, user.ID)
chat, err := s.messengerStore.CreateChat(r.Context(), input.Title, input.MemberIDs, user.ID)
if errors.Is(err, postgres.ErrInvalidMembers) {
return invalidRequest()
}
@@ -210,7 +141,7 @@ func (s *Server) listChats(w http.ResponseWriter, r *http.Request, user User) *a
if err != nil {
return err
}
items, hasNext, listErr := s.repository.ListChats(r.Context(), user.ID, cursorPosition(cursor), limit)
items, hasNext, listErr := s.messengerStore.ListChats(r.Context(), user.ID, cursorPosition(cursor), limit)
if errors.Is(listErr, postgres.ErrInvalidCursor) {
return invalidRequest()
}
@@ -245,7 +176,7 @@ func (s *Server) chat(w http.ResponseWriter, r *http.Request) *apiError {
if !valid {
return invalidRequest()
}
chat, err := s.repository.ChatForUser(r.Context(), chatID, user.ID)
chat, err := s.messengerStore.ChatForUser(r.Context(), chatID, user.ID)
if errors.Is(err, postgres.ErrNotFound) {
return notFound()
}
@@ -280,7 +211,7 @@ func (s *Server) messages(w http.ResponseWriter, r *http.Request) *apiError {
if !validText(input.Text, 4000) {
return invalidRequest()
}
message, err := s.repository.CreateMessage(r.Context(), chatID, user.ID, input.Text)
message, err := s.messengerStore.CreateMessage(r.Context(), chatID, user.ID, input.Text)
if errors.Is(err, postgres.ErrNotFound) {
return notFound()
}
@@ -296,7 +227,7 @@ func (s *Server) listMessages(w http.ResponseWriter, r *http.Request, user User,
if err != nil {
return err
}
items, hasNext, listErr := s.repository.ListMessages(r.Context(), chatID, user.ID, cursorPosition(cursor), limit)
items, hasNext, listErr := s.messengerStore.ListMessages(r.Context(), chatID, user.ID, cursorPosition(cursor), limit)
if errors.Is(listErr, postgres.ErrNotFound) {
return notFound()
}
@@ -328,30 +259,3 @@ func cursorPosition(cursor *pageCursor) *model.Position {
}
return &model.Position{CreatedAt: cursor.Time, ID: cursor.ID}
}
func (s *Server) authenticate(r *http.Request) (User, string, *apiError) {
values := r.Header.Values("Authorization")
if len(values) != 1 {
return User{}, "", unauthorized()
}
scheme, token, found := strings.Cut(values[0], " ")
if !found || !strings.EqualFold(scheme, "Bearer") || token == "" || strings.ContainsAny(token, " \t\r\n") {
return User{}, "", unauthorized()
}
userID, err := s.sessions.UserID(r.Context(), token)
if errors.Is(err, session.ErrNotFound) || errors.Is(err, session.ErrInvalidToken) {
return User{}, "", unauthorized()
}
if err != nil {
return User{}, "", unavailable()
}
user, err := s.repository.UserByID(r.Context(), userID)
if errors.Is(err, postgres.ErrNotFound) {
_ = s.sessions.Delete(r.Context(), token)
return User{}, "", unauthorized()
}
if err != nil {
return User{}, "", unavailable()
}
return user, token, nil
}
@@ -7,7 +7,7 @@ import (
"gitea.privcloud.tech/dizi/mtusi2026lab2/internal/model"
)
type Repository interface {
type MessengerStore interface {
Ping(context.Context) error
CreateUser(context.Context, string, string, string) (model.User, error)
UserByID(context.Context, string) (model.User, error)
@@ -26,7 +26,7 @@ type SessionStore interface {
Delete(context.Context, string) error
}
type Passwords interface {
type PasswordService interface {
Hash(string) (string, error)
Verify(string, string) (bool, error)
DummyHash() string
+12 -16
View File
@@ -9,15 +9,15 @@ import (
)
type Server struct {
repository Repository
sessions SessionStore
passwords Passwords
sessionTTL time.Duration
requestTTL time.Duration
logger *slog.Logger
swaggerPort string
metrics *metrics
ready atomic.Bool
messengerStore MessengerStore
sessions SessionStore
passwords PasswordService
sessionTTL time.Duration
requestTTL time.Duration
logger *slog.Logger
swaggerPort string
metrics *metrics
ready atomic.Bool
}
type statusWriter struct {
@@ -30,9 +30,9 @@ func (w *statusWriter) WriteHeader(status int) {
w.ResponseWriter.WriteHeader(status)
}
func NewServer(logger *slog.Logger, repository Repository, sessions SessionStore, passwords Passwords, sessionTTL, requestTTL time.Duration, swaggerPort string) *Server {
func NewServer(logger *slog.Logger, messages MessengerStore, sessions SessionStore, passwords PasswordService, sessionTTL, requestTTL time.Duration, swaggerPort string) *Server {
s := &Server{
repository: repository, sessions: sessions, passwords: passwords,
messengerStore: messages, sessions: sessions, passwords: passwords,
sessionTTL: sessionTTL, requestTTL: requestTTL, logger: logger, swaggerPort: swaggerPort, metrics: newMetrics(),
}
s.ready.Store(true)
@@ -80,11 +80,7 @@ func (s *Server) serve(w http.ResponseWriter, r *http.Request) {
r = r.WithContext(ctx)
if apiErr := s.route(wrapped, r); apiErr != nil {
if apiErr.status == http.StatusUnauthorized {
challenge := `Bearer realm="messenger"`
if r.URL.Path == "/api/v1/auth/sessions" {
challenge = `Basic realm="messenger", charset="UTF-8"`
}
wrapped.Header().Set("WWW-Authenticate", challenge)
wrapped.Header().Set("WWW-Authenticate", authenticationChallenge(r))
}
writeError(wrapped, requestID, apiErr)
}
+23 -23
View File
@@ -16,7 +16,7 @@ import (
var errDependency = errors.New("dependency unavailable")
type repositoryStub struct {
type messengerStoreStub struct {
pingErr error
userByID model.User
userByIDErr error
@@ -24,29 +24,29 @@ type repositoryStub struct {
credentialsErr error
}
func (s repositoryStub) Ping(context.Context) error { return s.pingErr }
func (repositoryStub) CreateUser(context.Context, string, string, string) (model.User, error) {
func (s messengerStoreStub) Ping(context.Context) error { return s.pingErr }
func (messengerStoreStub) CreateUser(context.Context, string, string, string) (model.User, error) {
return model.User{}, nil
}
func (s repositoryStub) UserByID(context.Context, string) (model.User, error) {
func (s messengerStoreStub) UserByID(context.Context, string) (model.User, error) {
return s.userByID, s.userByIDErr
}
func (s repositoryStub) UserByUsername(context.Context, string) (model.UserCredentials, error) {
func (s messengerStoreStub) UserByUsername(context.Context, string) (model.UserCredentials, error) {
return s.credentials, s.credentialsErr
}
func (repositoryStub) CreateChat(context.Context, string, []string, string) (model.Chat, error) {
func (messengerStoreStub) CreateChat(context.Context, string, []string, string) (model.Chat, error) {
return model.Chat{}, nil
}
func (repositoryStub) ChatForUser(context.Context, string, string) (model.Chat, error) {
func (messengerStoreStub) ChatForUser(context.Context, string, string) (model.Chat, error) {
return model.Chat{}, nil
}
func (repositoryStub) ListChats(context.Context, string, *model.Position, int) ([]model.Chat, bool, error) {
func (messengerStoreStub) ListChats(context.Context, string, *model.Position, int) ([]model.Chat, bool, error) {
return nil, false, nil
}
func (repositoryStub) CreateMessage(context.Context, string, string, string) (model.Message, error) {
func (messengerStoreStub) CreateMessage(context.Context, string, string, string) (model.Message, error) {
return model.Message{}, nil
}
func (repositoryStub) ListMessages(context.Context, string, string, *model.Position, int) ([]model.Message, bool, error) {
func (messengerStoreStub) ListMessages(context.Context, string, string, *model.Position, int) ([]model.Message, bool, error) {
return nil, false, nil
}
@@ -77,16 +77,16 @@ func (s passwordsStub) Verify(string, string) (bool, error) {
func TestReadinessReturnsUnavailableForDependencyFailure(t *testing.T) {
tests := []struct {
name string
repo repositoryStub
store messengerStoreStub
sessions sessionStub
}{
{name: "postgres", repo: repositoryStub{pingErr: errDependency}},
{name: "postgres", store: messengerStoreStub{pingErr: errDependency}},
{name: "valkey", sessions: sessionStub{pingErr: errDependency}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
server := newTestServer(tt.repo, tt.sessions, passwordsStub{})
server := newTestServer(tt.store, tt.sessions, passwordsStub{})
response := serveRequest(server, http.MethodGet, "/health/ready", "")
if response.Code != http.StatusServiceUnavailable {
t.Fatalf("status = %d, want %d", response.Code, http.StatusServiceUnavailable)
@@ -98,16 +98,16 @@ func TestReadinessReturnsUnavailableForDependencyFailure(t *testing.T) {
func TestBusinessRequestReturnsUnavailableForDependencyFailure(t *testing.T) {
tests := []struct {
name string
repo repositoryStub
store messengerStoreStub
sessions sessionStub
}{
{name: "valkey", sessions: sessionStub{userIDErr: errDependency}},
{name: "postgres", repo: repositoryStub{userByIDErr: errDependency}, sessions: sessionStub{userID: "user-id"}},
{name: "postgres", store: messengerStoreStub{userByIDErr: errDependency}, sessions: sessionStub{userID: "user-id"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
server := newTestServer(tt.repo, tt.sessions, passwordsStub{})
server := newTestServer(tt.store, tt.sessions, passwordsStub{})
request := httptest.NewRequest(http.MethodGet, "/api/v1/users/me", nil)
request.Header.Set("Authorization", "Bearer valid-token")
response := httptest.NewRecorder()
@@ -120,14 +120,14 @@ func TestBusinessRequestReturnsUnavailableForDependencyFailure(t *testing.T) {
}
func TestAuthenticationChallenges(t *testing.T) {
server := newTestServer(repositoryStub{}, sessionStub{}, passwordsStub{})
server := newTestServer(messengerStoreStub{}, sessionStub{}, passwordsStub{})
bearer := serveRequest(server, http.MethodGet, "/api/v1/users/me", "")
if bearer.Code != http.StatusUnauthorized || bearer.Header().Get("WWW-Authenticate") != `Bearer realm="messenger"` {
t.Fatalf("business challenge = %d %q", bearer.Code, bearer.Header().Get("WWW-Authenticate"))
}
repository := repositoryStub{credentials: model.UserCredentials{PasswordHash: "hash"}}
server = newTestServer(repository, sessionStub{}, passwordsStub{verified: false})
store := messengerStoreStub{credentials: model.UserCredentials{PasswordHash: "hash"}}
server = newTestServer(store, sessionStub{}, passwordsStub{verified: false})
request := httptest.NewRequest(http.MethodPost, "/api/v1/auth/sessions", nil)
request.SetBasicAuth("user", "wrong-password")
response := httptest.NewRecorder()
@@ -138,7 +138,7 @@ func TestAuthenticationChallenges(t *testing.T) {
}
func TestSessionCreationRejectsChunkedBody(t *testing.T) {
server := newTestServer(repositoryStub{}, sessionStub{}, passwordsStub{})
server := newTestServer(messengerStoreStub{}, sessionStub{}, passwordsStub{})
request := httptest.NewRequest(http.MethodPost, "/api/v1/auth/sessions", strings.NewReader("{}"))
request.ContentLength = -1
request.SetBasicAuth("user", "password")
@@ -150,16 +150,16 @@ func TestSessionCreationRejectsChunkedBody(t *testing.T) {
}
func TestRegistrationRejectsWhitespacePassword(t *testing.T) {
server := newTestServer(repositoryStub{}, sessionStub{}, passwordsStub{})
server := newTestServer(messengerStoreStub{}, sessionStub{}, passwordsStub{})
response := serveRequest(server, http.MethodPost, "/api/v1/users", `{"username":"student","display_name":"Student","password":" "}`)
if response.Code != http.StatusBadRequest {
t.Fatalf("status = %d, want %d", response.Code, http.StatusBadRequest)
}
}
func newTestServer(repository Repository, sessions SessionStore, passwords Passwords) *Server {
func newTestServer(messages MessengerStore, sessions SessionStore, passwords PasswordService) *Server {
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
return NewServer(logger, repository, sessions, passwords, time.Hour, time.Second, "8081")
return NewServer(logger, messages, sessions, passwords, time.Hour, time.Second, "8081")
}
func serveRequest(server *Server, method, path, body string) *httptest.ResponseRecorder {
+25 -22
View File
@@ -39,35 +39,38 @@ type Position struct {
ID string
}
type userJSON struct {
ID string `json:"id"`
Username string `json:"username"`
DisplayName string `json:"display_name"`
CreatedAt string `json:"created_at"`
}
type chatJSON struct {
ID string `json:"id"`
Title string `json:"title"`
MemberIDs []string `json:"member_ids"`
CreatedAt string `json:"created_at"`
}
type messageJSON struct {
ID string `json:"id"`
ChatID string `json:"chat_id"`
SenderID string `json:"sender_id"`
Text string `json:"text"`
CreatedAt string `json:"created_at"`
}
func (u User) MarshalJSON() ([]byte, error) {
type response struct {
ID string `json:"id"`
Username string `json:"username"`
DisplayName string `json:"display_name"`
CreatedAt string `json:"created_at"`
}
return json.Marshal(response{u.ID, u.Username, u.DisplayName, formatTime(u.CreatedAt)})
return json.Marshal(userJSON{u.ID, u.Username, u.DisplayName, formatTime(u.CreatedAt)})
}
func (c Chat) MarshalJSON() ([]byte, error) {
type response struct {
ID string `json:"id"`
Title string `json:"title"`
MemberIDs []string `json:"member_ids"`
CreatedAt string `json:"created_at"`
}
return json.Marshal(response{c.ID, c.Title, c.MemberIDs, formatTime(c.CreatedAt)})
return json.Marshal(chatJSON{c.ID, c.Title, c.MemberIDs, formatTime(c.CreatedAt)})
}
func (m Message) MarshalJSON() ([]byte, error) {
type response struct {
ID string `json:"id"`
ChatID string `json:"chat_id"`
SenderID string `json:"sender_id"`
Text string `json:"text"`
CreatedAt string `json:"created_at"`
}
return json.Marshal(response{m.ID, m.ChatID, m.SenderID, m.Text, formatTime(m.CreatedAt)})
return json.Marshal(messageJSON{m.ID, m.ChatID, m.SenderID, m.Text, formatTime(m.CreatedAt)})
}
func FormatTime(value time.Time) string {
+87 -54
View File
@@ -6,95 +6,128 @@ import (
"encoding/base64"
"errors"
"fmt"
"strconv"
"strings"
"golang.org/x/crypto/argon2"
)
const (
MemoryKiB uint32 = 64 * 1024
Iterations uint32 = 3
Parallelism uint8 = 2
SaltLength = 16
KeyLength uint32 = 32
var (
ErrInvalidConfig = errors.New("invalid password configuration")
ErrInvalidHash = errors.New("invalid password hash")
)
var ErrInvalidHash = errors.New("invalid password hash")
var dummyHash = encode(
make([]byte, SaltLength),
argon2.IDKey([]byte("invalid-user-password"), make([]byte, SaltLength), Iterations, MemoryKiB, Parallelism, KeyLength),
)
type Hasher struct{}
func (Hasher) Hash(value string) (string, error) {
return Hash(value)
type Config struct {
MemoryKiB uint32
Iterations uint32
Parallelism uint8
SaltLength uint32
KeyLength uint32
}
func (Hasher) Verify(value, encodedHash string) (bool, error) {
return Verify(value, encodedHash)
type Hasher struct {
config Config
dummyHash string
}
func (Hasher) DummyHash() string {
return dummyHash
func New(config Config) (*Hasher, error) {
if err := validateConfig(config); err != nil {
return nil, err
}
salt := make([]byte, config.SaltLength)
digest := argon2.IDKey([]byte("invalid-user-password"), salt, config.Iterations, config.MemoryKiB, config.Parallelism, config.KeyLength)
return &Hasher{config: config, dummyHash: encode(config, salt, digest)}, nil
}
func Hash(value string) (string, error) {
salt := make([]byte, SaltLength)
func validateConfig(config Config) error {
if config.MemoryKiB < 8*1024 || config.MemoryKiB > 1024*1024 ||
config.Iterations < 1 || config.Iterations > 20 ||
config.Parallelism < 1 ||
config.SaltLength < 8 || config.SaltLength > 1024 ||
config.KeyLength < 16 || config.KeyLength > 1024 {
return ErrInvalidConfig
}
return nil
}
func (h *Hasher) Hash(value string) (string, error) {
salt := make([]byte, h.config.SaltLength)
if _, err := rand.Read(salt); err != nil {
return "", fmt.Errorf("generate password salt: %w", err)
}
digest := argon2.IDKey([]byte(value), salt, Iterations, MemoryKiB, Parallelism, KeyLength)
return encode(salt, digest), nil
digest := argon2.IDKey([]byte(value), salt, h.config.Iterations, h.config.MemoryKiB, h.config.Parallelism, h.config.KeyLength)
return encode(h.config, salt, digest), nil
}
func encode(salt, digest []byte) string {
func (h *Hasher) Verify(value, encodedHash string) (bool, error) {
config, salt, digest, err := decode(encodedHash)
if err != nil {
return false, err
}
actual := argon2.IDKey([]byte(value), salt, config.Iterations, config.MemoryKiB, config.Parallelism, config.KeyLength)
return subtle.ConstantTimeCompare(actual, digest) == 1, nil
}
func (h *Hasher) DummyHash() string {
return h.dummyHash
}
func encode(config Config, salt, digest []byte) string {
return fmt.Sprintf(
"$argon2id$v=%d$m=%d,t=%d,p=%d$%s$%s",
argon2.Version,
MemoryKiB,
Iterations,
Parallelism,
config.MemoryKiB,
config.Iterations,
config.Parallelism,
base64.RawStdEncoding.EncodeToString(salt),
base64.RawStdEncoding.EncodeToString(digest),
)
}
func Verify(value, encodedHash string) (bool, error) {
salt, digest, err := decode(encodedHash)
if err != nil {
return false, err
}
actual := argon2.IDKey([]byte(value), salt, Iterations, MemoryKiB, Parallelism, KeyLength)
return subtle.ConstantTimeCompare(actual, digest) == 1, nil
}
func decode(encodedHash string) ([]byte, []byte, error) {
func decode(encodedHash string) (Config, []byte, []byte, error) {
parts := strings.Split(encodedHash, "$")
if len(parts) != 6 || parts[0] != "" || parts[1] != "argon2id" {
return nil, nil, ErrInvalidHash
if len(parts) != 6 || parts[0] != "" || parts[1] != "argon2id" || parts[2] != fmt.Sprintf("v=%d", argon2.Version) {
return Config{}, nil, nil, ErrInvalidHash
}
if parts[2] != fmt.Sprintf("v=%d", argon2.Version) {
return nil, nil, ErrInvalidHash
parameters := strings.Split(parts[3], ",")
if len(parameters) != 3 {
return Config{}, nil, nil, ErrInvalidHash
}
if parts[3] != fmt.Sprintf("m=%d,t=%d,p=%d", MemoryKiB, Iterations, Parallelism) {
return nil, nil, ErrInvalidHash
memory, err := parameter(parameters[0], "m=", 32)
if err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
iterations, err := parameter(parameters[1], "t=", 32)
if err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
parallelism, err := parameter(parameters[2], "p=", 8)
if err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
salt, err := base64.RawStdEncoding.Strict().DecodeString(parts[4])
if err != nil || len(salt) != SaltLength {
return nil, nil, ErrInvalidHash
if err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
digest, err := base64.RawStdEncoding.Strict().DecodeString(parts[5])
if err != nil || len(digest) != int(KeyLength) {
return nil, nil, ErrInvalidHash
if err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
config := Config{
MemoryKiB: uint32(memory), Iterations: uint32(iterations), Parallelism: uint8(parallelism),
SaltLength: uint32(len(salt)), KeyLength: uint32(len(digest)),
}
if err := validateConfig(config); err != nil {
return Config{}, nil, nil, ErrInvalidHash
}
return config, salt, digest, nil
}
return salt, digest, nil
func parameter(value, prefix string, bitSize int) (uint64, error) {
if !strings.HasPrefix(value, prefix) {
return 0, ErrInvalidHash
}
return strconv.ParseUint(strings.TrimPrefix(value, prefix), 10, bitSize)
}
+13 -2
View File
@@ -3,7 +3,10 @@ package password
import "testing"
func TestHasher(t *testing.T) {
hasher := Hasher{}
hasher, err := New(testConfig())
if err != nil {
t.Fatalf("New() error = %v", err)
}
hash, err := hasher.Hash("T3st-password-123")
if err != nil {
t.Fatalf("Hash() error = %v", err)
@@ -27,7 +30,15 @@ func TestHasher(t *testing.T) {
}
func TestVerifyRejectsMalformedHash(t *testing.T) {
if _, err := (Hasher{}).Verify("password", "invalid"); err == nil {
hasher, err := New(testConfig())
if err != nil {
t.Fatalf("New() error = %v", err)
}
if _, err := hasher.Verify("password", "invalid"); err == nil {
t.Fatal("Verify() error = nil for malformed hash")
}
}
func testConfig() Config {
return Config{MemoryKiB: 8 * 1024, Iterations: 1, Parallelism: 1, SaltLength: 16, KeyLength: 32}
}
+49 -6
View File
@@ -1,18 +1,61 @@
# Адрес и внутренний порт HTTP-сервера.
APP_HOST=0.0.0.0
APP_PORT=8080
# Адреса публикации сервисов на локальной машине.
API_BIND_ADDRESS=127.0.0.1:8080
SWAGGER_BIND_ADDRESS=127.0.0.1:8081
PROMETHEUS_BIND_ADDRESS=127.0.0.1:9090
GRAFANA_BIND_ADDRESS=127.0.0.1:3000
# Время жизни сессии и используемое хранилище.
SESSION_TTL_SECONDS=3600
SESSION_STORE=valkey
DB_MIN_CONNS=1
DB_MAX_CONNS=10
DEPENDENCY_TIMEOUT_SECONDS=5
SWAGGER_PORT=8081
# Учётные данные локального PostgreSQL и строка подключения API.
POSTGRES_USER=messenger
POSTGRES_DB=messenger
POSTGRES_PASSWORD=local-postgres-password
DATABASE_URL=postgres://messenger:local-postgres-password@postgres:5432/messenger?sslmode=disable
# Пароль локального Valkey и строка подключения API.
VALKEY_PASSWORD=local-valkey-password
CACHE_URL=redis://default:local-valkey-password@valkey:6379/0
# Размер пула и обслуживание соединений PostgreSQL.
DB_MIN_CONNS=1
DB_MAX_CONNS=10
DB_MAX_CONNECTION_AGE_SECONDS=1800
DB_MAX_CONNECTION_IDLE_SECONDS=300
DB_HEALTH_CHECK_SECONDS=30
# Таймауты зависимостей, миграций и HTTP-запросов.
DEPENDENCY_TIMEOUT_SECONDS=5
MIGRATION_TIMEOUT_SECONDS=30
REQUEST_TIMEOUT_SECONDS=5
HTTP_READ_HEADER_TIMEOUT_SECONDS=5
HTTP_READ_TIMEOUT_SECONDS=10
HTTP_WRITE_TIMEOUT_SECONDS=10
HTTP_IDLE_TIMEOUT_SECONDS=60
HTTP_SHUTDOWN_TIMEOUT_SECONDS=10
# Параметры Argon2id для новых хешей паролей.
PASSWORD_MEMORY_KIB=65536
PASSWORD_ITERATIONS=3
PASSWORD_PARALLELISM=2
PASSWORD_SALT_LENGTH=16
PASSWORD_KEY_LENGTH=32
# Порт Swagger внутри конфигурации CORS API.
SWAGGER_PORT=8081
# Ограничения ресурсов контейнеров приложения и хранилищ.
API_CPUS=2
API_MEMORY=512m
POSTGRES_CPUS=2
POSTGRES_MEMORY=1g
VALKEY_CPUS=1
VALKEY_MEMORY=256m
PROMETHEUS_PORT=9090
GRAFANA_PORT=3000
# Пароль локального администратора Grafana.
GRAFANA_ADMIN_PASSWORD=local-grafana-password
@@ -7,4 +7,4 @@ providers:
disableDeletion: true
editable: false
options:
path: /var/lib/grafana/dashboards
path: /etc/grafana/dashboards
+5 -5
View File
@@ -8,23 +8,23 @@ trap 'rm -f "$backup_file"' EXIT
started_at=$(date +%s)
docker compose exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
export PGPASSWORD="$POSTGRES_PASSWORD"
pg_dump --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" --format custom
' > "$backup_file"
docker compose exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
export PGPASSWORD="$POSTGRES_PASSWORD"
dropdb --username "$POSTGRES_USER" --if-exists "$1"
createdb --username "$POSTGRES_USER" "$1"
' sh "$restore_database"
docker compose exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
export PGPASSWORD="$POSTGRES_PASSWORD"
pg_restore --username "$POSTGRES_USER" --dbname "$1" --no-owner --no-privileges
' sh "$restore_database" < "$backup_file"
original=$(docker compose exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
export PGPASSWORD="$POSTGRES_PASSWORD"
psql --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" --tuples-only --no-align --command "
SELECT count(*) FROM users;
SELECT count(*) FROM chats;
@@ -43,7 +43,7 @@ original=$(docker compose exec -T postgres sh -eu -c '
')
restored=$(docker compose exec -T postgres sh -eu -c '
export PGPASSWORD="$(cat /run/secrets/postgres_password)"
export PGPASSWORD="$POSTGRES_PASSWORD"
psql --username "$POSTGRES_USER" --dbname "$1" --tuples-only --no-align --command "
SELECT count(*) FROM users;
SELECT count(*) FROM chats;
-21
View File
@@ -1,21 +0,0 @@
#!/bin/sh
set -eu
if [ -e secrets/postgres_password ] || [ -e secrets/valkey_password ] || [ -e secrets/database_url ] || [ -e secrets/cache_url ] || [ -e secrets/grafana_admin_password ]; then
echo "secrets already exist" >&2
exit 1
fi
umask 077
mkdir -p secrets
postgres_password=$(openssl rand -hex 24)
valkey_password=$(openssl rand -hex 24)
grafana_admin_password=$(openssl rand -hex 24)
printf '%s' "$postgres_password" > secrets/postgres_password
printf '%s' "$valkey_password" > secrets/valkey_password
printf 'postgres://messenger:%s@postgres:5432/messenger?sslmode=disable' "$postgres_password" > secrets/database_url
printf 'redis://default:%s@valkey:6379/0' "$valkey_password" > secrets/cache_url
printf '%s' "$grafana_admin_password" > secrets/grafana_admin_password