[fleet] Move fleet.preferences to Community

(cherry picked from commit c526a74e350da83bde243e437731c9710d9241ac) FLEET-MR-6894 GitOrigin-RevId: 614efefbbd76ca2658b7db4d83db10dd76e24e0e
2026-09-27 10:03:11 +07:00 · 2025-10-09 10:46:21 +00:00
parent 5c5336f72b
commit 5cfaa39a22
15 changed files with 396 additions and 0 deletions
@@ -11,6 +11,7 @@
      <module fileurl="file://$PROJECT_DIR$/fleet/ktor/network/tls/fleet.ktor.network.tls.iml" filepath="$PROJECT_DIR$/fleet/ktor/network/tls/fleet.ktor.network.tls.iml" />
      <module fileurl="file://$PROJECT_DIR$/fleet/lsp.protocol/fleet.lsp.protocol.iml" filepath="$PROJECT_DIR$/fleet/lsp.protocol/fleet.lsp.protocol.iml" />
      <module fileurl="file://$PROJECT_DIR$/fleet/multiplatform.shims/fleet.multiplatform.shims.iml" filepath="$PROJECT_DIR$/fleet/multiplatform.shims/fleet.multiplatform.shims.iml" />
+      <module fileurl="file://$PROJECT_DIR$/fleet/preferences/fleet.preferences.iml" filepath="$PROJECT_DIR$/community/fleet/preferences/fleet.preferences.iml" />
      <module fileurl="file://$PROJECT_DIR$/fleet/reporting/api/fleet.reporting.api.iml" filepath="$PROJECT_DIR$/fleet/reporting/api/fleet.reporting.api.iml" />
      <module fileurl="file://$PROJECT_DIR$/fleet/reporting/shared/fleet.reporting.shared.iml" filepath="$PROJECT_DIR$/fleet/reporting/shared/fleet.reporting.shared.iml" />
      <module fileurl="file://$PROJECT_DIR$/fleet/rhizomedb/fleet.rhizomedb.iml" filepath="$PROJECT_DIR$/fleet/rhizomedb/fleet.rhizomedb.iml" />
@@ -228,6 +228,7 @@ fleet/kernel
 fleet/ktor/network/tls
 fleet/lsp.protocol
 fleet/multiplatform.shims
+fleet/preferences
 fleet/reporting/api
 fleet/reporting/shared
 fleet/rhizomedb
@@ -0,0 +1,30 @@
+### auto-generated section `build fleet.preferences` start
+load("//build:compiler-options.bzl", "create_kotlinc_options")
+load("@rules_jvm//:jvm.bzl", "jvm_library", "jvm_provided_library")
+
+create_kotlinc_options(
+  name = "custom_preferences",
+  x_consistent_data_class_copy_visibility = True,
+  x_context_parameters = True,
+  x_jvm_default = "all-compatibility",
+  x_lambdas = "class"
+)
+
+jvm_provided_library(
+  name = "fleet_util_multiplatform_provided",
+  lib = "//fleet/util/multiplatform"
+)
+
+jvm_library(
+  name = "preferences",
+  module_name = "fleet.preferences",
+  visibility = ["//visibility:public"],
+  srcs = glob(["srcCommonMain/**/*.kt", "srcCommonMain/**/*.java", "srcCommonMain/**/*.form", "srcJvmMain/**/*.kt", "srcJvmMain/**/*.java", "srcJvmMain/**/*.form"], allow_empty = True, exclude = ["**/module-info.java"]),
+  kotlinc_opts = ":custom_preferences",
+  deps = [
+    "@lib//:kotlin-stdlib",
+    "@lib//:kotlinx-io-core",
+    ":fleet_util_multiplatform_provided",
+  ]
+)
+### auto-generated section `build fleet.preferences` end
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="kotlin-language" name="Kotlin">
+      <configuration version="5" platform="JVM 21" allPlatforms="JVM [21]" useProjectSettings="false">
+        <compilerSettings>
+          <option name="additionalArguments" value="-Xlambdas=class -Xconsistent-data-class-copy-visibility -Xcontext-parameters -XXLanguage:+AllowEagerSupertypeAccessibilityChecks" />
+        </compilerSettings>
+        <compilerArguments>
+          <stringArguments>
+            <stringArg name="jvmTarget" arg="21" />
+            <stringArg name="apiVersion" arg="2.2" />
+            <stringArg name="languageVersion" arg="2.2" />
+          </stringArguments>
+          <arrayArguments>
+            <arrayArg name="pluginClasspaths">
+              <args>$MAVEN_REPOSITORY$/jetbrains/fleet/expects-compiler-plugin/2.2.20-0.1/expects-compiler-plugin-2.2.20-0.1.jar</args>
+            </arrayArg>
+          </arrayArguments>
+        </compilerArguments>
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/srcCommonMain" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/srcJvmMain" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/gradlebuild/build" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="kotlin-stdlib" level="project" />
+    <orderEntry type="library" name="kotlinx-io-core" level="project" />
+    <orderEntry type="module" module-name="fleet.util.multiplatform" scope="PROVIDED" />
+  </component>
+</module>
@@ -0,0 +1,72 @@
+// IMPORT__MARKER_START
+import fleet.buildtool.conventions.configureAtMostOneJvmTargetOrThrow
+import fleet.buildtool.conventions.withJavaSourceSet
+// IMPORT__MARKER_END
+plugins {
+  alias(libs.plugins.kotlin.multiplatform)
+  id("fleet.project-module-conventions")
+  id("fleet.toolchain-conventions")
+  id("fleet.module-publishing-conventions")
+  id("fleet.sdk-repositories-publishing-conventions")
+  id("fleet.open-source-module-conventions")
+  alias(libs.plugins.dokka)
+  // GRADLE_PLUGINS__MARKER_START
+  id("fleet-module")
+  alias(jps.plugins.expects)
+  // GRADLE_PLUGINS__MARKER_END
+}
+
+fleetModule {
+  module {
+    name = "fleet.preferences"
+    importedFromJps {}
+  }
+}
+
+@OptIn(org.jetbrains.kotlin.gradle.ExperimentalWasmDsl::class)
+kotlin {
+  sourceSets.wasmJsMain.dependencies {
+    implementation("org.jetbrains.kotlinx:kotlinx-browser:0.3")
+  }
+
+  // KOTLIN__MARKER_START
+  compilerOptions.freeCompilerArgs = listOf(
+    "-Xlambdas=class",
+    "-Xconsistent-data-class-copy-visibility",
+    "-Xcontext-parameters",
+    "-XXLanguage:+AllowEagerSupertypeAccessibilityChecks",
+  )
+  jvm {}
+  wasmJs {
+    browser {}
+  }
+  sourceSets.commonMain.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcCommonMain")) }
+  sourceSets.commonMain.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesCommonMain")) }
+  sourceSets.commonTest.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcCommonTest")) }
+  sourceSets.commonTest.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesCommonTest")) }
+  sourceSets.jvmMain.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcJvmMain")) }
+  configureAtMostOneJvmTargetOrThrow { compilations.named("main") { withJavaSourceSet { javaSourceSet -> javaSourceSet.java.srcDir(layout.projectDirectory.dir("../srcJvmMain")) } } }
+  sourceSets.jvmMain.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesJvmMain")) }
+  sourceSets.jvmTest.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcJvmTest")) }
+  configureAtMostOneJvmTargetOrThrow { compilations.named("test") { withJavaSourceSet { javaSourceSet -> javaSourceSet.java.srcDir(layout.projectDirectory.dir("../srcJvmTest")) } } }
+  sourceSets.jvmTest.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesJvmTest")) }
+  sourceSets.wasmJsMain.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcWasmJsMain")) }
+  sourceSets.wasmJsMain.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesWasmJsMain")) }
+  sourceSets.wasmJsTest.configure { kotlin.srcDir(layout.projectDirectory.dir("../srcWasmJsTest")) }
+  sourceSets.wasmJsTest.configure { resources.srcDir(layout.projectDirectory.dir("../resourcesWasmJsTest")) }
+  sourceSets.commonMain.dependencies {
+    implementation(jps.org.jetbrains.kotlin.kotlin.stdlib1993400674.get().let { "${it.group}:${it.name}:${it.version}" }) {
+      exclude(group = "org.jetbrains", module = "annotations")
+    }
+    implementation(jps.org.jetbrains.kotlinx.kotlinx.io.core.jvm479158162.get().let { "${it.group}:kotlinx-io-core:${it.version}" }) {
+      exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib")
+    }
+  }
+  sourceSets.jvmMain.dependencies {
+    compileOnly(project(":fleet.util.multiplatform"))
+  }
+  sourceSets.wasmJsMain.dependencies {
+    implementation(project(":fleet.util.multiplatform"))
+  }
+  // KOTLIN__MARKER_END
+}
@@ -0,0 +1,64 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import kotlinx.io.IOException
+import kotlinx.io.files.Path
+import kotlinx.io.files.SystemFileSystem
+
+// Paths for resources while running Fleet from sources
+// None of its methods should be called on production call path
+object FleetFromSourcesPaths {
+  val isRunningFromSources: Boolean by lazy {
+    !isFleetDistributionMode && findRepositoryRoot() != null
+  }
+
+  val intellijProjectRoot: Path by lazy {
+    requireNotNull(findRepositoryRoot()) {
+      "Cannot find IntelliJ repository root"
+    }.let { SystemFileSystem.resolve(it) }
+  }
+
+  val projectRoot: Path by lazy {
+    Path(intellijProjectRoot, "fleet")
+  }
+
+  // TODO: remove the usages of this property and delete it.
+  // Ideally `skiko.library.path` should always be set by the tooling or distribution argfile, making `skikoLibraryDirectory` property redundant.
+  // Currently, this is needed for GalleryApp and some isolated UI tests.
+  // Once our test running logic is unified, we will be able to wire the proper preparation steps to test runs avoiding such code.
+  val skikoLibraryDirectory: Path by lazy {
+    val skiko = Path(projectRoot, "build/fleet-skiko/build/skiko/buildPlatform")
+    require(skiko.takeIf { SystemFileSystem.exists(it) }?.let { SystemFileSystem.list(it) }?.isNotEmpty() == true) {
+      """
+        '$skiko' is empty or does not exist.
+        
+        Usually, this directory is automatically populated when required. However a few use cases are outside of the normal test flow.
+        If you are in such case (standalone noria UI tests, etc.), you should either:
+         - run `./fleet.sh :fleet-skiko:downloadSkikoForJps` Gradle command
+         - or, set the JVM system property `skiko.library.path` to a valid skiko downloaded on your machine
+        
+        If you ran through a JPS configuration, probably it is misconfigured, please contact #fleet-platform.
+        If you ran through the Fleet Gradle build tooling, probably it is misconfigured, please contact #fleet-platform.
+      """.trimIndent()
+    }
+    skiko
+  }
+
+  private fun findRepositoryRoot(): Path? {
+    var directory: Path? = findFleetRootByClass()
+    while (directory != null) {
+      if (directory.name != "community") {
+        try {
+          val children = SystemFileSystem.list(directory).map(Path::name).toSet()
+          if (children.contains(".idea") && children.contains("fleet")) {
+            return directory
+          }
+        }
+        catch (_: IOException) {
+        }
+      }
+      directory = directory.parent
+    }
+    return null
+  }
+}
@@ -0,0 +1,48 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.linkToActual
+
+// True means one wants to investigate how fleet itself works (e.g. enable verbose logging or increase transport delays)
+val isFleetDebugMode: Boolean by lazy { fleetFlag("fleet.debug.mode") }
+
+// Enable auxiliary features to facilitate dev flow e.g. code reload etc. It means that we're running from sources.
+@Deprecated("most probably you want use FleetFromSourcesPaths.isRunningFromSources or FleetCommonSettingsKeys.kt#isInternalMode")
+val isFleetDevMode: Boolean by lazy { getFleetEnvironmentType() == FleetEnvironmentType.DEVELOPMENT }
+
+// Defined the default value for internal mode
+@Deprecated(
+  "we still have usages due to lack of dependency injection, most probably you want use FleetCommonSettingsKeys.kt#isInternalMode")
+val isFleetInternalDefaultValue: Boolean by lazy { fleetFlag("fleet.internal.mode.default") }
+
+// Fleet is running as a built distribution
+val isFleetDistributionMode: Boolean by lazy { getFleetEnvironmentType() == FleetEnvironmentType.PRODUCTION }
+
+// The distribution is not published on the marketplace, features that depend on it, should do workarounds:
+// e.g. upload required resources to the Space in the runtime
+val isFleetUnpublishedBuild: Boolean by lazy { fleetFlag("fleet.unpublished.build") }
+
+// Defines whether we are under testing. If set to true, some components will be mocked.
+val isFleetTestMode: Boolean by lazy { getFleetEnvironmentType() == FleetEnvironmentType.TEST }
+
+val isFleetShortCircuitMode: Boolean by lazy {
+  fleetFlag("fleet.shortCircuit", when {
+    isFleetTestMode -> false
+    isFleetInternalDefaultValue -> false
+    else -> true
+  })
+}
+
+val coroutinesDebugProbesEnabled: Boolean by lazy { fleetFlag("fleet.coroutines.debug.probes.enabled") }
+
+fun fleetFlag(name: String, defaultValue: Boolean = false): Boolean = fleetProperty(name)?.toBoolean() ?: defaultValue
+
+fun fleetProperty(name: String, defaultValue: String? = null): String? = linkToActual()
+
+internal enum class FleetEnvironmentType {
+  PRODUCTION,
+  DEVELOPMENT,
+  TEST
+}
+
+internal fun getFleetEnvironmentType(): FleetEnvironmentType = linkToActual()
@@ -0,0 +1,7 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.linkToActual
+import kotlinx.io.files.Path
+
+internal fun findFleetRootByClass(): Path? = linkToActual()
@@ -0,0 +1,46 @@
+package fleet.preferences
+
+object TracingConfigProperties {
+  //@fleet.kernel.plugins.InternalInPluginModules(where = ["fleet.reporting.opentelemetry"])
+  val otelGrpcEndpoint: String? by lazy { fleetProperty("fleet.diagnostic.otel.grpc.endpoint", null) }
+  val otelHttpEndpoint: String? by lazy { fleetProperty("fleet.diagnostic.otel.http.endpoint", null) }
+  val otelTracesDir: String? by lazy { fleetProperty("fleet.diagnostic.otel.traces.dir", null) }
+
+  //@fleet.kernel.plugins.InternalInPluginModules(where = ["fleet.reporting.opentelemetry"])
+  val metricsFile: String? by lazy { fleetProperty("fleet.diagnostic.metrics.file", null) }
+
+  val fahrplanStartupFile: String? by lazy { fleetProperty("fahrplan.startup", null) }
+
+  //@fleet.kernel.plugins.InternalInPluginModules(where = ["fleet.reporting.opentelemetry"])
+  val fahrplanEnabled: Boolean by lazy {
+    fahrplanStartupFile != null ||
+    (fleetProperty("fleet.diagnostic.fahrplan.enabled", null)?.toBoolean() ?: isFleetInternalDefaultValue)
+  }
+  val openTelemetryEnabled: Boolean by lazy {
+    isFleetInternalDefaultValue ||
+    otelGrpcEndpoint != null ||
+    otelHttpEndpoint != null ||
+    otelTracesDir != null ||
+    metricsFile != null ||
+    ijPerfFile != null
+  }
+
+  //@fleet.kernel.plugins.InternalInPluginModules(where = ["fleet.reporting.opentelemetry"])
+  val ijPerfFile: String? by lazy { fleetProperty("fleet.diagnostic.ijperf.file", null) }
+
+  val fusSchemaDir: String? by lazy { fleetProperty("fleet.diagnostic.fus.schema.dir", null) }
+  val schemaGenerationMode: Boolean by lazy { fusSchemaDir != null } //todo [MM] maybe rewrite to fleet.dock.impl.RunMode
+  val ijPerfSpanPrefix: String? by lazy { fleetProperty("fleet.diagnostic.ijperf.span.prefix") }
+
+  val performanceTestMode: Boolean by lazy {
+    (ijPerfFile != null || fahrplanStartupFile != null) &&
+    !fleetProperty("fleet.diagnostic.suppress.quit", "false").toBoolean()
+  }
+
+  //does a number of things to simplify FUS testing
+  // 1. does not update metadata (allows to work with modified metadata)
+  // 2. disables bucket check (sends always)
+  // 3. does not remove fus files (allows reading what is actually sent)
+  // 4. shows a directory with fus files on startup
+  val fusTestingMode: Boolean by lazy { fleetProperty("fleet.diagnostic.fus.testing.mode", "false").toBoolean() }
+}
@@ -0,0 +1,19 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.Actual
+
+@Actual("fleetProperty")
+internal fun fleetPropertyJvm(name: String, defaultValue: String?): String? {
+  val formattedName = name.replace('.', '_').uppercase()
+  return System.getProperty(name) ?: System.getenv(formattedName) ?: defaultValue
+}
+
+@Actual
+internal fun getFleetEnvironmentTypeJvm(): FleetEnvironmentType {
+  return when {
+    fleetFlag("fleet.distribution.mode") -> FleetEnvironmentType.PRODUCTION
+    fleetFlag("fleet.dev.mode") -> FleetEnvironmentType.DEVELOPMENT
+    else -> FleetEnvironmentType.TEST
+  }
+}
@@ -0,0 +1,20 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.Actual
+import kotlinx.io.files.Path
+import java.net.URL
+import kotlin.io.path.absolutePathString
+import kotlin.io.path.pathString
+import kotlin.io.path.toPath
+import kotlin.jvm.javaClass
+
+@Actual("findFleetRootByClass")
+internal fun findFleetRootByClassJvm(): Path? {
+  val url: URL? = FleetFromSourcesPaths.javaClass.getResource("/${FleetFromSourcesPaths.javaClass.name.replace('.', '/')}.class")
+  return when (url?.protocol) {
+    "file" -> url.toURI().toPath()
+    "jar" -> URL(url.file).toURI().toPath().pathString.split("!").firstOrNull()?.let { java.nio.file.Path.of(it) }
+    else -> null
+  }?.absolutePathString()?.let { Path(it) }
+}
@@ -0,0 +1,9 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import java.nio.file.Path
+
+@Deprecated("java Paths are not multiplatform. Please consider using kotlnx.io Path if possible")
+fun kotlinx.io.files.Path.toNioPath(): Path = Path.of(this.toString())
+
+fun kotlinx.io.files.Path.resolve(childPath: String): kotlinx.io.files.Path = kotlinx.io.files.Path(this, childPath)
@@ -0,0 +1,34 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.Actual
+import kotlinx.browser.window
+
+@Actual("fleetProperty")
+fun fleetPropertyWasmJs(name: String, defaultValue: String?): String? = when (name) {
+  "fleet.ai.service.configuration.url" -> url("aiconfig")
+  "fleet.ai.service.url" -> url("ai")
+  else -> defaultValue
+}
+
+@Actual
+internal fun getFleetEnvironmentTypeWasmJs(): FleetEnvironmentType {
+  return when (ENVIRONMENT) {
+    "production" -> FleetEnvironmentType.PRODUCTION
+    "development" -> FleetEnvironmentType.DEVELOPMENT
+    else -> FleetEnvironmentType.TEST
+  }
+}
+
+/**
+ * the property represents webpack's `config.mode` value
+ */
+@JsName("ENVIRONMENT")
+external val ENVIRONMENT: String
+
+private fun url(suffix: String): String {
+  return sequenceOf(window.location.origin, window.location.pathname, suffix)
+    .map { it.trim('/') }
+    .filter { it.isNotEmpty() }
+    .joinToString(separator = "/")
+}
@@ -0,0 +1,8 @@
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package fleet.preferences
+
+import fleet.util.multiplatform.Actual
+import kotlinx.io.files.Path
+
+@Actual("findFleetRootByClass")
+internal fun findFleetRootByClassWasmJs(): Path? = null