genqlient/docs/CHANGELOG.md

Changelog

next

Breaking changes:

• genqlient now requires Go 1.18 or higher.

New features:

• You can now bind all types from a package in genqlient.yaml using the new package_bindings option.
• The graphql operation (query or mutation) as sent over the wire is now exposed via a constant in the generated genqlient .go file.

Bug fixes:

• Fixed non-deterministic generated code when querying graphql interfaces.
• Fixed generated code when last component of package name is not a valid identifier (e.g. "path/to/my-package").
• Fixed incorrect documentation of for directive.

v0.5.0

Version 0.5.0 adds several new configuration options and convenience features. Note that genqlient now requires Go 1.16 or higher, and is tested through Go 1.18.

Breaking changes:

• genqlient now requires Go 1.16 or higher.
• The graphql.Client interface now accepts two structs for the request and response, to allow future expansion, rather than several individual arguments. Clients implementing the interface themselves will need to change the signature; clients who simply call graphql.NewClient are unaffected.

New features:

• genqlient can now run as a portable binary (i.e. without a local checkout of the repository or go run).
• You can now enable use_extensions in the configuration file, to receive extensions returned by the GraphQL API server. Generated functions will return extensions as map[string]interface{}, if enabled.
• You can now use graphql.NewClientUsingGet to create a client that uses query parameters to pass the query to the GraphQL API server.
• In config files, schema, operations, and generated can now be absolute paths.
• You can now configure how nullable types are mapped to Go types in the configuration file. Specifically, you can set optional: pointer to have all nullable GraphQL arguments, input fields, and output fields map to pointers.

Bug fixes:

• genqlient now explicitly rejects argument, operation, and type names which are Go keywords, rather than failing with an opaque error.
• genqlient now gives better error messages if it thinks your schema is invalid.

v0.4.0

Version 0.4.0 adds several new configuration options, as well as additional methods to simplify the use of interfaces.

Breaking changes:

• The Config fields Schema and Operations are now both of type StringList. This does not affect configuration via genqlient.yaml, only via the Go API.
• The typename and bind options may no longer be combined; doing so will now result in an error. In practice, any such use was likely in error (and the rules for which would win were confusing and undocumented).

New features:

• genqlient now generates getter methods for all fields, even those which do not implement a genqlient-generated interface; this can be useful for callers who wish to define their own interface and have several unrelated genqlient types which have the same fields implement it.
• The new struct_references option automatically sets the pointer and omitempty options on fields of struct type; see the genqlient.yaml documentation for details.
• genqlient config now accepts either a single or multiple files (or globs) for the schema and operations fields (previously it accepted only one schema, and required a list of operations files).
• genqlient now looks for its config file as [.]genqlient.y[a]ml in any ancestor directory, if unspecified, rather than only as genqlient.yaml in the current directory.
• The typename option can now be used on basic types (string, int, etc) as well as structs; this can be useful to have genqlient define new types like type Language string and use that type for specified fields.

Bug fixes:

• In certain very rare cases involving duplicate fields in fragment spreads, genqlient would generate code that failed to compile due to duplicate methods not getting promoted; genqlient now generates correct types. (See #126 for a more complete description.)
• genqlient no longer rejects schemas which include the implicitly declared types (scalar String, etc.) explicitly; this makes it easier to use schemas generate via introspection.

v0.3.0

Version 0.3.0 adds several new configuration options, allowing simplification of generated types and configuration of input types, as well as marshalers for all genqlient-generated types.

Breaking changes:

• Previously, # @genqlient directives applied to entire operations applied inconsistently to fields of input types used by those operations. Specifically, pointer: true, when applied to the operation, would affect all input-field arguments, but omitempty: true would not. Now, all options apply to fields of input types; this is a behavior change in the case of omitempty.

New features:

• genqlient's types are now safe to JSON-marshal, which can be useful for putting them in a cache, for example. See the docs for details.
• The new flatten option in the # @genqlient directive allows for a simpler form of type-sharing using fragment spreads. See the docs for details.
• The new for option in the # @genqlient directive allows applying options to a particular field anywhere it appears in the query. This is especially useful for fields of input types, for which there is otherwise no way to specify options; see the documentation on handling nullable fields for an example, and the # @genqlient directive reference for the full details.

Bug fixes:

v0.2.0

Version 0.2.0 adds several convenience features for using custom scalars, as well as many internal improvements and bug fixes.

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.
• Multiple genqlient directives may now be applied to the same node, as long as they don't conflict; see the directive 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)
• Previously, interface fields with # @genqlient(pointer: true) would be unmarshaled to (*MyInterface)(*<nil>), i.e. a pointer to the untyped-nil of the interface type. Now they are unmarshaled as (*MyInterface)(<nil>), i.e. a nil pointer of the pointer-to-interface type, as you would expect.

v0.1.0

First open-sourced version.