Merge pull request #20 from coder/qodana-and-plugin-verifier-inspections

Address Qodana and plugin verifier inspections

- remove usage of Gateway internal API
- delete unused V1 models
- used proper naming convention in serialized enum values
- remove unused methods
- remove unused property declarations
- remove redundant calls on non-nullable types
- suppress warnings about string capitalization & unstable API usage

Author: fioan89

lib/webrtc-java-0.6.0-windows-x86_64.jar

@@ -1,3 +1,5 @@
+@file:Suppress("DialogTitleCapitalization")
+
 package com.coder.gateway
 
 import com.coder.gateway.models.RecentWorkspaceConnection
@@ -63,7 +65,7 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
                 buildNumber = ideBuildNumber
             )
 
-            clientLifetime.launchUnderBackgroundProgress("Coder Gateway Deploy", true, true, null) {
+            clientLifetime.launchUnderBackgroundProgress("Coder Gateway Deploy", canBeCancelled = true, isIndeterminate = true, project = null) {
                 val context = SshMultistagePanelContext().apply {
                     deploy = true
                     sshConfig = sshConfiguration
@@ -74,6 +76,7 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
                     ide = ideConfig
                 }
                 launch {
+                    @Suppress("UnstableApiUsage")
                     SshDeployFlowUtil.fullDeployCycle(
                         clientLifetime,
                         context,

lib/webrtc-java-0.6.0.jar

@@ -25,15 +25,15 @@ class CoderGatewayMainView : GatewayConnector {
         return CoderGatewayBundle.message("gateway.connector.action.text")
     }
 
-    override fun getDescription(): String? {
+    override fun getDescription(): String {
         return CoderGatewayBundle.message("gateway.connector.description")
     }
 
-    override fun getDocumentationLink(): ActionLink? {
+    override fun getDocumentationLink(): ActionLink {
         return BrowserLink(null, "Learn more about Coder Workspaces", null, "https://coder.com/docs/coder/latest/workspaces")
     }
 
-    override fun getRecentConnections(setContentCallback: (Component) -> Unit): GatewayRecentConnections? {
+    override fun getRecentConnections(setContentCallback: (Component) -> Unit): GatewayRecentConnections {
         return CoderGatewayRecentWorkspaceConnectionsView()
     }
 

src/main/kotlin/com/coder/gateway/CoderGatewayConnectionProvider.kt

@@ -11,7 +11,7 @@ import java.nio.file.StandardCopyOption
 class CoderCLIDownloader(private val buildVersion: String) {
 
     fun downloadCLI(url: URL, outputName: String, ext: String): Path {
-        val filename = if (ext.isNullOrBlank()) "${outputName}-$buildVersion" else "${outputName}-${buildVersion}.${ext}"
+        val filename = if (ext.isBlank()) "${outputName}-$buildVersion" else "${outputName}-${buildVersion}.${ext}"
         val cliPath = Paths.get(System.getProperty("java.io.tmpdir"), filename)
         if (Files.exists(cliPath)) {
             logger.info("${cliPath.toAbsolutePath()} already exists, skipping download")

src/main/kotlin/com/coder/gateway/CoderGatewayMainView.kt

@@ -4,7 +4,7 @@ import com.intellij.openapi.diagnostic.Logger
 import java.net.URL
 import java.nio.file.Path
 
-class CoderCLIManager(private val url: URL, private val buildVersion: String) {
+class CoderCLIManager(private val url: URL, buildVersion: String) {
     private val coderCLIDownloader = CoderCLIDownloader(buildVersion)
 
     fun download(): Path? {
@@ -21,19 +21,19 @@ class CoderCLIManager(private val url: URL, private val buildVersion: String) {
         }
         return when (os) {
             OS.WINDOWS -> when (arch) {
-                Arch.amd64 -> "coder-windows-amd64"
-                Arch.arm64 -> "coder-windows-arm64"
+                Arch.AMD64 -> "coder-windows-amd64"
+                Arch.ARM64 -> "coder-windows-arm64"
                 else -> "coder-windows-amd64"
             }
             OS.LINUX -> when (arch) {
-                Arch.amd64 -> "coder-linux-amd64"
-                Arch.arm64 -> "coder-linux-arm64"
-                Arch.armv7 -> "coder-linux-armv7"
+                Arch.AMD64 -> "coder-linux-amd64"
+                Arch.ARM64 -> "coder-linux-arm64"
+                Arch.ARMV7 -> "coder-linux-armv7"
                 else -> "coder-linux-amd64"
             }
             OS.MAC -> when (arch) {
-                Arch.amd64 -> "coder-darwin-amd64"
-                Arch.arm64 -> "coder-darwin-arm64"
+                Arch.AMD64 -> "coder-darwin-amd64"
+                Arch.ARM64 -> "coder-darwin-arm64"
                 else -> "coder-darwin-amd64"
             }
         }

src/main/kotlin/com/coder/gateway/sdk/CoderCLIDownloader.kt

@@ -3,7 +3,6 @@ package com.coder.gateway.sdk
 import com.coder.gateway.sdk.convertors.InstantConverter
 import com.coder.gateway.sdk.ex.AuthenticationException
 import com.coder.gateway.sdk.v2.CoderV2RestFacade
-import com.coder.gateway.sdk.v2.models.AgentGitSSHKeys
 import com.coder.gateway.sdk.v2.models.BuildInfo
 import com.coder.gateway.sdk.v2.models.User
 import com.coder.gateway.sdk.v2.models.Workspace
@@ -24,16 +23,16 @@ import java.time.Instant
 @Service(Service.Level.APP)
 class CoderRestClientService {
     private lateinit var retroRestClient: CoderV2RestFacade
+    private lateinit var sessionToken: String
     lateinit var coderURL: URL
-    lateinit var sessionToken: String
     lateinit var me: User
     lateinit var buildVersion: String
 
     /**
      * This must be called before anything else. It will authenticate with coder and retrieve a session token
      * @throws [AuthenticationException] if authentication failed
      */
-    fun initClientSession(url: URL, token: String): User? {
+    fun initClientSession(url: URL, token: String): User {
         val cookieUrl = url.toHttpUrlOrNull()!!
         val cookieJar = JavaNetCookieJar(CookieManager()).apply {
             saveFromResponse(
@@ -82,16 +81,7 @@ class CoderRestClientService {
         return workspacesResponse.body()!!
     }
 
-    fun userSSHKeys(): AgentGitSSHKeys {
-        val sshKeysResponse = retroRestClient.sshKeys().execute()
-        if (!sshKeysResponse.isSuccessful) {
-            throw IllegalStateException("Could not retrieve Coder Workspaces:${sshKeysResponse.code()}, reason: ${sshKeysResponse.message()}")
-        }
-
-        return sshKeysResponse.body()!!
-    }
-
-    fun buildInfo(): BuildInfo {
+    private fun buildInfo(): BuildInfo {
         val buildInfoResponse = retroRestClient.buildInfo().execute()
         if (!buildInfoResponse.isSuccessful) {
             throw java.lang.IllegalStateException("Could not retrieve build information for Coder instance $coderURL, reason:${buildInfoResponse.message()}")

src/main/kotlin/com/coder/gateway/sdk/CoderCLIManager.kt

@@ -32,7 +32,7 @@ class InstantConverter : JsonSerializer<Instant?>, JsonDeserializer<Instant?> {
      * @param typeOfSrc the actual type (fully genericized version) of the source object.
      * @return a JsonElement corresponding to the specified object.
      */
-    override fun serialize(src: Instant?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement? {
+    override fun serialize(src: Instant?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
         return JsonPrimitive(FORMATTER.format(src))
     }
 

src/main/kotlin/com/coder/gateway/sdk/CoderRestClientService.kt

@@ -2,4 +2,4 @@ package com.coder.gateway.sdk.ex
 
 import java.io.IOException
 
-class AuthenticationException(val reason: String) : IOException(reason)
+class AuthenticationException(reason: String) : IOException(reason)

src/main/kotlin/com/coder/gateway/sdk/convertors/InstantConverter.kt

@@ -19,9 +19,9 @@ fun getOS(): OS? {
 fun getArch(): Arch? {
     val arch = System.getProperty("os.arch").toLowerCase()
     return when {
-        arch.contains("amd64", true) || arch.contains("x86_64", true) -> Arch.amd64
-        arch.contains("arm64", true) || arch.contains("aarch64", true) -> Arch.arm64
-        arch.contains("armv7", true) -> Arch.armv7
+        arch.contains("amd64", true) || arch.contains("x86_64", true) -> Arch.AMD64
+        arch.contains("arm64", true) || arch.contains("aarch64", true) -> Arch.ARM64
+        arch.contains("armv7", true) -> Arch.ARMV7
         else -> null
     }
 }
@@ -31,5 +31,5 @@ enum class OS {
 }
 
 enum class Arch {
-    amd64, arm64, armv7
+    AMD64, ARM64, ARMV7
 }

src/main/kotlin/com/coder/gateway/sdk/ex/AuthenticationException.kt

@@ -1,24 +1,13 @@
 package com.coder.gateway.sdk.v2
 
-import com.coder.gateway.sdk.v2.models.AgentGitSSHKeys
 import com.coder.gateway.sdk.v2.models.BuildInfo
-import com.coder.gateway.sdk.v2.models.LoginWithPasswordRequest
-import com.coder.gateway.sdk.v2.models.LoginWithPasswordResponse
 import com.coder.gateway.sdk.v2.models.User
 import com.coder.gateway.sdk.v2.models.Workspace
 import retrofit2.Call
-import retrofit2.http.Body
 import retrofit2.http.GET
-import retrofit2.http.POST
 
 interface CoderV2RestFacade {
 
-    /**
-     * Retrieves a session token authenticating with an email and password.
-     */
-    @POST("api/v2/users/login")
-    fun authenticate(@Body loginRequest: LoginWithPasswordRequest): Call<LoginWithPasswordResponse>
-
     /**
      * Retrieves details about the authenticated user.
      */
@@ -31,9 +20,6 @@ interface CoderV2RestFacade {
     @GET("api/v2/workspaces")
     fun workspaces(): Call<List<Workspace>>
 
-    @GET("api/v2/workspaceagents/me/gitsshkey")
-    fun sshKeys(): Call<AgentGitSSHKeys>
-
     @GET("api/v2/buildinfo")
     fun buildInfo(): Call<BuildInfo>
 }

src/main/kotlin/com/coder/gateway/sdk/os.kt

@@ -15,5 +15,21 @@ data class ProvisionerJob(
 )
 
 enum class ProvisionerJobStatus {
-    canceled, canceling, failed, pending, running, succeeded
+    @SerializedName("canceled")
+    CANCELED,
+
+    @SerializedName("canceling")
+    CANCELING,
+
+    @SerializedName("failed")
+    FAILED,
+
+    @SerializedName("pending")
+    PENDING,
+
+    @SerializedName("running")
+    RUNNING,
+
+    @SerializedName("succeeded")
+    SUCCEEDED
 }

src/main/kotlin/com/coder/gateway/sdk/v1/CoderV1RestFacade.kt

@@ -24,5 +24,12 @@ data class WorkspaceBuild(
 )
 
 enum class WorkspaceBuildTransition {
-    start, stop, delete
+    @SerializedName("start")
+    START,
+
+    @SerializedName("stop")
+    STOP,
+
+    @SerializedName("delete")
+    DELETE
 }

src/main/kotlin/com/coder/gateway/sdk/v1/CoderWebSocket.kt

@@ -13,7 +13,7 @@ import com.intellij.openapi.diagnostic.Logger
 @Service(Service.Level.APP)
 @State(name = "CoderRecentWorkspaceConnections", storages = [Storage("coder-recent-workspace-connections.xml", roamingType = RoamingType.DISABLED, exportable = true)])
 class CoderRecentWorkspaceConnectionsService : PersistentStateComponent<RecentWorkspaceConnectionState> {
-    var myState = RecentWorkspaceConnectionState()
+    private var myState = RecentWorkspaceConnectionState()
 
     fun addRecentConnection(connection: RecentWorkspaceConnection) = myState.add(connection)
 

src/main/kotlin/com/coder/gateway/sdk/v1/LoginRequest.kt

@@ -7,7 +7,7 @@ import com.intellij.util.ui.components.BorderLayoutPanel
 import com.jetbrains.rd.util.lifetime.Lifetime
 import com.jetbrains.rd.util.lifetime.onTermination
 
-class CoderGatewayConnectionComponent(val lifetime: Lifetime, val url: String) : BorderLayoutPanel() {
+class CoderGatewayConnectionComponent(lifetime: Lifetime, val url: String) : BorderLayoutPanel() {
     private val disposable = Disposer.newDisposable()
     private val mainPanel = BorderLayoutPanel().apply {
         add(JBLabel(CoderIcons.LOGO_52), "Center")

src/main/kotlin/com/coder/gateway/sdk/v1/LoginResponse.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DialogTitleCapitalization")
+
 package com.coder.gateway.views
 
 import com.coder.gateway.CoderGatewayBundle
@@ -92,7 +94,7 @@ class CoderGatewayRecentWorkspaceConnectionsView : GatewayRecentConnections {
                         }.horizontalAlign(HorizontalAlign.LEFT).gap(RightGap.SMALL)
                         actionButton(object : DumbAwareAction(CoderGatewayBundle.message("gateway.connector.recentconnections.terminal.button.tooltip"), "", CoderIcons.OPEN_TERMINAL) {
                             override fun actionPerformed(e: AnActionEvent) {
-                                BrowserUtil.browse(recentConnections[0]?.webTerminalLink ?: "")
+                                BrowserUtil.browse(recentConnections[0].webTerminalLink ?: "")
                             }
                         })
                     }
@@ -109,7 +111,7 @@ class CoderGatewayRecentWorkspaceConnectionsView : GatewayRecentConnections {
                                         "type" to "coder",
                                         "coder_workspace_hostname" to "${connectionDetails.coderWorkspaceHostname}",
                                         "project_path" to connectionDetails.projectPath!!,
-                                        "ide_product_code" to "${product.productCode}",
+                                        "ide_product_code" to product.productCode,
                                         "ide_build_number" to "${connectionDetails.ideBuildNumber}",
                                         "ide_download_link" to "${connectionDetails.downloadSource}"
                                     )

src/main/kotlin/com/coder/gateway/sdk/v1/RebuildMessage.kt

@@ -3,14 +3,19 @@ package com.coder.gateway.views
 import com.intellij.icons.AllIcons
 import com.intellij.ide.BrowserUtil
 import com.intellij.ide.IdeBundle
+import com.intellij.openapi.actionSystem.ActionManager
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.DefaultActionGroup
 import com.intellij.openapi.actionSystem.ex.ActionManagerEx
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.application.ModalityState
 import com.intellij.openapi.ide.CopyPasteManager
 import com.intellij.openapi.project.DumbAwareAction
 import com.intellij.ui.components.ActionLink
 import org.jetbrains.annotations.Nls
 import java.awt.datatransfer.StringSelection
+import java.util.concurrent.ForkJoinPool
+import java.util.function.Consumer
 import javax.swing.Icon
 
 class LazyBrowserLink(icon: Icon, @Nls text: String) : ActionLink() {
@@ -24,12 +29,25 @@ class LazyBrowserLink(icon: Icon, @Nls text: String) : ActionLink() {
             field = value
             if (value != null) {
                 addActionListener { BrowserUtil.browse(value) }
-                ActionManagerEx.doWithLazyActionManager { instance ->
+
+                doWithLazyActionManager { instance ->
                     val group = DefaultActionGroup(OpenLinkInBrowser(value), CopyLinkAction(value))
                     componentPopupMenu = instance.createActionPopupMenu("popup@browser.link.context.menu", group).component
                 }
             }
         }
+
+    private fun doWithLazyActionManager(whatToDo: Consumer<in ActionManager>) {
+        val created = ApplicationManager.getApplication().getServiceIfCreated(ActionManager::class.java)
+        if (created == null) {
+            ForkJoinPool.commonPool().execute {
+                val actionManager: ActionManager = ActionManagerEx.getInstanceEx()
+                ApplicationManager.getApplication().invokeLater({ whatToDo.accept(actionManager) }, ModalityState.any())
+            }
+        } else {
+            whatToDo.accept(created)
+        }
+    }
 }
 
 private class CopyLinkAction(val url: String) : DumbAwareAction(IdeBundle.messagePointer("action.text.copy.link.address"), AllIcons.Actions.Copy) {

src/main/kotlin/com/coder/gateway/sdk/v1/SSHKeys.kt

@@ -1,9 +1,16 @@
+@file:Suppress("DialogTitleCapitalization")
+
 package com.coder.gateway.views.steps
 
 import com.coder.gateway.CoderGatewayBundle
 import com.coder.gateway.icons.CoderIcons
 import com.coder.gateway.models.CoderWorkspacesWizardModel
-import com.coder.gateway.sdk.*
+import com.coder.gateway.sdk.CoderCLIManager
+import com.coder.gateway.sdk.CoderRestClientService
+import com.coder.gateway.sdk.OS
+import com.coder.gateway.sdk.getOS
+import com.coder.gateway.sdk.toURL
+import com.coder.gateway.sdk.withPath
 import com.intellij.ide.BrowserUtil
 import com.intellij.ide.IdeBundle
 import com.intellij.openapi.Disposable
@@ -19,7 +26,11 @@ import com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager
 import com.intellij.ui.AppIcon
 import com.intellij.ui.components.JBTextField
 import com.intellij.ui.components.dialog
-import com.intellij.ui.dsl.builder.*
+import com.intellij.ui.dsl.builder.BottomGap
+import com.intellij.ui.dsl.builder.RightGap
+import com.intellij.ui.dsl.builder.TopGap
+import com.intellij.ui.dsl.builder.bindText
+import com.intellij.ui.dsl.builder.panel
 import com.intellij.ui.dsl.gridLayout.HorizontalAlign
 import com.intellij.util.ui.JBFont
 import kotlinx.coroutines.CoroutineScope
@@ -71,9 +82,10 @@ class CoderAuthStepView : CoderWorkspacesWizardStep, Disposable {
         BrowserUtil.browse(model.coderURL.toURL().withPath("/login?redirect=%2Fcli-auth"))
         val pastedToken = askToken()
 
-        if (pastedToken?.isNullOrBlank() == true || coderClient.initClientSession(model.coderURL.toURL(), pastedToken) == null) {
+        if (pastedToken.isNullOrBlank()) {
             return false
         }
+        coderClient.initClientSession(model.coderURL.toURL(), pastedToken)
         model.token = pastedToken
         model.buildVersion = coderClient.buildVersion
 

src/main/kotlin/com/coder/gateway/sdk/v1/User.kt

@@ -124,7 +124,7 @@ class CoderLocateRemoteProjectStepView : CoderWorkspacesWizardStep, Disposable {
                 .flatMap { CachingProductsJsonWrapper.getAvailableIdes(it, workspaceOS) }
                 .map { ide -> IdeWithStatus(ide.product, ide.buildNumber, IdeStatus.DOWNLOAD, ide.downloadLink, ide.presentableVersion) }
 
-            if (idesWithStatus.isNullOrEmpty()) {
+            if (idesWithStatus.isEmpty()) {
                 logger.warn("Could not resolve any IDE for workspace ${selectedWorkspace.name}, probably $workspaceOS is not supported by Gateway")
             } else {
                 cbIDE.remove(spinner)
@@ -144,9 +144,9 @@ class CoderLocateRemoteProjectStepView : CoderWorkspacesWizardStep, Disposable {
                     "type" to "coder",
                     "coder_workspace_hostname" to "coder.${wizardModel.selectedWorkspace?.name}",
                     "project_path" to tfProject.text,
-                    "ide_product_code" to "${selectedIDE.product.productCode}",
-                    "ide_build_number" to "${selectedIDE.buildNumber}",
-                    "ide_download_link" to "${selectedIDE.source}",
+                    "ide_product_code" to selectedIDE.product.productCode,
+                    "ide_build_number" to selectedIDE.buildNumber,
+                    "ide_download_link" to selectedIDE.source,
                     "web_terminal_link" to "${terminalLink.url}"
                 )
             )

src/main/kotlin/com/coder/gateway/sdk/v1/Workspace.kt

@@ -51,27 +51,27 @@ class WorkspaceCellRenderer : ListCellRenderer<Workspace> {
     }
 
     private fun iconForStatus(workspace: Workspace) = when (workspace.latestBuild.job.status) {
-        ProvisionerJobStatus.succeeded -> if (workspace.latestBuild.workspaceTransition == WorkspaceBuildTransition.start) GREEN_CIRCLE else RED_CIRCLE
-        ProvisionerJobStatus.running -> when (workspace.latestBuild.workspaceTransition) {
-            WorkspaceBuildTransition.start, WorkspaceBuildTransition.stop, WorkspaceBuildTransition.delete -> GRAY_CIRCLE
+        ProvisionerJobStatus.SUCCEEDED -> if (workspace.latestBuild.workspaceTransition == WorkspaceBuildTransition.START) GREEN_CIRCLE else RED_CIRCLE
+        ProvisionerJobStatus.RUNNING -> when (workspace.latestBuild.workspaceTransition) {
+            WorkspaceBuildTransition.START, WorkspaceBuildTransition.STOP, WorkspaceBuildTransition.DELETE -> GRAY_CIRCLE
         }
         else -> RED_CIRCLE
     }
 
     private fun labelForStatus(workspace: Workspace) = when (workspace.latestBuild.job.status) {
-        ProvisionerJobStatus.pending -> "◍ Queued"
-        ProvisionerJobStatus.running -> when (workspace.latestBuild.workspaceTransition) {
-            WorkspaceBuildTransition.start -> "⦿ Starting"
-            WorkspaceBuildTransition.stop -> "◍ Stopping"
-            WorkspaceBuildTransition.delete -> "⦸ Deleting"
+        ProvisionerJobStatus.PENDING -> "◍ Queued"
+        ProvisionerJobStatus.RUNNING -> when (workspace.latestBuild.workspaceTransition) {
+            WorkspaceBuildTransition.START -> "⦿ Starting"
+            WorkspaceBuildTransition.STOP -> "◍ Stopping"
+            WorkspaceBuildTransition.DELETE -> "⦸ Deleting"
         }
-        ProvisionerJobStatus.succeeded -> when (workspace.latestBuild.workspaceTransition) {
-            WorkspaceBuildTransition.start -> "⦿ Running"
-            WorkspaceBuildTransition.stop -> "◍ Stopped"
-            WorkspaceBuildTransition.delete -> "⦸ Deleted"
+        ProvisionerJobStatus.SUCCEEDED -> when (workspace.latestBuild.workspaceTransition) {
+            WorkspaceBuildTransition.START -> "⦿ Running"
+            WorkspaceBuildTransition.STOP -> "◍ Stopped"
+            WorkspaceBuildTransition.DELETE -> "⦸ Deleted"
         }
-        ProvisionerJobStatus.canceling -> "◍ Canceling action"
-        ProvisionerJobStatus.canceled -> "◍ Canceled action"
-        ProvisionerJobStatus.failed -> "ⓧ Failed"
+        ProvisionerJobStatus.CANCELING -> "◍ Canceling action"
+        ProvisionerJobStatus.CANCELED -> "◍ Canceled action"
+        ProvisionerJobStatus.FAILED -> "ⓧ Failed"
     }
 }