Install unbundled plugin dependencies into dev IDE #SCL-23786 fixed

Install the plugin dependencies and updates into `<ideaHome>/sdk/%version%/custom-plugins`. This keeps an option to roll back a bundled plugin update compared to `<ideaHome>/sdk/%version%/plugins` and supports versioning compared to `<ideaHome>/system/plugins`, i.e.: you can have different plugins/versions in different branches.

Pass this path as `-Didea.plugins.path` so that IDE's plugin manager could pick up these custom plugins

Author: timaliberdov

ideaSupport/src/main/scala/org/jetbrains/sbtidea/download/api/IdeInstallationProcessContext.scala

@@ -1,5 +1,6 @@
 package org.jetbrains.sbtidea.download.api
 
+import org.jetbrains.sbtidea.download.api.IdeInstallationContext.customPluginsDirName
 import org.jetbrains.sbtidea.productInfo.{ProductInfo, ProductInfoParser}
 import sbt.pathToPathOps
 
@@ -18,7 +19,21 @@ sealed class IdeInstallationContext(
     ProductInfoParser.parse(productInfoFile.toFile)
   }
 
-  def pluginsDir: Path = baseDirectory / "plugins"
+  /**
+   * Represents the path to the "custom" plugins:
+   *   - installed via Marketplace;
+   *   - installed via "Install Plugin from Disk";
+   *   - plugins from [[org.jetbrains.sbtidea.Keys.intellijPlugins]], except bundled;
+   *   - a plugin from `org.jetbrains.sbtidea.packaging.PackagingKeys.packageOutputDir` when running locally;
+   *   - updates for bundled plugins.
+   *
+   * Passed to the IDE via `-Didea.plugins.path` option, see [[org.jetbrains.sbtidea.runIdea.IntellijVMOptionsBuilder.build]]
+   */
+  def pluginsDir: Path = baseDirectory / customPluginsDirName
+}
+
+object IdeInstallationContext {
+  val customPluginsDirName: String = "custom-plugins"
 }
 
 /**
@@ -31,4 +46,4 @@ sealed class IdeInstallationContext(
 final class IdeInstallationProcessContext(
   baseDirectory: Path,
   val artifactsDownloadsDir: Path
-) extends IdeInstallationContext(baseDirectory)
+) extends IdeInstallationContext(baseDirectory)

ideaSupport/src/main/scala/org/jetbrains/sbtidea/download/plugin/RepoPluginInstaller.scala

@@ -49,20 +49,21 @@ class RepoPluginInstaller(buildInfo: BuildInfo)
     downloadInfo: Option[PluginDownloadInfo] = None
   )(implicit ctx: IdeInstallationContext): Path = {
     val downloadedPluginFileNameHint = downloadInfo.map(_.downloadedFileName).fold("")(name => s" ($name)")
+    val pluginsInstallationDir = Files.createDirectories(ctx.pluginsDir)
     val installedPluginRoot = if (!PluginXmlDetector.Default.isPluginJar(artifact)) {
       val tmpPluginDir = extractPluginToTemporaryDir(
         artifact,
         plugin,
         s"${buildInfo.edition.name}-${buildInfo.buildNumber}-plugin"
       )
-      val installDir = ctx.pluginsDir.resolve(tmpPluginDir.getFileName)
+      val installDir = pluginsInstallationDir.resolve(tmpPluginDir.getFileName)
       NioUtils.delete(installDir)
       Files.move(tmpPluginDir, installDir)
       NioUtils.delete(tmpPluginDir.getParent)
       log.info(s"Installed plugin '$plugin'$downloadedPluginFileNameHint to $installDir")
       installDir
     } else {
-      val targetJar = ctx.pluginsDir.resolve(artifact.getFileName)
+      val targetJar = pluginsInstallationDir.resolve(artifact.getFileName)
       Files.move(artifact, targetJar)
       log.info(s"Installed plugin '$plugin'$downloadedPluginFileNameHint to $targetJar")
       targetJar

ideaSupport/src/main/scala/org/jetbrains/sbtidea/runIdea/IntellijVMOptionsBuilder.scala

@@ -1,6 +1,7 @@
 package org.jetbrains.sbtidea.runIdea
 
 import org.jetbrains.sbtidea.*
+import org.jetbrains.sbtidea.download.api.IdeInstallationContext
 import org.jetbrains.sbtidea.download.{IntelliJVersionDetector, Version}
 import org.jetbrains.sbtidea.productInfo.ProductInfoExtraDataProvider
 import org.jetbrains.sbtidea.runIdea.CustomIntellijVMOptions.DebugInfo
@@ -133,7 +134,7 @@ final case class IntellijVMOptionsBuilder(
     }
     val (systemPath, configPath) = (ideaHome.resolve(systemDirName), ideaHome.resolve(configDirName))
 
-    val customPluginsPath = systemPath.resolve("plugins")
+    val customPluginsPath = intellijDirectory.resolve(IdeInstallationContext.customPluginsDirName)
     val logPath = systemPath.resolve("log")
 
     // IntelliJ requires all these paths to be set when "idea.paths.selector" VM options is used (that comes from product-info.json)
@@ -230,6 +231,8 @@ object IntellijVMOptionsBuilder {
       else (ideaHome.resolve("system"), ideaHome.resolve("config"))
     buffer += s"-Didea.system.path=${OQ(system.toString)}"
     buffer += s"-Didea.config.path=${OQ(config.toString)}"
+    val customPlugins = intellijDirectory.resolve(IdeInstallationContext.customPluginsDirName)
+    buffer += s"-Didea.plugins.path=${OQ(customPlugins.toString)}"
     buffer += s"-Dplugin.path=${OQ(pluginPath.toString)}"
     if (forTests) {
       buffer += "-Didea.use.core.classloader.for.plugin.path=true"

ideaSupport/src/test/scala/org/jetbrains/sbtidea/IdeaVmOptionsTest.scala

@@ -77,8 +77,9 @@ class IdeaVmOptionsTest extends AnyFunSuite with Matchers {
 
   private val mustBeQuoted = Seq(
     "plugin.path",
+    "idea.config.path",
+    "idea.plugins.path",
     "idea.system.path",
-    "idea.config.path"
   )
 
   test("paths are quoted in xml version") {

ideaSupport/src/test/scala/org/jetbrains/sbtidea/integrationTests/SbtIdeaPluginIntegrationTest.scala

@@ -52,7 +52,9 @@ class SbtIdeaPluginIntegrationTest
     val intellijSdkRoot = runUpdateIntellijCommand("simple-with-plugin")
 
     doCommonAssertions(intellijSdkRoot)
-    assertFileExists(intellijSdkRoot / "plugins" / "Scala")
+    assertFileDoesNotExist(intellijSdkRoot / "plugins" / "Scala")
+    assertFileExists(intellijSdkRoot / "custom-plugins")
+    assertFileExists(intellijSdkRoot / "custom-plugins" / "Scala")
     assertSourcesDirectoryContents(intellijSdkRoot, Seq(
       "ideaIC-243.22562.145-sources.zip"
     ))
@@ -68,6 +70,7 @@ class SbtIdeaPluginIntegrationTest
       "ideaIU-243.22562.145-sources.zip"
     ))
     assertFileDoesNotExist(intellijSdkRoot / "plugins" / "scala")
+    assertFileDoesNotExist(intellijSdkRoot / "custom-plugins")
     new IdeInstallationContext(intellijSdkRoot.toPath).productInfo.productCode shouldBe "IU"
   }
 
@@ -151,4 +154,4 @@ class SbtIdeaPluginIntegrationTest
 
     intellijSdkRoot / "sdk" / CommonIntellijBuild
   }
-}
+}