add support for Durations and CompactLocalTime (#271)

* add support for Duration and CompactLocalTime

* add support for Duration when translating from openAPI and json schema

* default to PROTOBUF format for protobuf OffsetDateTime

Author: a-morales

buildDeps.sc

@@ -3,7 +3,7 @@ import mill.define._
 import mill.scalalib._
 
 object alloy {
-  val alloyVersion = "0.3.28"
+  val alloyVersion = "0.3.31"
   val org = "com.disneystreaming.alloy"
   val core = ivy"$org:alloy-core:$alloyVersion"
   val protobuf = ivy"$org:alloy-protobuf:$alloyVersion"

modules/compiler-core/src/internals/IModelToSmithy.scala

@@ -434,6 +434,7 @@ private[compiler] final class IModelToSmithy(useEnumTraitSyntax: Boolean)
         case Year           => List(new alloy.YearFormatTrait())
         case YearMonth      => List(new alloy.YearMonthFormatTrait())
         case MonthDay       => List(new alloy.MonthDayFormatTrait())
+        case Duration       => List(new alloy.DurationSecondsFormatTrait())
       }
     case Hint.Tags(values) =>
       List(TagsTrait.builder.values(values.asJava).build())

modules/compiler-core/src/internals/PatternFolder.scala

@@ -108,6 +108,7 @@ private[compiler] final class PatternFolder[F[
       case PYear => std("Integer", Hint.Timestamp(TimestampFormat.Year))
       case PYearMonth => std("String", Hint.Timestamp(TimestampFormat.YearMonth))
       case PMonthDay => std("String", Hint.Timestamp(TimestampFormat.MonthDay))
+      case PDuration => std("BigDecimal", Hint.Timestamp(TimestampFormat.Duration))
     }
 
   def nestedIdFromPrimitive(primitive: Primitive): (DefId, List[Hint]) =
@@ -123,6 +124,7 @@ private[compiler] final class PatternFolder[F[
       case PYear => alloy("Year")
       case PYearMonth => alloy("YearMonth")
       case PMonthDay => alloy("MonthDay")
+      case PDuration => alloy("Duration")
       case _ => topLevelIdFromPrimitive(primitive)
     }
   // format: on

modules/compiler-core/src/internals/Primitive.scala

@@ -16,8 +16,9 @@
 package smithytranslate.compiler.internals
 
 import java.util.Date
-import java.time._
+import java.time.{Duration => _, _}
 import java.util.UUID
+import scala.concurrent.duration.Duration
 
 private[compiler] sealed trait Primitive {
   type T
@@ -50,6 +51,7 @@ private[compiler] object Primitive {
   case object PYear extends Primitive { type T = Year }
   case object PYearMonth extends Primitive { type T = YearMonth }
   case object PMonthDay extends Primitive { type T = MonthDay }
+  case object PDuration extends Primitive { type T = Duration }
   case object PBytes extends Primitive { type T = Array[Byte] }
   case object PFreeForm extends Primitive { type T = Any }
 }

modules/compiler-core/src/internals/TimestampFormat.scala

@@ -33,4 +33,5 @@ private[compiler] object TimestampFormat {
   case object Year extends TimestampFormat
   case object YearMonth extends TimestampFormat
   case object MonthDay extends TimestampFormat
+  case object Duration extends TimestampFormat
 }

modules/compiler-core/src/internals/postprocess/DropAlloyTimeExtensionsTransformer.scala

@@ -36,7 +36,8 @@ private[compiler] object DropAlloyTimeExtensionsTransformer
     "zoned-date-time",
     "year",
     "year-month",
-    "month-day"
+    "month-day",
+    "duration"
   )
 
   private def process(d: Definition) = {

modules/docs/openapi.md

@@ -69,6 +69,7 @@ Smithy.
 | string            | binary             | Blob                 |                               |
 | string            | byte               | Blob                 |                               |
 | string            | password           | String               | @sensitive                    |
+| number            | duration           | Duration             | alloy#durationSecondsFormat   |
 | number            | float              | Float                |                               |
 | number            | double             | Double               |                               |
 | number            | double             | Double               |                               |
@@ -132,6 +133,9 @@ components:
     MyMonthDay:
       type: string
       format: "month-day"
+    MyDuration:
+      type: number
+      format: "duration"
     MyObj:
       type: object
       properties:
@@ -172,6 +176,9 @@ components:
         monthDay:
           type: string
           format: month-day
+        duration:
+          type: number
+          format: duration
 ```
 
 Smithy:
@@ -198,6 +205,8 @@ use alloy#ZoneId
 use alloy#zoneIdFormat
 use alloy#ZoneOffset
 use alloy#zoneOffsetFormat
+use alloy#Duration
+use alloy#durationSecondsFormat
 
 structure MyObj {
     myTimestamp: MyTimestamp
@@ -213,6 +222,7 @@ structure MyObj {
     year: Year
     yearMonth: YearMonth
     monthDay: MonthDay
+    duration: Duration
 }
 
 @dateFormat
@@ -251,6 +261,9 @@ string MyZoneId
 
 @zoneOffsetFormat
 string MyZoneOffset
+
+@durationSecondsFormat
+bigDecimal MyDuration
 ```
 
 #### Aggregate Shapes

modules/json-schema/src/internals/Extractors.scala

@@ -162,24 +162,21 @@ private[json_schema] object Extractors {
         // I:
         //  type: integer
         //  format: year
+        // I:
+        //  type: number
+        //  format: duration
         //  The json schema parser treats any integer type with a format fields as a CombinedSchema of StringSchema and NumberSchema
         //  where the StringSchema has the format set
         case (combinedSchema: CombinedSchema) => {
           val subschemas = combinedSchema.getSubschemas().asScala.toSet
 
-          val isNumberSchema = subschemas.exists {
-            case (_: NumberSchema) => true
-            case _                 => false
-          }
-          val hasYearFormat = subschemas.exists {
-            case Format("year") => true
-            case _              => false
-          }
-
-          if (isNumberSchema && hasYearFormat) {
-            Some(List.empty -> PYear)
-          } else
-            None
+          for {
+            _ <- subschemas.collectFirst { case (x: NumberSchema) => Some(x) }
+            format <- subschemas.collectFirst {
+              case Format("year")     => PYear
+              case Format("duration") => PDuration
+            }
+          } yield List.empty -> format
         }
 
         // S:

modules/json-schema/src/internals/LoadSchema.scala

@@ -40,6 +40,7 @@ private[compiler] object LoadSchema extends (JSONObject => Schema) {
       .addFormatValidator(new EmptyValidator("year"))
       .addFormatValidator(new EmptyValidator("year-month"))
       .addFormatValidator(new EmptyValidator("month-day"))
+      .addFormatValidator(new EmptyValidator("duration"))
       .useDefaults(true)
       .schemaJson(sch)
       .build()

modules/json-schema/test/src/TimeTypeSpec.scala

@@ -89,6 +89,15 @@ final class TimeTypeSpec extends munit.FunSuite {
       "@alloy#monthDayFormat"
     )
   }
+  
+  test("duration newtype definition") {
+    runNewtypeTest(
+      "duration",
+      List("@alloy#durationSecondsFormat"),
+      "number",
+      "bigDecimal"
+    )
+  }
 
   test("nested definitions") {
     val jsonSchString =
@@ -141,6 +150,10 @@ final class TimeTypeSpec extends munit.FunSuite {
          |    "monthDay": {
          |      "type": "string",
          |      "format": "month-day"
+         |    },
+         |    "duration": {
+         |      "type": "number",
+         |      "format": "duration"
          |    }
          |  }
          |}
@@ -160,6 +173,7 @@ final class TimeTypeSpec extends munit.FunSuite {
                             | year: alloy#Year
                             | yearMonth: alloy#YearMonth
                             | monthDay: alloy#MonthDay
+                            | duration: alloy#Duration
                             |}
                             |""".stripMargin