Add ability to suggest additional resource types (#2970)

Author: kiiadi

core/src/software/aws/toolkits/core/telemetry/TelemetryPublisher.kt

@@ -8,5 +8,5 @@ import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
 interface TelemetryPublisher : AutoCloseable {
     suspend fun publish(metricEvents: Collection<MetricEvent>)
 
-    suspend fun sendFeedback(sentiment: Sentiment, comment: String)
+    suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String>)
 }

jetbrains-core/src/software/aws/toolkits/jetbrains/services/telemetry/DefaultTelemetryPublisher.kt

@@ -38,7 +38,7 @@ class DefaultTelemetryPublisher(
         }
     }
 
-    override suspend fun sendFeedback(sentiment: Sentiment, comment: String) {
+    override suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String>) {
         withContext(getCoroutineBgContext()) {
             client.postFeedback {
                 it.awsProduct(clientMetadata.productName)
@@ -49,6 +49,9 @@ class DefaultTelemetryPublisher(
                 it.parentProductVersion(clientMetadata.parentProductVersion)
                 it.sentiment(sentiment)
                 it.comment(comment)
+                if (metadata.isNotEmpty()) {
+                    it.metadata(metadata.map { (k, v) -> MetadataEntry.builder().key(k).value(v).build() })
+                }
             }
         }
     }

jetbrains-core/src/software/aws/toolkits/jetbrains/services/telemetry/TelemetryService.kt

@@ -114,8 +114,8 @@ abstract class TelemetryService(private val publisher: TelemetryPublisher, priva
         batcher.enqueue(event)
     }
 
-    suspend fun sendFeedback(sentiment: Sentiment, comment: String) {
-        publisher.sendFeedback(sentiment, comment)
+    suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String> = emptyMap()) {
+        publisher.sendFeedback(sentiment, comment, metadata)
     }
 
     companion object {

jetbrains-core/src/software/aws/toolkits/jetbrains/settings/DynamicResourcesConfigurable.kt

@@ -3,24 +3,35 @@
 
 package software.aws.toolkits.jetbrains.settings
 
-import com.intellij.openapi.application.ApplicationManager
-import com.intellij.openapi.application.ModalityState
-import com.intellij.openapi.application.runInEdt
 import com.intellij.openapi.options.BoundConfigurable
 import com.intellij.openapi.project.ProjectManager
+import com.intellij.openapi.ui.InputValidator
+import com.intellij.openapi.ui.Messages
+import com.intellij.openapi.ui.messages.MessagesService
 import com.intellij.ui.CheckBoxList
 import com.intellij.ui.FilterComponent
 import com.intellij.ui.ListSpeedSearch
 import com.intellij.ui.layout.panel
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
 import software.aws.toolkits.core.utils.replace
+import software.aws.toolkits.jetbrains.core.coroutines.applicationCoroutineScope
+import software.aws.toolkits.jetbrains.core.coroutines.getCoroutineBgContext
+import software.aws.toolkits.jetbrains.core.coroutines.getCoroutineUiContext
 import software.aws.toolkits.jetbrains.core.explorer.ExplorerToolWindow
 import software.aws.toolkits.jetbrains.services.dynamic.DynamicResourceSupportedTypes
 import software.aws.toolkits.jetbrains.services.dynamic.explorer.OtherResourcesNode
+import software.aws.toolkits.jetbrains.services.telemetry.TelemetryService
+import software.aws.toolkits.jetbrains.ui.feedback.FEEDBACK_SOURCE
+import software.aws.toolkits.jetbrains.utils.notifyError
 import software.aws.toolkits.resources.message
+import software.aws.toolkits.telemetry.FeedbackTelemetry
 import javax.swing.ListSelectionModel
 
 class DynamicResourcesConfigurable : BoundConfigurable(message("aws.settings.dynamic_resources_configurable.title")) {
 
+    private val coroutineScope = applicationCoroutineScope()
     private val checklist = CheckBoxList<String>()
     private val allResources = mutableSetOf<String>()
     private val selected = mutableSetOf<String>()
@@ -43,14 +54,22 @@ class DynamicResourcesConfigurable : BoundConfigurable(message("aws.settings.dyn
 
     override fun createPanel() = panel {
         selected.replace(DynamicResourcesSettings.getInstance().selected)
-        ApplicationManager.getApplication().executeOnPooledThread {
+        coroutineScope.launch(getCoroutineBgContext()) {
             allResources.addAll(DynamicResourceSupportedTypes.getInstance().getSupportedTypes())
-            runInEdt(ModalityState.any()) {
+            withContext(getCoroutineUiContext()) {
                 updateCheckboxList()
             }
         }
-
-        row { filter(growX) }
+        row {
+            cell(isFullWidth = true) {
+                filter(growX, pushX)
+                link(message("aws.settings.dynamic_resources_configurable.suggest_types.prompt")) {
+                    showTypeSuggestionBox()?.let { suggestion ->
+                        submitSuggestion(suggestion)
+                    }
+                }
+            }
+        }
         row {
             scrollPane(checklist)
                 .constraints(growX, pushX)
@@ -78,6 +97,19 @@ class DynamicResourcesConfigurable : BoundConfigurable(message("aws.settings.dyn
         }
     }
 
+    private fun submitSuggestion(suggestion: String) {
+        coroutineScope.launch(getCoroutineBgContext()) {
+            try {
+                TelemetryService.getInstance().sendFeedback(Sentiment.NEGATIVE, suggestion, mapOf(FEEDBACK_SOURCE to "Resource Type Suggestions")).also {
+                    FeedbackTelemetry.result(project = null, success = true)
+                }
+            } catch (e: Exception) {
+                e.notifyError(message("feedback.submit_failed", e))
+                FeedbackTelemetry.result(project = null, success = false)
+            }
+        }
+    }
+
     private fun CheckBoxList<*>.toggleAll(state: Boolean) {
         (0 until model.size).forEach { idx ->
             checkboxStateHandler(idx, state)
@@ -112,4 +144,24 @@ class DynamicResourcesConfigurable : BoundConfigurable(message("aws.settings.dyn
             }
         }
     }
+
+    companion object {
+        private const val INITIAL_INPUT = "AWS::"
+        private const val MAX_LENGTH = 2000
+
+        private fun showTypeSuggestionBox(): String? = MessagesService.getInstance().showMultilineInputDialog(
+            project = null,
+            message = message("aws.settings.dynamic_resources_configurable.suggest_types.dialog.message"),
+            title = message("aws.settings.dynamic_resources_configurable.suggest_types.dialog.title"),
+            initialValue = INITIAL_INPUT,
+            icon = Messages.getQuestionIcon(),
+            object : InputValidator {
+                override fun checkInput(inputString: String?) = validateSuggestion(inputString)
+                override fun canClose(inputString: String?) = validateSuggestion(inputString)
+            }
+        )?.takeIf { it.isNotBlank() }
+
+        private fun validateSuggestion(inputString: String?) =
+            inputString != null && inputString.isNotBlank() && inputString != INITIAL_INPUT && inputString.length <= MAX_LENGTH
+    }
 }

jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/Constants.kt

@@ -0,0 +1,6 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.ui.feedback
+
+const val FEEDBACK_SOURCE = "source"

jetbrains-core/tst/software/aws/toolkits/jetbrains/services/telemetry/MockTelemetryService.kt

@@ -21,7 +21,7 @@ class NoOpTelemetryService : TelemetryService {
 class NoOpPublisher() : TelemetryPublisher {
     override suspend fun publish(metricEvents: Collection<MetricEvent>) {}
 
-    override suspend fun sendFeedback(sentiment: Sentiment, comment: String) {}
+    override suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String>) {}
 
     override fun close() {}
 }

resources/resources/software/aws/toolkits/resources/MessagesBundle.properties

@@ -89,6 +89,9 @@ aws.settings.aws_cli_settings=AWS CLI Settings
 aws.settings.clouddebug.location=cloud-debug CLI executable:
 aws.settings.dynamic_resources_configurable.clear_all=Clear All
 aws.settings.dynamic_resources_configurable.select_all=Select All
+aws.settings.dynamic_resources_configurable.suggest_types.dialog.message=Please suggest additional AWS resource types (e.g. AWS::S3::Bucket)\nyou would like to see supported in future releases.\n\n(max length: 2000 chars)
+aws.settings.dynamic_resources_configurable.suggest_types.dialog.title=Additional Resource Type Suggestions
+aws.settings.dynamic_resources_configurable.suggest_types.prompt=Don't see a resource type you expected?
 aws.settings.dynamic_resources_configurable.title=Resources
 aws.settings.executables.auto_resolved=(Auto-resolved: {0})
 aws.settings.executables.cannot_determine_version=Cannot determine version of {0}: {1}