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

add support for enum in deepCopyIfNeeded() in RecordConstructorValue #1933

Merged
merged 3 commits into from Dec 14, 2022
Merged

add support for enum in deepCopyIfNeeded() in RecordConstructorValue #1933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fd2686
rdar://102723507 (bug: (fdb-record-layer) add support for enum in dee…
g31pranjal Nov 28, 2022
1e0a3e3
fix deepCopy in RecordConstructorValue
Dec 12, 2022
7c09cb3
address comments
Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...rc/main/java/com/apple/foundationdb/record/query/plan/cascades/values/MessageHelpers.java
View file
Open in desktop
Expand Up @@ -267,6 +267,9 @@ public static Message deepCopyMessageIfNeeded(@Nonnull final Descriptors.Descrip
for (final var element : (List<?>)entry.getValue()) {
if (field.getJavaType() == Descriptors.FieldDescriptor.JavaType.MESSAGE) {
builder.addRepeatedField(targetField, deepCopyMessageIfNeeded(targetField.getMessageType(), (Message)element));
} else if (field.getJavaType() == Descriptors.FieldDescriptor.JavaType.ENUM) {
final var enumValue = ((Descriptors.EnumValueDescriptor) element).getName();
builder.addRepeatedField(targetField, targetField.getEnumType().findValueByName(enumValue));
} else {
builder.addRepeatedField(targetField, element);
}
Expand All @@ -283,6 +286,9 @@ public static Message deepCopyMessageIfNeeded(@Nonnull final Descriptors.Descrip
.build();
builder.setField(targetField, mergedObject);
}
} else if (field.getJavaType() == Descriptors.FieldDescriptor.JavaType.ENUM) {
final var enumValue = ((Descriptors.EnumValueDescriptor) entry.getValue()).getName();
builder.setField(targetField, targetField.getEnumType().findValueByName(enumValue));
} else {
builder.setField(targetField, entry.getValue());
}
Expand Down
10 changes: 9 additions & 1 deletion ...java/com/apple/foundationdb/record/query/plan/cascades/values/RecordConstructorValue.java
View file
Open in desktop
Expand Up @@ -35,12 +35,14 @@
import com.apple.foundationdb.record.query.plan.cascades.typing.TypeRepository;
import com.apple.foundationdb.record.query.plan.cascades.typing.Typed;
import com.google.auto.service.AutoService;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Suppliers;
import com.google.common.base.Verify;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Streams;
import com.google.protobuf.Descriptors;
import com.google.protobuf.DynamicMessage;
import com.google.protobuf.Message;

Expand Down Expand Up @@ -152,9 +154,10 @@ private DynamicMessage.Builder newMessageBuilderForType(@Nonnull TypeRepository
* @return an object that is either {@code field} if a copy could be avoided or a new copy of {@code field} whose
* constituent messages are {@link DynamicMessage}s based on dynamically-created descriptors.
*/
@VisibleForTesting
@Nullable
@SuppressWarnings("PMD.CompareObjectsWithEquals")
private Object deepCopyIfNeeded(@Nonnull TypeRepository typeRepository,
public static Object deepCopyIfNeeded(@Nonnull TypeRepository typeRepository,
g31pranjal marked this conversation as resolved.
Show resolved Hide resolved
@Nonnull final Type fieldType,
@Nullable final Object field) {
if (field == null) {
Expand All @@ -178,6 +181,11 @@ private Object deepCopyIfNeeded(@Nonnull TypeRepository typeRepository,
return resultBuilder.build();
}

if (fieldType instanceof Type.Enum) {
final var typeName = typeRepository.getProtoTypeName(fieldType);
return typeRepository.getEnumValue(typeName, ((Descriptors.EnumValueDescriptor)field).getName());
}

Verify.verify(fieldType instanceof Type.Record);
final var message = (Message)field;
final var declaredDescriptor = Verify.verifyNotNull(typeRepository.getMessageDescriptor(fieldType));
Expand Down
148 changes: 148 additions & 0 deletions .../com/apple/foundationdb/record/query/plan/cascades/values/RecordConstructorValueTest.java
View file
Open in desktop
@@ -0,0 +1,148 @@
/*
* RecordConstructorValueTest.java
*
* This source file is part of the FoundationDB open source project
*
* Copyright 2015-2022 Apple Inc. and the FoundationDB project authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/

package com.apple.foundationdb.record.query.plan.cascades.values;

import com.apple.foundationdb.record.query.plan.cascades.typing.Type;
import com.apple.foundationdb.record.query.plan.cascades.typing.TypeRepository;
import com.google.protobuf.Descriptors;
import com.google.protobuf.DynamicMessage;
import com.google.protobuf.Message;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

/**
* Test cases to test {@link RecordConstructorValue#deepCopyIfNeeded}.
*/
public class RecordConstructorValueTest {

private static final String[] suites = new String[] {"SPADES", "HEARTS", "DIAMONDS", "CLUBS"};

private static Type.Enum getCardsEnum() {
final var enumValues = new ArrayList<Type.Enum.EnumValue>();
for (var i = 0; i < suites.length; i++) {
enumValues.add(new Type.Enum.EnumValue(suites[i], i));
}
return new Type.Enum(false, enumValues, "enumType");
}

@Test
public void deepCopyMessageWithEnumTest() {
final var enumType = getCardsEnum();
var type = Type.Record.fromFieldsWithName("simpleType", false, List.of(Type.Record.Field.of(enumType, Optional.of("suit"))));
var repo = TypeRepository.newBuilder();
type.defineProtoType(repo);

final var typeRepoSrc = repo.build();
final var typeRepoTarget = repo.build();

final var typeDescriptor = typeRepoSrc.getMessageDescriptor("simpleType");
var messageBuilder = DynamicMessage.newBuilder(Objects.requireNonNull(typeDescriptor));
var enumFieldSrc = typeDescriptor.findFieldByName("suit");
messageBuilder.setField(enumFieldSrc, Objects.requireNonNull(typeRepoSrc.getEnumValue("enumType", "SPADES")));
var message = messageBuilder.build();

var copiedMessage = RecordConstructorValue.deepCopyIfNeeded(typeRepoTarget, type, message);
Assertions.assertNotNull(copiedMessage);
Assertions.assertNotSame(message, copiedMessage);
var enumFieldTargetValue = ((Message)copiedMessage).getField(Objects.requireNonNull(typeRepoTarget.getMessageDescriptor("simpleType")).findFieldByName("suit"));
Assertions.assertTrue(enumFieldTargetValue instanceof Descriptors.EnumValueDescriptor);
Assertions.assertEquals(((Descriptors.EnumValueDescriptor) message.getField(enumFieldSrc)).getName(), ((Descriptors.EnumValueDescriptor) enumFieldTargetValue).getName());
Assertions.assertNotSame(message.getField(enumFieldSrc), enumFieldTargetValue);
}

@Test
public void deepCopyEnumValueTest() {
final var enumType = getCardsEnum();
var repo = TypeRepository.newBuilder();
enumType.defineProtoType(repo);

final var typeRepoSrc = repo.build();
final var typeRepoTarget = repo.build();

final var enumValueSrc = typeRepoSrc.getEnumValue("enumType", "SPADES");

final var copied = RecordConstructorValue.deepCopyIfNeeded(typeRepoTarget, enumType, enumValueSrc);
Assertions.assertTrue(copied instanceof Descriptors.EnumValueDescriptor);
Assertions.assertEquals(enumValueSrc.getName(), ((Descriptors.EnumValueDescriptor) copied).getName());
Assertions.assertNotSame(enumValueSrc, copied);
}

@Test
public void deepCopyMessageWithRepeatedEnumValueTest() {
final var enumType = getCardsEnum();
var arrayType = new Type.Array(false, enumType);
var type = Type.Record.fromFieldsWithName("simpleType", false, List.of(Type.Record.Field.of(arrayType, Optional.of("suits"))));
var repo = TypeRepository.newBuilder();
arrayType.defineProtoType(repo);
type.defineProtoType(repo);

final var typeRepoSrc = repo.build();
final var typeRepoTarget = repo.build();

final var typeDescriptor = typeRepoSrc.getMessageDescriptor("simpleType");
var messageBuilder = DynamicMessage.newBuilder(Objects.requireNonNull(typeDescriptor));
var enumFieldSrc = typeDescriptor.findFieldByName("suits");
for (int i = suites.length - 1; i >= 0; i--) {
messageBuilder.addRepeatedField(enumFieldSrc, Objects.requireNonNull(typeRepoSrc.getEnumValue("enumType", suites[i])));
}
var message = messageBuilder.build();

var copiedMessage = RecordConstructorValue.deepCopyIfNeeded(typeRepoTarget, type, message);
Assertions.assertNotNull(copiedMessage);
var enumFieldTarget = Objects.requireNonNull(typeRepoTarget.getMessageDescriptor("simpleType")).findFieldByName("suits");
for (int i = 0; i < 4; i++) {
var enumFieldTargetValue = ((Message) copiedMessage).getRepeatedField(enumFieldTarget, i);
Assertions.assertTrue(enumFieldTargetValue instanceof Descriptors.EnumValueDescriptor);
Assertions.assertEquals(((Descriptors.EnumValueDescriptor) message.getRepeatedField(enumFieldSrc, i)).getName(), ((Descriptors.EnumValueDescriptor) enumFieldTargetValue).getName());
Assertions.assertNotSame(message.getRepeatedField(enumFieldSrc, i), enumFieldTargetValue);
}
}

@Test
public void deepCopyEnumValueArrayTest() {
final var enumType = getCardsEnum();
var arrayType = new Type.Array(false, enumType);
var repo = TypeRepository.newBuilder();
arrayType.defineProtoType(repo);

final var typeRepoSrc = repo.build();
final var typeRepoTarget = repo.build();

final var list = new ArrayList<Descriptors.EnumValueDescriptor>();
for (int i = suites.length - 1; i >= 0; i--) {
list.add(Objects.requireNonNull(typeRepoSrc.getEnumValue("enumType", suites[i])));
}

var copied = RecordConstructorValue.deepCopyIfNeeded(typeRepoTarget, arrayType, list);
Assertions.assertNotNull(copied);
for (int i = 0; i < 4; i++) {
var enumFieldTargetValue = ((List<?>) copied).get(i);
Assertions.assertTrue(enumFieldTargetValue instanceof Descriptors.EnumValueDescriptor);
Assertions.assertEquals(list.get(i).getName(), ((Descriptors.EnumValueDescriptor) enumFieldTargetValue).getName());
Assertions.assertNotSame(list.get(i), enumFieldTargetValue);
}
}
}