Impl: prevent version mismatch

fioan89 · fioan89 · commit 09e2d45aa351 · 2022-11-30T01:14:18.000+02:00
- basic semantic versioning parser and comparator - logic to compare if two coder versions are API compatible - basic checking between a tested Coder version number and the Coder version - resolves #89
diff --git a/src/main/kotlin/com/coder/gateway/CoderSupportedVersions.kt b/src/main/kotlin/com/coder/gateway/CoderSupportedVersions.kt
@@ -0,0 +1,17 @@
+package com.coder.gateway
+
+import com.coder.gateway.sdk.CoderSemVer
+import com.intellij.DynamicBundle
+import org.jetbrains.annotations.NonNls
+import org.jetbrains.annotations.PropertyKey
+
+@NonNls
+private const val BUNDLE = "version.CoderSupportedVersions"
+
+object CoderSupportedVersions : DynamicBundle(BUNDLE) {
+    val maxCoderVersion = CoderSemVer.parse(message("maxCoderVersion"))
+
+    @Suppress("SpreadOperator")
+    @JvmStatic
+    private fun message(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) = getMessage(key, *params)
+}
diff --git a/src/main/kotlin/com/coder/gateway/sdk/CoderSemVer.kt b/src/main/kotlin/com/coder/gateway/sdk/CoderSemVer.kt
@@ -0,0 +1,33 @@
+package com.coder.gateway.sdk
+
+
+class CoderSemVer(private val major: Int = 0, private val minor: Int = 0) {
+
+    init {
+        require(major >= 0) { "Coder major version must be a positive number" }
+        require(minor >= 0) { "Coder minor version must be a positive number" }
+    }
+
+    fun isCompatibleWith(other: CoderSemVer): Boolean {
+        // in the initial development phase minor changes when there are API incompatibilities
+        if (this.major == 0) {
+            if (other.major > 0) return false
+            return this.minor == other.minor
+        }
+        return this.major <= other.major
+    }
+
+    companion object {
+        private val pattern = """^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?\$""".toRegex()
+
+        fun isValidVersion(semVer: String) = pattern.matchEntire(semVer.trimStart('v')) != null
+
+        fun parse(semVer: String): CoderSemVer {
+            val matchResult = pattern.matchEntire(semVer.trimStart('v')) ?: throw IllegalArgumentException("$semVer could not be parsed")
+            return CoderSemVer(
+                if (matchResult.groupValues[1].isNotEmpty()) matchResult.groupValues[1].toInt() else 0,
+                if (matchResult.groupValues[2].isNotEmpty()) matchResult.groupValues[2].toInt() else 0,
+            )
+        }
+    }
+}
diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt
@@ -1,6 +1,7 @@
 package com.coder.gateway.views.steps
 
 import com.coder.gateway.CoderGatewayBundle
+import com.coder.gateway.CoderSupportedVersions
 import com.coder.gateway.icons.CoderIcons
 import com.coder.gateway.models.CoderWorkspacesWizardModel
 import com.coder.gateway.models.WorkspaceAgentModel
@@ -15,6 +16,7 @@ import com.coder.gateway.models.WorkspaceVersionStatus
 import com.coder.gateway.sdk.Arch
 import com.coder.gateway.sdk.CoderCLIManager
 import com.coder.gateway.sdk.CoderRestClientService
+import com.coder.gateway.sdk.CoderSemVer
 import com.coder.gateway.sdk.OS
 import com.coder.gateway.sdk.ex.AuthenticationResponseException
 import com.coder.gateway.sdk.ex.TemplateResponseException
@@ -304,6 +306,24 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
     private fun loginAndLoadWorkspace(token: String) {
         try {
             coderClient.initClientSession(localWizardModel.coderURL.toURL(), token)
+            if (!CoderSemVer.isValidVersion(coderClient.buildVersion)) {
+                notificationBand.apply {
+                    isVisible = true
+                    icon = AllIcons.General.Warning
+                    text = CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.invalid.coder.version", coderClient.buildVersion)
+                }
+            } else {
+                val coderVersion = CoderSemVer.parse(coderClient.buildVersion)
+                val testedCoderVersion = CoderSupportedVersions.maxCoderVersion
+
+                if (!testedCoderVersion.isCompatibleWith(coderVersion)) {
+                    notificationBand.apply {
+                        isVisible = true
+                        icon = AllIcons.General.Warning
+                        text = CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.unsupported.coder.version", coderClient.buildVersion)
+                    }
+                }
+            }
         } catch (e: AuthenticationResponseException) {
             logger.error("Could not authenticate on ${localWizardModel.coderURL}. Reason $e")
             return
diff --git a/src/main/resources/messages/CoderGatewayBundle.properties b/src/main/resources/messages/CoderGatewayBundle.properties
@@ -15,6 +15,8 @@ gateway.connector.view.coder.workspaces.start.text=Start Workspace
 gateway.connector.view.coder.workspaces.stop.text=Stop Workspace
 gateway.connector.view.coder.workspaces.update.text=Update Workspace Template
 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.
+gateway.connector.view.coder.workspaces.unsupported.coder.version=Coder version {0} might not be compatible with this plugin version.
 gateway.connector.view.coder.remoteproject.loading.text=Retrieving products...
 gateway.connector.view.coder.remoteproject.ide.error.text=Could not retrieve any IDE for workspace {0} because an error was encountered
 gateway.connector.view.coder.remoteproject.next.text=Start IDE and connect
diff --git a/src/main/resources/version/CoderSupportedVersions.properties b/src/main/resources/version/CoderSupportedVersions.properties
@@ -0,0 +1 @@
+maxCoderVersion=0.12
