Making comments optional when submitting feedback (#3166)

kiiadi · web-flow · commit 1c8faa4b3e1d · 2022-06-01T12:42:50.000-07:00
* Making comments optioanl when submitting feedback

* setting empty text to show the feedback comment is optional
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/FeedbackDialog.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/FeedbackDialog.kt
@@ -75,7 +75,7 @@ class FeedbackDialog(private val project: Project) : DialogWrapper(project) {
         val comment = panel.comment
 
         return when {
-            comment.isNullOrEmpty() -> ValidationInfo(message("feedback.validation.empty_comment"))
+            comment.isNullOrEmpty() -> null
             comment.length >= SubmitFeedbackPanel.MAX_LENGTH -> ValidationInfo(message("feedback.validation.comment_too_long"))
             else -> null
         }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/SubmitFeedbackPanel.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/SubmitFeedbackPanel.kt
@@ -50,6 +50,7 @@ class SubmitFeedbackPanel(initialSentiment: Sentiment? = null) {
 
     private fun createUIComponents() {
         textArea = JBTextArea(6, 70)
+        textArea.emptyText.text = message("feedback.comment.emptyText")
         textArea.lineWrap = true
         textAreaPane = JBScrollPane(textArea)
         smileIcon = JLabel(IconUtil.scale(AwsIcons.Misc.SMILE, null, 3f))
@@ -59,6 +60,14 @@ class SubmitFeedbackPanel(initialSentiment: Sentiment? = null) {
         textArea.document.addUndoableEditListener { onTextAreaUpdate() }
     }
 
+    @TestOnly
+    internal fun setSentimentForTest(sentiment: Sentiment) {
+        when (sentiment) {
+            Sentiment.POSITIVE -> smileButton.isSelected = true
+            else -> sadButton.isSelected = true
+        }
+    }
+
     init {
         // runs after $$$setupUI$$$
         // null out placeholder text
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/ui/feedback/FeedbackTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/ui/feedback/FeedbackTest.kt
@@ -83,11 +83,9 @@ class FeedbackTest {
             runInEdtAndWait {
                 val dialog = FeedbackDialog(projectRule.project)
                 val panel = dialog.getViewForTesting()
-
+                panel.setSentimentForTest(Sentiment.POSITIVE)
                 panel.comment = case
-                assertThat(dialog.doValidate()).isInstanceOfSatisfying(ValidationInfo::class.java) {
-                    it.message.contains(message("feedback.validation.empty_comment"))
-                }
+                assertThat(dialog.doValidate()).isNull()
             }
         }
     }
diff --git a/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties b/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties
@@ -616,6 +616,7 @@ explorer.results_truncated=Results truncated, double click to load more
 explorer.stack.no.serverless.resources=Stack has no Lambda Functions
 explorer.view_documentation=View Documentation
 explorer.view_source=View Source on GitHub
+feedback.comment.emptyText=(optional)
 feedback.comment.label=Please enter your feedback
 feedback.description=Submit quick feedback about the AWS Toolkit for JetBrains
 feedback.github.link=<html>Have an issue or feature request?<br><a href="{0}">Talk to us on GitHub instead!</a></html>

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ class FeedbackDialog(private val project: Project) : DialogWrapper(project) {`
`75`	`75`	`val comment = panel.comment`
`76`	`76`
`77`	`77`	`return when {`
`78`		`- comment.isNullOrEmpty() -> ValidationInfo(message("feedback.validation.empty_comment"))`
	`78`	`+ comment.isNullOrEmpty() -> null`
`79`	`79`	`comment.length >= SubmitFeedbackPanel.MAX_LENGTH -> ValidationInfo(message("feedback.validation.comment_too_long"))`
`80`	`80`	`else -> null`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,11 +83,9 @@ class FeedbackTest {`
`83`	`83`	`runInEdtAndWait {`
`84`	`84`	`val dialog = FeedbackDialog(projectRule.project)`
`85`	`85`	`val panel = dialog.getViewForTesting()`
`86`		`-`
	`86`	`+ panel.setSentimentForTest(Sentiment.POSITIVE)`
`87`	`87`	`panel.comment = case`
`88`		`- assertThat(dialog.doValidate()).isInstanceOfSatisfying(ValidationInfo::class.java) {`
`89`		`- it.message.contains(message("feedback.validation.empty_comment"))`
`90`		`- }`
	`88`	`+ assertThat(dialog.doValidate()).isNull()`
`91`	`89`	`}`
`92`	`90`	`}`
`93`	`91`	`}`