|
| 1 | +/* |
| 2 | + * Copyright 2018 Typelevel |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.typelevel.log4cats |
| 18 | + |
| 19 | +/** |
| 20 | + * Adapter layer to bridge the new SAM LoggerKernel with the existing Logger interface. This allows |
| 21 | + * gradual migration from the old multi-method design to the new SAM design. |
| 22 | + * |
| 23 | + * ## Usage |
| 24 | + * |
| 25 | + * ### Converting SAM LoggerKernel to old Logger interface |
| 26 | + * ```scala |
| 27 | + * val kernel = Slf4jLoggerKernel.fromName[IO]("MyApp") |
| 28 | + * val oldLogger = SamLoggerAdapter.toLogger(kernel) |
| 29 | + * |
| 30 | + * // Use old API |
| 31 | + * oldLogger.info("Works with old API") |
| 32 | + * oldLogger.error(exception)("Works with old API") |
| 33 | + * ``` |
| 34 | + * |
| 35 | + * ### Converting old Logger to SAM LoggerKernel |
| 36 | + * ```scala |
| 37 | + * val oldLogger = Slf4jLogger.getLogger[IO] |
| 38 | + * val samLogger = SamLoggerAdapter.loggerToSamLogger(oldLogger) |
| 39 | + * |
| 40 | + * // Use new SAM API |
| 41 | + * samLogger.info("Works with new API", ("key", "value")) |
| 42 | + * ``` |
| 43 | + * |
| 44 | + * ## Limitations |
| 45 | + * |
| 46 | + * - **Context Loss**: When converting from LoggerKernel → Logger → LoggerKernel, structured |
| 47 | + * context information (key-value pairs) is lost because the old Logger interface doesn't |
| 48 | + * support structured logging. Only message and throwable information is preserved. |
| 49 | + * - **Performance**: The `toLoggerKernel` method creates a full log record to extract message and |
| 50 | + * throwable, which has some overhead. |
| 51 | + * |
| 52 | + * ## Best Practices |
| 53 | + * |
| 54 | + * - Use `toLogger` for backward compatibility when migrating to new backends |
| 55 | + * - Use `loggerToSamLogger` when you need structured logging capabilities |
| 56 | + * - Avoid round-trip conversions (LoggerKernel → Logger → LoggerKernel) as they lose context |
| 57 | + */ |
| 58 | +object SamLoggerAdapter { |
| 59 | + |
| 60 | + /** |
| 61 | + * Convert a LoggerKernel to the existing Logger interface. |
| 62 | + * |
| 63 | + * This is the primary use case for the adapter - allowing new SAM-based backends to work with |
| 64 | + * existing code that uses the old Logger interface. |
| 65 | + * |
| 66 | + * **Note**: Structured context information is not accessible through the old Logger interface, so |
| 67 | + * any context added via the SAM API will not be visible when using the returned Logger. |
| 68 | + */ |
| 69 | + def toLogger[F[_], Ctx](kernel: LoggerKernel[F, Ctx]): Logger[F] = new Logger[F] { |
| 70 | + def error(message: => String): F[Unit] = |
| 71 | + kernel.log(KernelLogLevel.Error, _.withMessage(message)) |
| 72 | + |
| 73 | + def error(t: Throwable)(message: => String): F[Unit] = |
| 74 | + kernel.log(KernelLogLevel.Error, _.withMessage(message).withThrowable(t)) |
| 75 | + |
| 76 | + def warn(message: => String): F[Unit] = |
| 77 | + kernel.log(KernelLogLevel.Warn, _.withMessage(message)) |
| 78 | + |
| 79 | + def warn(t: Throwable)(message: => String): F[Unit] = |
| 80 | + kernel.log(KernelLogLevel.Warn, _.withMessage(message).withThrowable(t)) |
| 81 | + |
| 82 | + def info(message: => String): F[Unit] = |
| 83 | + kernel.log(KernelLogLevel.Info, _.withMessage(message)) |
| 84 | + |
| 85 | + def info(t: Throwable)(message: => String): F[Unit] = |
| 86 | + kernel.log(KernelLogLevel.Info, _.withMessage(message).withThrowable(t)) |
| 87 | + |
| 88 | + def debug(message: => String): F[Unit] = |
| 89 | + kernel.log(KernelLogLevel.Debug, _.withMessage(message)) |
| 90 | + |
| 91 | + def debug(t: Throwable)(message: => String): F[Unit] = |
| 92 | + kernel.log(KernelLogLevel.Debug, _.withMessage(message).withThrowable(t)) |
| 93 | + |
| 94 | + def trace(message: => String): F[Unit] = |
| 95 | + kernel.log(KernelLogLevel.Trace, _.withMessage(message)) |
| 96 | + |
| 97 | + def trace(t: Throwable)(message: => String): F[Unit] = |
| 98 | + kernel.log(KernelLogLevel.Trace, _.withMessage(message).withThrowable(t)) |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * Convert the existing Logger interface to a LoggerKernel. |
| 103 | + * |
| 104 | + * **Important**: This conversion has limitations: |
| 105 | + * - Only message and throwable information is preserved |
| 106 | + * - All structured context (key-value pairs) is lost because the old Logger interface doesn't |
| 107 | + * support structured logging |
| 108 | + * - This method is primarily intended for testing and round-trip compatibility |
| 109 | + * |
| 110 | + * For production use, prefer using the SAM LoggerKernel directly or use `toLogger` to convert |
| 111 | + * from LoggerKernel to Logger. |
| 112 | + */ |
| 113 | + def toLoggerKernel[F[_], Ctx](logger: Logger[F]): LoggerKernel[F, Ctx] = |
| 114 | + new LoggerKernel[F, Ctx] { |
| 115 | + def log(level: KernelLogLevel, record: Log.Builder[Ctx] => Log.Builder[Ctx]): F[Unit] = { |
| 116 | + // Build the log record to extract message and throwable |
| 117 | + // Note: Context information is intentionally not preserved as the old Logger |
| 118 | + // interface doesn't support structured logging |
| 119 | + val logRecord = record(Log.mutableBuilder[Ctx]()).build() |
| 120 | + val message = logRecord.message() |
| 121 | + val throwable = logRecord.throwable |
| 122 | + |
| 123 | + // Route to appropriate logger method based on level and throwable presence |
| 124 | + (level, throwable) match { |
| 125 | + case (KernelLogLevel.Error, Some(t)) => logger.error(t)(message) |
| 126 | + case (KernelLogLevel.Error, None) => logger.error(message) |
| 127 | + case (KernelLogLevel.Warn, Some(t)) => logger.warn(t)(message) |
| 128 | + case (KernelLogLevel.Warn, None) => logger.warn(message) |
| 129 | + case (KernelLogLevel.Info, Some(t)) => logger.info(t)(message) |
| 130 | + case (KernelLogLevel.Info, None) => logger.info(message) |
| 131 | + case (KernelLogLevel.Debug, Some(t)) => logger.debug(t)(message) |
| 132 | + case (KernelLogLevel.Debug, None) => logger.debug(message) |
| 133 | + case (KernelLogLevel.Trace, Some(t)) => logger.trace(t)(message) |
| 134 | + case (KernelLogLevel.Trace, None) => logger.trace(message) |
| 135 | + case _ => logger.info(message) // fallback for unknown levels |
| 136 | + } |
| 137 | + } |
| 138 | + } |
| 139 | + |
| 140 | + /** |
| 141 | + * Convert a SamLogger to the existing Logger interface. |
| 142 | + * |
| 143 | + * This is a convenience method that delegates to `toLogger`. |
| 144 | + */ |
| 145 | + def samLoggerToLogger[F[_], Ctx](samLogger: SamLogger[F, Ctx]): Logger[F] = toLogger(samLogger) |
| 146 | + |
| 147 | + /** |
| 148 | + * Convert the existing Logger interface to a SamLogger. |
| 149 | + * |
| 150 | + * This allows old Logger implementations to be used with the new SAM API, enabling structured |
| 151 | + * logging capabilities. |
| 152 | + * |
| 153 | + * **Note**: The underlying Logger implementation must support the old interface. Any structured |
| 154 | + * context added via the SAM API will be lost when the underlying Logger processes the log (since |
| 155 | + * it only receives message and throwable). |
| 156 | + */ |
| 157 | + def loggerToSamLogger[F[_], Ctx](logger: Logger[F]): SamLogger[F, Ctx] = |
| 158 | + SamLogger.wrap(toLoggerKernel(logger)) |
| 159 | +} |
0 commit comments