chrome/test/chromedriver/performance_logger.h

// 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.

#ifndef CHROME_TEST_CHROMEDRIVER_PERFORMANCE_LOGGER_H_
#define CHROME_TEST_CHROMEDRIVER_PERFORMANCE_LOGGER_H_

#include <string>

#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "chrome/test/chromedriver/capabilities.h"
#include "chrome/test/chromedriver/chrome/devtools_event_listener.h"
#include "chrome/test/chromedriver/command_listener.h"

class Log;

// Translates DevTools profiler events into Log messages with info level.
//
// The message is a JSON string of the following structure:
// {
//    "webview": <originating WebView ID>,
//    "message": { "method": "...", "params": { ... }}  // DevTools message.
// }
class PerformanceLogger : public DevToolsEventListener, public CommandListener {
 public:
  // Creates a |PerformanceLogger| with default preferences that creates entries
  // in the given Log object. The log is owned elsewhere and must not be null.
  explicit PerformanceLogger(Log* log);

  // Creates a |PerformanceLogger| with specific preferences.
  PerformanceLogger(Log* log, const PerfLoggingPrefs& prefs);

  // Enables Page,Network,Timeline events for client, which must not be null.
  virtual Status OnConnected(DevToolsClient* client) OVERRIDE;
  // Translates an event into a log entry.
  virtual Status OnEvent(DevToolsClient* client,
                         const std::string& method,
                         const base::DictionaryValue& params) OVERRIDE;

  virtual Status BeforeCommand(const std::string& command_name) OVERRIDE;

  // PerformanceLogger subscribes to browser-wide |DevToolsClient| for tracing.
  virtual bool subscribes_to_browser() OVERRIDE;

 private:
  Log* log_;  // The log where to create entries.
  PerfLoggingPrefs prefs_;

  DISALLOW_COPY_AND_ASSIGN(PerformanceLogger);
};

#endif  // CHROME_TEST_CHROMEDRIVER_PERFORMANCE_LOGGER_H_