refactor: improve code documentation and update test values

- Move the `Data` field and its comment in the `Message` struct
- Add comments for `NewMessage`, `NewTask`, `Encode`, and `Decode` functions
- Update `RetryMax` and `RetryFactor` values in the test and adjust assertions accordingly
- Add comments for `Options`, `newDefaultOptions`, `AllowOption`, and `NewOptions` functions
- Add `Float64` and `Time` helper functions

Signed-off-by: appleboy <appleboy.tw@gmail.com>

Author: appleboy

job/job.go

@@ -31,9 +31,6 @@ type Message struct {
 	// default is 100ms
 	RetryDelay time.Duration `json:"retry_delay"`
 
-	// Data to save Unsafe cast
-	Data []byte
-
 	// RetryFactor is the multiplying factor for each increment step.
 	//
 	// Defaults to 2.
@@ -48,6 +45,9 @@ type Message struct {
 	//
 	// Defaults to 10 seconds.
 	RetryMax time.Duration `json:"retry_max"`
+
+	// Data to save Unsafe cast
+	Data []byte
 }
 
 const (
@@ -64,6 +64,7 @@ func (m *Message) Encode() {
 	m.Data = Encode(m)
 }
 
+// NewMessage create new message
 func NewMessage(m core.QueuedMessage, opts ...AllowOption) *Message {
 	o := NewOptions(opts...)
 
@@ -78,6 +79,7 @@ func NewMessage(m core.QueuedMessage, opts ...AllowOption) *Message {
 	}
 }
 
+// NewTask create new task
 func NewTask(task TaskFunc, opts ...AllowOption) *Message {
 	o := NewOptions(opts...)
 
@@ -92,10 +94,12 @@ func NewTask(task TaskFunc, opts ...AllowOption) *Message {
 	}
 }
 
+// Encode for encoding the structure
 func Encode(m *Message) []byte {
 	return (*[movementSize]byte)(unsafe.Pointer(m))[:]
 }
 
+// Decode for decoding the structure
 func Decode(m []byte) *Message {
 	return (*Message)(unsafe.Pointer(&m[0]))
 }

job/job_test.go

@@ -20,10 +20,12 @@ func TestMessageEncodeDecode(t *testing.T) {
 		message: "foo",
 	},
 		AllowOption{
-			RetryCount: Int64(100),
-			RetryDelay: Time(30 * time.Millisecond),
-			Timeout:    Time(3 * time.Millisecond),
-			RetryMin:   Time(200 * time.Millisecond),
+			RetryCount:  Int64(100),
+			RetryDelay:  Time(30 * time.Millisecond),
+			Timeout:     Time(3 * time.Millisecond),
+			RetryMin:    Time(200 * time.Millisecond),
+			RetryMax:    Time(20 * time.Second),
+			RetryFactor: Float64(4.0),
 		},
 	)
 
@@ -35,6 +37,6 @@ func TestMessageEncodeDecode(t *testing.T) {
 	assert.Equal(t, 3*time.Millisecond, out.Timeout)
 	assert.Equal(t, "foo", string(out.Payload))
 	assert.Equal(t, 200*time.Millisecond, out.RetryMin)
-	assert.Equal(t, 10*time.Second, out.RetryMax)
-	assert.Equal(t, 2.0, out.RetryFactor)
+	assert.Equal(t, 20*time.Second, out.RetryMax)
+	assert.Equal(t, 4.0, out.RetryFactor)
 }

job/option.go

@@ -2,6 +2,7 @@ package job
 
 import "time"
 
+// Options is a set of options for the queue
 type Options struct {
 	retryCount  int64
 	retryDelay  time.Duration
@@ -12,6 +13,7 @@ type Options struct {
 	timeout time.Duration
 }
 
+// newDefaultOptions create new default options
 func newDefaultOptions() Options {
 	return Options{
 		retryCount:  0,
@@ -23,6 +25,7 @@ func newDefaultOptions() Options {
 	}
 }
 
+// AllowOption is a function that sets some option on the Options
 type AllowOption struct {
 	RetryCount  *int64
 	RetryDelay  *time.Duration
@@ -32,7 +35,7 @@ type AllowOption struct {
 	Timeout     *time.Duration
 }
 
-// NewOptions with custom parameter
+// NewOptions create new options
 func NewOptions(opts ...AllowOption) Options {
 	o := newDefaultOptions()
 
@@ -65,10 +68,17 @@ func NewOptions(opts ...AllowOption) Options {
 	return o
 }
 
+// Int64 is a helper routine that allocates a new int64 value
 func Int64(val int64) *int64 {
 	return &val
 }
 
+// Float64 is a helper routine that allocates a new float64 value
+func Float64(val float64) *float64 {
+	return &val
+}
+
+// Time is a helper routine that allocates a new time value
 func Time(v time.Duration) *time.Duration {
 	return &v
 }

job/option_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+// TestMessageEncodeDecode test message encode and decode
 func TestOptions(t *testing.T) {
 	o := NewOptions(
 		AllowOption{