Skip to content

Implement proper bulk loads in the transaction manager #3233

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

Open
gbrodman wants to merge 1 commit into
base: master
Choose a base branch
from
+120 −38
Open

Implement proper bulk loads in the transaction manager #3233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
72 changes: 46 additions & 26 deletions core/src/main/java/google/registry/persistence/transaction/JpaTransactionManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Throwables.throwIfUnchecked;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableMap.toImmutableMap;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static google.registry.config.RegistryConfig.getHibernateAllowNestedTransactions;
import static google.registry.persistence.transaction.DatabaseException.throwIfSqlException;
import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
import static java.util.AbstractMap.SimpleEntry;
import static java.util.stream.Collectors.joining;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimaps;
import com.google.common.collect.Streams;
import com.google.common.flogger.FluentLogger;
import com.google.common.flogger.StackSize;
Expand Down Expand Up @@ -78,7 +78,6 @@
import java.util.function.UnaryOperator;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import javax.annotation.Nullable;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
Expand Down Expand Up @@ -473,23 +472,38 @@ public <T> ImmutableMap<VKey<? extends T>, T> loadByKeysIfPresent(
Iterable<? extends VKey<? extends T>> keys) {
checkArgumentNotNull(keys, "keys must be specified");
assertInTransaction();
return StreamSupport.stream(keys.spliterator(), false)
// Accept duplicate keys.
.distinct()
.map(
key ->
new SimpleEntry<VKey<? extends T>, T>(
key, detach(getEntityManager().find(key.getKind(), key.getKey()))))
.filter(entry -> entry.getValue() != null)
.collect(toImmutableMap(Map.Entry::getKey, Map.Entry::getValue));
// Group keys by entity type; T may be a common superclass with keys pointing to different
// concrete entity tables (e.g. EppResource, Domain, and Host). Session::findMultiple requires a
// single concrete entity class per call.
ImmutableListMultimap<Class<? extends T>, VKey<? extends T>> keysByObjectType =
Multimaps.index(Streams.stream(keys).distinct().collect(toImmutableList()), VKey::getKind);
ImmutableMap.Builder<VKey<? extends T>, T> builder = new ImmutableMap.Builder<>();
for (Class<? extends T> objectClass : keysByObjectType.keySet()) {
ImmutableList<VKey<? extends T>> singleObjectTypeKeys = keysByObjectType.get(objectClass);
ImmutableList<Serializable> ids =
singleObjectTypeKeys.stream().map(VKey::getKey).collect(toImmutableList());
// Note: Hibernate batches SQL queries for us if necessary under the hood
List<? extends T> entities =
getEntityManager().unwrap(Session.class).findMultiple(objectClass, ids);
// Session::findMultiple keeps the entities in the same order with null values for missing
// keys. As a result, we can zip the keys+values as a map, ignoring null values.
for (int i = 0; i < ids.size(); i++) {
T entity = entities.get(i);
if (entity != null) {
builder.put(singleObjectTypeKeys.get(i), detach(entity));
}
}
}
return builder.build();
}

@Override
public <T> ImmutableList<T> loadByEntitiesIfPresent(Iterable<T> entities) {
return Streams.stream(entities)
.filter(this::exists)
.map(this::loadByEntity)
.collect(toImmutableList());
checkArgumentNotNull(entities, "entities must be specified");
assertInTransaction();
ImmutableList<VKey<T>> keys =
Streams.stream(entities).map(this::getKeyFromEntity).collect(toImmutableList());
return loadByKeysIfPresent(keys).values().asList();
}

@Override
Expand Down Expand Up @@ -521,20 +535,16 @@ public <T> ImmutableMap<VKey<? extends T>, T> loadByKeys(
public <T> T loadByEntity(T entity) {
checkArgumentNotNull(entity, "entity must be specified");
assertInTransaction();
@SuppressWarnings("unchecked")
T returnValue =
(T)
loadByKey(
VKey.create(
entity.getClass(),
// Casting to Serializable is safe according to JPA (JSR 338 sec. 2.4).
(Serializable) emf.getPersistenceUnitUtil().getIdentifier(entity)));
return returnValue;
return loadByKey(getKeyFromEntity(entity));
}

@Override
public <T> ImmutableList<T> loadByEntities(Iterable<T> entities) {
return Streams.stream(entities).map(this::loadByEntity).collect(toImmutableList());
checkArgumentNotNull(entities, "entities must be specified");
assertInTransaction();
ImmutableList<VKey<T>> keys =
Streams.stream(entities).map(this::getKeyFromEntity).collect(toImmutableList());
return loadByKeys(keys).values().asList();
}

@Override
Expand Down Expand Up @@ -644,6 +654,16 @@ private <T> EntityType<T> getEntityType(Class<T> clazz) {
return emf.getMetamodel().entity(clazz);
}

@SuppressWarnings("unchecked")
private <T> VKey<T> getKeyFromEntity(T entity) {
checkArgumentNotNull(entity, "entity must be specified");
return (VKey<T>)
VKey.create(
entity.getClass(),
// Casting to Serializable is safe according to JPA (JSR 338 sec. 2.4).
(Serializable) emf.getPersistenceUnitUtil().getIdentifier(entity));
}

/**
* A SQL Sequence based ID allocator that generates an ID from a monotonically increasing {@link
* AtomicLong}
Expand Down
86 changes: 74 additions & 12 deletions .../src/test/java/google/registry/persistence/transaction/JpaTransactionManagerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,42 +607,104 @@
});
}

@Test
void loadByKeysIfPresent_mixedEntityTypes_succeeds() {
persistResource(theEntity);
persistResource(compoundIdEntity);
tm().transact(
() -> {
ImmutableMap<VKey<? extends ImmutableObject>, ImmutableObject> results =
tm().loadByKeysIfPresent(
ImmutableList.of(
theEntityKey,
compoundIdEntityKey,
VKey.create(TestEntity.class, "does-not-exist")));

assertThat(results)
.containsExactly(theEntityKey, theEntity, compoundIdEntityKey, compoundIdEntity);
assertDetachedFromEntityManager(results.get(theEntityKey));
assertDetachedFromEntityManager(results.get(compoundIdEntityKey));
});
}

@Test
void loadByKeys_succeeds() {
persistResource(theEntity);
persistResource(compoundIdEntity);
tm().transact(
() -> {
ImmutableMap<VKey<? extends TestEntity>, TestEntity> results =
tm().loadByKeysIfPresent(ImmutableList.of(theEntityKey));
assertThat(results).containsExactly(theEntityKey, theEntity);
ImmutableMap<VKey<? extends ImmutableObject>, ImmutableObject> results =
tm().loadByKeys(ImmutableList.of(theEntityKey, compoundIdEntityKey));
assertThat(results)
.containsExactly(theEntityKey, theEntity, compoundIdEntityKey, compoundIdEntity);
assertDetachedFromEntityManager(results.get(theEntityKey));
assertDetachedFromEntityManager(results.get(compoundIdEntityKey));
});
}

@Test
void loadByKeys_missingKey_throws() {
persistResource(theEntity);
assertThat(
assertThrows(
NoSuchElementException.class,
() ->
tm().transact(
() ->
tm().loadByKeys(
ImmutableList.of(
theEntityKey,
VKey.create(TestEntity.class, "does-not-exist"))))))
.hasMessageThat()
.contains("does-not-exist");
}

@Test
void loadByEntitiesIfPresent_succeeds() {
persistResource(theEntity);
persistResource(compoundIdEntity);
tm().transact(
() -> {
ImmutableList<TestEntity> results =
ImmutableList<ImmutableObject> results =
tm().loadByEntitiesIfPresent(
ImmutableList.of(theEntity, new TestEntity("does-not-exist", "bar")));
assertThat(results).containsExactly(theEntity);
assertDetachedFromEntityManager(results.get(0));
ImmutableList.of(
theEntity,
compoundIdEntity,
new TestEntity("does-not-exist", "bar")));
assertThat(results).containsExactly(theEntity, compoundIdEntity);
results.forEach(DatabaseHelper::assertDetachedFromEntityManager);
});
}

@Test
void loadByEntities_succeeds() {
persistResource(theEntity);
persistResource(compoundIdEntity);
tm().transact(
() -> {
ImmutableList<TestEntity> results = tm().loadByEntities(ImmutableList.of(theEntity));
assertThat(results).containsExactly(theEntity);
assertDetachedFromEntityManager(results.get(0));
ImmutableList<ImmutableObject> results =
tm().loadByEntities(ImmutableList.of(theEntity, compoundIdEntity));
assertThat(results).containsExactly(theEntity, compoundIdEntity);
results.forEach(DatabaseHelper::assertDetachedFromEntityManager);
});
}

@Test
void loadByEntities_missingEntity_throws() {
persistResource(theEntity);
assertThat(
assertThrows(
NoSuchElementException.class,
() ->
tm().transact(
() ->
tm().loadByEntities(
ImmutableList.of(
theEntity, new TestEntity("does-not-exist", "bar"))))))
.hasMessageThat()
.contains("does-not-exist");
}

@Test
void loadAll_succeeds() {
persistResources(moreEntities);
Expand Down Expand Up @@ -911,7 +973,7 @@
}
}

private static class CompoundId implements Serializable {
private static class CompoundId extends ImmutableObject implements Serializable {
String name;
int age;

Expand Down Expand Up @@ -959,7 +1021,7 @@
}
}

private static class NamedCompoundId implements Serializable {
private static class NamedCompoundId extends ImmutableObject implements Serializable {
String nameField;
int ageField;

Expand Down
Loading