Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

timestamp format for proto #235

Merged
merged 6 commits into from
Mar 14, 2024
Merged

timestamp format for proto #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
04631d8
timestamp format for proto
lewisjkl Mar 13, 2024
9a9a054
fix imports
lewisjkl Mar 13, 2024
8d732d6
pass timestamp format down from member shapes
lewisjkl Mar 13, 2024
e88e87b
add timestamp format extract to structure method
lewisjkl Mar 13, 2024
376ada3
expected error count in test
lewisjkl Mar 13, 2024
a38f63d
Clean-up
Baccata Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion buildDeps.sc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import mill.define._
import mill.scalalib._

object alloy {
val alloyVersion = "0.3.0"
val alloyVersion = "0.3.3"
val core =
ivy"com.disneystreaming.alloy:alloy-core:$alloyVersion"
val protobuf =
Expand Down
30 changes: 16 additions & 14 deletions buildSetup.sc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,22 @@ trait BaseModule extends Module with HeaderModule {
}

def includeFileExtensions: List[String] = List("scala", "java")
def license: HeaderLicense = HeaderLicense.Custom("""|Copyright 2022 Disney Streaming
|
|Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License");
|you may not use this file except in compliance with the License.
|You may obtain a copy of the License at
|
| https://disneystreaming.github.io/TOST-1.0.txt
|
|Unless required by applicable law or agreed to in writing, software
|distributed under the License is distributed on an "AS IS" BASIS,
|WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|See the License for the specific language governing permissions and
|limitations under the License.
|""".stripMargin)
def license: HeaderLicense = HeaderLicense.Custom(
"""|Copyright 2022 Disney Streaming
|
|Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License");
|you may not use this file except in compliance with the License.
|You may obtain a copy of the License at
|
| https://disneystreaming.github.io/TOST-1.0.txt
|
|Unless required by applicable law or agreed to in writing, software
|distributed under the License is distributed on an "AS IS" BASIS,
|WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|See the License for the specific language governing permissions and
|limitations under the License.
|""".stripMargin
)
}

trait BasePublishModule extends BaseModule with CiReleaseModule {
Expand Down
2 changes: 1 addition & 1 deletion modules/cli/src/runners/Proto.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ private object Deps {
val validDeps = DependencyParser
.dependencies(
dependencies,
defaultScalaVersion = "2.13.10"
defaultScalaVersion = "2.13.12"
)
Comment on lines 106 to 108
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think this matters at all, but I guess might as well

.either
.getOrElse(sys.error("Invalid dependency."))
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi/tests/src/DebugSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ final class DebugSpec extends munit.FunSuite {
}

test("load with debug leaves validation events untouched") {
testFilteredErrors(debug = true, expectedCount = 5)
testFilteredErrors(debug = true, expectedCount = 4)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this is due to smithy model library being updated (transitively in alloy) to no longer output a debug event in some circumstance

}
test("load without debug filters validation events") {
testFilteredErrors(debug = false, expectedCount = 2)
Expand Down
45 changes: 40 additions & 5 deletions modules/proto/src/smithytranslate/proto3/internals/Compiler.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import software.amazon.smithy.model.neighbor.NeighborProvider
import software.amazon.smithy.model.neighbor.Walker
import alloy.OpenEnumTrait
import software.amazon.smithy.model.traits.EnumValueTrait
import alloy.proto.ProtoTimestampFormatTrait

private[proto3] class Compiler(model: Model, allShapes: Boolean) {

Expand Down Expand Up @@ -400,9 +401,16 @@ private[proto3] class Compiler(model: Model, allShapes: Boolean) {
Type.RefType(targetShape)
} else {
val numType = extractNumType(m)
val maybeTimestampFormat = extractTimestampFormat(m)
val wrapped = hasProtoWrapped(m)
targetShape
.accept(typeVisitor(wrapped, numType))
.accept(
typeVisitor(
isWrapped = wrapped,
numType = numType,
timestampFormat = maybeTimestampFormat
)
)
.get
}
val field = MessageElement.FieldElement(
Expand Down Expand Up @@ -507,6 +515,15 @@ private[proto3] class Compiler(model: Model, allShapes: Boolean) {
.map { _.getNumType() }
}

private def extractTimestampFormat(
shape: Shape
): Option[ProtoTimestampFormatTrait.TimestampFormat] = {
shape
.getTrait(classOf[ProtoTimestampFormatTrait])
.toScala
.map(_.getTimestampFormat())
}

private def isUnit(shape: StructureShape): Boolean = {
shape
.getTrait(classOf[UnitTypeTrait])
Expand All @@ -519,7 +536,8 @@ private[proto3] class Compiler(model: Model, allShapes: Boolean) {
// TODO: namespace in type?
private def typeVisitor(
isWrapped: Boolean = false,
numType: Option[ProtoNumTypeTrait.NumType] = None
numType: Option[ProtoNumTypeTrait.NumType] = None,
timestampFormat: Option[ProtoTimestampFormatTrait.TimestampFormat] = None
): ShapeVisitor[Option[Type]] =
new ShapeVisitor[Option[Type]] {
def bigDecimalShape(shape: BigDecimalShape): Option[Type] = Some {
Expand Down Expand Up @@ -591,8 +609,15 @@ private[proto3] class Compiler(model: Model, allShapes: Boolean) {
.or(() => target.getTrait(classOf[ProtoNumTypeTrait]))
.toScala
.map(_.getNumType())
val timestampFormatValue = extractTimestampFormat(shape)

target.accept(typeVisitor(isWrapped, numType))
target.accept(
typeVisitor(
isWrapped = isWrapped,
numType = numType,
timestampFormat = timestampFormatValue
)
)
}

def operationShape(shape: OperationShape): Option[Type] = None
Expand Down Expand Up @@ -630,8 +655,18 @@ private[proto3] class Compiler(model: Model, allShapes: Boolean) {
}

def timestampShape(shape: TimestampShape): Option[Type] = Some {
if (!isWrapped) Type.GoogleTimestamp
else Type.AlloyWrappers.Timestamp
val format =
extractTimestampFormat(shape)
.orElse(timestampFormat)
.getOrElse(ProtoTimestampFormatTrait.TimestampFormat.PROTOBUF)
val isEpochMillis =
(format == ProtoTimestampFormatTrait.TimestampFormat.EPOCH_MILLIS)
if (!isWrapped) {
if (isEpochMillis) Type.Int64 else Type.GoogleTimestamp
} else {
if (isEpochMillis) Type.GoogleWrappers.Int64
else Type.AlloyWrappers.Timestamp
}
}

def unionShape(shape: UnionShape): Option[Type] = Some(
Expand Down
10 changes: 10 additions & 0 deletions modules/proto/tests/src/smithytranslate/proto3/internals/CompilerRendererSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ class CompilerRendererSuite extends FunSuite {

test("Primitive fields") {
val source = """|namespace com.example
|
|use alloy.proto#protoTimestampFormat
|
|structure Struct {
| boolean: Boolean
Expand All @@ -192,6 +194,8 @@ class CompilerRendererSuite extends FunSuite {
| document: Document
| string: String
| timestamp: Timestamp
| @protoTimestampFormat("EPOCH_MILLIS")
| epoch: Timestamp
|}
|""".stripMargin

Expand All @@ -217,6 +221,7 @@ class CompilerRendererSuite extends FunSuite {
| google.protobuf.Value document = 11;
| string string = 12;
| google.protobuf.Timestamp timestamp = 13;
| int64 epoch = 14;
|}
|""".stripMargin
convertCheck(source, Map("com/example/example.proto" -> expected))
Expand All @@ -226,6 +231,7 @@ class CompilerRendererSuite extends FunSuite {
val source = """|namespace com.example
|
|use alloy.proto#protoWrapped
|use alloy.proto#protoTimestampFormat
|
|structure Struct {
| @protoWrapped
Expand Down Expand Up @@ -254,6 +260,9 @@ class CompilerRendererSuite extends FunSuite {
| string: String
| @protoWrapped
| timestamp: Timestamp
| @protoWrapped
| @protoTimestampFormat("EPOCH_MILLIS")
| epoch: Timestamp
|}
|""".stripMargin

Expand All @@ -279,6 +288,7 @@ class CompilerRendererSuite extends FunSuite {
| alloy.protobuf.DocumentValue document = 11;
| google.protobuf.StringValue string = 12;
| alloy.protobuf.TimestampValue timestamp = 13;
| google.protobuf.Int64Value epoch = 14;
|}
|""".stripMargin
convertCheck(source, Map("com/example/example.proto" -> expected))
Expand Down
Loading