Method Stop

coderd/notifications/manager.go:359–400

Stop stops the notifier and waits until it has stopped.

(ctx context.Context)

// Stop stops the notifier and waits until it has stopped.
func (m *Manager) Stop(ctx context.Context) error {
	m.mu.Lock()
	defer m.mu.Unlock()

	if m.closed {
		return nil
	}
	m.closed = true

	m.log.Debug(context.Background(), "graceful stop requested")

	// If the notifier hasn't been started, we don't need to wait for anything.
	// This is only really during testing when we want to enqueue messages only but not deliver them.
	if m.notifier != nil {
		m.notifier.stop()
	}

	// Signal the stop channel to cause loop to exit.
	close(m.stop)

	if m.notifier == nil {
		return nil
	}

	m.mu.Unlock()     // Unlock to avoid blocking loop.
	defer m.mu.Lock() // Re-lock the mutex due to earlier defer.

	// Wait for the manager loop to exit or the context to be canceled, whichever comes first.
	select {
	case <-ctx.Done():
		var errStr string
		if ctx.Err() != nil {
			errStr = ctx.Err().Error()
		}
		// For some reason, slog.Error returns {} for a context error.
		m.log.Error(context.Background(), "graceful stop failed", slog.F("err", errStr))
		return ctx.Err()
	case <-m.done:
		m.log.Debug(context.Background(), "gracefully stopped")
		return nil
	}
}

type dispatchResult struct {
	notifier  uuid.UUID