twitch-bot/internal/actors/log/actor.go

// Package log contains an actor to write bot-log entries from a rule
package log

import (
	"fmt"

	"github.com/pkg/errors"
	"gopkg.in/irc.v4"

	"github.com/sirupsen/logrus"

	"github.com/Luzifer/go_helpers/v2/fieldcollection"
	"github.com/Luzifer/twitch-bot/v3/internal/helpers"
	"github.com/Luzifer/twitch-bot/v3/plugins"
)

var formatMessage plugins.MsgFormatter

// Register provides the plugins.RegisterFunc
func Register(args plugins.RegistrationArguments) error {
	formatMessage = args.FormatMessage

	args.RegisterActor("log", func() plugins.Actor { return &actor{} })

	args.RegisterActorDocumentation(plugins.ActionDocumentation{
		Description: "Print info log-line to bot log",
		Name:        "Log output",
		Type:        "log",

		Fields: []plugins.ActionDocumentationField{
			{
				Default:         "",
				Description:     "Messsage to log into bot-log",
				Key:             "message",
				Name:            "Message",
				Optional:        false,
				SupportTemplate: true,
				Type:            plugins.ActionDocumentationFieldTypeString,
			},
		},
	})

	return nil
}

type actor struct{}

func (actor) Execute(_ *irc.Client, m *irc.Message, r *plugins.Rule, eventData *fieldcollection.FieldCollection, attrs *fieldcollection.FieldCollection) (preventCooldown bool, err error) {
	message, err := formatMessage(attrs.MustString("message", helpers.Ptr("")), m, r, eventData)
	if err != nil {
		return false, errors.Wrap(err, "executing message template")
	}

	logrus.WithFields(logrus.Fields{
		"channel":  plugins.DeriveChannel(m, eventData),
		"rule":     r.UUID,
		"username": plugins.DeriveUser(m, eventData),
	}).Info(message)
	return false, nil
}

func (actor) IsAsync() bool { return true }
func (actor) Name() string  { return "log" }

func (actor) Validate(tplValidator plugins.TemplateValidatorFunc, attrs *fieldcollection.FieldCollection) (err error) {
	if err = attrs.ValidateSchema(
		fieldcollection.MustHaveField(fieldcollection.SchemaField{Name: "message", NonEmpty: true, Type: fieldcollection.SchemaFieldTypeString}),
		helpers.SchemaValidateTemplateField(tplValidator, "message"),
	); err != nil {
		return fmt.Errorf("validating attributes: %w", err)
	}

	return nil
}