feat: add context.Context support to Go SDK

PULL_REQUEST_TEMPLATE.md

@@ -22,7 +22,7 @@ A short description of what this PR does.
 - [x] I acknowledge that all my contributions will be made under the project's license
 - [ ] Run `make test-docker`
 - [ ] Verify affected language:
-    - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff
+    - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_library.py](./scripts/build_twilio_library.py) using `python3 scripts/build_twilio_library.py -lang go path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff
     - [ ] Run `make test` in `twilio-go`
     - [ ] Create a pull request in `twilio-go`
     - [ ] Provide a link below to the pull request

examples/go/go-client/helper/client/test_client.go

@@ -1,6 +1,7 @@
 package client
 
 import (
+	"context"
 	"net/http"
 	"net/url"
 	"time"
@@ -37,6 +38,6 @@ func (tc *TestClient) getParsedUrl(path string) *url.URL {
 	return parsedUrl
 }
 
-func (tc *TestClient) SendRequest(method string, rawURL string, data url.Values, headers map[string]interface{}) (*http.Response, error) {
-	return tc.Client.SendRequest(method, tc.getParsedUrl(rawURL).String(), data, headers)
+func (tc *TestClient) SendRequestWithCtx(context context.Context, method string, rawURL string, data url.Values, headers map[string]interface{}) (*http.Response, error) {
+	return tc.Client.SendRequestWithCtx(context, method, tc.getParsedUrl(rawURL).String(), data, headers)
 }

examples/go/go-client/helper/rest/api/v2010/accounts.go

@@ -15,6 +15,7 @@
 package openapi
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"net/url"
@@ -54,6 +55,10 @@ func (params *CreateAccountParams) SetTwiml(Twiml string) *CreateAccountParams {
 }
 
 func (c *ApiService) CreateAccount(params *CreateAccountParams) (*TestResponseObject, error) {
+	return c.CreateAccountWithCtx(context.TODO(), params)
+}
+
+func (c *ApiService) CreateAccountWithCtx(ctx context.Context, params *CreateAccountParams) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts.json"
 
 	data := url.Values{}
@@ -75,7 +80,7 @@ func (c *ApiService) CreateAccount(params *CreateAccountParams) (*TestResponseOb
 		headers["X-Twilio-Webhook-Enabled"] = *params.XTwilioWebhookEnabled
 	}
 
-	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Post(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}
@@ -91,13 +96,17 @@ func (c *ApiService) CreateAccount(params *CreateAccountParams) (*TestResponseOb
 }
 
 func (c *ApiService) DeleteAccount(Sid string) error {
+	return c.DeleteAccountWithCtx(context.TODO(), Sid)
+}
+
+func (c *ApiService) DeleteAccountWithCtx(ctx context.Context, Sid string) error {
 	path := "/2010-04-01/Accounts/{Sid}.json"
 	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
 
 	data := url.Values{}
 	headers := make(map[string]interface{})
 
-	resp, err := c.requestHandler.Delete(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Delete(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return err
 	}
@@ -108,13 +117,17 @@ func (c *ApiService) DeleteAccount(Sid string) error {
 }
 
 func (c *ApiService) FetchAccount(Sid string) (*TestResponseObject, error) {
+	return c.FetchAccountWithCtx(context.TODO(), Sid)
+}
+
+func (c *ApiService) FetchAccountWithCtx(ctx context.Context, Sid string) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts/{Sid}.json"
 	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
 
 	data := url.Values{}
 	headers := make(map[string]interface{})
 
-	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Get(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}
@@ -172,6 +185,11 @@ func (params *ListAccountParams) SetLimit(Limit int) *ListAccountParams {
 
 // Retrieve a single page of Account records from the API. Request is executed immediately.
 func (c *ApiService) PageAccount(params *ListAccountParams, pageToken, pageNumber string) (*ListAccountResponse, error) {
+	return c.PageAccountWithCtx(context.TODO(), params, pageToken, pageNumber)
+}
+
+// Retrieve a single page of Account records from the API. Request is executed immediately.
+func (c *ApiService) PageAccountWithCtx(ctx context.Context, params *ListAccountParams, pageToken, pageNumber string) (*ListAccountResponse, error) {
 	path := "/2010-04-01/Accounts.json"
 
 	data := url.Values{}
@@ -200,7 +218,7 @@ func (c *ApiService) PageAccount(params *ListAccountParams, pageToken, pageNumbe
 		data.Set("Page", pageNumber)
 	}
 
-	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Get(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}
@@ -217,7 +235,12 @@ func (c *ApiService) PageAccount(params *ListAccountParams, pageToken, pageNumbe
 
 // Lists Account records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
 func (c *ApiService) ListAccount(params *ListAccountParams) ([]TestResponseObject, error) {
-	response, errors := c.StreamAccount(params)
+	return c.ListAccountWithCtx(context.TODO(), params)
+}
+
+// Lists Account records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
+func (c *ApiService) ListAccountWithCtx(ctx context.Context, params *ListAccountParams) ([]TestResponseObject, error) {
+	response, errors := c.StreamAccountWithCtx(ctx, params)
 
 	records := make([]TestResponseObject, 0)
 	for record := range response {
@@ -233,6 +256,11 @@ func (c *ApiService) ListAccount(params *ListAccountParams) ([]TestResponseObjec
 
 // Streams Account records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
 func (c *ApiService) StreamAccount(params *ListAccountParams) (chan TestResponseObject, chan error) {
+	return c.StreamAccountWithCtx(context.TODO(), params)
+}
+
+// Streams Account records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
+func (c *ApiService) StreamAccountWithCtx(ctx context.Context, params *ListAccountParams) (chan TestResponseObject, chan error) {
 	if params == nil {
 		params = &ListAccountParams{}
 	}
@@ -241,19 +269,19 @@ func (c *ApiService) StreamAccount(params *ListAccountParams) (chan TestResponse
 	recordChannel := make(chan TestResponseObject, 1)
 	errorChannel := make(chan error, 1)
 
-	response, err := c.PageAccount(params, "", "")
+	response, err := c.PageAccountWithCtx(ctx, params, "", "")
 	if err != nil {
 		errorChannel <- err
 		close(recordChannel)
 		close(errorChannel)
 	} else {
-		go c.streamAccount(response, params, recordChannel, errorChannel)
+		go c.streamAccount(ctx, response, params, recordChannel, errorChannel)
 	}
 
 	return recordChannel, errorChannel
 }
 
-func (c *ApiService) streamAccount(response *ListAccountResponse, params *ListAccountParams, recordChannel chan TestResponseObject, errorChannel chan error) {
+func (c *ApiService) streamAccount(ctx context.Context, response *ListAccountResponse, params *ListAccountParams, recordChannel chan TestResponseObject, errorChannel chan error) {
 	curRecord := 1
 
 	for response != nil {
@@ -268,7 +296,7 @@ func (c *ApiService) streamAccount(response *ListAccountResponse, params *ListAc
 			}
 		}
 
-		record, err := client.GetNext(c.baseURL, response, c.getNextListAccountResponse)
+		record, err := client.GetNextWithCtx(ctx, c.baseURL, response, c.getNextListAccountResponse)
 		if err != nil {
 			errorChannel <- err
 			break
@@ -283,11 +311,11 @@ func (c *ApiService) streamAccount(response *ListAccountResponse, params *ListAc
 	close(errorChannel)
 }
 
-func (c *ApiService) getNextListAccountResponse(nextPageUrl string) (interface{}, error) {
+func (c *ApiService) getNextListAccountResponse(ctx context.Context, nextPageUrl string) (interface{}, error) {
 	if nextPageUrl == "" {
 		return nil, nil
 	}
-	resp, err := c.requestHandler.Get(nextPageUrl, nil, nil)
+	resp, err := c.requestHandler.Get(ctx, nextPageUrl, nil, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -319,6 +347,10 @@ func (params *UpdateAccountParams) SetStatus(Status string) *UpdateAccountParams
 }
 
 func (c *ApiService) UpdateAccount(Sid string, params *UpdateAccountParams) (*TestResponseObject, error) {
+	return c.UpdateAccountWithCtx(context.TODO(), Sid, params)
+}
+
+func (c *ApiService) UpdateAccountWithCtx(ctx context.Context, Sid string, params *UpdateAccountParams) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts/{Sid}.json"
 	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
 
@@ -332,7 +364,7 @@ func (c *ApiService) UpdateAccount(Sid string, params *UpdateAccountParams) (*Te
 		data.Set("Status", *params.Status)
 	}
 
-	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Post(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}

examples/go/go-client/helper/rest/api/v2010/accounts_calls.go

@@ -15,6 +15,7 @@
 package openapi
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"net/url"
@@ -57,6 +58,10 @@ func (params *CreateCallParams) SetTestMethod(TestMethod string) *CreateCallPara
 }
 
 func (c *ApiService) CreateCall(params *CreateCallParams) (*TestResponseObject, error) {
+	return c.CreateCallWithCtx(context.TODO(), params)
+}
+
+func (c *ApiService) CreateCallWithCtx(ctx context.Context, params *CreateCallParams) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts/{AccountSid}/Calls.json"
 	if params != nil && params.PathAccountSid != nil {
 		path = strings.Replace(path, "{"+"AccountSid"+"}", *params.PathAccountSid, -1)
@@ -84,7 +89,7 @@ func (c *ApiService) CreateCall(params *CreateCallParams) (*TestResponseObject,
 		data.Set("TestMethod", *params.TestMethod)
 	}
 
-	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Post(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}
@@ -111,6 +116,10 @@ func (params *DeleteCallParams) SetPathAccountSid(PathAccountSid string) *Delete
 }
 
 func (c *ApiService) DeleteCall(TestInteger int, params *DeleteCallParams) error {
+	return c.DeleteCallWithCtx(context.TODO(), TestInteger, params)
+}
+
+func (c *ApiService) DeleteCallWithCtx(ctx context.Context, TestInteger int, params *DeleteCallParams) error {
 	path := "/2010-04-01/Accounts/{AccountSid}/Calls/{TestInteger}.json"
 	if params != nil && params.PathAccountSid != nil {
 		path = strings.Replace(path, "{"+"AccountSid"+"}", *params.PathAccountSid, -1)
@@ -122,7 +131,7 @@ func (c *ApiService) DeleteCall(TestInteger int, params *DeleteCallParams) error
 	data := url.Values{}
 	headers := make(map[string]interface{})
 
-	resp, err := c.requestHandler.Delete(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Delete(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return err
 	}
@@ -144,6 +153,10 @@ func (params *FetchCallParams) SetPathAccountSid(PathAccountSid string) *FetchCa
 }
 
 func (c *ApiService) FetchCall(TestInteger int, params *FetchCallParams) (*TestResponseObject, error) {
+	return c.FetchCallWithCtx(context.TODO(), TestInteger, params)
+}
+
+func (c *ApiService) FetchCallWithCtx(ctx context.Context, TestInteger int, params *FetchCallParams) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts/{AccountSid}/Calls/{TestInteger}.json"
 	if params != nil && params.PathAccountSid != nil {
 		path = strings.Replace(path, "{"+"AccountSid"+"}", *params.PathAccountSid, -1)
@@ -155,7 +168,7 @@ func (c *ApiService) FetchCall(TestInteger int, params *FetchCallParams) (*TestR
 	data := url.Values{}
 	headers := make(map[string]interface{})
 
-	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Get(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}

examples/go/go-client/helper/rest/api/v2010/accounts_calls_feedback_summary.go

@@ -15,6 +15,7 @@
 package openapi
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"net/url"
@@ -51,6 +52,10 @@ func (params *UpdateCallFeedbackSummaryParams) SetStartDate(StartDate string) *U
 }
 
 func (c *ApiService) UpdateCallFeedbackSummary(Sid string, params *UpdateCallFeedbackSummaryParams) (*TestResponseObject, error) {
+	return c.UpdateCallFeedbackSummaryWithCtx(context.TODO(), Sid, params)
+}
+
+func (c *ApiService) UpdateCallFeedbackSummaryWithCtx(ctx context.Context, Sid string, params *UpdateCallFeedbackSummaryParams) (*TestResponseObject, error) {
 	path := "/2010-04-01/Accounts/{AccountSid}/Calls/Feedback/Summary/{Sid}.json"
 	if params != nil && params.PathAccountSid != nil {
 		path = strings.Replace(path, "{"+"AccountSid"+"}", *params.PathAccountSid, -1)
@@ -72,7 +77,7 @@ func (c *ApiService) UpdateCallFeedbackSummary(Sid string, params *UpdateCallFee
 		data.Set("StartDate", fmt.Sprint(*params.StartDate))
 	}
 
-	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
+	resp, err := c.requestHandler.Post(ctx, c.baseURL+path, data, headers)
 	if err != nil {
 		return nil, err
 	}

examples/go/go-client/helper/rest/api/v2010/api_service.go

@@ -20,10 +20,14 @@ import (
 
 type ApiService struct {
 	baseURL        string
-	requestHandler *twilio.RequestHandler
+	requestHandler *twilio.RequestHandlerWithCtx
 }
 
 func NewApiService(requestHandler *twilio.RequestHandler) *ApiService {
+	return NewApiServiceWithCtx(twilio.UpgradeRequestHandler(requestHandler))
+}
+
+func NewApiServiceWithCtx(requestHandler *twilio.RequestHandlerWithCtx) *ApiService {
 	return &ApiService{
 		requestHandler: requestHandler,
 		baseURL:        "https://api.twilio.com",
@@ -33,3 +37,7 @@ func NewApiService(requestHandler *twilio.RequestHandler) *ApiService {
 func NewApiServiceWithClient(client twilio.BaseClient) *ApiService {
 	return NewApiService(twilio.NewRequestHandler(client))
 }
+
+func NewApiServiceWithClientWithCtx(client twilio.BaseClientWithCtx) *ApiService {
+	return NewApiServiceWithCtx(twilio.NewRequestHandlerWithCtx(client))
+}

examples/go/go-client/helper/rest/flex/v1/api_service.go

@@ -20,10 +20,14 @@ import (
 
 type ApiService struct {
 	baseURL        string
-	requestHandler *twilio.RequestHandler
+	requestHandler *twilio.RequestHandlerWithCtx
 }
 
 func NewApiService(requestHandler *twilio.RequestHandler) *ApiService {
+	return NewApiServiceWithCtx(twilio.UpgradeRequestHandler(requestHandler))
+}
+
+func NewApiServiceWithCtx(requestHandler *twilio.RequestHandlerWithCtx) *ApiService {
 	return &ApiService{
 		requestHandler: requestHandler,
 		baseURL:        "https://flex-api.twilio.com",
@@ -33,3 +37,7 @@ func NewApiService(requestHandler *twilio.RequestHandler) *ApiService {
 func NewApiServiceWithClient(client twilio.BaseClient) *ApiService {
 	return NewApiService(twilio.NewRequestHandler(client))
 }
+
+func NewApiServiceWithClientWithCtx(client twilio.BaseClientWithCtx) *ApiService {
+	return NewApiServiceWithCtx(twilio.NewRequestHandlerWithCtx(client))
+}