Add option for including operationName as a query parameter #298
Conversation
cgetzen
requested review from
benjaminjkraft,
csilvers,
dnerdy and
StevenACoffman
as code owners
|
The lint failures seem unrelated to this PR. I am also unable to trigger these errors locally with: Do you have any guidance on what could be going wrong? Thanks! |
There was a problem hiding this comment.
Thanks for the PR! The code looks fine modulo a few comments, below.
But I do want to check: does this match any standard conventions? I don't see any specific problems here but I want to be a bit careful of going down the road of adding many options to the client. (One can always wrap the Doer (specifically, the http.Transport of the http.Client) instead -- indeed at Khan when we wrote genqlient we did as much to support something similar but with a slightly different convention. For NewClientUsingGet that's substantially harder but here it would be basically the same code.)
| @@ -58,8 +64,8 @@ type client struct { | |||
| // example. | |||
| // | |||
| // [example/main.go]: https://github.com/Khan/genqlient/blob/main/example/main.go#L12-L20 | |||
| func NewClient(endpoint string, httpClient Doer) Client { | |||
| return newClient(endpoint, httpClient, http.MethodPost) | |||
| func NewClient(endpoint string, httpClient Doer, options ...func(*client)) Client { | |||
There was a problem hiding this comment.
technically a breaking change but probably one we can get away with
| body, err := json.Marshal(req) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| httpReq, err := http.NewRequest( | ||
| c.method, | ||
| c.endpoint, | ||
| parsedURL.String(), |
There was a problem hiding this comment.
Is parse/unparse guaranteed to roundtrip a valid URL without changes? Unless we're sure, it's probably a tad safer if we change queryUpdated to urlUpdated and use the URL exactly as specified if we don't need to change it.
There was a problem hiding this comment.
Please also add at least a quick test (either unit or integration, not sure which will be easier to wire up) that the option actually does something!
| } | ||
|
|
||
| // WithOperationNameParam allows operationName to be included as a query parameter. | ||
| func WithOperationNameParam(c *client) { |
There was a problem hiding this comment.
please add a named type for the options so they show up nicely in the documentation
|
Ah, and I'm not sure what's up with the lint. I agree it looks off, but I don't have time to figure out why right now. Perhaps we should try updating the linter -- feel free to give that a go in a separate PR if you like! |
|
Lint is fixed in #311 so once you merge main that part should be good! |
This introduces the ability to include
operationNameas a query parameter for the default client.There are a few patterns for options that are described here. The existing
NewClientUsingGetfollows the "Declare a new constructor for each configuration option" pattern. As additional options get added, the "Functional Options Pattern" may be more scalable.Use-case: This allows requests to be routed based on their operation.
I have: