fix: documentation and utilities

Author: bxcodec

interfaces/delayfn.go

@@ -1,5 +1,7 @@
 package interfaces
 
+// DelayFn is a function type that represents a delay function.
+// It takes the current number of retries as input and returns the delay in seconds.
 type DelayFn func(currenRetries int64) (delay int64)
 
 var (
@@ -19,5 +21,7 @@ var (
 	NoDelayFn DelayFn = func(currenRetries int64) (delay int64) {
 		return 0
 	}
+	// DefaultDelayFn is the default delay function that will be used if no delay function is provided.
+	// It is set to LinearDelayFn by default.
 	DefaultDelayFn DelayFn = LinearDelayFn
 )

interfaces/inboundmessagehandler.go

@@ -17,8 +17,12 @@ type InboundMessageHandlerMiddlewareFunc func(next InboundMessageHandlerFunc) In
 
 type InboundMessage struct {
 	Message
-	RetryCount int64                  `json:"retryCount"`
-	Metadata   map[string]interface{} `json:"metadata"`
+	// RetryCount is the number of times the message has been retried.
+	// This is set by the library to identify the number of times the message has been retried.
+	RetryCount int64 `json:"retryCount"`
+	// Metadata is the metadata of the message.
+	// This is set by the library to identify the metadata of the message.
+	Metadata map[string]interface{} `json:"metadata"`
 	// Ack is used for confirming the message. It will drop the message from the queue.
 	Ack func(ctx context.Context) (err error) `json:"-"`
 	// Nack is used for rejecting the message. It will requeue the message to be re-delivered again.

interfaces/message.go

@@ -12,21 +12,56 @@ import (
 // The message is used to publish messages to the queue.
 // Read the concept of message publishing in the documentation, here: TODO(bxcodec): Add link to the documentation
 type Message struct {
-	ID            string                     `json:"id"`
-	Action        string                     `json:"action"`
-	Topic         string                     `json:"topic"`
-	Data          any                        `json:"data"`
-	ContentType   headerVal.ContentType      `json:"-"`
-	Timestamp     time.Time                  `json:"timestamp"`
-	Headers       map[string]interface{}     `json:"-"`
-	ServiceAgent  headerVal.GoquServiceAgent `json:"-"`
+	// ID is the unique identifier for the message.
+	// This is set by the publisher to identify the message in the queue.
+	// The id is auto-generated by the the library if not provided.
+	ID string `json:"id"`
+	// Action is the action that will be performed on the message.
+	// This is set by the publisher to identify the action that will be performed on the message.
+	// For RabbitMQ, the action is the routing key.
+	Action string `json:"action"`
+	// Topic is the topic that the message will be published to.
+	// This is set by the publisher to identify the topic that the message will be published to.
+	// For RabbitMQ, the topic is the exchange name.
+	Topic string `json:"topic"`
+	// Data is the data that will be published to the queue.
+	// This is set by the publisher to identify the data that will be published to the queue.
+	// It should be a valid JSON object.
+	Data any `json:"data"`
+	// ContentType is the content type of the message.
+	// This is set by the publisher to identify the content type of the message.
+	// Default value is "application/json".
+	ContentType headerVal.ContentType `json:"-"`
+	// Timestamp is the timestamp of the message.
+	// This is set by the publisher to identify the timestamp of the message.
+	// Default value is the current time.
+	Timestamp time.Time `json:"timestamp"`
+	// Headers is the headers of the message.
+	// This is set by the publisher to identify the headers of the message.
+	// This library will provide extra headers values by default based on the library type.
+	// Don't use any prefix with :goqueue-, it will conflicted and overrided by the library.
+	Headers map[string]interface{} `json:"-"`
+	// ServiceAgent is the service agent that will be used to publish the message.
+	// This is set by the publisher to identify the service agent that will be used to publish the message.
+	// This will be set by the library and override any value
+	ServiceAgent headerVal.GoquServiceAgent `json:"-"`
+	// SchemaVersion is the schema version of the message.
+	// This is set by the publisher to identify the schema version of the message.
+	// Default value is the library type.
+	// This will be set by the library and override any value
 	schemaVersion string
 }
 
+// SetSchemaVersion is a method to set the schema version of the message.
+// This is used to set the schema version of the message.
+// This will be set by the library and override any value
 func (m *Message) SetSchemaVersion(v string) {
 	m.schemaVersion = v
 }
 
+// GetSchemaVersion is a method to get the schema version of the message.
+// This is used to get the schema version of the message.
+// This will be set by the library and override any value
 func (m *Message) GetSchemaVersion() string {
 	return m.schemaVersion
 }

interfaces/publisher.go

@@ -20,4 +20,6 @@ func (f PublisherFunc) Publish(ctx context.Context, m Message) (err error) {
 	return f(ctx, m)
 }
 
+// PublisherMiddlewareFunc is a function type that represents a publisher middleware function.
+// It takes a next PublisherFunc as input parameter and returns a PublisherFunc.
 type PublisherMiddlewareFunc func(next PublisherFunc) PublisherFunc