Enrich fileBrowserPrivate.onFileTransfersUpdated event to support displaying total number of jobs.

chrome/browser/chromeos/extensions/file_manager/event_router.cc

 // Copyright 2014 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/chromeos/extensions/file_manager/event_router.h"
 
 #include "base/bind.h"
 #include "base/files/file_util.h"
 #include "base/message_loop/message_loop.h"
 #include "base/prefs/pref_change_registrar.h"
 #include "base/prefs/pref_service.h"
 #include "base/stl_util.h"
+#include "base/thread_task_runner_handle.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "base/values.h"
 #include "chrome/browser/app_mode/app_mode_utils.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/chromeos/drive/drive_integration_service.h"
 #include "chrome/browser/chromeos/drive/file_change.h"
 #include "chrome/browser/chromeos/drive/file_system_interface.h"
 #include "chrome/browser/chromeos/drive/file_system_util.h"
 #include "chrome/browser/chromeos/extensions/file_manager/device_event_router.h"
 #include "chrome/browser/chromeos/extensions/file_manager/private_api_util.h"
@@ skipping 31 matching lines @@
 using drive::DriveIntegrationService;
 using drive::DriveIntegrationServiceFactory;
 using file_manager::util::EntryDefinition;
 using file_manager::util::FileDefinition;
 
 namespace file_browser_private = extensions::api::file_browser_private;
 
 namespace file_manager {
 namespace {
 // Constants for the "transferState" field of onFileTransferUpdated event.
+const char kFileTransferStateAdded[] = "added";
 const char kFileTransferStateStarted[] = "started";
 const char kFileTransferStateInProgress[] = "in_progress";
 const char kFileTransferStateCompleted[] = "completed";
 const char kFileTransferStateFailed[] = "failed";
 
 // Frequency of sending onFileTransferUpdated.
 const int64 kProgressEventFrequencyInMilliseconds = 1000;
 
 // Maximim size of detailed change info on directory change event. If the size
 // exceeds the maximum size, the detailed info is omitted and the force refresh
@@ skipping 17 matching lines @@
 
   scoped_ptr<base::DictionaryValue> result(new base::DictionaryValue);
   GURL url = util::ConvertDrivePathToFileSystemUrl(
       profile, job_info.file_path, extension_id);
   status->file_url = url.spec();
   status->transfer_state = file_browser_private::ParseTransferState(job_status);
   status->transfer_type =
       IsUploadJob(job_info.job_type) ?
       file_browser_private::TRANSFER_TYPE_UPLOAD :
       file_browser_private::TRANSFER_TYPE_DOWNLOAD;
+  status->num_total_jobs = job_info.num_total_jobs;
   // JavaScript does not have 64-bit integers. Instead we use double, which
   // is in IEEE 754 formant and accurate up to 52-bits in JS, and in practice
   // in C++. Larger values are rounded.
   status->processed.reset(
       new double(static_cast<double>(job_info.num_completed_bytes)));
   status->total.reset(
       new double(static_cast<double>(job_info.num_total_bytes)));
 }
 
 // Checks if the Recovery Tool is running. This is a temporary solution.
@@ skipping 247 matching lines @@
 EventRouter::DriveJobInfoWithStatus::DriveJobInfoWithStatus()
     : job_info(drive::TYPE_DOWNLOAD_FILE) {
 }
 
 EventRouter::DriveJobInfoWithStatus::DriveJobInfoWithStatus(
     const drive::JobInfo& info, const std::string& status)
     : job_info(info), status(status) {
 }
 
 EventRouter::EventRouter(Profile* profile)
-    : pref_change_registrar_(new PrefChangeRegistrar),
+    : delay_time_(base::TimeDelta::FromMilliseconds(100)),
+      force_send_time_(base::TimeDelta::FromMilliseconds(1000)),
+      pref_change_registrar_(new PrefChangeRegistrar),
       profile_(profile),
       multi_user_window_manager_observer_registered_(false),
       device_event_router_(new DeviceEventRouterImpl(profile)),
       weak_factory_(this) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 }
 
 EventRouter::~EventRouter() {
 }
 
@@ skipping 234 matching lines @@
   }
 
   BroadcastEvent(
       profile_,
       file_browser_private::OnPreferencesChanged::kEventName,
       file_browser_private::OnPreferencesChanged::Create());
 }
 
 void EventRouter::OnJobAdded(const drive::JobInfo& job_info) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-  OnJobUpdated(job_info);
+  if (!drive::IsActiveFileTransferJobInfo(job_info))
+    return;
+  const DriveJobInfoWithStatus job_info_with_status =
+      DriveJobInfoWithStatus(job_info, kFileTransferStateAdded);
+  SendDriveFileTransferEvent(
+      job_info_with_status, base::Time::Now(), true /* should_delay */);
 }
 
 void EventRouter::OnJobUpdated(const drive::JobInfo& job_info) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (!drive::IsActiveFileTransferJobInfo(job_info))
     return;
 
   bool is_new_job = (drive_jobs_.find(job_info.job_id) == drive_jobs_.end());
 
   // Replace with the latest job info.
   drive_jobs_[job_info.job_id] = DriveJobInfoWithStatus(
       job_info,
       is_new_job ? kFileTransferStateStarted : kFileTransferStateInProgress);
 
-  // Fire event if needed.
-  bool always = is_new_job;
-  SendDriveFileTransferEvent(always);
+  const DriveJobInfoWithStatus job_info_with_status =
+      drive_jobs_[job_info.job_id];
+  SendDriveFileTransferEvent(
+      job_info_with_status, base::Time::Now(), true /* should_delay */);
 }
 
 void EventRouter::OnJobDone(const drive::JobInfo& job_info,
                             drive::FileError error) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (!drive::IsActiveFileTransferJobInfo(job_info))
     return;
 
   // Replace with the latest job info.
   drive_jobs_[job_info.job_id] = DriveJobInfoWithStatus(
       job_info,
       error == drive::FILE_ERROR_OK ? kFileTransferStateCompleted
       : kFileTransferStateFailed);
 
-  // Fire event if needed.
-  bool always = true;
-  SendDriveFileTransferEvent(always);
+  const DriveJobInfoWithStatus job_info_with_status =
+      drive_jobs_[job_info.job_id];
+  base::Time now = base::Time::Now();
+  last_post_delayed_task_ = now;
+  SendDriveFileTransferEvent(
+      job_info_with_status, now, false /* should_delay */);
 
   // Forget about the job.
   drive_jobs_.erase(job_info.job_id);
 }
 
-void EventRouter::SendDriveFileTransferEvent(bool always) {
+void EventRouter::SendDriveFileTransferEvent(
+    const DriveJobInfoWithStatus& job_info_with_status,
+    base::Time call_time,
+    bool should_delay) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));

[hirono, 2014/08/29 11:50:46]

How about doing this?

ScheduleEvent(Event event, bool immediate) {
  // Update next send time.
  Time now = Now();
  if (immediate) {
    nextSendTime = now;
  else if (event_ == NULL)
    nextSendTime = Math.max(now + 100ms, nextSendTime);

  // Update the latest event.
  event_ = event;

  // Schedule event.
  TimeDelta delta = nextSendTime - now;
  if (delta <= 0)
    SendEvent();
  else
    PostDelayedTask(..., SendEvent, delta);
}

SendEvent() {
  Time now = Now();
  if (now < nextSendTime_ || event_ == null)
    return;
  Dispatch(event_);
  event_ = null;
  nextSendTime = now + 1000ms.
}

[iseki, 2014/09/01 02:24:47]

Done.

 
-  // When |always| flag is not set, we don't send the event until certain
-  // amount of time passes after the previous one. This is to avoid
-  // flooding the IPC between extensions by many onFileTransferUpdated events.
-  if (!ShouldSendProgressEvent(always, &last_file_transfer_event_))
+  if (should_delay) {
+    last_post_delayed_task_ = base::Time::Now();
+    if (first_delay_task_.is_null() || first_delay_task_.is_max())
+      first_delay_task_ = base::Time::Now();
+    base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
+        FROM_HERE,
+        base::Bind(&EventRouter::SendDriveFileTransferEvent,
+                   weak_factory_.GetWeakPtr(),
+                   job_info_with_status,
+                   last_post_delayed_task_,
+                   false /* should_delay */),
+        delay_time_);
     return;
+  }
+
+  if (!last_post_delayed_task_.is_null() && !first_delay_task_.is_null() &&
+      call_time < last_post_delayed_task_ &&
+      call_time < first_delay_task_ + force_send_time_) {
+    return;
+  }
+
+  first_delay_task_ = base::Time::Max();
 
   // Convert the current |drive_jobs_| to IDL type.
   std::vector<linked_ptr<file_browser_private::FileTransferStatus> >
       status_list;
-  for (std::map<drive::JobID, DriveJobInfoWithStatus>::iterator
-           iter = drive_jobs_.begin(); iter != drive_jobs_.end(); ++iter) {
-    linked_ptr<file_browser_private::FileTransferStatus> status(
-        new file_browser_private::FileTransferStatus());
-    JobInfoToTransferStatus(profile_,
-                            kFileManagerAppId,
-                            iter->second.status,
-                            iter->second.job_info,
-                            status.get());
-    status_list.push_back(status);
-  }
+
+  linked_ptr<file_browser_private::FileTransferStatus> status(
+      new file_browser_private::FileTransferStatus());
+  JobInfoToTransferStatus(profile_,
+                          kFileManagerAppId,
+                          job_info_with_status.status,
+                          job_info_with_status.job_info,
+                          status.get());
+  status_list.push_back(status);
+
   BroadcastEvent(
       profile_,
       file_browser_private::OnFileTransfersUpdated::kEventName,
       file_browser_private::OnFileTransfersUpdated::Create(status_list));
 }
 
 void EventRouter::OnDirectoryChanged(const base::FilePath& drive_path) {
   HandleFileWatchNotification(NULL, drive_path, false);
 }
 
@@ skipping 270 matching lines @@
   }
 }
 
 void EventRouter::OnOwnerEntryChanged(aura::Window* window) {
   BroadcastEvent(profile_,
                  file_browser_private::OnDesktopChanged::kEventName,
                  file_browser_private::OnDesktopChanged::Create());
 }
 
 }  // namespace file_manager