Function shouldPropagateError

agent/agent.go:2500–2523

shouldPropagateError decides whether an error from an API connection routine should be propagated to the apiConnRoutineManager. Its purpose is to prevent errors related to shutting down from propagating to the manager's error group, which will tear down the API connection and potentially stop gracef

(ctx context.Context, logger slog.Logger, err error)

// apiConnRoutineManager. Its purpose is to prevent errors related to shutting down from propagating to the manager's
// error group, which will tear down the API connection and potentially stop graceful shutdown from succeeding.
func shouldPropagateError(ctx context.Context, logger slog.Logger, err error) error {
	if (xerrors.Is(err, context.Canceled) ||
		xerrors.Is(err, io.EOF)) &&
		ctx.Err() != nil {
		logger.Debug(ctx, "swallowing error because context is canceled", slog.Error(err))
		// Don't propagate context canceled errors to the error group, because we don't want the
		// graceful context being canceled to halt the work of routines with
		// gracefulShutdownBehaviorRemain. Unfortunately, the dRPC library closes the stream
		// when context is canceled on an RPC, so canceling the context can also show up as
		// io.EOF. Also, when Coderd unilaterally closes the API connection (for example if the
		// build is outdated), it can sometimes show up as context.Canceled in our RPC calls.
		// We can't reliably distinguish between a context cancelation and a legit EOF, so we
		// also check that *our* context is currently canceled. If it is, we can safely ignore
		// the error.
		return nil
	}
	if xerrors.Is(err, ErrAgentClosing) {
		logger.Debug(ctx, "swallowing error because agent is closing")
		// This can only be generated when the agent is closing, so we never want it to propagate to other routines.
		// (They are signaled to exit via canceled contexts.)
		return nil
	}
	return err
}

func (a *apiConnRoutineManager) wait() error {
	return a.eg.Wait()