add event sequence number

Signed-off-by: Wei Liu <liuweixa@redhat.com>

cloudevents/generic/types/types.go

@@ -48,6 +48,10 @@ const (
 	// ExtensionResourceVersion is the cloud event extension key of the resource version.
 	ExtensionResourceVersion = "resourceversion"
 
+	// ExtensionSequenceNumber is the cloud event extension key of the event sequence number.
+	// The event sequence number represents the order in which events occur on the agent/source.
+	ExtensionSequenceNumber = "sequenceNumber"
+
 	// ExtensionDeletionTimestamp is the cloud event extension key of the deletion timestamp.
 	ExtensionDeletionTimestamp = "deletiontimestamp"
 
@@ -160,6 +164,7 @@ type EventBuilder struct {
 	originalSource    string
 	resourceID        string
 	resourceVersion   *int64
+	sequenceNumber    *int64
 	eventType         CloudEventsType
 	deletionTimestamp time.Time
 }
@@ -181,6 +186,11 @@ func (b *EventBuilder) WithResourceVersion(resourceVersion int64) *EventBuilder
 	return b
 }
 
+func (b *EventBuilder) WithSequenceNumber(sequenceNumber int64) *EventBuilder {
+	b.sequenceNumber = &sequenceNumber
+	return b
+}
+
 func (b *EventBuilder) WithClusterName(clusterName string) *EventBuilder {
 	b.clusterName = clusterName
 	return b
@@ -211,6 +221,10 @@ func (b *EventBuilder) NewEvent() cloudevents.Event {
 		evt.SetExtension(ExtensionResourceVersion, *b.resourceVersion)
 	}
 
+	if b.sequenceNumber != nil {
+		evt.SetExtension(ExtensionSequenceNumber, *b.sequenceNumber)
+	}
+
 	if len(b.clusterName) != 0 {
 		evt.SetExtension(ExtensionClusterName, b.clusterName)
 	}

cloudevents/work/agent/codec/manifest.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/bwmarrin/snowflake"
 	cloudevents "github.com/cloudevents/sdk-go/v2"
 	cloudeventstypes "github.com/cloudevents/sdk-go/v2/types"
 
@@ -29,12 +30,14 @@ const (
 
 // ManifestCodec is a codec to encode/decode a ManifestWork/cloudevent with ManifestBundle for an agent.
 type ManifestCodec struct {
-	restMapper meta.RESTMapper
+	sequenceGenerator *snowflake.Node
+	restMapper        meta.RESTMapper
 }
 
-func NewManifestCodec(restMapper meta.RESTMapper) *ManifestCodec {
+func NewManifestCodec(sequenceGenerator *snowflake.Node, restMapper meta.RESTMapper) *ManifestCodec {
 	return &ManifestCodec{
-		restMapper: restMapper,
+		sequenceGenerator: sequenceGenerator,
+		restMapper:        restMapper,
 	}
 }
 
@@ -66,6 +69,7 @@ func (c *ManifestCodec) Encode(source string, eventType types.CloudEventsType, w
 	evt := types.NewEventBuilder(source, eventType).
 		WithResourceID(string(work.UID)).
 		WithResourceVersion(resourceVersion).
+		WithSequenceNumber(c.sequenceGenerator.Generate().Int64()).
 		WithClusterName(work.Namespace).
 		WithOriginalSource(originalSource).
 		NewEvent()

cloudevents/work/agent/codec/manifest_test.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/bwmarrin/snowflake"
 	cloudevents "github.com/cloudevents/sdk-go/v2"
 
 	corev1 "k8s.io/api/core/v1"
@@ -17,7 +18,12 @@ import (
 )
 
 func TestManifestEventDataType(t *testing.T) {
-	codec := NewManifestCodec(nil)
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	codec := NewManifestCodec(sequenceGenerator, nil)
 
 	if codec.EventDataType() != payload.ManifestEventDataType {
 		t.Errorf("unexpected event data type %s", codec.EventDataType())
@@ -141,9 +147,14 @@ func TestManifestEncode(t *testing.T) {
 		},
 	}
 
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {
-			codec := NewManifestCodec(nil)
+			codec := NewManifestCodec(sequenceGenerator, nil)
 
 			_, err := codec.Encode("cluster1-work-agent", c.eventType, c.work)
 			if c.expectedErr {
@@ -281,10 +292,14 @@ func TestManifestDecode(t *testing.T) {
 		},
 	}
 
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {
-			codec := NewManifestCodec(nil)
-
+			codec := NewManifestCodec(sequenceGenerator, nil)
 			_, err := codec.Decode(c.event)
 			if c.expectedErr {
 				if err == nil {

cloudevents/work/agent/codec/manifestbundle.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/bwmarrin/snowflake"
 	cloudevents "github.com/cloudevents/sdk-go/v2"
 	cloudeventstypes "github.com/cloudevents/sdk-go/v2/types"
 
@@ -17,10 +18,14 @@ import (
 )
 
 // ManifestBundleCodec is a codec to encode/decode a ManifestWork/cloudevent with ManifestBundle for an agent.
-type ManifestBundleCodec struct{}
+type ManifestBundleCodec struct {
+	sequenceGenerator *snowflake.Node
+}
 
-func NewManifestBundleCodec() *ManifestBundleCodec {
-	return &ManifestBundleCodec{}
+func NewManifestBundleCodec(sequenceGenerator *snowflake.Node) *ManifestBundleCodec {
+	return &ManifestBundleCodec{
+		sequenceGenerator: sequenceGenerator,
+	}
 }
 
 // EventDataType always returns the event data type `io.open-cluster-management.works.v1alpha1.manifestbundles`.
@@ -48,6 +53,7 @@ func (c *ManifestBundleCodec) Encode(source string, eventType types.CloudEventsT
 		WithResourceID(string(work.UID)).
 		WithResourceVersion(resourceVersion).
 		WithClusterName(work.Namespace).
+		WithSequenceNumber(c.sequenceGenerator.Generate().Int64()).
 		WithOriginalSource(originalSource).
 		NewEvent()
 

cloudevents/work/agent/codec/manifestbundle_test.go

@@ -3,6 +3,7 @@ package codec
 import (
 	"testing"
 
+	"github.com/bwmarrin/snowflake"
 	cloudevents "github.com/cloudevents/sdk-go/v2"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -14,7 +15,12 @@ import (
 )
 
 func TestManifestBundleEventDataType(t *testing.T) {
-	codec := NewManifestBundleCodec()
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	codec := NewManifestBundleCodec(sequenceGenerator)
 
 	if codec.EventDataType() != payload.ManifestBundleEventDataType {
 		t.Errorf("unexpected event data type %s", codec.EventDataType())
@@ -90,9 +96,14 @@ func TestManifestBundleEncode(t *testing.T) {
 		},
 	}
 
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {
-			codec := NewManifestBundleCodec()
+			codec := NewManifestBundleCodec(sequenceGenerator)
 
 			_, err := codec.Encode("cluster1-work-agent", c.eventType, c.work)
 			if c.expectedErr {
@@ -229,9 +240,14 @@ func TestManifestBundleDecode(t *testing.T) {
 		},
 	}
 
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {
-			codec := NewManifestBundleCodec()
+			codec := NewManifestBundleCodec(sequenceGenerator)
 
 			_, err := codec.Decode(c.event)
 			if c.expectedErr {

go.mod

@@ -3,6 +3,7 @@ module open-cluster-management.io/api
 go 1.20
 
 require (
+	github.com/bwmarrin/snowflake v0.3.0
 	github.com/cloudevents/sdk-go/protocol/mqtt_paho/v2 v2.0.0-20231030012137-0836a524e995
 	github.com/cloudevents/sdk-go/v2 v2.14.0
 	github.com/eclipse/paho.golang v0.11.0

go.sum

@@ -2,6 +2,8 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/blang/semver/v4 v4.0.0 h1:1PFHFE6yCCTv8C1TeyNNarDzntLi7wMI5i/pzqYIsAM=
 github.com/blang/semver/v4 v4.0.0/go.mod h1:IbckMUScFkM3pff0VJDNKRiT6TG/YpiHIM2yvyW5YoQ=
+github.com/bwmarrin/snowflake v0.3.0 h1:xm67bEhkKh6ij1790JB83OujPR5CzNe8QuQqAgISZN0=
+github.com/bwmarrin/snowflake v0.3.0/go.mod h1:NdZxfVWX+oR6y2K0o6qAYv6gIOP9rjG0/E9WsDpxqwE=
 github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/cloudevents/sdk-go/protocol/mqtt_paho/v2 v2.0.0-20231030012137-0836a524e995 h1:pXyRKZ0T5WoB6X9QnHS5cEyW0Got39bNQIECxGUKVO4=

test/integration/cloudevents/agent/agent.go

@@ -3,15 +3,21 @@ package agent
 import (
 	"context"
 
+	"github.com/bwmarrin/snowflake"
 	"open-cluster-management.io/api/cloudevents/generic/options/mqtt"
 	"open-cluster-management.io/api/cloudevents/work"
 	"open-cluster-management.io/api/cloudevents/work/agent/codec"
 )
 
 func StartWorkAgent(ctx context.Context, clusterName string, config *mqtt.MQTTOptions) (*work.ClientHolder, error) {
+	sequenceGenerator, err := snowflake.NewNode(1)
+	if err != nil {
+		return nil, err
+	}
+
 	clientHolder, err := work.NewClientHolderBuilder(clusterName, config).
 		WithClusterName(clusterName).
-		WithCodecs(codec.NewManifestCodec(nil)).
+		WithCodecs(codec.NewManifestCodec(sequenceGenerator, nil)).
 		NewClientHolder(ctx)
 	if err != nil {
 		return nil, err