strategy

package
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 25, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// Assignee resolver errors.
	ErrAssigneeServiceNil        = errors.New("assignee service is nil")
	ErrApplicantIDEmpty          = errors.New("applicant ID is empty")
	ErrFormFieldNameEmpty        = errors.New("form field name is empty")
	ErrFormFieldValueEmpty       = errors.New("form field value is empty")
	ErrUnsupportedFieldValueType = errors.New("unsupported form field value type")
	ErrAssigneeResolverNotFound  = errors.New("assignee resolver not found")

	// Registry lookup errors.
	ErrPassRuleNotFound           = errors.New("pass rule strategy not found")
	ErrConditionEvaluatorNotFound = errors.New("condition evaluator not found")

	// Expression evaluation errors.
	ErrExpressionReturnedNonBool = errors.New("expression returned non-bool type")
)
View Source
var Module = fx.Module(
	"vef:approval:strategy",

	fx.Provide(

		fx.Annotate(NewAllPassStrategy, fx.ResultTags(`group:"vef:approval:pass_rule_strategies"`)),
		fx.Annotate(NewOnePassStrategy, fx.ResultTags(`group:"vef:approval:pass_rule_strategies"`)),
		fx.Annotate(NewRatioPassStrategy, fx.ResultTags(`group:"vef:approval:pass_rule_strategies"`)),
		fx.Annotate(NewOneRejectStrategy, fx.ResultTags(`group:"vef:approval:pass_rule_strategies"`)),

		fx.Annotate(NewUserAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewRoleAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewDepartmentAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewSelfAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewSuperiorAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewDepartmentLeaderAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),
		fx.Annotate(NewFormFieldAssigneeResolver, fx.ResultTags(`group:"vef:approval:assignee_resolvers"`)),

		fx.Annotate(NewFieldConditionEvaluator, fx.ResultTags(`group:"vef:approval:condition_evaluators"`)),
		fx.Annotate(NewExpressionConditionEvaluator, fx.ResultTags(`group:"vef:approval:condition_evaluators"`)),

		fx.Annotate(
			NewStrategyRegistry,
			fx.ParamTags(
				`group:"vef:approval:pass_rule_strategies"`,
				`group:"vef:approval:assignee_resolvers"`,
				`group:"vef:approval:condition_evaluators"`,
			),
		),
	),

	fx.Invoke(func(r *StrategyRegistry) error { return r.ValidateBuiltins() }),
)

Module provides built-in strategies with FX group extensibility.

Functions

func NewAllPassStrategy

func NewAllPassStrategy() approval.PassRuleStrategy

NewAllPassStrategy creates a new AllPassStrategy.

func NewExpressionConditionEvaluator

func NewExpressionConditionEvaluator() approval.ConditionEvaluator

NewExpressionConditionEvaluator creates a new ExpressionConditionEvaluator.

func NewFieldConditionEvaluator

func NewFieldConditionEvaluator() approval.ConditionEvaluator

NewFieldConditionEvaluator creates a new FieldConditionEvaluator.

func NewOnePassStrategy

func NewOnePassStrategy() approval.PassRuleStrategy

NewOnePassStrategy creates a new OnePassStrategy.

func NewOneRejectStrategy

func NewOneRejectStrategy() approval.PassRuleStrategy

NewOneRejectStrategy creates a new OneRejectStrategy.

func NewRatioPassStrategy

func NewRatioPassStrategy() approval.PassRuleStrategy

NewRatioPassStrategy creates a new RatioPassStrategy.

Types

type AllPassStrategy

type AllPassStrategy struct{}

AllPassStrategy requires all assignees to approve.

func (*AllPassStrategy) Evaluate

func (*AllPassStrategy) Rule

type AssigneeResolver

type AssigneeResolver interface {
	// Kind returns the assignee kind this resolver handles (user, role, department_leader, superior, etc.).
	Kind() approval.AssigneeKind
	// Resolve resolves concrete assignees from the assignee configuration in ResolveContext.
	Resolve(ctx context.Context, rc *ResolveContext) ([]approval.ResolvedAssignee, error)
}

AssigneeResolver resolves assignees for a specific kind.

func NewDepartmentAssigneeResolver added in v0.20.1

func NewDepartmentAssigneeResolver(svc approval.AssigneeService) AssigneeResolver

NewDepartmentAssigneeResolver creates a new DepartmentAssigneeResolver.

func NewDepartmentLeaderAssigneeResolver added in v0.20.1

func NewDepartmentLeaderAssigneeResolver(svc approval.AssigneeService) AssigneeResolver

NewDepartmentLeaderAssigneeResolver creates a new DepartmentLeaderAssigneeResolver.

func NewFormFieldAssigneeResolver

func NewFormFieldAssigneeResolver() AssigneeResolver

NewFormFieldAssigneeResolver creates a new FormFieldAssigneeResolver.

func NewRoleAssigneeResolver

func NewRoleAssigneeResolver(svc approval.AssigneeService) AssigneeResolver

NewRoleAssigneeResolver creates a new RoleAssigneeResolver.

func NewSelfAssigneeResolver

func NewSelfAssigneeResolver() AssigneeResolver

NewSelfAssigneeResolver creates a new SelfAssigneeResolver.

func NewSuperiorAssigneeResolver

func NewSuperiorAssigneeResolver(svc approval.AssigneeService) AssigneeResolver

NewSuperiorAssigneeResolver creates a new SuperiorAssigneeResolver.

func NewUserAssigneeResolver

func NewUserAssigneeResolver() AssigneeResolver

NewUserAssigneeResolver creates a new UserAssigneeResolver.

type CompositeAssigneeResolver

type CompositeAssigneeResolver struct {
	// contains filtered or unexported fields
}

CompositeAssigneeResolver chains multiple resolvers and resolves assignees based on config kind.

func NewCompositeAssigneeResolver

func NewCompositeAssigneeResolver(resolvers ...AssigneeResolver) *CompositeAssigneeResolver

NewCompositeAssigneeResolver creates a composite resolver from individual resolvers.

func (*CompositeAssigneeResolver) ResolveAll

ResolveAll resolves assignees from multiple configs.

type DepartmentAssigneeResolver added in v0.20.1

type DepartmentAssigneeResolver struct {
	// contains filtered or unexported fields
}

DepartmentAssigneeResolver resolves department leaders as assignees.

func (*DepartmentAssigneeResolver) Kind added in v0.20.1

func (*DepartmentAssigneeResolver) Resolve added in v0.20.1

type DepartmentLeaderAssigneeResolver added in v0.20.1

type DepartmentLeaderAssigneeResolver struct {
	// contains filtered or unexported fields
}

DepartmentLeaderAssigneeResolver resolves department leaders as assignees.

func (*DepartmentLeaderAssigneeResolver) Kind added in v0.20.1

func (*DepartmentLeaderAssigneeResolver) Resolve added in v0.20.1

type ExpressionConditionEvaluator

type ExpressionConditionEvaluator struct{}

ExpressionConditionEvaluator evaluates expr-lang expressions.

func (*ExpressionConditionEvaluator) Evaluate

func (*ExpressionConditionEvaluator) Kind

type FieldConditionEvaluator

type FieldConditionEvaluator struct {
	// contains filtered or unexported fields
}

FieldConditionEvaluator evaluates field-based conditions by converting them to expressions and delegating to ExpressionConditionEvaluator.

func (*FieldConditionEvaluator) Evaluate

func (*FieldConditionEvaluator) Kind

type FormFieldAssigneeResolver

type FormFieldAssigneeResolver struct{}

FormFieldAssigneeResolver resolves assignees from a form field value.

func (*FormFieldAssigneeResolver) Kind

func (*FormFieldAssigneeResolver) Resolve

type OnePassStrategy

type OnePassStrategy struct{}

OnePassStrategy passes when at least one assignee approves.

func (*OnePassStrategy) Evaluate

func (*OnePassStrategy) Rule

type OneRejectStrategy

type OneRejectStrategy struct{}

OneRejectStrategy fails when any assignee rejects (veto power). Note: the Evaluate logic is identical to AllPassStrategy because both strategies share the same semantics under the current PassRuleContext model — any rejection causes failure, and all must approve for success. They are kept separate as distinct PassRule enum values so they can diverge if PassRuleContext is extended in the future (e.g., with an "abstain" status).

func (*OneRejectStrategy) Evaluate

func (*OneRejectStrategy) Rule

type RatioPassStrategy

type RatioPassStrategy struct{}

RatioPassStrategy passes when approval ratio meets threshold.

func (*RatioPassStrategy) Evaluate

func (*RatioPassStrategy) Rule

type ResolveContext

type ResolveContext struct {
	DB                    orm.DB
	ApplicantID           string
	ApplicantName         string
	ApplicantDepartmentID *string
	FormData              approval.FormData
	UserResolver          approval.UserInfoResolver

	IDs       []string
	FormField *string
}

ResolveContext provides context for assignee resolution.

type RoleAssigneeResolver

type RoleAssigneeResolver struct {
	// contains filtered or unexported fields
}

RoleAssigneeResolver resolves assignees from role IDs via AssigneeService.

func (*RoleAssigneeResolver) Kind

func (*RoleAssigneeResolver) Resolve

type SelfAssigneeResolver

type SelfAssigneeResolver struct{}

SelfAssigneeResolver resolves the applicant as assignee.

func (*SelfAssigneeResolver) Kind

func (*SelfAssigneeResolver) Resolve

type StrategyRegistry

type StrategyRegistry struct {
	// contains filtered or unexported fields
}

StrategyRegistry holds all strategy implementations indexed by their type.

func NewStrategyRegistry

func NewStrategyRegistry(
	passRules []approval.PassRuleStrategy,
	assignees []AssigneeResolver,
	conditions []approval.ConditionEvaluator,
) *StrategyRegistry

NewStrategyRegistry creates a registry from slices (designed for FX group injection). It does not validate completeness on construction so test suites can build registries with partial strategy sets. Production modules call ValidateBuiltins via fx.Invoke after construction.

func (*StrategyRegistry) CompositeAssigneeResolver

func (r *StrategyRegistry) CompositeAssigneeResolver() *CompositeAssigneeResolver

CompositeAssigneeResolver returns the cached CompositeAssigneeResolver.

func (*StrategyRegistry) GetConditionEvaluator

GetConditionEvaluator returns the condition evaluator for the given type.

func (*StrategyRegistry) GetPassRuleStrategy

func (r *StrategyRegistry) GetPassRuleStrategy(rule approval.PassRule) (approval.PassRuleStrategy, error)

GetPassRuleStrategy returns the pass rule strategy for the given rule.

func (*StrategyRegistry) ValidateBuiltins added in v0.24.0

func (r *StrategyRegistry) ValidateBuiltins() error

ValidateBuiltins asserts that every built-in enum value the framework guarantees has a registered strategy. The production strategy.Module invokes this during boot so misconfigurations surface immediately rather than as a runtime "strategy not found" error deep inside a flow.

type SuperiorAssigneeResolver

type SuperiorAssigneeResolver struct {
	// contains filtered or unexported fields
}

SuperiorAssigneeResolver resolves the direct superior as assignee.

func (*SuperiorAssigneeResolver) Kind

func (*SuperiorAssigneeResolver) Resolve

type UserAssigneeResolver

type UserAssigneeResolver struct{}

UserAssigneeResolver resolves assignees from fixed user IDs.

func (*UserAssigneeResolver) Kind

func (*UserAssigneeResolver) Resolve

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL