-
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 Minimum Transform (#196)
* feat(transform): Add Number Minimum Transform * docs: Add Number Clamp Example * style: Update Clamp Example
- Loading branch information
Showing
10 changed files
with
291 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.clamp` pattern to return a value that is | ||
// constrained to a range, where the range is defined by two constants. | ||
local sub = import '../../../../../build/config/substation.libsonnet'; | ||
|
||
{ | ||
concurrency: 1, | ||
// Use `null` for object keys to operate on the entire message. | ||
transforms: sub.pattern.tf.num.clamp(null, null, 0, 100) + [ | ||
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,3 @@ | ||
-1 | ||
101 | ||
50 |
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,3 @@ | ||
100 | ||
0 | ||
50 |
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_minimum` transform to return the smaller | ||
// 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.min({ 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 | ||
-1 | ||
-1.1 | ||
0 |
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 newNumberMinimum(_ context.Context, cfg config.Config) (*numberMinimum, error) { | ||
conf := numberValConfig{} | ||
if err := iconfig.Decode(cfg.Settings, &conf); err != nil { | ||
return nil, fmt.Errorf("transform number_minimum: %v", err) | ||
} | ||
|
||
if conf.ID == "" { | ||
conf.ID = "number_minimum" | ||
} | ||
|
||
if err := conf.Validate(); err != nil { | ||
return nil, fmt.Errorf("transform %s: %v", conf.ID, err) | ||
} | ||
|
||
tf := numberMinimum{ | ||
conf: conf, | ||
isObject: conf.Object.SourceKey != "" && conf.Object.TargetKey != "", | ||
} | ||
|
||
return &tf, nil | ||
} | ||
|
||
type numberMinimum struct { | ||
conf numberValConfig | ||
isObject bool | ||
} | ||
|
||
func (tf *numberMinimum) 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.Min(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 *numberMinimum) 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 = &numberMinimum{} | ||
|
||
var numberMinimumTests = []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(`0`), | ||
}, | ||
}, | ||
{ | ||
"data", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"value": -1, | ||
}, | ||
}, | ||
[]byte(`0`), | ||
[][]byte{ | ||
[]byte(`-1`), | ||
}, | ||
}, | ||
{ | ||
"data", | ||
config.Config{ | ||
Settings: map[string]interface{}{ | ||
"value": -1.1, | ||
}, | ||
}, | ||
[]byte(`0.1`), | ||
[][]byte{ | ||
[]byte(`-1.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":0}`), | ||
}, | ||
}, | ||
{ | ||
"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.1, | ||
}, | ||
}, | ||
[]byte(`{"a":0.1}`), | ||
[][]byte{ | ||
[]byte(`{"a":-1.1}`), | ||
}, | ||
}, | ||
} | ||
|
||
func TestNumberMinimum(t *testing.T) { | ||
ctx := context.TODO() | ||
for _, test := range numberMinimumTests { | ||
t.Run(test.name, func(t *testing.T) { | ||
tf, err := newNumberMinimum(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 benchmarkNumberMinimum(b *testing.B, tf *numberMinimum, data []byte) { | ||
ctx := context.TODO() | ||
msg := message.New().SetData(data) | ||
b.ResetTimer() | ||
|
||
for i := 0; i < b.N; i++ { | ||
_, _ = tf.Transform(ctx, msg) | ||
} | ||
} | ||
|
||
func BenchmarkNumberMinimum(b *testing.B) { | ||
for _, test := range numberMinimumTests { | ||
tf, err := newNumberMinimum(context.TODO(), test.cfg) | ||
if err != nil { | ||
b.Fatal(err) | ||
} | ||
|
||
b.Run(test.name, | ||
func(b *testing.B) { | ||
benchmarkNumberMinimum(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