Rename deleted_at case, drop field if not set

Signed-off-by: Charlie Egan <[email protected]>

Author: charlieegan3

api/datareading.go

@@ -1,6 +1,9 @@
 package api
 
-import "time"
+import (
+	"encoding/json"
+	"time"
+)
 
 // DataReadingsPost is the payload in the upload request.
 type DataReadingsPost struct {
@@ -25,6 +28,23 @@ type DataReading struct {
 type GatheredResource struct {
 	// Resource is a reference to a k8s object that was found by the informer
 	// should be of type unstructured.Unstructured, raw Object
-	Resource  interface{} `json:"resource"`
-	DeletedAt *Time       `json:"deletedAt,omitempty"`
+	Resource  interface{}
+	DeletedAt Time
+}
+
+func (v GatheredResource) MarshalJSON() ([]byte, error) {
+	dateString := ""
+	if !v.DeletedAt.IsZero() {
+		dateString = v.DeletedAt.Format(TimeFormat)
+	}
+
+	data := struct {
+		Resource  interface{} `json:"resource"`
+		DeletedAt string      `json:"deleted_at,omitempty"`
+	}{
+		Resource:  v.Resource,
+		DeletedAt: dateString,
+	}
+
+	return json.Marshal(data)
 }

api/datareading_test.go

@@ -0,0 +1,36 @@
+package api
+
+import (
+	"encoding/json"
+	"testing"
+	"time"
+)
+
+func TestJSONGatheredResourceDropsEmptyTime(t *testing.T) {
+	var resource GatheredResource
+	bytes, err := json.Marshal(resource)
+	if err != nil {
+		t.Fatalf("failed to marshal %s", err)
+	}
+
+	expected := `{"resource":null}`
+
+	if string(bytes) != expected {
+		t.Fatalf("unexpected json \ngot  %s\nwant %s", string(bytes), expected)
+	}
+}
+
+func TestJSONGatheredResourceSetsTimeWhenPresent(t *testing.T) {
+	var resource GatheredResource
+	resource.DeletedAt = Time{time.Date(2021, 3, 29, 0, 0, 0, 0, time.UTC)}
+	bytes, err := json.Marshal(resource)
+	if err != nil {
+		t.Fatalf("failed to marshal %s", err)
+	}
+
+	expected := `{"resource":null,"deleted_at":"2021-03-29T00:00:00Z"}`
+
+	if string(bytes) != expected {
+		t.Fatalf("unexpected json \ngot  %s\nwant %s", string(bytes), expected)
+	}
+}

pkg/datagatherer/k8s/cache.go

@@ -70,7 +70,7 @@ func onDelete(obj interface{}, dgCache *cache.Cache) {
 		data := metadata.(map[string]interface{})
 		if uid, ok := data["uid"]; ok {
 			cacheObject := updateCacheGatheredResource(uid.(string), obj, dgCache)
-			cacheObject.DeletedAt = &api.Time{Time: clock.now()}
+			cacheObject.DeletedAt = api.Time{Time: clock.now()}
 			dgCache.Set(uid.(string), cacheObject, cache.DefaultExpiration)
 		} else {
 			log.Printf("could not %q resource %q to the cache, missing uid field", "delete", data["name"].(string))
@@ -92,7 +92,7 @@ func updateCacheGatheredResource(cacheKey string, resource interface{},
 	// update the object's properties, if it's already in the cache
 	if o, ok := dgCache.Get(cacheKey); ok {
 		deletedAt := o.(*api.GatheredResource).DeletedAt
-		if deletedAt != nil {
+		if deletedAt.IsZero() && !deletedAt.IsZero() {
 			cacheObject.DeletedAt = deletedAt
 		}
 	}

pkg/datagatherer/k8s/cache_test.go

@@ -11,7 +11,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
-func makeGatheredResource(obj runtime.Object, deletedAt *api.Time) *api.GatheredResource {
+func makeGatheredResource(obj runtime.Object, deletedAt api.Time) *api.GatheredResource {
 	return &api.GatheredResource{
 		Resource:  obj,
 		DeletedAt: deletedAt,
@@ -32,9 +32,9 @@ func TestOnAddCache(t *testing.T) {
 				getObject("foobar/v1", "NotFoo", "notfoo", "testns", false),
 			},
 			expected: []*api.GatheredResource{
-				makeGatheredResource(getObject("foobar/v1", "Foo", "testfoo", "testns", false), nil),
-				makeGatheredResource(getObject("v1", "Service", "testservice", "testns", false), nil),
-				makeGatheredResource(getObject("foobar/v1", "NotFoo", "notfoo", "testns", false), nil),
+				makeGatheredResource(getObject("foobar/v1", "Foo", "testfoo", "testns", false), api.Time{}),
+				makeGatheredResource(getObject("v1", "Service", "testservice", "testns", false), api.Time{}),
+				makeGatheredResource(getObject("foobar/v1", "NotFoo", "notfoo", "testns", false), api.Time{}),
 			},
 		},
 		"delete all objects. All objects should have the deletedAt flag": {
@@ -51,14 +51,17 @@ func TestOnAddCache(t *testing.T) {
 			},
 			eventFunc: func(old, new interface{}, dgCache *cache.Cache) { onDelete(old, dgCache) },
 			expected: []*api.GatheredResource{
-				makeGatheredResource(getObject("foobar/v1", "Foo", "testfoo", "testns", false),
-					&api.Time{Time: clock.now()},
+				makeGatheredResource(
+					getObject("foobar/v1", "Foo", "testfoo", "testns", false),
+					api.Time{Time: clock.now()},
 				),
-				makeGatheredResource(getObject("v1", "Service", "testservice", "testns", false),
-					&api.Time{Time: clock.now()},
+				makeGatheredResource(
+					getObject("v1", "Service", "testservice", "testns", false),
+					api.Time{Time: clock.now()},
 				),
-				makeGatheredResource(getObject("foobar/v1", "NotFoo", "notfoo", "testns", false),
-					&api.Time{Time: clock.now()},
+				makeGatheredResource(
+					getObject("foobar/v1", "NotFoo", "notfoo", "testns", false),
+					api.Time{Time: clock.now()},
 				),
 			},
 		},
@@ -76,9 +79,18 @@ func TestOnAddCache(t *testing.T) {
 			},
 			eventFunc: onUpdate,
 			expected: []*api.GatheredResource{
-				makeGatheredResource(getObject("foobar/v1", "Foo", "testfoo", "testns1", false), nil),
-				makeGatheredResource(getObject("v1", "Service", "testservice", "testns1", false), nil),
-				makeGatheredResource(getObject("foobar/v1", "NotFoo", "notfoo", "testns1", false), nil),
+				makeGatheredResource(
+					getObject("foobar/v1", "Foo", "testfoo", "testns1", false),
+					api.Time{},
+				),
+				makeGatheredResource(
+					getObject("v1", "Service", "testservice", "testns1", false),
+					api.Time{},
+				),
+				makeGatheredResource(
+					getObject("foobar/v1", "NotFoo", "notfoo", "testns1", false),
+					api.Time{},
+				),
 			},
 		},
 	}

pkg/datagatherer/k8s/dynamic_test.go

@@ -345,7 +345,7 @@ func TestDynamicGatherer_Fetch(t *testing.T) {
 			expected: []*api.GatheredResource{
 				{
 					Resource:  getObject("foobar/v1", "Foo", "testfoo", "testns", false),
-					DeletedAt: &api.Time{Time: clock.now()},
+					DeletedAt: api.Time{Time: clock.now()},
 				},
 			},
 		},
@@ -416,11 +416,11 @@ func TestDynamicGatherer_Fetch(t *testing.T) {
 			expected: []*api.GatheredResource{
 				{
 					Resource:  getObject("foobar/v1", "Foo", "testfoo1", "testns1", false),
-					DeletedAt: &api.Time{Time: clock.now()},
+					DeletedAt: api.Time{Time: clock.now()},
 				},
 				{
 					Resource:  getObject("foobar/v1", "Foo", "testfoo2", "testns2", false),
-					DeletedAt: &api.Time{Time: clock.now()},
+					DeletedAt: api.Time{Time: clock.now()},
 				},
 			},
 		},