[do not merge] improving + adding features to go client

clients/golang/examples/example_add_job.go

@@ -1,14 +1,23 @@
 package main
 
 import (
+	"context"
 	"fmt"
+	"net/http"
 
-	"taskforce.sh/bullmq_proxy_client/queue"
+	"taskforce.sh/bullmq_proxy_client/pkg/queue"
 )
 
 func main() {
-	q := queue.NewQueue("ws://localhost:8080/queues/test?token=1234")
-
+	h := make(http.Header)
+	h.Set("Authorization", "Bearer 1234")
+	ctx := context.Background()
+	q, err := queue.NewQueue(ctx, "ws://localhost:8080/queues/test", h)
+	if err != nil {
+		fmt.Println("Error Connecting:", err)
+		return
+	}
+
 	// Sample usage of your library's functionality.
 	jobResponse, err := q.AddJob("testJob", map[string]string{"key": "value"}, nil)
 	if err != nil {

clients/golang/go.mod

@@ -2,4 +2,15 @@ module taskforce.sh/bullmq_proxy_client
 
 go 1.21.1
 
-require github.com/gorilla/websocket v1.5.0 // indirect
+require (
+	github.com/go-resty/resty/v2 v2.12.0
+	github.com/gorilla/websocket v1.5.0
+	github.com/stretchr/testify v1.9.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/net v0.22.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

clients/golang/go.sum

@@ -1,2 +1,60 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-resty/resty/v2 v2.12.0 h1:rsVL8P90LFvkUYq/V5BTVe203WfRIU4gvcf+yfzJzGA=
+github.com/go-resty/resty/v2 v2.12.0/go.mod h1:o0yGPrkS3lOe1+eFajk6kBW8ScXzwU3hD69/gt2yB/0=
 github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
 github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
+golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
+golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
+golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
+golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
+golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
+golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
+golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
+golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

clients/golang/pkg/client/client.go

@@ -0,0 +1,162 @@
+package client
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+	"strconv"
+	"time"
+
+	"github.com/go-resty/resty/v2"
+	"taskforce.sh/bullmq_proxy_client/pkg/client/proxyapi"
+	"taskforce.sh/bullmq_proxy_client/pkg/client/wsclient"
+)
+
+// client represents a rooturl
+type Client struct {
+	rootUrl   string
+	authToken string
+
+	// non configurable below / set on construction
+	httpClient *resty.Client
+}
+
+type ClientOpts func(*Client)
+
+func NewClient(opts ...ClientOpts) *Client {
+	c := &Client{
+		rootUrl:   "http://localhost:8080",
+		authToken: "",
+	}
+	for _, v := range opts {
+		v(c)
+	}
+
+	c.httpClient = resty.New().
+		SetBaseURL(c.rootUrl).
+		SetTimeout(1*time.Minute).
+		SetHeader("authorization", "Bearer "+c.authToken)
+
+	return c
+}
+
+func (c *Client) DialQueue(ctx context.Context, queueName string) (*wsclient.WebSocket[*proxyapi.QueueCommand], error) {
+	joinedPath, err := url.JoinPath(c.rootUrl, "ws", "queues", queueName)
+	if err != nil {
+		return nil, err
+	}
+	return wsclient.New[*proxyapi.QueueCommand](ctx, joinedPath, c.httpClient.Header)
+}
+
+func (c *Client) DialWorker(ctx context.Context, queueName string, concurrency int) (*wsclient.WebSocket[*proxyapi.WorkerCommand], error) {
+	joinedPath, err := url.JoinPath(c.rootUrl, "ws", "queues", queueName, "process", strconv.Itoa(concurrency))
+	if err != nil {
+		return nil, err
+	}
+	return wsclient.New[*proxyapi.WorkerCommand](ctx, joinedPath, c.httpClient.Header)
+}
+
+func (c *Client) DialQueueEvents(ctx context.Context, queueName string) (*wsclient.WebSocket[any], error) {
+	joinedPath, err := url.JoinPath(c.rootUrl, "ws", "queues", queueName, "events")
+	if err != nil {
+		return nil, err
+	}
+	return wsclient.New[any](ctx, joinedPath, c.httpClient.Header)
+}
+
+func (c *Client) AddJobs(ctx context.Context, queueName string, jobs []*proxyapi.JobSpec) (out []*proxyapi.Job, err error) {
+	_, err = c.httpClient.R().
+		SetBody(jobs).
+		SetResult(out).
+		ForceContentType("application/json").
+		Post(fmt.Sprintf("/queues/%s/jobs", queueName))
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+func (c *Client) GetJobs(ctx context.Context, queueName string) (out *proxyapi.GetJobsResponse, err error) {
+	_, err = c.httpClient.R().
+		SetResult(out).
+		Get(fmt.Sprintf("/queues/%s/jobs", queueName))
+	if err != nil {
+		return nil, err
+	}
+	return nil, nil
+}
+func (c *Client) GetJob(ctx context.Context, queueName string, jobId string) (out *proxyapi.Job, err error) {
+	_, err = c.httpClient.R().
+		SetResult(out).
+		Get(fmt.Sprintf("/queues/%s/jobs/%s", queueName, jobId))
+	if err != nil {
+		return nil, err
+	}
+	return nil, nil
+}
+
+func (c *Client) AddWorker(ctx context.Context, jobs []*proxyapi.JobSpec) (err error) {
+	_, err = c.httpClient.R().
+		SetBody(jobs).
+		ForceContentType("application/json").
+		Post("/workers")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+func (c *Client) GetWorkers(ctx context.Context) (out *proxyapi.WorkerMetadata, err error) {
+	_, err = c.httpClient.R().
+		SetResult(out).
+		Get("/workers")
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+func (c *Client) RemoveWorker(ctx context.Context, queueName string) error {
+	_, err := c.httpClient.R().
+		Delete(fmt.Sprintf("/workers/%s", queueName))
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (c *Client) UpdateProgress(ctx context.Context, queueName string, jobId string, progress any) (err error) {
+	_, err = c.httpClient.R().
+		SetBody(progress).
+		ForceContentType("application/json").
+		Get(fmt.Sprintf("/queues/%s/jobs/%s/progress", queueName, jobId))
+	if err != nil {
+		return err
+	}
+	return nil
+}
+func (c *Client) AddLog(ctx context.Context, queueName string, jobId string, log string) (err error) {
+	_, err = c.httpClient.R().
+		SetBody(log).
+		ForceContentType("application/json").
+		Get(fmt.Sprintf("/queues/%s/jobs/%s/logs", queueName, jobId))
+	if err != nil {
+		return err
+	}
+	return nil
+}
+func (c *Client) GetLogs(ctx context.Context, queueName string, jobId string, start int, length int) (out *proxyapi.JobLog, err error) {
+	_, err = c.httpClient.R().
+		SetResult(out).
+		Get(fmt.Sprintf("/queues/%s/jobs/%s/logs", queueName, jobId))
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
+func (c *Client) ServerInfo(ctx context.Context) (string, error) {
+	resp, err := c.httpClient.R().Get("/")
+	if err != nil {
+		return "", err
+	}
+
+	return string(resp.Body()), nil
+}

clients/golang/pkg/client/options.go

@@ -0,0 +1,12 @@
+package client
+
+func RootUrl(url string) ClientOpts {
+	return func(c *Client) {
+		c.rootUrl = url
+	}
+}
+func AuthToken(token string) ClientOpts {
+	return func(c *Client) {
+		c.authToken = token
+	}
+}

clients/golang/pkg/client/proxyapi/job.go

@@ -0,0 +1,51 @@
+package proxyapi
+
+type Job struct {
+	// The name of the Job
+	Name string `json:"name"`
+	// The payload for this job.
+	Data any `json:"data"`
+	// The options object for this job.
+	Opts *BaseJobOptions `json:"opts"`
+	// The ID of the job.
+	ID *string `json:"id,omitempty"`
+	// It includes the prefix, the namespace separator :, and queue name.
+	// See https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+	QueueQualifiedName string `json:"queueQualifiedName"`
+	// The progress a job has performed so far.
+	// Default value is 0.
+	Progress any `json:"progress,omitempty"`
+	// The value returned by the processor when processing this job.
+	// Default value is null.
+	Returnvalue any `json:"returnvalue,omitempty"`
+	// Stacktrace for the error (for failed jobs).
+	// Default value is null.
+	Stacktrace []string `json:"stacktrace,omitempty"`
+	// An amount of milliseconds to wait until this job can be processed.
+	// Default value is 0.
+	Delay int64 `json:"delay,omitempty"`
+	// Timestamp when the job was created (unless overridden with job options).
+	Timestamp int64 `json:"timestamp,omitempty"`
+	// Number of attempts when job is moved to active.
+	// Default value is 0.
+	AttemptsStarted int `json:"attemptsStarted,omitempty"`
+	// Number of attempts after the job has failed.
+	// Default value is 0.
+	AttemptsMade int `json:"attemptsMade,omitempty"`
+	// Reason for failing.
+	FailedReason string `json:"failedReason,omitempty"`
+	// Timestamp when the job was finished.
+	FinishedOn *int64 `json:"finishedOn,omitempty,omitempty"`
+	// Timestamp when the job was processed.
+	ProcessedOn *int64 `json:"processedOn,omitempty,omitempty"`
+	// The key of the parent job.
+	ParentKey *string `json:"parentKey,omitempty,omitempty"`
+	// The parent job.
+	Parent *JobRef `json:"parent,omitempty,omitempty"`
+	// The key of the repeat job.
+	RepeatJobKey *string `json:"repeatJobKey,omitempty,omitempty"`
+	// The token of the job.
+	Token *string `json:"token,omitempty,omitempty"`
+	// The ID of the process that processed the job.
+	ProcessedBy *string `json:"processedBy,omitempty,omitempty"`
+}

clients/golang/pkg/client/proxyapi/job_opts.go

@@ -0,0 +1,63 @@
+package proxyapi
+
+type JobSpec struct {
+	Name    string          `json:"name"`
+	Data    string          `json:"data"`
+	Options *BulkJobOptions `json:"opts,omitempty"`
+}
+
+type JobRef struct {
+	Id string `json:"id"`
+
+	/**
+	 * It includes the prefix, the namespace separator :, and queue name.
+	 * @see https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+	 */
+	Queue string `json:"queue"`
+}
+
+type DefaultJobOptions struct {
+	Timestamp        *int             `json:"timestamp,omitempty"`
+	Priority         int              `json:"priority,omitempty"`
+	Delay            int              `json:"delay,omitempty"`
+	Attempts         int              `json:"attempts,omitempty"`
+	Backoff          *BackoffStrategy `json:"backoff,omitempty"` //TODO: support a custom unmarshaler
+	Lifo             bool             `json:"lifo,omitempty"`
+	RemoveOnComplete *RemovePolicy    `json:"removeOnComplete,omitempty"`
+	RemoveOnFail     *RemovePolicy    `json:"removeOnFail,omitempty"`
+	KeepLogs         int              `json:"keepLogs,omitempty"`
+	StackTraceLimit  int              `json:"stackTraceLimit,omitempty"`
+	SizeLimit        int              `json:"sizeLimit,omitempty"`
+}
+
+type BaseJobOptions struct {
+	DefaultJobOptions
+
+	Repeat       *RepeatOptions `json:"repeat,omitempty"`
+	RepeatJobKey *string        `json:"repeatJobKey,omitempty"`
+
+	JobId  *string `json:"jobId,omitempty"`
+	Parent *JobRef `json:"parent,omitempty"`
+
+	/**
+	 * Internal property used by repeatable jobs.
+	 */
+	PrevMillis *int `json:"prevMillis,omitempty"`
+}
+
+type BulkJobOptions struct {
+	BaseJobOptions
+
+	FailParentOnFailure       bool `json:"failParentOnFailure"`
+	IgnoreDependencyOnFailure bool `json:"ignoreDependencyOnFailure"`
+	RemoveDependencyOnFailure bool `json:"removeDependencyOnFailure"`
+
+	// Repeat cannot be set for bulk jobs, so we just don't send the repeat option by setting the json tag to -
+	Repeat       any    `json:"-"`
+	RepeatJobKey string `json:"-"`
+}
+
+type RedisJobOptions struct {
+	BaseJobOptions
+}
+