Что такое хотфикс: значение, хотфикс и патч, как выпустить
5 мин чтения
Хотфиксом (hotfix) называют исправление серьёзной проблемы в продакшене, которое выпускают вне обычного цикла релизов, потому что ожидание следующего планового релиза обойдётся дороже, чем риск действовать быстро. По замыслу он небольшой, проходит сокращённую версию обычных проверок, и пользователи узнают о нём, как только смогут его получить. Слово изначально означало изменение, применённое к «горячей» системе, то есть к серверу, который продолжает обслуживать пользователей, а сегодня оно говорит скорее о срочности, чем о способе установки исправления.
| Термин | Что это | Когда выходит | Типичный объём |
|---|---|---|---|
| Хотфикс | Срочное исправление проблемы, с которой пользователи сталкиваются сейчас | Сразу, как только готово, вне расписания | Один дефект |
| Багфикс | Любое исправление дефекта | Обычно с очередным плановым релизом | Один или несколько дефектов |
| Патч | Обновление существующей программы; в SemVer релиз, повышающий последнюю цифру | Плановый или срочный | Обратно совместимые исправления |
| Сервис-пак или rollup | Проверенный накопительный набор прежних исправлений | По расписанию | Много исправлений, иногда небольшие функции |
| Live patch | Исправление работающего кода без перезапуска | Когда перезапуск слишком дорог | Несколько функций |
Что означает хотфикс в разработке ПО?
Хотфиксом называют изменение, сделанное быстро, чтобы исправить проблему в программе, которой уже пользуются, и выпущенное отдельно, не дожидаясь следующей версии. В термине две идеи сразу: проблема серьёзная, а обычный процесс сокращён, чтобы с ней справиться.
Эту смену значения прослеживает статья Википедии о хотфиксах. Сначала термин относился к исправлению «горячей» системы, продакшен-сервера, активно обслуживающего клиентов, а со временем стал означать любое обновление, созданное в спешке или выпущенное вне обычного цикла обновлений. Microsoft много лет использовала это слово, а потом перешла на другую терминологию, хотя в её нынешнем списке типов обновлений сервис-пак по-прежнему описан как проверенный накопительный набор хотфиксов, обновлений безопасности, критических обновлений и обновлений. Исходный «горячий» смысл сохранился в live patching, который документация livepatch ядра Linux описывает как исправление критических функций без перезагрузки системы.
Чем хотфикс отличается от патча?
Патчем называют любое обновление, меняющее существующую программу, а хотфиксом называют патч, который определяется срочностью и временем выпуска. Каждый хотфикс является патчем; большинство патчей плановые и выходят с обычным релизом.
Больше всего путаницы вызывает пересечение с версионированием. По семантическому версионированию номер PATCH растёт при обратно совместимых исправлениях ошибок, поэтому хотфикс к версии 2.4.0 обычно выходит как 2.4.1. Плановый сервисный релиз тоже может быть 2.4.1. Номер версии фиксирует, какого рода это изменение, а слово «хотфикс» фиксирует, почему оно не могло ждать. Багфикс представляет собой то же изменение по обычному расписанию: код может быть тем же самым, и разница лишь в том, нарушали ли вы цикл релизов ради его выпуска.
Когда ошибка заслуживает хотфикса?
Когда оставить её в продакшене до следующего релиза обойдётся дороже, чем выпустить изменение в спешке. Решать это должен назначенный человек по критериям, которые команда согласовала в спокойной обстановке, а не тот, кто тревожится сильнее всех.
Проблемы, которые обычно оправдывают хотфикс:
- Потеря или повреждение данных, включая неправильно записанные данные, которые придётся потом исправлять.
- Уязвимость безопасности, которую уже эксплуатируют или легко эксплуатировать.
- Сломанный основной сценарий у многих пользователей: вход, оплата, сохранение работы.
- Регрессия последнего релиза, блокирующая клиентов, у которых накануне всё работало.
- Юридическое или договорное обязательство, которое программа перестала выполнять.
Проблемы, которые обычно могут подождать следующего релиза: косметические дефекты, ошибки с приемлемым обходным путём и всё, что затрагивает мало пользователей и не усугубляется. Список важно записать, потому что каждое срочное исправление обходит часть проверок, защищающих продакшен, а команда, которая выпускает хотфиксом всё подряд, тихо отказалась от своего процесса релизов.
Как безопасно выпустить хотфикс?
Исправляйте ту версию, которая действительно работает, меняйте как можно меньше, проверяйте исправление на той самой сборке, которую будете выкатывать, оставьте путь назад и влейте исправление в основную ветку, чтобы следующий релиз не вернул ошибку.
- Подтвердите и определите границы. Воспроизведите проблему, убедитесь, что она подходит под критерии выше, и назначьте одного ответственного за исправление.
- Отведите ветку от того, что в продакшене. В модели git-flow из статьи Винсента Дриссена о модели ветвления ветка хотфикса начинается от продакшен-тега на
master, версия повышается сразу, а готовая ветка вливается и вmaster, и вdevelop. В собственной заметке 2020 года к этой статье Дриссен рекомендует для веб-приложений с непрерывной поставкой более простой процесс: там хотфиксом становится небольшой pull request в основную ветку, который выкатывают сразу. - Сделайте наименьшее изменение, которое это исправляет. Никакого рефакторинга и дополнительных функций. Всё, что не является исправлением, может выйти на следующей неделе.
- Докажите, что оно работает. Добавьте тест, который воспроизводит ошибку и падает без исправления, затем прогоните весь набор тестов на коммите, который будете выкатывать.
- Версия и тег. Повысьте номер патча и поставьте тег на коммит, как описано в статье git-теги и релизы.
- Выкатывайте с путём назад. Где можно, раскатывайте постепенно, следите за долей ошибок и знайте команду отката до того, как она понадобится.
- Влейте обратно. Если исправление сделано в релизной ветке, влейте его в основную ветку в тот же день.
Нужны ли хотфиксу запись в changelog и release notes?
Да. Пользователям, которые столкнулись с ошибкой, нужно знать, что она исправлена и что им, если нужно, придётся сделать, а тем, кто потом читает историю версий, нужно понимать, почему 2.4.1 появилась через два дня после 2.4.0.
Заметка должна быть короткой: что было сломано, кого это затронуло, что меняется для них и в какой версии исправление. Если хотфикс отвечает на инцидент, действует руководство из статьи экстренные release notes, а для обычного исправления достаточно формата из статьи release notes исправления багов. Если ваш конвейер блокирует merge без записи в changelog, статья о проверке changelog в CI объясняет, как обрабатывать срочные исключения, не отключая gate. Changeloop составляет черновик записи по каждому влитому pull request, так что PR с хотфиксом получает черновик, как и любой другой merge, а рецензент утверждает его до публикации.
Как не дать хотфиксам стать рутиной?
Считайте их и разбирайте каждый. Каждый хотфикс свидетельствует о том, что в продакшен попало то, что должны были поймать обычные проверки, а число хотфиксов показывает, становится ли ситуация лучше или хуже.
В метрики доставки ПО DORA входит доля неудачных изменений (change fail rate): доля выкаток, после которых требуется немедленное вмешательство, скорее всего откат или хотфикс. Рост этого показателя обычно указывает на слишком крупные релизы или тесты, которые пропускают целые области продукта. После каждого хотфикса спросите, почему ошибка прошла, и добавьте тест, проверку или шаг ревью, которые остановили бы её. Статья о процессе управления релизами показывает, где эти проверки находятся в обычном релизе.
FAQ
Хотфикс и патч означают одно и то же? Каждый хотфикс является патчем, поскольку меняет существующую программу. Слово «хотфикс» добавляет, что патч был срочным и вышел вне обычного расписания релизов.
Какой номер версии должен получить хотфикс? Обычно следующую патч-версию по семантическому версионированию, так что хотфикс к 2.4.0 выходит как 2.4.1. Хотфикс должен содержать только обратно совместимые исправления, а именно это и обещает повышение номера патча.
Кто решает, нужен ли ошибке хотфикс? Одна назначенная роль, например дежурный инженер или владелец релиза, по критериям, которые команда записала заранее. Решать комитетом во время инцидента медленно, а решать по тому, кто громче кричит, значит превращать хотфиксы в рутину.
Можно ли пропускать code review для хотфикса? Нет. Сократите ревью, но не отменяйте: второй человек прочтёт изменение в десять строк за несколько минут и заметит опечатку, которая превращает один инцидент в два.
Технические утверждения в этой статье не проходили независимую проверку. Если здесь что-то не так, сообщите нам, и мы исправим.