Merge pull request #226 from opatry/ktor-monitor

opatry · web-flow · commit cce4008ed61b · 2025-05-24T17:15:55.000+02:00
Ktor monitor
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -46,7 +46,7 @@ jobs:
     - name: ©️ Generate credits for ':tasks-app-desktop'
       id: check_desktop_app_credits
       run: |
-            ./gradlew --no-daemon :tasks-app-desktop:exportLibraryDefinitions
+            ./gradlew --no-daemon :tasks-app-desktop:exportLibraryDefinitions -Pci=true
             stale_credits=$(git diff tasks-app-desktop/src/main/resources/licenses_desktop.json)
             if [ -n "${stale_credits}" ]; then
                 {
@@ -79,7 +79,7 @@ jobs:
     - name: ©️ Generate credits for ':tasks-app-android'
       id: check_android_app_credits
       run: |
-            ./gradlew --no-daemon :tasks-app-android:exportLibraryDefinitions
+            ./gradlew --no-daemon :tasks-app-android:exportLibraryDefinitions -Pci=true
             stale_credits=$(git diff tasks-app-android/src/main/assets/licenses_android.json)
             if [ -n "${stale_credits}" ]; then
                 {
diff --git a/_ci/generate_github_comment_stale_credits.sh b/_ci/generate_github_comment_stale_credits.sh
@@ -8,11 +8,11 @@ set -euo pipefail
 case "$1" in
   ":tasks-app-android")
   diff=$(git diff tasks-app-android/src/main/assets/licenses_android.json | awk '{printf "%s\\n", $0}')
-  update_cmd="./gradlew :tasks-app-android:exportLibraryDefinitions"
+  update_cmd="./gradlew :tasks-app-android:exportLibraryDefinitions -Pci=true"
   ;;
   ":tasks-app-desktop")
   diff=$(git diff tasks-app-desktop/src/main/resources/licenses_desktop.json | awk '{printf "%s\\n", $0}')
-  update_cmd="./gradlew :tasks-app-desktop:exportLibraryDefinitions"
+  update_cmd="./gradlew :tasks-app-desktop:exportLibraryDefinitions -Pci=true"
   ;;
   *)
   echo "Unsupported app module"
diff --git a/_ci/update_credits_json.sh b/_ci/update_credits_json.sh
@@ -7,4 +7,4 @@ origin=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) || exit
 cd "${origin}/.."
 
 find . -name "licenses*.json" -delete
-./gradlew "exportLibraryDefinitions"
+./gradlew "exportLibraryDefinitions" -Pci=true
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -8,6 +8,7 @@ kotlin = "2.2.0-RC"
 ksp = "2.2.0-RC-2.0.1"
 coroutines = "1.10.2"
 ktor = "3.1.3"
+ktor-monitor-logging = "1.7.1"
 activity-compose = "1.11.0-rc01"
 compose-plugin = "1.8.1"
 compose-hot-reload-plugin = "1.0.0-alpha10"
@@ -46,6 +47,9 @@ ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "k
 ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
 ktor-client-mock = { module = "io.ktor:ktor-client-mock", version.ref = "ktor" }
 
+ktor-monitor-logging = { module = "ro.cosminmihu.ktor:ktor-monitor-logging", version.ref = "ktor-monitor-logging" }
+ktor-monitor-logging-no-op = { module = "ro.cosminmihu.ktor:ktor-monitor-logging-no-op", version.ref = "ktor-monitor-logging" }
+
 slf4j-nop = { module = "org.slf4j:slf4j-nop", version = "2.0.17" }
 
 androidx-room-compiler = { module = "androidx.room:room-compiler", version.ref = "room" }
diff --git a/tasks-app-android/build.gradle.kts b/tasks-app-android/build.gradle.kts
@@ -105,7 +105,7 @@ android {
             manifestPlaceholders["crashlyticsEnabled"] = true
 
             // we allow dev signing config in release build when not in CI to allow release builds on dev machine
-            val ciBuild = (findProperty("ci") as? String)?.toBoolean() ?: false
+            val ciBuild = (findProperty("ci") as? String).toBoolean()
             signingConfig = if (signingConfigs.getByName("store").storeFile == null && !ciBuild) {
                 signingConfigs.getByName("dev")
             } else {
@@ -175,7 +175,7 @@ dependencies {
 
 aboutLibraries {
     // - If the automatic registered android tasks are disabled, a similar thing can be achieved manually
-    // - `./gradlew :tasks-app-android:exportLibraryDefinitions`
+    // - `./gradlew :tasks-app-android:exportLibraryDefinitions -Pci=true`
     // - the resulting file can for example be added as part of the SCM
     collect {
         configPath = file("$rootDir/license_config")
diff --git a/tasks-app-android/src/main/AndroidManifest.xml b/tasks-app-android/src/main/AndroidManifest.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-  Copyright (c) 2024 Olivier Patry
+  Copyright (c) 2025 Olivier Patry
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the "Software"),
@@ -21,10 +21,13 @@
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   -->
 
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
 
     <uses-permission android:name="android.permission.INTERNET" />
 
+    <uses-sdk tools:overrideLibrary="ro.cosminmihu.ktor.monitor" />
+
     <application
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
diff --git a/tasks-app-android/src/main/assets/licenses_android.json b/tasks-app-android/src/main/assets/licenses_android.json
@@ -2999,6 +2999,20 @@
             "organization": {
                 "name": "QOS.ch"
             }
+        },
+        {
+            "uniqueId": "ro.cosminmihu.ktor:ktor-monitor-logging-no-op",
+            "developers": [
+                {
+                    "name": "Cosmin Mihu"
+                }
+            ],
+            "artifactVersion": "1.7.1",
+            "description": "Powerful tools to log Ktor Client requests and responses, making it easier to debug and analyze network communication.",
+            "name": "Ktor Monitor",
+            "licenses": [
+                "Apache-2.0"
+            ]
         }
     ],
     "licenses": {
diff --git a/tasks-app-desktop/build.gradle.kts b/tasks-app-desktop/build.gradle.kts
@@ -38,6 +38,7 @@ plugins {
 val appName = "Taskfolio"
 val appVersion = libs.versions.tasksApp.name.get()
 val appVersionCode = System.getenv("CI_BUILD_NUMBER")?.toIntOrNull() ?: 1
+val ciBuild = (findProperty("ci") as? String).toBoolean()
 
 compose.resources {
     publicResClass = false
@@ -69,6 +70,12 @@ kotlin {
         implementation(projects.google.tasks)
         implementation(projects.tasksAppShared)
 
+        if (ciBuild) {
+            implementation(libs.ktor.monitor.logging.no.op)
+        } else {
+            implementation(libs.ktor.monitor.logging)
+        }
+
         testImplementation(kotlin("test"))
         testImplementation(libs.koin.test)
         testImplementation(libs.ktor.client.core) {
@@ -95,6 +102,7 @@ compose.desktop {
             "-Dapp.name=$appName",
             "-Dapp.version=$appVersion",
             "-Dapp.version.full=${appVersion}.${appVersionCode}",
+            "-Dbuild.release=$ciBuild"
         )
 
         nativeDistributions {
@@ -161,7 +169,7 @@ compose.desktop {
 
 aboutLibraries {
     // - If the automatic registered android tasks are disabled, a similar thing can be achieved manually
-    // - `./gradlew :tasks-app-desktop:exportLibraryDefinitions`
+    // - `./gradlew :tasks-app-desktop:exportLibraryDefinitions -Pci=true`
     // - the resulting file can for example be added as part of the SCM
     collect {
         configPath = file("$rootDir/license_config")
diff --git a/tasks-app-desktop/src/main/composeResources/values-fr/strings.xml b/tasks-app-desktop/src/main/composeResources/values-fr/strings.xml
@@ -24,4 +24,6 @@
     <string name="app_menu_edit">Édition</string>
     <string name="app_menu_edit_new_task_list">Nouvelle liste de tâches…</string>
     <string name="app_menu_edit_new_task">Nouvelle tâche…</string>
+    <string name="app_menu_tools">Outils</string>
+    <string name="app_menu_tools_show_network_logs">Afficher les logs réseau</string>
 </resources>
diff --git a/tasks-app-desktop/src/main/composeResources/values/strings.xml b/tasks-app-desktop/src/main/composeResources/values/strings.xml
@@ -24,4 +24,6 @@
     <string name="app_menu_edit">Edit</string>
     <string name="app_menu_edit_new_task_list">New task list…</string>
     <string name="app_menu_edit_new_task">New task…</string>
+    <string name="app_menu_tools">Tools</string>
+    <string name="app_menu_tools_show_network_logs">Show network logs</string>
 </resources>
diff --git a/tasks-app-desktop/src/main/kotlin/mainApp.kt b/tasks-app-desktop/src/main/kotlin/mainApp.kt
@@ -60,6 +60,7 @@ import net.opatry.tasks.app.ui.screen.AuthorizationScreen
 import net.opatry.tasks.app.ui.theme.TaskfolioTheme
 import org.koin.compose.KoinApplication
 import org.koin.compose.viewmodel.koinViewModel
+import ro.cosminmihu.ktor.monitor.KtorMonitorWindow
 import java.awt.Dimension
 import java.awt.Toolkit
 import javax.swing.UIManager
@@ -75,6 +76,7 @@ fun main() {
     val appName = System.getProperty("app.name") ?: "Taskfolio"
     val fullVersion = System.getProperty("app.version.full") ?: "0.0.0.0"
     val versionLabel = System.getProperty("app.version")?.let { " v$it" } ?: ""
+    val releaseBuild = System.getProperty("build.release").toBoolean()
     application {
         val screenSize by remember {
             mutableStateOf(Toolkit.getDefaultToolkit().screenSize)
@@ -90,6 +92,13 @@ fun main() {
         var showNewTaskListDialog by remember { mutableStateOf(false) }
         var showNewTaskEditorSheet by remember { mutableStateOf(false) }
         var selectedTaskList by remember { mutableStateOf<TaskListUIModel?>(null) }
+        var showKtorMonitor by remember { mutableStateOf(false) }
+        if (!releaseBuild) {
+            KtorMonitorWindow(
+                show = showKtorMonitor,
+                onCloseRequest = { showKtorMonitor = false }
+            )
+        }
 
         Window(
             onCloseRequest = ::exitApplication,
@@ -117,9 +126,11 @@ fun main() {
             }
 
             AppMenuBar(
+                showDevelopmentTools = !releaseBuild,
                 onNewTaskListClick = { showNewTaskListDialog = true },
                 canCreateTask = selectedTaskList != null,
                 onNewTaskClick = { showNewTaskEditorSheet = true },
+                onNetworkLogClick = { showKtorMonitor = true },
             )
 
             KoinApplication(application = {
diff --git a/tasks-app-desktop/src/main/kotlin/net/opatry/tasks/app/ui/component/AppMenuBar.kt b/tasks-app-desktop/src/main/kotlin/net/opatry/tasks/app/ui/component/AppMenuBar.kt
@@ -31,15 +31,19 @@ import net.opatry.tasks.app.resources.Res
 import net.opatry.tasks.app.resources.app_menu_edit
 import net.opatry.tasks.app.resources.app_menu_edit_new_task
 import net.opatry.tasks.app.resources.app_menu_edit_new_task_list
+import net.opatry.tasks.app.resources.app_menu_tools
+import net.opatry.tasks.app.resources.app_menu_tools_show_network_logs
 import net.opatry.tasks.app.util.OS
 import net.opatry.tasks.app.util.currentOS
 import org.jetbrains.compose.resources.stringResource
 
 @Composable
 fun FrameWindowScope.AppMenuBar(
+    showDevelopmentTools: Boolean,
     onNewTaskListClick: () -> Unit,
     canCreateTask: Boolean,
     onNewTaskClick: () -> Unit,
+    onNetworkLogClick: () -> Unit,
 ) {
     MenuBar {
         Menu(stringResource(Res.string.app_menu_edit), mnemonic = 'E') {
@@ -63,5 +67,18 @@ fun FrameWindowScope.AppMenuBar(
                 onClick = onNewTaskClick
             )
         }
+        if (showDevelopmentTools) {
+            Menu(stringResource(Res.string.app_menu_tools), mnemonic = 'T') {
+                Item(
+                    text = stringResource(Res.string.app_menu_tools_show_network_logs),
+                    shortcut = when (currentOS) {
+                        OS.Mac -> KeyShortcut(key = Key.L, meta = true, shift = true)
+                        OS.Linux,
+                        OS.Windows -> KeyShortcut(key = Key.L, ctrl = true, shift = true)
+                    },
+                    onClick = onNetworkLogClick
+                )
+            }
+        }
     }
 }
diff --git a/tasks-app-desktop/src/main/resources/licenses_desktop.json b/tasks-app-desktop/src/main/resources/licenses_desktop.json
@@ -1562,6 +1562,20 @@
             "organization": {
                 "name": "QOS.ch"
             }
+        },
+        {
+            "uniqueId": "ro.cosminmihu.ktor:ktor-monitor-logging-no-op",
+            "developers": [
+                {
+                    "name": "Cosmin Mihu"
+                }
+            ],
+            "artifactVersion": "1.7.1",
+            "description": "Powerful tools to log Ktor Client requests and responses, making it easier to debug and analyze network communication.",
+            "name": "Ktor Monitor",
+            "licenses": [
+                "Apache-2.0"
+            ]
         }
     ],
     "licenses": {
diff --git a/tasks-app-shared/build.gradle.kts b/tasks-app-shared/build.gradle.kts
@@ -42,6 +42,8 @@ compose.resources {
     generateResClass = auto
 }
 
+val ciBuild = (findProperty("ci") as? String).toBoolean()
+
 kotlin {
     jvm()
 
@@ -110,6 +112,14 @@ kotlin {
             implementation(projects.lucideIcons)
         }
 
+        commonMain.dependencies {
+            if (ciBuild) {
+                implementation(libs.ktor.monitor.logging.no.op)
+            } else {
+                implementation(libs.ktor.monitor.logging)
+            }
+        }
+
         commonTest.dependencies {
             implementation(kotlin("test"))
 
diff --git a/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/di/networkModule.kt b/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/di/networkModule.kt
@@ -35,6 +35,7 @@ import io.ktor.client.plugins.defaultRequest
 import io.ktor.client.plugins.logging.LogLevel
 import io.ktor.client.plugins.logging.Logger
 import io.ktor.client.plugins.logging.Logging
+import io.ktor.http.HttpHeaders
 import io.ktor.http.URLBuilder
 import io.ktor.http.encodedPath
 import io.ktor.http.takeFrom
@@ -49,6 +50,9 @@ import net.opatry.tasks.CredentialsStorage
 import net.opatry.tasks.TokenCache
 import org.koin.core.qualifier.named
 import org.koin.dsl.module
+import ro.cosminmihu.ktor.monitor.ContentLength
+import ro.cosminmihu.ktor.monitor.KtorMonitorLogging
+import kotlin.time.Duration.Companion.hours
 import kotlin.time.Duration.Companion.seconds
 import net.opatry.logging.Logger as TaskfolioLogger
 
@@ -82,6 +86,12 @@ val networkModule = module {
                     }
                 }
             }
+            install(KtorMonitorLogging) {
+                sanitizeHeader { header -> header == HttpHeaders.Authorization }
+                showNotification = true
+                retentionPeriod = 1.hours
+                maxContentLength = ContentLength.Default
+            }
             install(HttpCache)
             install(Auth) {
                 bearer {
