Co to jest hotfix? Znaczenie, hotfix a patch, jak go wydać
5 min czytania
Hotfix to poprawka poważnego problemu na produkcji, wydana poza zwykłym cyklem wydań, bo czekanie na kolejne planowane wydanie kosztowałoby więcej niż ryzyko szybkiego działania. Z założenia jest mały, przechodzi skróconą wersję zwykłych kontroli, a użytkownicy dowiadują się o nim, gdy tylko mogą go dostać. Słowo to pierwotnie oznaczało zmianę zastosowaną na „gorącym” systemie, czyli serwerze wciąż obsługującym użytkowników, a dziś opisuje raczej pilność niż sposób instalacji poprawki.
| Termin | Czym jest | Kiedy trafia do użytkowników | Typowy zakres |
|---|---|---|---|
| Hotfix | Pilna poprawka problemu, na który użytkownicy trafiają teraz | Gdy tylko jest gotowa, poza harmonogramem | Jeden defekt |
| Bugfix | Dowolna poprawka defektu | Zwykle z kolejnym planowanym wydaniem | Jeden lub więcej defektów |
| Patch | Aktualizacja istniejącego oprogramowania; w SemVer wydanie podnoszące ostatnią liczbę | Planowany lub pilny | Poprawki zgodne wstecz |
| Service pack lub rollup | Przetestowany, zbiorczy pakiet wcześniejszych poprawek | Według harmonogramu | Wiele poprawek, czasem drobne funkcje |
| Live patch | Poprawka zastosowana do działającego kodu bez restartu | Gdy restart kosztuje za dużo | Kilka funkcji |
Co oznacza hotfix w oprogramowaniu?
Hotfix to szybko wykonana zmiana naprawiająca problem w oprogramowaniu, które jest już w użyciu, wydawana osobno zamiast czekać na następną wersję. Termin niesie dwie idee naraz: problem jest poważny, a zwykły proces został skrócony, by go załatwić.
Artykuł Wikipedii o hotfixie opisuje tę zmianę znaczenia. Termin pierwotnie odnosił się do łatania gorącego systemu, czyli serwera produkcyjnego aktywnie obsługującego klientów, a z czasem zaczął oznaczać każdą aktualizację przygotowaną w pośpiechu lub wydaną poza normalnym cyklem aktualizacji. Microsoft używał tego słowa przez lata, a potem przeszedł na inną terminologię, choć jego obecna lista typów aktualizacji nadal opisuje service pack jako przetestowany, zbiorczy zestaw hotfixów, aktualizacji zabezpieczeń, aktualizacji krytycznych i aktualizacji. Pierwotne „gorące” znaczenie przetrwało w live patchingu, który dokumentacja livepatch jądra Linux opisuje jako naprawianie krytycznych funkcji bez restartu systemu.
Czym różni się hotfix od patcha?
Patch to każda aktualizacja zmieniająca istniejące oprogramowanie, a hotfix to patch zdefiniowany przez pilność i moment wydania. Każdy hotfix jest patchem; większość patchy jest planowana i trafia do użytkowników z regularnym wydaniem.
Większość zamieszania bierze się z nakładania się tego na wersjonowanie. W Semantic Versioning liczba PATCH rośnie, gdy wprowadzasz poprawki błędów zgodne wstecz, więc hotfix do wersji 2.4.0 zwykle wychodzi jako 2.4.1. Planowane wydanie konserwacyjne też może mieć numer 2.4.1. Numer wersji zapisuje, jakiego rodzaju jest zmiana, a słowo hotfix zapisuje, dlaczego nie mogła czekać. Bugfix to ten sam rodzaj zmiany według normalnego harmonogramu: kod może być identyczny, a różnica polega na tym, czy dla jego wydania przerwano cykl wydań.
Kiedy błąd zasługuje na hotfix?
Gdy koszt pozostawienia go na produkcji do następnego wydania jest wyższy niż ryzyko wypuszczenia zmiany w pośpiechu. Ocenę powinna wydać wskazana osoba, według kryteriów uzgodnionych w spokojnych warunkach, a nie ten, kto jest najbardziej zaniepokojony.
Problemy, które zwykle uzasadniają hotfix:
- Utrata lub uszkodzenie danych, w tym dane zapisane błędnie, które trzeba będzie później oczyścić.
- Luka bezpieczeństwa, która jest wykorzystywana lub łatwa do wykorzystania.
- Zepsuty kluczowy przepływ dla wielu użytkowników: logowanie, płatność, zapis pracy.
- Regresja z ostatniego wydania, która blokuje klientów, którym dzień wcześniej wszystko działało.
- Obowiązek prawny lub umowny, którego oprogramowanie przestało dotrzymywać.
Problemy, które zwykle mogą poczekać na następne wydanie: usterki kosmetyczne, błędy z rozsądnym obejściem i wszystko, co dotyczy niewielu użytkowników i się nie pogarsza. Spisanie tej listy ma znaczenie, bo każda pilna poprawka omija część kontroli chroniących produkcję, a zespół, który robi hotfix ze wszystkiego, po cichu porzucił swój proces wydań.
Jak wydać hotfix bezpiecznie?
Napraw wersję, która faktycznie działa, zmień jak najmniej, przetestuj poprawkę na dokładnie tym buildzie, który wdrożysz, zachowaj drogę powrotu i włącz poprawkę do głównej linii, żeby następne wydanie nie przywróciło błędu.
- Potwierdź i określ zakres. Odtwórz problem, potwierdź, że spełnia powyższe kryteria, i wskaż jednego właściciela poprawki.
- Odgałęź od tego, co jest na produkcji. W modelu git-flow z artykułu Vincenta Driessena o modelu gałęzi gałąź hotfix startuje od tagu produkcyjnego na
master, wersja jest podnoszona od razu, a gotowa gałąź wraca domasteri dodevelop. Własna notka Driessena z 2020 r. do tego artykułu zaleca prostszy przepływ dla aplikacji webowych wdrażanych w sposób ciągły, i tam hotfix to mały pull request do głównej gałęzi, wdrażany natychmiast. - Zrób najmniejszą zmianę, która to naprawia. Żadnego refaktoringu ani dodatkowych funkcji. Wszystko, co nie jest poprawką, może wyjść za tydzień.
- Udowodnij ją. Dodaj test, który odtwarza błąd i zawodzi bez poprawki, a potem uruchom pełny zestaw testów na commicie, który wdrożysz.
- Nadaj wersję i otaguj. Podnieś numer patch i otaguj commit, jak opisano w tekście tagi git i wydania.
- Wdróż z drogą powrotu. Wdrażaj stopniowo, gdy się da, obserwuj poziom błędów i znaj komendę wycofania, zanim będzie potrzebna.
- Włącz z powrotem. Jeśli poprawkę zrobiono na gałęzi wydania, włącz ją do głównej linii tego samego dnia.
Czy hotfix potrzebuje wpisu w changelogu i release notes?
Tak. Użytkownicy, którzy trafili na błąd, muszą wiedzieć, że został naprawiony i co, jeśli cokolwiek, muszą zrobić, a każdy, kto później czyta historię wersji, musi wiedzieć, dlaczego 2.4.1 pojawiło się dwa dni po 2.4.0.
Notatka ma być krótka: co było zepsute, kogo dotyczyło, co zmienia się dla nich i która wersja zawiera poprawkę. Gdy hotfix odpowiada na incydent, obowiązują wskazówki z tekstu o awaryjnych release notes, a dla rutynowej poprawki wystarczy format z tekstu o release notes poprawek błędów. Jeśli wasz pipeline blokuje merge bez wpisu w changelogu, artykuł o egzekwowaniu w CI wyjaśnia, jak obsłużyć pilne wyjątki bez wyłączania bramki. Changeloop przygotowuje szkic wpisu z każdego zmergowanego pull requesta, więc PR z hotfixem dostaje szkic jak każdy inny merge, a recenzent zatwierdza go, zanim cokolwiek zostanie opublikowane.
Jak sprawić, by hotfixy nie stały się rutyną?
Licz je i analizuj każdy z osobna. Hotfix to dowód, że na produkcję trafiło coś, co normalne kontrole powinny były wychwycić, a liczba mówi, czy jest z tym lepiej, czy gorzej.
Metryki dostarczania oprogramowania DORA obejmują change fail rate, czyli odsetek wdrożeń wymagających natychmiastowej interwencji po wypuszczeniu, co prawdopodobnie kończy się wycofaniem lub hotfixem. Rosnący wskaźnik zwykle wskazuje na zbyt duże wydania albo testy omijające całe obszary produktu. Po każdym hotfixie zapytaj, dlaczego błąd się prześlizgnął, i dodaj test, kontrolę lub etap przeglądu, które by go zatrzymały. Artykuł o procesie zarządzania wydaniami opisuje, gdzie te kontrole leżą w normalnym wydaniu.
FAQ
Czy hotfix to to samo co patch? Każdy hotfix jest patchem, bo zmienia istniejące oprogramowanie. Słowo hotfix dodaje, że patch był pilny i wyszedł poza normalnym harmonogramem wydań.
Jaki numer wersji powinien dostać hotfix? Zwykle kolejną wersję patch według Semantic Versioning, więc hotfix do 2.4.0 wychodzi jako 2.4.1. Hotfix powinien zawierać tylko poprawki zgodne wstecz, a dokładnie to obiecuje podniesienie numeru patch.
Kto decyduje, czy błąd wymaga hotfixa? Jedna wskazana rola, na przykład inżynier na dyżurze lub właściciel wydania, według kryteriów spisanych z wyprzedzeniem. Decydowanie komitetem w trakcie incydentu jest wolne, a decydowanie przez tego, kto krzyczy najgłośniej, robi z hotfixów rutynę.
Czy hotfix powinien pomijać code review? Nie. Skróć przegląd, ale go zachowaj: druga osoba potrzebuje kilku minut na przeczytanie dziesięciu linijek zmiany i wyłapuje literówkę, która zamienia jeden incydent w dwa.
Twierdzenia techniczne w tym artykule nie zostały niezależnie zweryfikowane. Jeśli coś się nie zgadza, daj nam znać, a poprawimy to.