src/components/feedback/feedback_uploader.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_
   6 #define COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_
   7
   8 #include <queue>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/file_util.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/time/time.h"
  16 #include "base/timer/timer.h"
  17
  18 namespace feedback {
  19
  20 typedef base::Callback<void(const std::string&)> ReportDataCallback;
  21
  22 class FeedbackReport;
  23
  24 // FeedbackUploader is used to add a feedback report to the queue of reports
  25 // being uploaded. In case uploading a report fails, it is written to disk and
  26 // tried again when it's turn comes up next in the queue.
  27 class FeedbackUploader : public base::SupportsWeakPtr<FeedbackUploader> {
  28  public:
  29   FeedbackUploader(const base::FilePath& path,
  30                    base::SequencedWorkerPool* pool);
  31   FeedbackUploader(const base::FilePath& path,
  32                    base::SequencedWorkerPool* pool,
  33                    const std::string& url);
  34   virtual ~FeedbackUploader();
  35
  36   // Queues a report for uploading.
  37   virtual void QueueReport(const std::string& data);
  38
  39   base::FilePath GetFeedbackReportsPath() { return report_path_; }
  40
  41   bool QueueEmpty() const { return reports_queue_.empty(); }
  42
  43  protected:
  44   friend class FeedbackUploaderTest;
  45
  46   struct ReportsUploadTimeComparator {
  47     bool operator()(FeedbackReport* a, FeedbackReport* b) const;
  48   };
  49
  50   void Init();
  51
  52   // Dispatches the report to be uploaded.
  53   virtual void DispatchReport(const std::string& data) = 0;
  54
  55   // Update our timer for uploading the next report.
  56   void UpdateUploadTimer();
  57
  58   // Requeue this report with a delay.
  59   void RetryReport(const std::string& data);
  60
  61   void QueueReportWithDelay(const std::string& data, base::TimeDelta delay);
  62
  63   void setup_for_test(const ReportDataCallback& dispatch_callback,
  64                       const base::TimeDelta& retry_delay);
  65
  66   base::FilePath report_path_;
  67   // Timer to upload the next report at.
  68   base::OneShotTimer<FeedbackUploader> upload_timer_;
  69   // Priority queue of reports prioritized by the time the report is supposed
  70   // to be uploaded at.
  71   std::priority_queue<scoped_refptr<FeedbackReport>,
  72                       std::vector<scoped_refptr<FeedbackReport> >,
  73                       ReportsUploadTimeComparator> reports_queue_;
  74
  75   ReportDataCallback dispatch_callback_;
  76   base::TimeDelta retry_delay_;
  77   std::string url_;
  78   base::SequencedWorkerPool* pool_;
  79
  80   DISALLOW_COPY_AND_ASSIGN(FeedbackUploader);
  81 };
  82
  83 }  // namespace feedback
  84
  85 #endif  // COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_