Skip to content

fix: open URLs on Windows #116

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 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
May 20, 2025
Merged
Changes from all 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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -10,6 +10,7 @@
### Fixed

- `Open web terminal` action is no longer displayed when the workspace is stopped.
- URL links can now be opened in Windows

## 0.2.1 - 2025-05-05

10 changes: 6 additions & 4 deletions src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.coder.toolbox

import com.coder.toolbox.browser.BrowserUtil
import com.coder.toolbox.browser.browse
import com.coder.toolbox.cli.CoderCLIManager
import com.coder.toolbox.cli.SshCommandProcessHandle
import com.coder.toolbox.models.WorkspaceAndAgentStatus
@@ -74,7 +74,7 @@ class CoderRemoteEnvironment(
if (wsRawStatus.canStop()) {
actions.add(Action(context.i18n.ptrl("Open web terminal")) {
context.cs.launch {
BrowserUtil.browse(client.url.withPath("/${workspace.ownerName}/$name/terminal").toString()) {
context.desktop.browse(client.url.withPath("/${workspace.ownerName}/$name/terminal").toString()) {
context.ui.showErrorInfoPopup(it)
}
}
@@ -83,15 +83,17 @@ class CoderRemoteEnvironment(
actions.add(
Action(context.i18n.ptrl("Open in dashboard")) {
context.cs.launch {
BrowserUtil.browse(client.url.withPath("/@${workspace.ownerName}/${workspace.name}").toString()) {
context.desktop.browse(
client.url.withPath("/@${workspace.ownerName}/${workspace.name}").toString()
) {
context.ui.showErrorInfoPopup(it)
}
}
})

actions.add(Action(context.i18n.ptrl("View template")) {
context.cs.launch {
BrowserUtil.browse(client.url.withPath("/templates/${workspace.templateName}").toString()) {
context.desktop.browse(client.url.withPath("/templates/${workspace.templateName}").toString()) {
context.ui.showErrorInfoPopup(it)
}
}
4 changes: 2 additions & 2 deletions src/main/kotlin/com/coder/toolbox/CoderRemoteProvider.kt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.coder.toolbox

import com.coder.toolbox.browser.BrowserUtil
import com.coder.toolbox.browser.browse
import com.coder.toolbox.cli.CoderCLIManager
import com.coder.toolbox.sdk.CoderRestClient
import com.coder.toolbox.sdk.v2.models.WorkspaceStatus
@@ -190,7 +190,7 @@ class CoderRemoteProvider(
listOf(
Action(context.i18n.ptrl("Create workspace")) {
context.cs.launch {
BrowserUtil.browse(client?.url?.withPath("/templates").toString()) {
context.desktop.browse(client?.url?.withPath("/templates").toString()) {
context.ui.showErrorInfoPopup(it)
}
}
3 changes: 2 additions & 1 deletion src/main/kotlin/com/coder/toolbox/CoderToolboxContext.kt
Original file line number Diff line number Diff line change
@@ -5,6 +5,7 @@ import com.coder.toolbox.store.CoderSecretsStore
import com.coder.toolbox.store.CoderSettingsStore
import com.coder.toolbox.util.toURL
import com.jetbrains.toolbox.api.core.diagnostics.Logger
import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
import com.jetbrains.toolbox.api.remoteDev.connection.ToolboxProxySettings
@@ -18,6 +19,7 @@ data class CoderToolboxContext(
val envPageManager: EnvironmentUiPageManager,
val envStateColorPalette: EnvironmentStateColorPalette,
val ideOrchestrator: ClientHelper,
val desktop: LocalDesktopManager,
val cs: CoroutineScope,
val logger: Logger,
val i18n: LocalizableStringFactory,
@@ -62,5 +64,4 @@ data class CoderToolboxContext(
} else null
}
}

}
2 changes: 2 additions & 0 deletions src/main/kotlin/com/coder/toolbox/CoderToolboxExtension.kt
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@ import com.jetbrains.toolbox.api.core.PluginSettingsStore
import com.jetbrains.toolbox.api.core.ServiceLocator
import com.jetbrains.toolbox.api.core.diagnostics.Logger
import com.jetbrains.toolbox.api.core.getService
import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
import com.jetbrains.toolbox.api.remoteDev.RemoteDevExtension
import com.jetbrains.toolbox.api.remoteDev.RemoteProvider
@@ -31,6 +32,7 @@ class CoderToolboxExtension : RemoteDevExtension {
serviceLocator.getService<EnvironmentUiPageManager>(),
serviceLocator.getService<EnvironmentStateColorPalette>(),
serviceLocator.getService<ClientHelper>(),
serviceLocator.getService<LocalDesktopManager>(),
serviceLocator.getService<CoroutineScope>(),
serviceLocator.getService<Logger>(),
serviceLocator.getService<LocalizableStringFactory>(),
73 changes: 13 additions & 60 deletions src/main/kotlin/com/coder/toolbox/browser/BrowserUtil.kt
Original file line number Diff line number Diff line change
@@ -1,66 +1,19 @@
package com.coder.toolbox.browser

import com.coder.toolbox.util.OS
import com.coder.toolbox.util.getOS
import org.zeroturnaround.exec.ProcessExecutor
import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
import java.net.URI

class BrowserUtil {
companion object {
suspend fun browse(url: String, errorHandler: suspend (BrowserException) -> Unit) {
val os = getOS()
if (os == null) {
errorHandler(BrowserException("Failed to open the URL because we can't detect the OS"))
return
}
when (os) {
OS.LINUX -> linuxBrowse(url, errorHandler)
OS.MAC -> macBrowse(url, errorHandler)
OS.WINDOWS -> windowsBrowse(url, errorHandler)
}
}

private suspend fun linuxBrowse(url: String, errorHandler: suspend (BrowserException) -> Unit) {
try {
if (OS.LINUX.getDesktopEnvironment()?.uppercase()?.contains("GNOME") == true) {
exec("gnome-open", url)
} else {
exec("xdg-open", url)
}
} catch (e: Exception) {
errorHandler(
BrowserException(
"Failed to open URL because an error was encountered. Please make sure xdg-open from package xdg-utils is available!",
e
)
)
}
}

private suspend fun macBrowse(url: String, errorHandler: suspend (BrowserException) -> Unit) {
try {
exec("open", url)
} catch (e: Exception) {
errorHandler(BrowserException("Failed to open URL because an error was encountered.", e))
}
}

private suspend fun windowsBrowse(url: String, errorHandler: suspend (BrowserException) -> Unit) {
try {
exec("cmd", "start \"$url\"")
} catch (e: Exception) {
errorHandler(BrowserException("Failed to open URL because an error was encountered.", e))
}
}

private fun exec(vararg args: String): String {
val stdout =
ProcessExecutor()
.command(*args)
.exitValues(0)
.readOutput(true)
.execute()
.outputUTF8()
return stdout
}
suspend fun LocalDesktopManager.browse(rawUrl: String, errorHandler: suspend (BrowserException) -> Unit) {
try {
val url = URI.create(rawUrl).toURL()
this.openUrl(url)
} catch (e: Exception) {
errorHandler(
BrowserException(
"Failed to open $rawUrl because an error was encountered",
e
)
)
}
}
18 changes: 4 additions & 14 deletions src/main/kotlin/com/coder/toolbox/util/Dialogs.kt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.coder.toolbox.util

import com.coder.toolbox.CoderToolboxContext
import com.coder.toolbox.browser.BrowserUtil
import com.coder.toolbox.browser.browse
import com.jetbrains.toolbox.api.localization.LocalizableString
import com.jetbrains.toolbox.api.ui.components.TextType
import java.net.URL
@@ -23,12 +23,7 @@ class DialogUi(private val context: CoderToolboxContext) {
placeholder: LocalizableString? = null,
): String? {
return context.ui.showTextInputPopup(
title,
description,
placeholder,
TextType.General,
context.i18n.ptrl("OK"),
context.i18n.ptrl("Cancel")
title, description, placeholder, TextType.General, context.i18n.ptrl("OK"), context.i18n.ptrl("Cancel")
)
}

@@ -38,17 +33,12 @@ class DialogUi(private val context: CoderToolboxContext) {
placeholder: LocalizableString? = null,
): String? {
return context.ui.showTextInputPopup(
title,
description,
placeholder,
TextType.Password,
context.i18n.ptrl("OK"),
context.i18n.ptrl("Cancel")
title, description, placeholder, TextType.Password, context.i18n.ptrl("OK"), context.i18n.ptrl("Cancel")
)
}

private suspend fun openUrl(url: URL) {
BrowserUtil.browse(url.toString()) {
context.desktop.browse(url.toString()) {
context.ui.showErrorInfoPopup(it)
}
}
2 changes: 2 additions & 0 deletions src/test/kotlin/com/coder/toolbox/cli/CoderCLIManagerTest.kt
Original file line number Diff line number Diff line change
@@ -31,6 +31,7 @@ import com.coder.toolbox.util.pluginTestSettingsStore
import com.coder.toolbox.util.sha1
import com.coder.toolbox.util.toURL
import com.jetbrains.toolbox.api.core.diagnostics.Logger
import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
import com.jetbrains.toolbox.api.remoteDev.connection.ToolboxProxySettings
@@ -66,6 +67,7 @@ internal class CoderCLIManagerTest {
mockk<EnvironmentUiPageManager>(),
mockk<EnvironmentStateColorPalette>(),
mockk<ClientHelper>(),
mockk<LocalDesktopManager>(),
mockk<CoroutineScope>(),
mockk<Logger>(relaxed = true),
mockk<LocalizableStringFactory>(),
2 changes: 2 additions & 0 deletions src/test/kotlin/com/coder/toolbox/sdk/CoderRestClientTest.kt
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ import com.coder.toolbox.store.TLS_CA_PATH
import com.coder.toolbox.util.pluginTestSettingsStore
import com.coder.toolbox.util.sslContextFromPEMs
import com.jetbrains.toolbox.api.core.diagnostics.Logger
import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
import com.jetbrains.toolbox.api.remoteDev.connection.ToolboxProxySettings
@@ -102,6 +103,7 @@ class CoderRestClientTest {
mockk<EnvironmentUiPageManager>(),
mockk<EnvironmentStateColorPalette>(),
mockk<ClientHelper>(),
mockk<LocalDesktopManager>(),
mockk<CoroutineScope>(),
mockk<Logger>(relaxed = true),
mockk<LocalizableStringFactory>(),