- Notifications
You must be signed in to change notification settings - Fork16
setup script can communicate an error message to the end user#538
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
88134ba setup script can communicate an error message to the end user
kirillk55870c4 review fixes
kirillkeb5e2ac custom exception class for setup command
kirillkc0b6fea better title
kirillke3a37fb Merge branch 'main' into kkalishev/setup-script-error
bcpeinhardtacc6a7f changelog update
bcpeinhardtFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletionsCHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionssrc/main/kotlin/com/coder/gateway/CoderGatewayConstants.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
60 changes: 46 additions & 14 deletionssrc/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| @@ -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) | ||
| 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..." | ||
| processSetupCommand(ignoreSetupFailure) { | ||
| exec(workspace, setupCommand) | ||
| } | ||
| } 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, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Not a comment on this PR just a note to self about how we're doing this in general: don't love us drilling down this | ||
| execCommand: () -> String | ||
| ) { | ||
| try { | ||
| val errorText = execCommand | ||
| .invoke() | ||
kirillk marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| .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) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
7 changes: 7 additions & 0 deletionssrc/main/kotlin/com/coder/gateway/CoderSetupCommandException.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| package com.coder.gateway | ||
| class CoderSetupCommandException : Exception { | ||
| constructor(message: String) : super(message) | ||
| constructor(message: String, cause: Throwable) : super(message, cause) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. a more simpler approach: class CoderSetupCommandException(message: String, cause: Throwable? = null) : Exception(message, cause) | ||
| } | ||
1 change: 1 addition & 0 deletionssrc/main/resources/messages/CoderGatewayBundle.properties
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletionssrc/test/kotlin/com/coder/gateway/util/SetupCommandTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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<CoderSetupCommandException> { | ||
| processSetupCommand(false) { throw Exception("Execution error") } | ||
| }.message | ||
| ) | ||
| processSetupCommand(true) { throw Exception("Execution error") } | ||
| } | ||
| @Test | ||
| fun setupScriptError() { | ||
| assertEquals( | ||
| "Your IDE is expired, please update", | ||
| assertThrows<CoderSetupCommandException> { | ||
| 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 | ||
| """ | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.