Add action type *dynamicFilter

This commit is contained in:
arberkatellari
2025-07-24 16:37:33 +02:00
committed by Dan Christian Bogos
parent 1f49779685
commit c0017d33f1
4 changed files with 221 additions and 0 deletions

View File

@@ -1050,3 +1050,117 @@ func (aL *actDynamicRanking) execute(ctx *context.Context, data utils.MapStorage
}
return
}
// actDynamicFilter processes the `ActionDiktatsOpts` field from the action to construct a Filter
//
// The ActionDiktatsOpts field format is expected as follows:
//
// 0 Tenant: string
// 1 ID: string
// 2 Type: string
// 3 Path: string
// 4 Values: strings separated by "&".
// 5 APIOpts: set of key-value pairs (separated by "&").
//
// Parameters are separated by ";" and must be provided in the specified order.
type actDynamicFilter struct {
config *config.CGRConfig
connMgr *engine.ConnManager
fltrS *engine.FilterS
aCfg *utils.APAction
tnt string
cgrEv *utils.CGREvent
}
func (aL *actDynamicFilter) id() string {
return aL.aCfg.ID
}
func (aL *actDynamicFilter) cfg() *utils.APAction {
return aL.aCfg
}
// execute implements actioner interface
func (aL *actDynamicFilter) execute(ctx *context.Context, data utils.MapStorage, trgID string) (err error) {
if len(aL.config.ActionSCfg().AdminSConns) == 0 {
return fmt.Errorf("no connection with AdminS")
}
data[utils.MetaNow] = time.Now()
data[utils.MetaTenant] = utils.FirstNonEmpty(aL.cgrEv.Tenant, aL.tnt,
config.CgrConfig().GeneralCfg().DefaultTenant)
// Parse action parameters based on the predefined format.
if len(aL.aCfg.Diktats) == 0 {
return fmt.Errorf("No diktats were speified for action <%v>", aL.aCfg.ID)
}
weights := make(map[string]float64) // stores sorting weights by Diktat ID
diktats := make([]*utils.APDiktat, 0) // list of diktats which have *template in opts, will be weight sorted later
for _, diktat := range aL.aCfg.Diktats {
if pass, err := aL.fltrS.Pass(ctx, aL.tnt, diktat.FilterIDs, data); err != nil {
return err
} else if !pass {
continue
}
weight, err := engine.WeightFromDynamics(ctx, diktat.Weights, aL.fltrS, aL.tnt, data)
if err != nil {
return err
}
weights[diktat.ID] = weight
diktats = append(diktats, diktat)
}
// Sort by weight (higher values first).
slices.SortFunc(diktats, func(a, b *utils.APDiktat) int {
return cmp.Compare(weights[b.ID], weights[a.ID])
})
for _, diktat := range diktats {
params := strings.Split(utils.IfaceAsString(diktat.Opts[utils.MetaTemplate]),
utils.InfieldSep)
if len(params) != 6 {
return fmt.Errorf("invalid number of parameters <%d> expected 6", len(params))
}
// parse dynamic parameters
for i := range params {
var onlyEncapsulatead bool
if i == 3 { // dont parse un-encapsulated "< >" string from Path
onlyEncapsulatead = true
}
if params[i], err = utils.ParseParamForDataProvider(params[i], data, onlyEncapsulatead); err != nil {
return err
}
}
// Prepare request arguments based on provided parameters.
args := &engine.FilterWithAPIOpts{
Filter: &engine.Filter{
Tenant: params[0],
ID: params[1],
Rules: []*engine.FilterRule{{
Type: params[2],
Element: params[3],
}},
},
APIOpts: make(map[string]any),
}
// populate Filter's Values
if params[4] != utils.EmptyString {
args.Filter.Rules[0].Values = strings.Split(params[4], utils.ANDSep)
}
// populate Filter's APIOpts
if params[5] != utils.EmptyString {
if err := parseParamStringToMap(params[5], args.APIOpts); err != nil {
return err
}
}
// create the Filter based on the populated parameters
var rply string
if err = aL.connMgr.Call(ctx, aL.config.ActionSCfg().AdminSConns,
utils.AdminSv1SetFilter, args, &rply); err != nil {
return err
}
if blocker, err := engine.BlockerFromDynamics(ctx, diktat.Blockers, aL.fltrS, aL.tnt, data); err != nil {
return err
} else if blocker {
break
}
}
return
}

View File

@@ -45,6 +45,8 @@ func actionTarget(act string) string {
return utils.MetaTrends
case utils.MetaDynamicRanking:
return utils.MetaRankings
case utils.MetaDynamicFilter:
return utils.MetaFilters
default:
return utils.MetaNone
}
@@ -153,6 +155,8 @@ func newActioner(ctx *context.Context, cgrEv *utils.CGREvent, cfg *config.CGRCon
return &actDynamicTrend{cfg, connMgr, fltrS, aCfg, tnt, cgrEv}, nil
case utils.MetaDynamicRanking:
return &actDynamicRanking{cfg, connMgr, fltrS, aCfg, tnt, cgrEv}, nil
case utils.MetaDynamicFilter:
return &actDynamicFilter{cfg, connMgr, fltrS, aCfg, tnt, cgrEv}, nil
default:
return nil, fmt.Errorf("unsupported action type: <%s>", aCfg.Type)

View File

@@ -260,6 +260,7 @@ func TestDynThdIT(t *testing.T) {
utils.MetaResources: {"someID": {}},
utils.MetaTrends: {"someID": {}},
utils.MetaRankings: {"someID": {}},
utils.MetaFilters: {"someID": {}},
},
Actions: []*utils.APAction{
{
@@ -604,6 +605,63 @@ func TestDynThdIT(t *testing.T) {
},
},
},
{
ID: "Dynamic_Filter_ID",
Type: utils.MetaDynamicFilter,
Diktats: []*utils.APDiktat{
{
ID: "CreateDynamicFilter1002",
FilterIDs: []string{"*string:~*req.Account:1002"},
Opts: map[string]any{
"*template": "*tenant;DYNAMICLY_FLTR_<~*req.Account>;*string;~*req.Account;1003&1002;~*opts",
},
Weights: utils.DynamicWeights{
{
Weight: 50,
},
},
},
{
ID: "CreateDynamicFilter1002NotFoundFilter",
FilterIDs: []string{"*string:~*req.Account:1003"},
Opts: map[string]any{
"*template": "*tenant;DYNAMICLY_FLTR_2_<~*req.Account>;*string;~*req.Account;1003&1002;~*opts",
},
Weights: utils.DynamicWeights{
{
Weight: 90,
},
},
},
{
ID: "CreateDynamicFilter1002Blocker",
Opts: map[string]any{
"*template": "*tenant;DYNAMICLY_FLTR_3_<~*req.Account>;*string;~*req.Account;1003&1002;~*opts",
},
Weights: utils.DynamicWeights{
{
Weight: 20,
},
},
Blockers: utils.DynamicBlockers{
{
Blocker: true,
},
},
},
{
ID: "CreateDynamicFilter1002Blocked",
Opts: map[string]any{
"*template": "*tenant;DYNAMICLY_FLTR_4_<~*req.Account>;*string;~*req.Account;1003&1002;~*opts",
},
Weights: utils.DynamicWeights{
{
Weight: 10,
},
},
},
},
},
},
},
}
@@ -1116,4 +1174,48 @@ func TestDynThdIT(t *testing.T) {
}
})
t.Run("GetDynamicFilter", func(t *testing.T) {
var rcv []*engine.Filter
if err := client.Call(context.Background(), utils.AdminSv1GetFilters,
&utils.ArgsItemIDs{
Tenant: utils.CGRateSorg,
}, &rcv); err != nil {
t.Errorf("AdminSv1GetFilters failed unexpectedly: %v", err)
}
if len(rcv) != 2 {
t.Fatalf("AdminSv1GetFilters len(rcv)=%v, want 2", len(rcv))
}
sort.Slice(rcv, func(i, j int) bool {
return rcv[i].ID > rcv[j].ID
})
exp := []*engine.Filter{
{
Tenant: "cgrates.org",
ID: "DYNAMICLY_FLTR_3_1002",
Rules: []*engine.FilterRule{
{
Type: utils.MetaString,
Element: "~*req.Account",
Values: []string{"1003", "1002"},
},
},
},
{
Tenant: "cgrates.org",
ID: "DYNAMICLY_FLTR_1002",
Rules: []*engine.FilterRule{
{
Type: utils.MetaString,
Element: "~*req.Account",
Values: []string{"1003", "1002"},
},
},
},
}
if !reflect.DeepEqual(exp, rcv) {
t.Errorf("Expected <%v>\nReceived <%v>", utils.ToJSON(exp), utils.ToJSON(rcv))
}
})
}

View File

@@ -1152,6 +1152,7 @@ const (
MetaDynamicResource = "*dynamic_resource"
MetaDynamicTrend = "*dynamicTrend"
MetaDynamicRanking = "*dynamicRanking"
MetaDynamicFilter = "*dynamicFilter"
// Diktats Opts Fields
MetaBalancePath = "*balancePath"