Create a friends configuration to use internals. (#8651)

* Create a friends configuration to use internals. From https://www.liutikas.net/2025/01/12/Kotlin-Library-Friends.html we should avoid using @file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE") So instead lets just be friends.
2025-08-08 23:42:08 +03:00 · 2025-05-10 12:15:14 +01:00
parent 889bb7b009
commit f2640e0b08
35 changed files with 71 additions and 38 deletions
--- a/android-test/build.gradle.kts
+++ b/android-test/build.gradle.kts
@@ -60,13 +60,15 @@ android {
 dependencies {
  implementation(libs.kotlin.reflect)
  implementation(libs.playservices.safetynet)
-  implementation(projects.okhttp)
+  "friendsImplementation"(projects.okhttp)
+  "friendsImplementation"(projects.okhttpDnsoverhttps)

+  testImplementation(projects.okhttp)
  testImplementation(libs.junit)
  testImplementation(libs.junit.ktx)
  testImplementation(libs.assertk)
  testImplementation(projects.okhttpTls)
-  testImplementation(projects.loggingInterceptor)
+  "friendsTestImplementation"(projects.loggingInterceptor)
  testImplementation(libs.androidx.test.runner)
  testImplementation(libs.robolectric)
  testImplementation(libs.androidx.espresso.core)
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -10,6 +10,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.kotlinExtension
 import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.jetbrains.kotlin.gradle.utils.addExtendsFromRelation
 import ru.vyarus.gradle.plugin.animalsniffer.AnimalSnifferExtension
 import java.net.URI

@@ -286,6 +287,51 @@ subprojects {
      languageSettings.optIn("okhttp3.ExperimentalOkHttpApi")
    }
  }
+
+  // From https://www.liutikas.net/2025/01/12/Kotlin-Library-Friends.html
+
+    // Create configurations we can use to track friend libraries
+  configurations {
+    val friendsApi = register("friendsApi") {
+      isCanBeResolved = true
+      isCanBeConsumed = false
+      isTransitive = true
+    }
+    val friendsImplementation = register("friendsImplementation") {
+      isCanBeResolved = true
+      isCanBeConsumed = false
+      isTransitive = false
+    }
+    val friendsTestImplementation = register("friendsTestImplementation") {
+      isCanBeResolved = true
+      isCanBeConsumed = false
+      isTransitive = false
+    }
+    configurations.configureEach {
+      if (name == "implementation") {
+        extendsFrom(friendsApi.get(), friendsImplementation.get())
+      }
+      if (name == "api") {
+        extendsFrom(friendsApi.get())
+      }
+      if (name == "testImplementation") {
+        extendsFrom(friendsTestImplementation.get())
+      }
+    }
+  }
+
+    // Make these libraries friends :)
+    tasks.withType<KotlinCompile>().configureEach {
+      configurations.findByName("friendsApi")?.let {
+        friendPaths.from(it.incoming.artifactView { }.files)
+      }
+      configurations.findByName("friendsImplementation")?.let {
+        friendPaths.from(it.incoming.artifactView { }.files)
+      }
+      configurations.findByName("friendsTestImplementation")?.let {
+        friendPaths.from(it.incoming.artifactView { }.files)
+      }
+    }
 }

 /** Configure publishing and signing for published Java and JavaPlatform subprojects. */
--- a/mockwebserver-deprecated/build.gradle.kts
+++ b/mockwebserver-deprecated/build.gradle.kts
@@ -15,7 +15,7 @@ tasks.jar {
 }

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  api(projects.mockwebserver3)
  api(libs.junit)

--- a/mockwebserver-deprecated/src/main/kotlin/okhttp3/mockwebserver/MockResponse.kt
+++ b/mockwebserver-deprecated/src/main/kotlin/okhttp3/mockwebserver/MockResponse.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.mockwebserver

--- a/mockwebserver-junit4/build.gradle.kts
+++ b/mockwebserver-junit4/build.gradle.kts
@@ -15,6 +15,7 @@ tasks.jar {
 }

 dependencies {
+  api(projects.okhttp)
  api(projects.mockwebserver3)
  api(libs.junit)

--- a/mockwebserver-junit5/build.gradle.kts
+++ b/mockwebserver-junit5/build.gradle.kts
@@ -21,6 +21,7 @@ tasks {
 }

 dependencies {
+  api(projects.okhttp)
  api(projects.mockwebserver3)
  api(libs.junit.jupiter.api)
  compileOnly(libs.animalsniffer.annotations)
--- a/mockwebserver/build.gradle.kts
+++ b/mockwebserver/build.gradle.kts
@@ -15,7 +15,7 @@ tasks.jar {
 }

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)

  testImplementation(projects.okhttpTestingSupport)
  testImplementation(projects.okhttpTls)
--- a/mockwebserver/src/main/kotlin/mockwebserver3/MockResponse.kt
+++ b/mockwebserver/src/main/kotlin/mockwebserver3/MockResponse.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package mockwebserver3

--- a/mockwebserver/src/main/kotlin/mockwebserver3/MockWebServer.kt
+++ b/mockwebserver/src/main/kotlin/mockwebserver3/MockWebServer.kt
@@ -14,7 +14,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package mockwebserver3

--- a/mockwebserver/src/test/java/mockwebserver3/RecordedRequestTest.kt
+++ b/mockwebserver/src/test/java/mockwebserver3/RecordedRequestTest.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package mockwebserver3

--- a/okhttp-dnsoverhttps/build.gradle.kts
+++ b/okhttp-dnsoverhttps/build.gradle.kts
@@ -15,7 +15,7 @@ project.applyOsgi(
 )

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  compileOnly(libs.findbugs.jsr305)

  testImplementation(projects.okhttpTestingSupport)
--- a/okhttp-dnsoverhttps/src/main/kotlin/okhttp3/dnsoverhttps/DnsOverHttps.kt
+++ b/okhttp-dnsoverhttps/src/main/kotlin/okhttp3/dnsoverhttps/DnsOverHttps.kt
@@ -208,17 +208,18 @@ class DnsOverHttps internal constructor(
      .apply {
        val query = DnsRecordCodec.encodeQuery(hostname, type)

+        val dnsUrl: HttpUrl = this@DnsOverHttps.url
        if (post) {
-          url(url)
+          url(dnsUrl)
            .cacheUrlOverride(
-              url
+              dnsUrl
                .newBuilder()
                .addQueryParameter("hostname", hostname)
                .build(),
            ).post(query.toRequestBody(DNS_MESSAGE))
        } else {
          val encoded = query.base64Url().replace("=", "")
-          val requestUrl = url.newBuilder().addQueryParameter("dns", encoded).build()
+          val requestUrl = dnsUrl.newBuilder().addQueryParameter("dns", encoded).build()

          url(requestUrl)
        }
--- a/okhttp-dnsoverhttps/src/test/java/okhttp3/dnsoverhttps/DnsRecordCodecTest.kt
+++ b/okhttp-dnsoverhttps/src/test/java/okhttp3/dnsoverhttps/DnsRecordCodecTest.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.dnsoverhttps

--- a/okhttp-java-net-cookiejar/build.gradle.kts
+++ b/okhttp-java-net-cookiejar/build.gradle.kts
@@ -15,7 +15,7 @@ project.applyOsgi(
 )

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  compileOnly(libs.findbugs.jsr305)
  compileOnly(libs.animalsniffer.annotations)
 }
--- a/okhttp-java-net-cookiejar/src/main/kotlin/okhttp3/java/net/cookiejar/JavaNetCookieJar.kt
+++ b/okhttp-java-net-cookiejar/src/main/kotlin/okhttp3/java/net/cookiejar/JavaNetCookieJar.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.java.net.cookiejar

--- a/okhttp-logging-interceptor/build.gradle.kts
+++ b/okhttp-logging-interceptor/build.gradle.kts
@@ -15,7 +15,7 @@ project.applyOsgi(
 )

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  compileOnly(libs.findbugs.jsr305)

  testCompileOnly(libs.findbugs.jsr305)
--- a/okhttp-logging-interceptor/src/main/kotlin/okhttp3/logging/HttpLoggingInterceptor.kt
+++ b/okhttp-logging-interceptor/src/main/kotlin/okhttp3/logging/HttpLoggingInterceptor.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.logging

--- a/okhttp-logging-interceptor/src/test/java/okhttp3/logging/HttpLoggingInterceptorTest.kt
+++ b/okhttp-logging-interceptor/src/test/java/okhttp3/logging/HttpLoggingInterceptorTest.kt
@@ -922,7 +922,6 @@ class HttpLoggingInterceptorTest {
      .assertNoMoreLogs()
  }

-  @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
  @Test
  fun sensitiveQueryParamsAreRedacted() {
    url = server.url("/api/login?user=test_user&authentication=basic&password=confidential_password")
@@ -968,7 +967,6 @@ class HttpLoggingInterceptorTest {
      .assertNoMoreLogs()
  }

-  @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
  @Test
  fun preserveQueryParamsAfterRedacted() {
    url =
--- a/okhttp-testing-support/build.gradle.kts
+++ b/okhttp-testing-support/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {

 dependencies {
  api(libs.squareup.okio)
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  api(projects.okhttpTls)
  api(libs.assertk)
  api(libs.bouncycastle.bcprov)
--- a/okhttp-testing-support/src/main/kotlin/okhttp3/CallEvent.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/CallEvent.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3

--- a/okhttp-testing-support/src/main/kotlin/okhttp3/ConnectionEvent.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/ConnectionEvent.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3

--- a/okhttp-testing-support/src/main/kotlin/okhttp3/OkHttpClientTestRule.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/OkHttpClientTestRule.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3

--- a/okhttp-testing-support/src/main/kotlin/okhttp3/TestValueFactory.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/TestValueFactory.kt
@@ -13,11 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress(
-  "CANNOT_OVERRIDE_INVISIBLE_MEMBER",
-  "INVISIBLE_MEMBER",
-  "INVISIBLE_REFERENCE",
-)

 package okhttp3

--- a/okhttp-testing-support/src/main/kotlin/okhttp3/internal/concurrent/TaskFaker.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/internal/concurrent/TaskFaker.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.internal.concurrent

@@ -370,6 +369,8 @@ class TaskFaker : Closeable {
          val editCountBefore = editCount
          yieldUntil { nanoTime >= waitUntil || editCount > editCountBefore }
        }
+        // TODO report compiler bug
+        TODO("Can't get here")
      }
    }

--- a/okhttp-testing-support/src/main/kotlin/okhttp3/internal/http/RecordingProxySelector.kt
+++ b/okhttp-testing-support/src/main/kotlin/okhttp3/internal/http/RecordingProxySelector.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.internal.http

--- a/okhttp-tls/build.gradle.kts
+++ b/okhttp-tls/build.gradle.kts
@@ -17,7 +17,7 @@ project.applyOsgi(

 dependencies {
  api(libs.squareup.okio)
-  implementation(projects.okhttp)
+  "friendsImplementation"(projects.okhttp)
  compileOnly(libs.findbugs.jsr305)
  compileOnly(libs.animalsniffer.annotations)

--- a/okhttp-tls/src/main/kotlin/okhttp3/tls/HandshakeCertificates.kt
+++ b/okhttp-tls/src/main/kotlin/okhttp3/tls/HandshakeCertificates.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.tls

--- a/okhttp-tls/src/main/kotlin/okhttp3/tls/internal/InsecureExtendedTrustManager.kt
+++ b/okhttp-tls/src/main/kotlin/okhttp3/tls/internal/InsecureExtendedTrustManager.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3.tls.internal

--- a/okhttp-urlconnection/build.gradle.kts
+++ b/okhttp-urlconnection/build.gradle.kts
@@ -16,7 +16,7 @@ project.applyOsgi(
 )

 dependencies {
-  api(projects.okhttp)
+  "friendsApi"(projects.okhttp)
  api(projects.okhttpJavaNetCookiejar)
  compileOnly(libs.findbugs.jsr305)
  compileOnly(libs.animalsniffer.annotations)
--- a/okhttp-urlconnection/src/main/kotlin/okhttp3/JavaNetCookieJar.kt
+++ b/okhttp-urlconnection/src/main/kotlin/okhttp3/JavaNetCookieJar.kt
@@ -13,7 +13,6 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package okhttp3

--- a/samples/guide/build.gradle.kts
+++ b/samples/guide/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
 }

 dependencies {
-  implementation(projects.okhttp)
+  "friendsImplementation"(projects.okhttp)
  implementation(projects.mockwebserver)
  implementation(projects.okhttpTestingSupport)
  implementation(projects.okhttpTls)
--- a/samples/guide/src/main/java/okhttp3/recipes/kt/WiresharkExample.kt
+++ b/samples/guide/src/main/java/okhttp3/recipes/kt/WiresharkExample.kt
@@ -13,7 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE", "Since15")
+@file:Suppress("Since15")

 package okhttp3.recipes.kt

--- a/samples/guide/src/main/java/okhttp3/recipes/kt/YubikeyClientAuth.kt
+++ b/samples/guide/src/main/java/okhttp3/recipes/kt/YubikeyClientAuth.kt
@@ -13,7 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE", "Since15")
+@file:Suppress("Since15")

 package okhttp3.recipes.kt

--- a/samples/slack/build.gradle.kts
+++ b/samples/slack/build.gradle.kts
@@ -3,6 +3,7 @@ plugins {
 }

 dependencies {
+  implementation(projects.okhttp)
  implementation(projects.mockwebserver)
  implementation(libs.squareup.moshi)
 }
--- a/samples/static-server/build.gradle.kts
+++ b/samples/static-server/build.gradle.kts
@@ -14,6 +14,7 @@ tasks.jar {
 }

 dependencies {
+  implementation(projects.okhttp)
  implementation(projects.mockwebserver)
 }