feat(amazonq): Add support for multi-content-root workspaces. (#5411)

**Problem:**

Q does not support multi-root workspaces for /dev, /doc, and related features.

**Solution:**

This change starts by adding a `Workspace` construct for uploads involving the `FeatureDevSessionContext`, which detects the IDE workspace's root directory as the common ancestor of the workspace's "content roots", to serve as the root of the addressable workspace filesystem layout. Then, when choosing what files to upload, files within this tree which are members of the workspace's content roots are included. This broadens /dev and /doc to support a multi-content-root workspace as a single working tree, while continuing to respect content roots of the workspace and not uploading extraneous content.

The change itself is straightforward, identifying the common ancestor and basing further work on that root. From here, a few changes unravel:

1. **Problem:** We need to add support for `.gitignore` in subdirectories (across ProjectContext and FeatureDev). Otherwise, we would confuse users with project-level `.gitignore` configurations, and it makes sense to fully support subdirectory `.gitignore` configurations rather than treat projects as a special case. **Solution:** I've **removed nearly all custom gitignore parsing** for FeatureDev, offloading the work to the IDE's VCS manager for more native gitignore support.
2. **Problem:** We need to require that uploaded files are part of a project "content root" directory, and not simply included because they are under the common ancestor directory (which would otherwise over-include ancillary directories that are not content roots as members of the IDE workspace). **Solution:** Filter uploaded content based on content roots. This matches the handling already performed by `ProjectContextProvider`, moving incrementally in the direction of common handling of workspaces across features. (**Note:** /test and /review appear to use `guessModuleDir` in their own independent context implementations, and so would continue to have minor symptoms for complex workspaces after these changes. I have not touched these areas.)
3. **Problem:** `ProjectContextProvider` had a dependency on `FeatureDevSessionContext` for its own ignore rules. **Solution:** I've reworked this implementation so that `ProjectContextProvider` and `FeatureDevSessionContext` now depend on a simplified shared primitive, which should be easier to audit and understand than the use-case specific rules that were inside `FeatureDevSessionContext`. However, `FeatureDevSessionContext` is kept in a global location to be consumed by /doc. (Removing this /doc -> /dev coupling is deeper than I was willing to go with these changes as broad as they already are.)

Additional granular changes to behavior:

1. **Problem:** We had inconsistent behaviors when auto build for /dev was enabled vs disabled. Overzealous filtering of file types was applied when it was not enabled. **Solution:** Now, filtering is applied based on what was previously the more permissive behavior of the two. Now, in both cases, only `.gitignore` and a few additional artifact-exclusion filters are applied (e.g. `.git`, `node_modules`, etc).

Author: ctidd

.changes/next-release/feature-2c04c975-cdbf-4361-94e6-4010e68af8d9.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "AmazonQ /dev and /doc: Add support for complex workspaces."
+}

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/common/session/SessionStateTypes.kt

@@ -4,7 +4,7 @@
 package software.aws.toolkits.jetbrains.common.session
 
 import software.aws.toolkits.jetbrains.common.util.AmazonQCodeGenService
-import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
+import software.aws.toolkits.jetbrains.services.amazonq.project.FeatureDevSessionContext
 
 open class SessionStateConfig(
     open val conversationId: String,

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/controller/DocController.kt

@@ -13,9 +13,6 @@ import com.intellij.diff.util.DiffUserDataKeys
 import com.intellij.ide.BrowserUtil
 import com.intellij.openapi.application.runInEdt
 import com.intellij.openapi.fileEditor.FileEditorManager
-import com.intellij.openapi.project.Project
-import com.intellij.openapi.roots.ProjectRootManager
-import com.intellij.openapi.vfs.LocalFileSystem
 import com.intellij.openapi.vfs.VfsUtil
 import com.intellij.openapi.wm.ToolWindowManager
 import com.intellij.testFramework.LightVirtualFile
@@ -31,9 +28,9 @@ import software.aws.toolkits.core.utils.info
 import software.aws.toolkits.core.utils.warn
 import software.aws.toolkits.jetbrains.common.util.selectFolder
 import software.aws.toolkits.jetbrains.core.coroutines.EDT
-import software.aws.toolkits.jetbrains.services.amazonq.RepoSizeError
 import software.aws.toolkits.jetbrains.services.amazonq.apps.AmazonQAppInitContext
 import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthController
+import software.aws.toolkits.jetbrains.services.amazonq.project.RepoSizeError
 import software.aws.toolkits.jetbrains.services.amazonq.toolwindow.AmazonQToolWindowFactory
 import software.aws.toolkits.jetbrains.services.amazonqDoc.DEFAULT_RETRY_LIMIT
 import software.aws.toolkits.jetbrains.services.amazonqDoc.DIAGRAM_SVG_EXT
@@ -81,7 +78,6 @@ import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util.Cancellat
 import software.aws.toolkits.jetbrains.services.codewhisperer.telemetry.QFeatureEvent
 import software.aws.toolkits.jetbrains.services.codewhisperer.telemetry.broadcastQEvent
 import software.aws.toolkits.resources.message
-import java.nio.file.Paths
 import java.util.UUID
 
 enum class DocGenerationStep {
@@ -308,7 +304,7 @@ class DocController(
         val session = getSessionInfo(tabId)
         val docGenerationTask = docGenerationTasks.getTask(tabId)
 
-        val currentSourceFolder = session.context.selectedSourceFolder
+        val currentSourceFolder = session.context.selectionRoot
 
         try {
             messenger.sendFolderConfirmationMessage(
@@ -405,7 +401,7 @@ class DocController(
                 inMemoryFile.isWritable = false
                 FileEditorManager.getInstance(context.project).openFile(inMemoryFile, true)
             } else {
-                val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.selectedSourceFolder)
+                val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.addressableRoot)
                 val leftDiffContent = if (existingFile == null) {
                     EmptyContent()
                 } else {
@@ -945,19 +941,9 @@ class DocController(
         }
     }
 
-    private fun isFolderPathInProjectModules(project: Project, folderPath: String): Boolean {
-        val path = Paths.get(folderPath)
-        val virtualFile = LocalFileSystem.getInstance().findFileByIoFile(path.toFile()) ?: return false
-
-        val projectFileIndex = ProjectRootManager.getInstance(project).fileIndex
-
-        return projectFileIndex.isInProject(virtualFile)
-    }
-
     private suspend fun modifyDefaultSourceFolder(tabId: String) {
         val session = getSessionInfo(tabId)
-        val currentSourceFolder = session.context.selectedSourceFolder
-        val projectRoot = session.context.projectRoot
+        val workspaceRoot = session.context.workspaceRoot
         val docGenerationTask = docGenerationTasks.getTask(tabId)
 
         withContext(EDT) {
@@ -967,7 +953,7 @@ class DocController(
                 message = message("amazonqDoc.prompt.choose_folder_to_continue")
             )
 
-            val selectedFolder = selectFolder(context.project, currentSourceFolder)
+            val selectedFolder = selectFolder(context.project, workspaceRoot)
 
             // No folder was selected
             if (selectedFolder == null) {
@@ -980,9 +966,7 @@ class DocController(
                 return@withContext
             }
 
-            val isFolderPathInProject = isFolderPathInProjectModules(context.project, selectedFolder.path)
-
-            if (!isFolderPathInProject) {
+            if (!selectedFolder.path.startsWith(workspaceRoot.path)) {
                 logger.info { "Selected folder not in workspace: ${selectedFolder.path}" }
 
                 messenger.sendAnswer(
@@ -1004,15 +988,15 @@ class DocController(
                 return@withContext
             }
 
-            if (selectedFolder.path == projectRoot.path) {
+            if (selectedFolder.path == workspaceRoot.path) {
                 docGenerationTask.folderLevel = DocFolderLevel.ENTIRE_WORKSPACE
             } else {
                 docGenerationTask.folderLevel = DocFolderLevel.SUB_FOLDER
             }
 
             logger.info { "Selected correct folder inside workspace: ${selectedFolder.path}" }
 
-            session.context.selectedSourceFolder = selectedFolder
+            session.context.selectionRoot = selectedFolder
 
             promptForDocTarget(tabId)
 

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/session/DocSession.kt

@@ -107,14 +107,12 @@ class DocSession(val tabID: String, val project: Project) {
      * Triggered by the Insert code follow-up button to apply code changes.
      */
     fun insertChanges(filePaths: List<NewFileZipInfo>, deletedFiles: List<DeletedFileInfo>) {
-        val selectedSourceFolder = context.selectedSourceFolder.toNioPath()
+        filePaths.forEach { resolveAndCreateOrUpdateFile(context.addressableRoot.toNioPath(), it.zipFilePath, it.fileContent) }
 
-        filePaths.forEach { resolveAndCreateOrUpdateFile(selectedSourceFolder, it.zipFilePath, it.fileContent) }
-
-        deletedFiles.forEach { resolveAndDeleteFile(selectedSourceFolder, it.zipFilePath) }
+        deletedFiles.forEach { resolveAndDeleteFile(context.addressableRoot.toNioPath(), it.zipFilePath) }
 
         // Taken from https://intellij-support.jetbrains.com/hc/en-us/community/posts/206118439-Refresh-after-external-changes-to-project-structure-and-sources
-        VfsUtil.markDirtyAndRefresh(true, true, true, context.selectedSourceFolder)
+        VfsUtil.markDirtyAndRefresh(true, true, true, context.addressableRoot)
     }
 
     private fun getFromReportedChanges(filePath: NewFileZipInfo): String? {
@@ -158,7 +156,7 @@ class DocSession(val tabID: String, val project: Project) {
                 }
             } else {
                 val sourceContent = reportedChange
-                    ?: VfsUtil.findRelativeFile(filePath.zipFilePath, context.selectedSourceFolder)?.content()
+                    ?: VfsUtil.findRelativeFile(filePath.zipFilePath, context.addressableRoot)?.content()
                         .orEmpty()
                 val diffMetrics = getDiffMetrics(sourceContent, content)
                 totalAddedLines += diffMetrics.insertedLines
@@ -185,7 +183,7 @@ class DocSession(val tabID: String, val project: Project) {
                 totalAddedChars += content.length
                 totalAddedLines += content.split('\n').size
             } else {
-                val existingFileContent = VfsUtil.findRelativeFile(filePath.zipFilePath, context.selectedSourceFolder)?.content()
+                val existingFileContent = VfsUtil.findRelativeFile(filePath.zipFilePath, context.addressableRoot)?.content()
                 val diffMetrics = getDiffMetrics(existingFileContent.orEmpty(), content)
                 totalAddedLines += diffMetrics.insertedLines
                 totalAddedChars += diffMetrics.insertedCharacters

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/session/DocSessionContext.kt

@@ -4,30 +4,6 @@
 package software.aws.toolkits.jetbrains.services.amazonqDoc.session
 
 import com.intellij.openapi.project.Project
-import com.intellij.openapi.vfs.VirtualFile
-import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
-import software.aws.toolkits.jetbrains.services.amazonqDoc.SUPPORTED_DIAGRAM_EXT_SET
-import software.aws.toolkits.jetbrains.services.amazonqDoc.SUPPORTED_DIAGRAM_FILE_NAME_SET
+import software.aws.toolkits.jetbrains.services.amazonq.project.FeatureDevSessionContext
 
-class DocSessionContext(project: Project, maxProjectSizeBytes: Long? = null) : FeatureDevSessionContext(project, maxProjectSizeBytes) {
-
-    /**
-     * Ensure diagram files are not ignored
-     */
-    override fun getAdditionalGitIgnoreBinaryFilesRules(): Set<String> {
-        val ignoreRules = super.getAdditionalGitIgnoreBinaryFilesRules()
-        val diagramExtRulesInGitIgnoreFormatSet = SUPPORTED_DIAGRAM_EXT_SET.map { "*.$it" }.toSet()
-        return ignoreRules - diagramExtRulesInGitIgnoreFormatSet
-    }
-
-    /**
-     * Ensure diagram files are not filtered
-     */
-    override fun isFileExtensionAllowed(file: VirtualFile): Boolean {
-        if (super.isFileExtensionAllowed(file)) {
-            return true
-        }
-
-        return file.extension != null && SUPPORTED_DIAGRAM_FILE_NAME_SET.contains(file.name)
-    }
-}
+class DocSessionContext(project: Project, maxProjectSizeBytes: Long? = null) : FeatureDevSessionContext(project, maxProjectSizeBytes)

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/FeatureDevExceptions.kt

@@ -3,7 +3,7 @@
 
 package software.aws.toolkits.jetbrains.services.amazonqFeatureDev
 
-import software.aws.toolkits.jetbrains.services.amazonq.RepoSizeError
+import software.aws.toolkits.jetbrains.services.amazonq.project.RepoSizeError
 import software.aws.toolkits.resources.message
 
 /**

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt

@@ -29,10 +29,10 @@ import software.aws.toolkits.core.utils.info
 import software.aws.toolkits.core.utils.warn
 import software.aws.toolkits.jetbrains.common.util.selectFolder
 import software.aws.toolkits.jetbrains.core.coroutines.EDT
-import software.aws.toolkits.jetbrains.services.amazonq.RepoSizeError
 import software.aws.toolkits.jetbrains.services.amazonq.apps.AmazonQAppInitContext
 import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthController
 import software.aws.toolkits.jetbrains.services.amazonq.messages.MessagePublisher
+import software.aws.toolkits.jetbrains.services.amazonq.project.RepoSizeError
 import software.aws.toolkits.jetbrains.services.amazonq.toolwindow.AmazonQToolWindowFactory
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.CodeIterationLimitException
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.DEFAULT_RETRY_LIMIT
@@ -249,7 +249,7 @@ class FeatureDevController(
         when (sessionState) {
             is PrepareCodeGenerationState -> {
                 runInEdt {
-                    val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.selectedSourceFolder)
+                    val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.addressableRoot)
 
                     val leftDiffContent = if (existingFile == null) {
                         EmptyContent()
@@ -336,7 +336,7 @@ class FeatureDevController(
             var pollAttempt = 0
             val pollDelayMs = 10L
             while (pollAttempt < 5) {
-                val file = VfsUtil.findRelativeFile(message.filePath, session.context.selectedSourceFolder)
+                val file = VfsUtil.findRelativeFile(message.filePath, session.context.addressableRoot)
                 // Wait for the file to be created and/or updated to the new content:
                 if (file != null && file.content() == filePaths.find { it.zipFilePath == fileToUpdate }?.fileContent) {
                     // Open a diff, showing the changes have been applied and the file now has identical left/right state:
@@ -729,7 +729,7 @@ class FeatureDevController(
 
             val codeWhispererSettings = CodeWhispererSettings.getInstance().getAutoBuildSetting()
             val hasDevFile = session.context.checkForDevFile()
-            val isPromptedForAutoBuildFeature = codeWhispererSettings.containsKey(session.context.getWorkspaceRoot())
+            val isPromptedForAutoBuildFeature = codeWhispererSettings.containsKey(session.context.workspaceRoot.path)
 
             if (hasDevFile && !isPromptedForAutoBuildFeature) {
                 promptAllowQCommandsConsent(messenger, tabId)
@@ -812,8 +812,7 @@ class FeatureDevController(
 
     private suspend fun modifyDefaultSourceFolder(tabId: String) {
         val session = getSessionInfo(tabId)
-        val currentSourceFolder = session.context.selectedSourceFolder
-        val projectRoot = session.context.projectRoot
+        val workspaceRoot = session.context.workspaceRoot
 
         val modifyFolderFollowUp = FollowUp(
             pillText = message("amazonqFeatureDev.follow_up.modify_source_folder"),
@@ -825,7 +824,7 @@ class FeatureDevController(
         var reason: ModifySourceFolderErrorReason? = null
 
         withContext(EDT) {
-            val selectedFolder = selectFolder(context.project, currentSourceFolder)
+            val selectedFolder = selectFolder(context.project, workspaceRoot)
             // No folder was selected
             if (selectedFolder == null) {
                 logger.info { "Cancelled dialog and not selected any folder" }
@@ -839,8 +838,7 @@ class FeatureDevController(
                 return@withContext
             }
 
-            // The folder is not in the workspace
-            if (!selectedFolder.path.startsWith(projectRoot.path)) {
+            if (!selectedFolder.path.startsWith(workspaceRoot.path)) {
                 logger.info { "Selected folder not in workspace: ${selectedFolder.path}" }
 
                 messenger.sendAnswer(
@@ -860,7 +858,7 @@ class FeatureDevController(
 
             logger.info { "Selected correct folder inside workspace: ${selectedFolder.path}" }
 
-            session.context.selectedSourceFolder = selectedFolder
+            session.context.selectionRoot = selectedFolder
             result = Result.Succeeded
 
             messenger.sendAnswer(

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/CodeGenerationState.kt

@@ -96,7 +96,7 @@ class CodeGenerationState(
                 var insertedCharacters = 0
                 codeGenerationResult.newFiles.forEach { file ->
                     // FIXME: Ideally, the before content should be read from the uploaded context instead of from disk, to avoid drift
-                    val before = config.repoContext.selectedSourceFolder
+                    val before = config.repoContext.addressableRoot
                         .toNioPath()
                         .resolve(file.zipFilePath)
                         .toFile()

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/PrepareCodeGenerationState.kt

@@ -49,7 +49,7 @@ class PrepareCodeGenerationState(
             messenger.sendAnswerPart(tabId = this.tabID, message = message("amazonqFeatureDev.chat_message.uploading_code"))
             messenger.sendUpdatePlaceholder(tabId = this.tabID, newPlaceholder = message("amazonqFeatureDev.chat_message.uploading_code"))
 
-            val isAutoBuildFeatureEnabled = CodeWhispererSettings.getInstance().isAutoBuildFeatureEnabled(this.config.repoContext.getWorkspaceRoot())
+            val isAutoBuildFeatureEnabled = CodeWhispererSettings.getInstance().isAutoBuildFeatureEnabled(this.config.repoContext.workspaceRoot.path)
             val repoZipResult = config.repoContext.getProjectZip(isAutoBuildFeatureEnabled = isAutoBuildFeatureEnabled)
             val zipFileChecksum = repoZipResult.checksum
             zipFileLength = repoZipResult.contentLength

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/Session.kt

@@ -8,8 +8,8 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VfsUtil
 import software.aws.toolkits.jetbrains.common.util.resolveAndCreateOrUpdateFile
 import software.aws.toolkits.jetbrains.common.util.resolveAndDeleteFile
-import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
 import software.aws.toolkits.jetbrains.services.amazonq.messages.MessagePublisher
+import software.aws.toolkits.jetbrains.services.amazonq.project.FeatureDevSessionContext
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.CODE_GENERATION_RETRY_LIMIT
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.ConversationIdNotFoundException
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.FEATURE_NAME
@@ -130,14 +130,13 @@ class Session(val tabID: String, val project: Project) {
     ) {
         val newFilePaths = filePaths.filter { !it.rejected && !it.changeApplied }
         val newDeletedFiles = deletedFiles.filter { !it.rejected && !it.changeApplied }
-        val selectedSourceFolder = context.selectedSourceFolder.toNioPath()
 
         runCatching {
             var insertedLines = 0
             var insertedCharacters = 0
             filePaths.forEach { file ->
                 // FIXME: Ideally, the before content should be read from the uploaded context instead of from disk, to avoid drift
-                val before = selectedSourceFolder
+                val before = context.addressableRoot.toNioPath()
                     .resolve(file.zipFilePath)
                     .toFile()
                     .let { f ->
@@ -174,18 +173,16 @@ class Session(val tabID: String, val project: Project) {
         ReferenceLogController.addReferenceLog(references, project)
 
         // Taken from https://intellij-support.jetbrains.com/hc/en-us/community/posts/206118439-Refresh-after-external-changes-to-project-structure-and-sources
-        VfsUtil.markDirtyAndRefresh(true, true, true, context.selectedSourceFolder)
+        VfsUtil.markDirtyAndRefresh(true, true, true, context.addressableRoot)
     }
 
 // Suppressing because insertNewFiles needs to be a suspend function in order to be tested
     @Suppress("RedundantSuspendModifier")
     suspend fun insertNewFiles(
         filePaths: List<NewFileZipInfo>,
     ) {
-        val selectedSourceFolder = context.selectedSourceFolder.toNioPath()
-
         filePaths.forEach {
-            resolveAndCreateOrUpdateFile(selectedSourceFolder, it.zipFilePath, it.fileContent)
+            resolveAndCreateOrUpdateFile(context.addressableRoot.toNioPath(), it.zipFilePath, it.fileContent)
             it.changeApplied = true
         }
     }
@@ -195,10 +192,8 @@ class Session(val tabID: String, val project: Project) {
     suspend fun applyDeleteFiles(
         deletedFiles: List<DeletedFileInfo>,
     ) {
-        val selectedSourceFolder = context.selectedSourceFolder.toNioPath()
-
         deletedFiles.forEach {
-            resolveAndDeleteFile(selectedSourceFolder, it.zipFilePath)
+            resolveAndDeleteFile(context.addressableRoot.toNioPath(), it.zipFilePath)
             it.changeApplied = true
         }
     }

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/SessionStateTypes.kt

@@ -4,7 +4,7 @@
 package software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session
 
 import com.fasterxml.jackson.annotation.JsonValue
-import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
+import software.aws.toolkits.jetbrains.services.amazonq.project.FeatureDevSessionContext
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util.CancellationTokenSource
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util.FeatureDevService
 import software.aws.toolkits.jetbrains.services.cwc.messages.RecommendationContentSpan