Improve UX for uncaught UnsupportedAction exception (#2898)

Author: kiiadi

.changes/next-release/bugfix-08864682-ab15-45b0-8de8-d78ecfa8b85b.json

@@ -0,0 +1,4 @@
+{
+  "type" : "bugfix",
+  "description" : "Fix uncaught exception when a resource does not support LIST in a certain region."
+}

core/tst/software/aws/toolkits/core/utils/test/AssertJAsserts.kt

@@ -4,6 +4,7 @@
 package software.aws.toolkits.core.utils.test
 
 import org.assertj.core.api.IterableAssert
+import org.assertj.core.api.ListAssert
 import org.assertj.core.api.ObjectAssert
 
 @Suppress("UNCHECKED_CAST")
@@ -13,3 +14,7 @@ val <T : Any> ObjectAssert<T?>.notNull: ObjectAssert<T>
 @Suppress("UNCHECKED_CAST")
 inline fun <reified SubType : Any> IterableAssert<*>.hasOnlyElementsOfType(): IterableAssert<SubType> =
     hasOnlyElementsOfType(SubType::class.java) as IterableAssert<SubType>
+
+@Suppress("UNCHECKED_CAST")
+inline fun <reified SubType : Any> ListAssert<*>.hasOnlyOneElementOfType(): ObjectAssert<SubType> =
+    (hasOnlyElementsOfType(SubType::class.java) as ListAssert<SubType>).singleElement()

jetbrains-core/src/software/aws/toolkits/jetbrains/services/dynamic/explorer/DynamicResourceServiceNode.kt

@@ -8,9 +8,11 @@ import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.progress.Task
 import com.intellij.openapi.project.Project
 import com.intellij.ui.EditorNotifications
+import software.amazon.awssdk.services.cloudcontrol.model.UnsupportedActionException
 import software.aws.toolkits.core.utils.getLogger
 import software.aws.toolkits.jetbrains.core.awsClient
 import software.aws.toolkits.jetbrains.core.credentials.getConnectionSettingsOrThrow
+import software.aws.toolkits.jetbrains.core.explorer.nodes.AwsExplorerEmptyNode
 import software.aws.toolkits.jetbrains.core.explorer.nodes.AwsExplorerNode
 import software.aws.toolkits.jetbrains.core.explorer.nodes.ResourceActionNode
 import software.aws.toolkits.jetbrains.core.explorer.nodes.ResourceParentNode
@@ -24,6 +26,7 @@ import software.aws.toolkits.jetbrains.services.dynamic.OpenViewEditableDynamicR
 import software.aws.toolkits.jetbrains.services.dynamic.ViewEditableDynamicResourceVirtualFile
 import software.aws.toolkits.resources.message
 import software.aws.toolkits.telemetry.DynamicresourceTelemetry
+import software.aws.toolkits.telemetry.Result
 
 class DynamicResourceResourceTypeNode(project: Project, private val resourceType: String) :
     AwsExplorerNode<String>(project, resourceType, null),
@@ -43,8 +46,16 @@ class DynamicResourceResourceTypeNode(project: Project, private val resourceType
             .map { DynamicResourceNode(nodeProject, it) }
             .also { DynamicresourceTelemetry.listResource(project = nodeProject, success = true, resourceType = resourceType) }
     } catch (e: Exception) {
-        DynamicresourceTelemetry.listResource(project = nodeProject, success = false, resourceType = resourceType)
-        throw e
+        when (e) {
+            is UnsupportedActionException -> {
+                DynamicresourceTelemetry.listResource(project = nodeProject, result = Result.Cancelled, resourceType = resourceType)
+                listOf(AwsExplorerEmptyNode(nodeProject, message("dynamic_resources.unavailable_in_region", region.id)))
+            }
+            else -> {
+                DynamicresourceTelemetry.listResource(project = nodeProject, success = false, resourceType = resourceType)
+                throw e
+            }
+        }
     }
 
     override fun actionGroupName(): String = "aws.toolkit.explorer.dynamic.resource.type"

jetbrains-core/tst/software/aws/toolkits/jetbrains/services/dynamic/explorer/DynamicResourceResourceTypeNodeTest.kt

@@ -0,0 +1,71 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.services.dynamic.explorer
+
+import com.intellij.testFramework.ProjectRule
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.Rule
+import org.junit.Test
+import software.amazon.awssdk.services.cloudcontrol.model.UnsupportedActionException
+import software.aws.toolkits.core.utils.test.aString
+import software.aws.toolkits.core.utils.test.hasOnlyOneElementOfType
+import software.aws.toolkits.jetbrains.core.MockResourceCacheRule
+import software.aws.toolkits.jetbrains.core.explorer.nodes.AwsExplorerEmptyNode
+import software.aws.toolkits.jetbrains.core.explorer.nodes.AwsExplorerErrorNode
+import software.aws.toolkits.jetbrains.services.dynamic.CloudControlApiResources
+import software.aws.toolkits.jetbrains.services.dynamic.DynamicResource
+import software.aws.toolkits.jetbrains.services.dynamic.ResourceType
+import software.aws.toolkits.resources.message
+import java.util.concurrent.CompletableFuture
+
+class DynamicResourceResourceTypeNodeTest {
+
+    @Rule
+    @JvmField
+    val projectRule = ProjectRule()
+
+    @Rule
+    @JvmField
+    val resourceCache = MockResourceCacheRule()
+
+    @Test
+    fun returnsListFromProvider() {
+        val type = aString()
+        val identifier = aString()
+        val resources = listOf(DynamicResource(ResourceType(type, "foo", "bah"), identifier))
+        resourceCache.addEntry(projectRule.project, CloudControlApiResources.listResources(type), resources)
+
+        val sut = DynamicResourceResourceTypeNode(projectRule.project, type)
+
+        assertThat(sut.children).hasOnlyOneElementOfType<DynamicResourceNode>().satisfies {
+            assertThat(it.displayName()).isEqualTo(identifier)
+        }
+    }
+
+    @Test
+    fun unsupportedExceptionResultsInEmptyNode() {
+        val type = aString()
+        resourceCache.addEntry(
+            projectRule.project,
+            CloudControlApiResources.listResources(type),
+            CompletableFuture.failedFuture(UnsupportedActionException.builder().build())
+        )
+
+        val sut = DynamicResourceResourceTypeNode(projectRule.project, type)
+
+        assertThat(sut.children).hasOnlyOneElementOfType<AwsExplorerEmptyNode>().satisfies {
+            assertThat(it.displayName()).startsWith(message("dynamic_resources.unavailable_in_region", ""))
+        }
+    }
+
+    @Test
+    fun otherExceptionsBubble() {
+        val type = aString()
+        resourceCache.addEntry(projectRule.project, CloudControlApiResources.listResources(type), CompletableFuture.failedFuture(RuntimeException()))
+
+        val sut = DynamicResourceResourceTypeNode(projectRule.project, type)
+
+        assertThat(sut.children).hasOnlyOneElementOfType<AwsExplorerErrorNode>()
+    }
+}