Add per request timeout

Author: danischm

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.15 (unreleased)
+
+- Add configurable per request HTTP timeout
+
 ## 0.1.14
 
 - Extend default wait time for release of device database lock to 120 seconds and make it configurable

client.go

@@ -310,11 +310,21 @@ func (client *Client) Do(req Req) (Res, error) {
 		defer client.mutex.Unlock()
 	}
 
+	// Use per-request timeout if specified, otherwise use client's default timeout
+	httpClient := client.HttpClient
+	if req.Timeout > 0 {
+		httpClient = &http.Client{
+			Timeout:   req.Timeout,
+			Transport: client.HttpClient.Transport,
+			Jar:       client.HttpClient.Jar,
+		}
+	}
+
 	for attempts := 0; ; attempts++ {
 		req.HttpReq.Body = io.NopCloser(bytes.NewBuffer(body))
 		log.Printf("[DEBUG] HTTP Request: %s, %s, %s", req.HttpReq.Method, req.HttpReq.URL, req.HttpReq.Body)
 
-		httpRes, err := client.HttpClient.Do(req.HttpReq)
+		httpRes, err := httpClient.Do(req.HttpReq)
 		if err != nil {
 			if ok := client.Backoff(attempts); !ok {
 				log.Printf("[ERROR] HTTP Connection error occured: %+v", err)

client_test.go

@@ -38,6 +38,28 @@ func TestNewClient(t *testing.T) {
 	assert.Equal(t, client.MaxRetries, 0)
 }
 
+// TestPerRequestTimeout tests per-request timeout functionality.
+func TestPerRequestTimeout(t *testing.T) {
+	defer gock.Off()
+	client := testClient()
+
+	// Test that the timeout modifier function works correctly
+	req := client.NewReq("GET", RestconfDataEndpoint+"/url", nil, Timeout(30*time.Second))
+	assert.Equal(t, req.Timeout, 30*time.Second)
+
+	// Test that the timeout modifier function works on existing requests
+	timeoutFunc := Timeout(45 * time.Second)
+	req2 := client.NewReq("GET", RestconfDataEndpoint+"/url", nil)
+	timeoutFunc(&req2)
+	assert.Equal(t, req2.Timeout, 45*time.Second)
+
+	// Test convenience methods with timeout modifier
+	// This mainly tests that the modifier is properly passed through
+	gock.New(testURL).Get("/restconf/data/test").Reply(200)
+	_, err := client.GetData("test", Timeout(15*time.Second))
+	assert.NoError(t, err)
+}
+
 // TestDiscoverRestconfEndpoint tests the Client::discoverRestconfEndpoint method.
 func TestDiscoverRestconfEndpoint(t *testing.T) {
 	defer gock.Off()

req.go

@@ -3,6 +3,7 @@ package restconf
 import (
 	"encoding/json"
 	"net/http"
+	"time"
 
 	"github.com/tidwall/gjson"
 	"github.com/tidwall/sjson"
@@ -63,6 +64,8 @@ type Req struct {
 	HttpReq *http.Request
 	// Wait until write operation is complete.
 	Wait bool
+	// Timeout for this specific request (optional).
+	Timeout time.Duration
 }
 
 // Query sets an HTTP query parameter.
@@ -87,3 +90,13 @@ func Query(k, v string) func(req *Req) {
 func Wait(req *Req) {
 	req.Wait = true
 }
+
+// Timeout sets a custom timeout for this specific request.
+// If not set, the client's default timeout will be used.
+//
+//	client.GetData("Cisco-IOS-XE-native:native", restconf.Timeout(30*time.Second))
+func Timeout(timeout time.Duration) func(req *Req) {
+	return func(req *Req) {
+		req.Timeout = timeout
+	}
+}