How to fix DDLogXYZ deprecation?

[AntonDe]

Hi there,

I've some warnings in my project where I use the DDLogInfo macro, with an suggestion to use DDLogMessageFormat:

'DDLogInfo(_:level:context:file:function:line:tag:asynchronous:ddlog:)' is deprecated: Use an interpolated DDLogMessageFormat instead

This warning occurs only in Swift code (I have both: Objective C and Swift code) and only at parameterized messages.
The suggested DDLogMessageFormat struct takes an stringLiteral or stringInterpolation as a parameter, but I'm not able to set the log level.
I'm found a solution to create an DDLogMessage instance and pass it to DDLog.log but is there a simpler way to achieve this and fix the warnings.

Best thanks

[ffried]

Simply use a Swift string literal for logging messages:

DDLogInfo("My log message")

If you have parameters in your log message, use a Swift string interpolation:

let parameter = "My Parameter"
DDLogInfo("My log message with parameter: \(parameter)")

Old vs. new examples

If you've previously had a string as the message in a separate variable, inline it into the DDLogXYZ call. Alternatively, declare it as a DDLogMessageFormat. Note however, that the latter will always evaluate the message even if won't be logged due to the configured level.

Old:

let message = "My message"
DDLogInfo(message)

New:

DDLogInfo("My message")
// OR (always evaluating the message)
let message: DDLogMessageFormat = "My message"
DDLogInfo(message)

---

If you have previously passed an arbitrary value to the DDLogXYZ functions, you need to wrap them in a string interpolation now. Note, though, that it's recommended to form a real message at the call site of DDLogXYZ.

Old:

let myValue = getSomeValue()
DDLogInfo(myValue)

New:

let myValue = getSomeValue()
DDLogInfo("\(myValue)")

Wrapper examples

If you're using a wrapper around the `DDLogXYZ` functions, make sure their message parameter is now of type `DDLogMessageFormat`. After that, the same rules apply for your wrapper as with `DDLogXYX` explained above.

Old:

func myInfoLogWrapper(_ message: Any) {
    DDLogInfo(message)
}

New:

func myInfoLogWrapper(_ message: DDLogMessageFormat) {
    DDLogInfo(message)
}