Skip to content

Commit

Permalink
Verify set and when are defined. Move MatchType enum to top-level
Browse files Browse the repository at this point in the history 
See #1007
  • Loading branch information
@thesamet
thesamet committed Jan 20, 2021
1 parent d04d4c1 commit 9d152fc
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 78 deletions.
14 changes: 12 additions & 2 deletions compiler-plugin/src/main/scala/scalapb/compiler/FieldTransformations.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package scalapb.compiler

import com.google.protobuf.Message
import scalapb.options.Scalapb
import scalapb.options.Scalapb.FieldTransformation.MatchType
import scalapb.options.Scalapb.MatchType
import com.google.protobuf.Descriptors.FieldDescriptor
import com.google.protobuf.Descriptors.FileDescriptor
import scala.jdk.CollectionConverters._
Expand Down Expand Up @@ -38,6 +38,16 @@ private[compiler] object ResolvedFieldTransformation {
file.getFullName(),
FieldTransformations.fieldExtensionsForFile(file)
)
if (!ft.hasWhen()) {
throw new GeneratorException(
s"""${file.getFullName}: FieldTransformation missing "when" field."""
)
}
if (!ft.hasSet()) {
throw new GeneratorException(
s"""${file.getFullName}: FieldTransformation missing "set" field."""
)
}
if (!ft.getSet().getAllFields().keySet().asScala.subsetOf(Set(Scalapb.field.getDescriptor()))
|| !ft
.getSet()
Expand All @@ -47,7 +57,7 @@ private[compiler] object ResolvedFieldTransformation {
.asScala
.subsetOf(Set(Scalapb.field.getNumber()))) {
throw new GeneratorException(
s"${file.getFullName}: FieldTransformation.set must contain only [scalapb.field] field"
s"${file.getFullName}: FieldTransformation.set must contain only [scalapb.field] field."
)
}
ResolvedFieldTransformation(
Expand Down
52 changes: 52 additions & 0 deletions compiler-plugin/src/test/scala/scalapb/compiler/FieldTransformationsSpec.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,58 @@ class FieldTransformationsSpec extends AnyFlatSpec with Matchers with ProtocInvo
)
}

it should "throw exception when not setting 'set'" in {
val e2 =
Map(
"e2.proto" ->
"""|syntax = "proto3";
|package local;
|import "scalapb/scalapb.proto";
|option (scalapb.options) = {
| field_transformations: [
| {
| when {}
| }
| ]
|};
|""".stripMargin
)
intercept[GeneratorException] {
FileOptionsCache.buildCache(
generateFileSet(base ++ e2),
SecondaryOutputProvider.empty
)
}.getMessage() must startWith(
"e2.proto: FieldTransformation missing \"set\" field."
)
}

it should "throw exception when not setting 'when'" in {
val e3 =
Map(
"e3.proto" ->
"""|syntax = "proto3";
|package local;
|import "scalapb/scalapb.proto";
|option (scalapb.options) = {
| field_transformations: [
| {
| set {}
| }
| ]
|};
|""".stripMargin
)
intercept[GeneratorException] {
FileOptionsCache.buildCache(
generateFileSet(base ++ e3),
SecondaryOutputProvider.empty
)
}.getMessage() must startWith(
"e3.proto: FieldTransformation missing \"when\" field."
)
}

it should "throw exception when import is missing on injected transformations" in {
val extraNoImport = Map(
"injected_options.proto" ->
Expand Down
11 changes: 6 additions & 5 deletions protobuf/scalapb/scalapb.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -312,13 +312,14 @@ extend google.protobuf.OneofOptions {
optional OneofOptions oneof = 1020;
}

enum MatchType {
CONTAINS = 0;
EXACT = 1;
PRESENCE = 2;
}

message FieldTransformation {
optional google.protobuf.FieldDescriptorProto when = 1;
enum MatchType {
CONTAINS = 0;
EXACT = 1;
PRESENCE = 2;
}
optional MatchType match_type = 2 [default=CONTAINS];
optional google.protobuf.FieldOptions set = 3;
}
Expand Down
66 changes: 10 additions & 56 deletions scalapb-runtime/shared/src/main/scala/scalapb/options/FieldTransformation.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ package scalapb.options
@SerialVersionUID(0L)
final case class FieldTransformation(
when: _root_.scala.Option[com.google.protobuf.descriptor.FieldDescriptorProto] = _root_.scala.None,
matchType: _root_.scala.Option[scalapb.options.FieldTransformation.MatchType] = _root_.scala.None,
matchType: _root_.scala.Option[scalapb.options.MatchType] = _root_.scala.None,
set: _root_.scala.Option[com.google.protobuf.descriptor.FieldOptions] = _root_.scala.None,
unknownFields: _root_.scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty
) extends scalapb.GeneratedMessage with scalapb.lenses.Updatable[FieldTransformation] {
Expand Down Expand Up @@ -61,9 +61,9 @@ final case class FieldTransformation(
def getWhen: com.google.protobuf.descriptor.FieldDescriptorProto = when.getOrElse(com.google.protobuf.descriptor.FieldDescriptorProto.defaultInstance)
def clearWhen: FieldTransformation = copy(when = _root_.scala.None)
def withWhen(__v: com.google.protobuf.descriptor.FieldDescriptorProto): FieldTransformation = copy(when = Option(__v))
def getMatchType: scalapb.options.FieldTransformation.MatchType = matchType.getOrElse(scalapb.options.FieldTransformation.MatchType.CONTAINS)
def getMatchType: scalapb.options.MatchType = matchType.getOrElse(scalapb.options.MatchType.CONTAINS)
def clearMatchType: FieldTransformation = copy(matchType = _root_.scala.None)
def withMatchType(__v: scalapb.options.FieldTransformation.MatchType): FieldTransformation = copy(matchType = Option(__v))
def withMatchType(__v: scalapb.options.MatchType): FieldTransformation = copy(matchType = Option(__v))
def getSet: com.google.protobuf.descriptor.FieldOptions = set.getOrElse(com.google.protobuf.descriptor.FieldOptions.defaultInstance)
def clearSet: FieldTransformation = copy(set = _root_.scala.None)
def withSet(__v: com.google.protobuf.descriptor.FieldOptions): FieldTransformation = copy(set = Option(__v))
Expand Down Expand Up @@ -97,7 +97,7 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
_root_.scala.Predef.require(__fieldsMap.keys.forall(_.containingMessage == scalaDescriptor), "FieldDescriptor does not match message type.")
scalapb.options.FieldTransformation(
when = __fieldsMap.get(scalaDescriptor.findFieldByNumber(1).get).flatMap(_.as[_root_.scala.Option[com.google.protobuf.descriptor.FieldDescriptorProto]]),
matchType = __fieldsMap.get(scalaDescriptor.findFieldByNumber(2).get).flatMap(_.as[_root_.scala.Option[_root_.scalapb.descriptors.EnumValueDescriptor]]).map(__e => scalapb.options.FieldTransformation.MatchType.fromValue(__e.number)),
matchType = __fieldsMap.get(scalaDescriptor.findFieldByNumber(2).get).flatMap(_.as[_root_.scala.Option[_root_.scalapb.descriptors.EnumValueDescriptor]]).map(__e => scalapb.options.MatchType.fromValue(__e.number)),
set = __fieldsMap.get(scalaDescriptor.findFieldByNumber(3).get).flatMap(_.as[_root_.scala.Option[com.google.protobuf.descriptor.FieldOptions]])
)
case _ => throw new RuntimeException("Expected PMessage")
Expand All @@ -115,7 +115,7 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
lazy val nestedMessagesCompanions: Seq[_root_.scalapb.GeneratedMessageCompanion[_ <: _root_.scalapb.GeneratedMessage]] = Seq.empty
def enumCompanionForFieldNumber(__fieldNumber: _root_.scala.Int): _root_.scalapb.GeneratedEnumCompanion[_] = {
(__fieldNumber: @_root_.scala.unchecked) match {
case 2 => scalapb.options.FieldTransformation.MatchType
case 2 => scalapb.options.MatchType
}
}
lazy val defaultInstance = scalapb.options.FieldTransformation(
Expand All @@ -125,7 +125,7 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
)
final class Builder private (
private var __when: _root_.scala.Option[com.google.protobuf.descriptor.FieldDescriptorProto],
private var __matchType: _root_.scala.Option[scalapb.options.FieldTransformation.MatchType],
private var __matchType: _root_.scala.Option[scalapb.options.MatchType],
private var __set: _root_.scala.Option[com.google.protobuf.descriptor.FieldOptions],
private var `_unknownFields__`: _root_.scalapb.UnknownFieldSet.Builder
) extends _root_.scalapb.MessageBuilder[scalapb.options.FieldTransformation] {
Expand All @@ -138,7 +138,7 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
case 10 =>
__when = Option(__when.fold(_root_.scalapb.LiteParser.readMessage[com.google.protobuf.descriptor.FieldDescriptorProto](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
case 16 =>
__matchType = Option(scalapb.options.FieldTransformation.MatchType.fromValue(_input__.readEnum()))
__matchType = Option(scalapb.options.MatchType.fromValue(_input__.readEnum()))
case 26 =>
__set = Option(__set.fold(_root_.scalapb.LiteParser.readMessage[com.google.protobuf.descriptor.FieldOptions](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
case tag =>
Expand Down Expand Up @@ -175,57 +175,11 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
}
def newBuilder: Builder = scalapb.options.FieldTransformation.Builder()
def newBuilder(`_message__`: scalapb.options.FieldTransformation): Builder = scalapb.options.FieldTransformation.Builder(_message__)
sealed abstract class MatchType(val value: _root_.scala.Int) extends _root_.scalapb.GeneratedEnum {
type EnumType = MatchType
def isContains: _root_.scala.Boolean = false
def isExact: _root_.scala.Boolean = false
def isPresence: _root_.scala.Boolean = false
def companion: _root_.scalapb.GeneratedEnumCompanion[MatchType] = scalapb.options.FieldTransformation.MatchType
final def asRecognized: _root_.scala.Option[scalapb.options.FieldTransformation.MatchType.Recognized] = if (isUnrecognized) _root_.scala.None else _root_.scala.Some(this.asInstanceOf[scalapb.options.FieldTransformation.MatchType.Recognized])
}

object MatchType extends _root_.scalapb.GeneratedEnumCompanion[MatchType] {
sealed trait Recognized extends MatchType
implicit def enumCompanion: _root_.scalapb.GeneratedEnumCompanion[MatchType] = this
@SerialVersionUID(0L)
case object CONTAINS extends MatchType(0) with MatchType.Recognized {
val index = 0
val name = "CONTAINS"
override def isContains: _root_.scala.Boolean = true
}

@SerialVersionUID(0L)
case object EXACT extends MatchType(1) with MatchType.Recognized {
val index = 1
val name = "EXACT"
override def isExact: _root_.scala.Boolean = true
}

@SerialVersionUID(0L)
case object PRESENCE extends MatchType(2) with MatchType.Recognized {
val index = 2
val name = "PRESENCE"
override def isPresence: _root_.scala.Boolean = true
}

@SerialVersionUID(0L)
final case class Unrecognized(unrecognizedValue: _root_.scala.Int) extends MatchType(unrecognizedValue) with _root_.scalapb.UnrecognizedEnum

lazy val values = scala.collection.immutable.Seq(CONTAINS, EXACT, PRESENCE)
def fromValue(__value: _root_.scala.Int): MatchType = __value match {
case 0 => CONTAINS
case 1 => EXACT
case 2 => PRESENCE
case __other => Unrecognized(__other)
}
def javaDescriptor: _root_.com.google.protobuf.Descriptors.EnumDescriptor = scalapb.options.FieldTransformation.javaDescriptor.getEnumTypes().get(0)
def scalaDescriptor: _root_.scalapb.descriptors.EnumDescriptor = scalapb.options.FieldTransformation.scalaDescriptor.enums(0)
}
implicit class FieldTransformationLens[UpperPB](_l: _root_.scalapb.lenses.Lens[UpperPB, scalapb.options.FieldTransformation]) extends _root_.scalapb.lenses.ObjectLens[UpperPB, scalapb.options.FieldTransformation](_l) {
def when: _root_.scalapb.lenses.Lens[UpperPB, com.google.protobuf.descriptor.FieldDescriptorProto] = field(_.getWhen)((c_, f_) => c_.copy(when = Option(f_)))
def optionalWhen: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[com.google.protobuf.descriptor.FieldDescriptorProto]] = field(_.when)((c_, f_) => c_.copy(when = f_))
def matchType: _root_.scalapb.lenses.Lens[UpperPB, scalapb.options.FieldTransformation.MatchType] = field(_.getMatchType)((c_, f_) => c_.copy(matchType = Option(f_)))
def optionalMatchType: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[scalapb.options.FieldTransformation.MatchType]] = field(_.matchType)((c_, f_) => c_.copy(matchType = f_))
def matchType: _root_.scalapb.lenses.Lens[UpperPB, scalapb.options.MatchType] = field(_.getMatchType)((c_, f_) => c_.copy(matchType = Option(f_)))
def optionalMatchType: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[scalapb.options.MatchType]] = field(_.matchType)((c_, f_) => c_.copy(matchType = f_))
def set: _root_.scalapb.lenses.Lens[UpperPB, com.google.protobuf.descriptor.FieldOptions] = field(_.getSet)((c_, f_) => c_.copy(set = Option(f_)))
def optionalSet: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[com.google.protobuf.descriptor.FieldOptions]] = field(_.set)((c_, f_) => c_.copy(set = f_))
}
Expand All @@ -234,7 +188,7 @@ object FieldTransformation extends scalapb.GeneratedMessageCompanion[scalapb.opt
final val SET_FIELD_NUMBER = 3
def of(
when: _root_.scala.Option[com.google.protobuf.descriptor.FieldDescriptorProto],
matchType: _root_.scala.Option[scalapb.options.FieldTransformation.MatchType],
matchType: _root_.scala.Option[scalapb.options.MatchType],
set: _root_.scala.Option[com.google.protobuf.descriptor.FieldOptions]
): _root_.scalapb.options.FieldTransformation = _root_.scalapb.options.FieldTransformation(
when,
Expand Down
30 changes: 15 additions & 15 deletions scalapb-runtime/shared/src/main/scala/scalapb/options/ScalapbProto.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,22 +74,22 @@ object ScalapbProto extends _root_.scalapb.GeneratedFileObject {
mlvbl9leHRlbmRzGAIgAygJQhXiPxISEGNvbXBhbmlvbkV4dGVuZHNSEGNvbXBhbmlvbkV4dGVuZHMSHQoEdHlwZRgDIAEoCUIJ4
j8GEgR0eXBlUgR0eXBlKgkI6AcQgICAgAIidAoQRW51bVZhbHVlT3B0aW9ucxImCgdleHRlbmRzGAEgAygJQgziPwkSB2V4dGVuZ
HNSB2V4dGVuZHMSLQoKc2NhbGFfbmFtZRgCIAEoCUIO4j8LEglzY2FsYU5hbWVSCXNjYWxhTmFtZSoJCOgHEICAgIACIkEKDE9uZ
W9mT3B0aW9ucxImCgdleHRlbmRzGAEgAygJQgziPwkSB2V4dGVuZHNSB2V4dGVuZHMqCQjoBxCAgICAAiKrAgoTRmllbGRUcmFuc
W9mT3B0aW9ucxImCgdleHRlbmRzGAEgAygJQgziPwkSB2V4dGVuZHNSB2V4dGVuZHMqCQjoBxCAgICAAiLjAQoTRmllbGRUcmFuc
2Zvcm1hdGlvbhJECgR3aGVuGAEgASgLMiUuZ29vZ2xlLnByb3RvYnVmLkZpZWxkRGVzY3JpcHRvclByb3RvQgniPwYSBHdoZW5SB
HdoZW4SXwoKbWF0Y2hfdHlwZRgCIAEoDjImLnNjYWxhcGIuRmllbGRUcmFuc2Zvcm1hdGlvbi5NYXRjaFR5cGU6CENPTlRBSU5TQ
g7iPwsSCW1hdGNoVHlwZVIJbWF0Y2hUeXBlEjkKA3NldBgDIAEoCzIdLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE9wdGlvbnNCCOI/B
RIDc2V0UgNzZXQiMgoJTWF0Y2hUeXBlEgwKCENPTlRBSU5TEAASCQoFRVhBQ1QQARIMCghQUkVTRU5DRRACIvEBChJQcmVwcm9jZ
XNzb3JPdXRwdXQSagoPb3B0aW9uc19ieV9maWxlGAEgAygLMi4uc2NhbGFwYi5QcmVwcm9jZXNzb3JPdXRwdXQuT3B0aW9uc0J5R
mlsZUVudHJ5QhLiPw8SDW9wdGlvbnNCeUZpbGVSDW9wdGlvbnNCeUZpbGUabwoST3B0aW9uc0J5RmlsZUVudHJ5EhoKA2tleRgBI
AEoCUII4j8FEgNrZXlSA2tleRI5CgV2YWx1ZRgCIAEoCzIXLnNjYWxhcGIuU2NhbGFQYk9wdGlvbnNCCuI/BxIFdmFsdWVSBXZhb
HVlOgI4ATpQCgdvcHRpb25zEhwuZ29vZ2xlLnByb3RvYnVmLkZpbGVPcHRpb25zGPwHIAEoCzIXLnNjYWxhcGIuU2NhbGFQYk9wd
GlvbnNSB29wdGlvbnM6UwoHbWVzc2FnZRIfLmdvb2dsZS5wcm90b2J1Zi5NZXNzYWdlT3B0aW9ucxj8ByABKAsyFy5zY2FsYXBiL
k1lc3NhZ2VPcHRpb25zUgdtZXNzYWdlOksKBWZpZWxkEh0uZ29vZ2xlLnByb3RvYnVmLkZpZWxkT3B0aW9ucxj8ByABKAsyFS5zY
2FsYXBiLkZpZWxkT3B0aW9uc1IFZmllbGQ6VgoMZW51bV9vcHRpb25zEhwuZ29vZ2xlLnByb3RvYnVmLkVudW1PcHRpb25zGPwHI
AEoCzIULnNjYWxhcGIuRW51bU9wdGlvbnNSC2VudW1PcHRpb25zOlwKCmVudW1fdmFsdWUSIS5nb29nbGUucHJvdG9idWYuRW51b
VZhbHVlT3B0aW9ucxj8ByABKAsyGS5zY2FsYXBiLkVudW1WYWx1ZU9wdGlvbnNSCWVudW1WYWx1ZTpLCgVvbmVvZhIdLmdvb2dsZ
S5wcm90b2J1Zi5PbmVvZk9wdGlvbnMY/AcgASgLMhUuc2NhbGFwYi5PbmVvZk9wdGlvbnNSBW9uZW9mQicKD3NjYWxhcGIub3B0a
W9uc+I/EwoPc2NhbGFwYi5vcHRpb25zEAE="""
HdoZW4SSwoKbWF0Y2hfdHlwZRgCIAEoDjISLnNjYWxhcGIuTWF0Y2hUeXBlOghDT05UQUlOU0IO4j8LEgltYXRjaFR5cGVSCW1hd
GNoVHlwZRI5CgNzZXQYAyABKAsyHS5nb29nbGUucHJvdG9idWYuRmllbGRPcHRpb25zQgjiPwUSA3NldFIDc2V0IvEBChJQcmVwc
m9jZXNzb3JPdXRwdXQSagoPb3B0aW9uc19ieV9maWxlGAEgAygLMi4uc2NhbGFwYi5QcmVwcm9jZXNzb3JPdXRwdXQuT3B0aW9uc
0J5RmlsZUVudHJ5QhLiPw8SDW9wdGlvbnNCeUZpbGVSDW9wdGlvbnNCeUZpbGUabwoST3B0aW9uc0J5RmlsZUVudHJ5EhoKA2tle
RgBIAEoCUII4j8FEgNrZXlSA2tleRI5CgV2YWx1ZRgCIAEoCzIXLnNjYWxhcGIuU2NhbGFQYk9wdGlvbnNCCuI/BxIFdmFsdWVSB
XZhbHVlOgI4ASoyCglNYXRjaFR5cGUSDAoIQ09OVEFJTlMQABIJCgVFWEFDVBABEgwKCFBSRVNFTkNFEAI6UAoHb3B0aW9ucxIcL
mdvb2dsZS5wcm90b2J1Zi5GaWxlT3B0aW9ucxj8ByABKAsyFy5zY2FsYXBiLlNjYWxhUGJPcHRpb25zUgdvcHRpb25zOlMKB21lc
3NhZ2USHy5nb29nbGUucHJvdG9idWYuTWVzc2FnZU9wdGlvbnMY/AcgASgLMhcuc2NhbGFwYi5NZXNzYWdlT3B0aW9uc1IHbWVzc
2FnZTpLCgVmaWVsZBIdLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE9wdGlvbnMY/AcgASgLMhUuc2NhbGFwYi5GaWVsZE9wdGlvbnNSB
WZpZWxkOlYKDGVudW1fb3B0aW9ucxIcLmdvb2dsZS5wcm90b2J1Zi5FbnVtT3B0aW9ucxj8ByABKAsyFC5zY2FsYXBiLkVudW1Pc
HRpb25zUgtlbnVtT3B0aW9uczpcCgplbnVtX3ZhbHVlEiEuZ29vZ2xlLnByb3RvYnVmLkVudW1WYWx1ZU9wdGlvbnMY/AcgASgLM
hkuc2NhbGFwYi5FbnVtVmFsdWVPcHRpb25zUgllbnVtVmFsdWU6SwoFb25lb2YSHS5nb29nbGUucHJvdG9idWYuT25lb2ZPcHRpb
25zGPwHIAEoCzIVLnNjYWxhcGIuT25lb2ZPcHRpb25zUgVvbmVvZkInCg9zY2FsYXBiLm9wdGlvbnPiPxMKD3NjYWxhcGIub3B0a
W9ucxAB"""
).mkString)
lazy val scalaDescriptor: _root_.scalapb.descriptors.FileDescriptor = {
val scalaProto = com.google.protobuf.descriptor.FileDescriptorProto.parseFrom(ProtoBytes)
Expand Down

0 comments on commit 9d152fc

Please sign in to comment.