feat!: replace msgpack with protobuf for all NATS messages
Some checks failed
CI / Lint (push) Failing after 3m2s
CI / Test (push) Successful in 3m44s
CI / Release (push) Has been skipped
CI / Notify Downstream (chat-handler) (push) Has been skipped
CI / Notify Downstream (pipeline-bridge) (push) Has been skipped
CI / Notify Downstream (stt-module) (push) Has been skipped
CI / Notify Downstream (tts-module) (push) Has been skipped
CI / Notify Downstream (voice-assistant) (push) Has been skipped
CI / Notify (push) Successful in 1s
Some checks failed
CI / Lint (push) Failing after 3m2s
CI / Test (push) Successful in 3m44s
CI / Release (push) Has been skipped
CI / Notify Downstream (chat-handler) (push) Has been skipped
CI / Notify Downstream (pipeline-bridge) (push) Has been skipped
CI / Notify Downstream (stt-module) (push) Has been skipped
CI / Notify Downstream (tts-module) (push) Has been skipped
CI / Notify Downstream (voice-assistant) (push) Has been skipped
CI / Notify (push) Successful in 1s
BREAKING CHANGE: All NATS message serialization now uses Protocol Buffers. - Added proto/messages/v1/messages.proto with 22 message types - Generated Go code at gen/messagespb/ - messages/ package now exports type aliases to proto types - natsutil.Publish/Request/Decode use proto.Marshal/Unmarshal - Removed legacy MessageHandler, OnMessage, wrapMapHandler - TypedMessageHandler now returns (proto.Message, error) - EffectiveQuery is now a free function: messages.EffectiveQuery(req) - Removed msgpack dependency entirely
This commit is contained in:
@@ -1,13 +1,15 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/nats-io/nats.go"
|
||||
"github.com/vmihailenco/msgpack/v5"
|
||||
"github.com/nats-io/nats.go"
|
||||
"google.golang.org/protobuf/proto"
|
||||
|
||||
"git.daviestechlabs.io/daviestechlabs/handler-base/config"
|
||||
"git.daviestechlabs.io/daviestechlabs/handler-base/config"
|
||||
pb "git.daviestechlabs.io/daviestechlabs/handler-base/gen/messagespb"
|
||||
"git.daviestechlabs.io/daviestechlabs/handler-base/natsutil"
|
||||
)
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
@@ -15,75 +17,75 @@ import (
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
func TestNewHandler(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
cfg.ServiceName = "test-handler"
|
||||
cfg.NATSQueueGroup = "test-group"
|
||||
cfg := config.Load()
|
||||
cfg.ServiceName = "test-handler"
|
||||
cfg.NATSQueueGroup = "test-group"
|
||||
|
||||
h := New("ai.test.subject", cfg)
|
||||
if h.Subject != "ai.test.subject" {
|
||||
t.Errorf("Subject = %q", h.Subject)
|
||||
}
|
||||
if h.QueueGroup != "test-group" {
|
||||
t.Errorf("QueueGroup = %q", h.QueueGroup)
|
||||
}
|
||||
if h.Settings.ServiceName != "test-handler" {
|
||||
t.Errorf("ServiceName = %q", h.Settings.ServiceName)
|
||||
}
|
||||
h := New("ai.test.subject", cfg)
|
||||
if h.Subject != "ai.test.subject" {
|
||||
t.Errorf("Subject = %q", h.Subject)
|
||||
}
|
||||
if h.QueueGroup != "test-group" {
|
||||
t.Errorf("QueueGroup = %q", h.QueueGroup)
|
||||
}
|
||||
if h.Settings.ServiceName != "test-handler" {
|
||||
t.Errorf("ServiceName = %q", h.Settings.ServiceName)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewHandlerNilSettings(t *testing.T) {
|
||||
h := New("ai.test", nil)
|
||||
if h.Settings == nil {
|
||||
t.Fatal("Settings should be loaded automatically")
|
||||
}
|
||||
if h.Settings.ServiceName != "handler" {
|
||||
t.Errorf("ServiceName = %q, want default", h.Settings.ServiceName)
|
||||
}
|
||||
h := New("ai.test", nil)
|
||||
if h.Settings == nil {
|
||||
t.Fatal("Settings should be loaded automatically")
|
||||
}
|
||||
if h.Settings.ServiceName != "handler" {
|
||||
t.Errorf("ServiceName = %q, want default", h.Settings.ServiceName)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCallbackRegistration(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
setupCalled := false
|
||||
h.OnSetup(func(ctx context.Context) error {
|
||||
setupCalled = true
|
||||
return nil
|
||||
})
|
||||
setupCalled := false
|
||||
h.OnSetup(func(ctx context.Context) error {
|
||||
setupCalled = true
|
||||
return nil
|
||||
})
|
||||
|
||||
teardownCalled := false
|
||||
h.OnTeardown(func(ctx context.Context) error {
|
||||
teardownCalled = true
|
||||
return nil
|
||||
})
|
||||
teardownCalled := false
|
||||
h.OnTeardown(func(ctx context.Context) error {
|
||||
teardownCalled = true
|
||||
return nil
|
||||
})
|
||||
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
return nil, nil
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return nil, nil
|
||||
})
|
||||
|
||||
if h.onSetup == nil || h.onTeardown == nil || h.onMessage == nil {
|
||||
t.Error("callbacks should not be nil after registration")
|
||||
}
|
||||
if h.onSetup == nil || h.onTeardown == nil || h.onTypedMessage == nil {
|
||||
t.Error("callbacks should not be nil after registration")
|
||||
}
|
||||
|
||||
// Verify setup/teardown work when called directly.
|
||||
_ = h.onSetup(context.Background())
|
||||
_ = h.onTeardown(context.Background())
|
||||
if !setupCalled || !teardownCalled {
|
||||
t.Error("callbacks should have been invoked")
|
||||
}
|
||||
// Verify setup/teardown work when called directly.
|
||||
_ = h.onSetup(context.Background())
|
||||
_ = h.onTeardown(context.Background())
|
||||
if !setupCalled || !teardownCalled {
|
||||
t.Error("callbacks should have been invoked")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTypedMessageRegistration(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (any, error) {
|
||||
return map[string]any{"ok": true}, nil
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return &pb.ChatResponse{Response: "ok"}, nil
|
||||
})
|
||||
|
||||
if h.onTypedMessage == nil {
|
||||
t.Error("onTypedMessage should not be nil after registration")
|
||||
}
|
||||
if h.onTypedMessage == nil {
|
||||
t.Error("onTypedMessage should not be nil after registration")
|
||||
}
|
||||
}
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
@@ -91,164 +93,161 @@ func TestTypedMessageRegistration(t *testing.T) {
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
func TestWrapHandler_ValidMessage(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
var receivedData map[string]any
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
receivedData = data
|
||||
return map[string]any{"status": "ok"}, nil
|
||||
})
|
||||
var receivedReq pb.ChatRequest
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
if err := natsutil.Decode(msg.Data, &receivedReq); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &pb.ChatResponse{Response: "ok", UserId: receivedReq.GetUserId()}, nil
|
||||
})
|
||||
|
||||
// Encode a message the same way services would.
|
||||
payload := map[string]any{
|
||||
"request_id": "test-001",
|
||||
"message": "hello",
|
||||
"premium": true,
|
||||
}
|
||||
encoded, err := msgpack.Marshal(payload)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Call wrapHandler directly without NATS.
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test.user.42.message",
|
||||
Data: encoded,
|
||||
})
|
||||
|
||||
if receivedData == nil {
|
||||
t.Fatal("handler was not called")
|
||||
}
|
||||
if receivedData["request_id"] != "test-001" {
|
||||
t.Errorf("request_id = %v", receivedData["request_id"])
|
||||
}
|
||||
if receivedData["premium"] != true {
|
||||
t.Errorf("premium = %v", receivedData["premium"])
|
||||
}
|
||||
// Encode a message the same way services would.
|
||||
encoded, err := proto.Marshal(&pb.ChatRequest{
|
||||
RequestId: "test-001",
|
||||
Message: "hello",
|
||||
Premium: true,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
func TestWrapHandler_InvalidMsgpack(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
// Call wrapHandler directly without NATS.
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test.user.42.message",
|
||||
Data: encoded,
|
||||
})
|
||||
|
||||
handlerCalled := false
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
handlerCalled = true
|
||||
return nil, nil
|
||||
})
|
||||
if receivedReq.GetRequestId() != "test-001" {
|
||||
t.Errorf("request_id = %v", receivedReq.GetRequestId())
|
||||
}
|
||||
if receivedReq.GetPremium() != true {
|
||||
t.Errorf("premium = %v", receivedReq.GetPremium())
|
||||
}
|
||||
}
|
||||
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: []byte{0xFF, 0xFE, 0xFD}, // invalid msgpack
|
||||
})
|
||||
func TestWrapHandler_InvalidMessage(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
if handlerCalled {
|
||||
t.Error("handler should not be called for invalid msgpack")
|
||||
}
|
||||
handlerCalled := false
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
handlerCalled = true
|
||||
var req pb.ChatRequest
|
||||
if err := natsutil.Decode(msg.Data, &req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &pb.ChatResponse{}, nil
|
||||
})
|
||||
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: []byte{0xFF, 0xFE, 0xFD}, // invalid protobuf
|
||||
})
|
||||
|
||||
// The handler IS called (wrapHandler doesn't pre-decode), but it should
|
||||
// return an error from Decode. Either way no panic.
|
||||
_ = handlerCalled
|
||||
}
|
||||
|
||||
func TestWrapHandler_HandlerError(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
return nil, context.DeadlineExceeded
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return nil, context.DeadlineExceeded
|
||||
})
|
||||
|
||||
encoded, _ := msgpack.Marshal(map[string]any{"key": "val"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{RequestId: "err-test"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
|
||||
// Should not panic even when handler returns error.
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: encoded,
|
||||
})
|
||||
// Should not panic even when handler returns error.
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: encoded,
|
||||
})
|
||||
}
|
||||
|
||||
func TestWrapHandler_NilResponse(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
return nil, nil // fire-and-forget style
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return nil, nil // fire-and-forget style
|
||||
})
|
||||
|
||||
encoded, _ := msgpack.Marshal(map[string]any{"x": 1})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{RequestId: "nil-resp"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
|
||||
// Should not panic with nil response and no reply subject.
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: encoded,
|
||||
})
|
||||
// Should not panic with nil response and no reply subject.
|
||||
handler(&nats.Msg{
|
||||
Subject: "ai.test",
|
||||
Data: encoded,
|
||||
})
|
||||
}
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
// wrapHandler dispatch tests — typed handler path
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
func TestWrapTypedHandler_ValidMessage(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
func TestWrapHandler_Typed(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
type testReq struct {
|
||||
RequestID string `msgpack:"request_id"`
|
||||
Message string `msgpack:"message"`
|
||||
}
|
||||
var received pb.ChatRequest
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
if err := natsutil.Decode(msg.Data, &received); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &pb.ChatResponse{UserId: received.GetUserId(), Response: "ok"}, nil
|
||||
})
|
||||
|
||||
var received testReq
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (any, error) {
|
||||
if err := msgpack.Unmarshal(msg.Data, &received); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return map[string]any{"status": "ok"}, nil
|
||||
})
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{
|
||||
RequestId: "typed-001",
|
||||
Message: "hello typed",
|
||||
})
|
||||
|
||||
encoded, _ := msgpack.Marshal(map[string]any{
|
||||
"request_id": "typed-001",
|
||||
"message": "hello typed",
|
||||
})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
|
||||
if received.RequestID != "typed-001" {
|
||||
t.Errorf("RequestID = %q", received.RequestID)
|
||||
}
|
||||
if received.Message != "hello typed" {
|
||||
t.Errorf("Message = %q", received.Message)
|
||||
}
|
||||
if received.GetRequestId() != "typed-001" {
|
||||
t.Errorf("RequestId = %q", received.GetRequestId())
|
||||
}
|
||||
if received.GetMessage() != "hello typed" {
|
||||
t.Errorf("Message = %q", received.GetMessage())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWrapTypedHandler_Error(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
func TestWrapHandler_TypedError(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (any, error) {
|
||||
return nil, context.DeadlineExceeded
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return nil, context.DeadlineExceeded
|
||||
})
|
||||
|
||||
encoded, _ := msgpack.Marshal(map[string]any{"key": "val"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{RequestId: "err"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
|
||||
// Should not panic.
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
// Should not panic.
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
}
|
||||
|
||||
func TestWrapTypedHandler_NilResponse(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
func TestWrapHandler_TypedNilResponse(t *testing.T) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (any, error) {
|
||||
return nil, nil
|
||||
})
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
return nil, nil
|
||||
})
|
||||
|
||||
encoded, _ := msgpack.Marshal(map[string]any{"x": 1})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{RequestId: "nil"})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
handler(&nats.Msg{Subject: "ai.test", Data: encoded})
|
||||
}
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
@@ -256,56 +255,25 @@ func TestWrapTypedHandler_NilResponse(t *testing.T) {
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
func BenchmarkWrapHandler(b *testing.B) {
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
h.OnMessage(func(ctx context.Context, msg *nats.Msg, data map[string]any) (map[string]any, error) {
|
||||
return map[string]any{"ok": true}, nil
|
||||
})
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (proto.Message, error) {
|
||||
var req pb.ChatRequest
|
||||
_ = natsutil.Decode(msg.Data, &req)
|
||||
return &pb.ChatResponse{Response: "ok"}, nil
|
||||
})
|
||||
|
||||
payload := map[string]any{
|
||||
"request_id": "bench-001",
|
||||
"message": "What is the capital of France?",
|
||||
"premium": true,
|
||||
"top_k": 10,
|
||||
}
|
||||
encoded, _ := msgpack.Marshal(payload)
|
||||
handler := h.wrapHandler(context.Background())
|
||||
msg := &nats.Msg{Subject: "ai.test", Data: encoded}
|
||||
encoded, _ := proto.Marshal(&pb.ChatRequest{
|
||||
RequestId: "bench-001",
|
||||
Message: "What is the capital of France?",
|
||||
Premium: true,
|
||||
TopK: 10,
|
||||
})
|
||||
handler := h.wrapHandler(context.Background())
|
||||
msg := &nats.Msg{Subject: "ai.test", Data: encoded}
|
||||
|
||||
b.ResetTimer()
|
||||
for b.Loop() {
|
||||
handler(msg)
|
||||
}
|
||||
b.ResetTimer()
|
||||
for b.Loop() {
|
||||
handler(msg)
|
||||
}
|
||||
|
||||
func BenchmarkWrapTypedHandler(b *testing.B) {
|
||||
type benchReq struct {
|
||||
RequestID string `msgpack:"request_id"`
|
||||
Message string `msgpack:"message"`
|
||||
Premium bool `msgpack:"premium"`
|
||||
TopK int `msgpack:"top_k"`
|
||||
}
|
||||
|
||||
cfg := config.Load()
|
||||
h := New("ai.test", cfg)
|
||||
h.OnTypedMessage(func(ctx context.Context, msg *nats.Msg) (any, error) {
|
||||
var req benchReq
|
||||
_ = msgpack.Unmarshal(msg.Data, &req)
|
||||
return map[string]any{"ok": true}, nil
|
||||
})
|
||||
|
||||
payload := map[string]any{
|
||||
"request_id": "bench-001",
|
||||
"message": "What is the capital of France?",
|
||||
"premium": true,
|
||||
"top_k": 10,
|
||||
}
|
||||
encoded, _ := msgpack.Marshal(payload)
|
||||
handler := h.wrapHandler(context.Background())
|
||||
msg := &nats.Msg{Subject: "ai.test", Data: encoded}
|
||||
|
||||
b.ResetTimer()
|
||||
for b.Loop() {
|
||||
handler(msg)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user