Skip to content

add popup diaglog for missing IDE data on url handler #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2024
Merged

add popup diaglog for missing IDE data on url handler #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pluginUntilBuild=241.*
# verifier should be used after bumping versions to ensure compatibility in the
# range.
platformType=GW
platformVersion=233.6745-EAP-CANDIDATE-SNAPSHOT
platformVersion=233.14808-EAP-CANDIDATE-SNAPSHOT
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous version was expired, so could not run it locally.

instrumentationCompiler=241.10840-EAP-CANDIDATE-SNAPSHOT
platformDownloadSources=true
verifyVersions=2023.3,2024.1
Expand Down
65 changes: 44 additions & 21 deletions src/main/kotlin/com/coder/gateway/CoderGatewayConnectionProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import com.coder.gateway.cli.CoderCLIManager
import com.coder.gateway.cli.ensureCLI
import com.coder.gateway.models.TokenSource
import com.coder.gateway.models.WorkspaceAndAgentStatus
import com.coder.gateway.sdk.BaseCoderRestClient
import com.coder.gateway.sdk.CoderRestClient
import com.coder.gateway.sdk.ex.AuthenticationResponseException
import com.coder.gateway.sdk.v2.models.Workspace
Expand All @@ -15,12 +14,17 @@ import com.coder.gateway.sdk.v2.models.WorkspaceStatus
import com.coder.gateway.services.CoderSettingsService
import com.coder.gateway.util.toURL
import com.coder.gateway.util.withPath
import com.coder.gateway.views.steps.CoderWorkspaceStepView
import com.coder.gateway.views.steps.CoderWorkspacesStepSelection
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.components.service
import com.intellij.openapi.diagnostic.Logger
import com.intellij.openapi.ui.DialogWrapper
import com.jetbrains.gateway.api.ConnectionRequestor
import com.jetbrains.gateway.api.GatewayConnectionHandle
import com.jetbrains.gateway.api.GatewayConnectionProvider
import java.net.URL
import javax.swing.JComponent

// In addition to `type`, these are the keys that we support in our Gateway
// links.
Expand All @@ -34,6 +38,18 @@ private const val IDE_DOWNLOAD_LINK = "ide_download_link"
private const val IDE_PRODUCT_CODE = "ide_product_code"
private const val IDE_BUILD_NUMBER = "ide_build_number"
private const val IDE_PATH_ON_HOST = "ide_path_on_host"
private const val PROJECT_PATH = "project_path"

class SelectWorkspaceIDEDialog(private val comp: JComponent) : DialogWrapper(true) {
init {
init()
title = "Select workspace IDE"
}

override fun createCenterPanel(): JComponent? {
return comp
}
}

// CoderGatewayConnectionProvider handles connecting via a Gateway link such as
// jetbrains-gateway://connect#type=coder.
Expand Down Expand Up @@ -93,31 +109,38 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
cli.login(client.token)

indicator.text = "Configuring Coder CLI..."
cli.configSsh(client.agentNames(workspaces))
cli.configSsh(client.agentNames(workspaces).toSet())

// TODO: Ask for these if missing. Maybe we can reuse the second
// step of the wizard? Could also be nice if we automatically used
// the last IDE.
if (parameters[IDE_PRODUCT_CODE].isNullOrBlank()) {
throw IllegalArgumentException("Query parameter \"$IDE_PRODUCT_CODE\" is missing")
}
if (parameters[IDE_BUILD_NUMBER].isNullOrBlank()) {
throw IllegalArgumentException("Query parameter \"$IDE_BUILD_NUMBER\" is missing")
}
if (parameters[IDE_PATH_ON_HOST].isNullOrBlank() && parameters[IDE_DOWNLOAD_LINK].isNullOrBlank()) {
throw IllegalArgumentException("One of \"$IDE_PATH_ON_HOST\" or \"$IDE_DOWNLOAD_LINK\" is required")
}

val openDialog = parameters[IDE_PRODUCT_CODE].isNullOrBlank() ||
parameters[IDE_BUILD_NUMBER].isNullOrBlank() ||
(parameters[IDE_PATH_ON_HOST].isNullOrBlank() && parameters[IDE_DOWNLOAD_LINK].isNullOrBlank()) ||
parameters[FOLDER].isNullOrBlank()

val params = if (openDialog) {
val view = CoderWorkspaceStepView{}
ApplicationManager.getApplication().invokeAndWait {
view.init(
CoderWorkspacesStepSelection(agent, workspace, cli, client, workspaces)
)
val dialog = SelectWorkspaceIDEDialog(view.component)
dialog.show()
}
val p = parameters.toMutableMap()


listOf(IDE_PRODUCT_CODE, IDE_BUILD_NUMBER, PROJECT_PATH, IDE_PATH_ON_HOST, IDE_DOWNLOAD_LINK).forEach { prop ->
view.data()[prop]?.let { value -> p[prop] = value }
}
p
} else
parameters.withProjectPath(parameters[FOLDER]!!)

// Check that both the domain and the redirected domain are
// allowlisted. If not, check with the user whether to proceed.
verifyDownloadLink(parameters)

// TODO: Ask for the project path if missing and validate the path.
val folder = parameters[FOLDER] ?: throw IllegalArgumentException("Query parameter \"$FOLDER\" is missing")

parameters
.withWorkspaceHostname(CoderCLIManager.getHostName(deploymentURL.toURL(), agent.name))
.withProjectPath(folder)
params.withWorkspaceHostname(CoderCLIManager.getHostName(deploymentURL.toURL(), "${workspace.name}.${agent.name}"))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure how this ever worked ... this was just using the agent.name instead of ${workspace.name}.${agent.name} so it never matched any ssh config rules.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I think I recently broke this because agent here used to be a WorkspaceAgentListModel and I have been refactoring to pass a regular WorkspaceAgent around, but I missed this name.

.withWebTerminalLink(client.url.withPath("/@$username/$workspace.name/terminal").toString())
.withConfigDirectory(cli.coderConfigPath.toString())
.withName(workspaceName)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: I think this is also meant to be in the workspace.agent format.

Expand All @@ -129,7 +152,7 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
* Return an authenticated Coder CLI and the user's name, asking for the
* token as long as it continues to result in an authentication failure.
*/
private fun authenticate(deploymentURL: URL, queryToken: String?, lastToken: Pair<String, TokenSource>? = null): Pair<BaseCoderRestClient, String> {
private fun authenticate(deploymentURL: URL, queryToken: String?, lastToken: Pair<String, TokenSource>? = null): Pair<CoderRestClient, String> {
// Use the token from the query, unless we already tried that.
val isRetry = lastToken != null
val token = if (!queryToken.isNullOrBlank() && !isRetry)
Expand Down
4 changes: 2 additions & 2 deletions src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ class CoderCLIManager(
*
* This can take supported features for testing purposes only.
*/
fun configSsh(workspaceNames: List<String>, feats: Features = features) {
fun configSsh(workspaceNames: Set<String>, feats: Features = features) {
writeSSHConfig(modifySSHConfig(readSSHConfig(), workspaceNames, feats))
}

Expand All @@ -232,7 +232,7 @@ class CoderCLIManager(
* If features are not provided, calculate them based on the binary
* version.
*/
private fun modifySSHConfig(contents: String?, workspaceNames: List<String>, feats: Features): String? {
private fun modifySSHConfig(contents: String?, workspaceNames: Set<String>, feats: Features): String? {
val host = deploymentURL.safeHost()
val startBlock = "# --- START CODER JETBRAINS $host"
val endBlock = "# --- END CODER JETBRAINS $host"
Expand Down
6 changes: 3 additions & 3 deletions src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspaceStepView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class CoderWorkspaceStepView(
// Called with a boolean indicating whether IDE selection is complete.
private val nextButtonEnabled: (Boolean) -> Unit,
) : CoderWizardStep {
private val cs = CoroutineScope(Dispatchers.Main)
private val cs = CoroutineScope(Dispatchers.IO)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved it to IO instead of Main because the app window seemed to be using Main so the IDE lazy-loaded selections were never running//loading. So I have no idea if this is correct or not...

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coryb is this code performing an I/O heavy operation, like waiting on network calls or disk read / writes? If not, Dispatchers.Unconfined might be okay. More info here: https://kotlinlang.org/docs/coroutine-context-and-dispatchers.html#dispatchers-and-threads

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The operation I think uses ssh to connect to the workspace to look for installed ides, so it is certainly using network I/O, but probably does not qualify as "I/O heavy"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that’s the case, the IO Dispatcher is likely safe to keep as-is 👍🏼

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There probably is some magic to get Main working (for example we had a similar issue when launching from File > Remote Development and the fix was to add the modality state to launch), but this seems good to me! I had the general impression that updating UI from IO was a no-go (and here we update foreground colors, text, etc) but it seems to work fine as far as I can tell. 🤷

private var ideComboBoxModel = DefaultComboBoxModel<IdeWithStatus>()
private var state: CoderWorkspacesStepSelection? = null

Expand Down Expand Up @@ -189,7 +189,7 @@ class CoderWorkspaceStepView(
logger.info("Configuring Coder CLI...")
cbIDE.renderer = IDECellRenderer("Configuring Coder CLI...")
withContext(Dispatchers.IO) {
data.cliManager.configSsh(data.client.agentNames(data.workspaces))
data.cliManager.configSsh(data.client.agentNames(data.workspaces).toSet())
}

val ides = suspendingRetryWithExponentialBackOff(
Expand Down Expand Up @@ -228,7 +228,7 @@ class CoderWorkspaceStepView(
cbIDE.renderer = IDECellRenderer(CoderGatewayBundle.message("gateway.connector.view.coder.retrieve-ides.failed.retry", humanizeDuration(remainingMs)))
},
)
withContext(Dispatchers.Main) {
withContext(Dispatchers.IO) {
ideComboBoxModel.addAll(ides)
cbIDE.selectedIndex = 0
}
Expand Down
8 changes: 4 additions & 4 deletions src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,12 +295,12 @@ internal class CoderCLIManagerTest {
.replace("/tmp/coder-gateway/test.coder.invalid/coder-linux-amd64", escape(ccm.localBinaryPath.toString()))

// Add workspaces.
ccm.configSsh(it.workspaces, it.features ?: Features())
ccm.configSsh(it.workspaces.toSet(), it.features ?: Features())

assertEquals(expectedConf, settings.sshConfigPath.toFile().readText())

// Remove configuration.
ccm.configSsh(emptyList(), it.features ?: Features())
ccm.configSsh(emptySet(), it.features ?: Features())

// Remove is the configuration we expect after removing.
assertEquals(
Expand Down Expand Up @@ -330,7 +330,7 @@ internal class CoderCLIManagerTest {

assertFailsWith(
exceptionClass = SSHConfigFormatException::class,
block = { ccm.configSsh(emptyList()) })
block = { ccm.configSsh(emptySet()) })
}
}

Expand All @@ -346,7 +346,7 @@ internal class CoderCLIManagerTest {

assertFailsWith(
exceptionClass = Exception::class,
block = { ccm.configSsh(listOf("foo", "bar")) })
block = { ccm.configSsh(setOf("foo", "bar")) })
}
}

Expand Down