docs(amazonq): Update autobuild setting strings (#5301)

neilk-aws · web-flow · commit 86e993ede886 · 2025-01-28T12:08:14.000-08:00
Improves the formatting and strings presented to customers when the allow /dev to run code and test commands automatically. Also includes minor variable name changes to improve internal consistency.
diff --git a/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt b/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt
@@ -727,7 +727,7 @@ class FeatureDevController(
                 return
             }
 
-            val codeWhispererSettings = CodeWhispererSettings.getInstance().getAutoBuildFeatureConfiguration()
+            val codeWhispererSettings = CodeWhispererSettings.getInstance().getAutoBuildSetting()
             val hasDevFile = session.context.checkForDevFile()
             val isPromptedForAutoBuildFeature = codeWhispererSettings.containsKey(session.context.getWorkspaceRoot())
 
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/settings/CodeWhispererConfigurable.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/settings/CodeWhispererConfigurable.kt
@@ -125,29 +125,6 @@ class CodeWhispererConfigurable(private val project: Project) :
             }
         }
 
-        group(message("aws.settings.codewhisperer.allow_q_dev_build_test_commands")) {
-            row {
-                val settings = codeWhispererSettings.getAutoBuildFeatureConfiguration()
-                for ((key) in settings) {
-                    checkBox(key).apply {
-                        connect.subscribe(
-                            ToolkitConnectionManagerListener.TOPIC,
-                            object : ToolkitConnectionManagerListener {
-                                override fun activeConnectionChanged(newConnection: ToolkitConnection?) {
-                                    enabled(isCodeWhispererEnabled(project))
-                                }
-                            }
-                        )
-
-                        bindSelected(
-                            getter = { codeWhispererSettings.isAutoBuildFeatureEnabled(key) },
-                            setter = { newValue -> codeWhispererSettings.toggleAutoBuildFeature(key, newValue) }
-                        )
-                    }
-                }
-            }
-        }
-
         group(message("aws.settings.codewhisperer.group.q_chat")) {
             row {
                 checkBox(message("aws.settings.codewhisperer.project_context")).apply {
@@ -214,6 +191,35 @@ class CodeWhispererConfigurable(private val project: Project) :
             }
         }
 
+        val autoBuildSetting = codeWhispererSettings.getAutoBuildSetting()
+        if (autoBuildSetting.isNotEmpty()) {
+            group(message("aws.settings.codewhisperer.feature_development")) {
+                row {
+                    text(message("aws.settings.codewhisperer.feature_development.allow_running_code_and_test_commands"))
+                }
+                row {
+                    val settings = codeWhispererSettings.getAutoBuildSetting()
+                    for ((key) in settings) {
+                        checkBox(key).apply {
+                            connect.subscribe(
+                                ToolkitConnectionManagerListener.TOPIC,
+                                object : ToolkitConnectionManagerListener {
+                                    override fun activeConnectionChanged(newConnection: ToolkitConnection?) {
+                                        enabled(isCodeWhispererEnabled(project))
+                                    }
+                                }
+                            )
+
+                            bindSelected(
+                                getter = { codeWhispererSettings.isAutoBuildFeatureEnabled(key) },
+                                setter = { newValue -> codeWhispererSettings.toggleAutoBuildFeature(key, newValue) }
+                            )
+                        }
+                    }
+                }
+            }
+        }
+
         group(message("aws.settings.codewhisperer.code_review")) {
             row {
                 ExpandableTextField(ParametersListUtil.COLON_LINE_PARSER, ParametersListUtil.COLON_LINE_JOINER).also {
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererConfigurableTest.kt b/plugins/amazonq/codewhisperer/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererConfigurableTest.kt
@@ -13,6 +13,7 @@ import org.mockito.kotlin.doNothing
 import software.aws.toolkits.jetbrains.core.credentials.ToolkitConnectionManagerListener
 import software.aws.toolkits.jetbrains.services.codewhisperer.codescan.CodeWhispererCodeScanManager
 import software.aws.toolkits.jetbrains.services.codewhisperer.settings.CodeWhispererConfigurable
+import software.aws.toolkits.jetbrains.settings.CodeWhispererSettings
 import software.aws.toolkits.resources.message
 import javax.swing.JCheckBox
 import javax.swing.JComponent
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererSettingsTest.kt b/plugins/amazonq/codewhisperer/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererSettingsTest.kt
@@ -12,7 +12,9 @@ import com.intellij.openapi.wm.ToolWindowManager
 import com.intellij.openapi.wm.impl.status.widget.StatusBarWidgetsManager
 import com.intellij.testFramework.replaceService
 import com.intellij.testFramework.runInEdtAndWait
+import com.intellij.util.xmlb.XmlSerializer
 import org.assertj.core.api.Assertions.assertThat
+import org.jdom.output.XMLOutputter
 import org.junit.Before
 import org.junit.Ignore
 import org.junit.Test
@@ -30,6 +32,7 @@ import software.aws.toolkits.jetbrains.services.codewhisperer.status.CodeWhisper
 import software.aws.toolkits.jetbrains.services.codewhisperer.toolwindow.CodeWhispererCodeReferenceToolWindowFactory
 import software.aws.toolkits.jetbrains.settings.CodeWhispererConfiguration
 import software.aws.toolkits.jetbrains.settings.CodeWhispererSettings
+import software.aws.toolkits.jetbrains.utils.xmlElement
 import kotlin.test.fail
 
 class CodeWhispererSettingsTest : CodeWhispererTestBase() {
@@ -145,6 +148,70 @@ class CodeWhispererSettingsTest : CodeWhispererTestBase() {
             assertThat(settingsManager.isIncludeCodeWithReference()).isEqualTo(true)
         }
     }
+
+    @Test
+    fun `serialize settings to ensure backwards compatibility`() {
+        val element = xmlElement(
+            """
+            <component name="CodeWhispererSettings">
+  </component>
+            """.trimIndent()
+        )
+
+        val settings = CodeWhispererSettings.getInstance()
+        settings.toggleAutoBuildFeature("project1", true)
+
+        XmlSerializer.serializeInto(settings.state, element)
+
+        val actual = XMLOutputter().outputString(element)
+        val expected = "<component name=\"CodeWhispererSettings\">\n" +
+            "<option name=\"autoBuildSetting\">" +
+            "<map><entry key=\"project1\" value=\"true\" />" +
+            "</map>" +
+            "</option>" +
+            "<option name=\"value\">" +
+            "<map><entry key=\"IsIncludeCodeWithReference\" value=\"true\" />" +
+            "</map>" +
+            "</option>" +
+            "</component>"
+
+        assertThat(actual).isEqualTo(expected)
+    }
+
+    @Test
+    fun `deserialize empty settings to ensure backwards compatibility`() {
+        val element = xmlElement(
+            """
+                <component name="CodeWhispererSettings">
+                </component>
+                """
+        )
+        val actual = XmlSerializer.deserialize(element, CodeWhispererConfiguration::class.java)
+        assertThat(actual.autoBuildSetting).hasSize(0)
+    }
+
+    @Test
+    fun `deserialize existing settings to ensure backwards compatibility`() {
+        val element = xmlElement(
+            """
+                <component name="CodeWhispererSettings">
+                    <option name="autoBuildSetting">
+                        <map>
+                            <entry key="project1" value="true" />
+                        </map>
+                    </option>
+                    <option>
+                        <map>
+                            <entry key="IsIncludeCodeWithReference" value="true" />
+                        </map>
+                    </option>
+                </component>
+            """.trimIndent()
+        )
+        val actual = XmlSerializer.deserialize(element, CodeWhispererConfiguration::class.java)
+        assertThat(actual.autoBuildSetting).hasSize(1)
+        assertThat(actual.autoBuildSetting["project1"]).isTrue()
+    }
 }
 
 class CodeWhispererSettingUnitTest {
diff --git a/plugins/amazonq/shared/jetbrains-community/src/software/aws/toolkits/jetbrains/settings/CodeWhispererSettings.kt b/plugins/amazonq/shared/jetbrains-community/src/software/aws/toolkits/jetbrains/settings/CodeWhispererSettings.kt
@@ -25,15 +25,15 @@ class CodeWhispererSettings : PersistentStateComponent<CodeWhispererConfiguratio
         false
     )
 
-    fun getAutoBuildFeatureConfiguration() = state.projectAutoBuildConfigurationMap
+    fun getAutoBuildSetting() = state.autoBuildSetting
 
     fun toggleAutoBuildFeature(project: String?, value: Boolean) {
         if (project == null) return
 
-        state.projectAutoBuildConfigurationMap[project] = value
+        state.autoBuildSetting[project] = value
     }
 
-    fun isAutoBuildFeatureEnabled(project: String?) = state.projectAutoBuildConfigurationMap.getOrDefault(project, false)
+    fun isAutoBuildFeatureEnabled(project: String?) = state.autoBuildSetting.getOrDefault(project, false)
 
     fun toggleImportAdder(value: Boolean) {
         state.value[CodeWhispererConfigurationType.IsImportAdderEnabled] = value
@@ -131,15 +131,18 @@ class CodeWhispererSettings : PersistentStateComponent<CodeWhispererConfiguratio
         value.putAll(state.value)
         intValue.putAll(state.intValue)
         stringValue.putAll(state.stringValue)
+        autoBuildSetting.putAll(state.autoBuildSetting)
     }
 
     override fun loadState(state: CodeWhispererConfiguration) {
         this.state.value.clear()
         this.state.intValue.clear()
         this.state.stringValue.clear()
+        this.state.autoBuildSetting.clear()
         this.state.value.putAll(state.value)
         this.state.intValue.putAll(state.intValue)
         this.state.stringValue.putAll(state.stringValue)
+        this.state.autoBuildSetting.putAll(state.autoBuildSetting)
     }
 }
 
@@ -153,7 +156,8 @@ class CodeWhispererConfiguration : BaseState() {
     @get:Property
     val stringValue by map<CodeWhispererStringConfigurationType, String>()
 
-    val projectAutoBuildConfigurationMap by map<String, Boolean>()
+    @get:Property
+    val autoBuildSetting by map<String, Boolean>()
 }
 
 enum class CodeWhispererConfigurationType {
diff --git a/plugins/core/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties b/plugins/core/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties
@@ -266,7 +266,8 @@ aws.settings.auto_update.notification_enable.tooltip=If unchecked, updates will
 aws.settings.auto_update.progress.message=Updating AWS plugins
 aws.settings.auto_update.text=Automatically install plugin updates when available
 aws.settings.aws_cli_settings=AWS CLI Settings
-aws.settings.codewhisperer.allow_q_dev_build_test_commands=Amazon Q: Allow Q /dev to run code and test commands
+aws.settings.codewhisperer.feature_development=Feature Development
+aws.settings.codewhisperer.feature_development.allow_running_code_and_test_commands=Allow /dev to run code and test commands
 aws.settings.codewhisperer.automatic_import_adder=Imports recommendation
 aws.settings.codewhisperer.automatic_import_adder.tooltip=Amazon Q will add import statements with code suggestions when necessary
 aws.settings.codewhisperer.code_review=Code Review

Original file line number	Diff line number	Diff line change
`@@ -727,7 +727,7 @@ class FeatureDevController(`
`727`	`727`	`return`
`728`	`728`	`}`
`729`	`729`
`730`		`- val codeWhispererSettings = CodeWhispererSettings.getInstance().getAutoBuildFeatureConfiguration()`
	`730`	`+ val codeWhispererSettings = CodeWhispererSettings.getInstance().getAutoBuildSetting()`
`731`	`731`	`val hasDevFile = session.context.checkForDevFile()`
`732`	`732`	`val isPromptedForAutoBuildFeature = codeWhispererSettings.containsKey(session.context.getWorkspaceRoot())`
`733`	`733`