Feature/logging (#26)

* Timber impl patch 1

* Timber impl patch 2

* Timber impl patch 3

Author: ShiftHackZ

app/app.gradle

@@ -81,6 +81,7 @@ dependencies {
     implementation di.koinCompose
     implementation reactive.rxkotlin
     implementation reactive.rxandroid
+    implementation log.timber
 
     playstoreImplementation platform(proprietary.firebaseBom)
     playstoreImplementation proprietary.firebaseAnalytics

app/src/main/java/com/shifthackz/aisdv1/app/AiStableDiffusionClientApp.kt

@@ -4,6 +4,7 @@ import android.app.Application
 import com.shifthackz.aisdv1.app.di.featureModule
 import com.shifthackz.aisdv1.app.di.preferenceModule
 import com.shifthackz.aisdv1.app.di.providersModule
+import com.shifthackz.aisdv1.core.common.log.FileLoggingTree
 import com.shifthackz.aisdv1.core.imageprocessing.di.imageProcessingModule
 import com.shifthackz.aisdv1.core.validation.di.validatorsModule
 import com.shifthackz.aisdv1.data.di.dataModule
@@ -14,12 +15,14 @@ import com.shifthackz.aisdv1.presentation.di.presentationModule
 import com.shifthackz.aisdv1.storage.di.databaseModule
 import org.koin.android.ext.koin.androidContext
 import org.koin.core.context.startKoin
+import timber.log.Timber
 
 class AiStableDiffusionClientApp : Application() {
 
     override fun onCreate() {
         super.onCreate()
         initializeKoin()
+        initializeLogging()
     }
 
     private fun initializeKoin() = startKoin {
@@ -38,4 +41,11 @@ class AiStableDiffusionClientApp : Application() {
             *presentationModule,
         )
     }
+
+    private fun initializeLogging() {
+        Timber.plant(FileLoggingTree())
+        if (BuildConfig.DEBUG) {
+            Timber.plant(Timber.DebugTree())
+        }
+    }
 }

app/src/main/java/com/shifthackz/aisdv1/app/di/ProvidersModule.kt

@@ -1,12 +1,12 @@
 package com.shifthackz.aisdv1.app.di
 
 import com.shifthackz.aisdv1.app.BuildConfig
+import com.shifthackz.aisdv1.core.common.appbuild.BuildInfoProvider
+import com.shifthackz.aisdv1.core.common.appbuild.BuildType
+import com.shifthackz.aisdv1.core.common.appbuild.BuildVersion
 import com.shifthackz.aisdv1.core.common.file.FileProviderDescriptor
 import com.shifthackz.aisdv1.core.common.links.LinksProvider
 import com.shifthackz.aisdv1.core.common.schedulers.SchedulersProvider
-import com.shifthackz.aisdv1.domain.appbuild.BuildInfoProvider
-import com.shifthackz.aisdv1.domain.appbuild.BuildType
-import com.shifthackz.aisdv1.domain.entity.AppVersion
 import com.shifthackz.aisdv1.network.qualifiers.ApiUrlProvider
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
 import io.reactivex.rxjava3.core.Scheduler
@@ -43,7 +43,7 @@ val providersModule = module {
         object : BuildInfoProvider {
             override val isDebug: Boolean = BuildConfig.DEBUG
             override val buildNumber: Int = BuildConfig.VERSION_CODE
-            override val version: AppVersion = AppVersion(BuildConfig.VERSION_NAME)
+            override val version: BuildVersion = BuildVersion(BuildConfig.VERSION_NAME)
             override val buildType: BuildType = BuildType.parse(BuildConfig.BUILD_FLAVOR_TYPE)
 
             override fun toString(): String = buildString {
@@ -68,6 +68,7 @@ val providersModule = module {
         object : FileProviderDescriptor {
             override val providerPath: String = "${androidApplication().packageName}.fileprovider"
             override val imagesCacheDirPath: String = "${androidApplication().cacheDir}/images"
+            override val logsCacheDirPath: String = "${androidApplication().cacheDir}/logs"
         }
     }
 }

app/src/main/res/xml/file_provider_paths.xml

@@ -4,6 +4,10 @@
         name="folder_images"
         path="images/" />
 
+    <cache-path
+        name="folder_logs"
+        path="logs/" />
+
     <external-path name="media" path="." />
     <external-path name="external_files" path="."/>
 </paths>

core/common/build.gradle

@@ -10,5 +10,7 @@ android {
 }
 
 dependencies {
+    implementation di.koinCore
     implementation reactive.rxjava
+    implementation log.timber
 }

core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/BuildInfoProvider.kt

@@ -0,0 +1,8 @@
+package com.shifthackz.aisdv1.core.common.appbuild
+
+interface BuildInfoProvider {
+    val isDebug: Boolean
+    val buildNumber: Int
+    val version: BuildVersion
+    val buildType: BuildType
+}

…ackz/aisdv1/domain/appbuild/BuildType.kt …aisdv1/core/common/appbuild/BuildType.ktdomain/src/main/java/com/shifthackz/aisdv1/domain/appbuild/BuildType.kt renamed to core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/BuildType.kt domain/src/main/java/com/shifthackz/aisdv1/domain/appbuild/BuildType.kt renamed to core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/BuildType.kt

@@ -1,4 +1,4 @@
-package com.shifthackz.aisdv1.domain.appbuild
+package com.shifthackz.aisdv1.core.common.appbuild
 
 enum class BuildType {
     FOSS,

…hackz/aisdv1/domain/entity/AppVersion.kt …dv1/core/common/appbuild/BuildVersion.ktdomain/src/main/java/com/shifthackz/aisdv1/domain/entity/AppVersion.kt renamed to core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/BuildVersion.kt domain/src/main/java/com/shifthackz/aisdv1/domain/entity/AppVersion.kt renamed to core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/BuildVersion.kt

@@ -1,6 +1,6 @@
-package com.shifthackz.aisdv1.domain.entity
+package com.shifthackz.aisdv1.core.common.appbuild
 
-class AppVersion : Comparable<AppVersion> {
+class BuildVersion : Comparable<BuildVersion> {
     private var major: Int = 0
     private var minor: Int = 0
     private var patch: Int = 0
@@ -37,7 +37,7 @@ class AppVersion : Comparable<AppVersion> {
         }
     }
 
-    override fun compareTo(other: AppVersion): Int {
+    override fun compareTo(other: BuildVersion): Int {
         if (this.major > other.major) return 1
         if (this.major < other.major) return -1
         if (this.minor > other.minor) return 1
@@ -51,7 +51,7 @@ class AppVersion : Comparable<AppVersion> {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false
 
-        other as AppVersion
+        other as BuildVersion
 
         if (major != other.major) return false
         if (minor != other.minor) return false

core/common/src/main/java/com/shifthackz/aisdv1/core/common/file/FileProviderDescriptor.kt

@@ -3,4 +3,5 @@ package com.shifthackz.aisdv1.core.common.file
 interface FileProviderDescriptor {
     val providerPath: String
     val imagesCacheDirPath: String
+    val logsCacheDirPath: String
 }

core/common/src/main/java/com/shifthackz/aisdv1/core/common/log/FileLoggingTree.kt

@@ -0,0 +1,92 @@
+package com.shifthackz.aisdv1.core.common.log
+
+import android.util.Log
+import com.shifthackz.aisdv1.core.common.appbuild.BuildInfoProvider
+import com.shifthackz.aisdv1.core.common.file.FileProviderDescriptor
+import com.shifthackz.aisdv1.core.common.schedulers.SchedulersProvider
+import org.koin.core.component.KoinComponent
+import org.koin.core.component.inject
+import timber.log.Timber
+import java.io.File
+import java.io.FileOutputStream
+import java.text.SimpleDateFormat
+import java.util.*
+
+class FileLoggingTree : Timber.Tree(), KoinComponent {
+
+    private val fileProviderDescriptor: FileProviderDescriptor by inject()
+    private val schedulersProvider: SchedulersProvider by inject()
+    private val buildInfoProvider: BuildInfoProvider by inject()
+
+    private val formatDate: String
+        get() = "[${SimpleDateFormat(LOGGER_TIMESTAMP_FORMAT, Locale.ROOT).format(Date())}]"
+
+    private val formatPriority: (Int) -> String = {
+        when (it) {
+            Log.ASSERT -> "[A]"
+            Log.DEBUG -> "[D]"
+            Log.ERROR -> "[E]"
+            Log.INFO -> "[I]"
+            Log.VERBOSE -> "[V]"
+            Log.WARN -> "[W]"
+            else -> "[U]"
+        }
+    }
+
+    private val formatTag: (String?) -> String = { tag ->
+        tag?.let { "[$it]" } ?: LOGGER_DEFAULT_TAG
+    }
+
+    init {
+        writeLine(buildString {
+            appendLine("=== APP SESSION STARTED ===")
+            appendLine()
+            appendLine("Version : $buildInfoProvider")
+            appendLine("Type    : ${buildInfoProvider.buildType}")
+            appendLine()
+        })
+    }
+
+    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
+        val log = buildString {
+            append(formatDate)
+            append(formatPriority(priority))
+            append(" ")
+            append(formatTag(tag))
+            append(" : ")
+            append(message)
+            t?.stackTraceToString()?.let { stacktrace ->
+                appendLine()
+                append(stacktrace)
+            }
+            appendLine()
+        }
+        writeLine(log)
+    }
+
+    private fun writeLine(message: String) = schedulersProvider.singleThread.execute {
+        run {
+            val cacheDirectory = File(fileProviderDescriptor.logsCacheDirPath)
+            if (!cacheDirectory.exists()) cacheDirectory.mkdirs()
+            val outFile = File(cacheDirectory, LOGGER_FILENAME)
+            if (!outFile.exists()) outFile.createNewFile()
+            FileOutputStream(outFile, true).use { fos ->
+                val payload = message.toByteArray()
+                fos.write(payload)
+                fos.close()
+            }
+        }
+    }
+
+    companion object {
+        private const val LOGGER_TIMESTAMP_FORMAT = "dd.MM.yyyy HH:mm:SS"
+        private const val LOGGER_DEFAULT_TAG = "[SDAI]"
+
+        const val LOGGER_FILENAME = "sdaiv1.log"
+
+        fun clearLog(fileProviderDescriptor: FileProviderDescriptor) {
+            val cacheDirectory = File(fileProviderDescriptor.logsCacheDirPath)
+            cacheDirectory.deleteRecursively()
+        }
+    }
+}