View bucket by entering bucket name/URI (#2722)

manodnyab · web-flow · commit 9ac694d6611d · 2021-07-23T07:14:15.000-07:00
* Initial changes

* ListBuckets required

* View bucket with bucket name

* detekt changes

* minor change

* minor change

* dialog changes

* detekt changes

* feedback changes

* Validation checks added based on resource

* detekt changes

* parameter removed

* change log added
diff --git a/.changes/next-release/feature-281b59e6-ec54-4a07-8a91-ab6495031e19.json b/.changes/next-release/feature-281b59e6-ec54-4a07-8a91-ab6495031e19.json
@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "Add ability to view bucket by entering bucket name/URI"
+}
diff --git a/jetbrains-core/resources/META-INF/plugin.xml b/jetbrains-core/resources/META-INF/plugin.xml
@@ -375,6 +375,8 @@ with what features/services are supported.
         <group id="aws.toolkit.explorer.s3" popup="false" compact="false">
         <action id="s3.create.bucket"
                 class="software.aws.toolkits.jetbrains.services.s3.bucketActions.CreateBucketAction"/>
+        <action id="s3.view.bucket"
+                class="software.aws.toolkits.jetbrains.services.s3.bucketActions.ViewBucketAction"/>
         </group>
 
         <group id="aws.toolkit.explorer.s3.bucket" popup="true" compact="false">
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/explorer/ViewResourceDialog.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/explorer/ViewResourceDialog.kt
@@ -0,0 +1,30 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.core.explorer
+
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.ui.DialogWrapper
+import com.intellij.ui.layout.panel
+import javax.swing.JComponent
+
+class ViewResourceDialog(project: Project, val resourceType: String, actionTitle: String, checkResourceNameValidity: (resource: String?) -> Boolean) :
+    DialogWrapper(project) {
+    var resourceName = ""
+    private val component by lazy {
+        panel {
+            row("$resourceType:") {
+                textField(::resourceName).constraints(grow).withErrorOnApplyIf("$resourceType must be entered") {
+                    it.text.isNullOrBlank() || checkResourceNameValidity(it.text)
+                }
+            }
+        }
+    }
+
+    init {
+        title = actionTitle
+        init()
+    }
+
+    override fun createCenterPanel(): JComponent = component
+}
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/explorer/actions/ViewResourceAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/explorer/actions/ViewResourceAction.kt
@@ -0,0 +1,24 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.core.explorer.actions
+
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAware
+import software.aws.toolkits.jetbrains.core.explorer.ViewResourceDialog
+import software.aws.toolkits.jetbrains.core.explorer.nodes.AwsExplorerNode
+
+abstract class ViewResourceAction<in T : AwsExplorerNode<*>>(private val actionTitle: String, val resourceType: String) :
+    SingleExplorerNodeAction<T>(actionTitle), DumbAware {
+
+    override fun actionPerformed(selected: T, e: AnActionEvent) {
+        val getResourceNameDialog = ViewResourceDialog(selected.nodeProject, resourceType, actionTitle, this::checkResourceNameValidity)
+        if (getResourceNameDialog.showAndGet()) {
+            viewResource(getResourceNameDialog.resourceName, selected)
+        }
+    }
+
+    abstract fun viewResource(resourceToView: String, selected: T)
+
+    abstract fun checkResourceNameValidity(resourceName: String?): Boolean
+}
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/S3ExplorerNode.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/S3ExplorerNode.kt
@@ -32,7 +32,7 @@ class S3BucketNode(project: Project, val bucket: Bucket) :
     override fun isAlwaysShowPlus(): Boolean = false
 
     override fun onDoubleClick() {
-        openEditor(nodeProject, bucket)
+        openEditor(nodeProject, bucket.name())
     }
 
     override fun displayName(): String = bucket.name()
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/S3ViewerProvider.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/S3ViewerProvider.kt
@@ -16,7 +16,6 @@ import com.intellij.openapi.project.PossiblyDumbAware
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.util.UserDataHolderBase
 import com.intellij.openapi.vfs.VirtualFile
-import software.amazon.awssdk.services.s3.model.Bucket
 import software.aws.toolkits.jetbrains.core.awsClient
 import software.aws.toolkits.jetbrains.services.s3.editor.S3ViewerPanel
 import software.aws.toolkits.jetbrains.services.s3.editor.S3VirtualBucket
@@ -77,11 +76,11 @@ class S3ViewerEditor(project: Project, private val bucket: S3VirtualBucket) : Us
     override fun setState(state: FileEditorState) {}
 }
 
-fun openEditor(project: Project, bucket: Bucket, prefix: String = ""): Editor? = try {
+fun openEditor(project: Project, bucketName: String, prefix: String = ""): Editor? = try {
     FileEditorManager.getInstance(project).openTextEditor(
         OpenFileDescriptor(
             project,
-            S3VirtualBucket(bucket, prefix, project.awsClient(), project)
+            S3VirtualBucket(bucketName, prefix, project.awsClient(), project)
         ),
         true
     ).also {
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/OpenBucketViewerAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/OpenBucketViewerAction.kt
@@ -10,6 +10,6 @@ import software.aws.toolkits.jetbrains.services.s3.openEditor
 
 class OpenBucketViewerAction : SingleResourceNodeAction<S3BucketNode>(), DumbAware {
     override fun actionPerformed(selected: S3BucketNode, e: AnActionEvent) {
-        openEditor(selected.nodeProject, selected.bucket)
+        openEditor(selected.nodeProject, selected.bucket.name())
     }
 }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/OpenPrefixedBucketViewerAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/OpenPrefixedBucketViewerAction.kt
@@ -28,6 +28,6 @@ class OpenPrefixedBucketViewerAction : SingleResourceNodeAction<S3BucketNode>(),
             return
         }
 
-        openEditor(selected.nodeProject, selected.bucket, prefix)
+        openEditor(selected.nodeProject, selected.bucket.name(), prefix)
     }
 }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/ViewBucketAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/bucketActions/ViewBucketAction.kt
@@ -0,0 +1,28 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.services.s3.bucketActions
+
+import software.amazon.awssdk.services.s3.model.S3Exception
+import software.aws.toolkits.jetbrains.core.explorer.actions.ViewResourceAction
+import software.aws.toolkits.jetbrains.services.s3.S3ServiceNode
+import software.aws.toolkits.jetbrains.services.s3.openEditor
+import software.aws.toolkits.jetbrains.utils.notifyError
+import software.aws.toolkits.resources.message
+
+class ViewBucketAction : ViewResourceAction<S3ServiceNode>(message("action.aws.toolkit.s3.open.bucket.viewer.text"), message("s3.bucket.label")) {
+
+    override fun viewResource(resourceToView: String, selected: S3ServiceNode) {
+        try {
+            if (resourceToView.startsWith("S3://", ignoreCase = true)) {
+                openEditor(selected.nodeProject, resourceToView.split("S3://", ignoreCase = true).last().substringBefore("/"))
+            } else {
+                openEditor(selected.nodeProject, resourceToView)
+            }
+        } catch (e: S3Exception) {
+            e.notifyError(message("s3.open.viewer.bucket.failed"))
+        }
+    }
+
+    override fun checkResourceNameValidity(resourceName: String?): Boolean = resourceName.equals("S3://", ignoreCase = true)
+}
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeNode.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeNode.kt
@@ -11,10 +11,12 @@ import com.intellij.ui.SimpleTextAttributes
 import com.intellij.ui.treeStructure.SimpleNode
 import kotlinx.coroutines.runBlocking
 import software.amazon.awssdk.services.s3.model.NoSuchBucketException
+import software.amazon.awssdk.services.s3.model.S3Exception
 import software.aws.toolkits.core.utils.error
 import software.aws.toolkits.core.utils.getLogger
 import software.aws.toolkits.jetbrains.core.utils.buildList
 import software.aws.toolkits.jetbrains.services.s3.NOT_VERSIONED_VERSION_ID
+import software.aws.toolkits.jetbrains.utils.notifyError
 import software.aws.toolkits.resources.message
 import java.time.Instant
 
@@ -128,6 +130,15 @@ open class S3TreeDirectoryNode(bucket: S3VirtualBucket, parent: S3TreeDirectoryN
         } catch (e: NoSuchBucketException) {
             bucket.handleDeletedBucket()
             return emptyList()
+        } catch (e: S3Exception) {
+            e.notifyError("Access denied to bucket")
+            return buildList {
+                if (continuationMarker != null) {
+                    add(S3TreeErrorContinuationNode(bucket, this@S3TreeDirectoryNode, this@S3TreeDirectoryNode.key, continuationMarker))
+                } else {
+                    add(S3TreeErrorNode(bucket, this@S3TreeDirectoryNode))
+                }
+            }
         } catch (e: Exception) {
             LOG.error(e) { "Loading objects failed!" }
             return buildList {
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/editor/S3VirtualBucket.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/editor/S3VirtualBucket.kt
@@ -8,21 +8,18 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.openapi.vfs.VirtualFileManager
 import com.intellij.testFramework.LightVirtualFile
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.future.await
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.core.sync.RequestBody
 import software.amazon.awssdk.services.s3.S3Client
-import software.amazon.awssdk.services.s3.model.Bucket
 import software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse
 import software.amazon.awssdk.services.s3.model.ListObjectsV2Response
 import software.amazon.awssdk.services.s3.model.ObjectIdentifier
 import software.aws.toolkits.jetbrains.core.explorer.refreshAwsTree
 import software.aws.toolkits.jetbrains.services.s3.download
 import software.aws.toolkits.jetbrains.services.s3.resources.S3Resources
 import software.aws.toolkits.jetbrains.services.s3.upload
-import software.aws.toolkits.jetbrains.utils.ApplicationThreadPoolScope
 import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 import software.aws.toolkits.jetbrains.utils.getCoroutineUiContext
 import software.aws.toolkits.jetbrains.utils.notifyError
@@ -31,9 +28,8 @@ import java.io.OutputStream
 import java.net.URL
 import java.nio.file.Path
 
-class S3VirtualBucket(val s3Bucket: Bucket, prefix: String, val client: S3Client, val project: Project) :
-    LightVirtualFile(vfsName(s3Bucket, prefix)),
-    CoroutineScope by ApplicationThreadPoolScope("S3VirtualBucket") {
+class S3VirtualBucket(val s3Bucket: String, prefix: String, val client: S3Client, val project: Project) :
+    LightVirtualFile(vfsName(s3Bucket, prefix)) {
 
     var prefix = prefix
         set(value) {
@@ -54,68 +50,68 @@ class S3VirtualBucket(val s3Bucket: Bucket, prefix: String, val client: S3Client
         if (other !is S3VirtualBucket) {
             return false
         }
-        return s3Bucket.name() == (other as? S3VirtualBucket)?.s3Bucket?.name() && prefix == (other as? S3VirtualBucket)?.prefix
+        return s3Bucket == (other as? S3VirtualBucket)?.s3Bucket && prefix == (other as? S3VirtualBucket)?.prefix
     }
 
-    override fun hashCode(): Int = s3Bucket.name().hashCode() + prefix.hashCode()
+    override fun hashCode(): Int = s3Bucket.hashCode() + prefix.hashCode()
 
     suspend fun newFolder(name: String) {
         withContext(getCoroutineBgContext()) {
-            client.putObject({ it.bucket(s3Bucket.name()).key(name.trimEnd('/') + "/") }, RequestBody.empty())
+            client.putObject({ it.bucket(s3Bucket).key(name.trimEnd('/') + "/") }, RequestBody.empty())
         }
     }
 
     suspend fun listObjects(prefix: String, continuationToken: String?): ListObjectsV2Response =
         withContext(getCoroutineBgContext()) {
             client.listObjectsV2 {
-                it.bucket(s3Bucket.name()).delimiter("/").prefix(prefix).maxKeys(MAX_ITEMS_TO_LOAD).continuationToken(continuationToken)
+                it.bucket(s3Bucket).delimiter("/").prefix(prefix).maxKeys(MAX_ITEMS_TO_LOAD).continuationToken(continuationToken)
             }
         }
 
     suspend fun listObjectVersions(key: String, keyMarker: String?, versionIdMarker: String?): ListObjectVersionsResponse? =
         withContext(getCoroutineBgContext()) {
             client.listObjectVersions {
-                it.bucket(s3Bucket.name()).prefix(key).delimiter("/").maxKeys(MAX_ITEMS_TO_LOAD).keyMarker(keyMarker).versionIdMarker(versionIdMarker)
+                it.bucket(s3Bucket).prefix(key).delimiter("/").maxKeys(MAX_ITEMS_TO_LOAD).keyMarker(keyMarker).versionIdMarker(versionIdMarker)
             }
         }
 
     suspend fun deleteObjects(keys: List<String>) {
         withContext(getCoroutineBgContext()) {
             val keysToDelete = keys.map { ObjectIdentifier.builder().key(it).build() }
-            client.deleteObjects { it.bucket(s3Bucket.name()).delete { del -> del.objects(keysToDelete) } }
+            client.deleteObjects { it.bucket(s3Bucket).delete { del -> del.objects(keysToDelete) } }
         }
     }
 
     suspend fun renameObject(fromKey: String, toKey: String) {
         withContext(getCoroutineBgContext()) {
-            client.copyObject { it.copySource("${s3Bucket.name()}/$fromKey").destinationBucket(s3Bucket.name()).destinationKey(toKey) }
-            client.deleteObject { it.bucket(s3Bucket.name()).key(fromKey) }
+            client.copyObject { it.copySource("$s3Bucket/$fromKey").destinationBucket(s3Bucket).destinationKey(toKey) }
+            client.deleteObject { it.bucket(s3Bucket).key(fromKey) }
         }
     }
 
     suspend fun upload(project: Project, source: Path, key: String) {
         withContext(getCoroutineBgContext()) {
-            client.upload(project, source, s3Bucket.name(), key).await()
+            client.upload(project, source, s3Bucket, key).await()
         }
     }
 
     suspend fun download(project: Project, key: String, versionId: String? = null, output: OutputStream) {
         withContext(getCoroutineBgContext()) {
-            client.download(project, s3Bucket.name(), key, versionId, output).await()
+            client.download(project, s3Bucket, key, versionId, output).await()
         }
     }
 
     fun generateUrl(key: String, versionId: String?): URL = client.utilities().getUrl {
-        it.bucket(s3Bucket.name())
+        it.bucket(s3Bucket)
         it.key(key)
         it.versionId(versionId)
     }
 
     fun handleDeletedBucket() {
-        notifyError(project = project, content = message("s3.open.viewer.bucket_does_not_exist", s3Bucket.name()))
+        notifyError(project = project, content = message("s3.open.viewer.bucket_does_not_exist", s3Bucket))
         val fileEditorManager = FileEditorManager.getInstance(project)
         fileEditorManager.openFiles.forEach {
-            if (it is S3VirtualBucket && it.name == s3Bucket.name()) {
+            if (it is S3VirtualBucket && it.name == s3Bucket) {
                 runBlocking(getCoroutineUiContext()) {
                     fileEditorManager.closeFile(it)
                 }
@@ -127,10 +123,10 @@ class S3VirtualBucket(val s3Bucket: Bucket, prefix: String, val client: S3Client
     private companion object {
         const val MAX_ITEMS_TO_LOAD = 300
 
-        fun vfsName(s3Bucket: Bucket, subroot: String): String = if (subroot.isBlank()) {
-            s3Bucket.name()
+        fun vfsName(s3BucketName: String, subroot: String): String = if (subroot.isBlank()) {
+            s3BucketName
         } else {
-            "${s3Bucket.name()}/$subroot"
+            "$s3BucketName/$subroot"
         }
     }
 }
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/DeleteBucketTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/DeleteBucketTest.kt
@@ -122,10 +122,10 @@ class DeleteBucketTest {
             // Silly hack because test file editor impl has a bunch of asserts about the document/psi that don't exist in the real impl
             associateFilePattern(FileTypes.PLAIN_TEXT, bucket.name(), disposableRule.disposable)
 
-            assertThat(openEditor(projectRule.project, bucket)).isNotNull
+            assertThat(openEditor(projectRule.project, bucket.name())).isNotNull
         }
 
-        val s3VirtualBucket = S3VirtualBucket(bucket, "", s3Mock, projectRule.project)
+        val s3VirtualBucket = S3VirtualBucket(bucket.name(), "", s3Mock, projectRule.project)
         val fileEditorManager = FileEditorManager.getInstance(projectRule.project)
 
         assertThat(fileEditorManager.openFiles).contains(s3VirtualBucket)
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/S3VirtualBucketTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/S3VirtualBucketTest.kt
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeDirectoryNodeTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeDirectoryNodeTest.kt
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeObjectNodeTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeObjectNodeTest.kt
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeObjectVersionNodeTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/s3/editor/S3TreeObjectVersionNodeTest.kt
diff --git a/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties b/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "type" : "feature",
 +  "description" : "Add ability to view bucket by entering bucket name/URI"
 +}
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class S3BucketNode(project: Project, val bucket: Bucket) :`
`32`	`32`	`override fun isAlwaysShowPlus(): Boolean = false`
`33`	`33`
`34`	`34`	`override fun onDoubleClick() {`
`35`		`- openEditor(nodeProject, bucket)`
	`35`	`+ openEditor(nodeProject, bucket.name())`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`override fun displayName(): String = bucket.name()`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@ import software.aws.toolkits.jetbrains.services.s3.openEditor`
`10`	`10`
`11`	`11`	`class OpenBucketViewerAction : SingleResourceNodeAction<S3BucketNode>(), DumbAware {`
`12`	`12`	`override fun actionPerformed(selected: S3BucketNode, e: AnActionEvent) {`
`13`		`- openEditor(selected.nodeProject, selected.bucket)`
	`13`	`+ openEditor(selected.nodeProject, selected.bucket.name())`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ class OpenPrefixedBucketViewerAction : SingleResourceNodeAction<S3BucketNode>(),`
`28`	`28`	`return`
`29`	`29`	`}`
`30`	`30`
`31`		`- openEditor(selected.nodeProject, selected.bucket, prefix)`
	`31`	`+ openEditor(selected.nodeProject, selected.bucket.name(), prefix)`
`32`	`32`	`}`
`33`	`33`	`}`