The Tor Browser: mobile/android/base/background/healthreport/upload/ObsoleteDocumentTracker.java@fc2d59ddac77 (annotated)

mobile/android/base/background/healthreport/upload/ObsoleteDocumentTracker.java@fc2d59ddac77 (annotated)

mobile/android/base/background/healthreport/upload/ObsoleteDocumentTracker.java

Wed, 31 Dec 2014 07:22:50 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 07:22:50 +0100
branch: TOR_BUG_3246
changeset 4: fc2d59ddac77
permissions: -rw-r--r--

Correct previous dual key logic pending first delivery installment.

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 package org.mozilla.gecko.background.healthreport.upload;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map.Entry;
 import java.util.Set;
 import org.mozilla.gecko.background.common.log.Logger;
 import org.mozilla.gecko.background.healthreport.HealthReportConstants;
 import org.mozilla.gecko.sync.ExtendedJSONObject;
 import android.content.SharedPreferences;
 public class ObsoleteDocumentTracker {
   public static final String LOG_TAG = ObsoleteDocumentTracker.class.getSimpleName();
   protected final SharedPreferences sharedPrefs;
   public ObsoleteDocumentTracker(SharedPreferences sharedPrefs) {
     this.sharedPrefs = sharedPrefs;
   }
   protected ExtendedJSONObject getObsoleteIds() {
     String s = sharedPrefs.getString(HealthReportConstants.PREF_OBSOLETE_DOCUMENT_IDS_TO_DELETION_ATTEMPTS_REMAINING, null);
     if (s == null) {
       // It's possible we're migrating an old profile forward.
       String lastId = sharedPrefs.getString(HealthReportConstants.PREF_LAST_UPLOAD_DOCUMENT_ID, null);
       if (lastId == null) {
         return new ExtendedJSONObject();
       }
       ExtendedJSONObject ids = new ExtendedJSONObject();
       ids.put(lastId, HealthReportConstants.DELETION_ATTEMPTS_PER_OBSOLETE_DOCUMENT_ID);
       setObsoleteIds(ids);
       return ids;
     }
     try {
       return ExtendedJSONObject.parseJSONObject(s);
     } catch (Exception e) {
       Logger.warn(LOG_TAG, "Got exception getting obsolete ids.", e);
       return new ExtendedJSONObject();
     }
   }
   /**
    * Write obsolete ids to disk.
    *
    * @param ids to write.
    */
   protected void setObsoleteIds(ExtendedJSONObject ids) {
     sharedPrefs
       .edit()
       .putString(HealthReportConstants.PREF_OBSOLETE_DOCUMENT_IDS_TO_DELETION_ATTEMPTS_REMAINING, ids.toString())
       .commit();
   }
   /**
    * Remove id from set of obsolete document ids tracked for deletion.
    *
    * Public for testing.
    *
    * @param id to stop tracking.
    */
   public void removeObsoleteId(String id) {
     ExtendedJSONObject ids = getObsoleteIds();
     ids.remove(id);
     setObsoleteIds(ids);
   }
   protected void decrementObsoleteId(ExtendedJSONObject ids, String id) {
     if (!ids.containsKey(id)) {
       return;
     }
     try {
       Long attempts = ids.getLong(id);
       if (attempts == null || --attempts < 1) {
         ids.remove(id);
       } else {
         ids.put(id, attempts);
       }
     } catch (ClassCastException e) {
       ids.remove(id);
       Logger.info(LOG_TAG, "Got exception decrementing obsolete ids counter.", e);
     }
   }
   /**
    * Decrement attempts remaining for id in set of obsolete document ids tracked
    * for deletion.
    *
    * Public for testing.
    *
    * @param id to decrement attempts.
    */
   public void decrementObsoleteIdAttempts(String id) {
     ExtendedJSONObject ids = getObsoleteIds();
     decrementObsoleteId(ids, id);
     setObsoleteIds(ids);
   }
   public void purgeObsoleteIds(Collection<String> oldIds) {
     ExtendedJSONObject ids = getObsoleteIds();
     for (String oldId : oldIds) {
       ids.remove(oldId);
     }
     setObsoleteIds(ids);
   }
   public void decrementObsoleteIdAttempts(Collection<String> oldIds) {
     ExtendedJSONObject ids = getObsoleteIds();
     for (String oldId : oldIds) {
       decrementObsoleteId(ids, oldId);
     }
     setObsoleteIds(ids);
   }
   /**
    * Sort Longs in decreasing order, moving null and non-Longs to the front.
    *
    * Public for testing only.
    */
   public static class PairComparator implements Comparator<Entry<String, Object>> {
     @Override
     public int compare(Entry<String, Object> lhs, Entry<String, Object> rhs) {
       Object l = lhs.getValue();
       Object r = rhs.getValue();
       if (l == null || !(l instanceof Long)) {
         if (r == null || !(r instanceof Long)) {
           return 0;
         }
         return -1;
       }
       if (r == null || !(r instanceof Long)) {
         return 1;
       }
       return ((Long) r).compareTo((Long) l);
     }
   }
   /**
    * Return a batch of obsolete document IDs that should be deleted next.
    *
    * Document IDs are long and sending too many in a single request might
    * increase the likelihood of POST failures, so we delete a (deterministic)
    * subset here.
    *
    * @return a non-null collection.
    */
   public Collection<String> getBatchOfObsoleteIds() {
     ExtendedJSONObject ids = getObsoleteIds();
     // Sort by increasing order of key values.
     List<Entry<String, Object>> pairs = new ArrayList<Entry<String,Object>>(ids.entrySet());
     Collections.sort(pairs, new PairComparator());
     List<String> batch = new ArrayList<String>(HealthReportConstants.MAXIMUM_DELETIONS_PER_POST);
     int i = 0;
     while (batch.size() < HealthReportConstants.MAXIMUM_DELETIONS_PER_POST && i < pairs.size()) {
       batch.add(pairs.get(i++).getKey());
     }
     return batch;
   }
   /**
    * Track the given document ID for eventual obsolescence and deletion.
    * Obsolete IDs are not known to have been uploaded to the server, so we just
    * give a best effort attempt at deleting them
    *
    * @param id to eventually delete.
    */
   public void addObsoleteId(String id) {
     ExtendedJSONObject ids = getObsoleteIds();
     if (ids.size() >= HealthReportConstants.MAXIMUM_STORED_OBSOLETE_DOCUMENT_IDS) {
       // Remove the one that's been tried the most and is least likely to be
       // known to be on the server. Since the comparator orders in decreasing
       // order, we take the max.
       ids.remove(Collections.max(ids.entrySet(), new PairComparator()).getKey());
     }
     ids.put(id, HealthReportConstants.DELETION_ATTEMPTS_PER_OBSOLETE_DOCUMENT_ID);
     setObsoleteIds(ids);
   }
   /**
    * Track the given document ID for eventual obsolescence and deletion, and
    * give it priority since we know this ID has made it to the server, and we
    * definitely don't want to orphan it.
    *
    * @param id to eventually delete.
    */
   public void markIdAsUploaded(String id) {
     ExtendedJSONObject ids = getObsoleteIds();
     ids.put(id, HealthReportConstants.DELETION_ATTEMPTS_PER_KNOWN_TO_BE_ON_SERVER_DOCUMENT_ID);
     setObsoleteIds(ids);
   }
   public boolean hasObsoleteIds() {
     return getObsoleteIds().size() > 0;
   }
   public int numberOfObsoleteIds() {
     return getObsoleteIds().size();
   }
   public String getNextObsoleteId() {
     ExtendedJSONObject ids = getObsoleteIds();
     if (ids.size() < 1) {
       return null;
     }
     try {
       // Delete the one that's most likely to be known to be on the server, and
       // that's not been tried as much. Since the comparator orders in
       // decreasing order, we take the min.
       return Collections.min(ids.entrySet(), new PairComparator()).getKey();
     } catch (Exception e) {
       Logger.warn(LOG_TAG, "Got exception picking obsolete id to delete.", e);
       return null;
     }
   }
   /**
    * We want cleaning up documents on the server to be best effort. Purge badly
    * formed IDs and cap the number of times we try to delete so that the queue
    * doesn't take too long.
    */
   public void limitObsoleteIds() {
     ExtendedJSONObject ids = getObsoleteIds();
     Set<String> keys = new HashSet<String>(ids.keySet()); // Avoid invalidating an iterator.
     for (String key : keys) {
       Object o = ids.get(key);
       if (!(o instanceof Long)) {
         continue;
       }
       if (((Long) o).longValue() > HealthReportConstants.DELETION_ATTEMPTS_PER_OBSOLETE_DOCUMENT_ID) {
         ids.put(key, HealthReportConstants.DELETION_ATTEMPTS_PER_OBSOLETE_DOCUMENT_ID);
       }
     }
     setObsoleteIds(ids);
   }
 }

The Tor Browser / annotate

mobile/android/base/background/healthreport/upload/ObsoleteDocumentTracker.java@fc2d59ddac77 (annotated)

mobile/android/base/background/healthreport/upload/ObsoleteDocumentTracker.java