Merge pull request #5 from randlabs/new_version

Changes for V2

Author: mxmauro

.gitignore

@@ -1,25 +1,5 @@
-
 *.~*
-
-*.log
-*.swp
+qodana.yaml
 .idea
-*.patch
-### Go template
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, build with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
 .DS_Store
-app
-demo
-
 vendor/*

LICENSE renamed to LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C) 2021 RandLabs
+   Copyright (C) 2021-2023 RandLabs
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -10,7 +10,7 @@ The base code of this library, the balancer, *DOES NOT DO* any kind of network a
 import (
     "time"
 
-    balancer "github.com/randlabs/go-loadbalancer"
+    balancer "github.com/randlabs/go-loadbalancer/v2"
 )
 
 type ServerInfo struct {
@@ -100,7 +100,7 @@ requests among them.
 import (
     "fmt"
 
-    balancer "github.com/randlabs/go-loadbalancer"
+    balancer "github.com/randlabs/go-loadbalancer/v2"
 )
 
 func main() {
@@ -120,20 +120,22 @@ func main() {
         },
     })
 
-    req := hc.NewRequest("GET", "/api-test")
-    err := req.Exec(context.Background(), func (ctx context.Context, res httpclient.Response) error {
-        if res.Err() != nil || res.StatusCode != 200 {
-            // Retry on the next available server on failed request
-            res.RetryOnNextServer()
-            return nil
-        }
+    err := hc.NewRequest(context.Background(), "/api-test").
+        Method("GET").
+        Callback(func (ctx context.Context, res httpclient.Response) error {
+            if res.Err() != nil || res.StatusCode != 200 {
+                // Retry on the next available server on failed request
+                res.RetryOnNextServer()
+                return nil
+            }
 
-        // Process response
-        // ...
+            // Process response
+            // ...
 
-        // Done
-        return nil
-    })
+            // Done
+            return nil
+        }).
+        Exec()
 }
 ```
 

go.mod

@@ -1,5 +1,11 @@
-module github.com/randlabs/go-loadbalancer
+module github.com/randlabs/go-loadbalancer/v2
 
-go 1.16
+go 1.18
 
 require github.com/stretchr/testify v1.8.4
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -1,17 +1,10 @@
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 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/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/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 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.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

httpclient/exec.go

@@ -8,36 +8,33 @@ import (
 	"net"
 	"net/http"
 	"strings"
-	"time"
 )
 
 // -----------------------------------------------------------------------------
 
 const (
-	defaultTimeout = 20 * time.Second
-
 	errUnableToExecuteRequest = "failed to execute http request"
 	errNoAvailableServer      = "no available upstream server"
 )
 
 // -----------------------------------------------------------------------------
 
-func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Request) error {
-	var httpreq *http.Request
+func (c *HttpClient) exec(req *Request) error {
+	var httpReq *http.Request
 	var getBody func() io.ReadCloser
 	var err error
 
 	// Define a body getter to return multiple copies of the reader to be used in retries.
-	if req.Body == nil {
+	if req.body == nil {
 		// If no body, getter will return nil
 		getBody = func() io.ReadCloser {
 			return nil
 		}
 	} else {
 		// Convert to a ReadCloser if just a reader
-		rc, ok := req.Body.(io.ReadCloser)
+		rc, ok := req.body.(io.ReadCloser)
 		if !ok {
-			rc = io.NopCloser(req.Body)
+			rc = io.NopCloser(req.body)
 		}
 
 		// Defer close of the original body
@@ -46,7 +43,7 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 		}()
 
 		// Set up a body reader cloning function
-		switch v := req.Body.(type) {
+		switch v := req.body.(type) {
 		case *bytes.Buffer:
 			buf := v.Bytes()
 			getBody = func() io.ReadCloser {
@@ -79,37 +76,38 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 	// Loop
 	for {
 		var netErr net.Error
-		var cancelCtx context.CancelFunc
 
 		// Get next available server
 		srv := c.lb.Next()
 		if srv == nil {
-			return c.newError(nil, errNoAvailableServer, req.Resource, 0)
+			return c.newError(nil, errNoAvailableServer, req.url, 0)
 		}
 
 		src := srv.UserData().(*Source)
 
 		// Create the final url
-		url := src.baseURL + req.Resource
+		url := src.baseURL + req.url
 
 		// Create a new http request
-		httpreq, err = http.NewRequest(req.Method, url, getBody())
+		httpReq, err = http.NewRequest(req.method, url, getBody())
 		if err != nil {
 			err = c.newError(err, errUnableToExecuteRequest, url, 0)
 			src.setLastError(err)
 			return err
 		}
 
 		// Add load balancer source headers
-		httpreq.Header = src.header.Clone()
+		httpReq.Header = src.header.Clone()
 
 		// Add request headers
-		for k, v := range req.Header {
-			vLen := len(v)
-			if vLen > 0 {
-				httpreq.Header.Set(k, v[0])
-				for vIdx := 1; vIdx < vLen; vIdx++ {
-					httpreq.Header.Add(k, v[vIdx])
+		if req.headers != nil {
+			for k, v := range req.headers {
+				vLen := len(v)
+				if vLen > 0 {
+					httpReq.Header.Set(k, v[0])
+					for vIdx := 1; vIdx < vLen; vIdx++ {
+						httpReq.Header.Add(k, v[vIdx])
+					}
 				}
 			}
 		}
@@ -119,13 +117,6 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 			Transport: c.transport,
 		}
 
-		// Establish a new context with a default timeout if a deadline is not present
-		ctx := parentCtx
-		cancelCtx = nil
-		if _, hasDeadline := parentCtx.Deadline(); !hasDeadline {
-			ctx, cancelCtx = context.WithTimeout(parentCtx, defaultTimeout)
-		}
-
 		// Build callback info
 		upstreamOffline := false
 		retry := false
@@ -137,8 +128,11 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 			retry:           &retry,
 		}
 
+		// Establish a new context with the timeout
+		ctx, cancelCtx := context.WithTimeout(req.ctx, req.timeout)
+
 		// Execute real request
-		execResult.Response, err = client.Do(httpreq.WithContext(ctx))
+		execResult.Response, err = client.Do(httpReq.WithContext(ctx))
 		if err != nil {
 			if errors.Is(err, context.DeadlineExceeded) {
 				// Deadline exceeded?
@@ -163,7 +157,7 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 		execResult.err = err
 
 		// Call the callback
-		err = cb(parentCtx, execResult)
+		err = req.callback(ctx, execResult)
 		if err != nil {
 			if errors.Is(err, context.DeadlineExceeded) {
 				err = ErrTimeout
@@ -175,9 +169,7 @@ func (c *HttpClient) exec(parentCtx context.Context, cb ExecCallback, req *Reque
 		}
 
 		// To avoid defer calling inside a for loop and warnings, we call it here
-		if cancelCtx != nil {
-			cancelCtx()
-		}
+		cancelCtx()
 
 		// Close the response body if one exist
 		if execResult.Response != nil {

httpclient/httpclient.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/randlabs/go-loadbalancer"
+	"github.com/randlabs/go-loadbalancer/v2"
 )
 
 // -----------------------------------------------------------------------------