WIP: Migrate to IntelliJ Platform Gradle Plugin 2.0 #879

citizenmatt · 2024-05-09T13:10:19Z

This PR migrates to the new IntelliJ Platform Gradle Plugin 2.0 (beta2). This is necessary to target 242, but more importantly, allows us to use "split mode" to reproduce and debug remote development issues. It's also easier to configure, and makes it easy to run the plugin in a different IDE, even locally built or installed IDEs.

It is still a work in progress, and not yet ready to merge. I will be actively updating and force-pushing changes into this branch.

The following build features work as expected:

Build, run and debug the plugin, including loading the AceJump (optional) dependency
Build, run and debug :test, vim-engine:test, and java-tests:test
Separately run long-running-tests and property-tests (there are failures, but these match master)
Plugin verifier runs with a default IDE based on the configured settings (using the since-build value, so it's testing 233). The task name has changed from runPluginVerifier to verifyPlugin, so the "IdeaVim full verification" run configuration has been updated
The since-build value is specified in both build.gradle.kts and plugin.xml. It would be better to specify it just once, and have the DevKit and the plugin verifier automatically pick this up from a single source
UI tests aren't currently running. The download robot task is commented out, as it should be moved to a normal dependency. The UI test task is not yet supported by the gradle plugin.

Other changes:

settings.gradle has been migrated to settings.gradle.kts
The Gradle plugin writes various files to .intellijPlatform/ (Ivy XML files to reference bundled plugins, etc.) This folder is added to .gitignore
A new runIdeSplitMode task and equivalent "Start IJ with IdeaVim (Split Mode)" run configuration have been added, to run the IDE in split mode, with the plugin loaded in the frontend, as per remote dev/CWM.
Running split mode in the frontend requires 242+ at runtime, so the task currently has a hardcoded EAP version. A better strategy should be figured out.
The createOpenApiSourcesJar has been renamed sourcesJar to match the default task created with java.withSourcesJar(). This also means the final file is renamed IdeaVIM-{version}-sources.jar instead of having the -src.jar suffix. This needs verifying for any external CI processes that need to call the task, or rely on the name of the file

There are also the following IdeaVim issues, which aren't required for this PR, but should be noted and fixed at some point:

The plugin distribution zip currently includes annotation-processors.jar, which is not required at run time
The CodeQL GitHub action fails due to picking the wrong Java version to compile with. We could update the action, or wait for it to be fixed. Issue 1855 on the github/codeql-action says it's being actively worked on and should therefore be released soon (not linked directly to the issue to prevent an unnecessary pingback on the ticket). This might be fixed in codeql-cli-2.17.4, but this doesn't appear to be used/released yet.
There are currently 3 failing tests. This is unrelated to the Gradle plugin migration. See VIM-3376. (Will be fixed in next rebase/force-push)

citizenmatt · 2024-05-09T13:11:07Z

build.gradle.kts

+  // TODO: Robot server task not yet available
+//  downloadRobotServerPlugin {
+//    version.set(remoteRobotVersion)
+//  }


What's supposed to happen with this task?

The downloadRobotServerPlugin is removed. The Robot Server Plugin will be added through the dependencies {} block.
ATM, the testIdeUI and testIdePerformance tasks are not available yet, but they will be there soon!

citizenmatt · 2024-05-09T13:11:24Z

build.gradle.kts

+//    systemProperty("jb.consents.confirmation.enabled", "false")
+//    systemProperty("ide.show.tips.on.startup.default.value", "false")
+//    systemProperty("octopus.handler", System.getProperty("octopus.handler") ?: true)
+//  }


Also this task? I don't know how the current UI tests work...

WIP, tasks will be available soon.

citizenmatt · 2024-05-09T13:12:12Z

build.gradle.kts

+      // TODO: Do we need this to be here *and* in plugin.xml?
+      sinceBuild.set("233.11799.67")
+      untilBuild.set(provider { null })
+    }


If we set since-build here, will the Plugin DevKit use it for analysis? We have it duplicated in plugin.xml right now, it would be nice to only set in one place

You can set it in Gradle build file only. Those values are used by the patchPluginXml file to update the plugin.xml file. All further checks performed by the Gradle plugin respect those values.

What about the DevKit though? Does it look at the patched or unpatched plugin.xml?

After some tests, it seems that DevKit only uses the value in the unpatched plugin.xml, so it's still worth keeping both values, even though it would make things easier to specify only in the build scripts

build.gradle.kts

citizenmatt · 2024-05-09T13:14:02Z

build.gradle.kts

+    instrumentationTools()
+
+    testFramework(TestFrameworkType.Platform.JUnit4)
+    testFramework(TestFrameworkType.Platform.JUnit5)


It seems unexpected to require two frameworks, but it fails with only one, and runs with two, so...

Either unresolved items (the @RunInEdt annotation) or runtime failures, also about the wrong threading models. Is it expected to require two frameworks?

It's unexpected. I'll take a look.

AlexPl292 · 2024-05-24T15:06:43Z

As a not, we HAVE to use 2.0 to target 242: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#usage

citizenmatt commented May 9, 2024

View reviewed changes

citizenmatt force-pushed the feature/gradle-intellij-plugin-v2 branch 6 times, most recently from f274fff to 5356fed Compare May 15, 2024 10:52

citizenmatt force-pushed the feature/gradle-intellij-plugin-v2 branch from 5356fed to 2ec7a33 Compare May 23, 2024 16:00

citizenmatt added 3 commits May 28, 2024 14:34

Move KSP gradle config blocks

a161f3e

Rename settings.gradle to settings.gradle.kts

55f2db4

Convert settings.gradle to Kotlin

7d6e2d5

citizenmatt force-pushed the feature/gradle-intellij-plugin-v2 branch 2 times, most recently from 205a7c6 to b272bbf Compare May 28, 2024 16:21

citizenmatt added 2 commits May 29, 2024 17:18

Migrate to IntelliJ Platform Gradle Plugin 2.0

b1db8ba

Add task to run IDE in split mode

e8150ee

citizenmatt force-pushed the feature/gradle-intellij-plugin-v2 branch from b272bbf to e8150ee Compare May 29, 2024 16:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Migrate to IntelliJ Platform Gradle Plugin 2.0 #879

WIP: Migrate to IntelliJ Platform Gradle Plugin 2.0 #879

citizenmatt commented May 9, 2024 •

edited

citizenmatt May 9, 2024

hsz May 9, 2024

citizenmatt May 9, 2024

hsz May 9, 2024

citizenmatt May 9, 2024

hsz May 9, 2024

citizenmatt May 9, 2024

citizenmatt May 9, 2024

citizenmatt May 9, 2024

hsz May 9, 2024

citizenmatt May 9, 2024

hsz May 9, 2024

AlexPl292 commented May 24, 2024

WIP: Migrate to IntelliJ Platform Gradle Plugin 2.0 #879

Are you sure you want to change the base?

WIP: Migrate to IntelliJ Platform Gradle Plugin 2.0 #879

Conversation

citizenmatt commented May 9, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexPl292 commented May 24, 2024

citizenmatt commented May 9, 2024 •

edited