feat: add jpms support with `module-info.java` #175

sgammon · 2024-03-01T05:17:15Z

Summary

This PR adds a module-info.java definition, bringing kotlinx-collections-immutable to full JPMS support; downstream users can use the new module with the following directive:

module-info.java

module your.module.here {
  requires kotlinx.collections.immutable;
}

Fixes and closes #157

Other changes

In general, the build was cleaned up, and Dependency Locking and Dependency Verification are now turned on, as is the case for other Kotlin projects.

Trying it out

This is still a draft because it is being tested downstream. If you would like to test this module, you can do so with:

build.gradle.kts

dependencies {
  implementation("org.jetbrains.kotlinx:kotlinx-collections-immutable:0.3.8-rc-1")
}

settings.gradle.kts

dependencyResolutionManagement {
  repositories {
    mavenCentral()

    // 👇  this repo
    maven {
      name = "elide-snapshots"
      url = uri("https://elide-snapshots.storage-download.googleapis.com/repository/v3/")
    }
  }
}

Changelog

feat: add module-info.java
feat: add Java9Modularity used by other kotlinx projects
feat: build core project as multi-release jar
chore: upgrade gradle → 8.6 (to run under jvm21)
chore: upgrade kotlin → 1.9.22
chore: general build cleanup (use kotlin for most build scripts)
chore: add gradle lockfiles and locking config
chore: add gradle dependency verification config

- feat: add `module-info.java` - feat: add `Java9Modularity` used by other kotlinx projects - feat: build `core` project as multi-release jar - chore: upgrade gradle → `8.6` (to run under jvm21) - chore: general build cleanup (use kotlin for most build scripts) - chore: add gradle lockfiles and locking config - chore: add gradle dependency verification config

sgammon · 2024-03-01T05:21:21Z

benchmarks/runner/build.gradle

-    implementation "org.jetbrains.kotlin:kotlin-stdlib"
-    implementation 'org.openjdk.jmh:jmh-core:1.21'
+    implementation libs.kotlin.stdlib
+    implementation libs.jmh.core


General build cleanup: moved dependencies to a version catalog.

sgammon · 2024-03-01T05:21:38Z

build.gradle.kts

+    lockAllConfigurations()
+}


Dependency locking and verification were activated, but kept in lenient mode for now, to account for native dependency shift in CI.

sgammon · 2024-03-01T05:22:27Z

buildSrc/src/main/kotlin/Java9Modularity.kt

+object Java9Modularity {
+    @JvmStatic
+    @JvmOverloads
+    fun Project.configureJava9ModuleInfo(multiRelease: Boolean = true) {


Java9Modularity added from here

sgammon · 2024-03-01T05:22:39Z

core/build.gradle.kts

-    archivesBaseName = "kotlinx-collections-immutable" // doesn't work
+    archivesName = "kotlinx-collections-immutable"


Fixes deprecation

sgammon · 2024-03-01T05:22:44Z

core/build.gradle.kts

@@ -1,3 +1,7 @@
+@file:OptIn(org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl::class)


Fixes warnings

sgammon · 2024-03-01T05:24:15Z

core/jvmMainModule/src/module-info.java

+module kotlinx.collections.immutable {
+    requires java.base;
+    requires transitive kotlin.stdlib;
+}


New module-info.java descriptor. I thought about adding it as kotlinx.collections.immutable.jvm, which is the suggested module name in IntelliJ; but I don't think users are using this value yet, because I can't locate it anywhere as an Automatic-Module-Name.

Thus, the format here matches other modules, like:

kotlinx.coroutines.[core|guava|...]

kotlinx.serialization.[core|json|...]

sgammon · 2024-03-01T05:24:43Z

gradle/libs.versions.toml

+[versions]
+kotlin-sdk = "1.9.22"
+kotlinx-benchmark = "0.4.10"
+kotlinx-validator = "0.13.2"
+guava-testlib = "18.0"
+jmh = "1.21"


New version catalog; other than updating kotlin-sdk to 1.9.22, no version changes were applied.

sgammon · 2024-03-01T05:25:07Z

gradle/wrapper/gradle-wrapper.properties

-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip


Gradle upgrade → latest stable so that this project can run under JVM 21.

sgammon · 2024-03-01T05:25:41Z

settings.gradle.kts

+pluginManagement {
+    repositories {


Rewrote this file as Kotlin because it helps a bit with build speed, since Groovy build scripts can't be build cached until Gradle 8.7, which is at RC2 (not yet released).

sgammon · 2024-03-04T20:24:59Z

cc / @qurbonzoda @daniel-jasinski @Sporking @qwwdfsad

daniel-jasinski · 2024-03-04T21:49:33Z

buildSrc/build.gradle.kts

+repositories {
+    mavenCentral()
+    mavenLocal()
+    if (project.hasProperty("kotlin_repo_url")) {


Use the nullable findProperty method to check and retrieve property. The properties property performs a copy of the underlying map.

Good catch, although this block wasn't supposed to make it in at all; I'll drop

daniel-jasinski · 2024-03-04T21:55:44Z

Good PR, but there is a lot of housekeeping and the original intention gets lost in all the minutiae.
I would suggest splitting this PR, at least into the chore and feature parts.

ilya-g

While this project contains only one module where module-info should be added, it would be better to avoid introducing an included build with common logic like buildSrc - it complicates build and increases configuration time.

It's enough to add a compilation task directly in the core subproject, like it is done in kotlinx.datetime

We can refactor it later to shared build logic if we introduce another published module.

sgammon · 2024-03-06T00:36:52Z

@daniel-jasinski Thank you for that review

@ilya-g Okay, no problem. I will apply those changes. Thank you as well

sgammon marked this pull request as ready for review March 1, 2024 05:20

sgammon commented Mar 1, 2024

View reviewed changes

daniel-jasinski reviewed Mar 4, 2024

View reviewed changes

ilya-g requested changes Mar 5, 2024

View reviewed changes

This was referenced Mar 11, 2024

Tracking: JPMS Ecosystem elide-dev/jpms#1

Open

Feature: KotlinX Immutable Collections elide-dev/jpms#32

Merged

qurbonzoda self-requested a review March 20, 2024 09:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add jpms support with `module-info.java` #175

feat: add jpms support with `module-info.java` #175

sgammon commented Mar 1, 2024 •

edited

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon Mar 1, 2024

sgammon commented Mar 4, 2024

daniel-jasinski Mar 4, 2024

sgammon Mar 6, 2024

daniel-jasinski commented Mar 4, 2024

ilya-g left a comment

sgammon commented Mar 6, 2024 •

edited

		archivesBaseName = "kotlinx-collections-immutable" // doesn't work
		archivesName = "kotlinx-collections-immutable"

		@@ -1,3 +1,7 @@
		@file:OptIn(org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl::class)

		distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
		distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip

		pluginManagement {
		repositories {

feat: add jpms support with module-info.java #175

Are you sure you want to change the base?

feat: add jpms support with module-info.java #175

Conversation

sgammon commented Mar 1, 2024 • edited

Summary

Other changes

Trying it out

Changelog

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgammon commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daniel-jasinski commented Mar 4, 2024

ilya-g left a comment

Choose a reason for hiding this comment

sgammon commented Mar 6, 2024 • edited

feat: add jpms support with `module-info.java` #175

feat: add jpms support with `module-info.java` #175

sgammon commented Mar 1, 2024 •

edited

sgammon commented Mar 6, 2024 •

edited