Edits made for PR comments

Author: wenli-cai

gradle/libs.versions.toml

@@ -3,7 +3,7 @@
 agpVersion = "8.8.0"
 
 compileSdk = "34"
-filekitDialogsComposeVersion = "0.10.0-beta04"
+filekitDialogsComposeVersion = "0.10.0-beta03"
 minSdk = "24"
 moshiKotlinVersion = "1.15.2"
 targetSdk = "33"

workflow-trace-viewer/README.md

@@ -9,3 +9,10 @@ It can be run via Gradle using:
 ```shell
 ./gradlew :workflow-trace-viewer:run
 ```
+
+
+### External Libraries
+
+[FileKit](https://github.com/vinceglb/FileKit) is an external library made to apply file operations 
+on Kotlin and KMP projects. It's purpose in this app is to allow developers to upload their own 
+json trace files. The motivation for its use is to quickly implement a file picker.

workflow-trace-viewer/build.gradle.kts

@@ -24,7 +24,7 @@ kotlin {
         implementation(libs.kotlinx.coroutines.swing)
         implementation(compose.materialIconsExtended)
         implementation(libs.moshi.kotlin)
-        implementation("io.github.vinceglb:filekit-dialogs-compose:0.10.0-beta03")
+        implementation(libs.filekit.dialogs.compose)
       }
     }
   }

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/App.kt

@@ -10,6 +10,9 @@ import androidx.compose.ui.Modifier
 import io.github.vinceglb.filekit.PlatformFile
 import io.github.vinceglb.filekit.readString
 
+/**
+ * Main composable that provides the different layers of UI.
+ */
 @Composable
 public fun App(
   modifier: Modifier = Modifier
@@ -31,7 +34,7 @@ private fun WorkflowContent(file: PlatformFile?) {
   LaunchedEffect(file) {
     jsonString.value = file?.readString()
   }
-  val root = jsonString.value?.let { fetchRoot(it) }
+  val root = jsonString.value?.let { parseTrace(it) }
 
   if (root != null) {
     DrawWorkflowTree(root)

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/Main.kt

@@ -2,6 +2,9 @@ package com.squareup.workflow1.traceviewer
 
 import androidx.compose.ui.window.singleWindowApplication
 
+/**
+ * Main entry point for the desktop application, see [README.md] for more details.
+ */
 fun main() {
   singleWindowApplication(title = "Workflow Trace Viewer") {
     App()

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/SandboxBackground.kt

@@ -1,6 +1,7 @@
 package com.squareup.workflow1.traceviewer
 
 import androidx.compose.foundation.gestures.awaitEachGesture
+import androidx.compose.foundation.gestures.detectDragGestures
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.layout.wrapContentSize
@@ -36,34 +37,22 @@ public fun SandboxBackground(
     modifier
       .fillMaxSize()
       .pointerInput(Unit) {
-        // this allows for user's panning to view different parts of content
+        // Panning capabilities: watches for drag gestures and applies the translation
+        detectDragGestures { _, translation->
+          offset += translation
+        }
+      }
+      .pointerInput(Unit) {
+        // Zooming capabilities: watches for any scroll events and immediately consumes changes.
+        // - This is AI generated.
         awaitEachGesture {
           val event = awaitPointerEvent()
-
-          // zooming
           if (event.type == PointerEventType.Scroll) {
             val scrollDelta = event.changes.first().scrollDelta.y
             scale *= if (scrollDelta < 0) 1.1f else 0.9f
             scale = scale.coerceIn(0.1f, 10f)
             event.changes.forEach { it.consume() }
           }
-
-          // panning: this tracks multiple events within one gesture to see what the user is doing,
-          // then calculates the offset and pans the screen accordingly
-          val drag = event.changes.firstOrNull()
-          if (drag != null && drag.pressed) {
-            var prev = drag.position
-            while (true) {
-              val nextEvent = awaitPointerEvent()
-              val nextDrag = nextEvent.changes.firstOrNull() ?: break
-              if (!nextDrag.pressed) break
-
-              val delta = nextDrag.position - prev
-              offset += delta
-              prev = nextDrag.position
-              nextDrag.consume()
-            }
-          }
         }
       }
   ) {

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/UploadFile.kt

@@ -17,6 +17,10 @@ import io.github.vinceglb.filekit.PlatformFile
 import io.github.vinceglb.filekit.dialogs.FileKitType
 import io.github.vinceglb.filekit.dialogs.compose.rememberFilePickerLauncher
 
+/**
+ * Provides functionality for user to upload a JSON or .txt file from their local devices, which
+ * contains information pulled from workflow traces
+ */
 @Composable
 public fun UploadFile(
   onFileSelect: (PlatformFile?) -> Unit,

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/WorkflowJsonParser.kt

@@ -6,12 +6,12 @@ import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
 import java.io.IOException
 
 /**
- * Parses a JSON string into [WorkflowNode] with Moshi adapters
+ * Parses a JSON string into [WorkflowNode] with Moshi adapters.
  *
  * All the caught exceptions should be handled by the caller, and appropriate UI feedback should be
- * provided to user
+ * provided to user.
  */
-public fun fetchRoot(
+public fun parseTrace(
   json: String
 ): WorkflowNode? {
   return try {

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/WorkflowTree.kt

@@ -31,8 +31,8 @@ public data class WorkflowNode(
 )
 
 /**
- * Since the workflow nodes present a tree structure, we utilize a recursive function to draw the tree
- * The Column holds a subtree of nodes, and the Row holds all the children of the current node
+ * Since the workflow nodes present a tree structure, we utilize a recursive function to draw the tree.
+ * The Column holds a subtree of nodes, and the Row holds all the children of the current node.
  */
 @Composable
 public fun DrawWorkflowTree(
@@ -62,7 +62,7 @@ public fun DrawWorkflowTree(
 }
 
 /**
- * A basic box that represents a workflow node
+ * A basic box that represents a workflow node.
  */
 @Composable
 private fun DrawNode(