Ban use of Dispatchers (#2688)

abrooksv · web-flow · commit 36c24b462f33 · 2021-06-30T13:22:44.000-07:00
diff --git a/core/src/software/aws/toolkits/core/credentials/sso/SsoCredentialProvider.kt b/core/src/software/aws/toolkits/core/credentials/sso/SsoCredentialProvider.kt
@@ -1,6 +1,8 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+@file:Suppress("BannedImports")
+
 package software.aws.toolkits.core.credentials.sso
 
 import kotlinx.coroutines.Dispatchers
diff --git a/detekt-rules/src/main/kotlin/software/aws/toolkits/gradle/detekt/rules/BannedImportsRule.kt b/detekt-rules/src/main/kotlin/software/aws/toolkits/gradle/detekt/rules/BannedImportsRule.kt
@@ -48,6 +48,16 @@ class BannedImportsRule : Rule() {
                     )
                 )
             }
+
+            if (element.importedFqName?.asString()?.contains("kotlinx.coroutines.Dispatchers") == true) {
+                report(
+                    CodeSmell(
+                        issue,
+                        Entity.from(element),
+                        message = "Use contexts from CoroutineUtils.kt instead of Dispatchers"
+                    )
+                )
+            }
         }
     }
 }
diff --git a/detekt-rules/src/main/kotlin/software/aws/toolkits/gradle/detekt/rules/BannedPatternRule.kt b/detekt-rules/src/main/kotlin/software/aws/toolkits/gradle/detekt/rules/BannedPatternRule.kt
@@ -16,7 +16,7 @@ class BannedPatternRule(private val patterns: List<BannedPattern>) : Rule() {
 
     override fun visitKtFile(file: KtFile) {
         var offset = 0
-        file.text.split("\n").forEachIndexed { line, text ->
+        file.text.split("\n").forEachIndexed { _, text ->
             patterns.forEach { pattern ->
                 val match = pattern.regex.find(text) ?: return@forEach
                 report(
diff --git a/detekt-rules/src/test/kotlin/BannedImportsRuleTest.kt b/detekt-rules/src/test/kotlin/BannedImportsRuleTest.kt
@@ -42,4 +42,18 @@ class BannedImportsRuleTest {
     fun `Importing Assert assertThat succeeds`() {
         assertThat(rule.lint("import org.assertj.core.api.Assertions.assertThat")).isEmpty()
     }
+
+    @Test
+    fun `Importing Dispatchers fails`() {
+        assertThat(rule.lint("import kotlinx.coroutines.Dispatchers"))
+            .singleElement()
+            .matches { it.id == "BannedImports" && it.message == "Use contexts from CoroutineUtils.kt instead of Dispatchers" }
+    }
+
+    @Test
+    fun `Importing Dispatchers statically fails`() {
+        assertThat(rule.lint("import kotlinx.coroutines.Dispatchers.IO"))
+            .singleElement()
+            .matches { it.id == "BannedImports" && it.message == "Use contexts from CoroutineUtils.kt instead of Dispatchers" }
+    }
 }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/cloudwatch/logs/CloudWatchActor.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/cloudwatch/logs/CloudWatchActor.kt
@@ -9,7 +9,6 @@ import com.intellij.ui.TableUtil
 import com.intellij.ui.table.TableView
 import com.intellij.util.ExceptionUtil
 import kotlinx.coroutines.CoroutineExceptionHandler
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.launch
@@ -30,6 +29,7 @@ import software.aws.toolkits.jetbrains.services.cloudwatch.logs.insights.LogResu
 import software.aws.toolkits.jetbrains.services.cloudwatch.logs.insights.identifier
 import software.aws.toolkits.jetbrains.services.cloudwatch.logs.insights.toLogResult
 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
 import software.aws.toolkits.resources.message
@@ -467,7 +467,7 @@ class InsightsQueryResultsActor(
     }
 
     // run on a separate context so we don't lock up the message listener
-    private fun startLoading() = coroutineScope.launch(Dispatchers.Default) {
+    private fun startLoading() = coroutineScope.launch(getCoroutineBgContext()) {
         tableLoading()
         val loadedQueryResults = mutableSetOf<String>()
         var response: GetQueryResultsResponse
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/cloudwatch/logs/insights/SaveQueryDialog.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/cloudwatch/logs/insights/SaveQueryDialog.kt
@@ -7,7 +7,6 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.DialogWrapper
 import com.intellij.openapi.ui.ValidationInfo
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient
@@ -18,6 +17,7 @@ import software.aws.toolkits.jetbrains.core.AwsResourceCache
 import software.aws.toolkits.jetbrains.core.credentials.ConnectionSettings
 import software.aws.toolkits.jetbrains.services.cloudwatch.logs.resources.CloudWatchResources
 import software.aws.toolkits.jetbrains.utils.ApplicationThreadPoolScope
+import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 import software.aws.toolkits.jetbrains.utils.notifyError
 import software.aws.toolkits.jetbrains.utils.notifyInfo
 import software.aws.toolkits.resources.message
@@ -63,12 +63,12 @@ class SaveQueryDialog(
         super.doCancelAction()
     }
 
-    override fun createCenterPanel(): JComponent? = view.saveQueryPanel
+    override fun createCenterPanel(): JComponent = view.saveQueryPanel
     override fun doValidate(): ValidationInfo? = validateQueryName(view)
     override fun getOKAction(): Action = action
 
     private suspend fun getExistingQueryId(queryName: String): String? {
-        val definitions = withContext(Dispatchers.Default) {
+        val definitions = withContext(getCoroutineBgContext()) {
             resourceCache.getResourceNow(
                 CloudWatchResources.DESCRIBE_QUERY_DEFINITIONS,
                 region = connectionSettings.region,
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PullFromRepositoryAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PullFromRepositoryAction.kt
@@ -12,7 +12,6 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.DialogWrapper
 import com.intellij.ui.SimpleListCellRenderer
 import com.intellij.ui.layout.panel
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.services.ecr.EcrClient
@@ -26,6 +25,7 @@ import software.aws.toolkits.jetbrains.services.ecr.resources.EcrResources
 import software.aws.toolkits.jetbrains.services.ecr.resources.Repository
 import software.aws.toolkits.jetbrains.ui.ResourceSelector
 import software.aws.toolkits.jetbrains.utils.ApplicationThreadPoolScope
+import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 import software.aws.toolkits.resources.message
 
 class PullFromRepositoryAction : EcrDockerAction() {
@@ -43,7 +43,7 @@ class PullFromRepositoryAction : EcrDockerAction() {
         val client: EcrClient = project.awsClient()
         coroutineScope.launch {
             val runtime = dockerServerRuntime.await()
-            val authData = withContext(Dispatchers.IO) {
+            val authData = withContext(getCoroutineBgContext()) {
                 client.authorizationToken.authorizationData().first()
             }
             PullFromEcrTask(project, authData.getDockerLogin(), repo, image, runtime).queue()
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PushToRepositoryAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PushToRepositoryAction.kt
@@ -35,7 +35,6 @@ import com.intellij.ui.layout.panel
 import com.intellij.ui.layout.selected
 import com.intellij.util.text.nullize
 import kotlinx.coroutines.Deferred
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.core.exception.SdkException
@@ -55,6 +54,7 @@ import software.aws.toolkits.jetbrains.services.ecr.resources.Repository
 import software.aws.toolkits.jetbrains.services.ecr.toLocalImageList
 import software.aws.toolkits.jetbrains.ui.ResourceSelector
 import software.aws.toolkits.jetbrains.utils.ApplicationThreadPoolScope
+import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 import software.aws.toolkits.jetbrains.utils.notifyError
 import software.aws.toolkits.jetbrains.utils.ui.installOnParent
 import software.aws.toolkits.jetbrains.utils.ui.selected
@@ -84,7 +84,7 @@ class PushToRepositoryAction : EcrDockerAction() {
             val pushRequest = dialog.getPushRequest()
             var result = Result.Failed
             try {
-                val authData = withContext(Dispatchers.IO) {
+                val authData = withContext(getCoroutineBgContext()) {
                     client.authorizationToken.authorizationData().first()
                 }
 
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecs/resources/SessionManagerPluginInstallationVerification.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecs/resources/SessionManagerPluginInstallationVerification.kt
@@ -7,12 +7,12 @@ import com.intellij.execution.configurations.GeneralCommandLine
 import com.intellij.execution.process.CapturingProcessHandler
 import com.intellij.openapi.application.runInEdt
 import com.intellij.openapi.project.Project
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.runBlocking
 import software.aws.toolkits.jetbrains.services.ecs.exec.SessionManagerPluginWarning
+import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 
 object SessionManagerPluginInstallationVerification {
-    private fun checkInstallation(): Boolean = runBlocking(Dispatchers.IO) {
+    private fun checkInstallation(): Boolean = runBlocking(getCoroutineBgContext()) {
         try {
             val process = CapturingProcessHandler(GeneralCommandLine("session-manager-plugin")).runProcess()
             process.exitCode == 0
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
@@ -9,7 +9,6 @@ import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.openapi.vfs.VirtualFileManager
 import com.intellij.testFramework.LightVirtualFile
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.future.await
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
@@ -24,6 +23,7 @@ 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
 import software.aws.toolkits.resources.message
@@ -60,45 +60,47 @@ class S3VirtualBucket(val s3Bucket: Bucket, prefix: String, val client: S3Client
     override fun hashCode(): Int = s3Bucket.name().hashCode() + prefix.hashCode()
 
     suspend fun newFolder(name: String) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.putObject({ it.bucket(s3Bucket.name()).key(name.trimEnd('/') + "/") }, RequestBody.empty())
         }
     }
 
-    suspend fun listObjects(prefix: String, continuationToken: String?): ListObjectsV2Response = withContext(Dispatchers.IO) {
-        client.listObjectsV2 {
-            it.bucket(s3Bucket.name()).delimiter("/").prefix(prefix).maxKeys(MAX_ITEMS_TO_LOAD).continuationToken(continuationToken)
+    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)
+            }
         }
-    }
 
-    suspend fun listObjectVersions(key: String, keyMarker: String?, versionIdMarker: String?): ListObjectVersionsResponse? = withContext(Dispatchers.IO) {
-        client.listObjectVersions {
-            it.bucket(s3Bucket.name()).prefix(key).delimiter("/").maxKeys(MAX_ITEMS_TO_LOAD).keyMarker(keyMarker).versionIdMarker(versionIdMarker)
+    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)
+            }
         }
-    }
 
     suspend fun deleteObjects(keys: List<String>) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             val keysToDelete = keys.map { ObjectIdentifier.builder().key(it).build() }
             client.deleteObjects { it.bucket(s3Bucket.name()).delete { del -> del.objects(keysToDelete) } }
         }
     }
 
     suspend fun renameObject(fromKey: String, toKey: String) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.copyObject { it.copySource("${s3Bucket.name()}/$fromKey").destinationBucket(s3Bucket.name()).destinationKey(toKey) }
             client.deleteObject { it.bucket(s3Bucket.name()).key(fromKey) }
         }
     }
 
     suspend fun upload(project: Project, source: InputStream, length: Long, key: String) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.upload(project, source, length, s3Bucket.name(), key).await()
         }
     }
 
     suspend fun download(project: Project, key: String, versionId: String? = null, output: OutputStream) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.download(project, s3Bucket.name(), key, versionId, output).await()
         }
     }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/sqs/toolwindow/SendMessagePane.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/sqs/toolwindow/SendMessagePane.kt
@@ -10,14 +10,14 @@ import com.intellij.openapi.ui.ComponentValidator
 import com.intellij.openapi.ui.ValidationInfo
 import com.intellij.ui.IdeBorderFactory
 import com.intellij.ui.components.JBTextArea
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.services.sqs.SqsClient
 import software.aws.toolkits.jetbrains.services.sqs.Queue
 import software.aws.toolkits.jetbrains.services.sqs.telemetryType
 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.resources.message
 import software.aws.toolkits.telemetry.Result
@@ -88,7 +88,7 @@ class SendMessagePane(
             return
         }
         try {
-            withContext(Dispatchers.IO) {
+            withContext(getCoroutineBgContext()) {
                 val messageId = client.sendMessage {
                     it.queueUrl(queue.queueUrl)
                     it.messageBody(inputText.text)
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/telemetry/DefaultTelemetryPublisher.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/telemetry/DefaultTelemetryPublisher.kt
@@ -3,7 +3,6 @@
 
 package software.aws.toolkits.jetbrains.services.telemetry
 
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import software.amazon.awssdk.auth.credentials.AnonymousCredentialsProvider
 import software.amazon.awssdk.regions.Region
@@ -16,14 +15,15 @@ import software.aws.toolkits.core.ToolkitClientManager
 import software.aws.toolkits.core.telemetry.MetricEvent
 import software.aws.toolkits.core.telemetry.TelemetryPublisher
 import software.aws.toolkits.jetbrains.core.AwsSdkClient
+import software.aws.toolkits.jetbrains.utils.getCoroutineBgContext
 import kotlin.streams.toList
 
 class DefaultTelemetryPublisher(
     private val clientMetadata: ClientMetadata = ClientMetadata.DEFAULT_METADATA,
     private val client: ToolkitTelemetryClient = createDefaultTelemetryClient()
 ) : TelemetryPublisher {
     override suspend fun publish(metricEvents: Collection<MetricEvent>) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.postMetrics {
                 it.awsProduct(clientMetadata.productName)
                 it.awsProductVersion(clientMetadata.productVersion)
@@ -38,7 +38,7 @@ class DefaultTelemetryPublisher(
     }
 
     override suspend fun sendFeedback(sentiment: Sentiment, comment: String) {
-        withContext(Dispatchers.IO) {
+        withContext(getCoroutineBgContext()) {
             client.postFeedback {
                 it.awsProduct(clientMetadata.productName)
                 it.awsProductVersion(clientMetadata.productVersion)

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,16 @@ class BannedImportsRule : Rule() {`
`48`	`48`	`)`
`49`	`49`	`)`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ if (element.importedFqName?.asString()?.contains("kotlinx.coroutines.Dispatchers") == true) {`
	`53`	`+ report(`
	`54`	`+ CodeSmell(`
	`55`	`+ issue,`
	`56`	`+ Entity.from(element),`
	`57`	`+ message = "Use contexts from CoroutineUtils.kt instead of Dispatchers"`
	`58`	`+ )`
	`59`	`+ )`
	`60`	`+ }`
`51`	`61`	`}`
`52`	`62`	`}`
`53`	`63`	`}`