From 0fab10eb28ab1e246f572302ad0e12508a196b34 Mon Sep 17 00:00:00 2001
From: zachh <zachh@google.com>
Date: Wed, 20 Dec 2017 10:57:38 -0800
Subject: Added copySubMessage method to PhoneLookup interface.

The existing way that protos are merged in CompositePhoneLookup is not correct because foo_submessage from BarDataSource may incorrectly contribute old information to the merged message.

The new copySubMessage method makes it so that each PhoneLookup is responsible for defining which submessage it is responsible for and prevents the problem.

Test: unit
PiperOrigin-RevId: 179707015
Change-Id: I566305cf64c46c698f14812d9241d166ac75a6d3
---
 java/com/android/dialer/phonelookup/PhoneLookup.java           |  6 ++++++
 .../dialer/phonelookup/composite/CompositePhoneLookup.java     | 10 ++++++++--
 java/com/android/dialer/phonelookup/cp2/Cp2PhoneLookup.java    |  6 ++++++
 3 files changed, 20 insertions(+), 2 deletions(-)

(limited to 'java/com/android/dialer/phonelookup')

diff --git a/java/com/android/dialer/phonelookup/PhoneLookup.java b/java/com/android/dialer/phonelookup/PhoneLookup.java
index eeab4dadd..bb14c1ff6 100644
--- a/java/com/android/dialer/phonelookup/PhoneLookup.java
+++ b/java/com/android/dialer/phonelookup/PhoneLookup.java
@@ -61,6 +61,12 @@ public interface PhoneLookup {
   ListenableFuture<ImmutableMap<DialerPhoneNumber, PhoneLookupInfo>> getMostRecentPhoneLookupInfo(
       ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> existingInfoMap);
 
+  /**
+   * Populates the sub-message that this {@link PhoneLookup} is responsible for by copying the
+   * sub-message value from {@code source} to {@code destination}
+   */
+  void copySubMessage(PhoneLookupInfo.Builder destination, PhoneLookupInfo source);
+
   /**
    * Called when the results of the {@link #getMostRecentPhoneLookupInfo(ImmutableMap)} have been
    * applied by the caller.
diff --git a/java/com/android/dialer/phonelookup/composite/CompositePhoneLookup.java b/java/com/android/dialer/phonelookup/composite/CompositePhoneLookup.java
index ee2244615..bb7856fff 100644
--- a/java/com/android/dialer/phonelookup/composite/CompositePhoneLookup.java
+++ b/java/com/android/dialer/phonelookup/composite/CompositePhoneLookup.java
@@ -112,14 +112,15 @@ public final class CompositePhoneLookup implements PhoneLookup {
               ImmutableMap.builder();
           for (DialerPhoneNumber dialerPhoneNumber : existingInfoMap.keySet()) {
             PhoneLookupInfo.Builder combinedInfo = PhoneLookupInfo.newBuilder();
-            for (ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> map : allMaps) {
+            for (int i = 0; i < allMaps.size(); i++) {
+              ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> map = allMaps.get(i);
               PhoneLookupInfo subInfo = map.get(dialerPhoneNumber);
               if (subInfo == null) {
                 throw new IllegalStateException(
                     "A sublookup didn't return an info for number: "
                         + LogUtil.sanitizePhoneNumber(dialerPhoneNumber.getRawInput().getNumber()));
               }
-              combinedInfo.mergeFrom(subInfo);
+              phoneLookups.get(i).copySubMessage(combinedInfo, subInfo);
             }
             combinedMap.put(dialerPhoneNumber, combinedInfo.build());
           }
@@ -128,6 +129,11 @@ public final class CompositePhoneLookup implements PhoneLookup {
         lightweightExecutorService);
   }
 
+  @Override
+  public void copySubMessage(PhoneLookupInfo.Builder destination, PhoneLookupInfo source) {
+    throw new UnsupportedOperationException();
+  }
+
   @Override
   public ListenableFuture<Void> onSuccessfulBulkUpdate() {
     List<ListenableFuture<Void>> futures = new ArrayList<>();
diff --git a/java/com/android/dialer/phonelookup/cp2/Cp2PhoneLookup.java b/java/com/android/dialer/phonelookup/cp2/Cp2PhoneLookup.java
index b31d0e72e..4261b763a 100644
--- a/java/com/android/dialer/phonelookup/cp2/Cp2PhoneLookup.java
+++ b/java/com/android/dialer/phonelookup/cp2/Cp2PhoneLookup.java
@@ -131,6 +131,7 @@ public final class Cp2PhoneLookup implements PhoneLookup {
 
   private boolean isDirtyInternal(ImmutableSet<DialerPhoneNumber> phoneNumbers) {
     long lastModified = sharedPreferences.getLong(PREF_LAST_TIMESTAMP_PROCESSED, 0L);
+    // TODO(zachh): If a number got disassociated with a contact; the contactIds will be empty.
     return contactsUpdated(queryPhoneTableForContactIds(phoneNumbers), lastModified)
         || contactsDeleted(lastModified);
   }
@@ -253,6 +254,11 @@ public final class Cp2PhoneLookup implements PhoneLookup {
         () -> getMostRecentPhoneLookupInfoInternal(existingInfoMap));
   }
 
+  @Override
+  public void copySubMessage(PhoneLookupInfo.Builder destination, PhoneLookupInfo source) {
+    destination.setCp2Info(source.getCp2Info());
+  }
+
   private ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> getMostRecentPhoneLookupInfoInternal(
       ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> existingInfoMap) {
     currentLastTimestampProcessed = null;
-- 
cgit v1.2.3