Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ protected void addConstituentFields(@Nonnull DescriptorProtos.DescriptorProto.Bu
for (Constituent constituent : constituents) {
descriptorProto.addFieldBuilder()
.setName(constituent.getName())
.setJsonName(constituent.getName())
.setNumber(++fieldNumber)
.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_MESSAGE)
.setTypeName("." + constituent.getRecordType().getDescriptor().getFullName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ public void buildDescriptor(@Nonnull final DescriptorProtos.FileDescriptorProto.
.setLabel(DescriptorProtos.FieldDescriptorProto.Label.LABEL_OPTIONAL)
.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_INT64)
.setName(constituent.getName())
.setJsonName(constituent.getName())
.setNumber(indexPosition++);
}
}
Expand All @@ -325,6 +326,7 @@ public void buildDescriptor(@Nonnull final DescriptorProtos.FileDescriptorProto.
.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_MESSAGE)
.setTypeName(name + "." + indexesProto.getName())
.setName(UnnestedRecordType.POSITIONS_FIELD)
.setJsonName(UnnestedRecordType.POSITIONS_FIELD)
.setNumber(getConstituents().size() + 1);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@
.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_MESSAGE)
.setTypeName(fullyQualifiedTypeName(fileBuilder, typeName))
.setName("_" + typeName)
.setJsonName("_" + typeName)
.setNumber(assignFieldNumber(unionBuilder));
unionBuilder.addField(fieldBuilder);
}
Expand Down Expand Up @@ -375,68 +376,69 @@
@Nonnull Descriptors.FileDescriptor[] dependencies) {
// Create a copy of the records builder (rather than calling metaDataBuilder.getRecordsBuilder()) to avoid
// corrupting the records builder in metaDataBuilder before all validation has been done.
final DescriptorProtos.FileDescriptorProto records = metaDataBuilder.getRecords();
boolean found = false;
for (DescriptorProtos.DescriptorProto messageType : records.getMessageTypeList()) {
if (messageType.getName().equals(recordTypeName)) {
found = true;
} else if (messageType.getName().equals(newRecordTypeName)) {
throw new MetaDataException("Cannot rename record type to " + newRecordTypeName + " as it already exists");
}
}
if (!found) {
throw new MetaDataException("No record type found with name " + recordTypeName);
}
if (recordTypeName.equals(newRecordTypeName)) {
// Identity transformation requires no work.
// From here on in, we can assume that recordTypeName != newRecordTypeName, which simplifies things.
return;
}
final Descriptors.FileDescriptor fileDescriptor = RecordMetaDataBuilder.buildFileDescriptor(records, dependencies);
final DescriptorProtos.FileDescriptorProto.Builder recordsBuilder = records.toBuilder();

// Determine the usage of the original record type by looking through the union builder.
// If we find a field that matches, also update its name to be in the canonical form (i.e., "_" + recordTypeName)
DescriptorProtos.DescriptorProto.Builder unionBuilder = fetchUnionBuilder(recordsBuilder);
RecordMetaDataOptionsProto.RecordTypeOptions.Usage usage;
if (unionBuilder.getName().equals(recordTypeName)) {
usage = RecordMetaDataOptionsProto.RecordTypeOptions.Usage.UNION;
} else {
final Descriptors.Descriptor unionDescriptor = getDescriptor(fileDescriptor, unionBuilder.getName());
DescriptorProtos.FieldDescriptorProto.Builder unionFieldBuilder = fetchUnionFieldBuilder(recordsBuilder,
unionBuilder, unionDescriptor, recordTypeName);
if (unionFieldBuilder == null) {
usage = RecordMetaDataOptionsProto.RecordTypeOptions.Usage.NESTED;
} else {
usage = RecordMetaDataOptionsProto.RecordTypeOptions.Usage.RECORD;
// Change the name to the "canonical" form unless that would cause a field name conflict
if (unionFieldBuilder.getName().equals("_" + recordTypeName)) {
String newFieldName = "_" + newRecordTypeName;
if (unionBuilder.getFieldBuilderList().stream()
.noneMatch(otherUnionField -> otherUnionField != unionFieldBuilder
&& otherUnionField.getName().equals(newFieldName))) {
unionFieldBuilder.setName(newFieldName);
unionFieldBuilder.setJsonName(newFieldName);
}
}
}
}
// Do not allow renaming to the default union name unless the record type is already the union
if (RecordMetaDataBuilder.DEFAULT_UNION_NAME.equals(newRecordTypeName) &&
!RecordMetaDataOptionsProto.RecordTypeOptions.Usage.UNION.equals(usage)) {
throw new MetaDataException("Cannot rename record type to the default union name", LogMessageKeys.RECORD_TYPE, recordTypeName);
}
// Rename the record type within the file
renameRecordTypeUsages(recordsBuilder, recordTypeName, newRecordTypeName, fileDescriptor);

// If the record type is a top level record type, change its usage elsewhere in the meta-data
if (RecordMetaDataOptionsProto.RecordTypeOptions.Usage.RECORD.equals(usage)) {
renameTopLevelRecordType(metaDataBuilder, recordTypeName, newRecordTypeName);
}
renameRecordTypeUsagesInUnnested(metaDataBuilder, fileDescriptor, recordTypeName, newRecordTypeName,
getDescriptor(fileDescriptor, recordTypeName));

// Update the file descriptor
metaDataBuilder.setRecords(recordsBuilder);

Check warning on line 441 in fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/provider/foundationdb/MetaDataProtoEditor.java

View check run for this annotation

fdb.teamscale.io / Teamscale | Findings

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/provider/foundationdb/MetaDataProtoEditor.java#L379-L441

This method is a bit lengthy [0]. Consider shortening it, e.g. by extracting code blocks into separate methods. [0] https://fdb.teamscale.io/findings/details/foundationdb-fdb-record-layer?t=FORK_MR%2F3517%2FMMcM%2Fgenerated-proto-vs-protoc%3AHEAD&id=AB0D38C53DE4416D89BFFE0B5528CD0D
}

private static Descriptors.Descriptor getDescriptor(final Descriptors.FileDescriptor fileDescriptor, String name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,7 @@ public void addProtoField(@Nonnull final TypeRepository.Builder typeRepositoryBu
descriptorBuilder.addField(FieldDescriptorProto.newBuilder()
.setNumber(fieldNumber)
.setName(fieldName)
.setJsonName(fieldName)
.setType(protoType)
.setLabel(label)
.build());
Expand Down Expand Up @@ -1634,6 +1635,7 @@ public void addProtoField(@Nonnull final TypeRepository.Builder typeRepositoryBu
FieldDescriptorProto.Builder builder = FieldDescriptorProto.newBuilder()
.setNumber(fieldNumber)
.setName(fieldName)
.setJsonName(fieldName)
.setType(protoType)
.setLabel(label);
typeNameOptional.ifPresent(builder::setTypeName);
Expand Down Expand Up @@ -2067,9 +2069,11 @@ public void addProtoField(@Nonnull final TypeRepository.Builder typeRepositoryBu
final var fieldDescriptorProto = FieldDescriptorProto.newBuilder();
fieldDescriptorProto
.setName(fieldName)
.setJsonName(fieldName)
.setNumber(fieldNumber)
.setType(FieldDescriptorProto.Type.TYPE_MESSAGE)
.setLabel(label);
typeNameOptional.ifPresent(fieldDescriptorProto::setTypeName);
typeNameOptional.ifPresent(localName -> fieldDescriptorProto.setTypeName("." + localName));
descriptorBuilder.addField(fieldDescriptorProto.build());
}

Expand Down Expand Up @@ -3036,7 +3040,9 @@ public void addProtoField(@Nonnull final TypeRepository.Builder typeRepositoryBu
FieldDescriptorProto.Builder builder = FieldDescriptorProto.newBuilder()
.setNumber(fieldNumber)
.setName(fieldName)
.setJsonName(fieldName)
.setLabel(label)
.setType(FieldDescriptorProto.Type.TYPE_MESSAGE)
.setTypeName(TupleFieldsProto.UUID.getDescriptor().getFullName());
typeNameOptional.ifPresent(builder::setTypeName);
descriptorBuilder.addField(builder);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,13 @@ public void visit(@Nonnull final Table table) {
// add the table as an entry in the final 'RecordTypeUnion' entry of the record store metadata. There is one
// field for each generation of the RecordLayerTable.
for (var version : generations.entrySet()) {
final String name = recordLayerTable.getName() + "_" + (fieldCounter++);
final var tableEntryInUnionDescriptor = DescriptorProtos.FieldDescriptorProto.newBuilder()
.setNumber(version.getKey())
.setName(recordLayerTable.getName() + "_" + (fieldCounter++))
.setName(name)
.setJsonName(name)
.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_MESSAGE)
.setTypeName(typeDescriptor)
.setTypeName("." + typeDescriptor)
.setOptions(version.getValue())
.build();
unionDescriptorBuilder.addField(tableEntryInUnionDescriptor);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public static DescriptorProtos.FieldDescriptorProto newDescriptor(String name,
String messageType,
boolean isRepeated) {
DescriptorProtos.FieldDescriptorProto.Builder proto = DescriptorProtos.FieldDescriptorProto.newBuilder()
.setName(name);
.setName(name).setJsonName(name);
switch (javaType) {
case INT:
proto.setType(DescriptorProtos.FieldDescriptorProto.Type.TYPE_INT32);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,11 @@ private void buildTypesAndTables() {
if (extension != null && extension.hasUsage() && extension.getUsage() == RecordMetaDataOptionsProto.RecordTypeOptions.Usage.UNION) {
//we found the Union Descriptor
for (DescriptorProtos.FieldDescriptorProto tableDescs : typeDesc.getFieldList()) {
tableNames.add(tableDescs.getTypeName());
String name = tableDescs.getTypeName();
if (name.startsWith(".")) {
name = name.substring(1);
}
tableNames.add(name);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ public void testGoodSchemaTemplate() {
final var unionDesc = maybeUnionDesc.get();

// Check if all tables are part of union descriptor.
final var expectedTableNameSet = Set.of("T1", "T2");
final var expectedTableNameSet = Set.of(".T1", ".T2");
Assertions.assertTrue(unionDesc.getFieldList().stream().allMatch(e -> expectedTableNameSet.contains(e.getTypeName())));

// Check if the number of fields in union descriptor are equal to the tables in the template.
Expand Down Expand Up @@ -237,8 +237,10 @@ public void testGoodSchemaTemplateWithGenerations() {
// Check if all generations are present in union descriptor
for (final var unionField : unionDesc.getFieldList()) {
final var typeName = unionField.getTypeName();
Assertions.assertTrue(testcase.containsKey(typeName));
final var expectedGenerations = testcase.get(typeName);
Assertions.assertTrue(typeName.startsWith("."));
final var caseName = typeName.substring(1);
Assertions.assertTrue(testcase.containsKey(caseName));
final var expectedGenerations = testcase.get(caseName);
Assertions.assertTrue(expectedGenerations.contains(NonnullPair.of(unionField.getNumber(), unionField.getOptions())));
}
}
Expand Down
Loading