set_run_result.go

package actions

import (
	"github.com/nyaruka/goflow/flows"
	"github.com/nyaruka/goflow/flows/events"
	"github.com/nyaruka/goflow/utils"
)

// TypeSetRunResult is the type for the set run result action
const TypeSetRunResult string = "set_run_result"

// SetRunResultAction can be used to save a result for a flow. The result will be available in the context
// for the run as @run.results.[name]. The optional category can be used as a way of categorizing results,
// this can be useful for reporting or analytics.
//
// Both the value and category fields may be templates. A `run_result_changed` event will be created with the
// final values.
//
//   {
//     "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
//     "type": "set_run_result",
//     "name": "Gender",
//     "value": "m",
//     "category": "Male"
//   }
//
// @action set_run_result
type SetRunResultAction struct {
	BaseAction
	Name     string `json:"name" validate:"required"`
	Value    string `json:"value" validate:"required"`
	Category string `json:"category"`
}

// Type returns the type of this action
func (a *SetRunResultAction) Type() string { return TypeSetRunResult }

// Validate validates our action is valid and has all the assets it needs
func (a *SetRunResultAction) Validate(assets flows.SessionAssets) error {
	return nil
}

// Execute runs this action
func (a *SetRunResultAction) Execute(run flows.FlowRun, step flows.Step, log flows.EventLog) error {
	// get our localized value if any
	template := run.GetText(utils.UUID(a.UUID()), "value", a.Value)
	value, err := run.EvaluateTemplateAsString(template, false)

	// log any error received
	if err != nil {
		log.Add(events.NewErrorEvent(err))
	}

	categoryLocalized := run.GetText(utils.UUID(a.UUID()), "category", a.Category)
	if a.Category == categoryLocalized {
		categoryLocalized = ""
	}

	log.Add(events.NewRunResultChangedEvent(a.Name, value, a.Category, categoryLocalized, step.NodeUUID(), ""))
	return nil
}