feat(amazonq): Add support for complex workspaces for /dev and /doc. #5411

ctidd · 2025-02-26T08:32:08Z

This provides multi-content-root workspace support for /dev and /doc.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Description

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:

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.
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.)
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:

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).

Checklist

My code follows the code style of this project
I have added tests to cover my changes
[TODO] A short description of the change has been added to the CHANGELOG if the change is customer-facing in the IDE.
I have added metrics for my changes (if required)

License

I confirm that my contribution is made under the terms of the Apache 2.0 license.

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

...etbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/project/Workspace.kt

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

+import software.aws.toolkits.jetbrains.services.amazonq.QConstants.MAX_FILE_SIZE_BYTES
+import software.aws.toolkits.jetbrains.utils.isDevFile
+import software.aws.toolkits.resources.AwsCoreBundle
+import software.aws.toolkits.telemetry.AmazonqTelemetry


...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

+import software.aws.toolkits.jetbrains.services.amazonq.QConstants.MAX_FILE_SIZE_BYTES
+import software.aws.toolkits.jetbrains.utils.isDevFile
+import software.aws.toolkits.resources.AwsCoreBundle
+import software.aws.toolkits.telemetry.AmazonqTelemetry


vikshe · 2025-03-11T15:47:24Z

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

+
+    private suspend fun createTemporaryZipFileAsync(block: suspend (FileSystem) -> Unit): Path = withContext(getCoroutineBgContext()) {
+        // Don't use Files.createTempFile since the file must not be created for ZipFS to work
+        val tempFilePath: Path = Paths.get(FileUtils.getTempDirectory().absolutePath, "${UUID.randomUUID()}.zip")


I think it's better to create specific folder in the temp location and store zip there.
Also how is the zip file deleted after upload ?

This is the existing impl, so I'm confident in how it works already. It just looks new here because the file is moved.

vikshe · 2025-03-11T16:00:56Z

...ommunity/src/software/aws/toolkits/jetbrains/services/amazonqDoc/controller/DocController.kt

@@ -967,7 +966,7 @@ class DocController(
                message = message("amazonqDoc.prompt.choose_folder_to_continue")
            )

-            val selectedFolder = selectFolder(context.project, currentSourceFolder)
+            val selectedFolder = selectFolder(context.project, workspaceRoot)


should it be session.context.selectionRoot instead ?

This is a small change in behavior, which handles a niche case slightly more in line with a workspace-oriented view. This behavior changes when a user selects a folder, and then triggers folder selection again.

Before: The file tree is opened on the current source folder to select new source folder.

Now: The file tree is opened on the workspace root to select a new source folder. (Like it was for the initial selection.)

This is a more workspace-oriented behavior (i.e. "select what you want") instead of nudging the user toward a folder inside their selected working folder, when the user selects a different folder multiple times.

...etbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/project/Workspace.kt

rli · 2025-03-12T04:57:55Z

...nity/tst/software/aws/toolkits/jetbrains/services/amazonq/workspace/context/WorkspaceTest.kt

+import kotlin.io.path.deleteExisting
+import kotlin.io.path.exists
+
+class WorkspaceTest : LightPlatformTestCase() {


generally we've been trying to move to junit5 but ok

rli · 2025-03-12T05:04:46Z

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

+
+    // This function checks for existence of `devfile.yaml` in customer's repository, currently only `devfile.yaml` is supported for this feature.
+    fun checkForDevFile(): Boolean {
+        val devFile = File(addressableRoot.toString(), "devfile.yaml")


devfile.yml is also valid according to spec

rli · 2025-03-12T05:09:39Z

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt

+        val filesToIncludeFlow = channelFlow {
+            // chunk with some reasonable number because we don't actually need a new job for each file
+            files.chunked(50).forEach { chunk ->
+                launch {
+                    for (file in chunk) {
+                        send(file)
+                    }
+                }
+            }
+        }


i see that this is the existing impl, but the flow seems superfluous for what is being accomplished here

rli · 2025-03-12T05:11:13Z

...etbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/project/Workspace.kt

+val additionalGlobalIgnoreRulesForStrictSources =
+    additionalGlobalIgnoreRules +
+        listOf(
+            // FIXME: It is incredibly brittle that this source of truth is a "telemetry" component


ctidd force-pushed the ctidd/multiroot branch from a7c114d to 78d68d6 Compare February 26, 2025 08:53

github-advanced-security bot found potential problems Feb 26, 2025

View reviewed changes

...ity/src/software/aws/toolkits/jetbrains/services/amazonq/project/FeatureDevSessionContext.kt Fixed Show fixed Hide fixed

...etbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/project/Workspace.kt Fixed Show fixed Hide fixed

ctidd force-pushed the ctidd/multiroot branch 2 times, most recently from 185a18e to 342b5a4 Compare March 9, 2025 11:33

ctidd changed the title ~~feat(amazonq): Add support for multi-project workspaces.~~ feat(amazonq): Add support for complex workspaces for /dev and /doc. Mar 9, 2025

ctidd force-pushed the ctidd/multiroot branch 2 times, most recently from 138964f to 8854f88 Compare March 9, 2025 11:52

github-advanced-security bot found potential problems Mar 9, 2025

View reviewed changes

ctidd force-pushed the ctidd/multiroot branch 2 times, most recently from 43f93d6 to 494314e Compare March 9, 2025 20:07

ctidd linked an issue Mar 11, 2025 that may be closed by this pull request

/dev feature only works on one module, not all in workspace #5085

Closed

ctidd force-pushed the ctidd/multiroot branch from 494314e to bf817f3 Compare March 11, 2025 04:38

ctidd requested review from rli and neilk-aws March 11, 2025 04:53

ctidd marked this pull request as ready for review March 11, 2025 04:54

ctidd requested review from a team as code owners March 11, 2025 04:54

vikshe reviewed Mar 11, 2025

View reviewed changes

ctidd commented Mar 11, 2025

View reviewed changes

...etbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/project/Workspace.kt Outdated Show resolved Hide resolved

ctidd force-pushed the ctidd/multiroot branch 2 times, most recently from bd75d40 to 24a65dc Compare March 11, 2025 21:27

neilk-aws approved these changes Mar 11, 2025

View reviewed changes

ctidd force-pushed the ctidd/multiroot branch 2 times, most recently from ffbc9d8 to ce0e40c Compare March 11, 2025 23:39

rli approved these changes Mar 12, 2025

View reviewed changes

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

27b2aac

ctidd force-pushed the ctidd/multiroot branch from ce0e40c to 27b2aac Compare March 12, 2025 17:20

rli merged commit 3f3726b into aws:main Mar 12, 2025
3 of 11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(amazonq): Add support for complex workspaces for /dev and /doc. #5411

feat(amazonq): Add support for complex workspaces for /dev and /doc. #5411

ctidd commented Feb 26, 2025 •

edited

Loading

vikshe Mar 11, 2025

ctidd Mar 11, 2025

vikshe Mar 11, 2025

ctidd Mar 11, 2025 •

edited

Loading

rli Mar 12, 2025

rli Mar 12, 2025

rli Mar 12, 2025

rli Mar 12, 2025

feat(amazonq): Add support for complex workspaces for /dev and /doc. #5411

feat(amazonq): Add support for complex workspaces for /dev and /doc. #5411

Conversation

ctidd commented Feb 26, 2025 • edited Loading

Types of changes

Description

Checklist

License

vikshe Mar 11, 2025

Choose a reason for hiding this comment

ctidd Mar 11, 2025

Choose a reason for hiding this comment

vikshe Mar 11, 2025

Choose a reason for hiding this comment

ctidd Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

rli Mar 12, 2025

Choose a reason for hiding this comment

rli Mar 12, 2025

Choose a reason for hiding this comment

rli Mar 12, 2025

Choose a reason for hiding this comment

rli Mar 12, 2025

Choose a reason for hiding this comment

ctidd commented Feb 26, 2025 •

edited

Loading

ctidd Mar 11, 2025 •

edited

Loading