feat(amazonq): warn user if absolute path found in pom.xml (#4762)

* fix(amazonq): prevent empty chat bubble

* fix(amazonq): warn user if absolute path found in pom.xml

* git issue

* show all paths detected

* remove unused imports

* fix detekt issues

* show chat message instead of notif

* remove unused imports

* fix CI

* localize String

* fix Lint

* assert that messages match

* fix lint

* update unit test

* update text

* update text to pass CI

* address comment

* address nit

---------

Co-authored-by: David Hasani <[email protected]>

Author: dhasani23

.changes/next-release/feature-7de35bb8-364d-4397-9760-57a220132300.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "feat(Amazon Q Code Transformation): warn user if absolute path found in pom.xml"
+}

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

@@ -70,6 +70,7 @@ import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getSupporte
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.isCodeTransformAvailable
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.isGradleProject
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.openTroubleshootingGuideNotificationAction
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.parseBuildFile
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.parseXmlDependenciesReport
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.setDependencyVersionInPom
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.tryGetJdk
@@ -395,6 +396,8 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
         }
     }
 
+    fun parseBuildFile(): String? = parseBuildFile(codeTransformationSession?.sessionContext?.configurationFile)
+
     internal suspend fun initModernizationJob(session: CodeModernizerSession, copyResult: MavenCopyCommandsResult): CodeModernizerJobCompletedResult =
         when (val result = session.createModernizationJob(copyResult)) {
             is CodeModernizerStartJobResult.ZipCreationFailed -> {

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

@@ -290,9 +290,9 @@ fun buildZipUploadFailedChatMessage(failureReason: UploadFailureReason): String
     return resultMessage
 }
 
-fun buildAuthRestoredMessage() = CodeTransformChatMessageContent(
+fun buildAbsolutePathWarning(warning: String) = CodeTransformChatMessageContent(
     type = CodeTransformChatMessageType.FinalizedAnswer,
-    message = message("codemodernizer.chat.message.reauth_success"),
+    message = warning,
 )
 
 fun buildCompileLocalSuccessChatContent() = CodeTransformChatMessageContent(

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

@@ -26,6 +26,7 @@ import software.aws.toolkits.jetbrains.services.codemodernizer.client.GumbyClien
 import software.aws.toolkits.jetbrains.services.codemodernizer.commands.CodeTransformActionMessage
 import software.aws.toolkits.jetbrains.services.codemodernizer.commands.CodeTransformCommand
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.FEATURE_NAME
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildAbsolutePathWarning
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildCheckingValidProjectChatContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildCompileHilAlternativeVersionContent
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.buildCompileLocalFailedChatContent
@@ -246,6 +247,16 @@ class CodeTransformChatController(
             updateLastPendingMessage(buildCompileLocalSuccessChatContent())
         }
 
+        // show user a non-blocking warning if their build file contains an absolute path
+        try {
+            val warningMessage = codeModernizerManager.parseBuildFile()
+            if (warningMessage != null) {
+                handleAbsolutePathDetected(warningMessage)
+            }
+        } catch (e: Exception) {
+            // swallow error and move on
+        }
+
         runInEdt {
             codeModernizerManager.runModernize(mavenBuildResult)
         }
@@ -443,6 +454,9 @@ class CodeTransformChatController(
         BrowserUtil.browse(message.link)
     }
 
+    private suspend fun handleAbsolutePathDetected(warning: String) =
+        codeTransformChatHelper.addNewMessage(buildAbsolutePathWarning(warning))
+
     private suspend fun handleCodeTransformUploadCompleted() {
         codeTransformChatHelper.addNewMessage(buildTransformBeginChatContent())
         codeTransformChatHelper.addNewMessage(buildTransformInProgressChatContent())

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

@@ -10,6 +10,8 @@ import com.intellij.openapi.util.io.FileUtil
 import com.intellij.openapi.vfs.VirtualFile
 import software.aws.toolkits.core.utils.createParentDirectories
 import software.aws.toolkits.core.utils.exists
+import software.aws.toolkits.core.utils.info
+import software.aws.toolkits.jetbrains.services.codemodernizer.CodeModernizerManager.Companion.LOG
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.HIL_ARTIFACT_DIR_NAME
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.HIL_ARTIFACT_POMFOLDER_DIR_NAME
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.HIL_DEPENDENCY_REPORT_DIR_NAME
@@ -20,6 +22,8 @@ import software.aws.toolkits.jetbrains.services.codemodernizer.constants.HIL_POM
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.HIL_UPLOAD_ZIP_NAME
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.DependencyUpdatesReport
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.MAVEN_CONFIGURATION_FILE_NAME
+import software.aws.toolkits.jetbrains.services.codewhisperer.util.content
+import software.aws.toolkits.resources.message
 import java.io.File
 import java.io.FileOutputStream
 import java.nio.file.Path
@@ -70,6 +74,33 @@ fun findBuildFiles(sourceFolder: File, supportedBuildFileNames: List<String>): L
     return buildFiles
 }
 
+fun parseBuildFile(buildFile: VirtualFile?): String? {
+    val absolutePaths = mutableListOf("users/", "system/", "volumes/", "c:\\", "d:\\")
+    val alias = System.getProperty("user.home").substringAfterLast(File.separator)
+    absolutePaths.add(alias)
+    if (buildFile != null && buildFile.exists()) {
+        val buildFileContents = buildFile.content().lowercase()
+        val detectedPaths: MutableList<String> = mutableListOf()
+        for (path in absolutePaths) {
+            if (buildFileContents.contains(path)) {
+                detectedPaths.add(path)
+            }
+        }
+        if (detectedPaths.size > 0) {
+            val warningMessage =
+                message(
+                    "codemodernizer.chat.message.absolute_path_detected",
+                    detectedPaths.size,
+                    buildFile.name,
+                    detectedPaths.joinToString(", "),
+                )
+            LOG.info { "CodeTransformation: absolute path potentially in build file" }
+            return warningMessage
+        }
+    }
+    return null
+}
+
 /**
  * Unzips a zip into a dir. Returns the true when successfully unzips the file pointed to by [zipFilePath] to [destDir]
  */

plugins/amazonq/codetransform/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codemodernizer/CodeWhispererCodeModernizerUtilsTest.kt

@@ -21,8 +21,10 @@ import software.amazon.awssdk.services.codewhispererruntime.model.Transformation
 import software.amazon.awssdk.services.ssooidc.model.InvalidGrantException
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getBillingText
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getTableMapping
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.parseBuildFile
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.pollTransformationStatusAndPlan
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.refreshToken
+import software.aws.toolkits.jetbrains.utils.rules.addFileToModule
 import java.util.concurrent.atomic.AtomicBoolean
 
 class CodeWhispererCodeModernizerUtilsTest : CodeWhispererCodeModernizerTestBase() {
@@ -206,6 +208,16 @@ class CodeWhispererCodeModernizerUtilsTest : CodeWhispererCodeModernizerTestBase
         assertThat(expected).isEqualTo(actual)
     }
 
+    @Test
+    fun `parseBuildFile can detect absolute paths in build file`() {
+        val module = projectRule.module
+        val fileText = "<project><properties><path>system/name/here</path></properties></project>"
+        val file = projectRule.fixture.addFileToModule(module, "pom.xml", fileText)
+        val expectedWarning = "I detected 1 potential absolute file path(s) in your pom.xml file: **system/**. " +
+            "Absolute file paths might cause issues when I build your code. Any errors will show up in the build log."
+        assertThat(parseBuildFile(file.virtualFile)).isEqualTo(expectedWarning)
+    }
+
     @Test
     fun `getBillingText on small project returns correct String`() {
         val expected = "<html><body style=\"line-height:2; font-family: Arial, sans-serif; font-size: 14;\"><br>" +

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

@@ -565,6 +565,7 @@ codemodernizer.builderrordialog.description.title=Error occurred when building y
 codemodernizer.chat.form.user_selection.item.choose_module=Choose a module to transform
 codemodernizer.chat.form.user_selection.item.choose_target_version=Choose the target code version
 codemodernizer.chat.form.user_selection.title=Q - Code transformation
+codemodernizer.chat.message.absolute_path_detected=I detected {0} potential absolute file path(s) in your {1} file: **{2}**. Absolute file paths might cause issues when I build your code. Any errors will show up in the build log.
 codemodernizer.chat.message.auth_prompt=Follow instructions to re-authenticate ...
 codemodernizer.chat.message.button.cancel=Cancel
 codemodernizer.chat.message.button.confirm=Confirm