Fix resource selectors assuming every region has every service (#2441)

hunterwerlla · web-flow · commit 2d4edaa80746 · 2021-03-01T14:01:53.000-08:00
Fixes issue #2435
diff --git a/.changes/next-release/bugfix-161127cc-a495-47f8-8883-4c6a04f229ab.json b/.changes/next-release/bugfix-161127cc-a495-47f8-8883-4c6a04f229ab.json
@@ -0,0 +1,4 @@
+{
+  "type" : "bugfix",
+  "description" : "Fix resource selectors assuming every region has every service (#2435)"
+}
diff --git a/core/src/software/aws/toolkits/core/region/ToolkitRegionProvider.kt b/core/src/software/aws/toolkits/core/region/ToolkitRegionProvider.kt
@@ -20,6 +20,11 @@ abstract class ToolkitRegionProvider {
      */
     fun allRegions(): Map<String, AwsRegion> = partitionData().flatMap { it.value.regions.asIterable() }.associate { it.key to it.value }
 
+    /**
+     * Returns a map of region ID([AwsRegion.id]) to [AwsRegion], filtering by if the service is supported
+     */
+    fun allRegionsForService(serviceId: String): Map<String, AwsRegion> = allRegions().filter { isServiceSupported(it.value, serviceId) }
+
     /**
      * Returns a map of region ID([AwsRegion.id]) to [AwsRegion] for the specified partition
      */
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecs/execution/EcsCloudDebugRunConfiguration.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecs/execution/EcsCloudDebugRunConfiguration.kt
@@ -16,6 +16,7 @@ import com.intellij.openapi.options.SettingsEditor
 import com.intellij.openapi.options.SettingsEditorGroup
 import com.intellij.openapi.project.Project
 import org.jdom.Element
+import software.amazon.awssdk.services.ecs.EcsClient
 import software.aws.toolkits.core.utils.error
 import software.aws.toolkits.core.utils.getLogger
 import software.aws.toolkits.jetbrains.core.AwsResourceCache
@@ -57,7 +58,7 @@ class EcsCloudDebugRunConfiguration(project: Project, private val configFactory:
 
         val editor = EcsCloudDebugSettingsEditor(project)
         group.addEditor(ExecutionBundle.message("run.configuration.configuration.tab.title"), editor)
-        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project, editor::awsConnectionUpdated))
+        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project, EcsClient.SERVICE_NAME, editor::awsConnectionUpdated))
 
         return group
     }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/execution/local/LocalLambdaRunConfiguration.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/execution/local/LocalLambdaRunConfiguration.kt
@@ -22,6 +22,7 @@ import com.intellij.refactoring.listeners.RefactoringElementListener
 import com.intellij.util.PathMappingSettings.PathMapping
 import com.intellij.util.text.SemVer
 import org.jetbrains.concurrency.isPending
+import software.amazon.awssdk.services.lambda.LambdaClient
 import software.amazon.awssdk.services.lambda.model.Runtime
 import software.aws.toolkits.core.lambda.LambdaRuntime
 import software.aws.toolkits.core.lambda.validOrNull
@@ -74,7 +75,7 @@ class LocalLambdaRunConfiguration(project: Project, factory: ConfigurationFactor
         val group = SettingsEditorGroup<LocalLambdaRunConfiguration>()
         group.addEditor(ExecutionBundle.message("run.configuration.configuration.tab.title"), LocalLambdaRunSettingsEditor(project))
         group.addEditor(message("lambda.run_configuration.sam"), SamSettingsEditor())
-        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project))
+        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project, LambdaClient.SERVICE_NAME))
         return group
     }
 
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/execution/remote/RemoteLambdaRunConfiguration.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/execution/remote/RemoteLambdaRunConfiguration.kt
@@ -11,6 +11,7 @@ import com.intellij.execution.configurations.RuntimeConfigurationError
 import com.intellij.execution.runners.ExecutionEnvironment
 import com.intellij.openapi.options.SettingsEditorGroup
 import com.intellij.openapi.project.Project
+import software.amazon.awssdk.services.lambda.LambdaClient
 import software.aws.toolkits.core.credentials.ToolkitCredentialsProvider
 import software.aws.toolkits.core.region.AwsRegion
 import software.aws.toolkits.jetbrains.services.lambda.execution.LambdaRunConfigurationBase
@@ -34,7 +35,7 @@ class RemoteLambdaRunConfiguration(project: Project, factory: ConfigurationFacto
         val group = SettingsEditorGroup<RemoteLambdaRunConfiguration>()
         val remoteLambdaSettings = RemoteLambdaRunSettingsEditor(project)
         group.addEditor(ExecutionBundle.message("run.configuration.configuration.tab.title"), remoteLambdaSettings)
-        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project, remoteLambdaSettings::updateFunctions))
+        group.addAwsConnectionEditor(AwsConnectionSettingsEditor(project, LambdaClient.SERVICE_NAME, remoteLambdaSettings::updateFunctions))
         return group
     }
 
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/wizard/SchemaSelectionPanel.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/wizard/SchemaSelectionPanel.kt
@@ -9,6 +9,7 @@ import com.intellij.openapi.ui.TextFieldWithBrowseButton
 import com.intellij.openapi.ui.ValidationInfo
 import com.intellij.openapi.vfs.VfsUtil
 import com.intellij.ui.layout.panel
+import software.amazon.awssdk.services.schemas.SchemasClient
 import software.aws.toolkits.core.lambda.LambdaRuntime
 import software.aws.toolkits.jetbrains.services.lambda.BuiltInRuntimeGroups
 import software.aws.toolkits.jetbrains.services.lambda.RuntimeGroup
@@ -27,7 +28,8 @@ class SchemaSelectionPanel : WizardFragment {
     private val schemaSelector by lazy { SchemaResourceSelector() }
     private val awsConnectionSelector by lazy {
         AwsConnectionSettingsSelector(
-            null
+            project = null,
+            serviceId = SchemasClient.SERVICE_NAME
         ) {
             val prev = schemaSelector.awsConnection
             schemaSelector.awsConnection = it
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/RegionSelector.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/RegionSelector.kt
@@ -37,7 +37,11 @@ class RegionSelector : ComboBox<AwsRegion>() {
     var selectedRegion: AwsRegion?
         get() = selected()
         set(value) {
-            selectedItem = value
+            selectedItem = if (comboBoxModel.items.contains(value)) {
+                value
+            } else {
+                null
+            }
         }
 
     private companion object {
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/connection/AwsConnectionSettingsEditor.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/connection/AwsConnectionSettingsEditor.kt
@@ -19,11 +19,19 @@ import software.aws.toolkits.jetbrains.core.region.AwsRegionProvider
 import software.aws.toolkits.resources.message
 import javax.swing.JComponent
 
+/**
+ * AWS settings for run configurations. Settings will be serialized with the rest of the run configuration.
+ * @param project The active project
+ * @param serviceName The ID of the service (accessed through <AWS client>.SERVICE_NAME in the JAVA SDK v2)
+ * used to filter out regions based on what regions a service is available in.
+ * @param settingsChangedListener A callback for when settings are changed
+ */
 class AwsConnectionSettingsEditor<T : AwsConnectionsRunConfigurationBase<*>>(
     project: Project,
+    serviceName: String? = null,
     settingsChangedListener: (AwsRegion?, String?) -> Unit = { _, _ -> }
 ) : SettingsEditor<T>() {
-    private val awsConnectionSelector = AwsConnectionSettingsSelector(project) {
+    private val awsConnectionSelector = AwsConnectionSettingsSelector(project, serviceName) {
         // TODO: Undo this unwrapping
         settingsChangedListener.invoke(it?.region, it?.credentials?.id)
     }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/connection/AwsConnectionSettingsSelector.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/ui/connection/AwsConnectionSettingsSelector.kt
@@ -16,14 +16,20 @@ import javax.swing.event.PopupMenuEvent
 
 class AwsConnectionSettingsSelector(
     project: Project?,
-    private val settingsChangedListener: (ConnectionSettings?) -> Unit = { _ -> }
+    serviceId: String? = null,
+    private val settingsChangedListener: (ConnectionSettings?) -> Unit = { _ -> },
 ) {
     private val regionProvider = AwsRegionProvider.getInstance()
     private val credentialManager = CredentialManager.getInstance()
     val view = AwsConnectionSettings()
 
     init {
-        view.region.setRegions(regionProvider.allRegions().values.toMutableList())
+        val regions = if (serviceId != null) {
+            regionProvider.allRegionsForService(serviceId).values.toMutableList()
+        } else {
+            regionProvider.allRegions().values.toMutableList()
+        }
+        view.region.setRegions(regions)
         view.credentialProvider.setCredentialsProviders(credentialManager.getCredentialIdentifiers())
 
         // nullable; unfortunately we can't rely on connection manager instance being retrievable from the default project
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/region/AwsRegionProviderTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/region/AwsRegionProviderTest.kt
@@ -151,6 +151,64 @@ class AwsRegionProviderTest {
             .containsKey("us-west-2")
     }
 
+    @Test
+    fun allRegionsForServiceWorks() {
+        createRegionDataProvider(
+            """
+            {
+                "partitions": [
+                    {
+                        "defaults": {
+                            "hostname": "{service}.{region}.{dnsSuffix}",
+                            "protocols": ["https"],
+                            "signatureVersions": ["v4"]
+                        },
+                        "dnsSuffix": "amazonaws.com",
+                        "partition": "aws",
+                        "partitionName": "AWS Standard",
+                        "regionRegex": "^(us|eu|ap|sa|ca|me)\\-\\w+\\-\\d+$",
+                        "regions": {
+                            "us-west-2": {
+                                "description": "US West (Oregon)"
+                            }
+                        },
+                        "services": {
+                            "a4b" : {
+                                "endpoints" : {
+                                    "us-west-2" : { }
+                                }
+                            }
+                        }
+                    },
+                    {
+                        "defaults": {
+                            "hostname": "{service}.{region}.{dnsSuffix}",
+                            "protocols": ["https"],
+                            "signatureVersions": ["v4"]
+                        },
+                        "dnsSuffix": "amazonaws.com.cn",
+                        "partition": "aws-cn",
+                        "partitionName": "AWS China",
+                        "regionRegex": "^cn\\-\\w+\\-\\d+$",
+                        "regions": {
+                            "cn-north-1": {
+                                "description": "China (Beijing)"
+                            }
+                        },
+                        "services": {}
+                    }
+                ],
+                "version": 3
+            }
+            """.trimIndent()
+        )
+
+        val awsRegionProvider = AwsRegionProvider()
+        assertThat(awsRegionProvider.allRegionsForService("a4b"))
+            .doesNotContainKey("cn-north-1")
+            .containsKey("us-west-2")
+    }
+
     @Test
     fun noDefaultRegionFallsBackToUsEast1() {
         createRegionDataProvider(
diff --git a/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/datagrip/auth/SecretsManagerAuthWidget.kt b/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/datagrip/auth/SecretsManagerAuthWidget.kt
@@ -11,6 +11,7 @@ import com.intellij.ui.components.JBLabel
 import com.intellij.ui.components.JBTextField
 import com.intellij.util.text.nullize
 import org.jetbrains.annotations.TestOnly
+import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient
 import software.aws.toolkits.jetbrains.services.rds.RdsResources
 import software.aws.toolkits.jetbrains.services.redshift.RedshiftUtils
 import software.aws.toolkits.jetbrains.ui.AwsAuthWidget
@@ -26,6 +27,7 @@ class SecretsManagerAuthWidget : AwsAuthWidget(userFieldEnabled = false) {
 
     override val rowCount = 5
     override fun getRegionFromUrl(url: String?): String? = RdsResources.extractRegionFromUrl(url) ?: RedshiftUtils.extractRegionFromUrl(url)
+    override val serviceId: String = SecretsManagerClient.SERVICE_NAME
 
     override fun createPanel(): JPanel {
         val panel = super.createPanel()
diff --git a/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/services/rds/auth/IamAuthWidget.kt b/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/services/rds/auth/IamAuthWidget.kt
@@ -9,6 +9,7 @@ import com.intellij.database.dataSource.url.template.ParametersHolder
 import com.intellij.database.dataSource.url.ui.UrlPropertiesPanel
 import com.intellij.ui.components.JBLabel
 import com.intellij.ui.components.JBTextField
+import software.amazon.awssdk.services.rds.RdsClient
 import software.aws.toolkits.jetbrains.services.rds.RdsResources
 import software.aws.toolkits.jetbrains.ui.AwsAuthWidget
 import software.aws.toolkits.resources.message
@@ -23,6 +24,7 @@ class IamAuthWidget : AwsAuthWidget() {
 
     override val rowCount = 4
     override fun getRegionFromUrl(url: String?): String? = RdsResources.extractRegionFromUrl(url)
+    override val serviceId: String = RdsClient.SERVICE_NAME
 
     override fun createPanel(): JPanel {
         val panel = super.createPanel()
diff --git a/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/services/redshift/auth/IamAuthWidget.kt b/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/services/redshift/auth/IamAuthWidget.kt
@@ -11,6 +11,7 @@ import com.intellij.database.dataSource.url.ui.UrlPropertiesPanel
 import com.intellij.ui.components.JBLabel
 import com.intellij.ui.components.JBTextField
 import org.jetbrains.annotations.TestOnly
+import software.amazon.awssdk.services.redshift.RedshiftClient
 import software.aws.toolkits.jetbrains.services.redshift.RedshiftUtils
 import software.aws.toolkits.jetbrains.ui.AwsAuthWidget
 import software.aws.toolkits.resources.message
@@ -23,6 +24,7 @@ class IamAuthWidget : AwsAuthWidget() {
 
     override val rowCount = 4
     override fun getRegionFromUrl(url: String?): String? = RedshiftUtils.extractRegionFromUrl(url)
+    override val serviceId: String = RedshiftClient.SERVICE_NAME
 
     override fun createPanel(): JPanel {
         val panel = super.createPanel()
diff --git a/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/ui/AwsAuthWidget.kt b/jetbrains-ultimate/src/software/aws/toolkits/jetbrains/ui/AwsAuthWidget.kt
@@ -31,6 +31,7 @@ abstract class AwsAuthWidget(private val userFieldEnabled: Boolean = true) : Dat
     protected val portParameter = "port"
 
     abstract fun getRegionFromUrl(url: String?): String?
+    abstract val serviceId: String
 
     open val rowCount: Int = 3
     open val columnCount: Int = 6
@@ -71,7 +72,13 @@ abstract class AwsAuthWidget(private val userFieldEnabled: Boolean = true) : Dat
         super.reset(dataSource, resetCredentials)
 
         val regionProvider = AwsRegionProvider.getInstance()
-        val allRegions = regionProvider.allRegions()
+        val allRegions = serviceId.let {
+            if (it != null) {
+                regionProvider.allRegionsForService(it)
+            } else {
+                regionProvider.allRegions()
+            }
+        }
         regionSelector.setRegions(allRegions.values.toMutableList())
         val regionId = dataSource.additionalJdbcProperties[REGION_ID_PROPERTY]?.nullize()
         regionId?.let {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "type" : "bugfix",
 +  "description" : "Fix resource selectors assuming every region has every service (#2435)"
 +}