Skip to content

Make logger to consume args of type Any with slf4 interpolator. #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2017
Merged

Make logger to consume args of type Any with slf4 interpolator. #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 37 additions & 23 deletions src/main/scala/com/typesafe/scalalogging/LoggerMacro.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ private object LoggerMacro {
def errorMessageArgs(c: LoggerContext)(message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isErrorEnabled) $underlying.error($message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isErrorEnabled) $underlying.error($message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isErrorEnabled) $underlying.error($message, ..$args)"
q"if ($underlying.isErrorEnabled) $underlying.error($message, ..$anyRefArgs)"
}

def errorMessageMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String]) = {
Expand All @@ -59,10 +60,11 @@ private object LoggerMacro {
def errorMessageArgsMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isErrorEnabled) $underlying.error($marker, $message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isErrorEnabled) $underlying.error($marker, $message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isErrorEnabled) $underlying.error($marker, $message, ..$args)"
q"if ($underlying.isErrorEnabled) $underlying.error($marker, $message, ..$anyRefArgs)"
}

// Warn
Expand All @@ -81,10 +83,11 @@ private object LoggerMacro {
def warnMessageArgs(c: LoggerContext)(message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isWarnEnabled) $underlying.warn($message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isWarnEnabled) $underlying.warn($message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isWarnEnabled) $underlying.warn($message, ..$args)"
q"if ($underlying.isWarnEnabled) $underlying.warn($message, ..$anyRefArgs)"
}

def warnMessageMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String]) = {
Expand All @@ -101,10 +104,11 @@ private object LoggerMacro {
def warnMessageArgsMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isWarnEnabled) $underlying.warn($marker, $message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isWarnEnabled) $underlying.warn($marker, $message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isWarnEnabled) $underlying.warn($marker, $message, ..$args)"
q"if ($underlying.isWarnEnabled) $underlying.warn($marker, $message, ..$anyRefArgs)"
}

// Info
Expand All @@ -123,10 +127,11 @@ private object LoggerMacro {
def infoMessageArgs(c: LoggerContext)(message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isInfoEnabled) $underlying.info($message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isInfoEnabled) $underlying.info($message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isInfoEnabled) $underlying.info($message, ..$args)"
q"if ($underlying.isInfoEnabled) $underlying.info($message, ..$anyRefArgs)"
}

def infoMessageMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String]) = {
Expand All @@ -143,10 +148,11 @@ private object LoggerMacro {
def infoMessageArgsMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isInfoEnabled) $underlying.info($marker, $message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isInfoEnabled) $underlying.info($marker, $message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isInfoEnabled) $underlying.info($marker, $message, ..$args)"
q"if ($underlying.isInfoEnabled) $underlying.info($marker, $message, ..$anyRefArgs)"
}

// Debug
Expand All @@ -165,10 +171,11 @@ private object LoggerMacro {
def debugMessageArgs(c: LoggerContext)(message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isDebugEnabled) $underlying.debug($message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isDebugEnabled) $underlying.debug($message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isDebugEnabled) $underlying.debug($message, ..$args)"
q"if ($underlying.isDebugEnabled) $underlying.debug($message, ..$anyRefArgs)"
}

def debugMessageMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String]) = {
Expand All @@ -185,10 +192,11 @@ private object LoggerMacro {
def debugMessageArgsMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isDebugEnabled) $underlying.debug($marker, $message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isDebugEnabled) $underlying.debug($marker, $message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isDebugEnabled) $underlying.debug($marker, $message, ..$args)"
q"if ($underlying.isDebugEnabled) $underlying.debug($marker, $message, ..$anyRefArgs)"
}

// Trace
Expand All @@ -207,10 +215,11 @@ private object LoggerMacro {
def traceMessageArgs(c: LoggerContext)(message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isTraceEnabled) $underlying.trace($message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isTraceEnabled) $underlying.trace($message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isTraceEnabled) $underlying.trace($message, ..$args)"
q"if ($underlying.isTraceEnabled) $underlying.trace($message, ..$anyRefArgs)"
}

def traceMessageMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String]) = {
Expand All @@ -227,10 +236,11 @@ private object LoggerMacro {
def traceMessageArgsMarker(c: LoggerContext)(marker: c.Expr[Marker], message: c.Expr[String], args: c.Expr[Any]*) = {
import c.universe._
val underlying = q"${c.prefix}.underlying"
val anyRefArgs = formatArgs(c)(args: _*)
if (args.length == 2)
q"if ($underlying.isTraceEnabled) $underlying.trace($marker, $message, _root_.scala.Array(${args(0)}, ${args(1)}): _*)"
q"if ($underlying.isTraceEnabled) $underlying.trace($marker, $message, _root_.scala.Array(${anyRefArgs(0)}, ${anyRefArgs(1)}): _*)"
else
q"if ($underlying.isTraceEnabled) $underlying.trace($marker, $message, ..$args)"
q"if ($underlying.isTraceEnabled) $underlying.trace($marker, $message, ..$anyRefArgs)"
}

/** Checks whether `messsage` is an interpolated string and transforms it into SLF4J string interpolation. */
Expand All @@ -246,14 +256,18 @@ private object LoggerMacro {
.map(str => if (args.nonEmpty) str.replace("{}", "\\{}") else str)
.mkString("{}")

val formatArgs = args map { arg =>
c.Expr[AnyRef](if (arg.tpe <:< weakTypeOf[AnyRef]) arg else q"$arg.asInstanceOf[_root_.scala.AnyRef]")
}
val formatArgs = args.map(t => c.Expr[Any](t))

(c.Expr(q"$format"), formatArgs)

case _ => (message, Seq.empty)
}
}

private def formatArgs(c: LoggerContext)(args: c.Expr[Any]*) = {
import c.universe._
args.map { arg =>
c.Expr[AnyRef](if (arg.tree.tpe <:< weakTypeOf[AnyRef]) arg.tree else q"$arg.asInstanceOf[_root_.scala.AnyRef]")
}
}
}
24 changes: 24 additions & 0 deletions src/test/scala/com/typesafe/scalalogging/LoggerSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,24 @@ class LoggerSpec extends WordSpec with Matchers with MockitoSugar {
}
}

"Logging a message using slf4 interpolator and Any args" should {
"map args to AnyRef for 2 args" in {
val f = fixture(_.isErrorEnabled, true)
import f._
logger.error("foo {}, bar {}", arg4, arg5)
verify(underlying).error("foo {}, bar {}", Array(arg4ref, arg5ref): _*)
}

"map args to AnyRef for non 2 args" in {
val f = fixture(_.isErrorEnabled, true)
import f._
logger.error("foo {}", arg4)
verify(underlying).error("foo {}", arg4ref)
logger.error("foo {}, bar {}, {}", arg4, arg5, arg6)
verify(underlying).error("foo {}, bar {}, {}", arg4ref, arg5ref, arg6ref)
}
}

"Serializing Logger" should {

def serialize(logger: Logger): Array[Byte] = {
Expand Down Expand Up @@ -513,6 +531,12 @@ class LoggerSpec extends WordSpec with Matchers with MockitoSugar {
val arg1 = "arg1"
val arg2 = new Integer(1)
val arg3 = "arg3"
val arg4 = 4
val arg4ref = arg4.asInstanceOf[AnyRef]
val arg5 = true
val arg5ref = arg5.asInstanceOf[AnyRef]
val arg6 = 6L
val arg6ref = arg6.asInstanceOf[AnyRef]
val underlying = mock[org.slf4j.Logger]
when(p(underlying)).thenReturn(isEnabled)
val logger = Logger(underlying)
Expand Down