Отмену контекста легко добавить и легко сделать чуть-чуть неправильно. Вот правила, к которым я возвращаюсь.

Передавайте, не храните

context.Context — это значение уровня запроса. Передавайте его первым аргументом в функции, которые делают I/O; не кладите его в структуру, которая живёт дольше запроса. Если типу нужен контекст в каждом методе, вероятно, контекст принадлежит вызывающему.

Каждый блокирующий вызов получает контекст

Запросы к базе, HTTP-запросы, файловые операции и ожидание каналов должны принимать контекст или иметь таймаут. Цикл, который проверяет ctx.Err() только между итерациями, всё равно может надолго заблокироваться внутри одной итерации.

Отменяйте соседей через errgroup

errgroup.WithContext даёт контекст, который отменяется, когда первая горутина возвращает ошибку. Обычно это и нужно для параллельной работы.

ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()

g, ctx := errgroup.WithContext(ctx)
g.Go(func() error { return server.ListenAndServe() })
g.Go(func() error {
    <-ctx.Done()
    shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()
    return server.Shutdown(shutdownCtx)
})
if err := g.Wait(); err != nil && !errors.Is(err, http.ErrServerClosed) {
    log.Fatal(err)
}

Отличайте отмену от ошибки

Когда запрос отменён, вызывающий обычно не хочет страницу ошибки или повтор. Проверяйте ctx.Err() перед тем, как логировать сбой как баг. И наоборот: превышение дедлайна — не то же самое, что закрытый таб; оба являются отменой, но только один заслуживает алерта.

Результат

Цель — не отменить всё. Цель — сделать отмену явной, чтобы shutdown и таймауты вели себя одинаково в разработке и в продакшене.

← Все заметки