[Offline Pages] Create a event/activity logger

components/offline_pages/offline_event_logger.h

Index: components/offline_pages/offline_event_logger.h
diff --git a/components/offline_pages/offline_event_logger.h b/components/offline_pages/offline_event_logger.h
new file mode 100644
index 0000000000000000000000000000000000000000..da88936dd8cd630af0f5f6b8b44751729f5b387b
--- /dev/null
+++ b/components/offline_pages/offline_event_logger.h
@@ -0,0 +1,58 @@
+// Copyright 2016 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.
+
+#ifndef COMPONENTS_OFFLINE_PAGES_OFFLINE_EVENT_LOGGER_H_
+#define COMPONENTS_OFFLINE_PAGES_OFFLINE_EVENT_LOGGER_H_
+
+#include <deque>
+#include <string>
+#include <vector>
+
+#include "base/macros.h"
+
+namespace offline_pages {
+
+static const size_t kMaxLogCount = 20;
+
+// Maximum number of recorded Logs to keep track of at any moment.

[fgorski, 2016/06/24 18:17:33]

I think you might want to put the documentation above the const definition and
remove the line below.

[chili, 2016/06/24 20:30:11]

Oops. I forgot to remove when I was debugging a different error.

+//static const size_t kMaxLogCount = 20;
+
+// Facilitates the logging of events. Subclasses should create methods that
+// call RecordActivity to write into the log. SetIsLogging, GetLogs, and

[fgorski, 2016/06/24 18:17:33]

|SetIsLogging|, ...

[chili, 2016/06/24 20:30:11]

Done.

+// Clear are called from the chrome://offline-internals page.
+//
+// Logging should be done by calling the corresponding subclass methods when
+// a loggable event occurs (i.e. when status has changed for a save request
+// or when an offlined page has been accessed/saved)

[fgorski, 2016/06/24 18:17:34]

nit: please put period at the end of a sentence.

[chili, 2016/06/24 20:30:11]

Done.

+//
+// This log only keeps track of the last 20 events.

[fgorski, 2016/06/24 18:17:33]

last |kMaxLogCount| events.

[chili, 2016/06/24 20:30:11]

Done.

+class OfflineEventLogger {
+ public:
+  OfflineEventLogger();
+
+  ~OfflineEventLogger();
+
+  // Clears the recorded activities.
+  void Clear();
+
+  // Turns logging on/off.
+  void SetIsLogging(bool is_logging);
+
+  // Dumps the current activity list into |records|.
+  void GetLogs(std::vector<std::string>& records);

[dewittj, 2016/06/24 18:32:49]

nit: use a pointer, non-const pass by reference is uncommon in Chrome.

[chili, 2016/06/24 20:30:11]

Done.

+
+ protected:
+  // Write the activity into the cycling log if we are currently logging.
+  void RecordActivity(const std::string& activity);
+
+ private:
+  // Recorded offline page activities.
+  std::deque<std::string> activities_;
+
+  // Whether we are currently recording logs or not.
+  bool is_logging_;
+};
+}  // namespace offline_pages
+
+#endif  // COMPONENTS_OFFLINE_PAGES_OFFLINE_EVENT_LOGGER_H_