Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

impl: enhanced workflow for network disruptions#162

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.

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

Already on GitHub?Sign in to your account

Merged
fioan89 merged 5 commits intomainfromimpl-improved-workflow-after-network-goes-down
Jul 25, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
4 changes: 4 additions & 0 deletionsCHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@

## Unreleased

### Changed

- improved workflow when network connection is flaky

## 0.5.2 - 2025-07-22

### Fixed
Expand Down
4 changes: 2 additions & 2 deletionsgradle.properties
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
version=0.5.2
version=0.6.0
group=com.coder.toolbox
name=coder-toolbox
name=coder-toolbox
19 changes: 14 additions & 5 deletionssrc/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,13 @@ class CoderRemoteEnvironment(
private val proxyCommandHandle = SshCommandProcessHandle(context)
private var pollJob: Job? = null

init {
if (context.settingsStore.shouldAutoConnect(id)) {
context.logger.info("resuming SSH connection to $id — last session was still active.")
startSshConnection()
}
}

fun asPairOfWorkspaceAndAgent(): Pair<Workspace, WorkspaceAgent> = Pair(workspace, agent)

private fun getAvailableActions(): List<ActionDescription> {
Expand DownExpand Up@@ -158,6 +165,7 @@ class CoderRemoteEnvironment(
override fun beforeConnection() {
context.logger.info("Connecting to $id...")
isConnected.update { true }
context.settingsStore.updateAutoConnect(this.id, true)
pollJob = pollNetworkMetrics()
}

Expand All@@ -180,12 +188,9 @@ class CoderRemoteEnvironment(
}
context.logger.debug("Loading metrics from ${metricsFile.absolutePath} for $id")
try {
val metrics = networkMetricsMarshaller.fromJson(metricsFile.readText())
if (metrics == null) {
return@launch
}
val metrics = networkMetricsMarshaller.fromJson(metricsFile.readText()) ?: return@launch
context.logger.debug("$id metrics: $metrics")
additionalEnvironmentInformation.put(context.i18n.ptrl("Network Status"),metrics.toPretty())
additionalEnvironmentInformation[context.i18n.ptrl("Network Status")] =metrics.toPretty()
} catch (e: Exception) {
context.logger.error(
e,
Expand All@@ -203,6 +208,10 @@ class CoderRemoteEnvironment(
pollJob?.cancel()
this.connectionRequest.update { false }
isConnected.update { false }
if (isManual) {
// if the user manually disconnects the ssh connection we should not connect automatically
context.settingsStore.updateAutoConnect(this.id, false)
}
Comment on lines +211 to +214
Copy link
Member

Choose a reason for hiding this comment

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

Why this choice? If the user manually disconnects and then connects again, we should still try to resume the last active connection if possible.

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

If you take a look atbeforeConnection we set auto-connect to true. In other words:

  • user connects the ssh, and then TBX is closed -> at the next restart we automatically reconnect.
  • user connects to the ssh, manually disconnects and then TBX is closed -> at the next restart we no longer reconnect automatically because the user made a conscious choice to disconnect.
  • user connects to the ssh, manually disconnects, then reconnects again the ssh session, and then TBX is closed -> at the next restart we automatically reconnect.

context.logger.info("Disconnected from $id")
}

Expand Down
52 changes: 23 additions & 29 deletionssrc/main/kotlin/com/coder/toolbox/CoderRemoteProvider.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,8 @@ class CoderRemoteProvider(
)
)

private val errorBuffer = mutableListOf<Throwable>()

/**
* With the provided client, start polling for workspaces. Every time a new
* workspace is added, reconfigure SSH using the provided cli (including the
Expand DownExpand Up@@ -160,23 +162,20 @@ class CoderRemoteProvider(
} catch (ex: Exception) {
val elapsed = lastPollTime.elapsedNow()
if (elapsed > POLL_INTERVAL * 2) {
context.logger.info("wake-up from an OS sleep was detected, going to re-initialize the http client...")
client.setupSession()
context.logger.info("wake-up from an OS sleep was detected")
} else {
context.logger.error(ex, "workspace polling error encountered, trying to auto-login")
context.logger.error(ex, "workspace polling error encountered")
if (ex is APIResponseException && ex.isTokenExpired) {
WorkspaceConnectionManager.shouldEstablishWorkspaceConnections = true
close()
context.envPageManager.showPluginEnvironmentsPage()
errorBuffer.add(ex)
break
}
close()
// force auto-login
firstRun = true
context.envPageManager.showPluginEnvironmentsPage()
break
}
}

// TODO: Listening on a web socket might be better?
select<Unit> {
select {
onTimeout(POLL_INTERVAL) {
context.logger.trace("workspace poller waked up by the $POLL_INTERVAL timeout")
}
Expand All@@ -196,9 +195,6 @@ class CoderRemoteProvider(
* first page.
*/
private fun logout() {
// Keep the URL and token to make it easy to log back in, but set
// rememberMe to false so we do not try to automatically log in.
context.secrets.rememberMe = false
WorkspaceConnectionManager.reset()
close()
}
Expand DownExpand Up@@ -360,22 +356,17 @@ class CoderRemoteProvider(
override fun getOverrideUiPage(): UiPage? {
// Show the setup page if we have not configured the client yet.
if (client == null) {
val errorBuffer = mutableListOf<Throwable>()
// When coming back to the application, initializeSession immediately.
val autoSetup = shouldDoAutoSetup()
context.secrets.lastToken.let { lastToken ->
context.secrets.lastDeploymentURL.let { lastDeploymentURL ->
if (autoSetup && lastDeploymentURL.isNotBlank() && (lastToken.isNotBlank() || !settings.requireTokenAuth)) {
try {
CoderCliSetupWizardState.goToStep(WizardStep.CONNECT)
return CoderCliSetupWizardPage(context, settingsPage, visibilityState, true, ::onConnect)
} catch (ex: Exception) {
errorBuffer.add(ex)
}
}
if (shouldDoAutoSetup()) {
try {
CoderCliSetupWizardState.goToStep(WizardStep.CONNECT)
return CoderCliSetupWizardPage(context, settingsPage, visibilityState, true, ::onConnect)
} catch (ex: Exception) {
errorBuffer.add(ex)
} finally {
firstRun = false
}
}
firstRun = false

// Login flow.
val setupWizardPage =
Expand All@@ -384,21 +375,24 @@ class CoderRemoteProvider(
errorBuffer.forEach {
setupWizardPage.notify("Error encountered", it)
}
errorBuffer.clear()
// and now reset the errors, otherwise we show it every time on the screen
return setupWizardPage
}
return null
}

private fun shouldDoAutoSetup(): Boolean = firstRun && context.secrets.rememberMe == true
/**
* Auto-login only on first the firs run if there is a url & token configured or the auth
* should be done via certificates.
*/
private fun shouldDoAutoSetup(): Boolean = firstRun && (context.secrets.canAutoLogin || !settings.requireTokenAuth)

private fun onConnect(client: CoderRestClient, cli: CoderCLIManager) {
// Store the URL and token for use next time.
context.secrets.lastDeploymentURL = client.url.toString()
context.secrets.lastToken = client.token ?: ""
context.secrets.storeTokenFor(client.url, context.secrets.lastToken)
// Currently we always remember, but this could be made an option.
context.secrets.rememberMe = true
this.client = client
pollJob?.cancel()
environments.showLoadingMessage()
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ open class CoderRestClient(
setupSession()
}

fun setupSession() {
privatefun setupSession() {
moshi =
Moshi.Builder()
.add(ArchConverter())
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,6 +146,11 @@ interface ReadOnlyCoderSettings {
* Return the URL and token from the config, if they exist.
*/
fun readConfig(dir: Path): Pair<String?, String?>

/**
* Returns whether the SSH connection should be automatically established.
*/
fun shouldAutoConnect(workspaceId: String): Boolean
}

/**
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,9 +24,8 @@ class CoderSecretsStore(private val store: PluginSecretStore) {
var lastToken: String
get() = get("last-token")
set(value) = set("last-token", value)
var rememberMe: Boolean
get() = get("remember-me").toBoolean()
set(value) = set("remember-me", value.toString())
val canAutoLogin: Boolean
get() = lastDeploymentURL.isNotBlank() && lastToken.isNotBlank()

fun tokenFor(url: URL): String? = store[url.host]

Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,10 @@ class CoderSettingsStore(
}
}

override fun shouldAutoConnect(workspaceId: String): Boolean {
return store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"]?.toBooleanStrictOrNull() ?: false
}

// a readonly cast
fun readOnly(): ReadOnlyCoderSettings = this

Expand DownExpand Up@@ -213,6 +217,10 @@ class CoderSettingsStore(
store[SSH_CONFIG_OPTIONS] = options
}

fun updateAutoConnect(workspaceId: String, autoConnect: Boolean) {
store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"] = autoConnect.toString()
}

private fun getDefaultGlobalDataDir(): Path {
return when (getOS()) {
OS.WINDOWS -> Paths.get(env.get("LOCALAPPDATA"), "coder-toolbox")
Expand Down
2 changes: 2 additions & 0 deletionssrc/main/kotlin/com/coder/toolbox/store/StoreKeys.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,3 +42,5 @@ internal const val SSH_CONFIG_OPTIONS = "sshConfigOptions"

internal const val NETWORK_INFO_DIR = "networkInfoDir"

internal const val SSH_AUTO_CONNECT_PREFIX = "ssh_auto_connect_"

1 change: 0 additions & 1 deletionsrc/main/kotlin/com/coder/toolbox/views/ConnectStep.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,6 @@ class ConnectStep(
if (shouldAutoLogin.value) {
CoderCliSetupContext.reset()
CoderCliSetupWizardState.goToFirstStep()
context.secrets.rememberMe = false
} else {
if (context.settingsStore.requireTokenAuth) {
CoderCliSetupWizardState.goToPreviousStep()
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp