René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Request Editors are broken","articleBody":"There seems to be an bug introduced with the recent PR #228, resulting in request editors to not work as advertised.\r\n\r\nHere's a snippet of code to illustrate the issue: using the example [`petstore-expanded.yaml`](https://github.com/deepmap/oapi-codegen/blob/master/examples/petstore-expanded/petstore-expanded.yaml) OpenAPI spec provided in this project, I've generated a Go file of the client bindings (`oapi-codegen -generate types,client -package main -o petstore.gen.go petstore-expanded.yaml`), then I added some print statements inside the generated `Client.FindPets()` method as well as in `Client.applyEditors()`:\r\n\r\n```go\r\n// petstore.gen.go\r\nfunc (c *Client) FindPets(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*http.Response, error) {\r\n    req, err := NewFindPetsRequest(c.Server, params)\r\n    if err != nil {\r\n        return nil, err\r\n    }\r\n    fmt.Printf(\"FindPets before applyEditors: req.Host=%s\\n\", req.Host)\r\n    if err := c.applyEditors(ctx, req, reqEditors); err != nil {\r\n        return nil, err\r\n    }\r\n    fmt.Printf(\"FindPets after applyEditors: req.Host=%s\\n\", req.Host)\r\n    return c.Client.Do(req)\r\n}\r\n\r\n// ...\r\n\r\nfunc (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error {\r\n    req = req.WithContext(ctx)\r\n    for _, r := range c.RequestEditors {\r\n        if err := r(ctx, req); err != nil {\r\n            return err\r\n        }\r\n    }\r\n    for _, r := range additionalEditors {\r\n        if err := r(ctx, req); err != nil {\r\n            return err\r\n        }\r\n    }\r\n    fmt.Printf(\"applyEditors: req.Host=%s\\n\", req.Host)\r\n    return nil\r\n}\r\n```\r\n\r\nThen, I wrote a little snippet that calls the generated code, and provides a `RequestEditorFn` that rewrites the request `Host` header:\r\n\r\n```go\r\n// main.go\r\npackage main\r\n\r\nimport (\r\n    \"context\"\r\n    \"net/http\"\r\n)\r\n\r\nfunc editRequest(ctx context.Context, req *http.Request) error {\r\n    req.Host = \"www.another-petstore.net\"\r\n\r\n    return nil\r\n}\r\n\r\nfunc main() {\r\n    ctx := context.Background()\r\n    client, err := NewClient(\"https://www.petstore.net/\")\r\n    if err != nil {\r\n        panic(err)\r\n    }\r\n\r\n    client.FindPets(ctx, \u0026FindPetsParams{}, editRequest)\r\n}\r\n```\r\n\r\nWhen running the code, we can clearly see that the modifications performed by the `reqEditors` are only local to the `Client.applyEditors()` method, and not to the HTTP request actually sent by the `Client`:\r\n\r\n```\r\n$ go run .\r\nFindPets before applyEditors: req.Host=www.petstore.net\r\napplyEditors: req.Host=www.another-petstore.net\r\nFindPets after applyEditors: req.Host=www.petstore.net\r\n```\r\n\r\nThis looks to be caused by the use of `req.WithContext(ctx)` in the `applyEditors()` method, which cause the modifications performed by the request editor functions to be only local to the method – where in the previous versions, the `req` variable would still be accessible to the `c.Client.Do()` method: https://github.com/deepmap/oapi-codegen/pull/228/files#diff-c8306209ecceed0e799909503c21e674164c27a31308bf57f75c68cd159cc33eR104-R112\r\n\r\nP.S.: It would have been nice to include the new `reqEditors` parameter to the `*WithResponse` methods as well.","author":{"url":"https://github.com/falzm","@type":"Person","name":"falzm"},"datePublished":"2021-02-18T13:34:02.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/298/oapi-codegen/issues/298"}