#313

Build # #313

Build Type

push

Committed by

Commit Message

<a href="https://github.com/evolution-gaming/cats-helper/commit/<a class=hub.com/evolution-gaming/cats-helper/commit/579cf7fc77a18ebf3a3223e8a9775aadfacc61fd">579cf7fc7<a href="https://github.com/evolution-gaming/cats-helper/commit/579cf7fc77a18ebf3a3223e8a9775aadfacc61fd">">Merge </a><a class="double-link" href="https://github.com/evolution-gaming/cats-helper/commit/<a class="double-link" href="https://github.com/evolution-gaming/cats-helper/commit/c65417cf3356695e3c1624f1a6a36804331bfc73">c65417cf3</a>">c65417cf3</a><a href="https://github.com/evolution-gaming/cats-helper/commit/579cf7fc77a18ebf3a3223e8a9775aadfacc61fd"> into 29621c892">29621c892</a>

Run Details

39 of 39 new or added lines in 1 file covered. (100.0%)

427 of 573 relevant lines covered (74.52%)

0.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

48.98

/core/src/main/scala/com/evolutiongaming/catshelper/Log.scala

package com.evolutiongaming.catshelper

import cats.effect.Sync
import cats.{Applicative, ~>}
import org.slf4j.Logger

trait Log[F[_]] {

  @inline def debug(msg: => String): F[Unit] = debug(msg, mdc = Log.MDC.empty)

  @inline def info(msg: => String): F[Unit] = info(msg, mdc = Log.MDC.empty)

  @inline def warn(msg: => String): F[Unit] = warn(msg, mdc = Log.MDC.empty)

  @inline def warn(msg: => String, cause: Throwable): F[Unit] = warn(msg, cause, mdc = Log.MDC.empty)

  @inline def error(msg: => String): F[Unit] = error(msg, mdc = Log.MDC.empty)

  @inline def error(msg: => String, cause: Throwable): F[Unit] = error(msg, cause, mdc = Log.MDC.empty)

  def debug(msg: => String, mdc: Log.MDC): F[Unit]

  def info(msg: => String, mdc: Log.MDC): F[Unit]

  def warn(msg: => String, mdc: Log.MDC): F[Unit]

  def warn(msg: => String, cause: Throwable, mdc: Log.MDC): F[Unit]

  def error(msg: => String, mdc: Log.MDC): F[Unit]

  def error(msg: => String, cause: Throwable, mdc: Log.MDC): F[Unit]
}

object Log {

  sealed trait MDC
  object MDC {

    private object Empty extends MDC
    private final case class Context(values: Map[String, String]) extends MDC {
      override def toString: String = s"MDC(${values.mkString(", ")})"
    }

    val empty: MDC = Empty

    def apply(values: Map[String, String]): MDC = Context(values)
    def apply(values: (String, String)*): MDC = apply(Map(values: _*))
    def apply(key: String, value: String): MDC = apply(key -> value)

    implicit final class MdcOps(val mdc: MDC) extends AnyVal {
      def context: Option[Map[String, String]] = mdc match {
        case Empty => None
        case Context(values) if values.isEmpty => None
        case Context(values) => Some(values)
      }
    }
  }

  def apply[F[_]](implicit F: Log[F]): Log[F] = F

  def summon[F[_]](implicit F: Log[F]): Log[F] = F

  def apply[F[_]: Sync](logger: Logger): Log[F] = new Log[F] {

    def withMDC(mdc: Log.MDC)(log: => Unit): Unit = {
      import MDC.MdcOps
      import org.slf4j.MDC.{getCopyOfContextMap, clear, put, setContextMap}
      mdc.context match {
        case None => log
        case Some(mdc) =>
          val backup = getCopyOfContextMap
          clear()
          mdc foreach { case (k, v) => put(k, v) }
          log
          setContextMap(backup)
      }
    }

    def debug(msg: => String, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isDebugEnabled) withMDC(mdc) { logger.debug(msg) }
      }
    }

    def info(msg: => String, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isInfoEnabled) withMDC(mdc) { logger.info(msg) }
      }
    }

    def warn(msg: => String, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isWarnEnabled) withMDC(mdc) { logger.warn(msg) }
      }
    }

    def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isWarnEnabled) withMDC(mdc) { logger.warn(msg, cause) }
      }
    }

    def error(msg: => String, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isErrorEnabled) withMDC(mdc) { logger.error(msg) }
      }
    }

    def error(msg: => String, cause: Throwable, mdc: Log.MDC) = {
      Sync[F].delay {
        if (logger.isErrorEnabled) withMDC(mdc) { logger.error(msg, cause) }
      }
    }
  }

  def const[F[_]](unit: F[Unit]): Log[F] = new Log[F] {

    def debug(msg: => String, mdc: Log.MDC) = unit

    def info(msg: => String, mdc: Log.MDC) = unit

    def warn(msg: => String, mdc: Log.MDC) = unit

    def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = unit

    def error(msg: => String, mdc: Log.MDC) = unit

    def error(msg: => String, cause: Throwable, mdc: Log.MDC) = unit
  }

  def empty[F[_]: Applicative]: Log[F] = const(Applicative[F].unit)

  implicit class LogOps[F[_]](val self: Log[F]) extends AnyVal {

    def mapK[G[_]](f: F ~> G): Log[G] = new Log[G] {

      def debug(msg: => String, mdc: Log.MDC) = f(self.debug(msg, mdc))

      def info(msg: => String, mdc: Log.MDC) = f(self.info(msg, mdc))

      def warn(msg: => String, mdc: Log.MDC) = f(self.warn(msg, mdc))

      def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = f(self.warn(msg, cause, mdc))

      def error(msg: => String, mdc: Log.MDC) = f(self.error(msg, mdc))

      def error(msg: => String, cause: Throwable, mdc: Log.MDC) = f(self.error(msg, cause, mdc))
    }

    def mapMsg(f: String => String): Log[F] = new Log[F] {

      def debug(msg: => String, mdc: Log.MDC) = self.debug(f(msg), mdc)

      def info(msg: => String, mdc: Log.MDC) = self.info(f(msg), mdc)

      def warn(msg: => String, mdc: Log.MDC) = self.warn(f(msg), mdc)

      def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = self.warn(f(msg), cause, mdc)

      def error(msg: => String, mdc: Log.MDC) = self.error(f(msg), mdc)

      def error(msg: => String, cause: Throwable, mdc: Log.MDC) = self.error(f(msg), cause, mdc)
    }

    def prefixed(prefix: String): Log[F] = mapMsg(msg => s"$prefix $msg")
  }
}

1	package com.evolutiongaming.catshelper
2
3	import cats.effect.Sync
4	import cats.{Applicative, ~>}
5	import org.slf4j.Logger
6
7	trait Log[F[_]] {
8
9	@inline def debug(msg: => String): F[Unit] = debug(msg, mdc = Log.MDC.empty)	1✔
10
11	@inline def info(msg: => String): F[Unit] = info(msg, mdc = Log.MDC.empty)	1✔
12
13	@inline def warn(msg: => String): F[Unit] = warn(msg, mdc = Log.MDC.empty)	1✔
14
15	@inline def warn(msg: => String, cause: Throwable): F[Unit] = warn(msg, cause, mdc = Log.MDC.empty)	1✔
16
17	@inline def error(msg: => String): F[Unit] = error(msg, mdc = Log.MDC.empty)	1✔
18
19	@inline def error(msg: => String, cause: Throwable): F[Unit] = error(msg, cause, mdc = Log.MDC.empty)	1✔
20
21	def debug(msg: => String, mdc: Log.MDC): F[Unit]
22
23	def info(msg: => String, mdc: Log.MDC): F[Unit]
24
25	def warn(msg: => String, mdc: Log.MDC): F[Unit]
26
27	def warn(msg: => String, cause: Throwable, mdc: Log.MDC): F[Unit]
28
29	def error(msg: => String, mdc: Log.MDC): F[Unit]
30
31	def error(msg: => String, cause: Throwable, mdc: Log.MDC): F[Unit]
32	}
33
34	object Log {
35
36	sealed trait MDC
37	object MDC {
38
39	private object Empty extends MDC
40	private final case class Context(values: Map[String, String]) extends MDC {
41	override def toString: String = s"MDC(${values.mkString(", ")})"
42	}
43
44	val empty: MDC = Empty	1✔
45
46	def apply(values: Map[String, String]): MDC = Context(values)	×
47	def apply(values: (String, String)): MDC = apply(Map(values: _))	×
48	def apply(key: String, value: String): MDC = apply(key -> value)	×
49
50	implicit final class MdcOps(val mdc: MDC) extends AnyVal {
51	def context: Option[Map[String, String]] = mdc match {	×
52	case Empty => None	×
53	case Context(values) if values.isEmpty => None	×
54	case Context(values) => Some(values)	×
55	}
56	}
57	}
58
59	def apply[F[_]](implicit F: Log[F]): Log[F] = F
60
61	def summon[F[_]](implicit F: Log[F]): Log[F] = F
62
63	def apply[F[_]: Sync](logger: Logger): Log[F] = new Log[F] {	1✔
64
65	def withMDC(mdc: Log.MDC)(log: => Unit): Unit = {
66	import MDC.MdcOps
67	import org.slf4j.MDC.{getCopyOfContextMap, clear, put, setContextMap}
68	mdc.context match {	×
69	case None => log
70	case Some(mdc) =>
71	val backup = getCopyOfContextMap	×
72	clear()	×
73	mdc foreach { case (k, v) => put(k, v) }	×
74	log
75	setContextMap(backup)	×
76	}
77	}
78
79	def debug(msg: => String, mdc: Log.MDC) = {
80	Sync[F].delay {	×
81	if (logger.isDebugEnabled) withMDC(mdc) { logger.debug(msg) }	×
82	}
83	}
84
85	def info(msg: => String, mdc: Log.MDC) = {
86	Sync[F].delay {	1✔
87	if (logger.isInfoEnabled) withMDC(mdc) { logger.info(msg) }	×
88	}
89	}
90
91	def warn(msg: => String, mdc: Log.MDC) = {
92	Sync[F].delay {	×
93	if (logger.isWarnEnabled) withMDC(mdc) { logger.warn(msg) }	×
94	}
95	}
96
97	def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = {
98	Sync[F].delay {	×
99	if (logger.isWarnEnabled) withMDC(mdc) { logger.warn(msg, cause) }	×
100	}
101	}
102
103	def error(msg: => String, mdc: Log.MDC) = {
104	Sync[F].delay {	×
105	if (logger.isErrorEnabled) withMDC(mdc) { logger.error(msg) }	×
106	}
107	}
108
109	def error(msg: => String, cause: Throwable, mdc: Log.MDC) = {
110	Sync[F].delay {	×
111	if (logger.isErrorEnabled) withMDC(mdc) { logger.error(msg, cause) }	×
112	}
113	}
114	}
115
116	def const[F[_]](unit: F[Unit]): Log[F] = new Log[F] {	×
117
118	def debug(msg: => String, mdc: Log.MDC) = unit
119
120	def info(msg: => String, mdc: Log.MDC) = unit
121
122	def warn(msg: => String, mdc: Log.MDC) = unit
123
124	def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = unit
125
126	def error(msg: => String, mdc: Log.MDC) = unit
127
128	def error(msg: => String, cause: Throwable, mdc: Log.MDC) = unit
129	}
130
131	def empty[F[_]: Applicative]: Log[F] = const(Applicative[F].unit)	×
132
133	implicit class LogOps[F[_]](val self: Log[F]) extends AnyVal {
134
135	def mapK[G[_]](f: F ~> G): Log[G] = new Log[G] {	1✔
136
137	def debug(msg: => String, mdc: Log.MDC) = f(self.debug(msg, mdc))	1✔
138
139	def info(msg: => String, mdc: Log.MDC) = f(self.info(msg, mdc))	1✔
140
141	def warn(msg: => String, mdc: Log.MDC) = f(self.warn(msg, mdc))	1✔
142
143	def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = f(self.warn(msg, cause, mdc))	1✔
144
145	def error(msg: => String, mdc: Log.MDC) = f(self.error(msg, mdc))	1✔
146
147	def error(msg: => String, cause: Throwable, mdc: Log.MDC) = f(self.error(msg, cause, mdc))	1✔
148	}
149
150	def mapMsg(f: String => String): Log[F] = new Log[F] {	1✔
151
152	def debug(msg: => String, mdc: Log.MDC) = self.debug(f(msg), mdc)	1✔
153
154	def info(msg: => String, mdc: Log.MDC) = self.info(f(msg), mdc)	1✔
155
156	def warn(msg: => String, mdc: Log.MDC) = self.warn(f(msg), mdc)	1✔
157
158	def warn(msg: => String, cause: Throwable, mdc: Log.MDC) = self.warn(f(msg), cause, mdc)	1✔
159
160	def error(msg: => String, mdc: Log.MDC) = self.error(f(msg), mdc)	1✔
161
162	def error(msg: => String, cause: Throwable, mdc: Log.MDC) = self.error(f(msg), cause, mdc)	1✔
163	}
164
165	def prefixed(prefix: String): Log[F] = mapMsg(msg => s"$prefix $msg")	1✔
166	}
167	}

evolution-gaming / cats-helper / #313

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous