Skip to content

Commit fec3b27

Browse files
author
Viktor Shesternyak
committedFeb 18, 2025
fix(amazonq): /doc add suppoort for uploading architecture diagrams
1 parent f5460c7 commit fec3b27

File tree

8 files changed

+127
-72
lines changed

8 files changed

+127
-72
lines changed
 

‎.changes/next-release/feature-bfb6687a-a302-4968-8e7e-8fa0d4ef6c53.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"type" : "feature",
3+
"description" : "Amazon Q /doc: support making changes to architecture diagrams"
4+
}

‎plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/DocConstants.kt

+5-27
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33

44
package software.aws.toolkits.jetbrains.services.amazonqDoc
55

6-
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUp
7-
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUpStatusType
8-
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUpTypes
9-
import software.aws.toolkits.resources.message
10-
116
const val FEATURE_EVALUATION_PRODUCT_NAME = "DocGeneration"
127

138
const val FEATURE_NAME = "Amazon Q Documentation Generation"
@@ -21,25 +16,8 @@ const val DEFAULT_RETRY_LIMIT = 0
2116
// Max allowed size for a repository in bytes
2217
const val MAX_PROJECT_SIZE_BYTES: Long = 200 * 1024 * 1024
2318

24-
enum class ModifySourceFolderErrorReason(
25-
private val reasonText: String,
26-
) {
27-
ClosedBeforeSelection("ClosedBeforeSelection"),
28-
NotInWorkspaceFolder("NotInWorkspaceFolder"),
29-
;
30-
31-
override fun toString(): String = reasonText
32-
}
33-
34-
val NEW_SESSION_FOLLOWUPS: List<FollowUp> = listOf(
35-
FollowUp(
36-
pillText = message("amazonqDoc.prompt.reject.new_task"),
37-
type = FollowUpTypes.NEW_TASK,
38-
status = FollowUpStatusType.Info
39-
),
40-
FollowUp(
41-
pillText = message("amazonqDoc.prompt.reject.close_session"),
42-
type = FollowUpTypes.CLOSE_SESSION,
43-
status = FollowUpStatusType.Info
44-
)
45-
)
19+
const val INFRA_DIAGRAM_PREFIX = "infra."
20+
const val DIAGRAM_SVG_EXT = "svg"
21+
const val DIAGRAM_DOT_EXT = "dot"
22+
val SUPPORTED_DIAGRAM_EXT_SET: Set<String> = setOf(DIAGRAM_SVG_EXT, DIAGRAM_DOT_EXT)
23+
val SUPPORTED_DIAGRAM_FILE_NAME_SET: Set<String> = SUPPORTED_DIAGRAM_EXT_SET.map { INFRA_DIAGRAM_PREFIX + it }.toSet()

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

+43-32
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ import com.intellij.diff.requests.SimpleDiffRequest
1212
import com.intellij.diff.util.DiffUserDataKeys
1313
import com.intellij.ide.BrowserUtil
1414
import com.intellij.openapi.application.runInEdt
15+
import com.intellij.openapi.fileEditor.FileEditorManager
1516
import com.intellij.openapi.project.Project
1617
import com.intellij.openapi.roots.ProjectRootManager
1718
import com.intellij.openapi.vfs.LocalFileSystem
1819
import com.intellij.openapi.vfs.VfsUtil
1920
import com.intellij.openapi.wm.ToolWindowManager
21+
import com.intellij.testFramework.LightVirtualFile
2022
import kotlinx.coroutines.withContext
23+
import org.intellij.images.fileTypes.impl.SvgFileType
2124
import software.amazon.awssdk.services.codewhispererruntime.model.DocFolderLevel
2225
import software.amazon.awssdk.services.codewhispererruntime.model.DocInteractionType
2326
import software.amazon.awssdk.services.codewhispererruntime.model.DocUserDecision
@@ -33,6 +36,7 @@ import software.aws.toolkits.jetbrains.services.amazonq.apps.AmazonQAppInitConte
3336
import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthController
3437
import software.aws.toolkits.jetbrains.services.amazonq.toolwindow.AmazonQToolWindowFactory
3538
import software.aws.toolkits.jetbrains.services.amazonqDoc.DEFAULT_RETRY_LIMIT
39+
import software.aws.toolkits.jetbrains.services.amazonqDoc.DIAGRAM_SVG_EXT
3640
import software.aws.toolkits.jetbrains.services.amazonqDoc.DocException
3741
import software.aws.toolkits.jetbrains.services.amazonqDoc.FEATURE_NAME
3842
import software.aws.toolkits.jetbrains.services.amazonqDoc.InboundAppMessagesHandler
@@ -374,45 +378,51 @@ class DocController(
374378

375379
override suspend fun processOpenDiff(message: IncomingDocMessage.OpenDiff) {
376380
val session = getSessionInfo(message.tabId)
377-
378-
val project = context.project
379381
val sessionState = session.sessionState
380382

381-
when (sessionState) {
382-
is PrepareDocGenerationState -> {
383-
runInEdt {
384-
val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.selectedSourceFolder)
385-
386-
val leftDiffContent = if (existingFile == null) {
387-
EmptyContent()
388-
} else {
389-
DiffContentFactory.getInstance().create(project, existingFile)
390-
}
391-
392-
val newFileContent = sessionState.filePaths.find { it.zipFilePath == message.filePath }?.fileContent
383+
if (sessionState !is PrepareDocGenerationState) {
384+
logger.error { "$FEATURE_NAME: OpenDiff event is received for a conversation that has ${session.sessionState.phase} phase" }
385+
messenger.sendError(
386+
tabId = message.tabId,
387+
errMessage = message("amazonqFeatureDev.exception.open_diff_failed"),
388+
retries = 0,
389+
conversationId = session.conversationIdUnsafe
390+
)
391+
return
392+
}
393393

394-
val rightDiffContent = if (message.deleted || newFileContent == null) {
395-
EmptyContent()
396-
} else {
397-
DiffContentFactory.getInstance().create(newFileContent)
398-
}
394+
runInEdt {
395+
val newFileContent = sessionState.filePaths.find { it.zipFilePath == message.filePath }?.fileContent
399396

400-
val request = SimpleDiffRequest(message.filePath, leftDiffContent, rightDiffContent, null, null)
401-
request.putUserData(DiffUserDataKeys.FORCE_READ_ONLY, true)
397+
val isSvgFile = message.filePath.lowercase().endsWith(".".plus(DIAGRAM_SVG_EXT))
398+
if (isSvgFile && newFileContent != null) {
399+
// instead of diff display generated svg in edit/preview window
400+
val inMemoryFile = LightVirtualFile(
401+
message.filePath,
402+
SvgFileType.INSTANCE,
403+
newFileContent
404+
)
405+
inMemoryFile.isWritable = false
406+
FileEditorManager.getInstance(context.project).openFile(inMemoryFile, true)
407+
} else {
408+
val existingFile = VfsUtil.findRelativeFile(message.filePath, session.context.selectedSourceFolder)
409+
val leftDiffContent = if (existingFile == null) {
410+
EmptyContent()
411+
} else {
412+
DiffContentFactory.getInstance().create(context.project, existingFile)
413+
}
402414

403-
val newDiff = ChainDiffVirtualFile(SimpleDiffRequestChain(request), message.filePath)
404-
DiffEditorTabFilesManager.getInstance(context.project).showDiffFile(newDiff, true)
415+
val rightDiffContent = if (message.deleted || newFileContent == null) {
416+
EmptyContent()
417+
} else {
418+
DiffContentFactory.getInstance().create(newFileContent)
405419
}
406-
}
407420

408-
else -> {
409-
logger.error { "$FEATURE_NAME: OpenDiff event is received for a conversation that has ${session.sessionState.phase} phase" }
410-
messenger.sendError(
411-
tabId = message.tabId,
412-
errMessage = message("amazonqFeatureDev.exception.open_diff_failed"),
413-
retries = 0,
414-
conversationId = session.conversationIdUnsafe
415-
)
421+
val request = SimpleDiffRequest(message.filePath, leftDiffContent, rightDiffContent, null, null)
422+
request.putUserData(DiffUserDataKeys.FORCE_READ_ONLY, true)
423+
424+
val newDiff = ChainDiffVirtualFile(SimpleDiffRequestChain(request), message.filePath)
425+
DiffEditorTabFilesManager.getInstance(context.project).showDiffFile(newDiff, true)
416426
}
417427
}
418428
}
@@ -738,6 +748,7 @@ class DocController(
738748
SessionStatePhase.CODEGEN -> {
739749
onCodeGeneration(session, message, tabId, mode)
740750
}
751+
741752
else -> null
742753
}
743754

‎plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/messages/DocMessagePublisherExtensions.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthNeededState
77
import software.aws.toolkits.jetbrains.services.amazonq.messages.MessagePublisher
88
import software.aws.toolkits.jetbrains.services.amazonqCodeTest.messages.ProgressField
99
import software.aws.toolkits.jetbrains.services.amazonqCodeTest.messages.PromptProgressMessage
10-
import software.aws.toolkits.jetbrains.services.amazonqDoc.NEW_SESSION_FOLLOWUPS
10+
import software.aws.toolkits.jetbrains.services.amazonqDoc.ui.NEW_SESSION_FOLLOWUPS
1111
import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session.CodeReferenceGenerated
1212
import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session.DeletedFileInfo
1313
import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session.NewFileZipInfo

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import software.aws.toolkits.jetbrains.common.session.SessionStateConfigData
2020
import software.aws.toolkits.jetbrains.common.util.AmazonQCodeGenService
2121
import software.aws.toolkits.jetbrains.common.util.resolveAndCreateOrUpdateFile
2222
import software.aws.toolkits.jetbrains.common.util.resolveAndDeleteFile
23-
import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
2423
import software.aws.toolkits.jetbrains.services.amazonq.messages.MessagePublisher
2524
import software.aws.toolkits.jetbrains.services.amazonqDoc.CODE_GENERATION_RETRY_LIMIT
2625
import software.aws.toolkits.jetbrains.services.amazonqDoc.FEATURE_NAME
@@ -40,7 +39,7 @@ import java.security.MessageDigest
4039
private val logger = getLogger<AmazonQCodeGenerateClient>()
4140

4241
class DocSession(val tabID: String, val project: Project) {
43-
var context: FeatureDevSessionContext
42+
var context: DocSessionContext = DocSessionContext(project, MAX_PROJECT_SIZE_BYTES)
4443
val sessionStartTime = System.currentTimeMillis()
4544

4645
var state: SessionState?
@@ -59,7 +58,6 @@ class DocSession(val tabID: String, val project: Project) {
5958
var isAuthenticating: Boolean
6059

6160
init {
62-
context = FeatureDevSessionContext(project, MAX_PROJECT_SIZE_BYTES)
6361
proxyClient = AmazonQCodeGenerateClient.getInstance(project)
6462
amazonQCodeGenService = AmazonQCodeGenService(proxyClient, project)
6563
state = ConversationNotStartedState("", tabID, token = null)

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

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package software.aws.toolkits.jetbrains.services.amazonqDoc.session
5+
6+
import com.intellij.openapi.project.Project
7+
import com.intellij.openapi.vfs.VirtualFile
8+
import software.aws.toolkits.jetbrains.services.amazonq.FeatureDevSessionContext
9+
import software.aws.toolkits.jetbrains.services.amazonqDoc.SUPPORTED_DIAGRAM_EXT_SET
10+
import software.aws.toolkits.jetbrains.services.amazonqDoc.SUPPORTED_DIAGRAM_FILE_NAME_SET
11+
12+
class DocSessionContext(project: Project, maxProjectSizeBytes: Long? = null) : FeatureDevSessionContext(project, maxProjectSizeBytes) {
13+
14+
/**
15+
* Ensure diagram files are not ignored
16+
*/
17+
override fun getAdditionalGitIgnoreBinaryFilesRules(): Set<String> {
18+
val ignoreRules = super.getAdditionalGitIgnoreBinaryFilesRules()
19+
val diagramExtRulesInGitIgnoreFormatSet = SUPPORTED_DIAGRAM_EXT_SET.map { "*.$it" }.toSet()
20+
return ignoreRules - diagramExtRulesInGitIgnoreFormatSet
21+
}
22+
23+
/**
24+
* Ensure diagram files are not filtered
25+
*/
26+
override fun isFileExtensionAllowed(file: VirtualFile): Boolean {
27+
if (super.isFileExtensionAllowed(file)) {
28+
return true
29+
}
30+
31+
return file.extension != null && SUPPORTED_DIAGRAM_FILE_NAME_SET.contains(file.name)
32+
}
33+
}

‎plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqDoc/ui/UiContants.kt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package software.aws.toolkits.jetbrains.services.amazonqDoc.ui
5+
6+
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUp
7+
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUpStatusType
8+
import software.aws.toolkits.jetbrains.services.amazonqDoc.messages.FollowUpTypes
9+
import software.aws.toolkits.resources.message
10+
11+
val NEW_SESSION_FOLLOWUPS: List<FollowUp> = listOf(
12+
FollowUp(
13+
pillText = message("amazonqDoc.prompt.reject.new_task"),
14+
type = FollowUpTypes.NEW_TASK,
15+
status = FollowUpStatusType.Info
16+
),
17+
FollowUp(
18+
pillText = message("amazonqDoc.prompt.reject.close_session"),
19+
type = FollowUpTypes.CLOSE_SESSION,
20+
status = FollowUpStatusType.Info
21+
)
22+
)

‎plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/FeatureDevSessionContext.kt

+18-9
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ interface RepoSizeError {
4343
}
4444
class RepoSizeLimitError(override val message: String) : RuntimeException(), RepoSizeError
4545

46-
class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Long? = null) {
46+
open class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Long? = null) {
4747
// TODO: Need to correct this class location in the modules going further to support both amazonq and codescan.
4848

4949
private val additionalGitIgnoreFolderRules = setOf(
@@ -61,7 +61,7 @@ class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Lo
6161
"dist",
6262
)
6363

64-
private val additionalGitIgnoreBinaryFilesRules = setOf(
64+
private val defaultAdditionalGitIgnoreBinaryFilesRules = setOf(
6565
"*.zip",
6666
"*.bin",
6767
"*.png",
@@ -91,17 +91,17 @@ class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Lo
9191
// selectedSourceFolder: is the directory selected in replacement of the root, this happens when the project is too big to bundle for uploading.
9292
private var _selectedSourceFolder = projectRoot
9393
private var ignorePatternsWithGitIgnore = emptyList<Regex>()
94-
private var ignorePatternsForBinaryFiles = additionalGitIgnoreBinaryFilesRules
95-
.map { convertGitIgnorePatternToRegex(it) }
96-
.mapNotNull { pattern ->
97-
runCatching { Regex(pattern) }.getOrNull()
98-
}
94+
private var ignorePatternsForBinaryFiles = buildIgnorePatternsForBinaryFiles()
95+
9996
private val gitIgnoreFile = File(selectedSourceFolder.path, ".gitignore")
10097

10198
init {
10299
ignorePatternsWithGitIgnore = try {
103100
buildList {
104-
addAll(additionalGitIgnoreFolderRules.map { convertGitIgnorePatternToRegex(it) })
101+
addAll(
102+
additionalGitIgnoreFolderRules
103+
.map { convertGitIgnorePatternToRegex(it) }
104+
)
105105
addAll(parseGitIgnore())
106106
}.mapNotNull { pattern ->
107107
runCatching { Regex(pattern) }.getOrNull()
@@ -111,6 +111,15 @@ class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Lo
111111
}
112112
}
113113

114+
private fun buildIgnorePatternsForBinaryFiles(): List<Regex> =
115+
getAdditionalGitIgnoreBinaryFilesRules()
116+
.map { convertGitIgnorePatternToRegex(it) }
117+
.mapNotNull { pattern ->
118+
runCatching { Regex(pattern) }.getOrNull()
119+
}
120+
121+
open fun getAdditionalGitIgnoreBinaryFilesRules(): Set<String> = defaultAdditionalGitIgnoreBinaryFilesRules
122+
114123
// This function checks for existence of `devfile.yaml` in customer's repository, currently only `devfile.yaml` is supported for this feature.
115124
fun checkForDevFile(): Boolean {
116125
val devFile = File(projectRoot.path, "/devfile.yaml")
@@ -129,7 +138,7 @@ class FeatureDevSessionContext(val project: Project, val maxProjectSizeBytes: Lo
129138
return ZipCreationResult(zippedProject, checkSum256, zippedProject.length())
130139
}
131140

132-
fun isFileExtensionAllowed(file: VirtualFile): Boolean {
141+
open fun isFileExtensionAllowed(file: VirtualFile): Boolean {
133142
// if it is a directory, it is allowed
134143
if (file.isDirectory) return true
135144
val extension = file.extension ?: return false

0 commit comments

Comments
 (0)