step_options.go

package sqlslog

import "log/slog"

type EventOptions struct {
	Msg   string
	Level Level
}

// StepEventMsgBuilder is the function type to format the step log message.
type StepEventMsgBuilder func(step Step, event Event) string

// StepEventMsgWithEventName returns the formatted step log message with the event name.
func StepEventMsgWithEventName(step Step, event Event) string {
	return step.String() + " " + event.String()
}

// StepEventMsgWithoutEventName returns the formatted step log message without the event name.
func StepEventMsgWithoutEventName(step Step, _ Event) string {
	return step.String()
}

// StepOptions is an struct that expresses the options for the step.
type StepOptions struct {
	Start    EventOptions
	Error    EventOptions
	Complete EventOptions

	// ErrorHandler is the function to handle the error.
	// When the error should not be logged as an error but as complete, it should return true.
	// It can also add attributes to the log.
	ErrorHandler func(error) (bool, []slog.Attr)
}

const defaultSlogLevelDiff = 4

func (o *StepOptions) SetLevel(lv Level) {
	o.Start.Level = lv - defaultSlogLevelDiff
	o.Complete.Level = lv
}

func (o *StepOptions) compare(other *StepOptions) bool {
	return o.Start.Level == other.Start.Level &&
		o.Error.Level == other.Error.Level &&
		o.Complete.Level == other.Complete.Level
}

func newStepOptions(f StepEventMsgBuilder, step Step, startLevel, errorLevel, completeLevel Level) *StepOptions {
	return &StepOptions{
		Start:    EventOptions{Msg: f(step, EventStart), Level: startLevel},
		Error:    EventOptions{Msg: f(step, EventError), Level: errorLevel},
		Complete: EventOptions{Msg: f(step, EventComplete), Level: completeLevel},
	}
}

func defaultStepOptions(msgb StepEventMsgBuilder, step Step, completeLevel Level, errHandlers ...func(error) (bool, []slog.Attr)) *StepOptions { // nolint:unparam
	var startLevel Level
	switch completeLevel { // nolint:exhaustive
	case LevelError:
		startLevel = LevelDebug
	case LevelInfo:
		startLevel = LevelTrace
	case LevelDebug:
		startLevel = LevelVerbose
	default:
		startLevel = LevelVerbose
	}
	r := newStepOptions(msgb, step, startLevel, LevelError, completeLevel)
	if len(errHandlers) > 0 {
		r.ErrorHandler = errHandlers[0]
	}
	return r
}