Export syncer return values to about:sync

chrome/browser/sync/sync_ui_util.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/sync/sync_ui_util.h"
 
 #include "base/i18n/number_formatting.h"
 #include "base/i18n/time_formatting.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
@@ skipping 631 matching lines @@
 
     // |snapshot| could be NULL if sync is not yet initialized.
     if (snapshot) {
       sync_ui_util::AddIntSyncDetail(details, "Download Count (This Session)",
           snapshot->syncer_status.num_updates_downloaded_total);
       sync_ui_util::AddIntSyncDetail(details, "Commit Count (This Session)",
           snapshot->syncer_status.num_successful_commits);
       sync_ui_util::AddStringSyncDetails(details, "Last Sync Source",
           browser_sync::GetUpdatesSourceString(
           snapshot->source.updates_source));
+      sync_ui_util::AddStringSyncDetails(

[rlarocque, 2012/02/22 22:01:52]

Note: There are two snapshot-like structures available in this function.

SyncManager::Status full_status: This is a Status struct managed by AllStatus. 
It can be fetched directly from the SyncManager from the UI thread because it is
protected by a lock.  It is always up to date with the most recently emitted
snapshot from the sycner, so it can contain information from an in-progress sync
cycle.

SyncSessionSnapshot snapshot: This snapshot is cached in the SyncBackendHost
when the syncer sends a SYNC_CYCLE_END event with !has_more_to_sync.  Such an
event is generated only when we exit the loop that invokes SyncShare(). 
Therefore, this snapshot may be a bit stale, though it should be updated just
before about:sync is told to refresh itself.  

I decided to use the snapshot to export the return values because:
- I wanted the values to be consistent with the "Last Sync Source".
- It did not require adding code to AllStatus or members to SyncManager::Status.
- I would like to eventually deprecate full_status.

[lipalani1, 2012/02/22 22:09:24]

That part is fine. But is there any value in caching this in all_status as well?
Would we be able to infer anything more based on these values?
On 2012/02/22 22:01:52, rlarocque wrote:

[rlarocque, 2012/02/22 22:22:37]

There would be some value, but I don't think it's worth it.

The only advantage to AllStatus/full_status is that it is more up to date than
the cached snapshot.  So, if for some reason the UI isn't getting pinged (ie. an
infinite loop or freeze in the syncer) we would be able to get slightly fresher
values from full_status.  

+          details, "Last Sync's GetUpdates Result",
+          GetSyncerErrorString(snapshot->errors.last_download_updates_result));
+      sync_ui_util::AddStringSyncDetails(
+          details, "Last Sync's Post Commit Result",
+          GetSyncerErrorString(snapshot->errors.last_post_commit_result));
+      sync_ui_util::AddStringSyncDetails(
+          details, "Last Sync's Process Commit Response Result",
+          GetSyncerErrorString(
+              snapshot->errors.last_process_commit_response_result));
 
       // Print the count of entries from snapshot. Warning: This might be
       // slightly out of date if there are client side changes that are yet
       // unsynced  However if we query the latest count here we will
       // have to hold the transaction which means we cannot display this page
       // when syncing.
       sync_ui_util::AddIntSyncDetail(details, "Entries" ,
                                      snapshot->num_entries);
       sync_ui_util::AddBoolSyncDetail(details, "Throttled",
                                       snapshot->is_silenced);
@@ skipping 67 matching lines @@
     }
   } else {
     version_modifier = " " + version_modifier;
   }
   return chrome_version.Name() + " " + chrome_version.OSType() + " " +
       chrome_version.Version() + " (" + chrome_version.LastChange() + ")" +
       version_modifier;
 }
 
 }  // namespace sync_ui_util