Fixing bug with doc links for resources (#2901)

Author: kiiadi

.changes/next-release/bugfix-1856587c-070d-439f-b45b-9235ddc482b8.json

@@ -0,0 +1,4 @@
+{
+  "type" : "bugfix",
+  "description" : "Fix null exception when view documentation action executed for types with missing doc urls"
+}

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

@@ -52,9 +52,12 @@ class DynamicResourceFileActionProvider :
     class DynamicResourceVirtualFilePanel(project: Project, file: DynamicResourceVirtualFile, text: String, actionId: String) : EditorNotificationPanel() {
         init {
             text(text)
-            createActionLabel(message("dynamic_resources.type.explorer.view_documentation")) {
-                openBrowser(file.dynamicResourceType, project)
+            DynamicResourceSupportedTypes.getInstance().getDocs(file.dynamicResourceType)?.let { docUrl ->
+                createActionLabel(message("dynamic_resources.type.explorer.view_documentation")) {
+                    BrowserLauncher.instance.browse(docUrl, project = project)
+                }
             }
+
             val action = ActionManager.getInstance().getAction(actionId)
             createActionLabel(action.templateText) {
                 executeAction(actionId)
@@ -65,8 +68,5 @@ class DynamicResourceFileActionProvider :
 
     companion object {
         val KEY = Key.create<DynamicResourceVirtualFilePanel>("software.aws.toolkits.jetbrains.core.dynamic.resource.file.actions")
-
-        fun openBrowser(resourceType: String, project: Project) =
-            BrowserLauncher.instance.browse(DynamicResourceSupportedTypes.getInstance().getDocs(resourceType), project = project)
     }
 }

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

@@ -6,29 +6,26 @@ package software.aws.toolkits.jetbrains.services.dynamic
 import com.fasterxml.jackson.databind.DeserializationFeature
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
-import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.components.service
+import software.aws.toolkits.jetbrains.utils.runUnderProgressIfNeeded
+import software.aws.toolkits.resources.message
 
 class DynamicResourceSupportedTypes {
 
-    private val docs = mutableMapOf<String, String>()
-    private val mapper = jacksonObjectMapper().disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
-    private val supportedTypes = if (ApplicationManager.getApplication().isDispatchThread) {
-        throw IllegalStateException("Access from Event Dispatch Thread")
-    } else {
-        this.javaClass.getResourceAsStream("/cloudapi/dynamic_resources.json")?.use { resourceStream ->
-            val resourceDetails = mapper.readValue<Map<String, ResourceDetails>>(resourceStream)
-                .filter { it.value.operations.contains(PermittedOperation.LIST) }
-            resourceDetails.forEach { docs[it.key] = it.value.documentation.toString() }
-            resourceDetails.map { it.key }
-        } ?: throw RuntimeException("dynamic resource manifest not found")
+    private val supportedTypes by lazy {
+        runUnderProgressIfNeeded(null, message("dynamic_resources.loading_manifest"), cancelable = false) {
+            this.javaClass.getResourceAsStream("/cloudapi/dynamic_resources.json")?.use { resourceStream ->
+                MAPPER.readValue<Map<String, ResourceDetails>>(resourceStream)
+            } ?: throw RuntimeException("dynamic resource manifest not found")
+        }
     }
 
-    fun getSupportedTypes(): List<String> = supportedTypes
+    fun getSupportedTypes(): List<String> = supportedTypes.filterValues { it.operations.contains(PermittedOperation.LIST) }.keys.toList()
 
-    fun getDocs(resourceType: String): String = docs[resourceType] ?: throw RuntimeException("dynamic resource manifest doesn't have doc link")
+    fun getDocs(resourceType: String) = supportedTypes[resourceType]?.documentation
 
     companion object {
         fun getInstance(): DynamicResourceSupportedTypes = service()
+        private val MAPPER = jacksonObjectMapper().disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
     }
 }

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

@@ -28,7 +28,7 @@ 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) :
+class DynamicResourceResourceTypeNode(project: Project, val resourceType: String) :
     AwsExplorerNode<String>(project, resourceType, null),
     ResourceParentNode,
     ResourceActionNode {

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

@@ -3,14 +3,22 @@
 
 package software.aws.toolkits.jetbrains.services.dynamic.explorer.actions
 
+import com.intellij.ide.browsers.BrowserLauncher
 import com.intellij.openapi.actionSystem.AnActionEvent
 import software.aws.toolkits.jetbrains.core.explorer.actions.SingleExplorerNodeAction
-import software.aws.toolkits.jetbrains.services.dynamic.DynamicResourceFileActionProvider
+import software.aws.toolkits.jetbrains.services.dynamic.DynamicResourceSupportedTypes
 import software.aws.toolkits.jetbrains.services.dynamic.explorer.DynamicResourceResourceTypeNode
 import software.aws.toolkits.resources.message
 
 class ViewDocumentationAction : SingleExplorerNodeAction<DynamicResourceResourceTypeNode>(message("dynamic_resources.type.explorer.view_documentation")) {
+    private val supportedType = DynamicResourceSupportedTypes.getInstance()
     override fun actionPerformed(selected: DynamicResourceResourceTypeNode, e: AnActionEvent) {
-        DynamicResourceFileActionProvider.openBrowser(selected.value, selected.nodeProject)
+        supportedType.getDocs(selected.resourceType)?.let { docUrl ->
+            BrowserLauncher.instance.browse(docUrl, project = e.project)
+        }
+    }
+
+    override fun update(selected: DynamicResourceResourceTypeNode, e: AnActionEvent) {
+        e.presentation.isEnabledAndVisible = supportedType.getDocs(selected.resourceType) != null
     }
 }

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

@@ -454,6 +454,7 @@ dynamic_resources.fetch.fail.title=Open resource model
 dynamic_resources.fetch.fetch=Retrieving model
 dynamic_resources.fetch.indicator_title=Open resource model for {0}
 dynamic_resources.fetch.open=Opening model in IDE
+dynamic_resources.loading_manifest=Loading AWS resource manifest
 dynamic_resources.openFileForUpdate_text=Update resource...
 dynamic_resources.openReadOnlyFile_text=View Resource
 dynamic_resources.operation_status_failed=Failed to {1} {0}: {2}