From 8d975a4d3681d0ba41bd8272f572a78de62e7f89 Mon Sep 17 00:00:00 2001
From: Stewart Stewart <stewart@driver.xyz>
Date: Mon, 25 Sep 2017 18:51:53 -0700
Subject: Add MdcExecutionContext to logging pacagke

---
 .../xyz/driver/core/logging/DriverLayout.scala     | 58 ++++++++++++++++++++++
 .../driver/core/logging/MdcExecutionContext.scala  | 32 ++++++++++++
 .../scala/xyz/driver/core/logging/package.scala    |  7 +++
 3 files changed, 97 insertions(+)
 create mode 100644 src/main/scala/xyz/driver/core/logging/DriverLayout.scala
 create mode 100644 src/main/scala/xyz/driver/core/logging/MdcExecutionContext.scala
 create mode 100644 src/main/scala/xyz/driver/core/logging/package.scala

(limited to 'src/main/scala/xyz/driver/core/logging')

diff --git a/src/main/scala/xyz/driver/core/logging/DriverLayout.scala b/src/main/scala/xyz/driver/core/logging/DriverLayout.scala
new file mode 100644
index 0000000..5e6c7df
--- /dev/null
+++ b/src/main/scala/xyz/driver/core/logging/DriverLayout.scala
@@ -0,0 +1,58 @@
+package xyz.driver.core
+package logging
+
+import java.text.SimpleDateFormat
+import java.util.Date
+
+import ch.qos.logback.classic.spi.ILoggingEvent
+import ch.qos.logback.core.LayoutBase
+import org.apache.commons.lang3.StringUtils
+
+class DriverLayout extends LayoutBase[ILoggingEvent] {
+  import scala.collection.JavaConverters._
+
+  private val FieldSeparator        = "="
+  private val DateFormatString      = "MM/dd/yyyy HH:mm:ss"
+  private val newline               = System.getProperty("line.separator")
+  private val IgnoredClassesInStack = Set("org.apache.catalina", "org.apache.coyote", "sun.reflect", "javax.servlet")
+
+  override def doLayout(loggingEvent: ILoggingEvent): String = {
+
+    val date  = new SimpleDateFormat(DateFormatString).format(new Date(loggingEvent.getTimeStamp))
+    val level = StringUtils.rightPad(loggingEvent.getLevel.toString, 5)
+
+    val message = new StringBuilder(s"$date [$level] - ${loggingEvent.getMessage}$newline")
+
+    logContext(message, loggingEvent)
+
+    Option(loggingEvent.getCallerData) foreach { stacktrace =>
+      val stacktraceLength = stacktrace.length
+
+      if (stacktraceLength > 0) {
+        val location = stacktrace.head
+
+        val _ = message
+          .append(s"Location: ${location.getClassName}.${location.getMethodName}:${location.getLineNumber}$newline")
+          .append(s"Exception: ${location.toString}$newline")
+
+        if (stacktraceLength > 1) {
+          message.append(stacktrace.tail.filterNot { e =>
+            IgnoredClassesInStack.forall(ignored => !e.getClassName.startsWith(ignored))
+          } map {
+            _.toString
+          } mkString newline)
+        }
+      }
+    }
+
+    message.toString
+  }
+
+  private def logContext(message: StringBuilder, loggingEvent: ILoggingEvent) = {
+    Option(loggingEvent.getMDCPropertyMap).map(_.asScala).filter(_.nonEmpty).foreach { context =>
+      message.append(
+        context map { case (key, value) => s"$key$FieldSeparator$value" } mkString ("Context: ", " ", newline)
+      )
+    }
+  }
+}
diff --git a/src/main/scala/xyz/driver/core/logging/MdcExecutionContext.scala b/src/main/scala/xyz/driver/core/logging/MdcExecutionContext.scala
new file mode 100644
index 0000000..9f8db3e
--- /dev/null
+++ b/src/main/scala/xyz/driver/core/logging/MdcExecutionContext.scala
@@ -0,0 +1,32 @@
+/** Code ported from "de.geekonaut" %% "slickmdc"  % "1.0.0"
+  * License: @see https://github.com/AVGP/slickmdc/blob/master/LICENSE
+  * Blog post: @see http://50linesofco.de/post/2016-07-01-slick-and-slf4j-mdc-logging-in-scala.html
+  */
+package xyz.driver.core.logging
+
+import org.slf4j.MDC
+import scala.concurrent.ExecutionContext
+
+/**
+  * Execution context proxy for propagating SLF4J diagnostic context from caller thread to execution thread.
+  */
+class MdcExecutionContext(executionContext: ExecutionContext) extends ExecutionContext {
+  override def execute(runnable: Runnable): Unit = {
+    val callerMdc = MDC.getCopyOfContextMap
+    executionContext.execute(new Runnable {
+      def run(): Unit = {
+        // copy caller thread diagnostic context to execution thread
+        // scalastyle:off
+        if (callerMdc != null) MDC.setContextMap(callerMdc)
+        try {
+          runnable.run()
+        } finally {
+          // the thread might be reused, so we clean up for the next use
+          MDC.clear()
+        }
+      }
+    })
+  }
+
+  override def reportFailure(cause: Throwable): Unit = executionContext.reportFailure(cause)
+}
diff --git a/src/main/scala/xyz/driver/core/logging/package.scala b/src/main/scala/xyz/driver/core/logging/package.scala
new file mode 100644
index 0000000..2b6fc11
--- /dev/null
+++ b/src/main/scala/xyz/driver/core/logging/package.scala
@@ -0,0 +1,7 @@
+package xyz.driver.core
+
+import org.slf4j.helpers.NOPLogger
+
+package object logging {
+  val NoLogger = com.typesafe.scalalogging.Logger(NOPLogger.NOP_LOGGER)
+}
-- 
cgit v1.2.3