Files
dc-observatio/docs/standards/CHECKLIST.md
T
Дмитрий Соловьев 260583b134 pcp: единообразие времени (UTC) по группе сервисов
Фронт (pcp-tgu-ops-ui):
- тест-страж utcTime.guard.test.ts: запрещает Date.parse / new Date(string) /
  toLocale* без timeZone вне utils/utcTime; тестовые фикстуры переведены на parseUtc.

Бэкенд:
- UTC-now: LocalDateTime.now() -> LocalDateTime.now(ZoneOffset.UTC) по всем сервисам
  (entity-дефолты, воркеры, use case'ы) и в тестовых фикстурах.
- Конвертации к UTC (баги на не-UTC JVM, каждая с регресс-тестом в не-UTC поясе):
  - tgu: VisibilityPayloadParser, SyncSpacecraftFromNsiUseCase (Instant -> UTC LocalDateTime);
  - mission-planing: MissionPlaningService (OffsetDateTime -> UTC через toUtcLocalDateTime);
  - dynamic-plan: RequestServiceClient (OffsetDateTime -> UTC);
  - slots: SlotRepositoryImpl (getObject(LocalDateTime) вместо getTimestamp().toLocalDateTime()).
- Контрактные сериализационные тесты формата на проводе (naive без зоны / Z):
  PlanResponse (tgu), RequestResponseDto (request, эталон), TguPlanning DTO (ui).
- KDoc-инвариант «=UTC» на UI-facing DTO (tgu PlanResponse, ui-service DTO вкладки ТГУ).

Документация: docs/standards/DATETIME_UTC.md (соглашение, таблица сервисов, под-задачи на миграцию к Z),
docs/standards/CHECKLIST.md (пункт про UTC на API).
2026-06-02 21:51:38 +03:00

5.9 KiB

CHECKLIST.md

Назначение

Этот документ содержит краткие checklists для review/merge, Definition of Done, обязательных тестов и validation.

Пункты ниже применяются по принципу where relevant:

  • для обычных Kotlin/Spring-изменений достаточно общего checklist;
  • для изменений в BPM / Zeebe / Camunda / Kafka / retries / DLQ / compensation / schema evolution дополнительно применяются профильные пункты;
  • для критичных процессов глубина проверок и тестов должна быть пропорциональна риску изменения.

Review checklist

Для всех нетривиальных изменений

Перед merge необходимо подтвердить:

  • запрошенное поведение реализовано;
  • решение осталось в корректной архитектурной границе;
  • существующие публичные контракты не сломаны без явного запроса;
  • добавлены или обновлены релевантные тесты;
  • не внесено несвязанных правок;
  • время на API — UTC; backend использует UTC-now (Instant.now() / LocalDateTime.now(ZoneOffset.UTC)), фронт парсит/форматирует через utils/utcTime (см. docs/standards/DATETIME_UTC.md);
  • validation выполнен по правилам AGENTS.md, либо пропуски явно объяснены.

Дополнительно для BPM / Kafka / Zeebe / external integration изменений

Перед merge необходимо подтвердить, где это релевантно:

  • business key определён и используется консистентно;
  • operation id принимается от вызывающей стороны и используется для dedup;
  • ошибки классифицированы семантически;
  • side effects идемпотентны или явно компенсируются;
  • доменные события публикуются через Outbox;
  • logs / metrics / traces содержат обязательные поля корреляции;
  • тесты покрывают duplicate delivery и retry behavior;
  • изменения деплоя и конфигурации трассируемы в VCS.

Definition of Done

Задача считается завершённой только если одновременно выполнено всё ниже, где это релевантно:

Общее

  1. Запрошенное поведение реализовано.
  2. Решение осталось в корректной архитектурной границе.
  3. Нужные тесты добавлены или обновлены.
  4. Нужный validation выполнен, либо невозможность запуска объяснена.
  5. Не внесено несвязанных правок.

Для BPM / Kafka / Zeebe / external integration

  1. BPM остаётся только оркестратором, если BPM участвует.
  2. Доменные правила остаются внутри сервисной границы.
  3. Flows остаются безопасными при at-least-once delivery.
  4. Идемпотентность обеспечена.
  5. operation_id сохранён или добавлен, где это требуется контрактом.
  6. Outbox сохранён или использован, где операция меняет состояние и публикует события.
  7. Retries ограничены и управляемы.
  8. DLQ handling сохранён для критичных consumers.
  9. Versioning / backward compatibility сохранены.
  10. Observability сохранена или улучшена.

Обязательные тесты для значимых изменений

Базовый минимум

Как минимум покрывать, где применимо:

  • happy path;
  • изменённые ветки branching / validation logic;
  • regression scenario для bug fix.

Дополнительно для BPM / Kafka / Zeebe / external integration

Покрывать, где применимо:

  • retryable failure с последующим успехом;
  • исчерпание retries;
  • ветку business error;
  • обработку timeout;
  • сценарий compensation;
  • duplicate delivery / duplicate event handling;
  • contract compatibility;
  • schema compatibility.

Для критичных процессов и high-risk изменений

Покрывать пропорционально риску изменения через automated tests и/или явный resilience test plan:

  • перезапуск воркера во время выполнения;
  • временную недоступность БД;
  • временную недоступность внешней зависимости;
  • разрыв связности Kafka / BPM;
  • сценарий load / lag recovery.

Validation

Следуй разделу Validation commands из AGENTS.md.

Если для изменения есть module-specific команды, используй минимальный релевантный прогон, а затем более широкий, когда это необходимо.

Если какая-либо команда не была запущена:

  • точно укажи, какая именно команда не запускалась;
  • объясни почему;
  • опиши остаточный риск.