-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Bumped platform version to 241, added execution listener for Bazel runs * Changelog entry * Remove unused import * CR suggestions * Update IDE version in test
- Loading branch information
Showing
17 changed files
with
217 additions
and
51 deletions.
There are no files selected for viewing
This file contains 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 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 @@ | ||
| Added support for Bazel run configurations. |
This file contains 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 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 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,25 @@ | ||
| fun properties(key: String) = project.findProperty(key).toString() | ||
|
|
||
| plugins { | ||
| // Java support | ||
| id("java") | ||
| // Kotlin support | ||
| id("org.jetbrains.kotlin.jvm") version "1.8.22" | ||
| // Gradle IntelliJ Plugin | ||
| id("org.jetbrains.intellij") version "1.+" | ||
| } | ||
|
|
||
| tasks { | ||
| buildSearchableOptions { | ||
| enabled = false | ||
| } | ||
| } | ||
|
|
||
| intellij { | ||
| version.set(properties("platformVersion")) | ||
| plugins.set(listOf("com.google.idea.bazel.ijwb:2024.09.24.0.2-api-version-241")) | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation(project(":mirrord-core")) | ||
| } |
154 changes: 154 additions & 0 deletions
154
...ucts/bazel/src/main/kotlin/com/metalbear/mirrord/products/bazel/BazelExecutionListener.kt
This file contains 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,154 @@ | ||
| package com.metalbear.mirrord.products.bazel | ||
|
|
||
| import com.google.idea.blaze.base.run.BlazeCommandRunConfiguration | ||
| import com.google.idea.blaze.base.run.state.BlazeCommandRunConfigurationCommonState | ||
| import com.google.idea.blaze.base.scope.BlazeContext | ||
| import com.google.idea.blaze.base.settings.Blaze | ||
| import com.intellij.execution.ExecutionListener | ||
| import com.intellij.execution.process.ProcessHandler | ||
| import com.intellij.execution.runners.ExecutionEnvironment | ||
| import com.intellij.execution.target.createEnvironmentRequest | ||
| import com.intellij.execution.wsl.target.WslTargetEnvironmentRequest | ||
| import com.intellij.notification.NotificationType | ||
| import com.intellij.openapi.components.service | ||
| import com.intellij.openapi.util.SystemInfo | ||
| import com.metalbear.mirrord.MirrordLogger | ||
| import com.metalbear.mirrord.MirrordProjectService | ||
| import java.util.concurrent.ConcurrentHashMap | ||
|
|
||
| data class SavedConfigData(val envVars: Map<String, String>, val bazelPath: String?) | ||
|
|
||
| class BazelExecutionListener : ExecutionListener { | ||
| /** | ||
| * Preserves original configuration for active Bazel runs (user environment variables and Bazel binary path) | ||
| */ | ||
| private val savedEnvs: ConcurrentHashMap<String, SavedConfigData> = ConcurrentHashMap() | ||
|
|
||
| /** | ||
| * Tries to unwrap Bazel-specific state from generic execution environment. | ||
| */ | ||
| private fun getBlazeConfigurationState(env: ExecutionEnvironment): BlazeCommandRunConfigurationCommonState? { | ||
| val runProfile = env.runProfile as? BlazeCommandRunConfiguration ?: return null | ||
| val state = runProfile.handler.state as? BlazeCommandRunConfigurationCommonState | ||
| return state | ||
| } | ||
|
|
||
| override fun processStartScheduled(executorId: String, env: ExecutionEnvironment) { | ||
| val service = env.project.service<MirrordProjectService>() | ||
|
|
||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: $executorId $env") | ||
|
|
||
| val state = getBlazeConfigurationState(env) ?: run { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: Bazel not detected") | ||
| super.processStartScheduled(executorId, env) | ||
| return | ||
| } | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: got config state $state") | ||
|
|
||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: wsl check") | ||
| @Suppress("UnstableApiUsage") // `createEnvironmentRequest` | ||
| val wsl = when (val request = createEnvironmentRequest(env.runProfile, env.project)) { | ||
| is WslTargetEnvironmentRequest -> request.configuration.distribution!! | ||
| else -> null | ||
| } | ||
|
|
||
| val originalEnv = state.userEnvVarsState.data.envs | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: found ${originalEnv.size} original env variables") | ||
|
|
||
| val binaryToPatch = if (SystemInfo.isMac) { | ||
| state.blazeBinaryState.blazeBinary?.let { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: found Bazel binary path in the config: $it") | ||
| it | ||
| } ?: run { | ||
| // Bazel binary path may be missing from the config. | ||
| // This is the logic that Bazel plugin uses to find global Bazel binary. | ||
| val global = Blaze.getBuildSystemProvider(env.project).buildSystem.getBuildInvoker(env.project, BlazeContext.create()).binaryPath | ||
| MirrordLogger.logger.debug("[${this.javaClass.name} processStartScheduled: found global Bazel binary path: $global") | ||
| global | ||
| } | ||
| } else { | ||
| null | ||
| } | ||
|
|
||
| try { | ||
| service.execManager.wrapper("bazel", originalEnv).apply { | ||
| this.wsl = wsl | ||
| this.executable = binaryToPatch | ||
| }.start()?.let { executionInfo -> | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: adding ${executionInfo.environment.size} environment variables") | ||
| var envVars = originalEnv + executionInfo.environment | ||
| executionInfo.envToUnset?.let { envToUnset -> | ||
| envVars = envVars.filter { | ||
| !envToUnset.contains(it.key) | ||
| } | ||
| } | ||
| state.userEnvVarsState.setEnvVars(envVars) | ||
|
|
||
| val originalBinary = state.blazeBinaryState.blazeBinary | ||
| if (SystemInfo.isMac) { | ||
| executionInfo.patchedPath?.let { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: patchedPath is not null: $it, meaning original was SIP") | ||
| state.blazeBinaryState.blazeBinary = it | ||
| } ?: run { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: isMac, but not patching SIP (no patched path returned by the CLI).") | ||
| } | ||
| } | ||
|
|
||
| savedEnvs[executorId] = SavedConfigData(originalEnv, originalBinary) | ||
| } | ||
| } catch (e: Throwable) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStartScheduled: exception catched: ", e) | ||
| // Error notifications were already fired. | ||
| // We can't abort the execution here, so we let the app run without mirrord. | ||
| service.notifier.notifySimple( | ||
| "Cannot abort run due to platform limitations, running without mirrord", | ||
| NotificationType.WARNING | ||
| ) | ||
| } | ||
|
|
||
| super.processStartScheduled(executorId, env) | ||
| } | ||
|
|
||
| /** | ||
| * Restores original configuration after Bazel run has ended. | ||
| */ | ||
| private fun restoreConfig(executorId: String, configState: BlazeCommandRunConfigurationCommonState) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] restoreEnv: $executorId $configState") | ||
|
|
||
| val saved = savedEnvs.remove(executorId) ?: run { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] restoreConfig: no saved env found") | ||
| return | ||
| } | ||
|
|
||
| MirrordLogger.logger.debug("[${this.javaClass.name}] restoreConfig: found ${saved.envVars.size} saved original variables") | ||
| configState.userEnvVarsState.setEnvVars(saved.envVars) | ||
|
|
||
| if (SystemInfo.isMac) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] restoreConfig: found saved original Bazel path ${saved.bazelPath}") | ||
| configState.blazeBinaryState.blazeBinary = saved.bazelPath | ||
| } | ||
| } | ||
|
|
||
| override fun processTerminating(executorId: String, env: ExecutionEnvironment, handler: ProcessHandler) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processTerminating: $executorId $env $handler") | ||
|
|
||
| val state = getBlazeConfigurationState(env) ?: run { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processTerminating: Bazel not detected") | ||
| return | ||
| } | ||
|
|
||
| restoreConfig(executorId, state) | ||
|
|
||
| super.processTerminating(executorId, env, handler) | ||
| } | ||
|
|
||
| override fun processNotStarted(executorId: String, env: ExecutionEnvironment) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processNotStarted (noop): $executorId $env") | ||
| super.processNotStarted(executorId, env) | ||
| } | ||
|
|
||
| override fun processStarted(executorId: String, env: ExecutionEnvironment, handler: ProcessHandler) { | ||
| MirrordLogger.logger.debug("[${this.javaClass.name}] processStarted (noop): $executorId $env $handler") | ||
| super.processStarted(executorId, env, handler) | ||
| } | ||
| } |
This file contains 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 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 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 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 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 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 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 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 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,7 @@ | ||
| <idea-plugin> | ||
| <projectListeners> | ||
| <listener class="com.metalbear.mirrord.products.bazel.BazelExecutionListener" | ||
| topic="com.intellij.execution.ExecutionListener"/> | ||
| </projectListeners> | ||
| </idea-plugin> | ||
|
|
Oops, something went wrong.