impl: ability to customize the links to Dashboard (#211)

Some clients (Netflix in this specific case) rely on mainly their own
dashboard tools instead of the Coder one. Two main reasons that were
mentioned by Netflix:
- aggregate many dev tools in a unified internal console
- specific platform/security needs that their own UI handles better

For this reason they would like the actions that open up the Coder
Dashboard (`Create workspace` and `Open in dashboard`) to be fully
customizable, and allow clients to override the URL.
For `Create workspace` we now have a config that defaults
$lastDeploymentUrl/templates, but it can be replaced with a complete new
URL. It also supports `$workspaceOwner` as a placeholder that is
replaced by the plugin with the username that logged in.

For `Open in dashboard` a full URL can be provided and we also
introduced two placeholders `$workspaceOwner` and `$workspaceName` which
will be replaced by the plugin but only for this action.

For now the decision is to not allow configuration from UI since Netflix
is the only target for this change, and they deploy at scale a templated
settings.json.

Author: fioan89

README.md

@@ -360,6 +360,16 @@ storage paths. The options can be configured from the plugin's main Workspaces p
 - `Header command` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
   The environment variable CODER_URL will be available to the command process.
 
+- `lastDeploymentURL` the last Coder deployment URL that Coder Toolbox successfully authenticated to.
+
+- `workspaceViewUrl` specifies the dashboard page full URL where users can view details about a workspace.
+  Helpful for customers that have their own in-house dashboards. Defaults to the Coder deployment workspace page.
+  This setting supports `$workspaceOwner` and `$workspaceName` as placeholders.
+
+- `workspaceCreateUrl` specifies the dashboard page full URL where users can create new workspaces.
+  Helpful for customers that have their own in-house dashboards. Defaults to the Coder deployment templates page.
+  This setting supports `$workspaceOwner` as placeholder with the replacing value being the username that logged in.
+
 ### TLS settings
 
 The following options control the secure communication behavior of the plugin with Coder deployment and its available

gradle.properties

@@ -1,3 +1,3 @@
-version=0.7.1
+version=0.7.3
 group=com.coder.toolbox
 name=coder-toolbox

src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt

@@ -91,8 +91,13 @@ class CoderRemoteEnvironment(
         }
         actions.add(
             Action(context, "Open in dashboard") {
+                val urlTemplate = context.settingsStore.workspaceViewUrl
+                    ?: client.url.withPath("/@${workspace.ownerName}/${workspace.name}").toString()
+                val url = urlTemplate
+                    .replace("\$workspaceOwner", "${workspace.ownerName}")
+                    .replace("\$workspaceName", workspace.name)
                 context.desktop.browse(
-                    client.url.withPath("/@${workspace.ownerName}/${workspace.name}").toString()
+                    url
                 ) {
                     context.ui.showErrorInfoPopup(it)
                 }

src/main/kotlin/com/coder/toolbox/CoderRemoteProvider.kt

@@ -224,7 +224,11 @@ class CoderRemoteProvider(
     override val additionalPluginActions: StateFlow<List<ActionDescription>> = MutableStateFlow(
         listOf(
             Action(context, "Create workspace") {
-                context.desktop.browse(client?.url?.withPath("/templates").toString()) {
+                val url = context.settingsStore.workspaceCreateUrl ?: client?.url?.withPath("/templates").toString()
+                context.desktop.browse(
+                    url
+                        .replace("\$workspaceOwner", client?.me()?.username ?: "")
+                ) {
                     context.ui.showErrorInfoPopup(it)
                 }
             },

src/main/kotlin/com/coder/toolbox/settings/ReadOnlyCoderSettings.kt

@@ -137,6 +137,17 @@ interface ReadOnlyCoderSettings {
      */
     val sshConfigOptions: String?
 
+    /**
+     * A custom full URL to the dashboard page used for viewing details about a workspace.
+     * Supports `$workspaceOwner` and `$workspaceName` as placeholders.
+     */
+    val workspaceViewUrl: String?
+
+    /**
+     * A custom full URL to the dashboard page used for creating workspaces.
+     * Supports `$workspaceOwner` as placeholder.
+     */
+    val workspaceCreateUrl: String?
 
     /**
      * The path where network information for SSH hosts are stored

src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt

@@ -80,6 +80,11 @@ class CoderSettingsStore(
             .normalize()
             .toString()
 
+    override val workspaceViewUrl: String?
+        get() = store[WORKSPACE_VIEW_URL]
+    override val workspaceCreateUrl: String?
+        get() = store[WORKSPACE_CREATE_URL]
+
     /**
      * Where the specified deployment should put its data.
      */

src/main/kotlin/com/coder/toolbox/store/StoreKeys.kt

@@ -46,5 +46,8 @@ internal const val SSH_CONFIG_OPTIONS = "sshConfigOptions"
 
 internal const val NETWORK_INFO_DIR = "networkInfoDir"
 
+internal const val WORKSPACE_VIEW_URL = "workspaceViewUrl"
+internal const val WORKSPACE_CREATE_URL = "workspaceCreateUrl"
+
 internal const val SSH_AUTO_CONNECT_PREFIX = "ssh_auto_connect_"
 

src/test/kotlin/com/coder/toolbox/util/URLExtensionsTest.kt

@@ -9,21 +9,21 @@ internal class URLExtensionsTest {
     @Test
     fun testToURL() {
         assertEquals(
-            URL("https", "localhost", 8080, "/path"),
-            "https://localhost:8080/path".toURL(),
+            expected = URI.create("https://localhost:8080/path").toURL(),
+            actual = "https://localhost:8080/path".toURL(),
         )
     }
 
     @Test
     fun testWithPath() {
         assertEquals(
-            URL("https", "localhost", 8080, "/foo/bar"),
-            URL("https", "localhost", 8080, "/").withPath("/foo/bar"),
+            expected = "https://localhost:8080/foo/bar".toURL(),
+            actual = "https://localhost:8080/".toURL().withPath("/foo/bar"),
         )
 
         assertEquals(
-            URL("https", "localhost", 8080, "/foo/bar"),
-            URL("https", "localhost", 8080, "/old/path").withPath("/foo/bar"),
+            expected = "https://localhost:8080/foo/bar".toURL(),
+            actual = "https://localhost:8080/old/path".toURL().withPath("/foo/bar"),
         )
     }