add *WithCtx methods to base client & request handler

twilio · Nov 7, 2022 · 0bad2da · 0bad2da
1 parent 00173f6
commit 0bad2da
Show file tree

Hide file tree

Showing 3 changed files with 123 additions and 30 deletions.
diff --git a/client/base_client.go b/client/base_client.go
@@ -1,6 +1,7 @@
 package client
 
 import (
+	"context"
 	"net/http"
 	"net/url"
 	"time"
@@ -12,3 +13,27 @@ type BaseClient interface {
 	SendRequest(method string, rawURL string, data url.Values,
 		headers map[string]interface{}) (*http.Response, error)
 }
+
+// BaseClientWithCtx is an extension of BaseClient with the ability to associate a contex with
+// the request
+type BaseClientWithCtx interface {
+	BaseClient
+	SendRequestWithCtx(ctx context.Context, method string, rawURL string, data url.Values,
+		headers map[string]interface{}) (*http.Response, error)
+}
+
+type wrapperClient struct {
+	// embed the BaseClient so the functions remain accessible
+	BaseClient
+}
+
+func (w wrapperClient) SendRequestWithCtx(ctx context.Context, method string, rawURL string, data url.Values,
+	headers map[string]interface{}) (*http.Response, error) {
+	return w.SendRequest(method, rawURL, data, headers)
+}
+
+// wrapBaseClientWithNoopCtx "upgrades" a BaseClient to BaseClientWithCtx so that requests can be
+// send with a request context.
+func wrapBaseClientWithNoopCtx(c BaseClient) BaseClientWithCtx {
+	return wrapperClient{BaseClient: c}
+}
diff --git a/client/page_util.go b/client/page_util.go
@@ -1,6 +1,7 @@
 package client
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"strings"
@@ -34,6 +35,15 @@ func GetNext(baseUrl string, response interface{}, getNextPage func(nextPageUri
 	return getNextPage(nextPageUrl)
 }
 
+func GetNextWithCtx(ctx context.Context, baseUrl string, response interface{}, getNextPage func(ctx context.Context, nextPageUri string) (interface{}, error)) (interface{}, error) {
+	nextPageUrl, err := getNextPageUrl(baseUrl, response)
+	if err != nil {
+		return nil, err
+	}
+
+	return getNextPage(ctx, nextPageUrl)
+}
+
 func toMap(s interface{}) (map[string]interface{}, error) {
 	var payload map[string]interface{}
 	data, err := json.Marshal(s)

diff --git a/client/request_handler.go b/client/request_handler.go
@@ -2,38 +2,14 @@
 package client
 
 import (
+	"context"
 	"net/http"
 	"net/url"
 	"os"
 	"strings"
 )
 
-type RequestHandler struct {
-	Client BaseClient
-	Edge   string
-	Region string
-}
-
-func NewRequestHandler(client BaseClient) *RequestHandler {
-	return &RequestHandler{
-		Client: client,
-		Edge:   os.Getenv("TWILIO_EDGE"),
-		Region: os.Getenv("TWILIO_REGION"),
-	}
-}
-
-func (c *RequestHandler) sendRequest(method string, rawURL string, data url.Values,
-	headers map[string]interface{}) (*http.Response, error) {
-	parsedURL, err := c.BuildUrl(rawURL)
-	if err != nil {
-		return nil, err
-	}
-
-	return c.Client.SendRequest(method, parsedURL, data, headers)
-}
-
-// BuildUrl builds the target host string taking into account region and edge configurations.
-func (c *RequestHandler) BuildUrl(rawURL string) (string, error) {
+func buildUrlInternal(overrideEdge, overrideRegion, rawURL string) (string, error) {
 	u, err := url.Parse(rawURL)
 	if err != nil {
 		return "", err
@@ -63,12 +39,12 @@ func (c *RequestHandler) BuildUrl(rawURL string) (string, error) {
 		region = pieces[2]
 	}
 
-	if c.Edge != "" {
-		edge = c.Edge
+	if overrideEdge != "" {
+		edge = overrideEdge
 	}
 
-	if c.Region != "" {
-		region = c.Region
+	if overrideRegion != "" {
+		region = overrideRegion
 	} else if region == "" && edge != "" {
 		region = "us1"
 	}
@@ -83,14 +59,96 @@ func (c *RequestHandler) BuildUrl(rawURL string) (string, error) {
 	return u.String(), nil
 }
 
+type RequestHandler struct {
+	Client BaseClient
+	Edge   string
+	Region string
+}
+
+func NewRequestHandler(client BaseClient) *RequestHandler {
+	return &RequestHandler{
+		Client: client,
+		Edge:   os.Getenv("TWILIO_EDGE"),
+		Region: os.Getenv("TWILIO_REGION"),
+	}
+}
+
+func (c *RequestHandler) sendRequest(method string, rawURL string, data url.Values,
+	headers map[string]interface{}) (*http.Response, error) {
+	parsedURL, err := c.BuildUrl(rawURL)
+	if err != nil {
+		return nil, err
+	}
+
+	return c.Client.SendRequest(method, parsedURL, data, headers)
+}
+
+// BuildUrl builds the target host string taking into account region and edge configurations.
+func (c *RequestHandler) BuildUrl(rawURL string) (string, error) {
+	return buildUrlInternal(c.Edge, c.Region, rawURL)
+}
+
+// deprecated
 func (c *RequestHandler) Post(path string, bodyData url.Values, headers map[string]interface{}) (*http.Response, error) {
 	return c.sendRequest(http.MethodPost, path, bodyData, headers)
 }
 
+// deprecated
 func (c *RequestHandler) Get(path string, queryData url.Values, headers map[string]interface{}) (*http.Response, error) {
 	return c.sendRequest(http.MethodGet, path, queryData, headers)
 }
 
+// deprecated
 func (c *RequestHandler) Delete(path string, nothing url.Values, headers map[string]interface{}) (*http.Response, error) {
 	return c.sendRequest(http.MethodDelete, path, nil, headers)
 }
+
+func UpgradeRequestHandler(h *RequestHandler) *RequestHandlerWithCtx {
+	return &RequestHandlerWithCtx{
+		// wrapped client will supply context.TODO() to all API calls
+		Client: wrapBaseClientWithNoopCtx(h.Client),
+		Edge:   h.Edge,
+		Region: h.Region,
+	}
+}
+
+type RequestHandlerWithCtx struct {
+	Client BaseClientWithCtx
+	Edge   string
+	Region string
+}
+
+func (c *RequestHandlerWithCtx) sendRequest(ctx context.Context, method string, rawURL string, data url.Values,
+	headers map[string]interface{}) (*http.Response, error) {
+	parsedURL, err := c.BuildUrl(rawURL)
+	if err != nil {
+		return nil, err
+	}
+
+	return c.Client.SendRequestWithCtx(ctx, method, parsedURL, data, headers)
+}
+
+func NewRequestHandlerWithCtx(client BaseClientWithCtx) *RequestHandlerWithCtx {
+	return &RequestHandlerWithCtx{
+		Client: client,
+		Edge:   os.Getenv("TWILIO_EDGE"),
+		Region: os.Getenv("TWILIO_REGION"),
+	}
+}
+
+// BuildUrl builds the target host string taking into account region and edge configurations.
+func (c *RequestHandlerWithCtx) BuildUrl(rawURL string) (string, error) {
+	return buildUrlInternal(c.Edge, c.Region, rawURL)
+}
+
+func (c *RequestHandlerWithCtx) Post(ctx context.Context, path string, bodyData url.Values, headers map[string]interface{}) (*http.Response, error) {
+	return c.sendRequest(ctx, http.MethodPost, path, bodyData, headers)
+}
+
+func (c *RequestHandlerWithCtx) Get(ctx context.Context, path string, queryData url.Values, headers map[string]interface{}) (*http.Response, error) {
+	return c.sendRequest(ctx, http.MethodGet, path, queryData, headers)
+}
+
+func (c *RequestHandlerWithCtx) Delete(ctx context.Context, path string, nothing url.Values, headers map[string]interface{}) (*http.Response, error) {
+	return c.sendRequest(ctx, http.MethodDelete, path, nil, headers)
+}