commonMain.pro.respawn.flowmvi.plugins.LoggingPlugin.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-jvm Show documentation

A Kotlin Multiplatform MVI library based on plugins that is simple, fast, powerful & flexible

There is a newer version: 3.0.0

@file:Suppress("StringShouldBeRawString")

package pro.respawn.flowmvi.plugins

import pro.respawn.flowmvi.api.FlowMVIDSL
import pro.respawn.flowmvi.api.MVIAction
import pro.respawn.flowmvi.api.MVIIntent
import pro.respawn.flowmvi.api.MVIState
import pro.respawn.flowmvi.api.StorePlugin
import pro.respawn.flowmvi.dsl.StoreBuilder
import pro.respawn.flowmvi.dsl.plugin
import pro.respawn.flowmvi.plugins.StoreLogLevel.Debug
import pro.respawn.flowmvi.plugins.StoreLogLevel.Error
import pro.respawn.flowmvi.plugins.StoreLogLevel.Info
import pro.respawn.flowmvi.plugins.StoreLogLevel.Trace

/**
 * Log level of this store. Override using [logging] or leave as a default for sensible log levels.
 * Not used when the logger does not support levels, such as with [consoleLoggingPlugin].
 */
public enum class StoreLogLevel {

    Trace, Debug, Info, Warn, Error
}

/**
 * Install a new [loggingPlugin].
 * @param log a function that prints the message using provided [StoreLogLevel] and tag if needed.
 * [pro.respawn.flowmvi.api.Store.name] is used as a tag by default.
 */
@FlowMVIDSL
public fun  StoreBuilder.logging(
    tag: String? = this.name,
    name: String = "${tag.orEmpty()}Logging",
    log: (level: StoreLogLevel, tag: String, msg: String) -> Unit
): Unit = install(loggingPlugin(tag, name, log))

/**
 * Create a new [StorePlugin] that prints messages using [log].
 * [tag] is used as a name for the plugin.
 * Tag can be null, in which case, [name] will be used, will remain null.
 */
@FlowMVIDSL
public inline fun  loggingPlugin(
    tag: String? = null,
    name: String = "${tag.orEmpty()}Logging",
    crossinline log: (level: StoreLogLevel, tag: String, msg: String) -> Unit,
): StorePlugin = plugin {
    this.name = name
    onState { old, new ->
        log(Trace, tag ?: name, "\nState:\n--->\n$old\n<---\n$new")
        new
    }
    onIntent {
        log(Debug, tag ?: name, "Intent -> $it")
        it
    }
    onAction {
        log(Debug, tag ?: name, "Action -> $it")
        it
    }
    onException {
        log(Error, tag ?: name, "Exception:\n $it")
        it
    }
    onStart {
        log(Info, tag ?: name, "Started")
    }
    onSubscribe { _, subs ->
        log(Info, tag ?: name, "New subscriber #${subs + 1}")
    }
    onUnsubscribe {
        log(Info, tag ?: name, "Subscriber #${it + 1} removed")
    }
    onStop {
        log(Info, tag ?: name, "Stopped with e=$it")
    }
}

/**
 * A logging plugin that prints logs to the console using [println]. Tag is not used except for naming the plugin.
 * For android, use androidLoggingPlugin.
 * @see loggingPlugin
 */
@FlowMVIDSL
public fun  consoleLoggingPlugin(
    tag: String? = null,
    name: String = "${tag.orEmpty()}Logging",
): StorePlugin = loggingPlugin(tag, name) { _, _, msg -> println("$tag: $msg") }