Skip to content

Read URL and token from config #183

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 2 commits into from
Mar 3, 2023
Merged

Read URL and token from config #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28d044d
Read URL and token from config on launch
code-asher Mar 1, 2023
d353e6a
Update changelog: use existing token
code-asher Mar 2, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
### Added

- support for Gateway 2023
- ability to use existing tokens rather than request a new one

## 2.1.7 - 2023-02-28

Expand Down
5 changes: 3 additions & 2 deletions src/main/kotlin/com/coder/gateway/models/CoderWorkspacesWizardModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ data class CoderWorkspacesWizardModel(
var token: String = "",
var buildVersion: String = "",
var localCliPath: String = "",
var selectedWorkspace: WorkspaceAgentModel? = null
)
var selectedWorkspace: WorkspaceAgentModel? = null,
var useExistingToken: Boolean = false
)
97 changes: 83 additions & 14 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
Expand Up @@ -46,13 +46,7 @@ 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
import com.intellij.ui.dsl.builder.RightGap
import com.intellij.ui.dsl.builder.TopGap
import com.intellij.ui.dsl.builder.bindText
import com.intellij.ui.dsl.builder.panel
import com.intellij.ui.dsl.builder.*
import com.intellij.ui.table.TableView
import com.intellij.util.ui.ColumnInfo
import com.intellij.util.ui.JBFont
Expand All @@ -76,8 +70,12 @@ import java.awt.event.MouseListener
import java.awt.event.MouseMotionListener
import java.awt.font.TextAttribute
import java.awt.font.TextAttribute.UNDERLINE_ON
import java.nio.file.Files
import java.nio.file.Path
import java.nio.file.Paths
import java.net.SocketTimeoutException
import javax.swing.Icon
import javax.swing.JCheckBox
import javax.swing.JTable
import javax.swing.JTextField
import javax.swing.ListSelectionModel
Expand All @@ -100,6 +98,7 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
private val appPropertiesService: PropertiesComponent = service()

private var tfUrl: JTextField? = null
private var cbExistingToken: JCheckBox? = null
private var listTableModelOfWorkspaces = ListTableModel<WorkspaceAgentModel>(
WorkspaceIconColumnInfo(""),
WorkspaceNameColumnInfo("Name"),
Expand Down Expand Up @@ -201,13 +200,13 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
font = JBFont.h3().asBold()
icon = CoderIcons.LOGO_16
}
}.topGap(TopGap.SMALL).bottomGap(BottomGap.MEDIUM)
}.topGap(TopGap.SMALL)
row {
cell(ComponentPanelBuilder.createCommentComponent(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.comment"), false, -1, true))
}
row {
browserLink(CoderGatewayBundle.message("gateway.connector.view.login.documentation.action"), "https://coder.com/docs/coder-oss/latest/workspaces")
}.bottomGap(BottomGap.MEDIUM)
}
row(CoderGatewayBundle.message("gateway.connector.view.login.url.label")) {
tfUrl = textField().resizableColumn().align(AlignX.FILL).gap(RightGap.SMALL).bindText(localWizardModel::coderURL).applyToComponent {
addActionListener {
Expand All @@ -223,6 +222,17 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
}
cell()
}
row {
cbExistingToken = checkBox(CoderGatewayBundle.message("gateway.connector.view.login.existing-token.label"))
.bindSelected(localWizardModel::useExistingToken)
.component
}
row {
cell(ComponentPanelBuilder.createCommentComponent(
CoderGatewayBundle.message("gateway.connector.view.login.existing-token.tooltip",
CoderGatewayBundle.message("gateway.connector.view.login.existing-token.label")),
false, -1, true))
}
row {
scrollCell(toolbar.createPanel().apply {
add(notificationBanner.component.apply { isVisible = false }, "South")
Expand Down Expand Up @@ -313,18 +323,71 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
if (localWizardModel.coderURL.isNotBlank() && localWizardModel.token.isNotBlank()) {
triggerWorkspacePolling()
} else {
val url = appPropertiesService.getValue(CODER_URL_KEY)
val token = appPropertiesService.getValue(SESSION_TOKEN)
if (!url.isNullOrBlank() && !token.isNullOrBlank()) {
val (url, token) = readStorageOrConfig()
if (!url.isNullOrBlank()) {
localWizardModel.coderURL = url
localWizardModel.token = token
tfUrl?.text = url
}
if (!token.isNullOrBlank()) {
localWizardModel.token = token
}
if (!url.isNullOrBlank() && !token.isNullOrBlank()) {
loginAndLoadWorkspace(token, true)
}
}
updateWorkspaceActions()
}

/**
* Return the URL and token from storage or the CLI config.
*/
private fun readStorageOrConfig(): Pair<String?, String?> {
val url = appPropertiesService.getValue(CODER_URL_KEY)
val token = appPropertiesService.getValue(SESSION_TOKEN)
if (!url.isNullOrBlank() && !token.isNullOrBlank()) {
return url to token
}
return readConfig()
}

/**
* Return the URL and token from the CLI config.
*/
private fun readConfig(): Pair<String?, String?> {
val configDir = getConfigDir()
logger.info("Reading config from $configDir")
try {
val url = Files.readString(configDir.resolve("url"))
val token = Files.readString(configDir.resolve("session"))
return url to token
} catch (e: Exception) {
return null to null // Probably has not configured the CLI yet.
}
}

/**
* Return the config directory used by the CLI.
*/
private fun getConfigDir(): Path {
var dir = System.getenv("CODER_CONFIG_DIR")
if (!dir.isNullOrBlank()) {
return Path.of(dir)
}
// The Coder CLI uses https://github.com/kirsle/configdir so this should
// match how it behaves.
return when(getOS()) {
OS.WINDOWS -> Paths.get(System.getenv("APPDATA"), "coderv2")
OS.MAC -> Paths.get(System.getenv("HOME"), "Library/Application Support/coderv2")
else -> {
dir = System.getenv("XDG_CACHE_HOME")
if (!dir.isNullOrBlank()) {
return Paths.get(dir, "coderv2")
}
return Paths.get(System.getenv("HOME"), ".config/coderv2")
}
}
}

private fun updateWorkspaceActions() {
goToDashboardAction.isEnabled = coderClient.isReady
createWorkspaceAction.isEnabled = coderClient.isReady
Expand Down Expand Up @@ -440,8 +503,14 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :

private fun askToken(openBrowser: Boolean): String? {
val getTokenUrl = localWizardModel.coderURL.toURL().withPath("/login?redirect=%2Fcli-auth")
if (openBrowser) {
if (openBrowser && !localWizardModel.useExistingToken) {
BrowserUtil.browse(getTokenUrl)
} else if (localWizardModel.useExistingToken) {
val (url, token) = readConfig()
if (url == localWizardModel.coderURL && !token.isNullOrBlank()) {
logger.info("Injecting valid token from CLI config")
localWizardModel.token = token
}
}
var tokenFromUser: String? = null
ApplicationManager.getApplication().invokeAndWait({
Expand Down
4 changes: 3 additions & 1 deletion src/main/resources/messages/CoderGatewayBundle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ gateway.connector.description=Connects to a Coder Workspace dev environment so t
gateway.connector.action.text=Connect to Coder
gateway.connector.view.login.documentation.action=Learn more about Coder
gateway.connector.view.login.url.label=URL:
gateway.connector.view.login.existing-token.label=Use existing token
gateway.connector.view.login.existing-token.tooltip=Checking "{0}" will prevent the browser from being launched for generating a new token. Additionally, if a token is already configured for this URL via the CLI it will appear as the default and can be used as-is or replaced.
Copy link
Member Author

@code-asher code-asher Mar 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Pinging @sharkymark @bpmct @ericpaulsen in case anyone has opinions on the wording of the checkbox help text (it has been tweaked a bit since the screenshot).

gateway.connector.view.login.token.dialog=Paste your token here:
gateway.connector.view.login.token.label=Session Token:
gateway.connector.view.coder.workspaces.header.text=Coder Workspaces
Expand All @@ -28,4 +30,4 @@ gateway.connector.recentconnections.title=Recent Coder Workspaces
gateway.connector.recentconnections.new.wizard.button.tooltip=Open a new Coder Workspace
gateway.connector.recentconnections.remove.button.tooltip=Remove from Recent Connections
gateway.connector.recentconnections.terminal.button.tooltip=Open SSH Web Terminal
gateway.connector.coder.connection.provider.title=Connecting to Coder workspace...
gateway.connector.coder.connection.provider.title=Connecting to Coder workspace...