sync: make scheduling logic and job ownership more obvious.

sync/engine/sync_scheduler_whitebox_unittest.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 "base/message_loop.h"
 #include "base/time.h"
 #include "sync/engine/backoff_delay_provider.h"
 #include "sync/engine/sync_scheduler_impl.h"
 #include "sync/engine/throttled_data_type_tracker.h"
 #include "sync/internal_api/public/engine/polling_constants.h"
@@ skipping 74 matching lines @@
        new SyncSchedulerImpl::WaitInterval(
        SyncSchedulerImpl::WaitInterval::EXPONENTIAL_BACKOFF,
        TimeDelta::FromSeconds(1)));
   }
 
   void SetWaitIntervalHadNudge(bool had_nudge) {
     scheduler_->wait_interval_->had_nudge = had_nudge;
   }
 
   SyncSchedulerImpl::JobProcessDecision DecideOnJob(
-      const SyncSchedulerImpl::SyncSessionJob& job) {
-    return scheduler_->DecideOnJob(job);
+      const SyncSessionJob* job) {

[akalin, 2012/10/26 06:52:29]

const ref please

+    return scheduler_->DecideOnJob(*job);
   }
 
   void InitializeSyncerOnNormalMode() {
     SetMode(SyncScheduler::NORMAL_MODE);
     ResetWaitInterval();
   }
 
   SyncSchedulerImpl::JobProcessDecision CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::SyncSessionJobPurpose purpose) {
-    SyncSession* s = scheduler_->CreateSyncSession(SyncSourceInfo());
-    SyncSchedulerImpl::SyncSessionJob job(purpose, TimeTicks::Now(),
-         make_linked_ptr(s),
-         false,
-         ConfigurationParams(),
-         FROM_HERE);
-    return DecideOnJob(job);
+      SyncSessionJob::Purpose purpose) {
+    scoped_ptr<SyncSession> s(scheduler_->CreateSyncSession(SyncSourceInfo()));
+    SyncSessionJob job(purpose, TimeTicks::Now(), s.Pass(),
+        ConfigurationParams(), FROM_HERE);
+    return DecideOnJob(&job);
   }
 
   SyncSessionContext* context() { return context_.get(); }
 
  private:
   MessageLoop message_loop_;
   scoped_ptr<MockConnectionManager> connection_;
   scoped_ptr<SyncSessionContext> context_;
   std::vector<scoped_refptr<FakeModelWorker> > workers_;
   FakeExtensionsActivityMonitor extensions_activity_monitor_;
   scoped_ptr<ThrottledDataTypeTracker> throttled_data_type_tracker_;
   TestDirectorySetterUpper dir_maker_;
 
  protected:
   // Declared here to ensure it is destructed before the objects it references.
   scoped_ptr<SyncSchedulerImpl> scheduler_;
 };
 
 TEST_F(SyncSchedulerWhiteboxTest, SaveNudge) {
   InitializeSyncerOnNormalMode();
 
   // Now set the mode to configure.
   SetMode(SyncScheduler::CONFIGURATION_MODE);
 
   SyncSchedulerImpl::JobProcessDecision decision =
-      CreateAndDecideJob(SyncSchedulerImpl::SyncSessionJob::NUDGE);
+      CreateAndDecideJob(SyncSessionJob::NUDGE);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::SAVE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, SaveNudgeWhileTypeThrottled) {
   InitializeSyncerOnNormalMode();
 
   const ModelTypeSet types(BOOKMARKS);
 
   // Mark bookmarks as throttled.
   context()->throttled_data_type_tracker()->SetUnthrottleTime(
       types, base::TimeTicks::Now() + base::TimeDelta::FromHours(2));
 
   const ModelTypeInvalidationMap& invalidation_map =
       ModelTypeSetToInvalidationMap(types, std::string());
 
   SyncSourceInfo info(GetUpdatesCallerInfo::LOCAL, invalidation_map);
-  SyncSession* s = scheduler_->CreateSyncSession(info);
+  scoped_ptr<SyncSession> s(scheduler_->CreateSyncSession(info));
 
   // Now schedule a nudge with just bookmarks and the change is local.
-  SyncSchedulerImpl::SyncSessionJob job(
-        SyncSchedulerImpl::SyncSessionJob::NUDGE,
-        TimeTicks::Now(),
-        make_linked_ptr(s),
-        false,
-        ConfigurationParams(),
-        FROM_HERE);
-
-  SyncSchedulerImpl::JobProcessDecision decision = DecideOnJob(job);
+  SyncSessionJob job(SyncSessionJob::NUDGE,
+                     TimeTicks::Now(),
+                     s.Pass(),
+                     ConfigurationParams(),
+                     FROM_HERE);
+  SyncSchedulerImpl::JobProcessDecision decision = DecideOnJob(&job);
   EXPECT_EQ(decision, SyncSchedulerImpl::SAVE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, ContinueNudge) {
   InitializeSyncerOnNormalMode();
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::NUDGE);
+      SyncSessionJob::NUDGE);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::CONTINUE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, DropPoll) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::CONFIGURATION_MODE);
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::POLL);
+      SyncSessionJob::POLL);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::DROP);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, ContinuePoll) {
   InitializeSyncerOnNormalMode();
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::POLL);
+      SyncSessionJob::POLL);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::CONTINUE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, ContinueConfiguration) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::CONFIGURATION_MODE);
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::CONFIGURATION);
+      SyncSessionJob::CONFIGURATION);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::CONTINUE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, SaveConfigurationWhileThrottled) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::CONFIGURATION_MODE);
 
   SetWaitIntervalToThrottled();
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::CONFIGURATION);
+      SyncSessionJob::CONFIGURATION);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::SAVE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, SaveNudgeWhileThrottled) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::CONFIGURATION_MODE);
 
   SetWaitIntervalToThrottled();
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::NUDGE);
+      SyncSessionJob::NUDGE);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::SAVE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, ContinueNudgeWhileExponentialBackOff) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::NORMAL_MODE);
   SetWaitIntervalToExponentialBackoff();
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::NUDGE);
+      SyncSessionJob::NUDGE);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::CONTINUE);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, DropNudgeWhileExponentialBackOff) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::NORMAL_MODE);
   SetWaitIntervalToExponentialBackoff();
   SetWaitIntervalHadNudge(true);
 
   SyncSchedulerImpl::JobProcessDecision decision = CreateAndDecideJob(
-      SyncSchedulerImpl::SyncSessionJob::NUDGE);
+      SyncSessionJob::NUDGE);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::DROP);
 }
 
 TEST_F(SyncSchedulerWhiteboxTest, ContinueCanaryJobConfig) {
   InitializeSyncerOnNormalMode();
   SetMode(SyncScheduler::CONFIGURATION_MODE);
   SetWaitIntervalToExponentialBackoff();
 
-  struct SyncSchedulerImpl::SyncSessionJob job;
-  job.purpose = SyncSchedulerImpl::SyncSessionJob::CONFIGURATION;
-  job.scheduled_start = TimeTicks::Now();
-  job.is_canary_job = true;
-  SyncSchedulerImpl::JobProcessDecision decision = DecideOnJob(job);
+  SyncSessionJob job(SyncSessionJob::CONFIGURATION,
+                     TimeTicks::Now(), scoped_ptr<SyncSession>(),
+                     ConfigurationParams(), FROM_HERE);
+
+  job.GrantCanaryPrivilege();
+  SyncSchedulerImpl::JobProcessDecision decision = DecideOnJob(&job);
 
   EXPECT_EQ(decision, SyncSchedulerImpl::CONTINUE);
 }
 
 }  // namespace syncer