Add @vector and @indexedSeq #303

daddykotex · 2022-07-11T19:59:51Z

Adds a mechanism for users to customise the collection type used when generating Scala code from smithy list shapes.

Users can now opt-in Vector or IndexedSeq. List remains the default collection type.

Both annotations can only be added to list since `set` is already specialized. They can't be mixed with each other or `uniqueItems` `@uniqueItems` is deprecated but I decided to support it nonetheless because 2.0 is not out yet

daddykotex · 2022-07-11T20:04:51Z

note: CI does not run because I don't target main I guess?

lewisjkl · 2022-07-11T20:27:52Z

modules/codegen/src/smithy4s/codegen/SmithyToIR.scala

@@ -607,7 +630,7 @@ private[codegen] class SmithyToIR(model: Model, namespace: String) {
          enumDef.getName().asScala
        )
      // List
-      case (N.ArrayNode(list), Type.List(mem)) =>
+      case (N.ArrayNode(list), Type.List(mem, _)) => // todo sure ?


This is just ignoring the hints because you don't need them here? That seems fine to me

lewisjkl · 2022-07-11T20:28:48Z

modules/docs/src/04-codegen/01-customisation.md

+
+#### Specialized collection types
+
+Smithy supports `list` and `set`, Smithy4s renders that to `List[A]` and `Set[A]` respectively. You can also use the `@uniqueItems` annotation on `list` which is equivalent to `set`.


Maybe add a note that uniqueItems is going away or remove that comment entirely?

it is actually not going away. The set keyword is going away in favour of uniqueItems (aws has pivoted on this)

Ahh, I read that from the source and I thought it was the latest state

lewisjkl · 2022-07-11T20:29:09Z

modules/docs/src/04-codegen/01-customisation.md

+
+Smithy supports `list` and `set`, Smithy4s renders that to `List[A]` and `Set[A]` respectively. You can also use the `@uniqueItems` annotation on `list` which is equivalent to `set`.
+
+Smithy4s has support for two specialized collection type: `Vector` and `IndexedSeq`. The following examples shows how to use them:


Suggested change

Smithy4s has support for two specialized collection type: `Vector` and `IndexedSeq`. The following examples shows how to use them:

Smithy4s has support for two specialized collection types: `Vector` and `IndexedSeq`. The following examples show how to use them:

Addressed in b3365de

lewisjkl · 2022-07-11T20:30:09Z

modules/docs/src/04-codegen/01-customisation.md

+}
+```
+
+Both annotation are only available on `list`. You can't mix `@vector` with `@indexedSeq`, nor `@uniqueItems`.


Suggested change

Both annotation are only available on `list`. You can't mix `@vector` with `@indexedSeq`, nor `@uniqueItems`.

Both annotations are only available on `list`. You can't mix `@vector` with `@indexedSeq`, and neither one can be used with `@uniqueItems`.

Addressed in b3365de

lewisjkl · 2022-07-11T20:31:33Z

sampleSpecs/misc.smithy

+use smithy4s.meta#vector
+use smithy4s.meta#indexedSeq


Are these used in this file?

Addressed in b3365de

Baccata · 2022-07-11T21:41:33Z

modules/codegen/src/smithy4s/codegen/Renderer.scala

@@ -650,8 +650,15 @@ private[codegen] class Renderer(compilationUnit: CompilationUnit) { self =>
  implicit class TypeExt(tpe: Type) {
    def schemaRef: Line = tpe match {
      case Type.PrimitiveType(p) => Line(schemaRefP(p))
-      case Type.List(member)     => line"list(${member.schemaRef})"
-      case Type.Set(member)      => line"set(${member.schemaRef})"
+      case Type.List(member, hints) =>


this is the wrong level to put this. Either you should have Type.Collection(tag, member), where tag is an enumeration, or you should have Type.List, Type.Vector, Type.IndexedSeq

Addressed in b3365de

Baccata · 2022-07-11T21:43:27Z

modules/protocol/resources/META-INF/smithy/smithy4s.meta.smithy

@@ -24,3 +24,16 @@ structure packedInputs {}
 @trait(selector: "structure :not([trait|error])")
 @idRef(failWhenMissing: true, selector: "union")
 string adtMember
+
+@trait(selector: """


Let's add some documentation for these annotations, in the form of a triple-slash comment (like for @adtMember)

Addressed in b3365de

daddykotex · 2022-07-12T12:53:59Z

modules/codegen/src/smithy4s/codegen/IR.scala

@@ -195,6 +191,14 @@ object Type {
  case class PrimitiveType(prim: Primitive) extends Type
 }

+sealed abstract class CollectionType(val tpe: String)


to sum it up: I went the easy route lol

sorry for that, I could have come up with this solution on the first try

daddykotex added 3 commits July 11, 2022 15:56

Add @vector and @indexedSeq

1f4fd4a

Both annotations can only be added to list since `set` is already specialized. They can't be mixed with each other or `uniqueItems` `@uniqueItems` is deprecated but I decided to support it nonetheless because 2.0 is not out yet

Update documentation

e5612ef

Use _hints (already available)

e918a34

lewisjkl reviewed Jul 11, 2022

View reviewed changes

Baccata reviewed Jul 11, 2022

View reviewed changes

Base automatically changed from dfrancoeur/kill-schematic to main July 11, 2022 22:02

Addressing comments

b3365de

Baccata approved these changes Jul 12, 2022

View reviewed changes

Baccata merged commit 2d07dba into main Jul 12, 2022

Baccata deleted the dfrancoeur/collections-pt2 branch July 12, 2022 12:05

daddykotex commented Jul 12, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add @vector and @indexedSeq #303

Add @vector and @indexedSeq #303

daddykotex commented Jul 11, 2022 •

edited by Baccata

Loading

daddykotex commented Jul 11, 2022

lewisjkl Jul 11, 2022

lewisjkl Jul 11, 2022

Baccata Jul 11, 2022

daddykotex Jul 12, 2022

lewisjkl Jul 11, 2022

Baccata Jul 12, 2022

lewisjkl Jul 11, 2022

Baccata Jul 12, 2022

lewisjkl Jul 11, 2022

Baccata Jul 12, 2022

Baccata Jul 11, 2022

Baccata Jul 12, 2022

Baccata Jul 11, 2022

Baccata Jul 12, 2022

daddykotex Jul 12, 2022


		#### Specialized collection types

		Smithy supports `list` and `set`, Smithy4s renders that to `List[A]` and `Set[A]` respectively. You can also use the `@uniqueItems` annotation on `list` which is equivalent to `set`.


		Smithy supports `list` and `set`, Smithy4s renders that to `List[A]` and `Set[A]` respectively. You can also use the `@uniqueItems` annotation on `list` which is equivalent to `set`.

		Smithy4s has support for two specialized collection type: `Vector` and `IndexedSeq`. The following examples shows how to use them:

	Both annotation are only available on `list`. You can't mix `@vector` with `@indexedSeq`, nor `@uniqueItems`.
	Both annotations are only available on `list`. You can't mix `@vector` with `@indexedSeq`, and neither one can be used with `@uniqueItems`.

Add @vector and @indexedSeq #303

Add @vector and @indexedSeq #303

Conversation

daddykotex commented Jul 11, 2022 • edited by Baccata Loading

daddykotex commented Jul 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daddykotex commented Jul 11, 2022 •

edited by Baccata

Loading