Merge pull request #1939 from lift/ajk-service-request-timer

Implement customizable service request timers

Author: farmdawgnation

web/webkit/src/main/scala/net/liftweb/http/LiftRules.scala

@@ -1994,9 +1994,30 @@ class LiftRules() extends Factory with FormVendor with LazyLoggable {
    */
   @volatile var logUnreadRequestVars = true
 
-  /** Controls whether or not the service handling timing messages (Service request (GET) ... took ... Milliseconds) are logged. Defaults to true. */
+  /** Controls whether or not the service handling timing messages (Service request (GET) ... took ... Milliseconds) are logged.
+    * If set to false NoOpServiceTimer is used.
+    * We should remove this setting in Lift-4 and only depend on serviceRequestTimer
+    * Defaults to true.
+    * */
   @volatile var logServiceRequestTiming = true
 
+  /**
+  * Handles logging of servicing a request
+  * two default implementations:
+  *   - NoOpServiceTimer that does nothing
+  *   - StandardServiceTimer that logs time it takes to serve the request (Service request (GET) ... took ... Milliseconds).
+  *     This is the default used.
+  *
+  *     Set custom in Boot:
+  *     LiftRules.installServiceRequestTimer(MyCustomServiceTimer)
+  */
+  val serviceRequestTimer = new LiftRulesGuardedSetting[FactoryMaker[ServiceRequestTimer]]("serviceRequestTimer", new FactoryMaker[ServiceRequestTimer](StandardServiceTimer){})
+
+  def installServiceRequestTimer(default: ServiceRequestTimer): Unit = {
+    val factoryMaker = new FactoryMaker[ServiceRequestTimer](default) {}
+    serviceRequestTimer.set(factoryMaker)
+  }
+
   /** Provides a function that returns random names for form variables, page ids, callbacks, etc. */
   @volatile var funcNameGenerator: () => String = defaultFuncNameGenerator(Props.mode)
 

web/webkit/src/main/scala/net/liftweb/http/LiftServlet.scala

@@ -159,15 +159,7 @@ class LiftServlet extends Loggable {
           )
         }
 
-        if (LiftRules.logServiceRequestTiming) {
-          logTime {
-            val ret = doService(req, resp)
-            val msg = "Service request (" + req.request.method + ") " + req.request.uri + " returned " + resp.getStatus + ","
-            (msg, ret)
-          }
-        } else {
-          doService(req, resp)
-        }
+        LiftRules.serviceRequestTimer.get.vend.logTime(req, resp)(doService)
       }
 
       req.request.resumeInfo match {

web/webkit/src/main/scala/net/liftweb/http/ServiceRequestTimer.scala

@@ -0,0 +1,24 @@
+package net.liftweb.http
+
+import net.liftweb.http.provider.HTTPResponse
+import net.liftweb.util.Helpers
+
+trait ServiceRequestTimer {
+  def logTime(req: Req, resp: HTTPResponse)(doService: (Req, HTTPResponse) => Boolean): Boolean
+}
+
+object NoOpServiceTimer extends ServiceRequestTimer {
+  override def logTime(req: Req, resp: HTTPResponse)(doService: (Req, HTTPResponse) => Boolean): Boolean = {
+    doService(req, resp)
+  }
+}
+
+object StandardServiceTimer extends ServiceRequestTimer {
+  override def logTime(req: Req, resp: HTTPResponse)(doService: (Req, HTTPResponse) => Boolean): Boolean = {
+    Helpers.logTime {
+      val ret = doService(req, resp)
+      val msg = "Service request (" + req.request.method + ") " + req.request.uri + " returned " + resp.getStatus + ","
+      (msg, ret)
+    }
+  }
+}

web/webkit/src/main/scala/net/liftweb/http/provider/HTTPProvider.scala

@@ -132,6 +132,9 @@ trait HTTPProvider {
   }
 
   private def postBoot {
+    if (!LiftRules.logServiceRequestTiming) {
+      LiftRules.installServiceRequestTimer(NoOpServiceTimer)
+    }
     try {
       ResourceBundle getBundle (LiftRules.liftCoreResourceName)
     } catch {