diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5b4851cc3..1b00555b3 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -23,7 +23,7 @@ jobs: - windows-latest runs-on: ${{ matrix.platform }} steps: - - uses: actions/checkout@v4.2.0 + - uses: actions/checkout@v4.2.2 - uses: actions/setup-java@v4 with: @@ -56,7 +56,7 @@ jobs: steps: # Check out current repository - name: Fetch Sources - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.2 # Setup Java 11 environment for the next steps - name: Setup Java @@ -82,7 +82,8 @@ jobs: echo "::set-output name=name::$NAME" echo "::set-output name=changelog::$CHANGELOG" echo "::set-output name=pluginVerifierHomeDir::~/.pluginVerifier" - ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier + # prepare list of IDEs for Plugin Verifier + ./gradlew printProductsReleases # Run plugin build - name: Run Build @@ -140,7 +141,7 @@ jobs: # Check out current repository - name: Fetch Sources - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.2 # Remove old release drafts by using the curl request for the available releases with draft flag - name: Remove Old Release Drafts diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 51d8c128f..5e8da9b50 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,7 +15,7 @@ jobs: # Check out current repository - name: Fetch Sources - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.2 with: ref: ${{ github.event.release.tag_name }} diff --git a/.gitignore b/.gitignore index 8157f01d4..41dda2b6d 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ ## Gradle .gradle build +jvm/ ## Qodana .qodana diff --git a/CHANGELOG.md b/CHANGELOG.md index f986d2f09..067980a5f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,66 @@ ## Unreleased +## 2.20.1 - 2025-05-20 + +### Changed + +- Retrieve workspace directly in link handler when using wildcardSSH feature + +### Fixed + +- installed EAP, RC, NIGHTLY and PREVIEW IDEs are no longer displayed if there is a higher released version available for download. +- project path is prefilled with the `folder` URI parameter when the IDE&Project dialog opens for URI handling. + +## 2.19.0 - 2025-02-21 + +### Added + +- Added functionality to show setup script error message to the end user. + +### Fixed + +- Fix bug where wildcard configs would not be written under certain conditions. + +## 2.18.1 - 2025-02-14 + +### Changed + +- Update the `pluginUntilBuild` to latest EAP + +## 2.18.0 - 2025-02-04 + +### Changed + +- Simplifies the written SSH config and avoids the need to make an API request for every workspace the filter returns. + +## 2.17.0 - 2025-01-27 + +### Added + +- Added setting "Check for IDE updates" which controls whether the plugin + checks and prompts for available IDE backend updates. + +## 2.16.0 - 2025-01-17 + +### Added + +- Added setting "Default IDE Selection" which will look for a matching IDE + code/version/build number to set as the preselected IDE in the select + component. + +## 2.15.2 - 2025-01-06 + +### Changed + +- When starting a workspace, shell out to the Coder binary instead of making an + API call. This reduces drift between what the plugin does and the CLI does. +- Increase workspace polling to one second on the workspace list view, to pick + up changes made via the CLI faster. The recent connections view remains + unchanged at five seconds. + +## 2.15.1 - 2024-10-04 + ### Added - Support an "owner" parameter when launching an IDE from the dashboard. This diff --git a/build.gradle.kts b/build.gradle.kts index 5e791b5a8..9ea24a063 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,5 +1,6 @@ +import org.jetbrains.changelog.Changelog import org.jetbrains.changelog.markdownToHTML -import org.jetbrains.kotlin.gradle.tasks.KotlinCompile +import org.jetbrains.intellij.platform.gradle.IntelliJPlatformType fun properties(key: String) = project.findProperty(key).toString() @@ -10,18 +11,34 @@ plugins { id("groovy") // Kotlin support id("org.jetbrains.kotlin.jvm") version "1.9.23" - // Gradle IntelliJ Plugin - id("org.jetbrains.intellij") version "1.13.3" + // Gradle IntelliJ Platform Plugin + id("org.jetbrains.intellij.platform") version "2.6.0" // Gradle Changelog Plugin id("org.jetbrains.changelog") version "2.2.1" // Gradle Qodana Plugin id("org.jetbrains.qodana") version "0.1.13" + // Gradle Kover Plugin + id("org.jetbrains.kotlinx.kover") version "0.9.1" // Generate Moshi adapters. id("com.google.devtools.ksp") version "1.9.23-1.0.20" } -group = properties("pluginGroup") -version = properties("pluginVersion") +group = providers.gradleProperty("pluginGroup").get() +version = providers.gradleProperty("pluginVersion").get() + +// Set the JVM language level used to build the project. +kotlin { + jvmToolchain(17) +} + +// Configure project's dependencies +repositories { + mavenCentral() + // IntelliJ Platform Gradle Plugin Repositories Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-repositories-extension.html + intellijPlatform { + defaultRepositories() + } +} dependencies { implementation(platform("com.squareup.okhttp3:okhttp-bom:4.12.0")) @@ -37,23 +54,83 @@ dependencies { implementation("org.zeroturnaround:zt-exec:1.12") testImplementation(kotlin("test")) -} + // required by the unit tests + testImplementation(kotlin("test-junit5")) + // required by IntelliJ test framework + testImplementation("junit:junit:4.13.2") -// Configure project's dependencies -repositories { - mavenCentral() - maven(url = "https://www.jetbrains.com/intellij-repository/snapshots") + + // IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html + intellijPlatform { + gateway(providers.gradleProperty("platformVersion")) + + // Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties file for bundled IntelliJ Platform plugins. + bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') }) + + // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace. + plugins(providers.gradleProperty("platformPlugins").map { it.split(',') }) + + pluginVerifier() + } } // Configure Gradle IntelliJ Plugin - read more: https://github.com/JetBrains/gradle-intellij-plugin -intellij { - pluginName.set(properties("pluginName")) - version.set(properties("platformVersion")) - type.set(properties("platformType")) - - downloadSources.set(properties("platformDownloadSources").toBoolean()) - // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file. - plugins.set(properties("platformPlugins").split(',').map(String::trim).filter(String::isNotEmpty)) +intellijPlatform { + buildSearchableOptions = false + instrumentCode = true + + pluginConfiguration { + name = providers.gradleProperty("pluginName") + version = providers.gradleProperty("pluginVersion") + + // Extract the section from README.md and provide for the plugin's manifest + description = providers.fileContents(layout.projectDirectory.file("README.md")).asText.map { + val start = "" + val end = "" + + with(it.lines()) { + if (!containsAll(listOf(start, end))) { + throw GradleException("Plugin description section not found in README.md:\n$start ... $end") + } + subList(indexOf(start) + 1, indexOf(end)).joinToString("\n").let(::markdownToHTML) + } + } + + val changelog = project.changelog // local variable for configuration cache compatibility + // Get the latest available change notes from the changelog file + changeNotes = providers.gradleProperty("pluginVersion").map { pluginVersion -> + with(changelog) { + renderItem( + (getOrNull(pluginVersion) ?: getUnreleased()) + .withHeader(false) + .withEmptySections(false), + Changelog.OutputType.HTML, + ) + } + } + + ideaVersion { + sinceBuild = providers.gradleProperty("pluginSinceBuild") + untilBuild = provider { null } + } + } + + pluginVerification { + ides { + providers.gradleProperty("verifyVersions").get().split(',').map(String::trim).forEach { version -> + ide(IntelliJPlatformType.Gateway, version) + } + } + } + + publishing { + token = providers.environmentVariable("PUBLISH_TOKEN") + // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3 + // Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more: + // https://plugins.jetbrains.com/docs/intellij/deployment.html#specifying-a-release-channel + channels = providers.gradleProperty("pluginVersion") + .map { listOf(it.substringAfter('-', "").substringBefore('.').ifEmpty { "default" }) } + } } // Configure Gradle Changelog Plugin - read more: https://github.com/JetBrains/gradle-changelog-plugin @@ -62,6 +139,17 @@ changelog { groups.set(emptyList()) } +// Configure Gradle Kover Plugin - read more: https://github.com/Kotlin/kotlinx-kover#configuration +kover { + reports { + total { + xml { + onCheck = true + } + } + } +} + // Configure Gradle Qodana Plugin - read more: https://github.com/JetBrains/gradle-qodana-plugin qodana { cachePath.set(projectDir.resolve(".qodana").canonicalPath) @@ -72,88 +160,43 @@ qodana { tasks { buildPlugin { + archiveBaseName = providers.gradleProperty("artifactName").get() exclude { "coroutines" in it.name } } prepareSandbox { exclude { "coroutines" in it.name } } - // Set the JVM compatibility versions - properties("javaVersion").let { - withType { - sourceCompatibility = it - targetCompatibility = it - } - withType { - kotlinOptions.jvmTarget = it - } - } - wrapper { - gradleVersion = properties("gradleVersion") - } - - instrumentCode { - compilerVersion.set(properties("instrumentationCompiler")) - } - - // TODO - this fails with linkage error, but we don't need it now - // because the plugin does not provide anything to search for in Preferences - buildSearchableOptions { - isEnabled = false - } - - patchPluginXml { - version.set(properties("pluginVersion")) - sinceBuild.set(properties("pluginSinceBuild")) - untilBuild.set(properties("pluginUntilBuild")) - - // Extract the section from README.md and provide for the plugin's manifest - pluginDescription.set( - projectDir.resolve("README.md").readText().lines().run { - val start = "" - val end = "" - - if (!containsAll(listOf(start, end))) { - throw GradleException("Plugin description section not found in README.md:\n$start ... $end") - } - subList(indexOf(start) + 1, indexOf(end)) - }.joinToString("\n").run { markdownToHTML(this) }, - ) - - // Get the latest available change notes from the changelog file - changeNotes.set( - provider { - changelog.run { - getOrNull(properties("pluginVersion")) ?: getLatest() - }.toHTML() - }, - ) - } - - runIde { - autoReloadPlugins.set(true) - } - - // Configure UI tests plugin - // Read more: https://github.com/JetBrains/intellij-ui-test-robot - runIdeForUiTests { - systemProperty("robot-server.port", "8082") - systemProperty("ide.mac.message.dialogs.as.sheets", "false") - systemProperty("jb.privacy.policy.text", "") - systemProperty("jb.consents.confirmation.enabled", "false") + gradleVersion = providers.gradleProperty("gradleVersion").get() } publishPlugin { - dependsOn("patchChangelog") - token.set(System.getenv("PUBLISH_TOKEN")) + dependsOn(patchChangelog) } test { useJUnitPlatform() } +} + +intellijPlatformTesting { + runIde { + register("runIdeForUiTests") { + task { + jvmArgumentProviders += CommandLineArgumentProvider { + listOf( + "-Drobot-server.port=8082", + "-Dide.mac.message.dialogs.as.sheets=false", + "-Djb.privacy.policy.text=", + "-Djb.consents.confirmation.enabled=false", + ) + } + } - runPluginVerifier { - ideVersions.set(properties("verifyVersions").split(",")) + plugins { + robotServerPlugin() + } + } } -} +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties index 25fd1805b..7327317ca 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,15 +2,13 @@ # -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html pluginGroup=com.coder.gateway # Zip file name. -pluginName=coder-gateway +artifactName=coder-gateway +pluginName=Coder # SemVer format -> https://semver.org -pluginVersion=2.15.1 +pluginVersion=2.20.0 # See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html # for insight into build numbers and IntelliJ Platform versions. -pluginSinceBuild=233.6745 -# This should be kept up to date with the latest EAP. If the API is incompatible -# with the latest stable, use the eap branch temporarily instead. -pluginUntilBuild=243.* +pluginSinceBuild=243.26053 # IntelliJ Platform Properties -> https://github.com/JetBrains/gradle-intellij-plugin#intellij-platform-properties # Gateway available build versions https://www.jetbrains.com/intellij-repository/snapshots and https://www.jetbrains.com/intellij-repository/releases # @@ -25,21 +23,23 @@ pluginUntilBuild=243.* # (for example if 233.14808-EAP-CANDIDATE-SNAPSHOT is missing then find a 233.* # that exists, ideally the most recent one, for example # 233.15325-EAP-CANDIDATE-SNAPSHOT). -platformType=GW -platformVersion=233.15619-EAP-CANDIDATE-SNAPSHOT -instrumentationCompiler=243.15521-EAP-CANDIDATE-SNAPSHOT +platformVersion=2024.3 # Gateway does not have open sources. platformDownloadSources=true -verifyVersions=2023.3,2024.1,2024.2,2024.3 +# available releases listed at: https://data.services.jetbrains.com/products?code=GW +verifyVersions=2024.3,2025.1 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html # Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22 platformPlugins= -# Java language level used to compile sources and to generate the files for - -# Java 17 is required since 2022.2 -javaVersion=17 +# Example: platformBundledPlugins = com.intellij.java +platformBundledPlugins = # Gradle Releases -> https://github.com/gradle/gradle/releases -gradleVersion=7.4 +gradleVersion=8.5 # Opt-out flag for bundling Kotlin standard library. # See https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library for details. # suppress inspection "UnusedProperty" kotlin.stdlib.default.dependency=true +# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html +org.gradle.configuration-cache = true +# Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html +org.gradle.caching = true \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 41d9927a4..d64cd4917 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 41dfb8790..1af9e0930 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 1b6c78733..1aa94a426 100755 --- a/gradlew +++ b/gradlew @@ -55,7 +55,7 @@ # Darwin, MinGW, and NonStop. # # (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt # within the Gradle project. # # You can find Gradle at https://github.com/gradle/gradle/. @@ -80,13 +80,11 @@ do esac done -APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit - -APP_NAME="Gradle" +# This is normally unused +# shellcheck disable=SC2034 APP_BASE_NAME=${0##*/} - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD=maximum @@ -133,22 +131,29 @@ location of your Java installation." fi else JAVACMD=java - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." + fi fi # Increase the maximum file descriptors if we can. if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then case $MAX_FD in #( max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 MAX_FD=$( ulimit -H -n ) || warn "Could not query maximum file descriptor limit" esac case $MAX_FD in #( '' | soft) :;; #( *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 ulimit -n "$MAX_FD" || warn "Could not set maximum file descriptor limit to $MAX_FD" esac @@ -193,11 +198,15 @@ if "$cygwin" || "$msys" ; then done fi -# Collect all arguments for the java command; -# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of -# shell script including quotes and variable substitutions, so put them in -# double quotes to make sure that they get re-expanded; and -# * put everything else in single quotes, so that it's not re-expanded. + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. set -- \ "-Dorg.gradle.appname=$APP_BASE_NAME" \ @@ -205,6 +214,12 @@ set -- \ org.gradle.wrapper.GradleWrapperMain \ "$@" +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + # Use "xargs" to parse quoted args. # # With -n1 it outputs one arg per line, with the quotes and backslashes removed. diff --git a/gradlew.bat b/gradlew.bat index 107acd32c..93e3f59f1 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -14,7 +14,7 @@ @rem limitations under the License. @rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +25,8 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,7 +41,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto execute +if %ERRORLEVEL% equ 0 goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 0 goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/src/main/kotlin/com/coder/gateway/CoderGatewayConstants.kt b/src/main/kotlin/com/coder/gateway/CoderGatewayConstants.kt index 6344aca68..1defb91d8 100644 --- a/src/main/kotlin/com/coder/gateway/CoderGatewayConstants.kt +++ b/src/main/kotlin/com/coder/gateway/CoderGatewayConstants.kt @@ -3,4 +3,5 @@ package com.coder.gateway object CoderGatewayConstants { const val GATEWAY_CONNECTOR_ID = "Coder.Gateway.Connector" const val GATEWAY_RECENT_CONNECTIONS_ID = "Coder.Gateway.Recent.Connections" + const val GATEWAY_SETUP_COMMAND_ERROR = "CODER_SETUP_ERROR" } diff --git a/src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt b/src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt index d71c5f791..790a2cd3a 100644 --- a/src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt +++ b/src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt @@ -2,6 +2,7 @@ package com.coder.gateway +import com.coder.gateway.CoderGatewayConstants.GATEWAY_SETUP_COMMAND_ERROR import com.coder.gateway.cli.CoderCLIManager import com.coder.gateway.models.WorkspaceProjectIDE import com.coder.gateway.models.toIdeWithStatus @@ -93,7 +94,7 @@ class CoderRemoteConnectionHandle { }, true, ) - if (attempt == 1) { + if (settings.checkIDEUpdate && attempt == 1) { // See if there is a newer (non-EAP) version of the IDE available. checkUpdate(accessor, parameters, indicator)?.let { update -> // Store the old IDE to delete later. @@ -160,25 +161,38 @@ class CoderRemoteConnectionHandle { ) logger.info("Adding ${parameters.ideName} for ${parameters.hostname}:${parameters.projectPath} to recent connections") recentConnectionsService.addRecentConnection(parameters.toRecentWorkspaceConnection()) + } catch (e: CoderSetupCommandException) { + logger.error("Failed to run setup command", e) + showConnectionErrorMessage( + e.message ?: "Unknown error", + "gateway.connector.coder.setup-command.failed", + ) } catch (e: Exception) { if (isCancellation(e)) { logger.info("Connection canceled due to ${e.javaClass.simpleName}") } else { logger.error("Failed to connect (will not retry)", e) - // The dialog will close once we return so write the error - // out into a new dialog. - ApplicationManager.getApplication().invokeAndWait { - Messages.showMessageDialog( - e.message ?: e.javaClass.simpleName ?: "Aborted", - CoderGatewayBundle.message("gateway.connector.coder.connection.failed"), - Messages.getErrorIcon(), - ) - } + showConnectionErrorMessage( + e.message ?: e.javaClass.simpleName ?: "Aborted", + "gateway.connector.coder.connection.failed" + ) } } } } + // The dialog will close once we return so write the error + // out into a new dialog. + private fun showConnectionErrorMessage(message: String, titleKey: String) { + ApplicationManager.getApplication().invokeAndWait { + Messages.showMessageDialog( + message, + CoderGatewayBundle.message(titleKey), + Messages.getErrorIcon(), + ) + } + } + /** * Return a new (non-EAP) IDE if we should update. */ @@ -412,18 +426,15 @@ class CoderRemoteConnectionHandle { ) { if (setupCommand.isNotBlank()) { indicator.text = "Running setup command..." - try { + processSetupCommand(ignoreSetupFailure) { exec(workspace, setupCommand) - } catch (ex: Exception) { - if (!ignoreSetupFailure) { - throw ex - } } } else { logger.info("No setup command to run on ${workspace.hostname}") } } + /** * Execute a command in the IDE's bin directory. * This exists since the accessor does not provide a generic exec. @@ -523,5 +534,26 @@ class CoderRemoteConnectionHandle { companion object { val logger = Logger.getInstance(CoderRemoteConnectionHandle::class.java.simpleName) + @Throws(CoderSetupCommandException::class) + fun processSetupCommand( + ignoreSetupFailure: Boolean, + execCommand: () -> String + ) { + try { + val errorText = execCommand + .invoke() + .lines() + .firstOrNull { it.contains(GATEWAY_SETUP_COMMAND_ERROR) } + ?.let { it.substring(it.indexOf(GATEWAY_SETUP_COMMAND_ERROR) + GATEWAY_SETUP_COMMAND_ERROR.length).trim() } + + if (!errorText.isNullOrBlank()) { + throw CoderSetupCommandException(errorText) + } + } catch (ex: Exception) { + if (!ignoreSetupFailure) { + throw CoderSetupCommandException(ex.message ?: "Unknown error", ex) + } + } + } } } diff --git a/src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt b/src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt index 5b69f39eb..18373983e 100644 --- a/src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt +++ b/src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt @@ -149,15 +149,29 @@ class CoderSettingsConfigurable : BoundConfigurable("Coder") { .bindText(state::workspaceFilter) .comment(CoderGatewayBundle.message("gateway.connector.settings.workspace-filter.comment")) }.layout(RowLayout.PARENT_GRID) + row(CoderGatewayBundle.message("gateway.connector.settings.default-ide")) { + textField().resizableColumn().align(AlignX.FILL) + .bindText(state::defaultIde) + .comment( + "The default IDE version to display in the IDE selection dropdown. " + + "Example format: CL 2023.3.6 233.15619.8", + ) + } + row(CoderGatewayBundle.message("gateway.connector.settings.check-ide-updates.heading")) { + checkBox(CoderGatewayBundle.message("gateway.connector.settings.check-ide-updates.title")) + .bindSelected(state::checkIDEUpdates) + .comment( + CoderGatewayBundle.message("gateway.connector.settings.check-ide-updates.comment"), + ) + }.layout(RowLayout.PARENT_GRID) } } - private fun validateDataDirectory(): ValidationInfoBuilder.(JBTextField) -> ValidationInfo? = - { - if (it.text.isNotBlank() && !Path.of(it.text).canCreateDirectory()) { - error("Cannot create this directory") - } else { - null - } + private fun validateDataDirectory(): ValidationInfoBuilder.(JBTextField) -> ValidationInfo? = { + if (it.text.isNotBlank() && !Path.of(it.text).canCreateDirectory()) { + error("Cannot create this directory") + } else { + null } + } } diff --git a/src/main/kotlin/com/coder/gateway/CoderSetupCommandException.kt b/src/main/kotlin/com/coder/gateway/CoderSetupCommandException.kt new file mode 100644 index 000000000..e43d92695 --- /dev/null +++ b/src/main/kotlin/com/coder/gateway/CoderSetupCommandException.kt @@ -0,0 +1,7 @@ +package com.coder.gateway + +class CoderSetupCommandException : Exception { + + constructor(message: String) : super(message) + constructor(message: String, cause: Throwable) : super(message, cause) +} \ No newline at end of file diff --git a/src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt b/src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt index ae1fd6a12..cc883a3bc 100644 --- a/src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt +++ b/src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt @@ -115,6 +115,7 @@ fun ensureCLI( data class Features( val disableAutostart: Boolean = false, val reportWorkspaceUsage: Boolean = false, + val wildcardSSH: Boolean = false, ) /** @@ -256,7 +257,6 @@ class CoderCLIManager( val host = deploymentURL.safeHost() val startBlock = "# --- START CODER JETBRAINS $host" val endBlock = "# --- END CODER JETBRAINS $host" - val isRemoving = workspaceNames.isEmpty() val baseArgs = listOfNotNull( escape(localBinaryPath.toString()), @@ -285,37 +285,58 @@ class CoderCLIManager( } else { "" } + val sshOpts = """ + ConnectTimeout 0 + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + LogLevel ERROR + SetEnv CODER_SSH_SESSION_TYPE=JetBrains + """.trimIndent() val blockContent = - workspaceNames.joinToString( - System.lineSeparator(), - startBlock + System.lineSeparator(), - System.lineSeparator() + endBlock, - transform = { + if (feats.wildcardSSH) { + startBlock + System.lineSeparator() + """ - Host ${getHostName(deploymentURL, it.first, currentUser, it.second)} - ProxyCommand ${proxyArgs.joinToString(" ")} ${getWorkspaceParts(it.first, it.second)} - ConnectTimeout 0 - StrictHostKeyChecking no - UserKnownHostsFile /dev/null - LogLevel ERROR - SetEnv CODER_SSH_SESSION_TYPE=JetBrains + Host ${getHostPrefix()}--* + ProxyCommand ${proxyArgs.joinToString(" ")} --ssh-host-prefix ${getHostPrefix()}-- %h """.trimIndent() + .plus("\n" + sshOpts.prependIndent(" ")) .plus(extraConfig) - .plus("\n") + .plus("\n\n") .plus( """ - Host ${getBackgroundHostName(deploymentURL, it.first, currentUser, it.second)} - ProxyCommand ${backgroundProxyArgs.joinToString(" ")} ${getWorkspaceParts(it.first, it.second)} - ConnectTimeout 0 - StrictHostKeyChecking no - UserKnownHostsFile /dev/null - LogLevel ERROR - SetEnv CODER_SSH_SESSION_TYPE=JetBrains + Host ${getHostPrefix()}-bg--* + ProxyCommand ${backgroundProxyArgs.joinToString(" ")} --ssh-host-prefix ${getHostPrefix()}-bg-- %h """.trimIndent() + .plus("\n" + sshOpts.prependIndent(" ")) .plus(extraConfig), - ).replace("\n", System.lineSeparator()) - }, - ) + ).replace("\n", System.lineSeparator()) + + System.lineSeparator() + endBlock + } else if (workspaceNames.isEmpty()) { + "" + } else { + workspaceNames.joinToString( + System.lineSeparator(), + startBlock + System.lineSeparator(), + System.lineSeparator() + endBlock, + transform = { + """ + Host ${getHostName(it.first, currentUser, it.second)} + ProxyCommand ${proxyArgs.joinToString(" ")} ${getWorkspaceParts(it.first, it.second)} + """.trimIndent() + .plus("\n" + sshOpts.prependIndent(" ")) + .plus(extraConfig) + .plus("\n") + .plus( + """ + Host ${getBackgroundHostName(it.first, currentUser, it.second)} + ProxyCommand ${backgroundProxyArgs.joinToString(" ")} ${getWorkspaceParts(it.first, it.second)} + """.trimIndent() + .plus("\n" + sshOpts.prependIndent(" ")) + .plus(extraConfig), + ).replace("\n", System.lineSeparator()) + }, + ) + } if (contents == null) { logger.info("No existing SSH config to modify") @@ -325,6 +346,8 @@ class CoderCLIManager( val start = "(\\s*)$startBlock".toRegex().find(contents) val end = "$endBlock(\\s*)".toRegex().find(contents) + val isRemoving = blockContent.isEmpty() + if (start == null && end == null && isRemoving) { logger.info("No workspaces and no existing config blocks to remove") return null @@ -451,6 +474,19 @@ class CoderCLIManager( return matches } + /** + * Start a workspace. + * + * Throws if the command execution fails. + */ + fun startWorkspace(workspaceOwner: String, workspaceName: String): String = exec( + "--global-config", + coderConfigPath.toString(), + "start", + "--yes", + workspaceOwner + "/" + workspaceName, + ) + private fun exec(vararg args: String): String { val stdout = ProcessExecutor() @@ -474,40 +510,50 @@ class CoderCLIManager( Features( disableAutostart = version >= SemVer(2, 5, 0), reportWorkspaceUsage = version >= SemVer(2, 13, 0), + wildcardSSH = version >= SemVer(2, 19, 0), ) } } + /* + * This function returns the ssh-host-prefix used for Host entries. + */ + fun getHostPrefix(): String = "coder-jetbrains-${deploymentURL.safeHost()}" + + /** + * This function returns the ssh host name generated for connecting to the workspace. + */ + fun getHostName( + workspace: Workspace, + currentUser: User, + agent: WorkspaceAgent, + ): String = if (features.wildcardSSH) { + "${getHostPrefix()}--${workspace.ownerName}--${workspace.name}.${agent.name}" + } else { + // For a user's own workspace, we use the old syntax without a username for backwards compatibility, + // since the user might have recent connections that still use the old syntax. + if (currentUser.username == workspace.ownerName) { + "coder-jetbrains--${workspace.name}.${agent.name}--${deploymentURL.safeHost()}" + } else { + "coder-jetbrains--${workspace.ownerName}--${workspace.name}.${agent.name}--${deploymentURL.safeHost()}" + } + } + + fun getBackgroundHostName( + workspace: Workspace, + currentUser: User, + agent: WorkspaceAgent, + ): String = if (features.wildcardSSH) { + "${getHostPrefix()}-bg--${workspace.ownerName}--${workspace.name}.${agent.name}" + } else { + getHostName(workspace, currentUser, agent) + "--bg" + } + companion object { val logger = Logger.getInstance(CoderCLIManager::class.java.simpleName) private val tokenRegex = "--token [^ ]+".toRegex() - /** - * This function returns the ssh host name generated for connecting to the workspace. - */ - @JvmStatic - fun getHostName( - url: URL, - workspace: Workspace, - currentUser: User, - agent: WorkspaceAgent, - ): String = - // For a user's own workspace, we use the old syntax without a username for backwards compatibility, - // since the user might have recent connections that still use the old syntax. - if (currentUser.username == workspace.ownerName) { - "coder-jetbrains--${workspace.name}.${agent.name}--${url.safeHost()}" - } else { - "coder-jetbrains--${workspace.ownerName}--${workspace.name}.${agent.name}--${url.safeHost()}" - } - - fun getBackgroundHostName( - url: URL, - workspace: Workspace, - currentUser: User, - agent: WorkspaceAgent, - ): String = getHostName(url, workspace, currentUser, agent) + "--bg" - /** * This function returns the identifier for the workspace to pass to the * coder ssh proxy command. @@ -521,6 +567,18 @@ class CoderCLIManager( @JvmStatic fun getBackgroundHostName( hostname: String, - ): String = hostname + "--bg" + ): String { + val parts = hostname.split("--").toMutableList() + if (parts.size < 2) { + throw SSHConfigFormatException("Invalid hostname: $hostname") + } + // non-wildcard case + if (parts[0] == "coder-jetbrains") { + return hostname + "--bg" + } + // wildcard case + parts[0] += "-bg" + return parts.joinToString("--") + } } } diff --git a/src/main/kotlin/com/coder/gateway/help/CoderWebHelp.kt b/src/main/kotlin/com/coder/gateway/help/CoderWebHelp.kt index 3f512ff3b..b441cbd10 100644 --- a/src/main/kotlin/com/coder/gateway/help/CoderWebHelp.kt +++ b/src/main/kotlin/com/coder/gateway/help/CoderWebHelp.kt @@ -6,7 +6,7 @@ const val ABOUT_HELP_TOPIC = "com.coder.gateway.about" class CoderWebHelp : WebHelpProvider() { override fun getHelpPageUrl(helpTopicId: String): String = when (helpTopicId) { - ABOUT_HELP_TOPIC -> "https://coder.com/docs/coder-oss/latest" - else -> "https://coder.com/docs/coder-oss/latest" + ABOUT_HELP_TOPIC -> "https://coder.com/docs" + else -> "https://coder.com/docs" } } diff --git a/src/main/kotlin/com/coder/gateway/icons/CoderIcons.kt b/src/main/kotlin/com/coder/gateway/icons/CoderIcons.kt index 9026af526..3011e633c 100644 --- a/src/main/kotlin/com/coder/gateway/icons/CoderIcons.kt +++ b/src/main/kotlin/com/coder/gateway/icons/CoderIcons.kt @@ -63,48 +63,47 @@ object CoderIcons { private val Y = IconLoader.getIcon("symbols/y.svg", javaClass) private val Z = IconLoader.getIcon("symbols/z.svg", javaClass) - fun fromChar(c: Char) = - when (c) { - '0' -> ZERO - '1' -> ONE - '2' -> TWO - '3' -> THREE - '4' -> FOUR - '5' -> FIVE - '6' -> SIX - '7' -> SEVEN - '8' -> EIGHT - '9' -> NINE - - 'a' -> A - 'b' -> B - 'c' -> C - 'd' -> D - 'e' -> E - 'f' -> F - 'g' -> G - 'h' -> H - 'i' -> I - 'j' -> J - 'k' -> K - 'l' -> L - 'm' -> M - 'n' -> N - 'o' -> O - 'p' -> P - 'q' -> Q - 'r' -> R - 's' -> S - 't' -> T - 'u' -> U - 'v' -> V - 'w' -> W - 'x' -> X - 'y' -> Y - 'z' -> Z - - else -> UNKNOWN - } + fun fromChar(c: Char) = when (c) { + '0' -> ZERO + '1' -> ONE + '2' -> TWO + '3' -> THREE + '4' -> FOUR + '5' -> FIVE + '6' -> SIX + '7' -> SEVEN + '8' -> EIGHT + '9' -> NINE + + 'a' -> A + 'b' -> B + 'c' -> C + 'd' -> D + 'e' -> E + 'f' -> F + 'g' -> G + 'h' -> H + 'i' -> I + 'j' -> J + 'k' -> K + 'l' -> L + 'm' -> M + 'n' -> N + 'o' -> O + 'p' -> P + 'q' -> Q + 'r' -> R + 's' -> S + 't' -> T + 'u' -> U + 'v' -> V + 'w' -> W + 'x' -> X + 'y' -> Y + 'z' -> Z + + else -> UNKNOWN + } } fun alignToInt(g: Graphics) { diff --git a/src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt b/src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt index cbf331d95..601a02b90 100644 --- a/src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt +++ b/src/main/kotlin/com/coder/gateway/models/WorkspaceAndAgentStatus.kt @@ -47,13 +47,12 @@ enum class WorkspaceAndAgentStatus(val label: String, val description: String) { READY("Ready", "The agent is ready to accept connections."), ; - fun statusColor(): JBColor = - when (this) { - READY, AGENT_STARTING_READY, START_TIMEOUT_READY -> JBColor.GREEN - CREATED, START_ERROR, START_TIMEOUT, SHUTDOWN_TIMEOUT -> JBColor.YELLOW - FAILED, DISCONNECTED, TIMEOUT, SHUTDOWN_ERROR -> JBColor.RED - else -> if (JBColor.isBright()) JBColor.LIGHT_GRAY else JBColor.DARK_GRAY - } + fun statusColor(): JBColor = when (this) { + READY, AGENT_STARTING_READY, START_TIMEOUT_READY -> JBColor.GREEN + CREATED, START_ERROR, START_TIMEOUT, SHUTDOWN_TIMEOUT -> JBColor.YELLOW + FAILED, DISCONNECTED, TIMEOUT, SHUTDOWN_ERROR -> JBColor.RED + else -> if (JBColor.isBright()) JBColor.LIGHT_GRAY else JBColor.DARK_GRAY + } /** * Return true if the agent is in a connectable state. diff --git a/src/main/kotlin/com/coder/gateway/models/WorkspaceProjectIDE.kt b/src/main/kotlin/com/coder/gateway/models/WorkspaceProjectIDE.kt index 3b2055540..287f1bd4d 100644 --- a/src/main/kotlin/com/coder/gateway/models/WorkspaceProjectIDE.kt +++ b/src/main/kotlin/com/coder/gateway/models/WorkspaceProjectIDE.kt @@ -6,11 +6,14 @@ import com.jetbrains.gateway.ssh.IdeStatus import com.jetbrains.gateway.ssh.IdeWithStatus import com.jetbrains.gateway.ssh.InstalledIdeUIEx import com.jetbrains.gateway.ssh.IntelliJPlatformProduct +import com.jetbrains.gateway.ssh.ReleaseType import com.jetbrains.gateway.ssh.deploy.ShellArgument import java.net.URL import java.nio.file.Path import kotlin.io.path.name +private val NON_STABLE_RELEASE_TYPES = setOf("EAP", "RC", "NIGHTLY", "PREVIEW") + /** * Validated parameters for downloading and opening a project using an IDE on a * workspace. @@ -101,7 +104,8 @@ class WorkspaceProjectIDE( name = name, hostname = hostname, projectPath = projectPath, - ideProduct = IntelliJPlatformProduct.fromProductCode(ideProductCode) ?: throw Exception("invalid product code"), + ideProduct = IntelliJPlatformProduct.fromProductCode(ideProductCode) + ?: throw Exception("invalid product code"), ideBuildNumber = ideBuildNumber, idePathOnHost = idePathOnHost, downloadSource = downloadSource, @@ -126,13 +130,13 @@ fun RecentWorkspaceConnection.toWorkspaceProjectIDE(): WorkspaceProjectIDE { // connections page, so it could be missing. Try to get it from the // host name. name = - if (name.isNullOrBlank() && !hostname.isNullOrBlank()) { - hostname - .removePrefix("coder-jetbrains--") - .removeSuffix("--${hostname.split("--").last()}") - } else { - name - }, + if (name.isNullOrBlank() && !hostname.isNullOrBlank()) { + hostname + .removePrefix("coder-jetbrains--") + .removeSuffix("--${hostname.split("--").last()}") + } else { + name + }, hostname = hostname, projectPath = projectPath, ideProductCode = ideProductCode, @@ -146,17 +150,17 @@ fun RecentWorkspaceConnection.toWorkspaceProjectIDE(): WorkspaceProjectIDE { // the config directory). For backwards compatibility with existing // entries, extract the URL from the config directory or host name. deploymentURL = - if (deploymentURL.isNullOrBlank()) { - if (!dir.isNullOrBlank()) { - "https://${Path.of(dir).parent.name}" - } else if (!hostname.isNullOrBlank()) { - "https://${hostname.split("--").last()}" + if (deploymentURL.isNullOrBlank()) { + if (!dir.isNullOrBlank()) { + "https://${Path.of(dir).parent.name}" + } else if (!hostname.isNullOrBlank()) { + "https://${hostname.split("--").last()}" + } else { + deploymentURL + } } else { deploymentURL - } - } else { - deploymentURL - }, + }, lastOpened = lastOpened, ) } @@ -195,6 +199,39 @@ fun AvailableIde.toIdeWithStatus(): IdeWithStatus = IdeWithStatus( remoteDevType = remoteDevType, ) +/** + * Returns a list of installed IDEs that don't have a RELEASED version available for download. + * Typically, installed EAP, RC, nightly or preview builds should be superseded by released versions. + */ +fun List.filterOutAvailableReleasedIdes(availableIde: List): List { + val availableReleasedByProductCode = availableIde + .filter { it.releaseType == ReleaseType.RELEASE } + .groupBy { it.product.productCode } + val result = mutableListOf() + + this.forEach { installedIde -> + // installed IDEs have the release type embedded in the presentable version + // which is a string in the form: 2024.2.4 NIGHTLY + if (NON_STABLE_RELEASE_TYPES.any { it in installedIde.presentableVersion }) { + // we can show the installed IDe if there isn't a higher released version available for download + if (installedIde.isSNotSupersededBy(availableReleasedByProductCode[installedIde.product.productCode])) { + result.add(installedIde) + } + } else { + result.add(installedIde) + } + } + + return result +} + +private fun InstalledIdeUIEx.isSNotSupersededBy(availableIdes: List?): Boolean { + if (availableIdes.isNullOrEmpty()) { + return true + } + return !availableIdes.any { it.buildNumber >= this.buildNumber } +} + /** * Convert an installed IDE to an IDE with status. */ diff --git a/src/main/kotlin/com/coder/gateway/sdk/CoderRestClient.kt b/src/main/kotlin/com/coder/gateway/sdk/CoderRestClient.kt index 9108ed610..71c6e1baf 100644 --- a/src/main/kotlin/com/coder/gateway/sdk/CoderRestClient.kt +++ b/src/main/kotlin/com/coder/gateway/sdk/CoderRestClient.kt @@ -176,6 +176,19 @@ open class CoderRestClient( return workspacesResponse.body()!!.workspaces } + /** + * Retrieves a specific workspace by owner and name. + * @throws [APIResponseException]. + */ + fun workspaceByOwnerAndName(owner: String, workspaceName: String): Workspace { + val workspaceResponse = retroRestClient.workspaceByOwnerAndName(owner, workspaceName).execute() + if (!workspaceResponse.isSuccessful) { + throw APIResponseException("retrieve workspace", url, workspaceResponse) + } + + return workspaceResponse.body()!! + } + /** * Retrieves all the agent names for all workspaces, including those that * are off. Meant to be used when configuring SSH. @@ -227,18 +240,6 @@ open class CoderRestClient( return templateResponse.body()!! } - /** - * @throws [APIResponseException]. - */ - fun startWorkspace(workspace: Workspace): WorkspaceBuild { - val buildRequest = CreateWorkspaceBuildRequest(null, WorkspaceTransition.START) - val buildResponse = retroRestClient.createWorkspaceBuild(workspace.id, buildRequest).execute() - if (buildResponse.code() != HttpURLConnection.HTTP_CREATED) { - throw APIResponseException("start workspace ${workspace.name}", url, buildResponse) - } - return buildResponse.body()!! - } - /** * @throws [APIResponseException]. */ diff --git a/src/main/kotlin/com/coder/gateway/sdk/convertors/InstantConverter.kt b/src/main/kotlin/com/coder/gateway/sdk/convertors/InstantConverter.kt index 10f700e04..a1a9f0850 100644 --- a/src/main/kotlin/com/coder/gateway/sdk/convertors/InstantConverter.kt +++ b/src/main/kotlin/com/coder/gateway/sdk/convertors/InstantConverter.kt @@ -12,10 +12,9 @@ import java.time.temporal.TemporalAccessor class InstantConverter { @ToJson fun toJson(src: Instant?): String = FORMATTER.format(src) - @FromJson fun fromJson(src: String): Instant? = - FORMATTER.parse(src) { temporal: TemporalAccessor? -> - Instant.from(temporal) - } + @FromJson fun fromJson(src: String): Instant? = FORMATTER.parse(src) { temporal: TemporalAccessor? -> + Instant.from(temporal) + } companion object { private val FORMATTER = DateTimeFormatter.ISO_INSTANT diff --git a/src/main/kotlin/com/coder/gateway/sdk/v2/CoderV2RestFacade.kt b/src/main/kotlin/com/coder/gateway/sdk/v2/CoderV2RestFacade.kt index b610a3147..81976ed89 100644 --- a/src/main/kotlin/com/coder/gateway/sdk/v2/CoderV2RestFacade.kt +++ b/src/main/kotlin/com/coder/gateway/sdk/v2/CoderV2RestFacade.kt @@ -4,6 +4,7 @@ import com.coder.gateway.sdk.v2.models.BuildInfo import com.coder.gateway.sdk.v2.models.CreateWorkspaceBuildRequest import com.coder.gateway.sdk.v2.models.Template import com.coder.gateway.sdk.v2.models.User +import com.coder.gateway.sdk.v2.models.Workspace import com.coder.gateway.sdk.v2.models.WorkspaceBuild import com.coder.gateway.sdk.v2.models.WorkspaceResource import com.coder.gateway.sdk.v2.models.WorkspacesResponse @@ -22,6 +23,15 @@ interface CoderV2RestFacade { @GET("api/v2/users/me") fun me(): Call + /** + * Retrieves a specific workspace by owner and name. + */ + @GET("api/v2/users/{user}/workspace/{workspace}") + fun workspaceByOwnerAndName( + @Path("user") user: String, + @Path("workspace") workspace: String, + ): Call + /** * Retrieves all workspaces the authenticated user has access to. */ diff --git a/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt b/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt index 4a33a091d..aa46ba574 100644 --- a/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt +++ b/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt @@ -100,6 +100,10 @@ open class CoderSettingsState( open var sshLogDirectory: String = "", // Default filter for fetching workspaces open var workspaceFilter: String = "owner:me", + // Default version of IDE to display in IDE selection dropdown + open var defaultIde: String = "", + // Whether to check for IDE updates. + open var checkIDEUpdates: Boolean = true, ) /** @@ -174,6 +178,18 @@ open class CoderSettings( val setupCommand: String get() = state.setupCommand + /** + * The default IDE version to display in the selection menu + */ + val defaultIde: String + get() = state.defaultIde + + /** + * Whether to check for IDE updates. + */ + val checkIDEUpdate: Boolean + get() = state.checkIDEUpdates + /** * Whether to ignore a failed setup command. */ diff --git a/src/main/kotlin/com/coder/gateway/util/Dialogs.kt b/src/main/kotlin/com/coder/gateway/util/Dialogs.kt index 0e360363e..f35f1e86e 100644 --- a/src/main/kotlin/com/coder/gateway/util/Dialogs.kt +++ b/src/main/kotlin/com/coder/gateway/util/Dialogs.kt @@ -38,7 +38,10 @@ private class CoderWorkspaceStepDialog( init { init() - title = CoderGatewayBundle.message("gateway.connector.view.coder.remoteproject.choose.text", CoderCLIManager.getWorkspaceParts(state.workspace, state.agent)) + title = CoderGatewayBundle.message( + "gateway.connector.view.coder.remoteproject.choose.text", + CoderCLIManager.getWorkspaceParts(state.workspace, state.agent) + ) } override fun show() { @@ -75,12 +78,13 @@ fun askIDE( cli: CoderCLIManager, client: CoderRestClient, workspaces: List, + remoteProjectPath: String? = null ): WorkspaceProjectIDE? { var data: WorkspaceProjectIDE? = null ApplicationManager.getApplication().invokeAndWait { val dialog = CoderWorkspaceStepDialog( - CoderWorkspacesStepSelection(agent, workspace, cli, client, workspaces), + CoderWorkspacesStepSelection(agent, workspace, cli, client, workspaces, remoteProjectPath), ) data = dialog.showAndGetData() } diff --git a/src/main/kotlin/com/coder/gateway/util/Error.kt b/src/main/kotlin/com/coder/gateway/util/Error.kt index 86bd84ba6..b9eff82e9 100644 --- a/src/main/kotlin/com/coder/gateway/util/Error.kt +++ b/src/main/kotlin/com/coder/gateway/util/Error.kt @@ -28,7 +28,7 @@ fun humanizeConnectionError(deploymentURL: URL, requireTokenAuth: Boolean, e: Ex } is SocketTimeoutException -> "Unable to connect to $deploymentURL; is it up?" is ResponseException, is ConnectException -> "Failed to download Coder CLI: $reason" - is SSLHandshakeException -> "Connection to $deploymentURL failed: $reason. See the documentation for TLS certificates for information on how to make your system trust certificates coming from your deployment." + is SSLHandshakeException -> "Connection to $deploymentURL failed: $reason. See the documentation for TLS certificates for information on how to make your system trust certificates coming from your deployment." else -> reason } } diff --git a/src/main/kotlin/com/coder/gateway/util/LinkHandler.kt b/src/main/kotlin/com/coder/gateway/util/LinkHandler.kt index 22c0e3b3a..f802109cc 100644 --- a/src/main/kotlin/com/coder/gateway/util/LinkHandler.kt +++ b/src/main/kotlin/com/coder/gateway/util/LinkHandler.kt @@ -32,7 +32,8 @@ open class LinkHandler( parameters: Map, indicator: ((t: String) -> Unit)? = null, ): WorkspaceProjectIDE { - val deploymentURL = parameters.url() ?: dialogUi.ask("Deployment URL", "Enter the full URL of your Coder deployment") + val deploymentURL = + parameters.url() ?: dialogUi.ask("Deployment URL", "Enter the full URL of your Coder deployment") if (deploymentURL.isNullOrBlank()) { throw MissingArgumentException("Query parameter \"$URL\" is missing") } @@ -50,36 +51,62 @@ open class LinkHandler( } // TODO: Show a dropdown and ask for the workspace if missing. - val workspaceName = parameters.workspace() ?: throw MissingArgumentException("Query parameter \"$WORKSPACE\" is missing") + val workspaceName = + parameters.workspace() ?: throw MissingArgumentException("Query parameter \"$WORKSPACE\" is missing") // The owner was added to support getting into another user's workspace // but may not exist if the Coder Gateway module is out of date. If no // owner is included, assume the current user. val owner = (parameters.owner() ?: client.me.username).ifBlank { client.me.username } - val workspaces = client.workspaces() - val workspace = - workspaces.firstOrNull { - it.ownerName == owner && it.name == workspaceName - } ?: throw IllegalArgumentException("The workspace $workspaceName does not exist") + val cli = + ensureCLI( + deploymentURL.toURL(), + client.buildInfo().version, + settings, + indicator, + ) + + var workspace: Workspace + var workspaces: List = emptyList() + var workspacesAndAgents: Set> = emptySet() + if (cli.features.wildcardSSH) { + workspace = client.workspaceByOwnerAndName(owner, workspaceName) + } else { + workspaces = client.workspaces() + workspace = + workspaces.firstOrNull { + it.ownerName == owner && it.name == workspaceName + } ?: throw IllegalArgumentException("The workspace $workspaceName does not exist") + workspacesAndAgents = client.withAgents(workspaces) + } when (workspace.latestBuild.status) { WorkspaceStatus.PENDING, WorkspaceStatus.STARTING -> // TODO: Wait for the workspace to turn on. throw IllegalArgumentException( - "The workspace \"$workspaceName\" is ${workspace.latestBuild.status.toString().lowercase()}; please wait then try again", + "The workspace \"$workspaceName\" is ${ + workspace.latestBuild.status.toString().lowercase() + }; please wait then try again", ) + WorkspaceStatus.STOPPING, WorkspaceStatus.STOPPED, WorkspaceStatus.CANCELING, WorkspaceStatus.CANCELED, - -> + -> // TODO: Turn on the workspace. throw IllegalArgumentException( - "The workspace \"$workspaceName\" is ${workspace.latestBuild.status.toString().lowercase()}; please start the workspace and try again", + "The workspace \"$workspaceName\" is ${ + workspace.latestBuild.status.toString().lowercase() + }; please start the workspace and try again", ) + WorkspaceStatus.FAILED, WorkspaceStatus.DELETING, WorkspaceStatus.DELETED -> throw IllegalArgumentException( - "The workspace \"$workspaceName\" is ${workspace.latestBuild.status.toString().lowercase()}; unable to connect", + "The workspace \"$workspaceName\" is ${ + workspace.latestBuild.status.toString().lowercase() + }; unable to connect", ) + WorkspaceStatus.RUNNING -> Unit // All is well } @@ -90,19 +117,17 @@ open class LinkHandler( if (status.pending()) { // TODO: Wait for the agent to be ready. throw IllegalArgumentException( - "The agent \"${agent.name}\" has a status of \"${status.toString().lowercase()}\"; please wait then try again", + "The agent \"${agent.name}\" has a status of \"${ + status.toString().lowercase() + }\"; please wait then try again", ) } else if (!status.ready()) { - throw IllegalArgumentException("The agent \"${agent.name}\" has a status of \"${status.toString().lowercase()}\"; unable to connect") - } - - val cli = - ensureCLI( - deploymentURL.toURL(), - client.buildInfo().version, - settings, - indicator, + throw IllegalArgumentException( + "The agent \"${agent.name}\" has a status of \"${ + status.toString().lowercase() + }\"; unable to connect" ) + } // We only need to log in if we are using token-based auth. if (client.token != null) { @@ -111,23 +136,24 @@ open class LinkHandler( } indicator?.invoke("Configuring Coder CLI...") - cli.configSsh(workspacesAndAgents = client.withAgents(workspaces), currentUser = client.me) + cli.configSsh(workspacesAndAgents, currentUser = client.me) val openDialog = parameters.ideProductCode().isNullOrBlank() || - parameters.ideBuildNumber().isNullOrBlank() || - (parameters.idePathOnHost().isNullOrBlank() && parameters.ideDownloadLink().isNullOrBlank()) || - parameters.folder().isNullOrBlank() + parameters.ideBuildNumber().isNullOrBlank() || + (parameters.idePathOnHost().isNullOrBlank() && parameters.ideDownloadLink().isNullOrBlank()) || + parameters.folder().isNullOrBlank() return if (openDialog) { - askIDE(agent, workspace, cli, client, workspaces) ?: throw MissingArgumentException("IDE selection aborted; unable to connect") + askIDE(agent, workspace, cli, client, workspaces, parameters.folder()) + ?: throw MissingArgumentException("IDE selection aborted; unable to connect") } else { // Check that both the domain and the redirected domain are // allowlisted. If not, check with the user whether to proceed. verifyDownloadLink(parameters) WorkspaceProjectIDE.fromInputs( name = CoderCLIManager.getWorkspaceParts(workspace, agent), - hostname = CoderCLIManager.getHostName(deploymentURL.toURL(), workspace, client.me, agent), + hostname = CoderCLIManager(deploymentURL.toURL(), settings).getHostName(workspace, client.me, agent), projectPath = parameters.folder(), ideProductCode = parameters.ideProductCode(), ideBuildNumber = parameters.ideBuildNumber(), @@ -251,7 +277,7 @@ private fun isAllowlisted(url: URL): Triple { val allowlisted = domainAllowlist.any { url.host == it || url.host.endsWith(".$it") } && - domainAllowlist.any { finalUrl.host == it || finalUrl.host.endsWith(".$it") } + domainAllowlist.any { finalUrl.host == it || finalUrl.host.endsWith(".$it") } val https = url.protocol == "https" && finalUrl.protocol == "https" return Triple(allowlisted, https, linkWithRedirect) } diff --git a/src/main/kotlin/com/coder/gateway/views/CoderGatewayRecentWorkspaceConnectionsView.kt b/src/main/kotlin/com/coder/gateway/views/CoderGatewayRecentWorkspaceConnectionsView.kt index 027f291ea..ded8edfad 100644 --- a/src/main/kotlin/com/coder/gateway/views/CoderGatewayRecentWorkspaceConnectionsView.kt +++ b/src/main/kotlin/com/coder/gateway/views/CoderGatewayRecentWorkspaceConnectionsView.kt @@ -5,6 +5,8 @@ package com.coder.gateway.views import com.coder.gateway.CoderGatewayBundle import com.coder.gateway.CoderGatewayConstants import com.coder.gateway.CoderRemoteConnectionHandle +import com.coder.gateway.cli.CoderCLIManager +import com.coder.gateway.cli.ensureCLI import com.coder.gateway.icons.CoderIcons import com.coder.gateway.models.WorkspaceAgentListModel import com.coder.gateway.models.WorkspaceProjectIDE @@ -73,6 +75,8 @@ data class DeploymentInfo( var items: List? = null, // Null if there have not been any errors yet. var error: String? = null, + // Null if unable to ensure the CLI is downloaded. + var cli: CoderCLIManager? = null, ) class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback: (Component) -> Unit) : @@ -232,10 +236,10 @@ class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback: if (enableLinks) { cell( ActionLink(workspaceProjectIDE.projectPathDisplay) { - withoutNull(deployment?.client, workspaceWithAgent?.workspace) { client, workspace -> + withoutNull(deployment?.cli, workspaceWithAgent?.workspace) { cli, workspace -> CoderRemoteConnectionHandle().connect { if (listOf(WorkspaceStatus.STOPPED, WorkspaceStatus.CANCELED, WorkspaceStatus.FAILED).contains(workspace.latestBuild.status)) { - client.startWorkspace(workspace) + cli.startWorkspace(workspace.ownerName, workspace.name) } workspaceProjectIDE } @@ -358,6 +362,19 @@ class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback: throw Exception("Unable to make request; token was not found in CLI config.") } + val cli = ensureCLI( + deploymentURL.toURL(), + client.buildInfo().version, + settings, + ) + + // We only need to log the cli in if we have token-based auth. + // Otherwise, we assume it is set up in the same way the plugin + // is with mTLS. + if (client.token != null) { + cli.login(client.token) + } + // This is purely to populate the current user, which is // used to match workspaces that were not recorded with owner // information. @@ -378,6 +395,7 @@ class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback: } deployment.client = client + deployment.cli = cli deployment.items = items deployment.error = null } catch (e: Exception) { diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspaceProjectIDEStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspaceProjectIDEStepView.kt index 8478e3558..81f02b2a5 100644 --- a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspaceProjectIDEStepView.kt +++ b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspaceProjectIDEStepView.kt @@ -4,10 +4,12 @@ import com.coder.gateway.CoderGatewayBundle import com.coder.gateway.cli.CoderCLIManager import com.coder.gateway.icons.CoderIcons import com.coder.gateway.models.WorkspaceProjectIDE +import com.coder.gateway.models.filterOutAvailableReleasedIdes import com.coder.gateway.models.toIdeWithStatus import com.coder.gateway.models.withWorkspaceProject import com.coder.gateway.sdk.v2.models.Workspace import com.coder.gateway.sdk.v2.models.WorkspaceAgent +import com.coder.gateway.services.CoderSettingsService import com.coder.gateway.util.Arch import com.coder.gateway.util.OS import com.coder.gateway.util.humanizeDuration @@ -20,6 +22,7 @@ import com.coder.gateway.views.LazyBrowserLink import com.intellij.openapi.application.ApplicationManager import com.intellij.openapi.application.ModalityState import com.intellij.openapi.application.asContextElement +import com.intellij.openapi.components.service import com.intellij.openapi.diagnostic.Logger import com.intellij.openapi.ui.ComboBox import com.intellij.openapi.ui.ComponentValidator @@ -79,15 +82,25 @@ import javax.swing.ListCellRenderer import javax.swing.SwingConstants import javax.swing.event.DocumentEvent +// Just extracting the way we display the IDE info into a helper function. +private fun displayIdeWithStatus(ideWithStatus: IdeWithStatus): String = + "${ideWithStatus.product.productCode} ${ideWithStatus.presentableVersion} ${ideWithStatus.buildNumber} | ${ + ideWithStatus.status.name.lowercase( + Locale.getDefault(), + ) + }" + /** * View for a single workspace. In particular, show available IDEs and a button * to select an IDE and project to run on the workspace. */ class CoderWorkspaceProjectIDEStepView( - private val showTitle: Boolean = true, + private val showTitle: Boolean = true ) : CoderWizardStep( CoderGatewayBundle.message("gateway.connector.view.coder.remoteproject.next.text"), ) { + private val settings: CoderSettingsService = service() + private val cs = CoroutineScope(Dispatchers.IO) private var ideComboBoxModel = DefaultComboBoxModel() private var state: CoderWorkspacesStepSelection? = null @@ -187,7 +200,9 @@ class CoderWorkspaceProjectIDEStepView( val name = CoderCLIManager.getWorkspaceParts(data.workspace, data.agent) logger.info("Initializing workspace step for $name") - val homeDirectory = data.agent.expandedDirectory ?: data.agent.directory + val homeDirectory = data.remoteProjectPath.takeIf { !it.isNullOrBlank() } + ?: data.agent.expandedDirectory + ?: data.agent.directory tfProject.text = if (homeDirectory.isNullOrBlank()) "/home" else homeDirectory titleLabel.text = CoderGatewayBundle.message("gateway.connector.view.coder.remoteproject.choose.text", name) titleLabel.isVisible = showTitle @@ -199,7 +214,11 @@ class CoderWorkspaceProjectIDEStepView( logger.info("Configuring Coder CLI...") cbIDE.renderer = IDECellRenderer("Configuring Coder CLI...") withContext(Dispatchers.IO) { - data.cliManager.configSsh(data.client.withAgents(data.workspaces), data.client.me) + if (data.cliManager.features.wildcardSSH) { + data.cliManager.configSsh(emptySet(), data.client.me) + } else { + data.cliManager.configSsh(data.client.withAgents(data.workspaces), data.client.me) + } } val ides = @@ -209,12 +228,21 @@ class CoderWorkspaceProjectIDEStepView( cbIDE.renderer = if (attempt > 1) { IDECellRenderer( - CoderGatewayBundle.message("gateway.connector.view.coder.connect-ssh.retry", attempt), + CoderGatewayBundle.message( + "gateway.connector.view.coder.connect-ssh.retry", + attempt + ), ) } else { IDECellRenderer(CoderGatewayBundle.message("gateway.connector.view.coder.connect-ssh")) } - val executor = createRemoteExecutor(CoderCLIManager.getBackgroundHostName(data.client.url, data.workspace, data.client.me, data.agent)) + val executor = createRemoteExecutor( + CoderCLIManager(data.client.url).getBackgroundHostName( + data.workspace, + data.client.me, + data.agent + ) + ) if (ComponentValidator.getInstance(tfProject).isEmpty) { logger.info("Installing remote path validator...") @@ -225,7 +253,10 @@ class CoderWorkspaceProjectIDEStepView( cbIDE.renderer = if (attempt > 1) { IDECellRenderer( - CoderGatewayBundle.message("gateway.connector.view.coder.retrieve-ides.retry", attempt), + CoderGatewayBundle.message( + "gateway.connector.view.coder.retrieve-ides.retry", + attempt + ), ) } else { IDECellRenderer(CoderGatewayBundle.message("gateway.connector.view.coder.retrieve-ides")) @@ -234,9 +265,9 @@ class CoderWorkspaceProjectIDEStepView( }, retryIf = { it is ConnectionException || - it is TimeoutException || - it is SSHException || - it is DeployException + it is TimeoutException || + it is SSHException || + it is DeployException }, onException = { attempt, nextMs, e -> logger.error("Failed to retrieve IDEs (attempt $attempt; will retry in $nextMs ms)") @@ -258,9 +289,24 @@ class CoderWorkspaceProjectIDEStepView( ) }, ) + + // Check the provided setting to see if there's a default IDE to set. + val defaultIde = ides.find { it -> + // Using contains on the displayable version of the ide means they can be as specific or as vague as they want + // CL 2023.3.6 233.15619.8 -> a specific Clion build + // CL 2023.3.6 -> a specific Clion version + // 2023.3.6 -> a specific version (some customers will only have one specific IDE in their list anyway) + if (settings.defaultIde.isEmpty()) { + false + } else { + displayIdeWithStatus(it).contains(settings.defaultIde) + } + } + val index = ides.indexOf(defaultIde ?: ides.firstOrNull()) + withContext(Dispatchers.IO) { ideComboBoxModel.addAll(ides) - cbIDE.selectedIndex = 0 + cbIDE.selectedIndex = index } } catch (e: Exception) { if (isCancellation(e)) { @@ -283,7 +329,10 @@ class CoderWorkspaceProjectIDEStepView( * Validate the remote path whenever it changes. */ private fun installRemotePathValidator(executor: HighLevelHostAccessor) { - val disposable = Disposer.newDisposable(ApplicationManager.getApplication(), CoderWorkspaceProjectIDEStepView::class.java.name) + val disposable = Disposer.newDisposable( + ApplicationManager.getApplication(), + CoderWorkspaceProjectIDEStepView::class.java.name + ) ComponentValidator(disposable).installOn(tfProject) tfProject.document.addDocumentListener( @@ -296,7 +345,12 @@ class CoderWorkspaceProjectIDEStepView( val isPathPresent = validateRemotePath(tfProject.text, executor) if (isPathPresent.pathOrNull == null) { ComponentValidator.getInstance(tfProject).ifPresent { - it.updateInfo(ValidationInfo("Can't find directory: ${tfProject.text}", tfProject)) + it.updateInfo( + ValidationInfo( + "Can't find directory: ${tfProject.text}", + tfProject + ) + ) } } else { ComponentValidator.getInstance(tfProject).ifPresent { @@ -305,7 +359,12 @@ class CoderWorkspaceProjectIDEStepView( } } catch (e: Exception) { ComponentValidator.getInstance(tfProject).ifPresent { - it.updateInfo(ValidationInfo("Can't validate directory: ${tfProject.text}", tfProject)) + it.updateInfo( + ValidationInfo( + "Can't validate directory: ${tfProject.text}", + tfProject + ) + ) } } } @@ -349,27 +408,34 @@ class CoderWorkspaceProjectIDEStepView( } logger.info("Resolved OS and Arch for $name is: $workspaceOS") - val installedIdesJob = - cs.async(Dispatchers.IO) { - executor.getInstalledIDEs().map { it.toIdeWithStatus() } - } - val idesWithStatusJob = - cs.async(Dispatchers.IO) { - IntelliJPlatformProduct.entries - .filter { it.showInGateway } - .flatMap { CachingProductsJsonWrapper.getInstance().getAvailableIdes(it, workspaceOS) } - .map { it.toIdeWithStatus() } - } + val installedIdesJob = cs.async(Dispatchers.IO) { + executor.getInstalledIDEs() + } + val availableToDownloadIdesJob = cs.async(Dispatchers.IO) { + IntelliJPlatformProduct.entries + .filter { it.showInGateway } + .flatMap { CachingProductsJsonWrapper.getInstance().getAvailableIdes(it, workspaceOS) } + } + + val installedIdes = installedIdesJob.await() + val availableIdes = availableToDownloadIdesJob.await() - val installedIdes = installedIdesJob.await().sorted() - val idesWithStatus = idesWithStatusJob.await().sorted() if (installedIdes.isEmpty()) { logger.info("No IDE is installed in $name") } - if (idesWithStatus.isEmpty()) { + if (availableIdes.isEmpty()) { logger.warn("Could not resolve any IDE for $name, probably $workspaceOS is not supported by Gateway") } - return installedIdes + idesWithStatus + + val remainingInstalledIdes = installedIdes.filterOutAvailableReleasedIdes(availableIdes) + if (remainingInstalledIdes.size < installedIdes.size) { + logger.info( + "Skipping the following list of installed IDEs because there is already a released version " + + "available for download: ${(installedIdes - remainingInstalledIdes).joinToString { "${it.product.productCode} ${it.presentableVersion}" }}" + ) + } + return remainingInstalledIdes.map { it.toIdeWithStatus() }.sorted() + availableIdes.map { it.toIdeWithStatus() } + .sorted() } private fun toDeployedOS( @@ -404,7 +470,7 @@ class CoderWorkspaceProjectIDEStepView( override fun data(): WorkspaceProjectIDE = withoutNull(cbIDE.selectedItem, state) { selectedIDE, state -> selectedIDE.withWorkspaceProject( name = CoderCLIManager.getWorkspaceParts(state.workspace, state.agent), - hostname = CoderCLIManager.getHostName(state.client.url, state.workspace, state.client.me, state.agent), + hostname = CoderCLIManager(state.client.url).getHostName(state.workspace, state.client.me, state.agent), projectPath = tfProject.text, deploymentURL = state.client.url, ) @@ -427,7 +493,8 @@ class CoderWorkspaceProjectIDEStepView( override fun getSelectedItem(): IdeWithStatus? = super.getSelectedItem() as IdeWithStatus? } - private class IDECellRenderer(message: String, cellIcon: Icon = AnimatedIcon.Default.INSTANCE) : ListCellRenderer { + private class IDECellRenderer(message: String, cellIcon: Icon = AnimatedIcon.Default.INSTANCE) : + ListCellRenderer { private val loadingComponentRenderer: ListCellRenderer = object : ColoredListCellRenderer() { override fun customizeCellRenderer( @@ -457,9 +524,9 @@ class CoderWorkspaceProjectIDEStepView( add(JLabel(ideWithStatus.product.ideName, ideWithStatus.product.icon, SwingConstants.LEFT)) add( JLabel( - "${ideWithStatus.product.productCode} ${ideWithStatus.presentableVersion} ${ideWithStatus.buildNumber} | ${ideWithStatus.status.name.lowercase( - Locale.getDefault(), - )}", + displayIdeWithStatus( + ideWithStatus, + ), ).apply { foreground = UIUtil.getLabelDisabledForeground() }, diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt index 3873ef322..1928a4c46 100644 --- a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt +++ b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt @@ -105,6 +105,7 @@ data class CoderWorkspacesStepSelection( // Pass along the latest workspaces so we can configure the CLI a bit // faster, otherwise this step would have to fetch the workspaces again. val workspaces: List, + val remoteProjectPath: String? = null ) /** @@ -147,7 +148,8 @@ class CoderWorkspacesStepView : setEmptyState(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.connect.text.disconnected")) setSelectionMode(ListSelectionModel.SINGLE_SELECTION) selectionModel.addListSelectionListener { - nextButton.isEnabled = selectedObject?.status?.ready() == true && selectedObject?.agent?.operatingSystem == OS.LINUX + nextButton.isEnabled = + selectedObject?.status?.ready() == true && selectedObject?.agent?.operatingSystem == OS.LINUX if (selectedObject?.status?.ready() == true && selectedObject?.agent?.operatingSystem != OS.LINUX) { notificationBanner.apply { component.isVisible = true @@ -202,7 +204,7 @@ class CoderWorkspacesStepView : row { browserLink( CoderGatewayBundle.message("gateway.connector.view.login.documentation.action"), - "https://coder.com/docs/coder-oss/latest/workspaces", + "https://coder.com/docs/user-guides/workspace-management", ) } row(CoderGatewayBundle.message("gateway.connector.view.login.url.label")) { @@ -303,13 +305,13 @@ class CoderWorkspacesStepView : CoderIcons.RUN, ) { override fun actionPerformed(p0: AnActionEvent) { - withoutNull(client, tableOfWorkspaces.selectedObject?.workspace) { c, workspace -> + withoutNull(cliManager, tableOfWorkspaces.selectedObject?.workspace) { cliManager, workspace -> jobs[workspace.id]?.cancel() jobs[workspace.id] = cs.launch(ModalityState.current().asContextElement()) { withContext(Dispatchers.IO) { try { - c.startWorkspace(workspace) + cliManager.startWorkspace(workspace.ownerName, workspace.name) loadWorkspaces() } catch (e: Exception) { logger.error("Could not start workspace ${workspace.name}", e) @@ -343,22 +345,26 @@ class CoderWorkspacesStepView : val maxWait = Duration.ofMinutes(10) while (isActive) { // Wait for the workspace to fully stop. delay(timeout.toMillis()) - val found = tableOfWorkspaces.items.firstOrNull { it.workspace.id == workspace.id } + val found = + tableOfWorkspaces.items.firstOrNull { it.workspace.id == workspace.id } when (val status = found?.workspace?.latestBuild?.status) { WorkspaceStatus.PENDING, WorkspaceStatus.STOPPING, WorkspaceStatus.RUNNING -> { logger.info("Still waiting for ${workspace.name} to stop before updating") } + WorkspaceStatus.STARTING, WorkspaceStatus.FAILED, WorkspaceStatus.CANCELING, WorkspaceStatus.CANCELED, WorkspaceStatus.DELETING, WorkspaceStatus.DELETED, - -> { + -> { logger.warn("Canceled ${workspace.name} update due to status change to $status") break } + null -> { logger.warn("Canceled ${workspace.name} update because it no longer exists") break } + WorkspaceStatus.STOPPED -> { logger.info("${workspace.name} has stopped; updating now") c.updateWorkspace(workspace) @@ -560,7 +566,10 @@ class CoderWorkspacesStepView : deploymentURL.host, ) tableOfWorkspaces.setEmptyState( - CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.connect.text.connecting", deploymentURL.host), + CoderGatewayBundle.message( + "gateway.connector.view.coder.workspaces.connect.text.connecting", + deploymentURL.host + ), ) tableOfWorkspaces.listTableModel.items = emptyList() @@ -600,7 +609,10 @@ class CoderWorkspacesStepView : client = authedClient tableOfWorkspaces.setEmptyState( - CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.connect.text.connected", deploymentURL.host), + CoderGatewayBundle.message( + "gateway.connector.view.coder.workspaces.connect.text.connected", + deploymentURL.host + ), ) tfUrlComment?.text = CoderGatewayBundle.message( @@ -659,7 +671,7 @@ class CoderWorkspacesStepView : cs.launch(ModalityState.current().asContextElement()) { while (isActive) { loadWorkspaces() - delay(5000) + delay(1000) } } } @@ -788,7 +800,8 @@ class WorkspacesTableModel : WorkspaceVersionColumnInfo("Version"), WorkspaceStatusColumnInfo("Status"), ) { - private class WorkspaceIconColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceIconColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(item: WorkspaceAgentListModel?): String? = item?.workspace?.templateName override fun getRenderer(item: WorkspaceAgentListModel?): TableCellRenderer { @@ -820,7 +833,8 @@ class WorkspacesTableModel : } } - private class WorkspaceNameColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceNameColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(item: WorkspaceAgentListModel?): String? = item?.name override fun getComparator(): Comparator = Comparator { a, b -> @@ -850,7 +864,8 @@ class WorkspacesTableModel : } } - private class WorkspaceOwnerColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceOwnerColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(item: WorkspaceAgentListModel?): String? = item?.workspace?.ownerName override fun getComparator(): Comparator = Comparator { a, b -> @@ -880,7 +895,8 @@ class WorkspacesTableModel : } } - private class WorkspaceTemplateNameColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceTemplateNameColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(item: WorkspaceAgentListModel?): String? = item?.workspace?.templateName override fun getComparator(): java.util.Comparator = Comparator { a, b -> @@ -909,7 +925,8 @@ class WorkspacesTableModel : } } - private class WorkspaceVersionColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceVersionColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(workspace: WorkspaceAgentListModel?): String? = if (workspace == null) { "Unknown" } else if (workspace.workspace.outdated) { @@ -940,7 +957,8 @@ class WorkspacesTableModel : } } - private class WorkspaceStatusColumnInfo(columnName: String) : ColumnInfo(columnName) { + private class WorkspaceStatusColumnInfo(columnName: String) : + ColumnInfo(columnName) { override fun valueOf(item: WorkspaceAgentListModel?): String? = item?.status?.label override fun getComparator(): java.util.Comparator = Comparator { a, b -> diff --git a/src/main/resources/messages/CoderGatewayBundle.properties b/src/main/resources/messages/CoderGatewayBundle.properties index 917919227..f318012e0 100644 --- a/src/main/resources/messages/CoderGatewayBundle.properties +++ b/src/main/resources/messages/CoderGatewayBundle.properties @@ -27,8 +27,8 @@ gateway.connector.view.coder.workspaces.update.description=Update workspace gateway.connector.view.coder.workspaces.create.text=Create Workspace gateway.connector.view.coder.workspaces.create.description=Create workspace gateway.connector.view.coder.workspaces.unsupported.os.info=Gateway supports only Linux machines. Support for macOS and Windows is planned. -gateway.connector.view.coder.workspaces.invalid.coder.version=Could not parse Coder version {0}. Coder Gateway plugin might not be compatible with this version. Connect to a Coder workspace manually -gateway.connector.view.coder.workspaces.unsupported.coder.version=Coder version {0} might not be compatible with this plugin version. Connect to a Coder workspace manually +gateway.connector.view.coder.workspaces.invalid.coder.version=Could not parse Coder version {0}. Coder Gateway plugin might not be compatible with this version. Connect to a Coder workspace manually +gateway.connector.view.coder.workspaces.unsupported.coder.version=Coder version {0} might not be compatible with this plugin version. Connect to a Coder workspace manually gateway.connector.view.workspaces.connect.failed=Connection to {0} failed. See above for details. gateway.connector.view.workspaces.connect.canceled=Connection to {0} canceled. gateway.connector.view.coder.connect-ssh=Establishing SSH connection to remote worker... @@ -49,6 +49,7 @@ gateway.connector.coder.connection.provider.title=Connecting to Coder workspace. gateway.connector.coder.connecting=Connecting... gateway.connector.coder.connecting.retry=Connecting (attempt {0})... gateway.connector.coder.connection.failed=Failed to connect +gateway.connector.coder.setup-command.failed=Failed to set up backend IDE gateway.connector.coder.connecting.failed.retry=Failed to connect...retrying {0} gateway.connector.settings.data-directory.title=Data directory gateway.connector.settings.data-directory.comment=Directories are created \ @@ -138,3 +139,10 @@ gateway.connector.settings.workspace-filter.comment=The filter to apply when \ the plugin fetches resources individually for each non-running workspace, \ which can be slow with many workspaces, and it adds every agent to the SSH \ config, which can result in a large SSH config with many workspaces. +gateway.connector.settings.default-ide=Default IDE Selection +gateway.connector.settings.check-ide-updates.heading=IDE version check +gateway.connector.settings.check-ide-updates.title=Check for IDE updates +gateway.connector.settings.check-ide-updates.comment=Checking this box will \ + cause the plugin to check for available IDE backend updates and prompt \ + with an option to upgrade if a newer version is available. + diff --git a/src/test/fixtures/inputs/wildcard.conf b/src/test/fixtures/inputs/wildcard.conf new file mode 100644 index 000000000..b6468c054 --- /dev/null +++ b/src/test/fixtures/inputs/wildcard.conf @@ -0,0 +1,17 @@ +# --- START CODER JETBRAINS test.coder.invalid +Host coder-jetbrains-test.coder.invalid--* + ProxyCommand /tmp/coder-gateway/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-gateway/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --ssh-host-prefix coder-jetbrains-test.coder.invalid-- %h + ConnectTimeout 0 + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + LogLevel ERROR + SetEnv CODER_SSH_SESSION_TYPE=JetBrains + +Host coder-jetbrains-test.coder.invalid-bg--* + ProxyCommand /tmp/coder-gateway/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-gateway/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --ssh-host-prefix coder-jetbrains-test.coder.invalid-bg-- %h + ConnectTimeout 0 + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + LogLevel ERROR + SetEnv CODER_SSH_SESSION_TYPE=JetBrains +# --- END CODER JETBRAINS test.coder.invalid diff --git a/src/test/fixtures/outputs/wildcard.conf b/src/test/fixtures/outputs/wildcard.conf new file mode 100644 index 000000000..b6468c054 --- /dev/null +++ b/src/test/fixtures/outputs/wildcard.conf @@ -0,0 +1,17 @@ +# --- START CODER JETBRAINS test.coder.invalid +Host coder-jetbrains-test.coder.invalid--* + ProxyCommand /tmp/coder-gateway/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-gateway/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --ssh-host-prefix coder-jetbrains-test.coder.invalid-- %h + ConnectTimeout 0 + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + LogLevel ERROR + SetEnv CODER_SSH_SESSION_TYPE=JetBrains + +Host coder-jetbrains-test.coder.invalid-bg--* + ProxyCommand /tmp/coder-gateway/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-gateway/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --ssh-host-prefix coder-jetbrains-test.coder.invalid-bg-- %h + ConnectTimeout 0 + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + LogLevel ERROR + SetEnv CODER_SSH_SESSION_TYPE=JetBrains +# --- END CODER JETBRAINS test.coder.invalid diff --git a/src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt b/src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt index 7abc4f442..5ae754ecf 100644 --- a/src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt +++ b/src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt @@ -419,6 +419,15 @@ internal class CoderCLIManagerTest { output = "multiple-agents", remove = "blank", ), + SSHTest( + listOf(workspace), + input = null, + output = "wildcard", + remove = "wildcard", + features = Features( + wildcardSSH = true, + ), + ), ) val newlineRe = "\r?\n".toRegex() @@ -463,6 +472,19 @@ internal class CoderCLIManagerTest { } } + val inputConf = + Path.of("src/test/fixtures/inputs/").resolve(it.remove + ".conf").toFile().readText() + .replace(newlineRe, System.lineSeparator()) + .replace("/tmp/coder-gateway/test.coder.invalid/config", escape(coderConfigPath.toString())) + .replace("/tmp/coder-gateway/test.coder.invalid/coder-linux-amd64", escape(ccm.localBinaryPath.toString())) + .let { conf -> + if (it.sshLogDirectory != null) { + conf.replace("/tmp/coder-gateway/test.coder.invalid/logs", it.sshLogDirectory.toString()) + } else { + conf + } + } + // Add workspaces. ccm.configSsh( it.workspaces.flatMap { ws -> @@ -487,8 +509,7 @@ internal class CoderCLIManagerTest { // Remove is the configuration we expect after removing. assertEquals( settings.sshConfigPath.toFile().readText(), - Path.of("src/test/fixtures/inputs").resolve(it.remove + ".conf").toFile() - .readText().replace(newlineRe, System.lineSeparator()), + inputConf ) } } @@ -804,7 +825,7 @@ internal class CoderCLIManagerTest { listOf( Pair("2.5.0", Features(true)), Pair("2.13.0", Features(true, true)), - Pair("4.9.0", Features(true, true)), + Pair("4.9.0", Features(true, true, true)), Pair("2.4.9", Features(false)), Pair("1.0.1", Features(false)), ) diff --git a/src/test/kotlin/com/coder/gateway/models/WorkspaceProjectIDETest.kt b/src/test/kotlin/com/coder/gateway/models/WorkspaceProjectIDETest.kt index 3a64f6e0c..6c6873e54 100644 --- a/src/test/kotlin/com/coder/gateway/models/WorkspaceProjectIDETest.kt +++ b/src/test/kotlin/com/coder/gateway/models/WorkspaceProjectIDETest.kt @@ -1,5 +1,22 @@ package com.coder.gateway.models +import com.jetbrains.gateway.ssh.AvailableIde +import com.jetbrains.gateway.ssh.Download +import com.jetbrains.gateway.ssh.InstalledIdeUIEx +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.GOIDE +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.IDEA +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.IDEA_IC +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.PYCHARM +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.RUBYMINE +import com.jetbrains.gateway.ssh.IntelliJPlatformProduct.RUSTROVER +import com.jetbrains.gateway.ssh.ReleaseType +import com.jetbrains.gateway.ssh.ReleaseType.EAP +import com.jetbrains.gateway.ssh.ReleaseType.NIGHTLY +import com.jetbrains.gateway.ssh.ReleaseType.PREVIEW +import com.jetbrains.gateway.ssh.ReleaseType.RC +import com.jetbrains.gateway.ssh.ReleaseType.RELEASE +import org.junit.jupiter.api.DisplayName import java.net.URL import kotlin.test.Test import kotlin.test.assertContains @@ -125,4 +142,323 @@ internal class WorkspaceProjectIDETest { }, ) } + + @Test + @DisplayName("test that installed IDEs filter returns an empty list when there are available IDEs but none are installed") + fun testFilterOutWhenNoIdeIsInstalledButAvailableIsPopulated() { + assertEquals( + emptyList(), emptyList().filterOutAvailableReleasedIdes( + listOf( + availableIde(IDEA, "242.23726.43", EAP), + availableIde(IDEA_IC, "251.23726.43", RELEASE) + ) + ) + ) + } + + @Test + @DisplayName("test that unreleased installed IDEs are not filtered out when available list of IDEs is empty") + fun testFilterOutAvailableReleaseIdesWhenAvailableIsEmpty() { + // given an eap installed ide + val installedEAPs = listOf(installedIde(IDEA, "242.23726.43", EAP)) + + // expect + assertEquals(installedEAPs, installedEAPs.filterOutAvailableReleasedIdes(emptyList())) + + // given an RC installed ide + val installedRCs = listOf(installedIde(RUSTROVER, "243.63726.48", RC)) + + // expect + assertEquals(installedRCs, installedRCs.filterOutAvailableReleasedIdes(emptyList())) + + // given a preview installed ide + val installedPreviews = listOf(installedIde(IDEA_IC, "244.63726.48", ReleaseType.PREVIEW)) + + // expect + assertEquals(installedPreviews, installedPreviews.filterOutAvailableReleasedIdes(emptyList())) + + // given a nightly installed ide + val installedNightlys = listOf(installedIde(RUBYMINE, "244.63726.48", NIGHTLY)) + + // expect + assertEquals(installedNightlys, installedNightlys.filterOutAvailableReleasedIdes(emptyList())) + } + + @Test + @DisplayName("test that unreleased EAP ides are superseded by available RELEASED ides with the same or higher build number") + fun testUnreleasedAndInstalledEAPIdesAreSupersededByAvailableReleasedWithSameOrHigherBuildNr() { + // given an eap installed ide + val installedEapIdea = installedIde(IDEA, "242.23726.43", EAP) + val installedReleasedRustRover = installedIde(RUSTROVER, "251.55667.23", RELEASE) + // and a released idea with same build number + val availableReleasedIdeaWithSameBuild = availableIde(IDEA, "242.23726.43", RELEASE) + + // expect the installed eap idea to be filtered out + assertEquals( + listOf(installedReleasedRustRover), + listOf(installedEapIdea, installedReleasedRustRover).filterOutAvailableReleasedIdes( + listOf( + availableReleasedIdeaWithSameBuild + ) + ) + ) + + // given a released idea with higher build number + val availableIdeaWithHigherBuild = availableIde(IDEA, "243.21726.43", RELEASE) + + // expect the installed eap idea to be filtered out + assertEquals( + listOf(installedReleasedRustRover), + listOf(installedEapIdea, installedReleasedRustRover).filterOutAvailableReleasedIdes( + listOf( + availableIdeaWithHigherBuild + ) + ) + ) + } + + @Test + @DisplayName("test that unreleased RC ides are superseded by available RELEASED ides with the same or higher build number") + fun testUnreleasedAndInstalledRCIdesAreSupersededByAvailableReleasedWithSameOrHigherBuildNr() { + // given an RC installed ide + val installedRCRustRover = installedIde(RUSTROVER, "242.23726.43", RC) + val installedReleasedGoLand = installedIde(GOIDE, "251.55667.23", RELEASE) + // and a released idea with same build number + val availableReleasedRustRoverWithSameBuild = availableIde(RUSTROVER, "242.23726.43", RELEASE) + + // expect the installed RC rust rover to be filtered out + assertEquals( + listOf(installedReleasedGoLand), + listOf(installedRCRustRover, installedReleasedGoLand).filterOutAvailableReleasedIdes( + listOf( + availableReleasedRustRoverWithSameBuild + ) + ) + ) + + // given a released rust rover with higher build number + val availableRustRoverWithHigherBuild = availableIde(RUSTROVER, "243.21726.43", RELEASE) + + // expect the installed RC rust rover to be filtered out + assertEquals( + listOf(installedReleasedGoLand), + listOf(installedRCRustRover, installedReleasedGoLand).filterOutAvailableReleasedIdes( + listOf( + availableRustRoverWithHigherBuild + ) + ) + ) + } + + @Test + @DisplayName("test that unreleased PREVIEW ides are superseded by available RELEASED ides with the same or higher build number") + fun testUnreleasedAndInstalledPreviewIdesAreSupersededByAvailableReleasedWithSameOrHigherBuildNr() { + // given a PREVIEW installed ide + val installedPreviewRubyMine = installedIde(RUBYMINE, "242.23726.43", PREVIEW) + val installedReleasedIntelliJCommunity = installedIde(IDEA_IC, "251.55667.23", RELEASE) + // and a released ruby mine with same build number + val availableReleasedRubyMineWithSameBuild = availableIde(RUBYMINE, "242.23726.43", RELEASE) + + // expect the installed PREVIEW idea to be filtered out + assertEquals( + listOf(installedReleasedIntelliJCommunity), + listOf(installedPreviewRubyMine, installedReleasedIntelliJCommunity).filterOutAvailableReleasedIdes( + listOf( + availableReleasedRubyMineWithSameBuild + ) + ) + ) + + // given a released ruby mine with higher build number + val availableRubyMineWithHigherBuild = availableIde(RUBYMINE, "243.21726.43", RELEASE) + + // expect the installed PREVIEW ruby mine to be filtered out + assertEquals( + listOf(installedReleasedIntelliJCommunity), + listOf(installedPreviewRubyMine, installedReleasedIntelliJCommunity).filterOutAvailableReleasedIdes( + listOf( + availableRubyMineWithHigherBuild + ) + ) + ) + } + + @Test + @DisplayName("test that unreleased NIGHTLY ides are superseded by available RELEASED ides with the same or higher build number") + fun testUnreleasedAndInstalledNightlyIdesAreSupersededByAvailableReleasedWithSameOrHigherBuildNr() { + // given a NIGHTLY installed ide + val installedNightlyPyCharm = installedIde(PYCHARM, "242.23726.43", NIGHTLY) + val installedReleasedRubyMine = installedIde(RUBYMINE, "251.55667.23", RELEASE) + // and a released pycharm with same build number + val availableReleasedPyCharmWithSameBuild = availableIde(PYCHARM, "242.23726.43", RELEASE) + + // expect the installed NIGHTLY pycharm to be filtered out + assertEquals( + listOf(installedReleasedRubyMine), + listOf(installedNightlyPyCharm, installedReleasedRubyMine).filterOutAvailableReleasedIdes( + listOf( + availableReleasedPyCharmWithSameBuild + ) + ) + ) + + // given a released pycharm with higher build number + val availablePyCharmWithHigherBuild = availableIde(PYCHARM, "243.21726.43", RELEASE) + + // expect the installed NIGHTLY pycharm to be filtered out + assertEquals( + listOf(installedReleasedRubyMine), + listOf(installedNightlyPyCharm, installedReleasedRubyMine).filterOutAvailableReleasedIdes( + listOf( + availablePyCharmWithHigherBuild + ) + ) + ) + } + + @Test + @DisplayName("test that unreleased installed ides are NOT superseded by available unreleased IDEs with higher build numbers") + fun testUnreleasedIdesAreNotSupersededByAvailableUnreleasedIdesWithHigherBuildNr() { + // given installed and unreleased ides + val installedEap = listOf(installedIde(RUSTROVER, "203.87675.5", EAP)) + val installedRC = listOf(installedIde(RUSTROVER, "203.87675.5", RC)) + val installedPreview = listOf(installedIde(RUSTROVER, "203.87675.5", PREVIEW)) + val installedNightly = listOf(installedIde(RUSTROVER, "203.87675.5", NIGHTLY)) + + // and available unreleased ides + val availableHigherAndUnreleasedIdes = listOf( + availableIde(RUSTROVER, "204.34567.1", EAP), + availableIde(RUSTROVER, "205.45678.2", RC), + availableIde(RUSTROVER, "206.24667.3", PREVIEW), + availableIde(RUSTROVER, "207.24667.4", NIGHTLY), + ) + + assertEquals( + installedEap, + installedEap.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedRC, + installedRC.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedPreview, + installedPreview.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedNightly, + installedNightly.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + } + + @Test + @DisplayName("test that unreleased installed ides are NOT superseded by available unreleased IDEs with same major number but higher minor build numbers") + fun testUnreleasedIdesAreNotSupersededByAvailableUnreleasedIdesWithSameMajorButHigherMinorBuildNr() { + // given installed and unreleased ides + val installedEap = listOf(installedIde(RUSTROVER, "203.12345.5", EAP)) + val installedRC = listOf(installedIde(RUSTROVER, "203.12345.5", RC)) + val installedPreview = listOf(installedIde(RUSTROVER, "203.12345.5", PREVIEW)) + val installedNightly = listOf(installedIde(RUSTROVER, "203.12345.5", NIGHTLY)) + + // and available unreleased ides + val availableHigherAndUnreleasedIdes = listOf( + availableIde(RUSTROVER, "203.34567.1", EAP), + availableIde(RUSTROVER, "203.45678.2", RC), + availableIde(RUSTROVER, "203.24667.3", PREVIEW), + availableIde(RUSTROVER, "203.24667.4", NIGHTLY), + ) + + assertEquals( + installedEap, + installedEap.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedRC, + installedRC.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedPreview, + installedPreview.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedNightly, + installedNightly.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + } + + @Test + @DisplayName("test that unreleased installed ides are NOT superseded by available unreleased IDEs with same major and minor number but higher patch numbers") + fun testUnreleasedIdesAreNotSupersededByAvailableUnreleasedIdesWithSameMajorAndMinorButHigherPatchNr() { + // given installed and unreleased ides + val installedEap = listOf(installedIde(RUSTROVER, "203.12345.1", EAP)) + val installedRC = listOf(installedIde(RUSTROVER, "203.12345.1", RC)) + val installedPreview = listOf(installedIde(RUSTROVER, "203.12345.1", PREVIEW)) + val installedNightly = listOf(installedIde(RUSTROVER, "203.12345.1", NIGHTLY)) + + // and available unreleased ides + val availableHigherAndUnreleasedIdes = listOf( + availableIde(RUSTROVER, "203.12345.2", EAP), + availableIde(RUSTROVER, "203.12345.3", RC), + availableIde(RUSTROVER, "203.12345.4", PREVIEW), + availableIde(RUSTROVER, "203.12345.5", NIGHTLY), + ) + + assertEquals( + installedEap, + installedEap.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedRC, + installedRC.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedPreview, + installedPreview.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + assertEquals( + installedNightly, + installedNightly.filterOutAvailableReleasedIdes(availableHigherAndUnreleasedIdes) + ) + } + + companion object { + private val fakeDownload = Download( + "https://download.jetbrains.com/idea/ideaIU-2024.1.7.tar.gz", + 1328462259, + "https://download.jetbrains.com/idea/ideaIU-2024.1.7.tar.gz.sha256" + ) + + private fun installedIde( + product: IntelliJPlatformProduct, + buildNumber: String, + releaseType: ReleaseType + ): InstalledIdeUIEx { + return InstalledIdeUIEx( + product, + buildNumber, + "/home/coder/.cache/JetBrains/", + toPresentableVersion(buildNumber) + " " + releaseType.toString() + ) + } + + private fun availableIde( + product: IntelliJPlatformProduct, + buildNumber: String, + releaseType: ReleaseType + ): AvailableIde { + return AvailableIde( + product, + buildNumber, + fakeDownload, + toPresentableVersion(buildNumber) + " " + releaseType.toString(), + null, + releaseType + ) + } + + private fun toPresentableVersion(buildNr: String): String { + + return "20" + buildNr.substring(0, 2) + "." + buildNr.substring(2, 3) + } + } } diff --git a/src/test/kotlin/com/coder/gateway/util/SetupCommandTest.kt b/src/test/kotlin/com/coder/gateway/util/SetupCommandTest.kt new file mode 100644 index 000000000..b237925b4 --- /dev/null +++ b/src/test/kotlin/com/coder/gateway/util/SetupCommandTest.kt @@ -0,0 +1,48 @@ +package com.coder.gateway.util + +import com.coder.gateway.CoderRemoteConnectionHandle.Companion.processSetupCommand +import com.coder.gateway.CoderSetupCommandException +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertThrows +import kotlin.test.assertEquals + +internal class SetupCommandTest { + + @Test + fun executionErrors() { + assertEquals( + "Execution error", + assertThrows { + processSetupCommand(false) { throw Exception("Execution error") } + }.message + ) + processSetupCommand(true) { throw Exception("Execution error") } + } + + @Test + fun setupScriptError() { + assertEquals( + "Your IDE is expired, please update", + assertThrows { + processSetupCommand(false) { + """ + execution line 1 + execution line 2 + CODER_SETUP_ERRORYour IDE is expired, please update + execution line 3 + """ + } + }.message + ) + + processSetupCommand(true) { + """ + execution line 1 + execution line 2 + CODER_SETUP_ERRORYour IDE is expired, please update + execution line 3 + """ + } + + } +} \ No newline at end of file