Files
genqlient/docs/CHANGELOG.md
T
Ben KraftandGitHub 8de55d352e Add support for binding with a custom marshal/unmarshal function (#104)
## Summary:
This is useful if you want to bind to a type you don't control (or use
for other things) but need different serialization than its default.
This is a feature gqlgen has and we've found it very useful.  For
example, in webapp we want to bind `DateTime` to `time.Time`, but its
default serialization is not compatible with Python, so currently we
have to bind to a wrapper type and cast all over the place, which is
exactly the sort of boilerplate genqlient is supposed to avoid.

For unmarshaling, the implementation basically just follows the existing
support for abstract types; instead of calling our own generated
helper, we now call your specified function.  This required some
refactoring to abstract the handling of custom unmarshalers generally
from abstract types specifically, and to wire in not only the
unmarshaler-name but also the `generator` (in order to compute the right
import alias).

For marshaling, I had to implement all that stuff over again; it's
mostly parallel to unmarshaling (and I made a few minor changes to
unmarshaling to make the two more parallel).  Luckily, after #103 I at
least only had to do it once, rather than implementing the same
functionality for arguments and for input-type fields.  It was still
quite a bit of code; I didn't try to be quite as completionist about the
tests as with unmarshal but still had to add a few.

Issue: https://github.com/Khan/genqlient/issues/38

## Test plan:
make check


Author: benjaminjkraft

Reviewers: StevenACoffman, dnerdy, benjaminjkraft, aberkan, jvoll, mahtabsabet, MiguelCastillo

Required Reviewers: 

Approved By: StevenACoffman, dnerdy

Checks:  Test (1.17),  Test (1.16),  Test (1.15),  Test (1.14),  Lint,  Test (1.17),  Test (1.16),  Test (1.15),  Test (1.14),  Lint

Pull Request URL: https://github.com/Khan/genqlient/pull/104
2021-09-24 11:16:01 -07:00

1.8 KiB

Changelog

next

Breaking changes:

  • The graphql.Client interface now accepts variables interface{} (containing a JSON-marshalable value) rather than variables map[string]interface{}. Clients implementing the interface themselves will need to change the signature; clients who simply call graphql.NewClient are unaffected.
  • genqlient's handling of the omitempty option has changed to match that of encoding/json, from which it had inadvertently differed. In particular, this means struct-typed arguments with # @genqlient(omitempty: true) will no longer be omitted if they are the zero value. (Struct-pointers are still omitted if nil, so adding pointer: true will typically work fine. It's also now possible to use a custom marshaler to explicitly map zero to null.)

New features:

  • The new bindings.marshaler and bindings.unmarshaler options in genqlient.yaml allow binding to a type without using its standard JSON serialization; see the documentation for details.

Bug fixes:

  • The omitempty option now works correctly for struct- and map-typed variables, matching encoding/json, which is to say it never omits structs, and omits empty maps. (#43)
  • Generated type-names now abbreviate across multiple components; for example if the path to a type is (MyOperation, Outer, Outer, Inner, OuterInner), it will again be called MyOperationOuterInner. (This regressed in a pre-v0.1.0 refactor.) (#109)

v0.1.0

First open-sourced version.