34 Commits

Author SHA1 Message Date
Joel Wetzell
55f5767d47 Merge pull request #11 from jwetzell/feat/raw-framing-default
use RAW framer if no framer specified
2025-12-08 22:44:11 -06:00
Joel Wetzell
66435fc2ba use RAW framer if no framer specified 2025-12-08 22:21:34 -06:00
Joel Wetzell
a85b0e64e0 add RAW framer for passthrough 2025-12-08 19:31:42 -06:00
Joel Wetzell
202d1aea1f add SetupConn method to net.udp.client 2025-12-08 19:22:28 -06:00
Joel Wetzell
3a7b484c76 up buffer size for net.udp.server 2025-12-08 18:03:33 -06:00
Joel Wetzell
ffb39b1034 add tests for framers 2025-12-08 18:03:09 -06:00
Joel Wetzell
bb78b7b08b add tests for string.split 2025-12-07 14:14:46 -06:00
Joel Wetzell
48ac2640d0 add tests for error cases 2025-12-07 14:14:37 -06:00
Joel Wetzell
25324a4dcd Merge pull request #10 from jwetzell/chore/processor-tests
add some basic processor tests
2025-12-07 11:31:05 -06:00
Joel Wetzell
bebcd56d70 add release not config for more labels 2025-12-07 11:28:56 -06:00
Joel Wetzell
ce8e18dd4f fix labeler config 2025-12-07 11:27:15 -06:00
Joel Wetzell
f4021d858b add basic tests for uint.parse 2025-12-07 11:20:50 -06:00
Joel Wetzell
008d7665bd add basic tests for int.parse 2025-12-07 11:20:43 -06:00
Joel Wetzell
917f728f14 add basic tests for float.parse 2025-12-07 11:20:37 -06:00
Joel Wetzell
e3b6783a98 add missing err checking in freed.create 2025-12-07 11:13:10 -06:00
Joel Wetzell
5e7ebd1bf1 rename framing to framer 2025-12-07 10:42:51 -06:00
Joel Wetzell
0bd43ca0c3 rename processing to processor 2025-12-07 10:41:14 -06:00
Joel Wetzell
2e7feede28 fix naming conflict on import 2025-12-07 10:35:11 -06:00
Joel Wetzell
a5deea6447 move route and module into internal 2025-12-07 10:34:58 -06:00
Joel Wetzell
3f6914282b reorder functions 2025-12-06 23:53:32 -06:00
Joel Wetzell
7a01ce6691 convert Route to interface 2025-12-06 23:50:44 -06:00
Joel Wetzell
5be40a5abf add TODO 2025-12-06 23:48:39 -06:00
Joel Wetzell
388851f8bd inject router on HandleInput 2025-12-06 23:08:05 -06:00
Joel Wetzell
9a06949b5b move router to module New func 2025-12-06 23:00:45 -06:00
Joel Wetzell
8d8347fc4d fix import 2025-12-06 23:00:28 -06:00
Joel Wetzell
07108918f1 move config to internal 2025-12-06 22:42:38 -06:00
Joel Wetzell
2c6502b622 add output to net.udp.multicast 2025-12-06 22:36:55 -06:00
Joel Wetzell
4c0f7c1723 move framing creation into shared place 2025-12-06 16:02:35 -06:00
Joel Wetzell
04103cc6ca Merge pull request #9 from jwetzell/feat/serial-client
add serial client module
2025-12-06 14:00:07 -06:00
Joel Wetzell
66097f7297 add serial client module 2025-12-06 13:55:41 -06:00
Joel Wetzell
3eb3ccca0c cleanup copy/paste 2025-12-06 11:01:30 -06:00
Joel Wetzell
55452d9dd0 load udp addr on init in net.udp.server 2025-12-06 11:00:42 -06:00
Joel Wetzell
ed4f7dc1f7 switch to using only TCPConn in net.tcp.server 2025-12-06 10:58:18 -06:00
Joel Wetzell
190bdd8b44 reuse the same UDP client for every output 2025-12-06 10:49:36 -06:00
70 changed files with 1377 additions and 548 deletions

20
.github/labeler.yml vendored
View File

@@ -1,10 +1,22 @@
framing:
config:
- changed-files:
- any-glob-to-any-file: 'internal/framing/**'
- any-glob-to-any-file: 'internal/config/**'
processing:
framer:
- changed-files:
- any-glob-to-any-file: 'internal/processing/**'
- any-glob-to-any-file: 'internal/framer/**'
module:
- changed-files:
- any-glob-to-any-file: 'internal/module/**'
processor:
- changed-files:
- any-glob-to-any-file: 'internal/processor/**'
route:
- changed-files:
- any-glob-to-any-file: 'internal/route/**'
cli:
- changed-files:

17
.github/release.yml vendored
View File

@@ -5,12 +5,21 @@ changelog:
labels:
- dependencies
categories:
- title: Framing 🖼
- title: Config
labels:
- framing
- title: Processing 🏭
- config
- title: Framer 🖼️
labels:
- processing
- framer
- title: Module 📦
labels:
- module
- title: Processor 🏭
labels:
- processor
- title: Route 🛣️
labels:
- route
- title: CLI ⌨️
labels:
- cmd

View File

@@ -8,6 +8,7 @@ import (
"os/signal"
"github.com/jwetzell/showbridge-go"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/urfave/cli/v3"
"sigs.k8s.io/yaml"
)
@@ -54,19 +55,19 @@ func main() {
}
func readConfig(configPath string) (showbridge.Config, error) {
func readConfig(configPath string) (config.Config, error) {
cfg := config.Config{}
configBytes, err := os.ReadFile(configPath)
if err != nil {
return showbridge.Config{}, err
return config.Config{}, err
}
config := showbridge.Config{}
err = yaml.Unmarshal(configBytes, &config)
err = yaml.Unmarshal(configBytes, &cfg)
if err != nil {
return showbridge.Config{}, err
return config.Config{}, err
}
return config, nil
return cfg, nil
}

View File

@@ -1,6 +0,0 @@
package showbridge
type Config struct {
Modules []ModuleConfig `json:"modules"`
Routes []RouteConfig `json:"routes"`
}

2
go.mod
View File

@@ -11,11 +11,13 @@ require (
github.com/nats-io/nats.go v1.47.0
github.com/urfave/cli/v3 v3.6.1
gitlab.com/gomidi/midi/v2 v2.3.16
go.bug.st/serial v1.6.4
modernc.org/quickjs v0.17.0
sigs.k8s.io/yaml v1.6.0
)
require (
github.com/creack/goselect v0.1.2 // indirect
github.com/dustin/go-humanize v1.0.1 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/gorilla/websocket v1.5.3 // indirect

4
go.sum
View File

@@ -1,3 +1,5 @@
github.com/creack/goselect v0.1.2 h1:2DNy14+JPjRBgPzAd1thbQp4BSIihxcBf0IXhQXDRa0=
github.com/creack/goselect v0.1.2/go.mod h1:a/NhLweNvqIYMuxcMOuWY516Cimucms3DglDzQP3hKY=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
@@ -42,6 +44,8 @@ github.com/urfave/cli/v3 v3.6.1 h1:j8Qq8NyUawj/7rTYdBGrxcH7A/j7/G8Q5LhWEW4G3Mo=
github.com/urfave/cli/v3 v3.6.1/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
gitlab.com/gomidi/midi/v2 v2.3.16 h1:yufWSENyjnJ4LFQa9BerzUm4E4aLfTyzw5nmnCteO0c=
gitlab.com/gomidi/midi/v2 v2.3.16/go.mod h1:jDpP4O4skYi+7iVwt6Zyp18bd2M4hkjtMuw2cmgKgfw=
go.bug.st/serial v1.6.4 h1:7FmqNPgVp3pu2Jz5PoPtbZ9jJO5gnEnZIvnI1lzve8A=
go.bug.st/serial v1.6.4/go.mod h1:nofMJxTeNVny/m6+KaafC6vJGj3miwQZ6vW4BZUGJPI=
go.yaml.in/yaml/v2 v2.4.2 h1:DzmwEr2rDGHl7lsFgAHxmNz/1NlQ7xLIrlN2h5d1eGI=
go.yaml.in/yaml/v2 v2.4.2/go.mod h1:081UH+NErpNdqlCXm3TtEran0rJZGxAYx9hb/ELlsPU=
go.yaml.in/yaml/v3 v3.0.3 h1:bXOww4E/J3f66rav3pX3m8w6jDE4knZjGOw8b5Y6iNE=

23
internal/config/config.go Normal file
View File

@@ -0,0 +1,23 @@
package config
type Config struct {
Modules []ModuleConfig `json:"modules"`
Routes []RouteConfig `json:"routes"`
}
type ModuleConfig struct {
Id string `json:"id"`
Type string `json:"type"`
Params map[string]any `json:"params"`
}
type RouteConfig struct {
Input string `json:"input"`
Processors []ProcessorConfig `json:"processors"`
Output string `json:"output"`
}
type ProcessorConfig struct {
Type string `json:"type"`
Params map[string]any `json:"params"`
}

29
internal/framer/framer.go Normal file
View File

@@ -0,0 +1,29 @@
package framer
import (
"fmt"
)
type Framer interface {
Decode([]byte) [][]byte
Encode([]byte) []byte
Clear()
Buffer() []byte
}
func GetFramer(framingType string) (Framer, error) {
switch framingType {
case "CR":
return NewByteSeparatorFramer([]byte{'\r'}), nil
case "LF":
return NewByteSeparatorFramer([]byte{'\n'}), nil
case "CRLF":
return NewByteSeparatorFramer([]byte{'\r', '\n'}), nil
case "SLIP":
return NewSlipFramer(), nil
case "RAW":
return NewRawFramer(), nil
default:
return nil, fmt.Errorf("unknown framing method: %s", framingType)
}
}

23
internal/framer/raw.go Normal file
View File

@@ -0,0 +1,23 @@
package framer
type RawFramer struct{}
func NewRawFramer() *RawFramer {
return &RawFramer{}
}
func (rf *RawFramer) Decode(data []byte) [][]byte {
return [][]byte{data}
}
func (rf *RawFramer) Encode(data []byte) []byte {
return data
}
func (rf *RawFramer) Clear() {
// NOTE(jwetzell): no internal state to clear
}
func (rf *RawFramer) Buffer() []byte {
return []byte{}
}

View File

@@ -1,4 +1,4 @@
package framing
package framer
import (
"bytes"
@@ -35,3 +35,7 @@ func (bsf *ByteSeparatorFramer) Encode(data []byte) []byte {
func (bsf *ByteSeparatorFramer) Clear() {
bsf.buffer = []byte{}
}
func (bsf *ByteSeparatorFramer) Buffer() []byte {
return bsf.buffer
}

View File

@@ -0,0 +1,69 @@
package framer_test
import (
"slices"
"testing"
"github.com/jwetzell/showbridge-go/internal/framer"
)
func TestGoodSeparatorFramer(t *testing.T) {
tests := []struct {
name string
framer framer.Framer
input []byte
expected [][]byte
buffer []byte
}{
{
name: "new line separator",
framer: framer.NewByteSeparatorFramer([]byte{0x0a}),
input: []byte("Hello\nWorld\nThis is a test\n"),
expected: [][]byte{
[]byte("Hello"),
[]byte("World"),
[]byte("This is a test"),
},
buffer: []byte{},
},
{
name: "CRLF separator",
framer: framer.NewByteSeparatorFramer([]byte{0x0d, 0x0a}),
input: []byte("Hello\r\nWorld\r\nThis is a test\r\n"),
expected: [][]byte{
[]byte("Hello"),
[]byte("World"),
[]byte("This is a test"),
},
buffer: []byte{},
},
{
name: "extra data after separator",
framer: framer.NewByteSeparatorFramer([]byte{0x0d, 0x0a}),
input: []byte("Hello\r\nWorld\r\nThis is a test\r\nextra"),
expected: [][]byte{
[]byte("Hello"),
[]byte("World"),
[]byte("This is a test"),
},
buffer: []byte("extra"),
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
frames := test.framer.Decode(test.input)
if len(frames) != len(test.expected) {
t.Errorf("separator framer got %d frames, expected %d", len(frames), len(test.expected))
}
for i, frame := range frames {
if !slices.Equal(frame, test.expected[i]) {
t.Errorf("separator framer frame %d got %s, expected %s", i, frame, test.expected[i])
}
}
if !slices.Equal(test.framer.Buffer(), test.buffer) {
t.Errorf("separator framer buffer got %s, expected %s", test.framer.Buffer(), test.buffer)
}
})
}
}

View File

@@ -1,4 +1,4 @@
package framing
package framer
type SlipFramer struct {
buffer []byte
@@ -74,3 +74,7 @@ func (sf *SlipFramer) Encode(data []byte) []byte {
func (sf *SlipFramer) Clear() {
sf.buffer = []byte{}
}
func (sf *SlipFramer) Buffer() []byte {
return sf.buffer
}

View File

@@ -0,0 +1,45 @@
package framer_test
import (
"slices"
"testing"
"github.com/jwetzell/showbridge-go/internal/framer"
)
func TestGoodSLIPFramer(t *testing.T) {
tests := []struct {
name string
framer framer.Framer
input []byte
expected [][]byte
buffer []byte
}{
{
name: "OSC SLIP messages",
framer: framer.NewSlipFramer(),
input: []byte{0xc0, 0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x00, 0x00, 0x00, 0xc0},
expected: [][]byte{
{0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x00, 0x00, 0x00},
},
buffer: []byte{},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
frames := test.framer.Decode(test.input)
if len(frames) != len(test.expected) {
t.Errorf("SLIP framer got %d frames, expected %d", len(frames), len(test.expected))
}
for i, frame := range frames {
if !slices.Equal(frame, test.expected[i]) {
t.Errorf("SLIP framer frame %d got %s, expected %s", i, frame, test.expected[i])
}
}
if !slices.Equal(test.framer.Buffer(), test.buffer) {
t.Errorf("SLIP framer buffer got %s, expected %s", test.framer.Buffer(), test.buffer)
}
})
}
}

View File

@@ -1,7 +0,0 @@
package framing
type Framer interface {
Decode([]byte) [][]byte
Encode([]byte) []byte
Clear()
}

View File

@@ -1,24 +1,29 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"net/http"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type HTTPClient struct {
config ModuleConfig
router *Router
config config.ModuleConfig
ctx context.Context
client *http.Client
router route.RouteIO
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.http.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
return &HTTPClient{config: config}, nil
return &HTTPClient{config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -31,17 +36,13 @@ func (hc *HTTPClient) Type() string {
return hc.config.Type
}
func (hc *HTTPClient) RegisterRouter(router *Router) {
hc.router = router
}
func (hc *HTTPClient) Run() error {
hc.client = &http.Client{
Timeout: 10 * time.Second,
}
<-hc.router.Context.Done()
<-hc.ctx.Done()
slog.Debug("router context done in module", "id", hc.config.Id)
return nil
}

View File

@@ -1,16 +1,21 @@
package showbridge
package module
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"net/http"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type HTTPServer struct {
config ModuleConfig
config config.ModuleConfig
Port uint16
router *Router
ctx context.Context
router route.RouteIO
}
type ResponseData struct {
@@ -21,7 +26,7 @@ type ResponseData struct {
func init() {
RegisterModule(ModuleRegistration{
Type: "net.http.server",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
port, ok := params["port"]
if !ok {
@@ -34,7 +39,7 @@ func init() {
return nil, fmt.Errorf("net.http.server port must be uint16")
}
return &HTTPServer{Port: uint16(portNum), config: config}, nil
return &HTTPServer{Port: uint16(portNum), config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -47,10 +52,6 @@ func (hs *HTTPServer) Type() string {
return hs.config.Type
}
func (hs *HTTPServer) RegisterRouter(router *Router) {
hs.router = router
}
func (hs *HTTPServer) HandleDefault(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
@@ -87,18 +88,19 @@ func (hs *HTTPServer) Run() error {
}
go func() {
<-hs.router.Context.Done()
<-hs.ctx.Done()
slog.Debug("router context done in module", "id", hs.config.Id)
httpServer.Close()
}()
err := httpServer.ListenAndServe()
slog.Debug("net.http.server closed", "id", hs.config.Id)
// TODO(jwetzell): handle server closed error differently
if err != nil {
return err
}
<-hs.router.Context.Done()
<-hs.ctx.Done()
return nil
}

View File

@@ -1,22 +1,27 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type Interval struct {
config ModuleConfig
config config.ModuleConfig
Duration uint32
router *Router
ctx context.Context
router route.RouteIO
ticker *time.Ticker
}
func init() {
RegisterModule(ModuleRegistration{
Type: "gen.interval",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
duration, ok := params["duration"]
@@ -30,7 +35,7 @@ func init() {
return nil, fmt.Errorf("gen.interval duration must be number")
}
return &Interval{Duration: uint32(durationNum), config: config}, nil
return &Interval{Duration: uint32(durationNum), config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -43,10 +48,6 @@ func (i *Interval) Type() string {
return i.config.Type
}
func (i *Interval) RegisterRouter(router *Router) {
i.router = router
}
func (i *Interval) Run() error {
ticker := time.NewTicker(time.Millisecond * time.Duration(i.Duration))
i.ticker = ticker
@@ -54,7 +55,7 @@ func (i *Interval) Run() error {
for {
select {
case <-i.router.Context.Done():
case <-i.ctx.Done():
slog.Debug("router context done in module", "id", i.config.Id)
return nil
case <-ticker.C:

View File

@@ -1,18 +1,22 @@
//go:build cgo
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
"gitlab.com/gomidi/midi/v2"
_ "gitlab.com/gomidi/midi/v2/drivers/rtmididrv"
)
type MIDIClient struct {
config ModuleConfig
router *Router
config config.ModuleConfig
ctx context.Context
router route.RouteIO
InputPort string
OutputPort string
SendFunc func(midi.Message) error
@@ -22,7 +26,7 @@ func init() {
RegisterModule(ModuleRegistration{
//TODO(jwetzell): find a better namespace than "misc"
Type: "misc.midi.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
input, ok := params["input"]
@@ -48,7 +52,7 @@ func init() {
return nil, fmt.Errorf("misc.midi.client output must be a string")
}
return &MIDIClient{config: config, InputPort: inputString, OutputPort: outputString}, nil
return &MIDIClient{config: config, InputPort: inputString, OutputPort: outputString, ctx: ctx, router: router}, nil
},
})
}
@@ -61,10 +65,6 @@ func (mc *MIDIClient) Type() string {
return mc.config.Type
}
func (mc *MIDIClient) RegisterRouter(router *Router) {
mc.router = router
}
func (mc *MIDIClient) Run() error {
defer midi.CloseDriver()
@@ -98,7 +98,7 @@ func (mc *MIDIClient) Run() error {
mc.SendFunc = send
<-mc.router.Context.Done()
<-mc.ctx.Done()
slog.Debug("router context done in module", "id", mc.config.Id)
return nil
}

View File

@@ -1,33 +1,30 @@
package showbridge
package module
import (
"context"
"fmt"
"sync"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type ModuleError struct {
Index int
Config ModuleConfig
Config config.ModuleConfig
Error error
}
type Module interface {
Id() string
Type() string
RegisterRouter(*Router)
Run() error
Output(any) error
}
type ModuleConfig struct {
Id string `json:"id"`
Type string `json:"type"`
Params map[string]any `json:"params"`
}
type ModuleRegistration struct {
Type string `json:"type"`
New func(ModuleConfig) (Module, error)
New func(context.Context, config.ModuleConfig, route.RouteIO) (Module, error)
}
func RegisterModule(mod ModuleRegistration) {
@@ -42,13 +39,13 @@ func RegisterModule(mod ModuleRegistration) {
moduleRegistryMu.Lock()
defer moduleRegistryMu.Unlock()
if _, ok := moduleRegistry[string(mod.Type)]; ok {
if _, ok := ModuleRegistry[string(mod.Type)]; ok {
panic(fmt.Sprintf("module already registered: %s", mod.Type))
}
moduleRegistry[string(mod.Type)] = mod
ModuleRegistry[string(mod.Type)] = mod
}
var (
moduleRegistryMu sync.RWMutex
moduleRegistry = make(map[string]ModuleRegistration)
ModuleRegistry = make(map[string]ModuleRegistration)
)

View File

@@ -1,16 +1,20 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
mqtt "github.com/eclipse/paho.mqtt.golang"
"github.com/jwetzell/showbridge-go/internal/processing"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/processor"
"github.com/jwetzell/showbridge-go/internal/route"
)
type MQTTClient struct {
config ModuleConfig
router *Router
config config.ModuleConfig
ctx context.Context
router route.RouteIO
Broker string
ClientID string
Topic string
@@ -20,7 +24,7 @@ type MQTTClient struct {
func init() {
RegisterModule(ModuleRegistration{
Type: "net.mqtt.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
broker, ok := params["broker"]
@@ -58,7 +62,7 @@ func init() {
return nil, fmt.Errorf("net.mqtt.client clientId must be string")
}
return &MQTTClient{config: config, Broker: brokerString, Topic: topicString, ClientID: clientIdString}, nil
return &MQTTClient{config: config, Broker: brokerString, Topic: topicString, ClientID: clientIdString, ctx: ctx, router: router}, nil
},
})
}
@@ -71,10 +75,6 @@ func (mc *MQTTClient) Type() string {
return mc.config.Type
}
func (mc *MQTTClient) RegisterRouter(router *Router) {
mc.router = router
}
func (mc *MQTTClient) Run() error {
opts := mqtt.NewClientOptions()
opts.AddBroker(mc.Broker)
@@ -99,13 +99,13 @@ func (mc *MQTTClient) Run() error {
return err
}
<-mc.router.Context.Done()
<-mc.ctx.Done()
slog.Debug("router context done in module", "id", mc.config.Id)
return nil
}
func (mc *MQTTClient) Output(payload any) error {
payloadMessage, ok := payload.(processing.MQTTMessage)
payloadMessage, ok := payload.(processor.MQTTMessage)
if !ok {
return fmt.Errorf("net.mqtt.client is only able to output a MQTTMessage")

View File

@@ -1,16 +1,20 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"github.com/jwetzell/showbridge-go/internal/processing"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/processor"
"github.com/jwetzell/showbridge-go/internal/route"
"github.com/nats-io/nats.go"
)
type NATSClient struct {
config ModuleConfig
router *Router
config config.ModuleConfig
ctx context.Context
router route.RouteIO
URL string
Subject string
client *nats.Conn
@@ -19,7 +23,7 @@ type NATSClient struct {
func init() {
RegisterModule(ModuleRegistration{
Type: "net.nats.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
url, ok := params["url"]
@@ -45,7 +49,7 @@ func init() {
return nil, fmt.Errorf("net.nats.client subject must be string")
}
return &NATSClient{config: config, URL: urlString, Subject: subjectString}, nil
return &NATSClient{config: config, URL: urlString, Subject: subjectString, ctx: ctx, router: router}, nil
},
})
}
@@ -58,10 +62,6 @@ func (nc *NATSClient) Type() string {
return nc.config.Type
}
func (nc *NATSClient) RegisterRouter(router *Router) {
nc.router = router
}
func (nc *NATSClient) Run() error {
client, err := nats.Connect(nc.URL, nats.RetryOnFailedConnect(true))
@@ -86,14 +86,14 @@ func (nc *NATSClient) Run() error {
defer sub.Unsubscribe()
<-nc.router.Context.Done()
<-nc.ctx.Done()
slog.Debug("router context done in module", "id", nc.config.Id)
return nil
}
func (nc *NATSClient) Output(payload any) error {
payloadMessage, ok := payload.(processing.NATSMessage)
payloadMessage, ok := payload.(processor.NATSMessage)
if !ok {
return fmt.Errorf("net.nats.client is only able to output NATSMessage")

View File

@@ -1,27 +1,31 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"net"
"time"
"github.com/jwetzell/psn-go"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type PSNClient struct {
config ModuleConfig
config config.ModuleConfig
conn *net.UDPConn
router *Router
ctx context.Context
router route.RouteIO
decoder *psn.Decoder
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.psn.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
return &PSNClient{config: config, decoder: psn.NewDecoder()}, nil
return &PSNClient{config: config, decoder: psn.NewDecoder(), ctx: ctx, router: router}, nil
},
})
}
@@ -34,10 +38,6 @@ func (pc *PSNClient) Type() string {
return pc.config.Type
}
func (pc *PSNClient) RegisterRouter(router *Router) {
pc.router = router
}
func (pc *PSNClient) Run() error {
addr, err := net.ResolveUDPAddr("udp", "236.10.10.10:56565")
@@ -56,7 +56,7 @@ func (pc *PSNClient) Run() error {
buffer := make([]byte, 2048)
for {
select {
case <-pc.router.Context.Done():
case <-pc.ctx.Done():
// TODO(jwetzell): cleanup?
slog.Debug("router context done in module", "id", pc.config.Id)
return nil

View File

@@ -0,0 +1,174 @@
//go:build cgo
package module
import (
"context"
"fmt"
"log/slog"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/framer"
"github.com/jwetzell/showbridge-go/internal/route"
"go.bug.st/serial"
)
type SerialClient struct {
config config.ModuleConfig
ctx context.Context
router route.RouteIO
Port string
Framer framer.Framer
Mode *serial.Mode
port serial.Port
}
func init() {
RegisterModule(ModuleRegistration{
//TODO(jwetzell): find a better namespace than "misc"
Type: "misc.serial.client",
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
port, ok := params["port"]
if !ok {
return nil, fmt.Errorf("misc.serial.client requires a port parameter")
}
portString, ok := port.(string)
if !ok {
return nil, fmt.Errorf("misc.serial.client port must be a string")
}
framingMethod := "RAW"
framingMethodRaw, ok := params["framing"]
if ok {
framingMethodString, ok := framingMethodRaw.(string)
if !ok {
return nil, fmt.Errorf("misc.serial.client framing method must be a string")
}
framingMethod = framingMethodString
}
framer, err := framer.GetFramer(framingMethod)
if err != nil {
return nil, err
}
buadRate, ok := params["baudRate"]
if !ok {
return nil, fmt.Errorf("misc.serial.client requires a baudRate parameter")
}
baudRateNum, ok := buadRate.(float64)
if !ok {
return nil, fmt.Errorf("misc.serial.client baudRate must be a number")
}
mode := serial.Mode{
BaudRate: int(baudRateNum),
}
return &SerialClient{config: config, Port: portString, Framer: framer, Mode: &mode, ctx: ctx, router: router}, nil
},
})
}
func (mc *SerialClient) Id() string {
return mc.config.Id
}
func (mc *SerialClient) Type() string {
return mc.config.Type
}
func (mc *SerialClient) SetupPort() error {
port, err := serial.Open(mc.Port, mc.Mode)
if err != nil {
return fmt.Errorf("misc.serial.client can't open input port: %s", mc.Port)
}
mc.port = port
return nil
}
func (mc *SerialClient) Run() error {
// TODO(jwetzell): shutdown with router.Context properly
go func() {
<-mc.ctx.Done()
slog.Debug("router context done in module", "id", mc.config.Id)
if mc.port != nil {
mc.port.Close()
}
}()
for {
err := mc.SetupPort()
if err != nil {
if mc.ctx.Err() != nil {
slog.Debug("router context done in module", "id", mc.config.Id)
return nil
}
slog.Error("misc.serial.client", "id", mc.config.Id, "error", err.Error())
time.Sleep(time.Second * 2)
continue
}
buffer := make([]byte, 1024)
select {
case <-mc.ctx.Done():
slog.Debug("router context done in module", "id", mc.config.Id)
return nil
default:
READ:
for {
select {
case <-mc.ctx.Done():
slog.Debug("router context done in module", "id", mc.config.Id)
return nil
default:
byteCount, err := mc.port.Read(buffer)
if err != nil {
mc.Framer.Clear()
break READ
}
if mc.Framer != nil {
if byteCount > 0 {
messages := mc.Framer.Decode(buffer[0:byteCount])
for _, message := range messages {
if mc.router != nil {
mc.router.HandleInput(mc.config.Id, message)
} else {
slog.Error("misc.serial.client has no router", "id", mc.config.Id)
}
}
}
}
}
}
}
}
}
func (mc *SerialClient) Output(payload any) error {
payloadBytes, ok := payload.([]byte)
if !ok {
return fmt.Errorf("misc.serial.client can only ouptut bytes")
}
_, err := mc.port.Write(mc.Framer.Encode(payloadBytes))
return err
}

View File

@@ -1,26 +1,30 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"net"
"time"
"github.com/jwetzell/showbridge-go/internal/framing"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/framer"
"github.com/jwetzell/showbridge-go/internal/route"
)
type TCPClient struct {
config ModuleConfig
framer framing.Framer
config config.ModuleConfig
framer framer.Framer
conn *net.TCPConn
router *Router
ctx context.Context
router route.RouteIO
Addr *net.TCPAddr
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.tcp.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
host, ok := params["host"]
@@ -50,33 +54,26 @@ func init() {
return nil, err
}
framingMethod, ok := params["framing"]
if !ok {
return nil, fmt.Errorf("net.tcp.client requires a framing method")
framingMethod := "RAW"
framingMethodRaw, ok := params["framing"]
if ok {
framingMethodString, ok := framingMethodRaw.(string)
if !ok {
return nil, fmt.Errorf("misc.serial.client framing method must be a string")
}
framingMethod = framingMethodString
}
framingMethodString, ok := framingMethod.(string)
framer, err := framer.GetFramer(framingMethod)
if !ok {
return nil, fmt.Errorf("net.tcp.client framing method must be a string")
if err != nil {
return nil, err
}
var framer framing.Framer
switch framingMethodString {
case "CR":
framer = framing.NewByteSeparatorFramer([]byte{'\r'})
case "LF":
framer = framing.NewByteSeparatorFramer([]byte{'\n'})
case "CRLF":
framer = framing.NewByteSeparatorFramer([]byte{'\r', '\n'})
case "SLIP":
framer = framing.NewSlipFramer()
default:
return nil, fmt.Errorf("unknown framing method: %s", framingMethodString)
}
return &TCPClient{framer: framer, Addr: addr, config: config}, nil
return &TCPClient{framer: framer, Addr: addr, config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -89,15 +86,11 @@ func (tc *TCPClient) Type() string {
return tc.config.Type
}
func (tc *TCPClient) RegisterRouter(router *Router) {
tc.router = router
}
func (tc *TCPClient) Run() error {
// TODO(jwetzell): shutdown with router.Context properly
go func() {
<-tc.router.Context.Done()
<-tc.ctx.Done()
slog.Debug("router context done in module", "id", tc.config.Id)
if tc.conn != nil {
tc.conn.Close()
@@ -107,7 +100,7 @@ func (tc *TCPClient) Run() error {
for {
err := tc.SetupConn()
if err != nil {
if tc.router.Context.Err() != nil {
if tc.ctx.Err() != nil {
slog.Debug("router context done in module", "id", tc.config.Id)
return nil
}
@@ -118,14 +111,14 @@ func (tc *TCPClient) Run() error {
buffer := make([]byte, 1024)
select {
case <-tc.router.Context.Done():
case <-tc.ctx.Done():
slog.Debug("router context done in module", "id", tc.config.Id)
return nil
default:
READ:
for {
select {
case <-tc.router.Context.Done():
case <-tc.ctx.Done():
slog.Debug("router context done in module", "id", tc.config.Id)
return nil
default:

View File

@@ -1,6 +1,7 @@
package showbridge
package module
import (
"context"
"errors"
"fmt"
"log/slog"
@@ -10,25 +11,27 @@ import (
"syscall"
"time"
"github.com/jwetzell/showbridge-go/internal/framing"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/framer"
"github.com/jwetzell/showbridge-go/internal/route"
)
type TCPServer struct {
config ModuleConfig
Ip string
Port uint16
framingMethod string
router *Router
config config.ModuleConfig
Addr *net.TCPAddr
Framer framer.Framer
ctx context.Context
router route.RouteIO
quit chan interface{}
wg sync.WaitGroup
connections []net.Conn
connections []*net.TCPConn
connectionsMu sync.RWMutex
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.tcp.server",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
port, ok := params["port"]
if !ok {
@@ -41,15 +44,23 @@ func init() {
return nil, fmt.Errorf("net.tcp.server port must be a number")
}
framingMethod, ok := params["framing"]
if !ok {
return nil, fmt.Errorf("net.tcp.server requires a framing method")
framingMethod := "RAW"
framingMethodRaw, ok := params["framing"]
if ok {
framingMethodString, ok := framingMethodRaw.(string)
if !ok {
return nil, fmt.Errorf("misc.serial.client framing method must be a string")
}
framingMethod = framingMethodString
}
framingMethodString, ok := framingMethod.(string)
framer, err := framer.GetFramer(framingMethod)
if !ok {
return nil, fmt.Errorf("net.tcp.server framing method must be a string")
if err != nil {
return nil, err
}
ipString := "0.0.0.0"
@@ -65,7 +76,12 @@ func init() {
ipString = specificIpString
}
return &TCPServer{framingMethod: framingMethodString, Port: uint16(portNum), Ip: ipString, config: config, quit: make(chan interface{})}, nil
addr, err := net.ResolveTCPAddr("tcp", fmt.Sprintf("%s:%d", ipString, uint16(portNum)))
if err != nil {
return nil, err
}
return &TCPServer{Framer: framer, Addr: addr, config: config, quit: make(chan interface{}), ctx: ctx, router: router}, nil
},
})
}
@@ -78,28 +94,12 @@ func (ts *TCPServer) Type() string {
return ts.config.Type
}
func (ts *TCPServer) RegisterRouter(router *Router) {
ts.router = router
}
func (ts *TCPServer) handleClient(client net.Conn) {
func (ts *TCPServer) handleClient(client *net.TCPConn) {
ts.connectionsMu.Lock()
ts.connections = append(ts.connections, client)
ts.connectionsMu.Unlock()
slog.Debug("net.tcp.server connection accepted", "id", ts.config.Id, "remoteAddr", client.RemoteAddr().String())
defer client.Close()
var framer framing.Framer
switch ts.framingMethod {
case "LF":
framer = framing.NewByteSeparatorFramer([]byte{'\n'})
case "CR":
framer = framing.NewByteSeparatorFramer([]byte{'\r'})
case "CRLF":
framer = framing.NewByteSeparatorFramer([]byte{'\r', '\n'})
case "SLIP":
framer = framing.NewSlipFramer()
}
buffer := make([]byte, 1024)
ClientRead:
@@ -143,9 +143,9 @@ ClientRead:
}
return
}
if framer != nil {
if ts.Framer != nil {
if byteCount > 0 {
messages := framer.Decode(buffer[0:byteCount])
messages := ts.Framer.Decode(buffer[0:byteCount])
for _, message := range messages {
if ts.router != nil {
ts.router.HandleInput(ts.config.Id, message)
@@ -160,15 +160,14 @@ ClientRead:
}
func (ts *TCPServer) Run() error {
// TODO(jwetzell): switch to net.ListenTCP and move addr resolution to init
listener, err := net.Listen("tcp", fmt.Sprintf("%s:%d", ts.Ip, ts.Port))
listener, err := net.ListenTCP("tcp", ts.Addr)
if err != nil {
return err
}
ts.wg.Add(1)
go func() {
<-ts.router.Context.Done()
<-ts.ctx.Done()
close(ts.quit)
listener.Close()
slog.Debug("router context done in module", "id", ts.config.Id)
@@ -176,7 +175,7 @@ func (ts *TCPServer) Run() error {
AcceptLoop:
for {
conn, err := listener.Accept()
conn, err := listener.AcceptTCP()
if err != nil {
select {
case <-ts.quit:

View File

@@ -1,22 +1,27 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type Timer struct {
config ModuleConfig
config config.ModuleConfig
Duration uint32
router *Router
ctx context.Context
router route.RouteIO
timer *time.Timer
}
func init() {
RegisterModule(ModuleRegistration{
Type: "gen.timer",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
duration, ok := params["duration"]
@@ -30,7 +35,7 @@ func init() {
return nil, fmt.Errorf("gen.timer duration must be a number")
}
return &Timer{Duration: uint32(durationNum), config: config}, nil
return &Timer{Duration: uint32(durationNum), config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -43,16 +48,12 @@ func (t *Timer) Type() string {
return t.config.Type
}
func (t *Timer) RegisterRouter(router *Router) {
t.router = router
}
func (t *Timer) Run() error {
t.timer = time.NewTimer(time.Millisecond * time.Duration(t.Duration))
defer t.timer.Stop()
for {
select {
case <-t.router.Context.Done():
case <-t.ctx.Done():
t.timer.Stop()
slog.Debug("router context done in module", "id", t.config.Id)
return nil

View File

@@ -1,24 +1,28 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"net"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type UDPClient struct {
config ModuleConfig
Host string
config config.ModuleConfig
Addr *net.UDPAddr
Port uint16
conn *net.UDPConn
router *Router
addr *net.UDPAddr
ctx context.Context
router route.RouteIO
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.udp.client",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
host, ok := params["host"]
@@ -43,7 +47,12 @@ func init() {
return nil, fmt.Errorf("net.udp.client port must be a number")
}
return &UDPClient{Host: hostString, Port: uint16(portNum), config: config}, nil
addr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", hostString, uint16(portNum)))
if err != nil {
return nil, err
}
return &UDPClient{Addr: addr, config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -56,20 +65,20 @@ func (uc *UDPClient) Type() string {
return uc.config.Type
}
func (uc *UDPClient) RegisterRouter(router *Router) {
uc.router = router
func (uc *UDPClient) SetupConn() error {
client, err := net.DialUDP("udp", nil, uc.Addr)
uc.conn = client
return err
}
func (uc *UDPClient) Run() error {
addr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", uc.Host, uc.Port))
err := uc.SetupConn()
if err != nil {
return err
}
uc.addr = addr
<-uc.router.Context.Done()
<-uc.ctx.Done()
slog.Debug("router context done in module", "id", uc.config.Id)
if uc.conn != nil {
uc.conn.Close()
@@ -83,19 +92,14 @@ func (uc *UDPClient) Output(payload any) error {
if !ok {
return fmt.Errorf("net.udp.client is only able to output bytes")
}
if uc.conn != nil {
_, err := uc.conn.Write(payloadBytes)
// TODO(jwetzell): reuse connection or setup new one when necessary
client, err := net.DialUDP("udp", nil, uc.addr)
if err != nil {
return err
}
uc.conn = client
_, err = uc.conn.Write(payloadBytes)
if err != nil {
return err
if err != nil {
return err
}
} else {
return fmt.Errorf("net.udp.client client is not setup")
}
return nil
}

View File

@@ -1,23 +1,28 @@
package showbridge
package module
import (
"context"
"fmt"
"log/slog"
"net"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type UDPMulticast struct {
config ModuleConfig
config config.ModuleConfig
conn *net.UDPConn
router *Router
ctx context.Context
router route.RouteIO
Addr *net.UDPAddr
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.udp.multicast",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
ip, ok := params["ip"]
@@ -46,7 +51,7 @@ func init() {
if err != nil {
return nil, err
}
return &UDPMulticast{config: config, Addr: addr}, nil
return &UDPMulticast{config: config, Addr: addr, ctx: ctx, router: router}, nil
},
})
}
@@ -59,10 +64,6 @@ func (um *UDPMulticast) Type() string {
return um.config.Type
}
func (um *UDPMulticast) RegisterRouter(router *Router) {
um.router = router
}
func (um *UDPMulticast) Run() error {
client, err := net.ListenMulticastUDP("udp", nil, um.Addr)
@@ -76,7 +77,7 @@ func (um *UDPMulticast) Run() error {
buffer := make([]byte, 2048)
for {
select {
case <-um.router.Context.Done():
case <-um.ctx.Done():
// TODO(jwetzell): cleanup?
slog.Debug("router context done in module", "id", um.config.Id)
return nil
@@ -94,9 +95,6 @@ func (um *UDPMulticast) Run() error {
if numBytes > 0 {
message := buffer[:numBytes]
if err != nil {
slog.Error("net.udp.multicast problem decoding psn traffic", "id", um.config.Id, "error", err)
}
if um.router != nil {
um.router.HandleInput(um.config.Id, message)
@@ -109,5 +107,16 @@ func (um *UDPMulticast) Run() error {
}
func (um *UDPMulticast) Output(payload any) error {
return fmt.Errorf("net.udp.multicast output is not implemented")
payloadBytes, ok := payload.([]byte)
if !ok {
return fmt.Errorf("net.udp.multicast can only output bytes")
}
if um.conn == nil {
return fmt.Errorf("net.udp.multicast connection is not setup")
}
_, err := um.conn.Write(payloadBytes)
return err
}

View File

@@ -1,24 +1,28 @@
package showbridge
package module
import (
"context"
"fmt"
"log"
"log/slog"
"net"
"time"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/route"
)
type UDPServer struct {
Ip string
Port uint16
config ModuleConfig
router *Router
Addr *net.UDPAddr
config config.ModuleConfig
ctx context.Context
router route.RouteIO
}
func init() {
RegisterModule(ModuleRegistration{
Type: "net.udp.server",
New: func(config ModuleConfig) (Module, error) {
New: func(ctx context.Context, config config.ModuleConfig, router route.RouteIO) (Module, error) {
params := config.Params
port, ok := params["port"]
if !ok {
@@ -44,7 +48,12 @@ func init() {
ipString = specificIpString
}
return &UDPServer{Ip: ipString, Port: uint16(portNum), config: config}, nil
addr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", ipString, uint16(portNum)))
if err != nil {
log.Fatalf("error resolving UDP address: %v", err)
}
return &UDPServer{Addr: addr, config: config, ctx: ctx, router: router}, nil
},
})
}
@@ -57,29 +66,20 @@ func (us *UDPServer) Type() string {
return us.config.Id
}
func (us *UDPServer) RegisterRouter(router *Router) {
us.router = router
}
func (us *UDPServer) Run() error {
// TODO(jwetzell): move this to init
addr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", us.Ip, us.Port))
if err != nil {
log.Fatalf("error resolving UDP address: %v", err)
}
listener, err := net.ListenUDP("udp", addr)
listener, err := net.ListenUDP("udp", us.Addr)
if err != nil {
return err
}
defer listener.Close()
buffer := make([]byte, 1024)
// TODO(jwetzell): make buffer size configurable
buffer := make([]byte, 65535)
for {
select {
case <-us.router.Context.Done():
case <-us.ctx.Done():
// TODO(jwetzell): cleanup?
slog.Debug("router context done in module", "id", us.config.Id)
return nil

View File

@@ -1,41 +0,0 @@
package processing_test
import (
"testing"
"github.com/jwetzell/showbridge-go/internal/processing"
)
func TestGoodStringDecode(t *testing.T) {
stringDecoder := processing.StringDecode{}
tests := []struct {
processor processing.Processor
name string
payload any
expected string
}{
{
processor: &stringDecoder,
name: "hello",
payload: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
expected: "hello",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
gotString, ok := got.(string)
if !ok {
t.Errorf("string.decode returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("string.decode failed: %s", err)
}
if gotString != test.expected {
t.Errorf("string.decode got %s, expected %s", got, test.expected)
}
})
}
}

View File

@@ -1,42 +0,0 @@
package processing_test
import (
"slices"
"testing"
"github.com/jwetzell/showbridge-go/internal/processing"
)
func TestGoodStringEncode(t *testing.T) {
stringEncoder := processing.StringEncode{}
tests := []struct {
processor processing.Processor
name string
payload any
expected []byte
}{
{
processor: &stringEncoder,
name: "hello",
payload: "hello",
expected: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
gotBytes, ok := got.([]byte)
if !ok {
t.Errorf("string.encode returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("string.encode failed: %s", err)
}
if !slices.Equal(gotBytes, test.expected) {
t.Errorf("string.encode got %s, expected %s", got, test.expected)
}
})
}
}

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"log/slog"
"github.com/jwetzell/showbridge-go/internal/config"
)
type DebugLog struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (dl *DebugLog) Process(ctx context.Context, payload any) (any, error) {
@@ -22,7 +24,7 @@ func (dl *DebugLog) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "debug.log",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &DebugLog{config: config}, nil
},
})

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"strconv"
"github.com/jwetzell/showbridge-go/internal/config"
)
type FloatParse struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (fp *FloatParse) Process(ctx context.Context, payload any) (any, error) {
@@ -32,7 +34,7 @@ func (fp *FloatParse) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "float.parse",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &FloatParse{config: config}, nil
},
})

View File

@@ -0,0 +1,85 @@
package processor_test
import (
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodFloatParse(t *testing.T) {
floatParser := processor.FloatParse{}
tests := []struct {
processor processor.Processor
name string
payload any
expected float64
}{
{
name: "positive number",
payload: "12345.67",
expected: 12345.67,
},
{
name: "negative number",
payload: "-12345.67",
expected: -12345.67,
},
{
name: "zero",
payload: "0",
expected: 0,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := floatParser.Process(t.Context(), test.payload)
gotFloat, ok := got.(float64)
if !ok {
t.Errorf("float.parse returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("float.parse failed: %s", err)
}
if gotFloat != test.expected {
t.Errorf("float.parse got %f, expected %f", gotFloat, test.expected)
}
})
}
}
func TestBadFloatParse(t *testing.T) {
floatParser := processor.FloatParse{}
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
name: "non-string input",
payload: []byte{0x01},
errorString: "float.parse processor only accepts a string",
},
{
name: "not float string",
payload: "abcd",
errorString: "strconv.ParseFloat: parsing \"abcd\": invalid syntax",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := floatParser.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("float.parse expected to fail but succeeded, got: %v", got)
}
if err.Error() != test.errorString {
t.Errorf("float.parse got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"bytes"
@@ -8,10 +8,11 @@ import (
"text/template"
freeD "github.com/jwetzell/free-d-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type FreeDCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Id *template.Template
Pan *template.Template
Tilt *template.Template
@@ -51,6 +52,10 @@ func (fc *FreeDCreate) Process(ctx context.Context, payload any) (any, error) {
panNum, err := strconv.ParseFloat(panString, 32)
if err != nil {
return nil, err
}
var tiltBuffer bytes.Buffer
err = fc.Tilt.Execute(&tiltBuffer, payload)
@@ -62,6 +67,10 @@ func (fc *FreeDCreate) Process(ctx context.Context, payload any) (any, error) {
tiltNum, err := strconv.ParseFloat(tiltString, 32)
if err != nil {
return nil, err
}
var rollBuffer bytes.Buffer
err = fc.Tilt.Execute(&rollBuffer, payload)
@@ -77,10 +86,6 @@ func (fc *FreeDCreate) Process(ctx context.Context, payload any) (any, error) {
return nil, err
}
if err != nil {
return nil, err
}
var posXBuffer bytes.Buffer
err = fc.PosX.Execute(&posXBuffer, payload)
@@ -178,7 +183,7 @@ func (fc *FreeDCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "freed.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
// TODO(jwetzell): make some params optional
params := config.Params

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"context"
@@ -6,10 +6,11 @@ import (
"log/slog"
freeD "github.com/jwetzell/free-d-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type FreeDDecode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (fdd *FreeDDecode) Process(ctx context.Context, payload any) (any, error) {
@@ -33,7 +34,7 @@ func (fdd *FreeDDecode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "freed.decode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &FreeDDecode{config: config}, nil
},
})

View File

@@ -1,14 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
freeD "github.com/jwetzell/free-d-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type FreeDEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (fde *FreeDEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -29,7 +30,7 @@ func (fde *FreeDEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "freed.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &FreeDEncode{config: config}, nil
},
})

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"bytes"
@@ -6,10 +6,12 @@ import (
"fmt"
"net/http"
"text/template"
"github.com/jwetzell/showbridge-go/internal/config"
)
type HTTPRequestCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Method string
URL *template.Template
}
@@ -42,7 +44,7 @@ func (hre *HTTPRequestCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "http.request.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
method, ok := params["method"]

View File

@@ -1,14 +1,16 @@
package processing
package processor
import (
"context"
"fmt"
"io"
"net/http"
"github.com/jwetzell/showbridge-go/internal/config"
)
type HTTPRequestEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (hre *HTTPRequestEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -33,7 +35,7 @@ func (hre *HTTPRequestEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "http.request.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &HTTPRequestEncode{config: config}, nil
},
})

View File

@@ -1,14 +1,16 @@
package processing
package processor
import (
"context"
"fmt"
"net/http"
"regexp"
"github.com/jwetzell/showbridge-go/internal/config"
)
type HTTPRequestFilter struct {
config ProcessorConfig
config config.ProcessorConfig
Path *regexp.Regexp
Method string
}
@@ -41,7 +43,7 @@ func (hrf *HTTPRequestFilter) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "http.request.filter",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
path, ok := params["path"]

View File

@@ -1,14 +1,16 @@
package processing
package processor
import (
"context"
"fmt"
"io"
"net/http"
"github.com/jwetzell/showbridge-go/internal/config"
)
type HTTPResponseEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (hre *HTTPResponseEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -34,7 +36,7 @@ func (hre *HTTPResponseEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "http.response.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &HTTPResponseEncode{config: config}, nil
},
})

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"strconv"
"github.com/jwetzell/showbridge-go/internal/config"
)
type IntParse struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (ip *IntParse) Process(ctx context.Context, payload any) (any, error) {
@@ -32,7 +34,7 @@ func (ip *IntParse) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "int.parse",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &IntParse{config: config}, nil
},
})

View File

@@ -0,0 +1,85 @@
package processor_test
import (
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodIntParse(t *testing.T) {
intParser := processor.IntParse{}
tests := []struct {
processor processor.Processor
name string
payload any
expected int64
}{
{
name: "positive number",
payload: "12345",
expected: 12345,
},
{
name: "negative number",
payload: "-12345",
expected: -12345,
},
{
name: "zero",
payload: "0",
expected: 0,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := intParser.Process(t.Context(), test.payload)
gotInt, ok := got.(int64)
if !ok {
t.Errorf("int.parse returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("int.parse failed: %s", err)
}
if gotInt != test.expected {
t.Errorf("int.parse got %d, expected %d", gotInt, test.expected)
}
})
}
}
func TestBadIntParse(t *testing.T) {
intParser := processor.IntParse{}
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
name: "non-string input",
payload: []byte{0x01},
errorString: "int.parse processor only accepts a string",
},
{
name: "not int string",
payload: "123.46",
errorString: "strconv.ParseInt: parsing \"123.46\": invalid syntax",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := intParser.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("int.parse expected to fail but succeeded, got: %v", got)
}
if err.Error() != test.errorString {
t.Errorf("int.parse got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

View File

@@ -1,16 +1,17 @@
//go:build cgo
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
"gitlab.com/gomidi/midi/v2"
)
type MIDIMessageDecode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (mmd *MIDIMessageDecode) Process(ctx context.Context, payload any) (any, error) {
@@ -32,7 +33,7 @@ func (mmd *MIDIMessageDecode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "midi.message.decode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &MIDIMessageDecode{config: config}, nil
},
})

View File

@@ -1,16 +1,17 @@
//go:build cgo
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
"gitlab.com/gomidi/midi/v2"
)
type MIDIMessageEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (mme *MIDIMessageEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -30,7 +31,7 @@ func (mme *MIDIMessageEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "midi.message.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &MIDIMessageEncode{config: config}, nil
},
})

View File

@@ -1,8 +1,10 @@
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
)
type MQTTMessage struct {
@@ -13,7 +15,7 @@ type MQTTMessage struct {
}
type MQTTMessageCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Topic string
QoS byte
Retained bool
@@ -39,7 +41,7 @@ func (mmc *MQTTMessageCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "mqtt.message.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
topic, ok := params["topic"]

View File

@@ -1,14 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
mqtt "github.com/eclipse/paho.mqtt.golang"
"github.com/jwetzell/showbridge-go/internal/config"
)
type MQTTMessageEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (mme *MQTTMessageEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -28,7 +29,7 @@ func (mme *MQTTMessageEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "mqtt.message.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &MQTTMessageEncode{config: config}, nil
},
})

View File

@@ -1,10 +1,12 @@
package processing
package processor
import (
"bytes"
"context"
"fmt"
"text/template"
"github.com/jwetzell/showbridge-go/internal/config"
)
type NATSMessage struct {
@@ -13,7 +15,7 @@ type NATSMessage struct {
}
type NATSMessageCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Subject string
Payload *template.Template
}
@@ -44,7 +46,7 @@ func (nmc *NATSMessageCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "nats.message.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
// TODO(jwetzell): support template for subject
subject, ok := params["subject"]

View File

@@ -1,14 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/nats-io/nats.go"
)
type NATSMessageEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (nme *NATSMessageEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -28,7 +29,7 @@ func (nme *NATSMessageEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "nats.message.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &NATSMessageEncode{config: config}, nil
},
})

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"bytes"
@@ -9,10 +9,11 @@ import (
"text/template"
"github.com/jwetzell/osc-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type OSCMessageCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Address *template.Template
Args []*template.Template
Types string
@@ -76,7 +77,7 @@ func (o *OSCMessageCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "osc.message.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
address, ok := params["address"]

View File

@@ -1,14 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
osc "github.com/jwetzell/osc-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type OSCMessageDecode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (o *OSCMessageDecode) Process(ctx context.Context, payload any) (any, error) {
@@ -40,7 +41,7 @@ func (o *OSCMessageDecode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "osc.message.decode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &OSCMessageDecode{config: config}, nil
},
})

View File

@@ -1,14 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
osc "github.com/jwetzell/osc-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type OSCMessageEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (o *OSCMessageEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -29,7 +30,7 @@ func (o *OSCMessageEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "osc.message.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &OSCMessageEncode{config: config}, nil
},
})

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"context"
@@ -7,10 +7,11 @@ import (
"strings"
"github.com/jwetzell/osc-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type OSCMessageFilter struct {
config ProcessorConfig
config config.ProcessorConfig
Address *regexp.Regexp
}
@@ -36,7 +37,7 @@ func (o *OSCMessageFilter) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "osc.message.filter",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
address, ok := params["address"]

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"bytes"
@@ -7,10 +7,11 @@ import (
"text/template"
osc "github.com/jwetzell/osc-go"
"github.com/jwetzell/showbridge-go/internal/config"
)
type OSCMessageTransform struct {
config ProcessorConfig
config config.ProcessorConfig
Address *template.Template
}
@@ -51,7 +52,7 @@ func (o *OSCMessageTransform) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "osc.message.transform",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
address, ok := params["address"]

View File

@@ -1,9 +1,11 @@
package processing
package processor
import (
"context"
"fmt"
"sync"
"github.com/jwetzell/showbridge-go/internal/config"
)
type Processor interface {
@@ -11,14 +13,9 @@ type Processor interface {
Process(context.Context, any) (any, error)
}
type ProcessorConfig struct {
Type string `json:"type"`
Params map[string]any `json:"params"`
}
type ProcessorRegistration struct {
Type string `json:"type"`
New func(ProcessorConfig) (Processor, error)
New func(config.ProcessorConfig) (Processor, error)
}
func RegisterProcessor(processor ProcessorRegistration) {

View File

@@ -1,4 +1,4 @@
package processing
package processor
import (
"context"
@@ -6,11 +6,12 @@ import (
"github.com/expr-lang/expr"
"github.com/expr-lang/expr/vm"
"github.com/jwetzell/showbridge-go/internal/config"
)
// NOTE(jwetzell): see language definition https://expr-lang.org/docs/language-definition
type ScriptExpr struct {
config ProcessorConfig
config config.ProcessorConfig
Program *vm.Program
}
@@ -31,7 +32,7 @@ func (se *ScriptExpr) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "script.expr",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
expression, ok := params["expression"]

View File

@@ -1,15 +1,16 @@
package processing
package processor
import (
"context"
"encoding/json"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
"modernc.org/quickjs"
)
type ScriptJS struct {
config ProcessorConfig
config config.ProcessorConfig
Program string
}
@@ -67,7 +68,7 @@ func (sj *ScriptJS) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "script.js",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
program, ok := params["program"]

View File

@@ -1,14 +1,16 @@
package processing
package processor
import (
"bytes"
"context"
"fmt"
"text/template"
"github.com/jwetzell/showbridge-go/internal/config"
)
type StringCreate struct {
config ProcessorConfig
config config.ProcessorConfig
Template *template.Template
}
@@ -32,7 +34,7 @@ func (sc *StringCreate) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "string.create",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
tmpl, ok := params["template"]

View File

@@ -1,12 +1,14 @@
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
)
type StringDecode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (sd *StringDecode) Process(ctx context.Context, payload any) (any, error) {
@@ -28,7 +30,7 @@ func (sd *StringDecode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "string.decode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &StringDecode{config: config}, nil
},
})

View File

@@ -0,0 +1,71 @@
package processor_test
import (
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodStringDecode(t *testing.T) {
stringDecoder := processor.StringDecode{}
tests := []struct {
processor processor.Processor
name string
payload any
expected string
}{
{
processor: &stringDecoder,
name: "hello",
payload: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
expected: "hello",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
gotString, ok := got.(string)
if !ok {
t.Errorf("string.decode returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("string.decode failed: %s", err)
}
if gotString != test.expected {
t.Errorf("string.decode got %s, expected %s", got, test.expected)
}
})
}
}
func TestBadStringDecode(t *testing.T) {
stringDecoder := processor.StringDecode{}
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
processor: &stringDecoder,
name: "non-[]byte input",
payload: "hello",
errorString: "string.decode processor only accepts a []byte",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("string.decode expected to fail but got payload: %s", got)
}
if err.Error() != test.errorString {
t.Errorf("string.decode got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

View File

@@ -1,12 +1,14 @@
package processing
package processor
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
)
type StringEncode struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (se *StringEncode) Process(ctx context.Context, payload any) (any, error) {
@@ -28,7 +30,7 @@ func (se *StringEncode) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "string.encode",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &StringEncode{config: config}, nil
},
})

View File

@@ -0,0 +1,72 @@
package processor_test
import (
"slices"
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodStringEncode(t *testing.T) {
stringEncoder := processor.StringEncode{}
tests := []struct {
processor processor.Processor
name string
payload any
expected []byte
}{
{
processor: &stringEncoder,
name: "hello",
payload: "hello",
expected: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
gotBytes, ok := got.([]byte)
if !ok {
t.Errorf("string.encode returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("string.encode failed: %s", err)
}
if !slices.Equal(gotBytes, test.expected) {
t.Errorf("string.encode got %s, expected %s", got, test.expected)
}
})
}
}
func TestBadStringEncode(t *testing.T) {
stringEncoder := processor.StringEncode{}
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
processor: &stringEncoder,
name: "non-string input",
payload: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
errorString: "string.encode processor only accepts a string",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("string.encode expected to fail but got payload: %s", got)
}
if err.Error() != test.errorString {
t.Errorf("string.encode got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"regexp"
"github.com/jwetzell/showbridge-go/internal/config"
)
type StringFilter struct {
config ProcessorConfig
config config.ProcessorConfig
Pattern *regexp.Regexp
}
@@ -32,7 +34,7 @@ func (se *StringFilter) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "string.filter",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
pattern, ok := params["pattern"]

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"strings"
"github.com/jwetzell/showbridge-go/internal/config"
)
type StringSplit struct {
config ProcessorConfig
config config.ProcessorConfig
Separator string
}
@@ -30,7 +32,7 @@ func (se *StringSplit) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "string.split",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
params := config.Params
separator, ok := params["separator"]

View File

@@ -0,0 +1,70 @@
package processor_test
import (
"slices"
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodStringSplit(t *testing.T) {
tests := []struct {
processor processor.Processor
name string
payload any
expected []string
}{
{
processor: &processor.StringSplit{Separator: ","},
name: "comma separated",
payload: "part1,part2,part3",
expected: []string{"part1", "part2", "part3"},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
gotStrings, ok := got.([]string)
if !ok {
t.Errorf("string.split returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("string.split failed: %s", err)
}
if !slices.Equal(gotStrings, test.expected) {
t.Errorf("string.split got %s, expected %s", got, test.expected)
}
})
}
}
func TestBasStringSplit(t *testing.T) {
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
processor: &processor.StringSplit{Separator: ","},
name: "hello",
payload: []byte{0x68, 0x65, 0x6c, 0x6c, 0x6f},
errorString: "string.split only accepts a string",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := test.processor.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("string.split expected error but got none, payload: %s", got)
}
if err.Error() != test.errorString {
t.Errorf("string.split got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

View File

@@ -1,13 +1,15 @@
package processing
package processor
import (
"context"
"fmt"
"strconv"
"github.com/jwetzell/showbridge-go/internal/config"
)
type UintParse struct {
config ProcessorConfig
config config.ProcessorConfig
}
func (up *UintParse) Process(ctx context.Context, payload any) (any, error) {
@@ -32,7 +34,7 @@ func (up *UintParse) Type() string {
func init() {
RegisterProcessor(ProcessorRegistration{
Type: "uint.parse",
New: func(config ProcessorConfig) (Processor, error) {
New: func(config config.ProcessorConfig) (Processor, error) {
return &UintParse{config: config}, nil
},
})

View File

@@ -0,0 +1,80 @@
package processor_test
import (
"testing"
"github.com/jwetzell/showbridge-go/internal/processor"
)
func TestGoodUintParse(t *testing.T) {
uintParser := processor.UintParse{}
tests := []struct {
processor processor.Processor
name string
payload any
expected uint64
}{
{
name: "positive number",
payload: "12345",
expected: 12345,
},
{
name: "zero",
payload: "0",
expected: 0,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := uintParser.Process(t.Context(), test.payload)
gotUint, ok := got.(uint64)
if !ok {
t.Errorf("uint.parse returned a %T payload: %s", got, got)
}
if err != nil {
t.Errorf("uint.parse failed: %s", err)
}
if gotUint != test.expected {
t.Errorf("uint.parse got %d, expected %d", gotUint, test.expected)
}
})
}
}
func TestBadUintParse(t *testing.T) {
uintParser := processor.UintParse{}
tests := []struct {
processor processor.Processor
name string
payload any
errorString string
}{
{
name: "non-string input",
payload: []byte{0x01},
errorString: "uint.parse processor only accepts a string",
},
{
name: "not uint string",
payload: "-1234",
errorString: "strconv.ParseUint: parsing \"-1234\": invalid syntax",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := uintParser.Process(t.Context(), test.payload)
if err == nil {
t.Errorf("uint.parse expected to fail but succeeded, got: %v", got)
}
if err.Error() != test.errorString {
t.Errorf("uint.parse got error '%s', expected '%s'", err.Error(), test.errorString)
}
})
}
}

86
internal/route/route.go Normal file
View File

@@ -0,0 +1,86 @@
package route
import (
"context"
"fmt"
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/processor"
)
type RouteError struct {
Index int
Config config.RouteConfig
Error error
}
type RouteIOError struct {
Index int
Error error
}
type RouteIO interface {
HandleInput(sourceId string, payload any) []RouteIOError
HandleOutput(sourceId string, destinationId string, payload any) error
}
type Route interface {
Input() string
Output() string
HandleInput(ctx context.Context, sourceId string, payload any, router RouteIO) error
HandleOutput(ctx context.Context, sourceId string, payload any, router RouteIO) error
}
type ProcessorRoute struct {
input string
processors []processor.Processor
output string
}
func NewRoute(config config.RouteConfig) (Route, error) {
processors := []processor.Processor{}
if len(config.Processors) > 0 {
for _, processorDecl := range config.Processors {
processorInfo, ok := processor.ProcessorRegistry[processorDecl.Type]
if !ok {
return nil, fmt.Errorf("problem loading processor registration for processor type: %s", processorDecl.Type)
}
processor, err := processorInfo.New(processorDecl)
if err != nil {
return nil, err
}
processors = append(processors, processor)
}
}
return &ProcessorRoute{input: config.Input, processors: processors, output: config.Output}, nil
}
func (r *ProcessorRoute) Input() string {
return r.input
}
func (r *ProcessorRoute) Output() string {
return r.output
}
func (r *ProcessorRoute) HandleInput(ctx context.Context, sourceId string, payload any, router RouteIO) error {
var err error
for _, processor := range r.processors {
payload, err = processor.Process(ctx, payload)
if err != nil {
return err
}
//NOTE(jwetzell) nil payload will result in the route being "terminated"
if payload == nil {
return nil
}
}
return r.HandleOutput(ctx, sourceId, payload, router)
}
func (r *ProcessorRoute) HandleOutput(ctx context.Context, sourceId string, payload any, router RouteIO) error {
return router.HandleOutput(sourceId, r.output, payload)
}

View File

@@ -1,67 +0,0 @@
package showbridge
import (
"fmt"
"github.com/jwetzell/showbridge-go/internal/processing"
)
type RouteError struct {
Index int
Config RouteConfig
Error error
}
type Route struct {
index int
Input string
Processors []processing.Processor
Output string
router *Router
}
type RouteConfig struct {
Input string `json:"input"`
Processors []processing.ProcessorConfig `json:"processors"`
Output string `json:"output"`
}
func NewRoute(index int, config RouteConfig, router *Router) (*Route, error) {
processors := []processing.Processor{}
if len(config.Processors) > 0 {
for _, processorDecl := range config.Processors {
processorInfo, ok := processing.ProcessorRegistry[processorDecl.Type]
if !ok {
return nil, fmt.Errorf("problem loading processor registration for processor type: %s", processorDecl.Type)
}
processor, err := processorInfo.New(processorDecl)
if err != nil {
return nil, err
}
processors = append(processors, processor)
}
}
return &Route{Input: config.Input, Processors: processors, Output: config.Output, router: router, index: index}, nil
}
func (r *Route) HandleInput(sourceId string, payload any) error {
var err error
for _, processor := range r.Processors {
payload, err = processor.Process(r.router.Context, payload)
if err != nil {
return err
}
//NOTE(jwetzell) nil payload will result in the route being "terminated"
if payload == nil {
return nil
}
}
return r.HandleOutput(sourceId, payload)
}
func (r *Route) HandleOutput(sourceId string, payload any) error {
return r.router.HandleOutput(sourceId, r.Output, payload)
}

View File

@@ -6,23 +6,21 @@ import (
"log/slog"
"os"
"sync"
)
type RoutingError struct {
Index int
Error error
}
"github.com/jwetzell/showbridge-go/internal/config"
"github.com/jwetzell/showbridge-go/internal/module"
"github.com/jwetzell/showbridge-go/internal/route"
)
type Router struct {
contextCancel context.CancelFunc
Context context.Context
ModuleInstances []Module
RouteInstances []*Route
ModuleInstances []module.Module
RouteInstances []route.Route
moduleWait sync.WaitGroup
}
func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []RouteError) {
func NewRouter(ctx context.Context, config config.Config) (*Router, []module.ModuleError, []route.RouteError) {
logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
@@ -35,20 +33,20 @@ func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []Ro
router := Router{
Context: routerContext,
contextCancel: cancel,
ModuleInstances: []Module{},
RouteInstances: []*Route{},
ModuleInstances: []module.Module{},
RouteInstances: []route.Route{},
}
var moduleErrors []ModuleError
var moduleErrors []module.ModuleError
for moduleIndex, moduleDecl := range config.Modules {
moduleInfo, ok := moduleRegistry[moduleDecl.Type]
moduleInfo, ok := module.ModuleRegistry[moduleDecl.Type]
if !ok {
if moduleErrors == nil {
moduleErrors = []ModuleError{}
moduleErrors = []module.ModuleError{}
}
moduleErrors = append(moduleErrors, ModuleError{
moduleErrors = append(moduleErrors, module.ModuleError{
Index: moduleIndex,
Config: moduleDecl,
Error: fmt.Errorf("module type not defined"),
@@ -61,9 +59,9 @@ func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []Ro
if moduleInstance.Id() == moduleDecl.Id {
moduleInstanceExists = true
if moduleErrors == nil {
moduleErrors = []ModuleError{}
moduleErrors = []module.ModuleError{}
}
moduleErrors = append(moduleErrors, ModuleError{
moduleErrors = append(moduleErrors, module.ModuleError{
Index: moduleIndex,
Config: moduleDecl,
Error: fmt.Errorf("duplicate module id"),
@@ -73,12 +71,12 @@ func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []Ro
}
if !moduleInstanceExists {
moduleInstance, err := moduleInfo.New(moduleDecl)
moduleInstance, err := moduleInfo.New(router.Context, moduleDecl, &router)
if err != nil {
if moduleErrors == nil {
moduleErrors = []ModuleError{}
moduleErrors = []module.ModuleError{}
}
moduleErrors = append(moduleErrors, ModuleError{
moduleErrors = append(moduleErrors, module.ModuleError{
Index: moduleIndex,
Config: moduleDecl,
Error: err,
@@ -91,26 +89,21 @@ func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []Ro
}
var routeErrors []RouteError
var routeErrors []route.RouteError
for routeIndex, routeDecl := range config.Routes {
route, err := NewRoute(routeIndex, routeDecl, &router)
routeInstance, err := route.NewRoute(routeDecl)
if err != nil {
if routeErrors == nil {
routeErrors = []RouteError{}
routeErrors = []route.RouteError{}
}
routeErrors = append(routeErrors, RouteError{
routeErrors = append(routeErrors, route.RouteError{
Index: routeIndex,
Config: routeDecl,
Error: err,
})
continue
}
router.RouteInstances = append(router.RouteInstances, route)
}
for _, moduleInstance := range router.ModuleInstances {
slog.Debug("registering router with module", "id", moduleInstance.Id())
moduleInstance.RegisterRouter(&router)
router.RouteInstances = append(router.RouteInstances, routeInstance)
}
return &router, moduleErrors, routeErrors
@@ -119,7 +112,6 @@ func NewRouter(ctx context.Context, config Config) (*Router, []ModuleError, []Ro
func (r *Router) Run() {
slog.Info("running router")
for _, moduleInstance := range r.ModuleInstances {
moduleInstance.RegisterRouter(r)
r.moduleWait.Add(1)
go func() {
err := moduleInstance.Run()
@@ -138,16 +130,16 @@ func (r *Router) Stop() {
r.contextCancel()
}
func (r *Router) HandleInput(sourceId string, payload any) []RoutingError {
var routingErrors []RoutingError
for routeIndex, route := range r.RouteInstances {
if route.Input == sourceId {
err := route.HandleInput(sourceId, payload)
func (r *Router) HandleInput(sourceId string, payload any) []route.RouteIOError {
var routingErrors []route.RouteIOError
for routeIndex, routeInstance := range r.RouteInstances {
if routeInstance.Input() == sourceId {
err := routeInstance.HandleInput(r.Context, sourceId, payload, r)
if err != nil {
if routingErrors == nil {
routingErrors = []RoutingError{}
routingErrors = []route.RouteIOError{}
}
routingErrors = append(routingErrors, RoutingError{
routingErrors = append(routingErrors, route.RouteIOError{
Index: routeIndex,
Error: err,
})