-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(transform): Add Number Maximum Transform (#195)
* feat(transform): Add Number Maximum Transform * test: Add Unit Tests
- Loading branch information
Showing
8 changed files
with
292 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
// This example uses the `number_maximum` transform to return the larger | ||
// of two values, where one value is a constant and the other is a message. | ||
local sub = import '../../../../../build/config/substation.libsonnet'; | ||
|
||
{ | ||
concurrency: 1, | ||
transforms: [ | ||
sub.tf.num.max({ value: 0 }), | ||
sub.tf.send.stdout(), | ||
], | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
0 | ||
-1 | ||
-1.1 | ||
10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
0 | ||
0 | ||
0 | ||
10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
package transform | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"math" | ||
|
||
"github.com/brexhq/substation/config" | ||
iconfig "github.com/brexhq/substation/internal/config" | ||
"github.com/brexhq/substation/message" | ||
) | ||
|
||
func newNumberMaximum(_ context.Context, cfg config.Config) (*numberMaximum, error) { | ||
conf := numberValConfig{} | ||
if err := iconfig.Decode(cfg.Settings, &conf); err != nil { | ||
return nil, fmt.Errorf("transform number_maximum: %v", err) | ||
} | ||
|
||
if conf.ID == "" { | ||
conf.ID = "number_maximum" | ||
} | ||
|
||
if err := conf.Validate(); err != nil { | ||
return nil, fmt.Errorf("transform %s: %v", conf.ID, err) | ||
} | ||
|
||
tf := numberMaximum{ | ||
conf: conf, | ||
isObject: conf.Object.SourceKey != "" && conf.Object.TargetKey != "", | ||
} | ||
|
||
return &tf, nil | ||
} | ||
|
||
type numberMaximum struct { | ||
conf numberValConfig | ||
isObject bool | ||
} | ||
|
||
func (tf *numberMaximum) Transform(ctx context.Context, msg *message.Message) ([]*message.Message, error) { | ||
if msg.IsControl() { | ||
return []*message.Message{msg}, nil | ||
} | ||
|
||
var value message.Value | ||
if tf.isObject { | ||
value = msg.GetValue(tf.conf.Object.SourceKey) | ||
} else { | ||
value = bytesToValue(msg.Data()) | ||
} | ||
|
||
if !value.Exists() { | ||
return []*message.Message{msg}, nil | ||
} | ||
|
||
flo64 := math.Max(value.Float(), tf.conf.Value) | ||
|
||
if !tf.isObject { | ||
s := numberFloat64ToString(flo64) | ||
msg.SetData([]byte(s)) | ||
|
||
return []*message.Message{msg}, nil | ||
} | ||
|
||
if err := msg.SetValue(tf.conf.Object.TargetKey, flo64); err != nil { | ||
return nil, fmt.Errorf("transform %s: %v", tf.conf.ID, err) | ||
} | ||
|
||
return []*message.Message{msg}, nil | ||
} | ||
|
||
func (tf *numberMaximum) String() string { | ||
b, _ := json.Marshal(tf.conf) | ||
return string(b) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
package transform | ||
|
||
import ( | ||
"context" | ||
"reflect" | ||
"testing" | ||
|
||
"github.com/brexhq/substation/config" | ||
"github.com/brexhq/substation/message" | ||
) | ||
|
||
var _ Transformer = &numberMaximum{} | ||
|
||
var numberMaximumTests = []struct { | ||
name string | ||
cfg config.Config | ||
test []byte | ||
expected [][]byte | ||
}{ | ||
// data tests | ||
{ | ||
"data", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"value": 1, | ||
}, | ||
}, | ||
[]byte(`0`), | ||
[][]byte{ | ||
[]byte(`1`), | ||
}, | ||
}, | ||
{ | ||
"data", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"value": -1, | ||
}, | ||
}, | ||
[]byte(`0`), | ||
[][]byte{ | ||
[]byte(`0`), | ||
}, | ||
}, | ||
{ | ||
"data", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"value": -1.1, | ||
}, | ||
}, | ||
[]byte(`0.1`), | ||
[][]byte{ | ||
[]byte(`0.1`), | ||
}, | ||
}, | ||
// object tests | ||
{ | ||
"object", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"object": map[string]interface{}{ | ||
"source_key": "a", | ||
"target_key": "a", | ||
}, | ||
"value": 1, | ||
}, | ||
}, | ||
[]byte(`{"a":0}`), | ||
[][]byte{ | ||
[]byte(`{"a":1}`), | ||
}, | ||
}, | ||
{ | ||
"object", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"object": map[string]interface{}{ | ||
"source_key": "a", | ||
"target_key": "a", | ||
}, | ||
"value": -1, | ||
}, | ||
}, | ||
[]byte(`{"a":0}`), | ||
[][]byte{ | ||
[]byte(`{"a":0}`), | ||
}, | ||
}, | ||
{ | ||
"object", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"object": map[string]interface{}{ | ||
"source_key": "a", | ||
"target_key": "a", | ||
}, | ||
"value": -1.1, | ||
}, | ||
}, | ||
[]byte(`{"a":0.1}`), | ||
[][]byte{ | ||
[]byte(`{"a":0.1}`), | ||
}, | ||
}, | ||
} | ||
|
||
func TestNumberMaximum(t *testing.T) { | ||
ctx := context.TODO() | ||
for _, test := range numberMaximumTests { | ||
t.Run(test.name, func(t *testing.T) { | ||
tf, err := newNumberMaximum(ctx, test.cfg) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
|
||
msg := message.New().SetData(test.test) | ||
result, err := tf.Transform(ctx, msg) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
|
||
var data [][]byte | ||
for _, c := range result { | ||
data = append(data, c.Data()) | ||
} | ||
|
||
if !reflect.DeepEqual(data, test.expected) { | ||
t.Errorf("expected %s, got %s", test.expected, data) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func benchmarkNumberMaximum(b *testing.B, tf *numberMaximum, data []byte) { | ||
ctx := context.TODO() | ||
msg := message.New().SetData(data) | ||
b.ResetTimer() | ||
|
||
for i := 0; i < b.N; i++ { | ||
_, _ = tf.Transform(ctx, msg) | ||
} | ||
} | ||
|
||
func BenchmarkNumberMaximum(b *testing.B) { | ||
for _, test := range numberMaximumTests { | ||
tf, err := newNumberMaximum(context.TODO(), test.cfg) | ||
if err != nil { | ||
b.Fatal(err) | ||
} | ||
|
||
b.Run(test.name, | ||
func(b *testing.B) { | ||
benchmarkNumberMaximum(b, tf, test.test) | ||
}, | ||
) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters