PoC: add a cache redirector, make lock file independent of it

Author: fzhinkin

build.gradle.kts

@@ -15,6 +15,7 @@ plugins {
     id("benchmark-conventions")
     id("publishing-check-conventions")
     id("kover-conventions")
+    id("cache-redirector-conventions")
 
     alias(libs.plugins.serialization) apply false
 }
@@ -170,5 +171,3 @@ val documentedSubprojects
         "kotlinx-serialization-hocon",
         "kotlinx-serialization-protobuf"
     )
-
-project.configureJsCacheRedirector()

buildSrc/src/main/kotlin/cache-redirector-conventions.gradle.kts

@@ -0,0 +1,7 @@
+/*
+ * Copyright 2017-2026 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+if (project.findProperty("disable_js_cache_redirector")?.toString()?.toBooleanStrictOrNull() != true) {
+    project.configureJsCacheRedirector()
+}

buildSrc/src/main/kotlin/cacheRedirector.kt

@@ -2,10 +2,12 @@
  * Copyright 2017-2026 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
  */
 
-import org.gradle.api.Project
+import org.gradle.api.*
 import org.gradle.kotlin.dsl.the
-import org.gradle.kotlin.dsl.withType
-import org.jetbrains.kotlin.gradle.targets.js.yarn.YarnLockMismatchReport
+import kotlin.io.path.moveTo
+import kotlin.io.path.readText
+import kotlin.io.path.writeText
+import kotlin.text.replace
 
 const val DEFAULT_YARN_REGISTRY = "https://registry.yarnpkg.com"
 const val NPM_REGISTRY_CACHE = "https://cache-redirector.jetbrains.com/registry.npmjs.org"
@@ -14,18 +16,44 @@ const val YARN_DIST_CACHE = "https://cache-redirector.jetbrains.com/github.com/y
 
 fun Project.configureJsCacheRedirector() {
     rootProject.plugins.withType(org.jetbrains.kotlin.gradle.targets.js.yarn.YarnPlugin::class.java) {
-        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnRootExtension>().restoreYarnLockTaskProvider.configure {
-            doLast {
-                // yarn 1.x doesn't and won't support overriding registry used in yarn.lock, so we need to replace it manually
-                // https://github.com/yarnpkg/yarn/issues/6436#issuecomment-426728911
-                val lockFile = outputFile.get()
-                lockFile.writeText(lockFile.readText().replace(DEFAULT_YARN_REGISTRY, NPM_REGISTRY_CACHE))
+        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnRootExtension>().apply {
+            restoreYarnLockTaskProvider.configure {
+                doLast {
+                    // yarn 1.x doesn't and won't support overriding registry used in yarn.lock, so we need to replace it manually
+                    // https://github.com/yarnpkg/yarn/issues/6436#issuecomment-426728911
+                    val lockFile = outputFile.get()
+                    lockFile.writeText(lockFile.readText().replace(DEFAULT_YARN_REGISTRY, NPM_REGISTRY_CACHE))
+                }
+            }
+            // A hacky workaround helping to keep the original URLs in the lock file.
+            storeYarnLockTaskProvider.configure {
+                val originalLockFile = inputFile.get().asFile.toPath()
+                val tempReplacement = originalLockFile.resolveSibling("${originalLockFile.fileName}.${System.nanoTime()}")
+
+                doFirst {
+                    // Create a copy of the lock file with preserved URLs,
+                    // replace cache-redirector URLs with the original once in the yarn.lock file.
+                    originalLockFile.moveTo(tempReplacement)
+                    originalLockFile.writeText(
+                        tempReplacement.readText().replace(NPM_REGISTRY_CACHE, DEFAULT_YARN_REGISTRY)
+                    )
+                }
+                // In between doFirst and doLast, the task will compare the lock file with the checked-in one.
+                doLast {
+                    // Rename the lock file with cache-redirector URLs back to yarn.lock
+                    tempReplacement.moveTo(originalLockFile, true)
+                }
             }
         }
-        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnRootEnvSpec>().downloadBaseUrl.set(YARN_DIST_CACHE)
+
+        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnRootEnvSpec>().downloadBaseUrl.set(
+            YARN_DIST_CACHE
+        )
     }
 
     rootProject.plugins.withType(org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin::class.java) {
-        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsEnvSpec>().downloadBaseUrl.set(NODE_DIST_CACHE)
+        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsEnvSpec>().downloadBaseUrl.set(
+            NODE_DIST_CACHE
+        )
     }
 }

gradle.properties

@@ -25,3 +25,6 @@ kotlin.native.distribution.type=prebuilt
 org.gradle.jvmargs="-XX:+HeapDumpOnOutOfMemoryError"
 
 kotlin.internal.suppressGradlePluginErrors=DeprecatedKotlinNativeTargetsDiagnostic
+
+# Uncomment to disable cache redirector for NodeJs dist, Npm, and Yarn
+# disable_js_cache_redirector=true