Lock down ctype=CORD in proto file.

ctype can not be used for none string/bytes fields. ctye=CORD can not be used for extensions. A new macro PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE is added that will be flipped for our next breaking release.

PiperOrigin-RevId: 555615362
pull/13514/head
Jie Luo 1 year ago committed by Copybara-Service
parent e701f4fa77
commit b359e5020a
  1. 6
      csharp/protos/unittest.proto
  2. 6
      objectivec/Tests/unittest.proto
  3. 16
      src/google/protobuf/compiler/cpp/generator.cc
  4. 34
      src/google/protobuf/compiler/cpp/generator_unittest.cc
  5. 4
      src/google/protobuf/port_def.inc
  6. 12
      src/google/protobuf/unittest.proto
  7. 13
      src/google/protobuf/unittest_lite.proto

@ -258,7 +258,7 @@ extend TestAllExtensions {
optional_import_enum_extension = 23; optional_import_enum_extension = 23;
optional string optional_string_piece_extension = 24 [ctype = STRING_PIECE]; optional string optional_string_piece_extension = 24 [ctype = STRING_PIECE];
optional string optional_cord_extension = 25 [ctype = CORD]; optional string optional_cord_extension = 25;
optional protobuf_unittest_import_proto2.PublicImportMessage optional protobuf_unittest_import_proto2.PublicImportMessage
optional_public_import_message_extension = 26; optional_public_import_message_extension = 26;
@ -298,7 +298,7 @@ extend TestAllExtensions {
repeated_import_enum_extension = 53; repeated_import_enum_extension = 53;
repeated string repeated_string_piece_extension = 54 [ctype = STRING_PIECE]; repeated string repeated_string_piece_extension = 54 [ctype = STRING_PIECE];
repeated string repeated_cord_extension = 55 [ctype = CORD]; repeated string repeated_cord_extension = 55;
repeated TestAllTypes.NestedMessage repeated_lazy_message_extension = 57 repeated TestAllTypes.NestedMessage repeated_lazy_message_extension = 57
[lazy = true]; [lazy = true];
@ -329,7 +329,7 @@ extend TestAllExtensions {
optional string default_string_piece_extension = 84 optional string default_string_piece_extension = 84
[ctype = STRING_PIECE, default = "abc"]; [ctype = STRING_PIECE, default = "abc"];
optional string default_cord_extension = 85 [ctype = CORD, default = "123"]; optional string default_cord_extension = 85 [default = "123"];
// For oneof test // For oneof test
optional uint32 oneof_uint32_extension = 111; optional uint32 oneof_uint32_extension = 111;

@ -244,7 +244,7 @@ extend TestAllExtensions {
optional_import_enum_extension = 23; optional_import_enum_extension = 23;
optional string optional_string_piece_extension = 24 [ctype=STRING_PIECE]; optional string optional_string_piece_extension = 24 [ctype=STRING_PIECE];
optional string optional_cord_extension = 25 [ctype=CORD]; optional string optional_cord_extension = 25;
optional objc.protobuf.tests.public_import.Message optional objc.protobuf.tests.public_import.Message
optional_public_import_message_extension = 26; optional_public_import_message_extension = 26;
@ -286,7 +286,7 @@ extend TestAllExtensions {
repeated_import_enum_extension = 53; repeated_import_enum_extension = 53;
repeated string repeated_string_piece_extension = 54 [ctype=STRING_PIECE]; repeated string repeated_string_piece_extension = 54 [ctype=STRING_PIECE];
repeated string repeated_cord_extension = 55 [ctype=CORD]; repeated string repeated_cord_extension = 55;
repeated TestAllTypes.NestedMessage repeated TestAllTypes.NestedMessage
repeated_lazy_message_extension = 57 [lazy=true]; repeated_lazy_message_extension = 57 [lazy=true];
@ -317,7 +317,7 @@ extend TestAllExtensions {
optional string default_string_piece_extension = 84 [ctype=STRING_PIECE, optional string default_string_piece_extension = 84 [ctype=STRING_PIECE,
default="abc"]; default="abc"];
optional string default_cord_extension = 85 [ctype=CORD, default="123"]; optional string default_cord_extension = 85 [default="123"];
// For oneof test // For oneof test
optional uint32 oneof_uint32_extension = 111; optional uint32 oneof_uint32_extension = 111;

@ -379,6 +379,22 @@ absl::Status CppGenerator::ValidateFeatures(const FileDescriptor* file) const {
absl::StrCat("Field ", field.full_name(), absl::StrCat("Field ", field.full_name(),
" has a closed enum type with implicit presence.")); " has a closed enum type with implicit presence."));
} }
#ifdef PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE
if (field.options().has_ctype()) {
if (field.cpp_type() != FieldDescriptor::CPPTYPE_STRING) {
status = absl::FailedPreconditionError(absl::StrCat(
"Field ", field.full_name(),
" specifies ctype, but is not a string nor bytes field."));
}
if (field.options().ctype() == FieldOptions::CORD) {
if (field.is_extension()) {
status = absl::FailedPreconditionError(absl::StrCat(
"Extension ", field.full_name(),
" specifies ctype=CORD which is not supported for extensions."));
}
}
}
#endif // !PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE
}); });
return status; return status;
} }

@ -172,6 +172,40 @@ TEST_F(CppGeneratorTest, LegacyClosedEnumImplicit) {
"Field Foo.bar has a closed enum type with implicit presence."); "Field Foo.bar has a closed enum type with implicit presence.");
} }
#ifdef PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE
TEST_F(CppGeneratorTest, CtypeOnNoneStringFieldTest) {
CreateTempFile("foo.proto",
R"schema(
edition = "2023";
message Foo {
int32 bar = 1 [ctype=STRING];
})schema");
RunProtoc(
"protocol_compiler --proto_path=$tmpdir --cpp_out=$tmpdir "
"--experimental_editions foo.proto");
ExpectErrorSubstring(
"Field Foo.bar specifies ctype, but is not "
"a string nor bytes field.");
}
TEST_F(CppGeneratorTest, CtypeOnExtensionTest) {
CreateTempFile("foo.proto",
R"schema(
edition = "2023";
message Foo {
extensions 1 to max;
}
extend Foo {
bytes bar = 1 [ctype=CORD];
})schema");
RunProtoc(
"protocol_compiler --proto_path=$tmpdir --cpp_out=$tmpdir "
"--experimental_editions foo.proto");
ExpectErrorSubstring(
"Extension bar specifies ctype=CORD which is "
"not supported for extensions.");
}
#endif // !PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE
} // namespace } // namespace
} // namespace cpp } // namespace cpp
} // namespace compiler } // namespace compiler

@ -246,6 +246,10 @@ static_assert(PROTOBUF_ABSL_MIN(20230125, 3),
// Owner: mkruskal@ // Owner: mkruskal@
#define PROTOBUF_FUTURE_EXTENSION_RANGE_CLASS 1 #define PROTOBUF_FUTURE_EXTENSION_RANGE_CLASS 1
// Used to lock down wrong ctype usages in proto file.
// Owner: jieluo@
#define PROTOBUF_FUTURE_REMOVE_WRONG_CTYPE 1
#endif #endif
#ifdef PROTOBUF_VERSION #ifdef PROTOBUF_VERSION

@ -267,7 +267,9 @@ extend TestAllExtensions {
optional_import_enum_extension = 23; optional_import_enum_extension = 23;
optional string optional_string_piece_extension = 24 [ctype=STRING_PIECE]; optional string optional_string_piece_extension = 24 [ctype=STRING_PIECE];
optional string optional_cord_extension = 25 [ctype=CORD]; // TODO(b/294946958): ctype=CORD is not supported for extension. Add
// ctype=CORD option back after it is supported.
optional string optional_cord_extension = 25;
optional protobuf_unittest_import.PublicImportMessage optional protobuf_unittest_import.PublicImportMessage
optional_public_import_message_extension = 26; optional_public_import_message_extension = 26;
@ -309,7 +311,9 @@ extend TestAllExtensions {
repeated_import_enum_extension = 53; repeated_import_enum_extension = 53;
repeated string repeated_string_piece_extension = 54 [ctype=STRING_PIECE]; repeated string repeated_string_piece_extension = 54 [ctype=STRING_PIECE];
repeated string repeated_cord_extension = 55 [ctype=CORD]; // TODO(b/294946958): ctype=CORD is not supported for extension. Add
// ctype=CORD option back after it is supported.
repeated string repeated_cord_extension = 55;
repeated TestAllTypes.NestedMessage repeated TestAllTypes.NestedMessage
repeated_lazy_message_extension = 57 [lazy=true]; repeated_lazy_message_extension = 57 [lazy=true];
@ -340,7 +344,9 @@ extend TestAllExtensions {
optional string default_string_piece_extension = 84 [ctype=STRING_PIECE, optional string default_string_piece_extension = 84 [ctype=STRING_PIECE,
default="abc"]; default="abc"];
optional string default_cord_extension = 85 [ctype=CORD, default="123"]; // TODO(b/294946958): ctype=CORD is not supported for extension. Add
// ctype=CORD option back after it is supported.
optional string default_cord_extension = 85 [default="123"];
// For oneof test // For oneof test
optional uint32 oneof_uint32_extension = 111; optional uint32 oneof_uint32_extension = 111;

@ -243,7 +243,9 @@ extend TestAllExtensionsLite {
optional string optional_string_piece_extension_lite = 24 optional string optional_string_piece_extension_lite = 24
[ctype = STRING_PIECE]; [ctype = STRING_PIECE];
optional string optional_cord_extension_lite = 25 [ctype = CORD]; // TODO(b/294946958): ctype=CORD is not supported for extension. Add
// ctype=CORD option back after it is supported.
optional string optional_cord_extension_lite = 25;
optional protobuf_unittest_import.PublicImportMessageLite optional protobuf_unittest_import.PublicImportMessageLite
optional_public_import_message_extension_lite = 26; optional_public_import_message_extension_lite = 26;
@ -288,7 +290,9 @@ extend TestAllExtensionsLite {
repeated string repeated_string_piece_extension_lite = 54 repeated string repeated_string_piece_extension_lite = 54
[ctype = STRING_PIECE]; [ctype = STRING_PIECE];
repeated string repeated_cord_extension_lite = 55 [ctype = CORD]; // TODO(b/294946958): ctype=CORD is not supported for extension. Add
// ctype=CORD option back after it is supported.
repeated string repeated_cord_extension_lite = 55;
repeated TestAllTypesLite.NestedMessage repeated_lazy_message_extension_lite = repeated TestAllTypesLite.NestedMessage repeated_lazy_message_extension_lite =
57 [lazy = true]; 57 [lazy = true];
@ -319,8 +323,9 @@ extend TestAllExtensionsLite {
optional string default_string_piece_extension_lite = 84 optional string default_string_piece_extension_lite = 84
[ctype = STRING_PIECE, default = "abc"]; [ctype = STRING_PIECE, default = "abc"];
optional string default_cord_extension_lite = 85 // TODO(b/294946958): ctype=CORD is not supported for extension. Add
[ctype = CORD, default = "123"]; // ctype=CORD option back after it is supported.
optional string default_cord_extension_lite = 85 [default = "123"];
// For oneof test // For oneof test
optional uint32 oneof_uint32_extension_lite = 111; optional uint32 oneof_uint32_extension_lite = 111;

Loading…
Cancel
Save