[RFC] In Progress - Release 1.0 - Swift Codegen

[calvincestari]

This is the current working branch for the 1.0 release candidate.

The primary focus of the 1.0 release is a reimagining of the generated GraphQL operation models. This includes a major overhaul of the internal model and execution layer and a re-write of the code generation engine in Swift.

An RFC for the new format of the generated GraphQL operation models is provided as part of this PR.

Please make comments on this RFC as a review of this PR.

The full rich text of the RFC can be found at CodegenProposal.md

IN PROGRESS - DO NOT MERGE

• This PR serves to collect all changes that we intend to release as an alpha of 1.0.0.
• We should continue merging smaller changes into main and releasing them.
• Occasionally this branch should be brought up-to-date with main.
• Keep adding code to this branch via PRs.

[martinbonnin]

I'm experimenting with this at the moment and one drawback of using schema types for mock objects generated is that schema types don't know anything about aliases. If an operation uses aliases, creating a mock for it using schema types only is a bit awkward and certainly non type safe as the alias name would have to be passed at runtime.

[AnthonyMDev]

Great point! I plan on using the schema types to build the objects, and then when you want to convert them to a specific selection set, I could run them through the GraphQLExecutor really quickly to map any aliased fields to their correct fields.

If you want a mock of a specific SelectionSet, you'll have to make your mock from the schema type and then run a function to convert it to the SelectionSet. Still haven't defined the API for that exactly, but I have a decent idea of how to do that.

[martinbonnin]

you'll have to make your mock from the schema type and then run a function to convert it to the SelectionSet

I think that part could be the problematic one. If you have 2 field with different values, one of them being aliased, there's no real way to mock this using schema types:

query {
  cat: animal(species: CAT)
  dog: animal(species: DOG)
}

I'm still experimenting with this so maybe there's a convenient and idiomatic way to set aliases for schema types but it feels a bit out of place at first sight.

[AnthonyMDev]

Yeah, this is definitely a rough edge. I think there is a solution to this. We are already ignoring aliases when storing fields in the cache on iOS. The field is stored using a cache key from the actual field name. If the field has arguments, those arguments become part of the cache key. So this seems doable.

[designatednerd]

Would definitely help to have a quick summary at the top of all this of what is changing from existing codegen with links to the bits that are changing.

[calvincestari]

This PR was closed when we deleted the release/1.0-alpha-incubating branch. All Alpha tagged releases can be found on release/1.0.