Add unit test for timeout=0

[folly.git] / folly / experimental / AutoTimer.h

diff --git a/folly/experimental/AutoTimer.h b/folly/experimental/AutoTimer.h
index 20c5156d6a8bcbe1d8a38571c7923fde63398de3..545c3be7649319e4dfc14da3f7c5df21dc9c8aa7 100644 (file)
--- a/folly/experimental/AutoTimer.h
+++ b/folly/experimental/AutoTimer.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 
 #include <folly/Conv.h>
 #include <folly/Format.h>
+#include <folly/Optional.h>
 #include <folly/String.h>
 #include <glog/logging.h>
 
@@ -45,8 +46,9 @@ struct GoogleLogger;
  *   "Foo() completed in 4.3 seconds"
  *
  * You can customize what you use as the logger and clock. The logger needs
- * to have an operator()(StringPiece, double) that gets a message and a duration
- * (in seconds). The clock needs to model Clock from std::chrono.
+ * to have an operator()(StringPiece, std::chrono::duration<double>) that
+ * gets a message and a duration. The clock needs to model Clock from
+ * std::chrono.
  *
  * The default logger logs usings glog. It only logs if the message is
  * non-empty, so you can also just use this class for timing, e.g.:
@@ -60,9 +62,11 @@ template <
     class Clock = std::chrono::high_resolution_clock>
 class AutoTimer final {
  public:
+  using DoubleSeconds = std::chrono::duration<double>;
+
   explicit AutoTimer(
       std::string&& msg = "",
-      double minTimetoLog = 0.0,
+      const DoubleSeconds& minTimetoLog = DoubleSeconds::zero(),
       Logger&& logger = Logger())
       : destructionMessage_(std::move(msg)),
         minTimeToLog_(minTimetoLog),
@@ -76,21 +80,23 @@ class AutoTimer final {
   AutoTimer& operator=(AutoTimer&&) = default;
 
   ~AutoTimer() {
-    log(destructionMessage_);
+    if (destructionMessage_) {
+      log(destructionMessage_.value());
+    }
   }
 
-  double log(StringPiece msg = "") {
+  DoubleSeconds log(StringPiece msg = "") {
     return logImpl(Clock::now(), msg);
   }
 
   template <typename... Args>
-  double log(Args&&... args) {
+  DoubleSeconds log(Args&&... args) {
     auto now = Clock::now();
     return logImpl(now, to<std::string>(std::forward<Args>(args)...));
   }
 
   template <typename... Args>
-  double logFormat(Args&&... args) {
+  DoubleSeconds logFormat(Args&&... args) {
     auto now = Clock::now();
     return logImpl(now, format(std::forward<Args>(args)...).str());
   }
@@ -98,10 +104,8 @@ class AutoTimer final {
  private:
   // We take in the current time so that we don't measure time to call
   // to<std::string> or format() in the duration.
-  double logImpl(std::chrono::time_point<Clock> now, StringPiece msg) {
-    double duration =
-        std::chrono::duration_cast<std::chrono::duration<double>>(now - start_)
-            .count();
+  DoubleSeconds logImpl(std::chrono::time_point<Clock> now, StringPiece msg) {
+    auto duration = now - start_;
     if (duration >= minTimeToLog_) {
       logger_(msg, duration);
     }
@@ -109,9 +113,9 @@ class AutoTimer final {
     return duration;
   }
 
-  const std::string destructionMessage_;
+  Optional<std::string> destructionMessage_;
   std::chrono::time_point<Clock> start_ = Clock::now();
-  double minTimeToLog_;
+  DoubleSeconds minTimeToLog_;
   Logger logger_;
 };
 
@@ -120,7 +124,8 @@ template <
     class Clock = std::chrono::high_resolution_clock>
 auto makeAutoTimer(
     std::string&& msg = "",
-    double minTimeToLog = 0.0,
+    const std::chrono::duration<double>& minTimeToLog =
+        std::chrono::duration<double>::zero(),
     Logger&& logger = Logger()) {
   return AutoTimer<Logger, Clock>(
       std::move(msg), minTimeToLog, std::move(logger));
@@ -128,15 +133,17 @@ auto makeAutoTimer(
 
 template <GoogleLoggerStyle Style>
 struct GoogleLogger final {
-  void operator()(StringPiece msg, double sec) const {
+  void operator()(StringPiece msg, const std::chrono::duration<double>& sec)
+      const {
     if (msg.empty()) {
       return;
     }
     if (Style == GoogleLoggerStyle::PRETTY) {
-      LOG(INFO) << msg << " in " << prettyPrint(sec, PrettyType::PRETTY_TIME);
+      LOG(INFO) << msg << " in "
+                << prettyPrint(sec.count(), PrettyType::PRETTY_TIME);
     } else {
-      LOG(INFO) << msg << " in " << sec << " seconds";
+      LOG(INFO) << msg << " in " << sec.count() << " seconds";
     }
   }
 };
-}
+} // namespace folly