Protobuf

.github/workflows/test.yml

@@ -62,3 +62,4 @@ jobs:
         uses: golangci/golangci-lint-action@v3
         with:
           args: --timeout 5000s
+          skip-cache: true

Makefile

@@ -25,8 +25,6 @@ run:
 	export INSTANCE_LISTEN=0.0.0.0
 	export DEBUG=true
 	export LISTEN_ONLY=true
-	export SENTRY_ENVIRONMENT=testing
-	export SENTRY_ENABLED=true
 	$(eval LD_FLAGS := -X beryju.io/gravity/pkg/extconfig.Version=${VERSION} -X beryju.io/gravity/pkg/extconfig.BuildHash=dev-$(shell git rev-parse HEAD))
 	go run ${GO_FLAGS} . server
 
@@ -43,6 +41,12 @@ gen-build:
 	DEBUG=true go run ${GO_FLAGS} . generateSchema ${SCHEMA_FILE}
 	git add ${SCHEMA_FILE}
 
+gen-proto:
+	protoc \
+		--proto_path . \
+		--go_out . \
+		protobuf/**
+
 gen-clean:
 	rm -rf gen-ts-api/
 

go.mod

@@ -47,6 +47,7 @@ require (
 	golang.org/x/net v0.10.0
 	golang.org/x/oauth2 v0.8.0
 	golang.org/x/term v0.8.0
+	google.golang.org/protobuf v1.30.0
 )
 
 require (
@@ -204,7 +205,6 @@ require (
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20221227171554-f9683d7f8bef // indirect
 	google.golang.org/grpc v1.52.3 // indirect
-	google.golang.org/protobuf v1.30.0 // indirect
 	gopkg.in/DataDog/dd-trace-go.v1 v1.47.0 // indirect
 	gopkg.in/cheggaaa/pb.v1 v1.0.28 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect

pkg/roles/discovery/api_devices_test.go

@@ -141,7 +141,7 @@ func TestDeviceApplyDHCPWithDNS(t *testing.T) {
 			dnsTypes.KeyZones,
 			"gravity.beryju.io.",
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustJSON(dns.ZoneContext{}),
 	)
 	inst.KV().Put(
 		ctx,
@@ -150,7 +150,7 @@ func TestDeviceApplyDHCPWithDNS(t *testing.T) {
 			dnsTypes.KeyZones,
 			"0.192.in-addr.arpa.",
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustJSON(dns.ZoneContext{}),
 	)
 
 	// Create DHCP role to register events
@@ -210,7 +210,7 @@ func TestDeviceApplyDHCPWithDNS(t *testing.T) {
 			"test",
 			"A",
 		),
-		dns.Record{
+		dnsTypes.Record{
 			Data: "192.0.2.1",
 		},
 	)
@@ -224,7 +224,7 @@ func TestDeviceApplyDHCPWithDNS(t *testing.T) {
 			"1.2",
 			"PTR",
 		),
-		dns.Record{
+		dnsTypes.Record{
 			Data: "test.gravity.beryju.io.",
 		},
 	)
@@ -257,7 +257,7 @@ func TestDeviceApplyDNSWithReverse(t *testing.T) {
 			dnsTypes.KeyZones,
 			"gravity.beryju.io.",
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustJSON(dns.ZoneContext{}),
 	)
 	inst.KV().Put(
 		ctx,
@@ -266,7 +266,7 @@ func TestDeviceApplyDNSWithReverse(t *testing.T) {
 			dnsTypes.KeyZones,
 			"0.192.in-addr.arpa.",
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustJSON(dns.ZoneContext{}),
 	)
 
 	// Create DNS role to register events
@@ -291,7 +291,7 @@ func TestDeviceApplyDNSWithReverse(t *testing.T) {
 			"test",
 			"A",
 		),
-		dns.Record{
+		dnsTypes.Record{
 			Data: "192.0.2.1",
 		},
 	)
@@ -305,7 +305,7 @@ func TestDeviceApplyDNSWithReverse(t *testing.T) {
 			"1.2",
 			"PTR",
 		),
-		dns.Record{
+		dnsTypes.Record{
 			Data: "test.gravity.beryju.io.",
 		},
 	)

pkg/roles/dns/api_records.go

@@ -73,10 +73,10 @@ func (r *Role) APIRecordsGet() usecase.Interactor {
 				FQDN:         rec.Name + "." + zone.Name,
 				Type:         rec.Type,
 				Data:         rec.Data,
-				MXPreference: rec.MXPreference,
-				SRVPort:      rec.SRVPort,
-				SRVPriority:  rec.SRVPriority,
-				SRVWeight:    rec.SRVWeight,
+				MXPreference: uint16(rec.MxPreference),
+				SRVPort:      uint16(rec.SrvPort),
+				SRVPriority:  uint16(rec.SrvPriority),
+				SRVWeight:    uint16(rec.SrvWeight),
 			})
 		}
 		return nil
@@ -122,10 +122,10 @@ func (r *Role) APIRecordsPut() usecase.Interactor {
 			input.Data = utils.EnsureTrailingPeriod(input.Data)
 		}
 		rec.Data = input.Data
-		rec.MXPreference = input.MXPreference
-		rec.SRVPort = input.SRVPort
-		rec.SRVPriority = input.SRVPriority
-		rec.SRVWeight = input.SRVWeight
+		rec.MxPreference = uint32(input.MXPreference)
+		rec.SrvPort = uint32(input.SRVPort)
+		rec.SrvPriority = uint32(input.SRVPriority)
+		rec.SrvWeight = uint32(input.SRVWeight)
 		err = rec.put(ctx, -1)
 		if err != nil {
 			return status.Wrap(err, status.Internal)

pkg/roles/dns/api_records_test.go

@@ -24,7 +24,7 @@ func TestAPIRecordsGet(t *testing.T) {
 			types.KeyZones,
 			zone,
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustPB(&types.Zone{}),
 	)
 	inst.KV().Put(
 		ctx,
@@ -35,7 +35,7 @@ func TestAPIRecordsGet(t *testing.T) {
 			"test",
 			"A",
 		).String(),
-		tests.MustJSON(dns.Record{
+		tests.MustPB(&types.Record{
 			Data: "192.0.2.1",
 		}),
 	)
@@ -61,7 +61,7 @@ func TestAPIRecordsPut(t *testing.T) {
 			types.KeyZones,
 			name,
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustPB(&types.Zone{}),
 	)
 	assert.NoError(t, role.APIRecordsPut().Interact(ctx, dns.APIRecordsPutInput{
 		Zone:     name,
@@ -80,7 +80,7 @@ func TestAPIRecordsPut(t *testing.T) {
 			"test",
 			"A",
 		),
-		dns.Record{
+		types.Record{
 			Data: "192.0.2.1",
 		},
 	)
@@ -100,7 +100,7 @@ func TestAPIRecordsDelete(t *testing.T) {
 			types.KeyZones,
 			zone,
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustPB(&types.Zone{}),
 	)
 	inst.KV().Put(
 		ctx,
@@ -111,7 +111,7 @@ func TestAPIRecordsDelete(t *testing.T) {
 			"test",
 			"A",
 		).String(),
-		tests.MustJSON(dns.Record{
+		tests.MustPB(&types.Record{
 			Data: "192.0.2.1",
 		}),
 	)

pkg/roles/dns/api_zones.go

@@ -10,6 +10,7 @@ import (
 	"github.com/swaggest/usecase/status"
 	clientv3 "go.etcd.io/etcd/client/v3"
 	"go.uber.org/zap"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 type APIZonesGetInput struct {
@@ -54,11 +55,19 @@ func (r *Role) APIZonesGet() usecase.Interactor {
 			if strings.Contains(_zone.Name, "/") {
 				continue
 			}
+			handlers := []map[string]string{}
+			for _, h := range _zone.HandlerConfigs {
+				hc := map[string]string{}
+				for key, value := range h.Fields {
+					hc[key] = value.GetStringValue()
+				}
+				handlers = append(handlers, hc)
+			}
 			output.Zones = append(output.Zones, APIZone{
 				Name:           _zone.Name,
 				Authoritative:  _zone.Authoritative,
 				DefaultTTL:     _zone.DefaultTTL,
-				HandlerConfigs: _zone.HandlerConfigs,
+				HandlerConfigs: handlers,
 			})
 		}
 		return nil
@@ -85,7 +94,16 @@ func (r *Role) APIZonesPut() usecase.Interactor {
 			z.Name += "."
 		}
 		z.Authoritative = input.Authoritative
-		z.HandlerConfigs = input.HandlerConfigs
+		z.HandlerConfigs = []*structpb.Struct{}
+		for _, h := range input.HandlerConfigs {
+			fields := make(map[string]*structpb.Value)
+			for key, value := range h {
+				fields[key] = structpb.NewStringValue(value)
+			}
+			z.HandlerConfigs = append(z.HandlerConfigs, &structpb.Struct{
+				Fields: fields,
+			})
+		}
 		z.DefaultTTL = input.DefaultTTL
 		err := z.put(ctx)
 		if err != nil {

pkg/roles/dns/api_zones_test.go

@@ -9,6 +9,7 @@ import (
 	"beryju.io/gravity/pkg/roles/dns/types"
 	"beryju.io/gravity/pkg/tests"
 	"github.com/stretchr/testify/assert"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 func TestAPIZonesGet(t *testing.T) {
@@ -24,7 +25,7 @@ func TestAPIZonesGet(t *testing.T) {
 			types.KeyZones,
 			"test.",
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustPB(&types.Zone{}),
 	)
 
 	var output dns.APIZonesGetOutput
@@ -57,11 +58,13 @@ func TestAPIZonesPut(t *testing.T) {
 			types.KeyZones,
 			name,
 		),
-		dns.Zone{
+		types.Zone{
 			Authoritative: true,
-			HandlerConfigs: []map[string]string{
+			HandlerConfigs: []*structpb.Struct{
 				{
-					"type": "etcd",
+					Fields: map[string]*structpb.Value{
+						"type": structpb.NewStringValue("etcd"),
+					},
 				},
 			},
 		},
@@ -83,7 +86,7 @@ func TestAPIZonesDelete(t *testing.T) {
 			types.KeyZones,
 			name,
 		).String(),
-		tests.MustJSON(dns.Zone{}),
+		tests.MustPB(&types.Zone{}),
 	)
 
 	assert.NoError(t, role.APIZonesDelete().Interact(ctx, dns.APIZonesDeleteInput{

pkg/roles/dns/dns_handler.go

@@ -12,9 +12,9 @@ import (
 )
 
 // Find a zone for the given fqdn
-func (r *Role) FindZone(fqdn string) *Zone {
+func (r *Role) FindZone(fqdn string) *ZoneContext {
 	lastLongest := 0
-	var longestZone *Zone
+	var longestZone *ZoneContext
 	for name, zone := range r.zones {
 		// Zone doesn't have the correct suffix for the question
 		if !strings.HasSuffix(fqdn, name) {
@@ -30,7 +30,7 @@ func (r *Role) FindZone(fqdn string) *Zone {
 
 func (ro *Role) Handler(w dns.ResponseWriter, r *dns.Msg) {
 	lastLongest := 0
-	var longestZone *Zone
+	var longestZone *ZoneContext
 
 	span := sentry.StartTransaction(
 		context.TODO(),

pkg/roles/dns/event_handler.go

@@ -36,14 +36,14 @@ func (r *Role) eventCreateForward(ev *roles.Event) {
 		r.log.Warn("failed to parse address to add dns record", zap.Error(err))
 		return
 	}
-	var rec *Record
+	var rec *RecordContext
 	if ip.Is4() {
 		rec = forwardZone.newRecord(hostname, types.DNSRecordTypeA)
 	} else {
 		rec = forwardZone.newRecord(hostname, types.DNSRecordTypeA)
 	}
 	rec.Data = ip.String()
-	rec.TTL = forwardZone.DefaultTTL
+	rec.Ttl = forwardZone.DefaultTTL
 	err = rec.put(ev.Context, 0, ev.Payload.RelatedObjectOptions...)
 	if err != nil {
 		r.log.Warn("failed to save dns record", zap.Error(err))
@@ -74,7 +74,7 @@ func (r *Role) eventCreateReverse(ev *roles.Event) {
 	relName := strings.TrimSuffix(rev, utils.EnsureLeadingPeriod(forwardZone.Name))
 	rec := forwardZone.newRecord(relName, types.DNSRecordTypePTR)
 	rec.Data = fqdn
-	rec.TTL = forwardZone.DefaultTTL
+	rec.Ttl = forwardZone.DefaultTTL
 	err = rec.put(ev.Context, 0, ev.Payload.RelatedObjectOptions...)
 	if err != nil {
 		r.log.Warn("failed to save dns record", zap.Error(err))

pkg/roles/dns/handler_coredns.go

@@ -12,25 +12,26 @@ import (
 	"github.com/miekg/dns"
 	_ "github.com/ori-edge/k8s_gateway"
 	"go.uber.org/zap"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 const CoreDNSType = "coredns"
 
 type CoreDNS struct {
-	c        map[string]string
+	c        map[string]*structpb.Value
 	log      *zap.Logger
 	instance *caddy.Instance
 	srv      *dnsserver.Server
 }
 
-func NewCoreDNS(z *Zone, rawConfig map[string]string) *CoreDNS {
+func NewCoreDNS(z *ZoneContext, rawConfig map[string]*structpb.Value) *CoreDNS {
 	core := &CoreDNS{
 		c: rawConfig,
 	}
 	core.log = z.log.With(zap.String("handler", core.Identifier()))
 	dnsserver.Quiet = true
 	corefile := caddy.CaddyfileInput{
-		Contents:       []byte(core.c["config"]),
+		Contents:       []byte(core.c["config"].GetStringValue()),
 		Filepath:       "in-memory",
 		ServerTypeName: "dns",
 	}

pkg/roles/dns/handler_coredns_test.go

@@ -9,6 +9,7 @@ import (
 	"beryju.io/gravity/pkg/roles/dns/types"
 	"beryju.io/gravity/pkg/tests"
 	"github.com/stretchr/testify/assert"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 const CoreDNSConfig = `.:1342 {
@@ -29,11 +30,13 @@ func TestRoleDNSHandlerCoreDNS(t *testing.T) {
 			types.KeyZones,
 			".",
 		).String(),
-		tests.MustJSON(dns.Zone{
-			HandlerConfigs: []map[string]string{
+		tests.MustPB(&types.Zone{
+			HandlerConfigs: []*structpb.Struct{
 				{
-					"type":   "coredns",
-					"config": CoreDNSConfig,
+					Fields: map[string]*structpb.Value{
+						"type":   structpb.NewStringValue("coredns"),
+						"config": structpb.NewStringValue(CoreDNSConfig),
+					},
 				},
 			},
 		}),