chore: add json.Marshaler/Unmarshaler to protobuf.ResourceSpec

Simplify JSON encoded resource encoding and decoding.

Signed-off-by: Artem Chernyshev <artem.chernyshev@talos-systems.com>

Author: Unix4ever

pkg/resource/protobuf/spec.go

@@ -4,7 +4,11 @@
 
 package protobuf
 
-import "google.golang.org/protobuf/proto"
+import (
+	"encoding/json"
+
+	"google.golang.org/protobuf/proto"
+)
 
 // Spec should be proto.Message and pointer.
 type Spec[T any] interface {
@@ -28,11 +32,23 @@ func (spec ResourceSpec[T, S]) DeepCopy() ResourceSpec[T, S] {
 	}
 }
 
+// MarshalJSON implements json.Marshaler.
+func (spec *ResourceSpec[T, S]) MarshalJSON() ([]byte, error) {
+	return json.Marshal(spec.Value)
+}
+
 // MarshalProto implements ProtoMarshaler.
-func (spec ResourceSpec[T, S]) MarshalProto() ([]byte, error) {
+func (spec *ResourceSpec[T, S]) MarshalProto() ([]byte, error) {
 	return ProtoMarshal(spec.Value)
 }
 
+// UnmarshalJSON implements json.Unmarshaler.
+func (spec *ResourceSpec[T, S]) UnmarshalJSON(bytes []byte) error {
+	spec.Value = new(T)
+
+	return json.Unmarshal(bytes, &spec.Value)
+}
+
 // UnmarshalProto implements protobuf.ResourceUnmarshaler.
 func (spec *ResourceSpec[T, S]) UnmarshalProto(protoBytes []byte) error {
 	spec.Value = new(T)
@@ -41,13 +57,13 @@ func (spec *ResourceSpec[T, S]) UnmarshalProto(protoBytes []byte) error {
 }
 
 // GetValue returns wrapped protobuf object.
-func (spec ResourceSpec[T, S]) GetValue() proto.Message { //nolint:ireturn
+func (spec *ResourceSpec[T, S]) GetValue() proto.Message { //nolint:ireturn
 	return spec.Value
 }
 
 // Equal implements spec equality check.
-func (spec ResourceSpec[T, S]) Equal(other interface{}) bool {
-	otherSpec, ok := other.(ResourceSpec[T, S])
+func (spec *ResourceSpec[T, S]) Equal(other interface{}) bool {
+	otherSpec, ok := other.(*ResourceSpec[T, S])
 	if !ok {
 		return false
 	}

pkg/resource/typed/typed_resource.go

@@ -38,7 +38,7 @@ func (t *Resource[T, RD]) Metadata() *resource.Metadata {
 
 // Spec implements resource.Resource.
 func (t *Resource[T, RD]) Spec() interface{} {
-	return t.spec
+	return &t.spec
 }
 
 // TypedSpec returns a pointer to spec field.
@@ -58,7 +58,7 @@ func (t *Resource[T, RD]) ResourceDefinition() spec.ResourceDefinitionSpec {
 	return zero.ResourceDefinition(t.md, t.spec)
 }
 
-// UnmarshalProto impelements protobuf.Unmarshaler interface in a generic way.
+// UnmarshalProto implements protobuf.Unmarshaler interface in a generic way.
 //
 // UnmarshalProto requires that the spec implements the protobuf.ProtoUnmarshaller interface.
 func (t *Resource[T, RD]) UnmarshalProto(md *resource.Metadata, protoBytes []byte) error {

pkg/resource/typed/types_resource_test.go pkg/resource/typed/typed_resource_test.gopkg/resource/typed/types_resource_test.go renamed to pkg/resource/typed/typed_resource_test.go

@@ -5,12 +5,15 @@
 package typed_test
 
 import (
+	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/cosi-project/runtime/api/v1alpha1"
 	"github.com/cosi-project/runtime/pkg/resource"
 	"github.com/cosi-project/runtime/pkg/resource/meta"
+	"github.com/cosi-project/runtime/pkg/resource/protobuf"
 	"github.com/cosi-project/runtime/pkg/resource/typed"
 )
 
@@ -67,3 +70,27 @@ func TestTypedResource(t *testing.T) {
 	// check that getting resource definition actually works on phantom types
 	asrt.Equal(res.ResourceDefinition().DisplayType, "test definition")
 }
+
+type jsonResSpec = protobuf.ResourceSpec[v1alpha1.Metadata, *v1alpha1.Metadata]
+
+//nolint:unused
+type jsonResRD struct{}
+
+// ResourceDefinition ...
+//nolint:unused
+func (jsonResRD) ResourceDefinition(md resource.Metadata, spec jsonResSpec) meta.ResourceDefinitionSpec {
+	return meta.ResourceDefinitionSpec{
+		DisplayType: "test definition",
+	}
+}
+
+func TestUnmarshalJSON(t *testing.T) {
+	res := typed.NewResource[jsonResSpec, jsonResRD](
+		resource.NewMetadata("default", "type", "1", resource.VersionUndefined),
+		jsonResSpec{},
+	)
+
+	assert.NoError(t, json.Unmarshal([]byte(`{"id": "1"}`), res.Spec()))
+	assert.NotNil(t, res.TypedSpec().Value)
+	assert.Equal(t, "1", res.TypedSpec().Value.Id)
+}