feat(version): add CLI version check on extension startup #9
There are no files selected for viewing
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
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
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
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
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
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,121 @@ | ||||||||
| package xyz.shelltime.jetbrains.version | ||||||||
|
|
||||||||
| import com.intellij.ide.BrowserUtil | ||||||||
| import com.intellij.notification.NotificationGroupManager | ||||||||
| import com.intellij.notification.NotificationType | ||||||||
| import com.intellij.openapi.project.Project | ||||||||
| import kotlinx.coroutines.* | ||||||||
| import kotlinx.serialization.json.Json | ||||||||
| import xyz.shelltime.jetbrains.config.Constants | ||||||||
| import xyz.shelltime.jetbrains.heartbeat.VersionCheckResponse | ||||||||
| import xyz.shelltime.jetbrains.utils.Logger | ||||||||
| import java.net.HttpURLConnection | ||||||||
| import java.net.URL | ||||||||
| import java.net.URLEncoder | ||||||||
|
|
||||||||
| /** | ||||||||
| * Checks CLI version against the server and notifies user if update is available | ||||||||
| */ | ||||||||
| class VersionChecker( | ||||||||
| private val apiEndpoint: String, | ||||||||
| private val webEndpoint: String, | ||||||||
| debug: Boolean = false | ||||||||
| ) { | ||||||||
| private val logger = Logger("VersionChecker", debug) | ||||||||
| private val json = Json { ignoreUnknownKeys = true } | ||||||||
| private val scope = CoroutineScope(Dispatchers.IO + SupervisorJob()) | ||||||||
|
|
||||||||
| @Volatile | ||||||||
| private var hasShownWarning = false | ||||||||
|
Comment on lines
+28
to
+29
There was a problem hiding this comment. The comment "Version warning already shown this session" implies this flag should be shared across all Furthermore, the current implementation has a race condition. If To fix both issues, you can move
|
||||||||
|
|
||||||||
| /** | ||||||||
| * Check CLI version asynchronously | ||||||||
| */ | ||||||||
| fun checkVersion(currentVersion: String, project: Project?) { | ||||||||
| if (hasShownWarning) { | ||||||||
| logger.log("Version warning already shown this session, skipping") | ||||||||
| return | ||||||||
| } | ||||||||
|
|
||||||||
| scope.launch { | ||||||||
| try { | ||||||||
| val result = fetchVersionCheck(currentVersion) | ||||||||
| if (result != null && !result.isLatest) { | ||||||||
| hasShownWarning = true | ||||||||
| withContext(Dispatchers.Main) { | ||||||||
| showUpdateWarning(currentVersion, result.latestVersion, project) | ||||||||
| } | ||||||||
| } else if (result != null) { | ||||||||
| logger.log("CLI version $currentVersion is up to date") | ||||||||
| } | ||||||||
| } catch (e: Exception) { | ||||||||
| logger.log("Version check failed: ${e.message}") | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| private fun fetchVersionCheck(version: String): VersionCheckResponse? { | ||||||||
| val encodedVersion = URLEncoder.encode(version, "UTF-8") | ||||||||
| val url = URL("$apiEndpoint${Constants.VERSION_CHECK_ENDPOINT}?version=$encodedVersion") | ||||||||
|
|
||||||||
| logger.log("Checking version at: $url") | ||||||||
|
|
||||||||
| val connection = url.openConnection() as HttpURLConnection | ||||||||
| connection.requestMethod = "GET" | ||||||||
| connection.connectTimeout = Constants.VERSION_CHECK_TIMEOUT_MS.toInt() | ||||||||
| connection.readTimeout = Constants.VERSION_CHECK_TIMEOUT_MS.toInt() | ||||||||
| connection.setRequestProperty("Accept", "application/json") | ||||||||
|
|
||||||||
| return try { | ||||||||
| if (connection.responseCode == HttpURLConnection.HTTP_OK) { | ||||||||
| val response = connection.inputStream.bufferedReader().use { it.readText() } | ||||||||
| json.decodeFromString<VersionCheckResponse>(response) | ||||||||
| } else { | ||||||||
| logger.log("Version check HTTP error: ${connection.responseCode}") | ||||||||
| null | ||||||||
| } | ||||||||
| } finally { | ||||||||
| connection.disconnect() | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| private fun showUpdateWarning(currentVersion: String, latestVersion: String, project: Project?) { | ||||||||
| val message = "ShellTime CLI update available: $currentVersion -> $latestVersion" | ||||||||
| val updateCommand = "curl -sSL $webEndpoint/i | bash" | ||||||||
|
|
||||||||
| NotificationGroupManager.getInstance() | ||||||||
| .getNotificationGroup(Constants.NOTIFICATION_GROUP_ID) | ||||||||
| .createNotification( | ||||||||
| "ShellTime Update Available", | ||||||||
| "$message<br><br>Run: <code>$updateCommand</code>", | ||||||||
| NotificationType.WARNING | ||||||||
| ) | ||||||||
| .addAction(object : com.intellij.notification.NotificationAction("Copy Update Command") { | ||||||||
| override fun actionPerformed( | ||||||||
| e: com.intellij.notification.AnActionEvent, | ||||||||
| notification: com.intellij.notification.Notification | ||||||||
| ) { | ||||||||
| val clipboard = java.awt.Toolkit.getDefaultToolkit().systemClipboard | ||||||||
| clipboard.setContents(java.awt.datatransfer.StringSelection(updateCommand), null) | ||||||||
|
Comment on lines
+98
to
+99
There was a problem hiding this comment. It's better to use the IntelliJ Platform's You'll need to add this import:
Suggested change
|
||||||||
| notification.expire() | ||||||||
|
|
||||||||
| NotificationGroupManager.getInstance() | ||||||||
| .getNotificationGroup(Constants.NOTIFICATION_GROUP_ID) | ||||||||
| .createNotification( | ||||||||
| "Update command copied to clipboard", | ||||||||
| NotificationType.INFORMATION | ||||||||
| ) | ||||||||
| .notify(project) | ||||||||
| } | ||||||||
| }) | ||||||||
| .notify(project) | ||||||||
| } | ||||||||
|
|
||||||||
| fun setDebug(enabled: Boolean) { | ||||||||
| logger.setDebug(enabled) | ||||||||
| } | ||||||||
|
|
||||||||
| fun dispose() { | ||||||||
| scope.cancel() | ||||||||
| } | ||||||||
| } | ||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new function
getFileConfigappears to be unused within the scope of this pull request. Furthermore, it bypasses the caching mechanism implemented ingetConfig(), leading to inefficient file I/O and parsing on every call. The properties it seems intended to expose (apiEndpointandwebEndpoint) are already merged intoShellTimeConfigand available via the cachedgetConfig()method. If this function is not needed, it should be removed. If it is needed for some other purpose, it should be refactored to leverage the existing caching logic.