Skip to content

Handle Gateway links #289

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 14 commits into from
Aug 18, 2023
Merged

Handle Gateway links #289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
bc0ce3f
Break connection code out into separate class
code-asher Aug 3, 2023
8d60046
Break out askToken dialog
code-asher Aug 3, 2023
77787a8
Add generic function to ask for input
code-asher Aug 7, 2023
e20d503
Add QUERY token source and show deployment host
code-asher Aug 7, 2023
78a8df4
Tweak client error responses
code-asher Aug 7, 2023
5569d46
Use exception class name when there is no message
code-asher Aug 7, 2023
809f5b2
Handle Gateway links
code-asher Aug 3, 2023
153a48e
Fix If-None-Match header name
code-asher Aug 16, 2023
b654ace
Use active voice
code-asher Aug 16, 2023
aa453f4
Automatically use token on disk if there is one
code-asher Aug 16, 2023
2d27c46
Use only agent if none provided
code-asher Aug 16, 2023
64fe78f
Confirm download link if not whitelisted
code-asher Aug 17, 2023
64cf76d
s/whitelist/allowlist
code-asher Aug 18, 2023
e0b8293
Remove deployment host
code-asher Aug 18, 2023
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
Prev Previous commit
Next Next commit
Break out askToken dialog 
So it can be reused in the link flow.
  • Loading branch information
@code-asher
code-asher committed Aug 3, 2023
commit 8d60046194bd46237f897ad6fa3aaac872f3fa27
102 changes: 100 additions & 2 deletions src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,39 @@

package com.coder.gateway

import com.coder.gateway.models.TokenSource
import com.coder.gateway.sdk.CoderCLIManager
import com.coder.gateway.sdk.humanizeDuration
import com.coder.gateway.sdk.isCancellation
import com.coder.gateway.sdk.isWorkerTimeout
import com.coder.gateway.sdk.suspendingRetryWithExponentialBackOff
import com.coder.gateway.sdk.toURL
import com.coder.gateway.sdk.withPath
import com.coder.gateway.services.CoderRecentWorkspaceConnectionsService
import com.intellij.ide.BrowserUtil
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.application.ModalityState
import com.intellij.openapi.components.service
import com.intellij.openapi.diagnostic.Logger
import com.intellij.openapi.rd.util.launchUnderBackgroundProgress
import com.intellij.openapi.ui.Messages
import com.intellij.openapi.ui.panel.ComponentPanelBuilder
import com.intellij.ui.AppIcon
import com.intellij.ui.components.JBTextField
import com.intellij.ui.components.dialog
import com.intellij.ui.dsl.builder.RowLayout
import com.intellij.ui.dsl.builder.panel
import com.intellij.util.applyIf
import com.intellij.util.ui.UIUtil
import com.jetbrains.gateway.ssh.SshDeployFlowUtil
import com.jetbrains.gateway.ssh.SshMultistagePanelContext
import com.jetbrains.gateway.ssh.deploy.DeployException
import com.jetbrains.rd.util.lifetime.LifetimeDefinition
import kotlinx.coroutines.launch
import net.schmizz.sshj.common.SSHException
import net.schmizz.sshj.connection.ConnectionException
import java.awt.Dimension
import java.net.URL
import java.time.Duration
import java.util.concurrent.TimeoutException

Expand All @@ -31,8 +47,6 @@ class CoderRemoteConnectionHandle {
suspend fun connect(parameters: Map<String, String>) {
logger.debug("Creating connection handle", parameters)
val clientLifetime = LifetimeDefinition()
// TODO: If this fails determine if it is an auth error and if so prompt
// for a new token, configure the CLI, then try again.
clientLifetime.launchUnderBackgroundProgress(CoderGatewayBundle.message("gateway.connector.coder.connection.provider.title"), canBeCancelled = true, isIndeterminate = true, project = null) {
try {
indicator.text = CoderGatewayBundle.message("gateway.connector.coder.connecting")
Expand Down Expand Up @@ -88,5 +102,89 @@ class CoderRemoteConnectionHandle {

companion object {
val logger = Logger.getInstance(CoderRemoteConnectionHandle::class.java.simpleName)

/**
* Open a dialog for providing the token. Show any existing token so the
* user can validate it if a previous connection failed. If we are not
* retrying and the user has not checked the existing token box then open a
* browser to the auth page. If the user has checked the existing token box
* then populate the dialog with the token on disk (this will overwrite any
* other existing token) unless this is a retry to avoid clobbering the
* token that just failed. Return the token submitted by the user.
*/
@JvmStatic
fun askToken(
url: URL,
token: Pair<String, TokenSource>?,
isRetry: Boolean,
useExisting: Boolean,
): Pair<String, TokenSource>? {
var (existingToken, tokenSource) = token ?: Pair("", TokenSource.USER)
val getTokenUrl = url.withPath("/login?redirect=%2Fcli-auth")
if (!isRetry && !useExisting) {
BrowserUtil.browse(getTokenUrl)
} else if (!isRetry && useExisting) {
val (u, t) = CoderCLIManager.readConfig()
if (url == u?.toURL() && !t.isNullOrBlank() && t != existingToken) {
logger.info("Injecting token from CLI config")
tokenSource = TokenSource.CONFIG
existingToken = t
}
}
var tokenFromUser: String? = null
ApplicationManager.getApplication().invokeAndWait({
lateinit var sessionTokenTextField: JBTextField
val panel = panel {
row {
browserLink(
CoderGatewayBundle.message("gateway.connector.view.login.token.label"),
getTokenUrl.toString()
)
sessionTokenTextField = textField()
.applyToComponent {
text = existingToken
minimumSize = Dimension(520, -1)
}.component
}.layout(RowLayout.PARENT_GRID)
row {
cell() // To align with the text box.
cell(
ComponentPanelBuilder.createCommentComponent(
CoderGatewayBundle.message(
if (isRetry) "gateway.connector.view.workspaces.token.rejected"
else if (tokenSource == TokenSource.CONFIG) "gateway.connector.view.workspaces.token.injected"
else if (existingToken.isNotBlank()) "gateway.connector.view.workspaces.token.comment"
else "gateway.connector.view.workspaces.token.none"
),
false,
-1,
true
).applyIf(isRetry) {
apply {
foreground = UIUtil.getErrorForeground()
}
}
)
}.layout(RowLayout.PARENT_GRID)
}
AppIcon.getInstance().requestAttention(null, true)
if (!dialog(
CoderGatewayBundle.message("gateway.connector.view.login.token.dialog"),
panel = panel,
focusedComponent = sessionTokenTextField
).showAndGet()
) {
return@invokeAndWait
}
tokenFromUser = sessionTokenTextField.text
}, ModalityState.any())
if (tokenFromUser.isNullOrBlank()) {
return null
}
if (tokenFromUser != existingToken) {
tokenSource = TokenSource.USER
}
return Pair(tokenFromUser!!, tokenSource)
}
}
}
93 changes: 2 additions & 91 deletions src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.coder.gateway.views.steps

import com.coder.gateway.CoderGatewayBundle
import com.coder.gateway.CoderRemoteConnectionHandle
import com.coder.gateway.icons.CoderIcons
import com.coder.gateway.models.CoderWorkspacesWizardModel
import com.coder.gateway.models.TokenSource
Expand All @@ -20,7 +21,6 @@ import com.coder.gateway.sdk.ex.WorkspaceResponseException
import com.coder.gateway.sdk.toURL
import com.coder.gateway.sdk.v2.models.WorkspaceStatus
import com.coder.gateway.sdk.v2.models.toAgentModels
import com.coder.gateway.sdk.withPath
import com.coder.gateway.services.CoderSettingsState
import com.intellij.icons.AllIcons
import com.intellij.ide.ActivityTracker
Expand All @@ -30,20 +30,15 @@ import com.intellij.ide.util.PropertiesComponent
import com.intellij.openapi.Disposable
import com.intellij.openapi.actionSystem.AnAction
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.application.ModalityState
import com.intellij.openapi.components.service
import com.intellij.openapi.diagnostic.Logger
import com.intellij.openapi.rd.util.launchUnderBackgroundProgress
import com.intellij.openapi.ui.panel.ComponentPanelBuilder
import com.intellij.openapi.ui.setEmptyState
import com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager
import com.intellij.ui.AnActionButton
import com.intellij.ui.AppIcon
import com.intellij.ui.RelativeFont
import com.intellij.ui.ToolbarDecorator
import com.intellij.ui.components.JBTextField
import com.intellij.ui.components.dialog
import com.intellij.ui.dsl.builder.AlignX
import com.intellij.ui.dsl.builder.AlignY
import com.intellij.ui.dsl.builder.BottomGap
Expand All @@ -54,7 +49,6 @@ import com.intellij.ui.dsl.builder.bindSelected
import com.intellij.ui.dsl.builder.bindText
import com.intellij.ui.dsl.builder.panel
import com.intellij.ui.table.TableView
import com.intellij.util.applyIf
import com.intellij.util.ui.ColumnInfo
import com.intellij.util.ui.JBFont
import com.intellij.util.ui.JBUI
Expand Down Expand Up @@ -391,7 +385,7 @@ class CoderWorkspacesStepView(val setNextButtonEnabled: (Boolean) -> Unit) : Cod
val oldURL = localWizardModel.coderURL.toURL()
component.apply() // Force bindings to be filled.
val newURL = localWizardModel.coderURL.toURL()
val pastedToken = askToken(
val pastedToken = CoderRemoteConnectionHandle.askToken(
newURL,
// If this is a new URL there is no point in trying to use the same
// token.
Expand Down Expand Up @@ -512,89 +506,6 @@ class CoderWorkspacesStepView(val setNextButtonEnabled: (Boolean) -> Unit) : Cod
}
}

/**
* Open a dialog for providing the token. Show any existing token so the
* user can validate it if a previous connection failed. If we are not
* retrying and the user has not checked the existing token box then open a
* browser to the auth page. If the user has checked the existing token box
* then populate the dialog with the token on disk (this will overwrite any
* other existing token) unless this is a retry to avoid clobbering the
* token that just failed. Return the token submitted by the user.
*/
private fun askToken(
url: URL,
token: Pair<String, TokenSource>?,
isRetry: Boolean,
useExisting: Boolean,
): Pair<String, TokenSource>? {
var (existingToken, tokenSource) = token ?: Pair("", TokenSource.USER)
val getTokenUrl = url.withPath("/login?redirect=%2Fcli-auth")
if (!isRetry && !useExisting) {
BrowserUtil.browse(getTokenUrl)
} else if (!isRetry && useExisting) {
val (u, t) = CoderCLIManager.readConfig()
if (url == u?.toURL() && !t.isNullOrBlank() && t != existingToken) {
logger.info("Injecting token from CLI config")
tokenSource = TokenSource.CONFIG
existingToken = t
}
}
var tokenFromUser: String? = null
ApplicationManager.getApplication().invokeAndWait({
lateinit var sessionTokenTextField: JBTextField
val panel = panel {
row {
browserLink(
CoderGatewayBundle.message("gateway.connector.view.login.token.label"),
getTokenUrl.toString()
)
sessionTokenTextField = textField()
.applyToComponent {
text = existingToken
minimumSize = Dimension(520, -1)
}.component
}.layout(RowLayout.PARENT_GRID)
row {
cell() // To align with the text box.
cell(
ComponentPanelBuilder.createCommentComponent(
CoderGatewayBundle.message(
if (isRetry) "gateway.connector.view.workspaces.token.rejected"
else if (tokenSource == TokenSource.CONFIG) "gateway.connector.view.workspaces.token.injected"
else if (existingToken.isNotBlank()) "gateway.connector.view.workspaces.token.comment"
else "gateway.connector.view.workspaces.token.none"
),
false,
-1,
true
).applyIf(isRetry) {
apply {
foreground = UIUtil.getErrorForeground()
}
}
)
}.layout(RowLayout.PARENT_GRID)
}
AppIcon.getInstance().requestAttention(null, true)
if (!dialog(
CoderGatewayBundle.message("gateway.connector.view.login.token.dialog"),
panel = panel,
focusedComponent = sessionTokenTextField
).showAndGet()
) {
return@invokeAndWait
}
tokenFromUser = sessionTokenTextField.text
}, ModalityState.any())
if (tokenFromUser.isNullOrBlank()) {
return null
}
if (tokenFromUser != existingToken) {
tokenSource = TokenSource.USER
}
return Pair(tokenFromUser!!, tokenSource)
}

private fun triggerWorkspacePolling(fetchNow: Boolean) {
poller?.cancel()

Expand Down