Skip to content

Commit ad9a315

Browse files
code-ashercode-asher
committed
Add setting for default URL
Closes #395. This also consolidates some logic for getting the default token.
1 parent 5f46308 commit ad9a315

File tree

12 files changed

+220
-81
lines changed

12 files changed

+220
-81
lines changed

‎CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- Sort IDEs by version (latest first).
1010
- Recent connections window will try to recover after encountering an error.
1111
There is still a known issue where if a token expires there is no way to enter
12-
a new one except to go back through the "Connect with Coder" flow.
12+
a new one except to go back through the "Connect to Coder" flow.
1313
- Header command ignores stderr and does not error if nothing is output. It
1414
will still error if any blank lines are output.
1515
- Remove "from jetbrains.com" from the download text since the download source
@@ -27,6 +27,8 @@
2727
instead of hiding them in tooltips.
2828
- Truncate the path in the recents window if it is too long to prevent
2929
needing to scroll to press the workspace actions.
30+
- If there is no default URL, coder.example.com will no longer be used. The
31+
field will just be blank, to remove the need to first delete the example URL.
3032

3133
### Added
3234

@@ -37,6 +39,9 @@
3739
- New setting for extra SSH options. This is arbitrary text and is not
3840
validated in any way. If this setting is left empty, the environment variable
3941
CODER_SSH_CONFIG_OPTIONS will be used if set.
42+
- New setting for the default URL. If this setting is left empty, the
43+
environment variable CODER_URL will be used. If CODER_URL is also empty, the
44+
URL in the global CLI config directory will be used, if it exists.
4045

4146
## 2.10.0 - 2024-03-12
4247

‎gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
pluginGroup=com.coder.gateway
44
pluginName=coder-gateway
55
# SemVer format -> https://semver.org
6-
pluginVersion=2.11.1
6+
pluginVersion=2.11.2
77
# See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
88
# for insight into build numbers and IntelliJ Platform versions.
99
pluginSinceBuild=233.6745

‎src/main/kotlin/com/coder/gateway/CoderGatewayConnectionProvider.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import com.coder.gateway.cli.ensureCLI
77
import com.coder.gateway.models.AGENT_ID
88
import com.coder.gateway.models.AGENT_NAME
99
import com.coder.gateway.models.TOKEN
10-
import com.coder.gateway.models.TokenSource
1110
import com.coder.gateway.models.URL
1211
import com.coder.gateway.models.WORKSPACE
1312
import com.coder.gateway.models.WorkspaceAndAgentStatus
@@ -30,6 +29,7 @@ import com.coder.gateway.sdk.v2.models.WorkspaceAgent
3029
import com.coder.gateway.sdk.v2.models.WorkspaceStatus
3130
import com.coder.gateway.services.CoderRestClientService
3231
import com.coder.gateway.services.CoderSettingsService
32+
import com.coder.gateway.settings.Source
3333
import com.coder.gateway.util.toURL
3434
import com.coder.gateway.views.steps.CoderWorkspaceProjectIDEStepView
3535
import com.coder.gateway.views.steps.CoderWorkspacesStepSelection
@@ -193,12 +193,12 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
193193
* continues to result in an authentication failure and token authentication
194194
* is required.
195195
*/
196-
private fun authenticate(deploymentURL: String, queryToken: String?, lastToken: Pair<String, TokenSource>? = null): CoderRestClient {
196+
private fun authenticate(deploymentURL: String, queryToken: String?, lastToken: Pair<String, Source>? = null): CoderRestClient {
197197
val token = if (settings.requireTokenAuth) {
198198
// Use the token from the query, unless we already tried that.
199199
val isRetry = lastToken != null
200200
if (!queryToken.isNullOrBlank() && !isRetry)
201-
Pair(queryToken, TokenSource.QUERY)
201+
Pair(queryToken, Source.QUERY)
202202
else CoderRemoteConnectionHandle.askToken(
203203
deploymentURL.toURL(),
204204
lastToken,

‎src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
package com.coder.gateway
44

5-
import com.coder.gateway.models.TokenSource
65
import com.coder.gateway.models.WorkspaceProjectIDE
76
import com.coder.gateway.services.CoderRecentWorkspaceConnectionsService
87
import com.coder.gateway.services.CoderSettingsService
98
import com.coder.gateway.settings.CoderSettings
9+
import com.coder.gateway.settings.Source
1010
import com.coder.gateway.util.humanizeDuration
1111
import com.coder.gateway.util.isCancellation
1212
import com.coder.gateway.util.isWorkerTimeout
@@ -197,12 +197,12 @@ class CoderRemoteConnectionHandle {
197197
@JvmStatic
198198
fun askToken(
199199
url: URL,
200-
token: Pair<String, TokenSource>?,
200+
token: Pair<String, Source>?,
201201
isRetry: Boolean,
202202
useExisting: Boolean,
203203
settings: CoderSettings,
204-
): Pair<String, TokenSource>? {
205-
var (existingToken, tokenSource) = token ?: Pair("", TokenSource.USER)
204+
): Pair<String, Source>? {
205+
var (existingToken, tokenSource) = token ?: Pair("", Source.USER)
206206
val getTokenUrl = url.withPath("/login?redirect=%2Fcli-auth")
207207

208208
// On the first run either open a browser to generate a new token
@@ -213,10 +213,12 @@ class CoderRemoteConnectionHandle {
213213
if (!useExisting) {
214214
BrowserUtil.browse(getTokenUrl)
215215
} else {
216-
val (u, t) = settings.readConfig(settings.coderConfigDir)
217-
if (url.toString() == u && !t.isNullOrBlank() && t != existingToken) {
218-
logger.info("Injecting token for $url from CLI config")
219-
return Pair(t, TokenSource.CONFIG)
216+
// Look on disk in case we already have a token, either in
217+
// the deployment's config or the global config.
218+
val token = settings.token(url.toString())
219+
if (token != null && token.first != existingToken) {
220+
logger.info("Injecting token for $url from ${token.second}")
221+
return token
220222
}
221223
}
222224
}
@@ -226,9 +228,10 @@ class CoderRemoteConnectionHandle {
226228
val tokenFromUser = ask(
227229
CoderGatewayBundle.message(
228230
if (isRetry) "gateway.connector.view.workspaces.token.rejected"
229-
else if (tokenSource == TokenSource.CONFIG) "gateway.connector.view.workspaces.token.injected"
230-
else if (tokenSource == TokenSource.QUERY) "gateway.connector.view.workspaces.token.query"
231-
else if (tokenSource == TokenSource.LAST_USED) "gateway.connector.view.workspaces.token.last-used"
231+
else if (tokenSource == Source.CONFIG) "gateway.connector.view.workspaces.token.injected-global"
232+
else if (tokenSource == Source.DEPLOYMENT_CONFIG) "gateway.connector.view.workspaces.token.injected"
233+
else if (tokenSource == Source.LAST_USED) "gateway.connector.view.workspaces.token.last-used"
234+
else if (tokenSource == Source.QUERY) "gateway.connector.view.workspaces.token.query"
232235
else if (existingToken.isNotBlank()) "gateway.connector.view.workspaces.token.comment"
233236
else "gateway.connector.view.workspaces.token.none",
234237
url.host,
@@ -244,7 +247,7 @@ class CoderRemoteConnectionHandle {
244247
return null
245248
}
246249
if (tokenFromUser != existingToken) {
247-
tokenSource = TokenSource.USER
250+
tokenSource = Source.USER
248251
}
249252
return Pair(tokenFromUser, tokenSource)
250253
}

‎src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,13 @@ class CoderSettingsConfigurable : BoundConfigurable("Coder") {
132132
CoderGatewayBundle.message("gateway.connector.settings.ignore-setup-failure.comment")
133133
)
134134
}.layout(RowLayout.PARENT_GRID)
135+
row(CoderGatewayBundle.message("gateway.connector.settings.default-url.title")) {
136+
textField().resizableColumn().align(AlignX.FILL)
137+
.bindText(state::defaultURL)
138+
.comment(
139+
CoderGatewayBundle.message("gateway.connector.settings.setup-command.comment")
140+
)
141+
}.layout(RowLayout.PARENT_GRID)
135142
}
136143
}
137144

‎src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ fun ensureCLI(
110110
/**
111111
* The supported features of the CLI.
112112
*/
113-
data class Features(
113+
data class Features (
114114
val disableAutostart: Boolean = false,
115115
)
116116

‎src/main/kotlin/com/coder/gateway/models/TokenSource.kt

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,20 @@ import java.nio.file.Path
1515
import java.nio.file.Paths
1616

1717
const val CODER_SSH_CONFIG_OPTIONS = "CODER_SSH_CONFIG_OPTIONS"
18+
const val CODER_URL = "CODER_URL"
19+
20+
/**
21+
* Describes where a setting came from.
22+
*/
23+
enum class Source {
24+
CONFIG, // Pulled from the global Coder CLI config.
25+
DEPLOYMENT_CONFIG, // Pulled from the config for a deployment.
26+
ENVIRONMENT, // Pulled from environment variables.
27+
LAST_USED, // Last used token.
28+
QUERY, // From the Gateway link as a query parameter.
29+
SETTINGS, // Pulled from settings.
30+
USER, // Input by the user.
31+
}
1832

1933
open class CoderSettingsState(
2034
// Used to download the Coder CLI which is necessary to proxy SSH
@@ -66,6 +80,8 @@ open class CoderSettingsState(
6680
open var setupCommand: String = "",
6781
// Whether to ignore setup command failures.
6882
open var ignoreSetupFailure: Boolean = false,
83+
// Default URL to show in the connection window.
84+
open var defaultURL: String = "",
6985
)
7086

7187
/**
@@ -140,6 +156,53 @@ open class CoderSettings(
140156
val ignoreSetupFailure: Boolean
141157
get() = state.ignoreSetupFailure
142158

159+
/**
160+
* The default URL to show in the connection window.
161+
*/
162+
fun defaultURL(): Pair<String, Source>? {
163+
val defaultURL = state.defaultURL
164+
val envURL = env.get(CODER_URL)
165+
if (!defaultURL.isBlank()) {
166+
return defaultURL to Source.SETTINGS
167+
} else if (!envURL.isBlank()) {
168+
return envURL to Source.ENVIRONMENT
169+
} else {
170+
val (configUrl, _) = readConfig(coderConfigDir)
171+
if (!configUrl.isNullOrBlank()) {
172+
return configUrl to Source.CONFIG
173+
}
174+
}
175+
return null
176+
}
177+
178+
/**
179+
* Given a deployment URL, try to find a token for it if required.
180+
*/
181+
fun token(url: String): Pair<String, Source>? {
182+
// No need to bother if we do not need token auth anyway.
183+
if (!requireTokenAuth) {
184+
return null
185+
}
186+
// Try the deployment's config directory. This could exist if someone
187+
// has entered a URL that they are not currently connected to, but have
188+
// connected to in the past.
189+
try {
190+
val (_, deploymentToken) = readConfig(dataDir(url.toURL()).resolve("config"))
191+
if (!deploymentToken.isNullOrBlank()) {
192+
return deploymentToken to Source.DEPLOYMENT_CONFIG
193+
}
194+
} catch (ex: Exception) {
195+
// URL is invalid.
196+
}
197+
// Try the global config directory, in case they previously set up the
198+
// CLI with this URL.
199+
val (configUrl, configToken) = readConfig(coderConfigDir)
200+
if (configUrl == url && !configToken.isNullOrBlank()) {
201+
return configToken to Source.CONFIG
202+
}
203+
return null
204+
}
205+
143206
/**
144207
* Where the specified deployment should put its data.
145208
*/
@@ -183,18 +246,20 @@ open class CoderSettings(
183246
}
184247

185248
/**
186-
* Return the URL and token from the config, if it exists. Both the url and
187-
* session files must exist if using token auth, otherwise only url must
188-
* exist.
249+
* Return the URL and token from the config, if they exist.
189250
*/
190251
fun readConfig(dir: Path): Pair<String?, String?> {
191252
logger.info("Reading config from $dir")
192253
return try {
193-
val token = if (requireTokenAuth) Files.readString(dir.resolve("session")) else null
194-
Files.readString(dir.resolve("url")) to token
254+
Files.readString(dir.resolve("url"))
255+
} catch (e: Exception) {
256+
// SSH has not been configured yet, or using some other authorization mechanism.
257+
null
258+
} to try {
259+
Files.readString(dir.resolve("session"))
195260
} catch (e: Exception) {
196261
// SSH has not been configured yet, or using some other authorization mechanism.
197-
null to null
262+
null
198263
}
199264
}
200265

‎src/main/kotlin/com/coder/gateway/views/CoderGatewayRecentWorkspaceConnectionsView.kt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ package com.coder.gateway.views
55
import com.coder.gateway.CoderGatewayBundle
66
import com.coder.gateway.CoderGatewayConstants
77
import com.coder.gateway.CoderRemoteConnectionHandle
8-
import com.coder.gateway.cli.CoderCLIManager
98
import com.coder.gateway.icons.CoderIcons
109
import com.coder.gateway.models.WorkspaceAgentListModel
1110
import com.coder.gateway.models.WorkspaceProjectIDE
@@ -317,9 +316,8 @@ class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback:
317316
.map { Triple(it.key, deployments.getOrPut(it.key) { DeploymentInfo() }, it.value) }
318317
connections.forEach { (deploymentURL, deployment, workspaces) ->
319318
val client = deployment.client ?: try {
320-
val cli = CoderCLIManager(deploymentURL.toURL())
321-
val (_, token) = settings.readConfig(cli.coderConfigPath)
322-
deployment.client = CoderRestClientService(deploymentURL.toURL(), token)
319+
val token = settings.token(deploymentURL)
320+
deployment.client = CoderRestClientService(deploymentURL.toURL(), token?.first)
323321
deployment.error = null
324322
deployment.client
325323
} catch (e: Exception) {

0 commit comments

Comments
 (0)