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

Анализ влияния изменений

middle-senior~45 мин

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

Анализ влияния изменений

Сцена · два символа в схеме события

Сервис оплаты публикует событие OrderPaid. Разработчик наводит порядок в именах: в схеме события поле user_id становится userId, как везде в TypeScript. Дифф в схеме меняет два символа. Типы в сервисе оплаты обновились, тесты сервиса оплаты обновились и зелёные, ревьюер одобрил за минуту: «переименование, ок».

Через час ломаются три сервиса. Аналитика читает user_id, получает пустоту и пишет в хранилище строки без пользователя. Уведомления не находят, кому слать чек, и тихо пропускают письма. Антифрод считает платёж без пользователя гостевым и блокирует часть заказов. Падает только антифрод, поэтому его и чинят первым. Про аналитику узнают через неделю, когда отчёт по выручке не сходится, а неделя событий в хранилище уже записана без пользователей.

Дифф был в два символа. Влияние было на три сервиса и неделю данных. Ни тесты, ни типы, ни ревью этого не увидели, потому что все они смотрели на сервис оплаты, а сломалось всё вокруг него.

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

  • Определение анализа влияния и два вопроса, на которые он отвечает.
  • Пять путей, по которым маленькое изменение уходит далеко: конфиги, контракты, опции, типы, схемы.
  • Три способа искать влияние: трассировка, зависимости, экспертиза. Что видит каждый и чего не видит.
  • Как найти затронутое обходом графа назад и где граф заканчивается.
  • Как оценить масштаб последствий и почему тихая ошибка хуже громкой.
  • Что смотреть в PR кроме строк: шаблон раздела «Влияние».

Что такое анализ влияния

Классическое определение даёт книга Bohner и Arnold «Software Change Impact Analysis» (1996). Сама книга в открытом доступе не нашлась, поэтому определение здесь по статье Wikipedia: анализ влияния это выявление потенциальных последствий изменения или оценка того, что нужно поменять, чтобы изменение выполнить.

В этой фразе два вопроса, и оба нужны:

  1. Что сломается, если сделать это изменение? Это взгляд от изменения наружу: кто зависит от того, что я трогаю.
  2. Что ещё придётся поменять, чтобы изменение заработало? Это план работ: миграция данных, правки у потребителей, обновление документации.

Pfleeger и Atlee, по той же статье, смещают акцент на риски: ресурсы, трудозатраты, сроки. Анализ влияния нужен не только чтобы не сломать, но и чтобы честно оценить задачу. «Переименовать поле» звучит как пять минут. С тремя потребителями и неделей данных это уже задача на несколько дней и разговор с тремя командами.

Почему маленький дифф не значит безопасный

Размер диффа меряет текст, а не влияние. Изменение распространяется по путям, которых в диффе не видно. Пять самых частых:

  • Конфиги. Таймаут с 30 секунд до 3 в файле настроек, который делят несколько сервисов, меняет поведение всех, кто этот файл читает, включая клиентов, о которых ты не знаешь.
  • Контракты. Поле API, формат файла выгрузки, таблица, которую читает соседняя команда. Код потребителя живёт в другом репозитории, а значит вне твоего диффа и твоих тестов.
  • Опции и значения по умолчанию. Новое значение по умолчанию у параметра функции меняет поведение всех вызовов, которые его не передавали. В диффе одна строка, а затронуты все места, где параметра нет.
  • Типы. Расширение типа (string становится string | null, у перечисления появляется новый вариант) ломает тех, кто рассчитывал на старое множество значений: switch без нового случая, .length на null.
  • Схемы событий и данных. Самый коварный путь из сцены. Событие уже отправлено и прочитано, данные уже записаны в старом или новом формате. Откат кода не откатывает то, что успело уехать.

У всех пяти общее: изменение задевает того, кто читает изменённую вещь, а читатель не виден из места изменения. Компилятор знает про импорты, но не знает, кто разбирает JSON из очереди.

Три способа искать влияние

Та же статья делит техники анализа влияния на три вида. У каждого своя слепая зона, поэтому на важном изменении их комбинируют.

Трассировка. Связи между требованиями, спецификациями, дизайном и тестами. Если у требования «чек уходит покупателю после оплаты» есть ссылка на тест и на код, то изменение кода показывает, какое требование под угрозой. Работает ровно настолько, насколько связи записаны: критерии приёмки со ссылками, ADR, тесты с говорящими именами.

Зависимости. Связи модулей, переменных, логики: статический анализ кода и динамический (что реально вызывается во время работы). По статье этот способ точнее трассировки. Для пакетов это обход зависимостей в обратную сторону: в мире RPM и Debian для этого есть скрипт whatrequires (кто требует этот пакет). Для кода это граф импортов и вызовов. Полнотекстовый поиск помогает, но хуже работает, когда связь появляется только во время работы: ключ собирается из строк, обработчик выбирается по имени из конфига.

Экспертиза. Знания людей: ревью, обсуждение, вопрос тому, кто в теме. Плохо масштабируется и зависит от того, кого спросили. Зато ловит то, чего нет ни в графе, ни в ссылках: «эту выгрузку по понедельникам читает бухгалтерия», «в прошлый раз такое же переименование сломало мобильное приложение».

В сцене сработал бы любой из трёх, если бы его применили. Трассировка показала бы требование «чек после оплаты». Поиск по репозиториям нашёл бы строку user_id у трёх потребителей. Вопрос в канал «кто читает OrderPaid?» за пять минут собрал бы список.

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

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

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