[Client] Allow query to specify every subtype of an interface

[AlixBa]

Rationale: We would like compilation to fail if there a new enum entry and we don't implement a selection builder

[ghostdogpr]

So, I've recently implemented this PR for unions. Basically it generates 2 methods instead of 1, one with all union subtypes optional and the other where they are mandatory. How about doing the same for interfaces? It would be consistent and would prevent an additional configuration parameter. Also you would be free to use a mix of them in your code, which is more flexible than a single configuration. What do you think?

[AlixBa]

I'll give it a shot :)
I'd rather push something unified at a caliban writer level than another CLI option!

EDIT: I see that before, on union subtypes, it was mandatory and you added a xxxOption method with default. For interfaces it will be the other way around. And as I guess we don't want to break compatibility how should I name this new method that will enforce all parameters to be set?

[ghostdogpr]

Hmm I'd rather break and be consistent. We can mention it clearly in the release notes and it won't be hard to fix. It won't break code immediately for users unless they generate the code during compilation. Sounds reasonable?

[ghostdogpr]

If we break it, I'll give #237 a thought and see if I find a good solution. It might also break so better to do all at once if possible.

[AlixBa]

I'll have something by the end of the day 🤞 (in France)

[ghostdogpr]

@AlixBa yeah, that's right.

And it would be nice to add onInterfaceName: Option[SelectionBuilder[InterfaceName, A]], to select common fields from the interface (and generate that code, it doesn't exist currently). I guess it makes sense only in methodOption, not on the other one?

[AlixBa]

I've updated with the first goal of this MR.
I'll try to impl #237 :)

[ghostdogpr]

The test error comes from this code generated in writeView:

case (field @ FieldTypeInfo(_, _, _, interfaceTypes, _, _, Some(_)), fieldName) if interfaceTypes.nonEmpty =>
          val tpe = genericSelectionFieldTypesMap(field)
          interfaceTypes.map(intType => s"${fieldName}On$intType: Option[SelectionBuilder[$intType, $tpe]] = None")

I guess it doesn't need to be an Option anymore (like for unions just a few lines above)?

You can run scripted in sbt to test it.

[ghostdogpr]

Btw is this PR ready to review? I wasn't sure 😅

[AlixBa]

Ups, sorry @ghostdogpr
It is, indeed

[ghostdogpr]

LGTM, thanks!