Skip to content

Commit

Permalink
protoc: parser rejects explicit use of map_entry option (#13479)
Browse files Browse the repository at this point in the history
This addresses #13441.  Second try, now with more internal fixes.

This preserves the similar check at the _point of use_ of invalid messages in `DescriptorBuilder` (and there's an existing test that verifies that check still works).

But it adds another check in the parser, to catch this error at the _point of definition_ of an invalid message. And the corresponding test is updated: we no longer need a usage of the message to catch the error, and the reported position is the definition of the option, not the usage site of the message.

The way this works feels kinda gross, but I wasn't sure of a better way to do it. The only place we know for certain that it was an explicit option (vs. auto-added by the parser when synthesizing a map entry message) is when after processing the message body, we can look at the uninterpreted options. So that's what this does. If you have ideas on better/cleaner approaches, I'd be happy to revise.

Closes #13479

PiperOrigin-RevId: 557199190
  • Loading branch information
fowles authored and Copybara-Service committed Aug 15, 2023
1 parent 9702adf commit 8f59292
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
24 changes: 24 additions & 0 deletions src/google/protobuf/compiler/parser.cc
Expand Up @@ -571,6 +571,26 @@ void Parser::SkipRestOfBlock() {

// ===================================================================

bool Parser::ValidateMessage(const DescriptorProto* proto) {
for (int i = 0; i < proto->options().uninterpreted_option_size(); i++) {
const UninterpretedOption& option =
proto->options().uninterpreted_option(i);
if (option.name_size() > 0 && !option.name(0).is_extension() &&
option.name(0).name_part() == "map_entry") {
int line = -1, col = 0; // indicates line and column not known
if (source_location_table_ != nullptr) {
source_location_table_->Find(
&option, DescriptorPool::ErrorCollector::OPTION_NAME, &line, &col);
}
RecordError(line, col,
"map_entry should not be set explicitly. "
"Use map<KeyType, ValueType> instead.");
return false;
}
}
return true;
}

bool Parser::ValidateEnum(const EnumDescriptorProto* proto) {
bool has_allow_alias = false;
bool allow_alias = false;
Expand Down Expand Up @@ -866,6 +886,7 @@ bool IsMessageSetWireFormatMessage(const DescriptorProto& message) {
for (int i = 0; i < options.uninterpreted_option_size(); ++i) {
const UninterpretedOption& uninterpreted = options.uninterpreted_option(i);
if (uninterpreted.name_size() == 1 &&
!uninterpreted.name(0).is_extension() &&
uninterpreted.name(0).name_part() == "message_set_wire_format" &&
uninterpreted.identifier_value() == "true") {
return true;
Expand Down Expand Up @@ -930,6 +951,9 @@ bool Parser::ParseMessageBlock(DescriptorProto* message,
if (message->reserved_range_size() > 0) {
AdjustReservedRangesWithMaxEndNumber(message);
}

DO(ValidateMessage(message));

return true;
}

Expand Down
1 change: 1 addition & 0 deletions src/google/protobuf/compiler/parser.h
Expand Up @@ -540,6 +540,7 @@ class PROTOBUF_EXPORT Parser {
return syntax_identifier_ == "proto3";
}

bool ValidateMessage(const DescriptorProto* proto);
bool ValidateEnum(const EnumDescriptorProto* proto);

// =================================================================
Expand Down
7 changes: 4 additions & 3 deletions src/google/protobuf/compiler/parser_unittest.cc
Expand Up @@ -171,6 +171,8 @@ class ParserTest : public testing::Test {
// input.
void ExpectHasEarlyExitErrors(const char* text, const char* expected_errors) {
SetupParser(text);
SourceLocationTable source_locations;
parser_->RecordSourceLocationsTo(&source_locations);
FileDescriptorProto file;
EXPECT_FALSE(parser_->Parse(input_.get(), &file));
EXPECT_EQ(expected_errors, error_collector_.text_);
Expand Down Expand Up @@ -2357,17 +2359,16 @@ TEST_F(ParserValidationErrorTest, EnumReservedRangeError) {
}

TEST_F(ParserValidationErrorTest, ExplicitlyMapEntryError) {
ExpectHasValidationErrors(
ExpectHasErrors(
"message Foo {\n"
" message ValueEntry {\n"
" option map_entry = true;\n"
" optional int32 key = 1;\n"
" optional int32 value = 2;\n"
" extensions 99 to 999;\n"
" }\n"
" repeated ValueEntry value = 1;\n"
"}",
"7:11: map_entry should not be set explicitly. Use "
"2:11: map_entry should not be set explicitly. Use "
"map<KeyType, ValueType> instead.\n");
}

Expand Down

0 comments on commit 8f59292

Please sign in to comment.