Fix entry-overwriting bug in PremiumList.saveAndUpdateEntries()

The saveAndUpdateEntries() method was always saving entries under the current entity's revisionKey, and then always deleting them under the old entity's revisionKey - even if the revisionKeys were the same (i.e., we didn't change any entry content in the list, in which case the builder's build() method doesn't create a new revisionKey).

This would have caused the existing entries to be unnecessarily resaved, and (worse) then caused those same existing entries to all be deleted.

This fixes the bug by only resaving entries when the revisionKey has changed.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=124873871
This commit is contained in:
nickfelt 2016-06-14 13:18:47 -07:00 committed by Ben McIlwain
parent 45747fd792
commit 6466ad51f6
2 changed files with 51 additions and 10 deletions

View file

@ -266,7 +266,13 @@ public final class PremiumList extends BaseDomainLabelList<Money, PremiumList.Pr
*/
public PremiumList saveAndUpdateEntries() {
final Optional<PremiumList> oldPremiumList = get(name);
// Save the new child entities in a series of transactions.
// Only update entries if there's actually a new revision of the list to save (which there will
// be if the list content changes, vs just the description/metadata).
boolean entriesToUpdate =
!oldPremiumList.isPresent()
|| !Objects.equals(oldPremiumList.get().revisionKey, this.revisionKey);
// If needed, save the new child entities in a series of transactions.
if (entriesToUpdate) {
for (final List<PremiumListEntry> batch
: partition(premiumListMap.values(), TRANSACTION_BATCH_SIZE)) {
ofy().transactNew(new VoidWork() {
@ -275,6 +281,7 @@ public final class PremiumList extends BaseDomainLabelList<Money, PremiumList.Pr
ofy().save().entities(batch);
}});
}
}
// Save the new PremiumList itself.
PremiumList updated = ofy().transactNew(new Work<PremiumList>() {
@Override
@ -296,8 +303,8 @@ public final class PremiumList extends BaseDomainLabelList<Money, PremiumList.Pr
}});
// Update the cache.
PremiumList.cache.put(name, updated);
// Delete the entities under the old PremiumList, if any.
if (oldPremiumList.isPresent()) {
// If needed and there are any, delete the entities under the old PremiumList.
if (entriesToUpdate && oldPremiumList.isPresent()) {
oldPremiumList.get().deleteEntries();
}
return updated;

View file

@ -179,6 +179,40 @@ public class PremiumListTest {
assertThat(entry.label).isEqualTo("lol");
}
@Test
public void test_saveAndUpdateEntries_twiceOnUnchangedList() throws Exception {
PremiumList pl =
new PremiumList.Builder()
.setName("pl")
.setPremiumListMapFromLines(ImmutableList.of("test,USD 1"))
.build()
.saveAndUpdateEntries();
Map<String, PremiumListEntry> entries = pl.getPremiumListEntries();
assertThat(entries.keySet()).containsExactly("test");
assertThat(PremiumList.get("pl").get().getPremiumListEntries()).isEqualTo(entries);
// Save again with no changes, and clear the cache to force a re-load from datastore.
pl.saveAndUpdateEntries();
ofy().clearSessionCache();
assertThat(PremiumList.get("pl").get().getPremiumListEntries()).isEqualTo(entries);
}
@Test
public void test_saveAndUpdateEntries_twiceOnListWithOnlyMetadataChanges() throws Exception {
PremiumList pl =
new PremiumList.Builder()
.setName("pl")
.setPremiumListMapFromLines(ImmutableList.of("test,USD 1"))
.build()
.saveAndUpdateEntries();
Map<String, PremiumListEntry> entries = pl.getPremiumListEntries();
assertThat(entries.keySet()).containsExactly("test");
assertThat(PremiumList.get("pl").get().getPremiumListEntries()).isEqualTo(entries);
// Save again with description changed, and clear the cache to force a re-load from datastore.
pl.asBuilder().setDescription("foobar").build().saveAndUpdateEntries();
ofy().clearSessionCache();
assertThat(PremiumList.get("pl").get().getPremiumListEntries()).isEqualTo(entries);
}
@Test
public void testDelete() throws Exception {
persistPremiumList("gtld1", "trombone,USD 10");