Merge pull request #137 from getditto/zan/rotating-logs

Update logExporter to use rotating logs

Author: zmarkan

Diff for: DittoExportLogs/build.gradle

@@ -18,6 +18,7 @@ dependencies {
     implementation libs.androidx.compose.material3.material3
     implementation libs.androidx.compose.ui.ui
     implementation libs.androidx.navigation.navigationCompose
+    implementation(libs.live.ditto.ditto)
     // Dependency constraint for ditto
     constraints {
         implementation(libs.live.ditto.ditto) {
@@ -26,6 +27,7 @@ dependencies {
             }
         }
     }
+
     implementation libs.live.ditto.exporter
     implementation platform(libs.androidx.compose.composeBom)
 

Diff for: DittoExportLogs/src/main/java/live/ditto/dittoexportlogs/DittoLogManager.kt

@@ -1,26 +1,90 @@
 package live.ditto.dittoexportlogs
 
+import android.os.Build
+import android.os.Environment
+import androidx.annotation.RequiresApi
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.size
+import androidx.compose.foundation.layout.width
+import androidx.compose.material3.AlertDialog
+import androidx.compose.material3.Button
+import androidx.compose.material3.CircularProgressIndicator
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.stringResource
-import live.ditto.exporter.ExportDialog
-import java.nio.file.Path
+import androidx.compose.ui.unit.dp
+import kotlinx.coroutines.launch
+import java.io.File
+import java.time.LocalDateTime
+import java.time.format.DateTimeFormatter
 
+@RequiresApi(Build.VERSION_CODES.O)
 @Composable
-fun ExportLogs(onDismiss: () -> Unit) {
-    ExportDialog(
-        title = stringResource(R.string.export_logs),
-        text = stringResource(R.string.do_you_want_to_export_logs),
-        confirmText = stringResource(R.string.export),
-        cancelText = stringResource(R.string.cancel),
-        fileProvider = { getZippedLogs().toFile() },
-        mimeType = stringResource(R.string.application_x_zip),
-        onDismiss = onDismiss
+fun ExportLogs(onDismiss: () -> Unit, viewModel: ExportLogsViewModel = ExportLogsViewModel()) {
+
+    val isLoading by remember { mutableStateOf(viewModel.isLoading)}
+
+    val title = stringResource(R.string.export_logs)
+
+    val confirmText = stringResource(R.string.export)
+    val cancelText = stringResource(R.string.cancel)
+    val context = LocalContext.current
+
+    val now = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMdd_HHmmss"))
+    val appName = context.applicationInfo.loadLabel(context.packageManager).toString()
+
+    val fileName = "$appName-dittologs-$now.jsonl.gz"
+    val downloadsDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS)
+    val filePath = File(downloadsDir, fileName).absolutePath
+
+    AlertDialog(
+        onDismissRequest = onDismiss,
+        title = {
+            Text(title)
+        },
+        text = {
+            Text(stringResource(R.string.export_logs_message, fileName))
+        },
+
+        confirmButton = {
+            Button(
+                onClick = {
+                       viewModel.exportLogs(filePath, context, onDismiss)
+                }
+            ) {
+                Row {
+                    Text(confirmText)
+
+                    if (isLoading) {
+                        Spacer(Modifier.width(16.dp))
+
+                        CircularProgressIndicator(
+                            modifier = Modifier.size(18.dp),
+                            color = MaterialTheme.colorScheme.onPrimary,
+                            strokeWidth = 2.dp
+                        )
+                    }
+                }
+            }
+        },
+        dismissButton = {
+            Button(
+                onClick = onDismiss,
+            ) {
+                Text(cancelText)
+            }
+        }
     )
 }
 
-private fun getZippedLogs(): Path {
-    return DittoLogManager.createLogsZip()
-}
 
 
 

Diff for: DittoExportLogs/src/main/java/live/ditto/dittoexportlogs/ExportLogs.kt

@@ -0,0 +1,39 @@
+package live.ditto.dittoexportlogs
+
+import android.content.Context
+import android.util.Log
+import android.widget.Toast
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.setValue
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import kotlinx.coroutines.launch
+import live.ditto.DittoError
+import live.ditto.DittoLogger
+
+class ExportLogsViewModel : ViewModel() {
+
+    var isLoading by mutableStateOf(false)
+        private set
+
+    fun exportLogs(filePath: String, context: Context, onDismiss: () -> Unit) {
+        viewModelScope.launch {
+            isLoading = true
+            try {
+                val sizeWritten = DittoLogger.exportToFile(filePath)
+
+                val sizeWrittenInKB = (sizeWritten / 1024u).toInt()
+                val toastText = context.getString(R.string.exported_file_size_kb, sizeWrittenInKB)
+                Toast.makeText(context, toastText, Toast.LENGTH_LONG).show()
+            } catch (e: DittoError.IoError) {
+                Log.e("DittoTools LogExporter", e.reason.toString())
+                Toast.makeText(context,
+                    context.getString(R.string.error_exporting_logs, e.message), Toast.LENGTH_LONG).show()
+            } finally {
+                isLoading = false
+                onDismiss()
+            }
+        }
+    }
+}

Diff for: DittoExportLogs/src/main/java/live/ditto/dittoexportlogs/ExportLogsViewModel.kt

@@ -5,4 +5,7 @@
     <string name="export">Export</string>
     <string name="cancel">Cancel</string>
     <string name="application_x_zip">application/x-zip</string>
+    <string name="export_logs_message">Logs will be exported to: \nDownloads/%1$s\"</string>
+    <string name="exported_file_size_kb">Exported file size: %1$d kB</string>
+    <string name="error_exporting_logs">Error exporting logs: %1$s</string>
 </resources>

Diff for: DittoExportLogs/src/main/res/values/strings.xml

@@ -26,7 +26,7 @@ import live.ditto.dittoexportlogs.ExportLogs
 import live.ditto.dittotoolsviewer.R
 import live.ditto.dittotoolsviewer.presentation.navigation.Screens
 import live.ditto.dittotoolsviewer.presentation.viewmodel.ToolsViewerViewModel
-import live.ditto.health.ui.composables.HealthScreen
+import live.ditto.health.HealthScreen
 import live.ditto.presencedegradationreporter.PresenceDegradationReporterScreen
 
 /**

Diff for: DittoToolsViewer/src/main/java/live/ditto/dittotoolsviewer/presentation/DittoToolsViewer.kt

@@ -152,38 +152,9 @@ Maven:
 ```
 
 ### 4. Export Logs
-Export Logs allows you to export a file of the logs from your applcation.  
+Export Logs allows you to export logs from your application into a file.  
 
-**Important**
-
-Before calling `ditto.startSync()` we need to set the `DittoLogger.setLogFileURL(<logFileURL>)`. This registers a file path where logs will be written to, whenever Ditto wants to issue a log (on top of emitting the log to the console). Use the `LogFileConfig` struct:
-
-```
-object LogFileConfig {
-    private const val logsDirectoryName = "debug-logs"
-    private const val logFileName = "logs.txt"
-
-    val logsDirectory: Path by lazy {
-        val directory = Paths.get(System.getProperty("java.io.tmpdir"), logsDirectoryName)
-        Files.createDirectories(directory)
-        directory
-    }
-
-    val logFile: Path by lazy {
-        logsDirectory.resolve(logFileName)
-    }
-}
-```
-
-and then before calling `ditto.startSync()` set the log file url with:
-
-```
-LogFileConfig.logFile.let { logFile ->
-    DittoLogger.setLogFile(logFile.toString())
-}
-```
-
-Now we can call `ExportLogs()`.
+Include `ExportLogs()` in your Composable function. You can pass in a lambda function to be called when the dialog is dismissed.
 
 ```kotlin
 ExportLogs(onDismiss: () -> Unit)

Diff for: Img/exportLogs.png

@@ -95,10 +95,6 @@ class MainActivity : ComponentActivity() {
         val ditto = Ditto(androidDependencies, identity)
         DittoLogger.minimumLogLevel = DittoLogLevel.DEBUG
 
-        LogFileConfig.logFile.let { logFile ->
-            DittoLogger.setLogFile(logFile.toString())
-        }
-
         ditto
     }
 

Diff for: README.md

@@ -14,7 +14,7 @@ androidx-navigation = "2.5.3"
 androidx-test-ext = "1.1.5"
 androidx-webkit = "1.7.0"
 datastorePreferences = "1.0.0"
-ditto = "4.7.4"
+ditto = "4.8.2"
 live-ditto-tools = "2.1.0"
 
 junit = "4.13.2"