8000 GitHub - Tipz/HT6 · GitHub
[go: up one dir, main page]

Skip to content
TipzPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Вместе в путь

CI and publish

«Вместе в путь» — учебное клиент-серверное приложение для планирования и сравнения семейных поездок. Пользователь может вести несколько поездок, сравнивать варианты размещения и направлений, рассчитывать бюджет и хранить данные в своей учётной записи.

Текущая версия выполнена в рамках домашнего задания № 6. К приложению добавлены CI/CD, аудит безопасности, OAuth 2.0 через Яндекс ID, Яндекс Метрика с явным согласием, health checks и структурированные JSON-логи. Вход по email и паролю сохранён. Платёжный сервис не используется, поскольку он является опциональным и не требуется предметной области проекта.

Основной экран приложения с вымышленными данными

Возможности

  • регистрация и вход по паролю или через Яндекс ID;
  • несколько независимых поездок с датами, составом семьи и возрастом детей;
  • создание, редактирование и удаление вариантов направления и жилья;
  • шесть статей бюджета с расчётом в целых копейках;
  • различение неизвестной суммы и нулевого расхода;
  • сравнение двух и более вариантов по семи переключаемым критериям;
  • серверное хранение данных в PostgreSQL с изоляцией пользователей;
  • защита от потери изменений при сетевой ошибке или конфликте версий;
  • добровольный импорт данных старой IndexedDB-версии без удаления локальной копии;
  • адаптивный русскоязычный интерфейс на MudBlazor.

Основной экран следует концепции «План поездки»: холодная сине-серая палитра, блок сравнения перед карточками и боковая навигация на широком экране.

Технологии

Область Технологии
Клиент C#, .NET 10, standalone Blazor WebAssembly, MudBlazor 9.7.0
Backend ASP.NET Core Minimal API, ASP.NET Core Identity
Данные EF Core, Npgsql, PostgreSQL
Тесты xUnit, bUnit, Playwright .NET
Эксплуатация Docker, Docker Compose, GitHub Actions, GHCR
Интеграции Яндекс ID OAuth 2.0, Яндекс Метрика

Бизнес-модель, вычисления и валидация находятся в Together.Core и не зависят от браузера или базы данных. Контракты API выделены в Together.Contracts.

Быстрый запуск через Docker Compose

Потребуются Docker Engine и Docker Compose. Из корня репозитория:

Copy-Item .env.example .env

Перед запуском обязательно задайте в .env новый длинный пароль PostgreSQL. Для изолированного локального HTTP-стенда также установите:

POSTGRES_PASSWORD=replace-with-a-long-random-password
SECURE_COOKIES=false

Запустите приложение:

docker compose up --build -d
docker compose ps

После успешного завершения контейнера migrate приложение доступно по адресу http://localhost:8080. Состояние готовности можно проверить запросом http://localhost:8080/health/ready.

Остановка без удаления данных:

docker compose down

Файл .env исключён из Git. Не сохраняйте пароли, OAuth Client Secret и строки подключения в appsettings.json, Docker image, логах или Blazor bundle.

Запуск для разработки без Docker

Потребуются:

  • .NET SDK 10.0.303, зафиксированный в global.json;
  • PostgreSQL;
  • два терминала для API и клиента.

Подготовьте строку подключения ConnectionStrings__Together, затем восстановите инструменты и примените миграции:

dotnet restore Together.slnx --locked-mode
dotnet tool restore
dotnet tool run dotnet-ef database update --project src/Together.Api

Запустите API:

dotnet run --project src/Together.Api

В другом терминале запустите клиент:

dotnet run --project src/Together.Client

Клиент будет доступен по адресу http://localhost:5180, API — по адресу http://localhost:5182. Для разработки клиента с hot reload можно использовать:

dotnet watch --project src/Together.Client

Node.js и npm для сборки приложения не требуются.

Яндекс ID

OAuth включается только при наличии обеих server-side настроек:

Authentication__Yandex__ClientId
Authentication__Yandex__ClientSecret

При запуске через Compose им соответствуют YANDEX_CLIENT_ID и YANDEX_CLIENT_SECRET. Callback приложения:

<APP_URL>/signin-yandex

Этот точный URI необходимо зарегистрировать в консоли Яндекс ID. Backend использует Authorization Code Flow с PKCE, запрашивает только login:email, не передаёт access token в Blazor и не сохраняет его после входа.

Интеграция проверена на локальном HTTPS-стенде. Production-стенд размещён в частной сети на машине 192.168.1.26; TLS завершается существующим Traefik, а сертификаты выдаются локальным центром сертификации. При переносе в другую инфраструктуру необходимо настроить собственные DNS/URL, HTTPS reverse proxy, сертификат, Client ID, Client Secret и Redirect URI.

Яндекс Метрика

Метрика включается настройкой YandexMetrika__CounterId, которой в Compose соответствует YANDEX_METRIKA_COUNTER_ID.

  • скрипт Метрики не загружается до явного согласия пользователя;
  • согласие можно отозвать;
  • в Метрику передаются только очищенные SPA paths без query string и fragment;
  • разрешены цели login_succeeded с методом password или yandex и trip_created;
  • email, идентификатор пользователя, поездки, возраст детей и заметки не передаются.

Интеграция проверена с настроенным счётчиком на локальном стенде. В другом окружении необходимо создать собственный счётчик и передать его номер приложению.

CI и публикация образа

Workflow .github/workflows/ci.yml запускается для pull request и push в main.

Последовательность проверок:

locked restore
  → format и NuGet audit
  → Release build и xUnit
  → CodeQL
  → Docker Compose и Chromium backend smoke
  → multi-platform publish
  → smoke опубликованного digest

Pull request выполняет проверки, но не публикует образ. После успешного push в main workflow публикует образ для linux/amd64 и linux/arm64 в GitHub Container Registry:

ghcr.io/tipz/ht6

Доступны теги latest, main, sha-<полный SHA> и v* для Git-тегов. Production deployment рекомендуется выполнять по неизменяемой ссылке ghcr.io/tipz/ht6@sha256:....

Автоматический deployment через защищённый self-hosted GitHub runner был подготовлен для локальной production-машины, но отключён в текущем универсальном workflow. Такой job зависит от конкретных runner labels, локального пути, приватной сети, reverse proxy и PKI. Текущая версия автоматически проверяет и публикует готовый образ, а его развёртывание выполняется вручную на целевом Docker-хосте.

Production deployment готового образа

Для развёртывания без исходников и локальной сборки используйте docker-compose.deploy.yml:

cp deploy.env.example .env.deploy
# PowerShell: Copy-Item deploy.env.example .env.deploy

Заполните как минимум:

TOGETHER_IMAGE=ghcr.io/tipz/ht6@sha256:replace-with-published-digest
POSTGRES_PASSWORD=replace-with-a-long-random-password

Для OAuth и аналитики также задайте:

YANDEX_CLIENT_ID=
YANDEX_CLIENT_SECRET=
YANDEX_METRIKA_COUNTER_ID=

Проверка и запуск:

docker compose --env-file .env.deploy --file docker-compose.deploy.yml config --quiet
docker compose --env-file .env.deploy --file docker-compose.deploy.yml up -d
docker compose --env-file .env.deploy --file docker-compose.deploy.yml ps

Compose:

  • загружает опубликованные образы приложения и PostgreSQL;
  • ожидает готовности PostgreSQL;
  • выполняет EF Core migrations отдельным одноразовым контейнером;
  • запускает приложение только после успешной миграции;
  • сохраняет PostgreSQL и Data Protection keys в отдельных volumes;
  • запускает приложение от пользователя app с read-only root filesystem.

Сам Compose по умолчанию использует 127.0.0.1:8080, но текущий deploy.env.example задаёт APP_BIND_ADDRESS=0.0.0.0 для доступа из локальной сети. В этом режиме ограничьте порт firewall доверенной LAN. Если reverse proxy работает на том же хосте, безопаснее установить APP_BIND_ADDRESS=127.0.0.1. В production используйте HTTPS и SECURE_COOKIES=true; задайте точный TRUSTED_PROXY_IP и включите USE_HTTPS_REDIRECTION только после корректной передачи X-Forwarded-Proto.

Проверки состояния:

  • /health — liveness процесса;
  • /health/ready — readiness приложения с проверкой PostgreSQL.

Остановка без удаления данных:

docker compose --env-file .env.deploy --file docker-compose.deploy.yml down

Не используйте down --volumes, если не требуется намеренно удалить базу и ключи cookie. Перед обновлением и изменением схемы базы сделайте резервную копию. Подробная инструкция находится в backend_documentation.md.

Безопасность, мониторинг и логи

В проекте реализованы:

  • antiforgery-защита изменяющих API-запросов;
  • HttpOnly, SameSite и Secure cookies;
  • CSP, HSTS и другие security headers;
  • rate limiting и блокировка повторных неуспешных входов;
  • проверка владения серверными данными;
  • optimistic concurrency с ответом 409 Conflict;
  • аудит NuGet-зависимостей и CodeQL;
  • JSON-логи в stdout с timestamp, level, category, Event ID и Trace ID;
  • ограничение размера Docker logs;
  • Docker health checks и контроль локального стенда средствами Docker и Traefik.

Отдельные документы:

Проверки

Release-сборка и оба основных набора xUnit:

dotnet restore Together.slnx --locked-mode
dotnet format Together.slnx --verify-no-changes --no-restore
dotnet build Together.slnx --configuration Release --no-restore
dotnet test tests/Together.Tests/Together.Tests.csproj --configuration Release --no-build --no-restore
dotnet test tests/Together.Api.Tests/Together.Api.Tests.csproj --configuration Release --no-build --no-restore
dotnet package list --project Together.slnx --include-transitive --vulnerable

Актуальный браузерный smoke выполняется на полном Compose-стенде:

docker compose up --build -d
$env:APP_URL = 'http://localhost:8080'
dotnet run --project tests/Together.BrowserTests -- --backend-smoke
Remove-Item Env:APP_URL

Он проверяет регистрацию, загрузку серверного примера, сохранение данных после перезагрузки и выход. Все тестовые данные вымышлены. Результаты и скриншоты находятся в docs/evidence.

Набор без --backend-smoke относится к исторической IndexedDB-версии ДЗ № 4 и не является проверкой текущего backend.

Структура репозитория

Путь Назначение
src/Together.Core Модель, вычисления и валидация
src/Together.Contracts DTO и маршруты API
src/Together.Client Blazor WebAssembly UI и API-клиент
src/Together.Api Identity, Minimal API, EF Core и миграции
tests/Together.Tests Модульные и компонентные тесты
tests/Together.Api.Tests Интеграционные тесты API и безопасности
tests/Together.BrowserTests Playwright browser smoke
docker-compose.yml Локальная сборка и запуск из исходников
docker-compose.deploy.yml Развёртывание опубликованного образа
.github/workflows/ci.yml CI, security checks и публикация GHCR image
docs Требования, отчёты, инструкции и evidence

Документация

Публичный HTTPS-стенд не предоставляется: учебный production-стенд работает в приватной локальной сети. Репозиторий и готовые multi-platform образы доступны через GitHub и GHCR.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0