impl: support for unlimited 'Until Build' setting (#549)

* chore: upgrade Gradle to 8.5 the latest version

This upgrade is needed in order to be able to upgrade the gateway/intellij
platform plugins.

* chore: upgrade Gradle IntelliJ Plugin

This is needed in order to be able to specify "unlimited until builds".
IntelliJ Platform Gradle Plugin 2.x is the build system that supersedes
the Gradle IntelliJ Plugin 1.x, and this is the version that comes with
the ability to provide unlimited until build support.

This is a major overhaul of the DSL, I've tested these changes locally with
GW 2023.3 (the minimum supported version), and I've also compared the plugin.xml
with a previous version to make sure it is generated correctly.

* impl: support for unlimited 'Until Build' setting

Every time a new GW version is released we need to change the untilBuild setting.
With latest IntelliJ Platform Plugin we can provide unlimited upper range with no
manual intervention each time a new release is happening.

* chore: simplify build script

Use gateway DSL to provide the platform type and version.
The plugin verification as well as the platform type depends on the versions in the format "2025.x"

* fix: merge from main was botched

* fix: missing junit4 dependency for IntelliJ test framework

We don't have any UI tests but the test task still fails because it misses junit 4 dependencies.
For the unit tests we use kotlin tests library with junit 5 as a backend.

* fix: task was renamed

listProductsReleases was renamed to printProductsReleases in version 2.x

* chore: use latest version 2.6.0 for the platform plugin

Author: fioan89

.github/workflows/build.yml

@@ -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

.gitignore

@@ -14,6 +14,7 @@
 ## Gradle
 .gradle
 build
+jvm/
 
 ## Qodana
 .qodana

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 <!-- Plugin description --> section from README.md and provide for the plugin's manifest
+        description = providers.fileContents(layout.projectDirectory.file("README.md")).asText.map {
+            val start = "<!-- Plugin description -->"
+            val end = "<!-- Plugin description 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<JavaCompile> {
-            sourceCompatibility = it
-            targetCompatibility = it
-        }
-        withType<KotlinCompile> {
-            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 <!-- Plugin description --> section from README.md and provide for the plugin's manifest
-        pluginDescription.set(
-            projectDir.resolve("README.md").readText().lines().run {
-                val start = "<!-- Plugin description -->"
-                val end = "<!-- Plugin description 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", "<!--999.999-->")
-        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=<!--999.999-->",
+                        "-Djb.consents.confirmation.enabled=false",
+                    )
+                }
+            }
 
-    runPluginVerifier {
-        ideVersions.set(properties("verifyVersions").split(","))
+            plugins {
+                robotServerPlugin()
+            }
+        }
     }
-}
+}

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.20.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=243.26053
-# 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=251.*
 # 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=251.*
 # (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=243.26053-EAP-CANDIDATE-SNAPSHOT
-instrumentationCompiler=243.26053-EAP-CANDIDATE-SNAPSHOT
+platformVersion=2024.3
 # Gateway does not have open sources.
 platformDownloadSources=true
+# 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

gradle/wrapper/gradle-wrapper.jar

@@ -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