Rename event source to "resource"

Replace required event source field with a new optional "resource" field.

Signed-off-by: Nick Hale <4175918+njhale@users.noreply.github.com>

integration/events/events_test.go

@@ -52,7 +52,7 @@ func TestAppEvents(t *testing.T) {
 	// Ensure an event of each type has been recorded
 	var created, updated, deleted bool
 	helper.Wait(t, helper.Watcher(t, c), &apiv1.EventList{}, func(obj *apiv1.Event) bool {
-		if obj.Namespace != project.Name || obj.Source.Kind != "app" || obj.Source.Name != app.Name {
+		if obj.Namespace != project.Name || obj.Resource.Kind != "app" || obj.Resource.Name != app.Name {
 			// This event isn't for our app
 			return false
 		}

pkg/apis/internal.acorn.io/v1/event.go

@@ -3,7 +3,7 @@ package v1
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
+	"strings"
 	"time"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -40,8 +40,9 @@ type EventInstance struct {
 	// +optional
 	AppName string `json:"appName,omitempty"`
 
-	// Source identifies the object the Event is regarding.
-	Source EventSource `json:"source"`
+	// Resource identifies the object the Event is regarding.
+	// +optional
+	Resource *EventResource `json:"resource,omitempty"`
 
 	// Description is a human-readable description of the Event.
 	// +optional
@@ -120,24 +121,32 @@ const (
 // EventSeverity indicates the severity of an event.
 type EventSeverity string
 
-// EventSource identifies an object related to an Event.
+// EventResource identifies a resource related to an Event.
 //
-// The referenced object may or may not exist.
+// The referenced resource may or may not exist.
 //
 // Note: corev1.ObjectReference was explicitly avoided because its use in new schemas is discouraged.
 // See https://github.com/kubernetes/api/blob/cdff1d4efea5d7ddc52c4085f82748c5f3e5cc8e/core/v1/types.go#L5919
 // for more details.
-type EventSource struct {
-	// Kind is the source object kind.
+type EventResource struct {
+	// Kind is the resource kind.
 	Kind string `json:"kind"`
 
-	// Name is the name of the source object.
+	// Name is the name of the resource.
 	Name string `json:"name"`
 
-	// UID uniquely identifies the source object.
+	// UID uniquely identifies the resource.
 	UID types.UID `json:"uuid"`
 }
 
-func (e EventSource) String() string {
-	return fmt.Sprintf("%s/%s", e.Kind, e.Name)
+func (e EventResource) String() string {
+	components := make([]string, 0, 2)
+	if e.Kind != "" {
+		components = append(components, e.Kind)
+	}
+	if e.Name != "" {
+		components = append(components, e.Name)
+	}
+
+	return strings.Join(components, "/")
 }

pkg/cli/completion.go

@@ -382,13 +382,20 @@ func eventsCompletion(ctx context.Context, c client.Client, toComplete string) (
 
 	matched := make(map[string]struct{})
 	if err := channels.ForEach(ctx, events, func(e apiv1.Event) error {
-		for _, completion := range []string{
+		completions := []string{
 			// Name prefix completion
 			e.Name,
-			// Source prefix completion
-			e.Source.String(),
-			e.Source.Kind,
-		} {
+		}
+
+		if e.Resource != nil {
+			// Resource prefix completions
+			completions = append(completions,
+				e.Resource.String(),
+				e.Resource.Kind,
+			)
+		}
+
+		for _, completion := range completions {
 			if _, ok := matched[completion]; ok {
 				// Completion already added to results
 				return nil
@@ -399,6 +406,7 @@ func eventsCompletion(ctx context.Context, c client.Client, toComplete string) (
 				matched[completion] = struct{}{}
 			}
 		}
+
 		return nil
 	}); !channels.NilOrCanceled(err) {
 		return nil, err

pkg/cli/events.go

@@ -28,13 +28,13 @@ func NewEvent(c CommandContext) *cobra.Command {
   # List the last 5 events and follow the event log
   acorn events --tail 5 -f
 
-  # Filter by Event Source 
+  # Filter by Related Resource 
   # If a PREFIX is given in the form '<kind>/<name>', the results of this command are pruned to include
-  # only those events sourced by resources matching the given kind and name.
-  # List events sourced by the 'hello' app in the current project
+  # only those events related to resources matching the given kind and name.
+  # List events related to the 'hello' app in the current project
   acorn events app/hello
   
-  # If the '/<name>' suffix is omitted, '<kind>' will match events sourced by any resource of the given kind.
+  # If the '/<name>' suffix is omitted, '<kind>' will match events related to any resource of the given kind.
   # List events related to any app in the current project
   acorn events app 
 

pkg/controller/appdefinition/pullappimage.go

@@ -211,7 +211,7 @@ func recordPullEvent(ctx context.Context, recorder event.Recorder, observed meta
 		Severity:    v1.EventSeverityInfo,
 		Description: fmt.Sprintf("Pulled %s", target.Name),
 		AppName:     obj.GetName(),
-		Source:      event.ObjectSource(obj),
+		Resource:    event.Resource(obj),
 		Observed:    v1.MicroTime(observed),
 	}
 	e.SetNamespace(obj.GetNamespace())

pkg/controller/appdefinition/pullappimage_test.go

@@ -95,7 +95,7 @@ func withMeta[T kclient.Object](name, uid, resourceVersion string, obj T) T {
 
 func TestPullAppImageEvents(t *testing.T) {
 	// Test cases below this comment ensure the handler produces the correct events
-	now := v1.MicroTime(metav1.NowMicro())
+	now := v1.NowMicro()
 	// Manual upgrade should record an event
 	testRecordPullEvent(t,
 		"ImageChange",
@@ -108,7 +108,7 @@ func TestPullAppImageEvents(t *testing.T) {
 			Severity:    v1.EventSeverityInfo,
 			Description: "Pulled acorn.io/img:1",
 			AppName:     "foo",
-			Source:      v1.EventSource{Kind: "app", Name: "foo", UID: types.UID("foo-uid")},
+			Resource:    &v1.EventResource{Kind: "app", Name: "foo", UID: types.UID("foo-uid")},
 			Observed:    now,
 			Details: mustMapify(t, AppImagePullEventDetails{
 				ResourceVersion: "1",
@@ -131,7 +131,7 @@ func TestPullAppImageEvents(t *testing.T) {
 			Severity:    v1.EventSeverityInfo,
 			Description: "Pulled acorn.io/img:1",
 			AppName:     "foo",
-			Source:      v1.EventSource{Kind: "app", Name: "foo"},
+			Resource:    &v1.EventResource{Kind: "app", Name: "foo"},
 			Observed:    now,
 			Details: mustMapify(t, AppImagePullEventDetails{
 				AutoUpgrade: true,
@@ -152,7 +152,7 @@ func TestPullAppImageEvents(t *testing.T) {
 			Severity:    v1.EventSeverityInfo,
 			Description: "Pulled acorn.io/img:1",
 			AppName:     "foo",
-			Source:      v1.EventSource{Kind: "app", Name: "foo"},
+			Resource:    &v1.EventResource{Kind: "app", Name: "foo"},
 			Observed:    now,
 			Details: mustMapify(t, AppImagePullEventDetails{
 				AutoUpgrade: true,
@@ -173,7 +173,7 @@ func TestPullAppImageEvents(t *testing.T) {
 			Severity:    v1.EventSeverityError,
 			Description: "Failed to pull acorn.io/img:1",
 			AppName:     "foo",
-			Source:      v1.EventSource{Kind: "app", Name: "foo"},
+			Resource:    &v1.EventResource{Kind: "app", Name: "foo"},
 			Observed:    now,
 			Details: mustMapify(t, AppImagePullEventDetails{
 				Target: ImageSummary{Name: "acorn.io/img:1"},

pkg/event/event.go

@@ -5,7 +5,8 @@ import (
 	"fmt"
 
 	apiv1 "github.com/acorn-io/runtime/pkg/apis/api.acorn.io/v1"
-	v1 "github.com/acorn-io/runtime/pkg/apis/internal.acorn.io/v1"
+	internalv1 "github.com/acorn-io/runtime/pkg/apis/internal.acorn.io/v1"
+	"github.com/acorn-io/z"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apiserver/pkg/endpoints/request"
 	kclient "sigs.k8s.io/controller-runtime/pkg/client"
@@ -46,13 +47,10 @@ var (
 )
 
 func init() {
-	must := func(err error) {
-		if err != nil {
-			panic(fmt.Sprintf("failed to add to scheme: %s", err.Error()))
-		}
-	}
-	must(apiv1.AddToScheme(scheme))
-	must(v1.AddToScheme(scheme))
+	z.Must(
+		apiv1.AddToScheme(scheme),
+		internalv1.AddToScheme(scheme),
+	)
 }
 
 func publicKind(obj runtime.Object) string {
@@ -66,8 +64,9 @@ func publicKind(obj runtime.Object) string {
 	return ""
 }
 
-func ObjectSource(obj kclient.Object) v1.EventSource {
-	return v1.EventSource{
+// Resource returns a non-nil pointer to a v1.EventResource for the given object.
+func Resource(obj kclient.Object) *internalv1.EventResource {
+	return &internalv1.EventResource{
 		Kind: publicKind(obj),
 		Name: obj.GetName(),
 		UID:  obj.GetUID(),

pkg/event/id.go

@@ -7,21 +7,22 @@ import (
 	"strings"
 
 	apiv1 "github.com/acorn-io/runtime/pkg/apis/api.acorn.io/v1"
+	"github.com/acorn-io/z"
 )
 
 // ContentID returns a deterministic ID based on the content of a given event.
 // The returned ID is a valid kubernetes resource name (metadata.name).
 func ContentID(e *apiv1.Event) (string, error) {
-	fieldSet := strings.Join([]string{
+	fieldSet := []string{
 		e.Type,
 		string(e.Severity),
-		e.Source.String(),
+		z.Dereference(e.Resource).String(),
 		e.Description,
 		strconv.FormatInt(e.Observed.UnixMicro(), 10),
-	}, ",")
+	}
 
 	h := fnv.New128a()
-	if _, err := h.Write([]byte(fieldSet)); err != nil {
+	if _, err := h.Write([]byte(strings.Join(fieldSet, ","))); err != nil {
 		return "", err
 	}
 

pkg/server/registry/apigroups/acorn/apps/events.go

@@ -83,8 +83,8 @@ func (s *eventRecordingStrategy) Create(ctx context.Context, obj types.Object) (
 		Details:     details,
 		Description: fmt.Sprintf("App %s/%s created", obj.GetNamespace(), obj.GetName()),
 		AppName:     obj.GetName(),
-		Source:      event.ObjectSource(obj),
-		Observed:    v1.MicroTime(metav1.NowMicro()),
+		Resource:    event.Resource(obj),
+		Observed:    v1.NowMicro(),
 	}); err != nil {
 		logrus.Warnf("Failed to record event: %s", err.Error())
 	}
@@ -117,8 +117,8 @@ func (s *eventRecordingStrategy) Delete(ctx context.Context, obj types.Object) (
 		Details:     details,
 		Description: fmt.Sprintf("App %s/%s deleted", obj.GetNamespace(), obj.GetName()),
 		AppName:     obj.GetName(),
-		Source:      event.ObjectSource(obj),
-		Observed:    v1.MicroTime(metav1.NowMicro()),
+		Resource:    event.Resource(obj),
+		Observed:    v1.NowMicro(),
 	}); err != nil {
 		logrus.Warnf("Failed to record event: %s", err.Error())
 	}
@@ -172,8 +172,8 @@ func (s *eventRecordingStrategy) Update(ctx context.Context, obj types.Object) (
 		Details:     details,
 		Description: fmt.Sprintf("Spec field updated for App %s/%s", obj.GetNamespace(), obj.GetName()),
 		AppName:     obj.GetName(),
-		Source:      event.ObjectSource(obj),
-		Observed:    v1.MicroTime(metav1.NowMicro()),
+		Resource:    event.Resource(obj),
+		Observed:    v1.NowMicro(),
 	}); err != nil {
 		logrus.Warnf("Failed to record event: %s", err)
 	}

pkg/server/registry/apigroups/acorn/events/strategy.go

@@ -323,7 +323,7 @@ type prefix string
 func (p prefix) matches(e apiv1.Event) bool {
 	return p.all() ||
 		strings.HasPrefix(e.Name, string(p)) ||
-		strings.HasPrefix(e.Source.String(), string(p))
+		strings.HasPrefix(z.Dereference(e.Resource).String(), string(p))
 }
 
 func (p prefix) all() bool {