Раздел 16 · Архитектура и решения

Fitness functions

middle-senior~55 мин

без входаВойди, чтобы отмечать прогресс, вести заметки и решать задачи в редакторе. войти

Fitness functions

Сцена · двенадцать мест за месяц

В начале проекта команда договорилась о слоях: маршруты зовут сервисы, сервисы зовут репозитории, репозитории ходят в базу. Нарисовали схему, положили в вики, на ревью иногда напоминали.

Через месяц кто-то из любопытства прогнал поиск по импортам. Двенадцать мест, где слой ходит мимо соседа. Маршрут админки читает базу напрямую, потому что «нужно было срочно показать цифру». Отчёт в сервисе собирает SQL руками, потому что репозиторий «неудобный». Репозиторий импортирует расчёт цены из сервиса, потому что «он же уже написан».

Злого умысла нет ни в одном месте. Горел срок, был новичок, который не читал вики, был ревьюер, который пролистал дифф на семьсот строк. Каждое нарушение по отдельности мелкое. Вместе они значат, что слоёв больше нет: есть схема в вики и код, который живёт своей жизнью.

Договорённость, которую проверяют люди, держится, пока люди помнят. Этот урок про то, как превратить её в проверку, которая падает сама.

Карта урока · что заберёшь

  • Что такое fitness function и чем она отличается от обычного теста.
  • Какие архитектурные свойства превращаются в проверки: от циклов и слоёв до идемпотентности и персональных данных в логах.
  • Где и как часто запускать проверку: охват, частота, контекст.
  • Как ArchUnit и dependency-cruiser записывают правило слоёв обычным тестом.
  • Как внедрить проверку в старый проект, где нарушений уже десятки.
  • Новую метрику эпохи агентов: цену типового изменения.

Что такое fitness function

В прошлом уроке мы взяли определение у Ford, Parsons и Kua: fitness function даёт объективную оценку того, насколько система сохраняет какую-то архитектурную характеристику. Пола Пол и Розмари Ванг в статье Thoughtworks (январь 2019) говорят практичнее: это тесты архитектурных целей, которые живут рядом с тестами фич, как в TDD.

Рабочая формула для этого урока: fitness function это тест, у которого есть метрика и порог. Метрика отвечает «сколько»: число циклов, задержка, доля покрытия, число импортов мимо слоя. Порог отвечает «сколько можно». Проверка сравнивает одно с другим и говорит да или нет.

Чем это отличается от обычного теста? Юнит-тест проверяет поведение одной функции: на такой вход такой выход. Fitness function проверяет свойство системы целиком, которое не принадлежит ни одной фиче. Ни одна фича не отвечает за то, что в коде нет циклов. Ни одна фича не отвечает за то, что логи чистые от телефонов клиентов. Поэтому такие свойства и гниют первыми: у них нет хозяина среди задач.

Архитектурные характеристики это то, что в уроке про NFR называется нефункциональными требованиями. Fitness function делает следующий шаг: не только назвать требование числом, но и проверять его на каждом изменении.

Допустимое и целевое: проверять направление изменений

Зелёная проверка отвечает «сейчас допустимо». Чтобы направлять эволюцию, нужно ещё видеть расстояние до цели. Разделим допустимые требования, нарушение которых блокирует принятие изменения, и целевые требования, к которым система должна прийти за согласованное время. Это приём работы с fitness functions, а не обязательное устройство каждой такой функции.

Учебный пример: команда улучшает отправку подтверждения заказа. Все числа ниже выбраны для примера; это не норматив для любого проекта.

КачествоДопустимо сейчасЦель через две итерацииКак сравниваем
Задержка подтвержденияp95 не больше 2 сp95 не больше 500 мсОдин стенд, одинаковая нагрузка и набор заказов
Старые нарушения границТолько 12 записанных зависимостей, новых нетСписок пустСравнение конкретных зависимостей с базовой линией
Циклы между модулями00Проверка всего графа импортов

Первые две цели требуют работы, последняя удерживает уже достигнутое. Для старых нарушений можно наметить промежуточную цель: после первой итерации осталось не больше восьми. Нужны ответственный, срок и регулярная сверка, иначе цели годами остаются необязательными пожеланиями.

Когда задержка устойчиво укладывается в 500 мс на согласованном прогоне, команда закрепляет этот уровень как допустимый. Система больше не может вернуться к двум секундам незаметно. Следующую цель выбирают по новой потребности: например, выдерживать большую нагрузку при прежней задержке. Бесконечно уменьшать время ответа ради самой цифры не требуется.

Не ухудшать достигнутое и продвигаться к цели это разные условия. Первое проверяют для каждого изменения в пределах выбранных ограничений, второе оценивают на согласованном горизонте. Правка текста кнопки не обязана ускорять отправку писем. При этом CI, который никогда не допускает регресса, сам по себе не заставит команду устранить старые нарушения.

Качества сравнивают каждое в своих единицах: миллисекунды, стоимость, число зависимостей. Сводить их в один балл необязательно. Защищённые границы задают явно, а обмен, например рост стоимости ради меньшей задержки, обсуждают и фиксируют. Шумные измерения требуют повторных прогонов и допуска. Если изменились нагрузка, среда или метод измерения, сначала восстанавливают сопоставимость. Смена порога ради зелёной сборки не означает улучшения системы.

Что проверять · примеры по темам

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

ТемаСвойствоПроверка
структуранет циклов между модулямиграф импортов без циклов
структураслой видит только соседа снизуправило зависимостей в CI
связностьмодуль не тянет за собой полпроектачисло модулей, от которых зависит модуль, не больше порога
сложностькод можно прочитатькогнитивная сложность функции не выше порога в линтере
надёжностьповтор события не портит данныетест прогоняет обработчик дважды и сравнивает состояние
масштабсервис не хранит состояниезапросы одного пользователя идут на два экземпляра, результат тот же
производительностьпоиск быстрыйp95 ответа меньше 300 мс на нагрузочном прогоне
безопасностьнет секретов в коде и уязвимых библиотексканер секретов и зависимостей в CI
соответствиенет персональных данных в логахпроверка логов тестового прогона по шаблонам
эксплуатациясервис можно чинить ночьюу сервиса есть runbook и алерты

Обрати внимание на строки про идемпотентность и отсутствие состояния. Это не правила оформления кода, а поведение системы. Fitness function не обязана быть статическим анализом: это может быть интеграционный тест, нагрузочный прогон или запрос в мониторинг.

Покрытие тестами в статье тоже есть (пример порога там 90 процентов), но вспомни урок про качество: покрытие хорошо как термометр и вредно как цель. Порог на покрытие легко выполнить тестами без проверок, и проверка будет зелёной, а свойство мёртвым.

Где и когда запускать

Ford, Parsons и Kua подчёркивают, что функции различаются по нескольким осям: охват, частота, контекст. На практике это три вопроса к каждой проверке.

Охват: одно свойство или несколько сразу? «Нет циклов» проверяет одно. Нагрузочный прогон проверяет задержку, ошибки и потребление памяти разом. Узкие проверки точно говорят, что сломалось. Широкие ловят то, что видно только на системе целиком.

Частота: когда запускать? Статические правила (циклы, слои, сложность) дешёвые, их гоняют на каждый PR. Нагрузочный прогон дорогой, его запускают ночью или перед релизом. А некоторые свойства проверяются постоянно в проде: SLO из урока про эксплуатацию это тоже fitness function, только её метрика живёт в мониторинге.

Контекст: где запускать? На коде в CI, на стенде с данными, в живом проде. Чем ближе к проду, тем честнее ответ и тем позже он приходит.

ПроверкаОхватКогдаГде
нет циклов, слоиодно свойствокаждый PRCI, на коде
сложность функцийодно свойствокаждый PRлинтер
повтор событияодно свойствокаждый PRинтеграционный тест
p95 поисканескольконочьюстенд с нагрузкой
доступностьнесколькопостояннопрод, мониторинг

Последний шаг из статьи Thoughtworks: встроить проверки в конвейер как автоматические шлюзы и регулярно их пересматривать. Проверка, которую нельзя провалить (она только пишет предупреждение в лог), через месяц перестанет читаться. Проверка, которую никто не пересматривает, через год охраняет свойство, которое уже никому не нужно.

дальше после входа

Урок целиком открыт всем, кто вошёл. Войди по своему email, чтобы читать дальше.

Вход пока по приглашению. Если хочешь учиться, напиши Vassiliy.