adding new UI messaging for patch descriptions and removing redundant view diff buttons

Author: ntarakad-aws

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/ArtifactHandler.kt

@@ -75,6 +75,13 @@ import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildSt
 const val DOWNLOAD_PROXY_WILDCARD_ERROR: String = "Dangling meta character '*' near index 0"
 const val DOWNLOAD_SSL_HANDSHAKE_ERROR: String = "Unable to execute HTTP request: javax.net.ssl.SSLHandshakeException"
 const val INVALID_ARTIFACT_ERROR: String = "Invalid artifact"
+val patchDescriptions: Map<String, String> = mapOf(
+    "Minimal Compatible Library Upgrade to Java 17" to "This diff patch covers the set of upgrades for Springboot, JUnit, and PowerMockito frameworks.",
+    "Popular Enterprise Specifications and Application Frameworks" to "This diff patch covers the set of upgrades for Jakarta EE 10, Hibernate 6.2, and Micronaut 3.",
+    "HTTP Client Utilities, Apache Commons Utilities, and Web Frameworks" to "This diff patch covers the set of upgrades for Apache HTTP Client 5, Apache Commons utilities (Collections, IO, Lang, Math), Struts 6.0.",
+    "Testing Tools and Frameworks" to "This diff patch covers the set of upgrades for ArchUnit, Mockito, TestContainers, Cucumber, and additionally, Jenkins plugins and the Maven Wrapper.",
+    "Miscellaneous Processing Documentation" to "This diff patch covers a diverse set of upgrades spanning ORMs, XML processing, API documentation, and more."
+)
 
 class ArtifactHandler(private val project: Project, private val clientAdaptor: GumbyClient, private val codeTransformChatHelper: CodeTransformChatHelper? = null) {
     private val telemetry = CodeTransformTelemetryManager.getInstance(project)
@@ -212,7 +219,7 @@ class ArtifactHandler(private val project: Project, private val clientAdaptor: G
 //                path = result.first
 //                totalDownloadBytes = result.second
 //                zipPath = path.toAbsolutePath().toString()
-                zipPath = "/Users/ntarakad/Desktop/SampleArtifact.zip"
+                zipPath = "/Users/ntarakad/Desktop/SampleArtifactOneDiffNoJson.zip"
                 LOG.info { "Successfully converted the download to a zip at $zipPath." }
             } catch (e: Exception) {
                 LOG.error { e.message.toString() }
@@ -277,7 +284,11 @@ class ArtifactHandler(private val project: Project, private val clientAdaptor: G
                 null,
                 ChangeListManager.getInstance(project)
                     .addChangeList(
-                        diffDescription?.name ?: patchFile.name,
+                        if (diffDescription != null) {
+                            "${diffDescription.name} (${if (diffDescription.isSuccessful) "Success" else "Failure"})"
+                        } else {
+                            patchFile.name
+                        },
                         ""),
                 null,
                 null,
@@ -292,9 +303,14 @@ class ArtifactHandler(private val project: Project, private val clientAdaptor: G
                     telemetry.viewArtifact(CodeTransformArtifactType.ClientInstructions, jobId, "Submit", source)
                     setCurrentPatchIndex(getCurrentPatchIndex() + 1)
                     if (getCurrentPatchIndex() < totalPatchFiles){
+                        val message = if (diffDescription != null) {
+                            "I applied the changes in diff patch ${getCurrentPatchIndex()} of $totalPatchFiles. ${patchDescriptions[diffDescription.name]} You can make a commit if the diff shows success. If the diff shows partial success, apply and fix the errors, and start a new transformation."
+                        } else {
+                            "I applied the changes to your project."
+                        }
                         val resultContent = CodeTransformChatMessageContent(
                             type = CodeTransformChatMessageType.PendingAnswer,
-                            message = message("codemodernizer.chat.message.result.success"),
+                            message = message,
                             buttons = listOf(createViewDiffButton("View diff ${getCurrentPatchIndex() + 1}/${totalPatchFiles}"), viewSummaryButton),
                         )
                         codeTransformChatHelper?.updateLastPendingMessage(resultContent)

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/CodeModernizerManager.kt

@@ -560,11 +560,11 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
             resumeJob(session, lastJobId, currentJobResult)
         }
 
-    private fun displayDiffNotificationAction(jobId: JobId): NotificationAction = NotificationAction.createSimple(
-        message("codemodernizer.notification.info.modernize_complete.view_diff")
-    ) {
-        artifactHandler.displayDiffAction(jobId, CodeTransformVCSViewerSrcComponents.ToastNotification)
-    }
+//    private fun displayDiffNotificationAction(jobId: JobId): NotificationAction = NotificationAction.createSimple(
+//        message("codemodernizer.notification.info.modernize_complete.view_diff")
+//    ) {
+//        artifactHandler.displayDiffAction(jobId, CodeTransformVCSViewerSrcComponents.ToastNotification)
+//    }
 
     private fun displaySummaryNotificationAction(jobId: JobId) =
         NotificationAction.createSimple(message("codemodernizer.notification.info.modernize_complete.view_summary")) {
@@ -622,7 +622,7 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
                     message("codemodernizer.notification.info.modernize_partial_complete.title"),
                     message("codemodernizer.notification.info.modernize_partial_complete.content", result.targetJavaVersion.description),
                     project,
-                    listOf(displayDiffNotificationAction(result.jobId), displaySummaryNotificationAction(result.jobId), displayFeedbackNotificationAction()),
+                    listOf(displaySummaryNotificationAction(result.jobId), displayFeedbackNotificationAction()),
                 )
                 jobId = result.jobId
             }
@@ -632,7 +632,7 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
                     message("codemodernizer.notification.info.modernize_complete.title"),
                     message("codemodernizer.notification.info.modernize_complete.content"),
                     project,
-                    listOf(displayDiffNotificationAction(result.jobId), displaySummaryNotificationAction(result.jobId)),
+                    listOf(displaySummaryNotificationAction(result.jobId)),
                 )
                 jobId = result.jobId
             }

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/constants/CodeTransformChatItems.kt

@@ -361,6 +361,11 @@ fun buildTransformBeginChatContent() = CodeTransformChatMessageContent(
     message = message("codemodernizer.chat.message.transform_begin"),
 )
 
+fun buildMultipleDiffsChatContent() = CodeTransformChatMessageContent(
+    type = CodeTransformChatMessageType.PendingAnswer,
+    message = message("codemodernizer.chat.message.multiple_patch_descriptions")
+)
+
 fun buildTransformInProgressChatContent() = CodeTransformChatMessageContent(
     type = CodeTransformChatMessageType.PendingAnswer,
     message = message("codemodernizer.chat.message.transform_in_progress"),

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/controller/CodeTransformChatController.kt

@@ -42,6 +42,7 @@ import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildHi
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildHilRejectContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildHilResumeWithErrorContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildHilResumedContent
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildMultipleDiffsChatContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildProjectInvalidChatContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildProjectValidChatContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildStartNewTransformFollowup
@@ -173,6 +174,7 @@ class CodeTransformChatController(
                 codeTransformChatHelper.addNewMessage(buildTransformInProgressChatContent())
             } else {
                 codeTransformChatHelper.addNewMessage(buildTransformBeginChatContent())
+                codeTransformChatHelper.addNewMessage(buildMultipleDiffsChatContent())
                 codeTransformChatHelper.addNewMessage(buildTransformInProgressChatContent())
             }
             return true
@@ -503,6 +505,7 @@ class CodeTransformChatController(
 
     private suspend fun handleCodeTransformUploadCompleted() {
         codeTransformChatHelper.addNewMessage(buildTransformBeginChatContent())
+        codeTransformChatHelper.addNewMessage(buildMultipleDiffsChatContent())
         codeTransformChatHelper.addNewMessage(buildTransformInProgressChatContent())
     }
 

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/model/CodeModernizerArtifact.kt

@@ -61,7 +61,7 @@ open class CodeModernizerArtifact(
                 }
 //                notifyStickyInfo("Zip", path.name)
 //                notifyStickyInfo("Zip", tempDir.path)
-                tempDir = tempDir.resolve("SampleArtifact")
+                tempDir = tempDir.resolve("SampleArtifactOneDiffNoJson")
                 val manifest = loadManifest()
                 if (manifest.version > maxSupportedVersion) {
                     // If not supported we can still try to use it, i.e. the versions should largely be backwards compatible

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/panels/managers/CodeModernizerBottomWindowPanelManager.kt

@@ -209,7 +209,7 @@ class CodeModernizerBottomWindowPanelManager(private val project: Project) : JPa
     private fun setJobCompletedSuccessfullyUI() {
         add(BorderLayout.CENTER, buildProgressSplitterPanelManager)
         buildProgressSplitterPanelManager.apply {
-            addViewDiffToBanner()
+//            addViewDiffToBanner()
             addViewSummaryToBanner()
             banner.updateContent(message("codemodernizer.toolwindow.banner.run_scan_complete"), AllIcons.Actions.Commit)
             setSplitPanelStopView()

plugins/core/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties

@@ -618,6 +618,13 @@ codemodernizer.chat.message.skip_tests_form.response=Okay, I will {0} when build
 codemodernizer.chat.message.skip_tests_form.run_tests=Run unit tests
 codemodernizer.chat.message.skip_tests_form.skip=Skip unit tests
 codemodernizer.chat.message.transform_begin=I'm starting to transform your code. It can take 10 to 30 minutes to upgrade your code, depending on the size of your module. To monitor progress, go to the Transformation Hub.
+codemodernizer.chat.message.multiple_patch_descriptions=\
+I will be dividing my proposed changes into smaller sections. Here is a description of what each section entails:\n\n\
+? Minimal Compatible Library Upgrade to Java 17: This upgrades dependencies to the minimum compatible versions in Java 17. It also includes updated versions of Springboot as well as JUnit and PowerMockito frameworks.\n\n\
+? Popular Enterprise Specifications Application Frameworks: This group aims to migrate to the latest versions of popular enterprise specifications and application frameworks like Jakarta EE 10 (the new javax namespace), Hibernate 6.2 (a widely used ORM), and Micronaut 3 (a modern, lightweight full-stack framework).\n\n\
+? HTTP Client Utilities Web Frameworks: This section targets upgrades for HTTP client libraries (Apache HTTP Client 5), Apache Commons utilities (Collections, IO, Lang, Math), and web frameworks (Struts 6.0). The goal is to modernize these commonly used libraries and frameworks to their latest versions, ensuring compatibility with Java 17.\n\n\
+? Testing Tools Frameworks: This set upgrades targets testing tools and frameworks like ArchUnit, Mockito, TestContainers, and Cucumber. Additionally, it updates build tools like Jenkins plugins and the Maven Wrapper. The goal is to bring the testing ecosystem and build tooling up-to-date with the latest versions and best practices.\n\n\
+? Miscellaneous Processing Documentation: This group covers a diverse set of upgrades spanning ORMs (JpaRepository), XML processing (JAXB namespace), application servers (WebSphere to Liberty migration), API documentation (Swagger to SpringDoc/OpenAPI), and utilities (Okio, OkHttp, LaunchDarkly)
 codemodernizer.chat.message.transform_cancelled_by_user=I cancelled your transformation. If you want to start another transformation, choose **Start a new transformation**.
 codemodernizer.chat.message.transform_in_progress=If I run into any issues, I might pause the transformation to get input from you on how to proceed.
 codemodernizer.chat.message.transform_stopped_by_user=I stopped your transformation. If you want to start another transformation, choose **Start a new transformation**.
@@ -733,7 +740,6 @@ codemodernizer.notification.warn.zip_creation_failed=Amazon Q could not zip the
 codemodernizer.notification.warn.zip_creation_failed.reasons.unknown=An unexpected error occurred
 codemodernizer.notification.warn.zip_too_large.content=Sorry, your project size exceeds the Amazon Q Code Transformation upload limit of 2GB.
 codemodernizer.notification.warn.zip_too_large.title=Project size exceeds limit
-codemodernizer.patch.name=Patch with code changes required to upgrade to Java 17
 codemodernizer.toolwindow.banner.action.diff=View diff
 codemodernizer.toolwindow.banner.action.feedback=Provide Feedback
 codemodernizer.toolwindow.banner.action.plan=View transformation plan