Repository navigation
Generate a struct for each operation's variables - #146
Closed
saga-dasgupta wants to merge 2 commits into
Closed
saga-dasgupta wants to merge 2 commits into
saga-dasgupta wants to merge 2 commits into
Conversation
saga-dasgupta
added a commit
to Shopify/shopify-function-rust
that referenced
this pull request
Oct 5, 2026
A prepare target returns the variables for its run target's input query as untyped `JSON`. Nothing checked that they matched what the run query declares, so a renamed, added, or retyped variable deployed fine and failed at checkout, with the run query resolving nothing. bluejay now generates a struct for the variables of each operation that declares them: `<Operation>Variables`, or `RootVariables` for an anonymous operation, with a field per variable. A non-null variable with no default is a plain field; any other is an `Option` whose `None` omits it. `typegen` implements wasm_api's `Serialize` and `Deserialize` for it with the same code as input objects, so it serializes directly. The schema does not link a prepare target to its run target, so they are paired by name: the mutation root's `<target>Prepare` feeds `<target>Run`, and when a `#[query]` module named `<target>_run` holds a single operation that declares variables, the prepare result's `variables` field is typed as that operation's variables struct instead of `JsonValue`. A prepare target that no longer matches its run query then fails to compile: - a renamed or removed variable is an unknown field (E0560) - an added variable is a missing field (E0063) - a retyped variable, or a hand-written `JsonValue`, is a mismatch (E0308) This breaks prepare targets that follow the naming convention and build their `variables` by hand. Prepare targets are in beta. Prepare results that don't pair keep `JsonValue`. Depends on Shopify/bluejay#146, patched in from its branch until it ships in a release.
saga-dasgupta
force-pushed
the
operation-variables
branch
from
October 5, 2026 19:15
9c30cf4 to
9998dcc
Compare
saga-dasgupta
added a commit
to Shopify/shopify-function-rust
that referenced
this pull request
Oct 5, 2026
A prepare target returns the variables for its run target's input query as untyped `JSON`. Nothing checked that they matched what the run query declares, so a renamed, added, or retyped variable deployed fine and failed at checkout, with the run query resolving nothing. bluejay now generates a struct for the variables of each operation that declares them: `<Operation>Variables`, or `RootVariables` for an anonymous operation, with a field per variable. A non-null variable with no default is a plain field; any other is an `Option` whose `None` omits it. `typegen` implements wasm_api's `Serialize` and `Deserialize` for it with the same code as input objects, so it serializes directly. The schema does not link a prepare target to its run target, so they are paired by name: the mutation root's `<target>Prepare` feeds `<target>Run`, and when a `#[query]` module named `<target>_run` holds a single operation that declares variables, the prepare result's `variables` field is typed as that operation's variables struct instead of `JsonValue`. A prepare target that no longer matches its run query then fails to compile: - a renamed or removed variable is an unknown field (E0560) - an added variable is a missing field (E0063) - a retyped variable, or a hand-written `JsonValue`, is a mismatch (E0308) This breaks prepare targets that follow the naming convention and build their `variables` by hand. Prepare targets are in beta. Prepare results that don't pair keep `JsonValue`. Depends on Shopify/bluejay#146, patched in from its branch until it ships in a release.
saga-dasgupta
force-pushed
the
operation-variables
branch
from
October 5, 2026 20:44
9998dcc to
c9522b5
Compare
saga-dasgupta
added a commit
to Shopify/shopify-function-rust
that referenced
this pull request
Oct 5, 2026
A prepare target returns the variables for its run target's input query as
untyped `JSON`. Nothing checked that they matched what the run query declares,
so a renamed, added, or retyped variable deployed fine and failed at checkout,
with the run query resolving nothing.
bluejay now generates a struct for the variables of each operation that
declares them: `<Operation>Variables`, or `RootVariables` for an anonymous
operation, with a field per variable. A non-null variable with no default is a
plain field; any other is an `Option` whose `None` omits it. `typegen`
implements wasm_api's `Serialize` and `Deserialize` for it with the same code
as input objects, so it serializes directly.
bluejay's `typegen` also takes `custom_scalar_overrides`, so a prepare result's
`variables` field can be typed as the run query's variables struct instead of
`JsonValue`:
#[typegen("schema.graphql", custom_scalar_overrides = {
"CartValidationsGeneratePrepareResult.variables" => cart_validations_generate_run::InputVariables,
})]
A prepare target that no longer matches its run query then fails to compile:
- a renamed or removed variable is an unknown field (E0560)
- an added variable is a missing field (E0063)
- a retyped variable, or a hand-written `JsonValue`, is a mismatch (E0308)
Depends on Shopify/bluejay#146, patched in from its branch until it ships in a
release.
`typegen` now takes `custom_scalar_overrides`, like `query` does, to override the type of a custom scalar field of an input object. Paths are `"InputObject.field"`, and lists and nullability are kept. This lets a field typed with a catch-all scalar such as `JSON` use a specific Rust type instead of an untyped value. Parsing and validation are shared with the `query` option, whose behaviour doesn't change.
An operation that declares variables now also gets a struct next to its own in the query module, named `<Operation>Variables`, or `RootVariables` for an anonymous operation, with a field per variable. A variable that is non-null with no default is a plain field. Any other variable is an `Option`. `CodeGenerator` gains `attributes_for_variables_struct`, `additional_impls_for_variables_struct` and `attributes_for_variables_struct_field`, so generators can derive or implement serialization for it. `bluejay-typegen-macro` derives serde's `Serialize`, and skips an optional variable that is `None` so that its default applies. It is an error for a variables struct name to clash with a fragment or operation struct in the same module.
saga-dasgupta
force-pushed
the
operation-variables
branch
from
October 5, 2026 21:33
c9522b5 to
2137e8d
Compare
saga-dasgupta
added a commit
to Shopify/shopify-function-rust
that referenced
this pull request
Oct 5, 2026
A prepare target returns the variables for its run target's input query as
untyped `JSON`. Nothing checked that they matched what the run query declares,
so a renamed, added, or retyped variable deployed fine and failed at checkout,
with the run query resolving nothing.
bluejay now generates a struct for the variables of each operation that
declares them: `<Operation>Variables`, or `RootVariables` for an anonymous
operation, with a field per variable. A non-null variable with no default is a
plain field; any other is an `Option` whose `None` omits it. `typegen`
implements wasm_api's `Serialize` and `Deserialize` for it with the same code
as input objects, so it serializes directly.
bluejay's `typegen` also takes `custom_scalar_overrides`, so a prepare result's
`variables` field can be typed as the run query's variables struct instead of
`JsonValue`:
#[typegen("schema.graphql", custom_scalar_overrides = {
"CartValidationsGeneratePrepareResult.variables" => cart_validations_generate_run::InputVariables,
})]
A prepare target that no longer matches its run query then fails to compile:
- a renamed or removed variable is an unknown field (E0560)
- an added variable is a missing field (E0063)
- a retyped variable, or a hand-written `JsonValue`, is a mismatch (E0308)
Depends on Shopify/bluejay#146 and Shopify/bluejay#147, patched in from #146's
branch, which has both, until they ship in a release.
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Typegen generates types for what an operation returns, but not for the variables it declares. A caller building those variables by hand gets no help from the compiler: renaming, adding, removing or retyping a variable in the query still compiles, and only fails once the query runs.
This generates a struct for an operation's variables, next to the operation's own struct in the query module:
<Operation>Variables, orRootVariablesfor an anonymous operation, whose struct isRoot. Operations that declare no variables get no struct.Option, so a variable with a default can be left out.input_object_type_definition.rsinto a newinput_type.rsthat both use. That includes borrowing: withborrow = true, the struct gets an'alifetime when a field borrows.CodeGeneratorhooks:attributes_for_variables_struct,additional_impls_for_variables_structandattributes_for_variables_struct_field, modelled on the input object hooks. All three default to no-ops, so existing implementations don't change.bluejay-typegen-macro:Clone,PartialEq,Debugand serde'sSerialize;None, so the query's default applies instead of an explicitnull.query My($x: Int)next tofragment MyVariables on .... Without this check, rustc would report a duplicate definition.Compatibility
These are cases that compile on
mainand don't here:<Operation>Variablesname. This now gets the clash error above.$self,$Self,$super,$crateor$_now panics innames::to_ident. These names can't be raw identifiers, soformat_ident!("r#self")panics. Fields and input fields with those names already panic the same way onmain; variables just didn't become identifiers before. I left this alone to keep the PR focused, but I can add a typegen error for it here if you'd prefer.$fooBarand$foo_bar, now fail with rustc's duplicate field error (E0124). Input objects with such fields already fail the same way.bluejay-typegen, a custom scalar that is a variable's type, but no input object field's, now needsClone,PartialEq,Debugand serde'sSerialize, which the variables struct derives. Input object fields already need these.