Retain original field ordering in schemas #1427
Conversation
| val args = fields.map(f => Line(f.name)).intercalate(Line.comma) | ||
| lines( | ||
| line"// constructor using the original order from the spec", | ||
| line"private def make($params): ${product.nameRef} = ${product.nameRef}($args)" |
There was a problem hiding this comment.
question: I think it'd be valuable to have this in the public API, e.g. if someone really really wants to avoid getting bit by a default parameter (I've seen it happen). WDYT?
There was a problem hiding this comment.
If people care about it, we have rendering options to prevent default parameters from being generated : https://disneystreaming.github.io/smithy4s/docs/codegen/customisation/default-rendering
I think the "correct" course of action would be to generate the case-class without default parameters, retaining the original order, and to create a custom apply method that would have the default parameters. The problem is that it'd also impact extractors, so I don't want to pull that trigger just yet. We could potentially roll it in 0.19, as people should be more careful about reading release notes.
I do not however want to expose this make method. I've toyed with the idea of actually turning it into a IndexedSeq[Any] => A, as it's general and could be captured in a potential GeneratedStructureCompanion interface, which could potentially help the Spark usecase. I don't want to make the generated make public because we may change it later on.
| hints: List[Hint] = Nil | ||
| ): Field = | ||
| Field(name, name, tpe, modifier, hints) | ||
| Field(name, name, tpe, modifier, originalIndex, hints) |
| @@ -727,7 +737,7 @@ private[internals] class Renderer(compilationUnit: CompilationUnit) { self => | |||
| if (recursive) line"$recursive_($struct_" else line"$struct_" | |||
| line"${schemaImplicit}val schema: $Schema_[${product.nameRef}] = $definition" | |||
| .args(renderedFields) | |||
| .block(line"${product.nameRef}.apply") | |||
| .block(line"make") | |||
There was a problem hiding this comment.
nitpick: I'd try to avoid the block here and pass this in the same line
This changes the rendering logic to retain the original ordering of fields in Structure schemas, thus reflecting the spec more accurately.
The original ordering of fields is important in some protocols, when positional information has semantic importance.
NB for reviewers : the commits can be reviewed individually (in particular the first one)
PR Checklist (not all items are relevant to all PRs)