[Sync] Prevent uploading throttled datatypes.

chrome/browser/sync/sessions/sync_session_context.h

 // Copyright (c) 2011 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.
 
 // SyncSessionContext encapsulates the contextual information and engine
 // components specific to a SyncSession. A context is accessible via
 // a SyncSession so that session SyncerCommands and parts of the engine have
 // a convenient way to access other parts. In this way it can be thought of as
 // the surrounding environment for the SyncSession. The components of this
 // environment are either valid or not valid for the entire context lifetime,
 // or they are valid for explicitly scoped periods of time by using Scoped
 // installation utilities found below. This means that the context assumes no
 // ownership whatsoever of any object that was not created by the context
 // itself.
 //
 // It can only be used from the SyncerThread.
 
 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_
 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_
 #pragma once
 
 #include <map>
 #include <string>
 
+#include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time.h"
 #include "chrome/browser/sync/engine/model_safe_worker.h"
 #include "chrome/browser/sync/engine/syncer_types.h"
 #include "chrome/browser/sync/sessions/debug_info_getter.h"
 
 namespace syncable {
 class DirectoryManager;
 }
 
 namespace browser_sync {
 
 class ConflictResolver;
 class ExtensionsActivityMonitor;
 class ModelSafeWorkerRegistrar;
 class ServerConnectionManager;
 
 // Default number of items a client can commit in a single message.
 static const int kDefaultMaxCommitBatchSize = 25;
 
 namespace sessions {
 class ScopedSessionContextConflictResolver;
+class SyncSessionContextTest;

[akalin, 2011/11/23 03:44:33]

there's actually no need to forward-declare for FRIEND_TEST

 struct SyncSessionSnapshot;
 class TestScopedSessionEventListener;
 
 class SyncSessionContext {
  public:
   SyncSessionContext(ServerConnectionManager* connection_manager,
                      syncable::DirectoryManager* directory_manager,
                      ModelSafeWorkerRegistrar* model_safe_worker_registrar,
                      const std::vector<SyncEngineEventListener*>& listeners,
                      DebugInfoGetter* debug_info_getter);
@@ skipping 45 matching lines @@
   void set_previous_session_routing_info(const ModelSafeRoutingInfo& info) {
     previous_session_routing_info_ = info;
   }
 
   void NotifyListeners(const SyncEngineEvent& event) {
     FOR_EACH_OBSERVER(SyncEngineEventListener, listeners_,
                       OnSyncEngineEvent(event));
   }
 
   // This is virtual for unit tests.
-  // TODO(lipalani)  Consult the unthrottle times before committing data to
-  // the server.
   virtual void SetUnthrottleTime(const syncable::ModelTypeSet& types,
                                  const base::TimeTicks& time);
 
+  void UpdateThrottledTypes(const base::TimeTicks& time);

[akalin, 2011/11/23 03:44:33]

maybe a better name would be: "PruneUnthrottledTypes"

Add a comment explaining what it does, and that it's called only at the start of
a sync cycle.

+  syncable::ModelTypeSet GetThrottledTypes() const;

[akalin, 2011/11/23 03:44:33]

Add comment explaining what this does, and that it stays constant throughout the
whole sync cycle.

+
  private:
   typedef std::map<syncable::ModelType, base::TimeTicks> UnthrottleTimes;
 
+  FRIEND_TEST_ALL_PREFIXES(SyncSessionContextTest, AddUnthrottleTimeTest);
+  FRIEND_TEST_ALL_PREFIXES(SyncSessionContextTest,
+                           GetCurrentlyThrottledTypesTest);
+
   // Rather than force clients to set and null-out various context members, we
   // extend our encapsulation boundary to scoped helpers that take care of this
   // once they are allocated. See definitions of these below.
   friend class ScopedSessionContextConflictResolver;
   friend class TestScopedSessionEventListener;
 
   // This is installed by Syncer objects when needed and may be NULL.
   ConflictResolver* resolver_;
 
   ObserverList<SyncEngineEventListener> listeners_;
@@ skipping 56 matching lines @@
  private:
   SyncSessionContext* context_;
   ConflictResolver* resolver_;
   DISALLOW_COPY_AND_ASSIGN(ScopedSessionContextConflictResolver);
 };
 
 }  // namespace sessions
 }  // namespace browser_sync
 
 #endif  // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_