Skip to content

feat: Introduce Context in Golang #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manisha1997 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Introduce Context in Golang #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
191e304
chore: Twilio csharp path param
manisha1997 May 19, 2025
5140254
chore: Twilio csharp path param
manisha1997 May 19, 2025
a4a411c
chore: Twilio golang generation introduce context
manisha1997 May 21, 2025
c949f39
chore: context in golang
manisha1997 May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions src/main/resources/twilio-go/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package {{packageName}}

{{#operations}}
import (
"context"
"encoding/json"
"fmt"
"net/url"
Expand Down Expand Up @@ -37,6 +38,9 @@ func (params *{{{nickname}}}Params) Set{{paramName}}({{paramName}} {{{dataType}}
// {{{notes}}}
{{/notes}}
func (c *ApiService) {{{nickname}}}({{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}}{{#hasOptionalParams}}params *{{{nickname}}}Params{{/hasOptionalParams}}) ({{#returnType}}*{{{returnType}}}, {{/returnType}}error) {
return c.{{{nickname}}}WithContext(context.TODO(), {{#allParams}}{{#required}}{{paramName}} {{^-last}}, {{/-last}}{{/required}}{{/allParams}}{{#hasOptionalParams}}params {{/hasOptionalParams}})
}
func (c *ApiService) {{{nickname}}}WithContext(ctx context.Context, {{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}}{{#hasOptionalParams}}params *{{{nickname}}}Params{{/hasOptionalParams}}) ({{#returnType}}*{{{returnType}}}, {{/returnType}}error) {
path := "{{{path}}}"
{{>partial_serialization}}

Expand All @@ -48,10 +52,10 @@ func (c *ApiService) {{{nickname}}}({{#allParams}}{{#required}}{{paramName}} {{{
{{/headerParams}}
{{/hasHeaderParams}}
{{#vendorExtensions.x-is-json-type}}
resp, err := c.requestHandler.{{httpMethod}}(c.baseURL+path, data, headers, body...)
resp, err := c.requestHandler.{{httpMethod}}WithContext(ctx, c.baseURL+path, data, headers, body...)
{{/vendorExtensions.x-is-json-type}}
{{^vendorExtensions.x-is-json-type}}
resp, err := c.requestHandler.{{httpMethod}}(c.baseURL+path, data, headers)
resp, err := c.requestHandler.{{httpMethod}}WithContext(ctx, c.baseURL+path, data, headers)
{{/vendorExtensions.x-is-json-type}}
{{#returnType}}
if err != nil {
Expand Down Expand Up @@ -81,6 +85,11 @@ func (c *ApiService) {{{nickname}}}({{#allParams}}{{#required}}{{paramName}} {{{
{{#vendorExtensions.x-is-read-operation}}
// Retrieve a single page of {{{vendorExtensions.x-domain-name}}} records from the API. Request is executed immediately.
func (c *ApiService) Page{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params, pageToken, pageNumber string) (*{{{returnContainer}}}, error) {
return c.Page{{{vendorExtensions.x-domain-name}}}WithContext(context.TODO(), {{#allParams}}{{#required}}{{paramName}} {{^last}}, {{/last}}{{/required}}{{/allParams}}params, pageToken, pageNumber)
}

// Retrieve a single page of {{{vendorExtensions.x-domain-name}}} records from the API. Request is executed immediately.
func (c *ApiService) Page{{{vendorExtensions.x-domain-name}}}WithContext(ctx context.Context, {{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params, pageToken, pageNumber string) (*{{{returnContainer}}}, error) {
path := "{{{path}}}"

{{>partial_serialization}}
Expand All @@ -91,7 +100,7 @@ func (c *ApiService) Page{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#r
data.Set("Page", pageNumber)
}

resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
resp, err := c.requestHandler.GetWithContext(ctx, c.baseURL+path, data, headers)
if err != nil {
return nil, err
}
Expand All @@ -108,7 +117,12 @@ func (c *ApiService) Page{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#r

// Lists {{{vendorExtensions.x-domain-name}}} records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (c *ApiService) List{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params) ({{{returnType}}}, error) {
response, errors := c.Stream{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#required}}{{paramName}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params)
return c.List{{{vendorExtensions.x-domain-name}}}WithContext(context.TODO(), {{#allParams}}{{#required}}{{paramName}} {{^last}}, {{/last}}{{/required}}{{/allParams}}params)
}

// Lists {{{vendorExtensions.x-domain-name}}} records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (c *ApiService) List{{{vendorExtensions.x-domain-name}}}WithContext(ctx context.Context, {{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params) ({{{returnType}}}, error) {
response, errors := c.Stream{{{vendorExtensions.x-domain-name}}}WithContext(ctx, {{#allParams}}{{#required}}{{paramName}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params)

records := make({{{returnType}}}, 0)
for record := range response {
Expand All @@ -124,6 +138,11 @@ func (c *ApiService) List{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#r

// Streams {{{vendorExtensions.x-domain-name}}} 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) Stream{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params) (chan {{{returnBaseType}}}, chan error) {
return c.Stream{{{vendorExtensions.x-domain-name}}}WithContext(context.TODO(), {{#allParams}}{{#required}}{{paramName}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params)
}

// Streams {{{vendorExtensions.x-domain-name}}} 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) Stream{{{vendorExtensions.x-domain-name}}}WithContext(ctx context.Context, {{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params *{{{nickname}}}Params) (chan {{{returnBaseType}}}, chan error) {
if params == nil {
params = &{{{nickname}}}Params{}
}
Expand All @@ -132,20 +151,20 @@ func (c *ApiService) Stream{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{
recordChannel := make(chan {{{returnBaseType}}}, 1)
errorChannel := make(chan error, 1)

response, err := c.Page{{{vendorExtensions.x-domain-name}}}({{#allParams}}{{#required}}{{paramName}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params, "", "")
response, err := c.Page{{{vendorExtensions.x-domain-name}}}WithContext(ctx, {{#allParams}}{{#required}}{{paramName}}{{^last}}, {{/last}}{{/required}}{{/allParams}}params, "", "")
if err != nil {
errorChannel <- err
close(recordChannel)
close(errorChannel)
} else {
go c.stream{{{vendorExtensions.x-domain-name}}}(response, params, recordChannel, errorChannel)
go c.stream{{{vendorExtensions.x-domain-name}}}WithContext(ctx, response, params, recordChannel, errorChannel)
}

return recordChannel, errorChannel
}


func (c *ApiService) stream{{{vendorExtensions.x-domain-name}}}(response *{{{returnContainer}}}, params *{{{nickname}}}Params, recordChannel chan {{{returnBaseType}}}, errorChannel chan error) {
func (c *ApiService) stream{{{vendorExtensions.x-domain-name}}}WithContext(ctx context.Context, response *{{{returnContainer}}}, params *{{{nickname}}}Params, recordChannel chan {{{returnBaseType}}}, errorChannel chan error) {
curRecord := 1

for response != nil {
Expand All @@ -160,7 +179,7 @@ func (c *ApiService) stream{{{vendorExtensions.x-domain-name}}}(response *{{{ret
}
}

record, err := client.GetNext(c.baseURL, response, c.getNext{{{returnContainer}}})
record, err := client.GetNextWithContext(ctx, c.baseURL, response, c.getNext{{{returnContainer}}}WithContext)
if err != nil {
errorChannel <- err
break
Expand All @@ -175,11 +194,11 @@ func (c *ApiService) stream{{{vendorExtensions.x-domain-name}}}(response *{{{ret
close(errorChannel)
}

func (c *ApiService) getNext{{{returnContainer}}}(nextPageUrl string) (interface{}, error) {
func (c *ApiService) getNext{{{returnContainer}}}WithContext(ctx context.Context, nextPageUrl string) (interface{}, error) {
if nextPageUrl == "" {
return nil, nil
}
resp, err := c.requestHandler.Get(nextPageUrl, nil, nil)
resp, err := c.requestHandler.GetWithContext(ctx, nextPageUrl, nil, nil)
if err != nil {
return nil, err
}
Expand Down
7 changes: 7 additions & 0 deletions src/main/resources/twilio-go/api_service.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,10 @@ func NewApiService(requestHandler *twilio.RequestHandler) *ApiService {
func NewApiServiceWithClient(client twilio.BaseClient) *ApiService {
return NewApiService(twilio.NewRequestHandler(client))
}

func NewApiServiceWithCtx(requestHandler *twilio.RequestHandler) *ApiService {
return &ApiService {
requestHandler: requestHandler,
baseURL: "{{#hasServers}}{{#servers}}{{url}}{{/servers}}{{/hasServers}}",
}
}
Loading