Release rules_kotlin as a Bazel module #660

fmeum · 2022-01-15T17:15:16Z

Bazel 5 will bring experimental support for a new system for external dependency management codenamed "bzlmod". Making rules_kotlin available within this system requires packaging it as a module and submitting it to the Bazel Central Registry.
Is this already being worked on? I would be willing to help, but do not understand the dependency structure well enough to take this on on my own.

cgruber · 2022-02-04T20:29:03Z

We are looking at it, but we have to look at how this affects those who aren't using 5, and aren't in the modules ecosystem. We're open to it, and ultimately will likely implement this, but if the migration path doesn't support some sort of way out for <5.0 bazel, we'll have to wait a release (of bazel) or two before we really get it done.

In the mean-time, we're looking into the mechanism and setting up a plan. I wouldn't count on this before 1.7 of the rules.

comius · 2022-12-20T13:36:14Z

Main problems:

release tgz contains rkt_1_{4-7}.tgz, legacy.tgz which additionally describe Kotlin/Java compiler flags
compiler repository depends back on rules_kotlin, to export .jars with kt_jvm_import rules (circular deps are possible in bzlmod, however they are potentially problematic)

Goal: Make rules_kotlin work with and without bzlmod

I believe there should be just two repositories: rules_kotlin and kotlin_compiler. Bzlmod should handle kotlin_compiler as a dependency as naturally as possible. This then makes it easy for the users to select kotlin_compiler version and rules_kotlin version they want to use.

Proposal:

Move kt_jvm_import (and kt_js_import) targets from the kotlin_complier repository into the rules_kotlin repository (just export files instead from kotlin_complier repo) to break dependency edge from compiler repo to rules_kotlin

alternative, bet that cyclic deps work and just depend on rules_kotlin (we'd need to release rules_kotlin and kotlin_compiler on bazel-central-registry at the same time)

Release kotlin_compiler 1_4 to 1_7 on bazel-central-registry including the additional bzl files contained in rkt_1_{4,..7} , kt_{kotlinc,javac}_options rules and {kotlinc,javac}_options_to_flags.
- or a more lightweight .bzl file, containing only a string list of available javac and kotlinc flags
Make rules_kotlin/MODULE.bazel that has a dependency on kotlin_compiler (no repos for rkt_1_x)

There are other minor problems, which I'll attempt to solve separately.

WDYT?

fmeum · 2022-12-20T14:31:14Z

Based on my own experience with the rules_go and gazelle Bazel modules that mutually depend on each other, I can say that this case does work but can also be painful to work with. I would suggest trying to break such cyclic dependencies before Bzlmod-ifying a repo.

Move Kotlin specific targets (like `kt_jvm_import`) from `BUILD.com_github_jetbrains_kotlin` to `//kotlin/compiler`. This will make it possible to release `kotlin-compiler` module on `bazel-central-registry` without depending on `rules_kotlin`. The release will contain the new form `BUILD.com_github_jetbrains_kotlin` which doesn't depend on `rules_kotlin`. RELNOTES[INC]: This breaks users that depend on `@com_github_jetbrains_kotlin//:*` targets. The same targets can be found under `@io_bazel_rules_kotlin//kotlin/compiler:*`. It's not possible to add an `alias` to `@com_github_jetbrains_kotlin` repository, becuase it would already create a dependency on `rules_kotlin` repository in the bzlmod world. Technically it's possible to release 2 bzlmod modules that have a circular dependency. But this might create some unexpected problems. It addition it would be harder to convince `com_github_jetbrains_kotlin` owners to depend on `rules_kotlin`. Works toward: bazelbuild#660

Add `capabilities.bzl` to Kotlin compiler repository. Generate `kt_kotlinc_options` rule from it, that is filter out options that are not available in a specific version. This change makes a narrow interface between Kotlin compiler and Kotlin rules. It will make it possible to release and use new versions of Kotlin compiler independently from Kotlin rules. The release of Kotlin compiler should include the new `capabilities.bzl` file. The `capabilities.bzl` files were generated by grepping respective version of Kotlin compiler sources for `@Argument` annotation (some of them are not documented). The `legacy` file was generated from Kotlin compiler 1.3.0 additionally removing options that weren't available in `src/legacy`. There are some minor differences from previous `src/legacy` - javac opts are the same for versions. Works toward: bazelbuild#660

Remove `absolute_target` and use `Label` in the top-level bzl scope. This makes `Label` correctly evaluate to point to the repository where bzl file resides. Bzlmod is more stringent about labels and `absolute_target` implementation doesn't work with it - the created labels are de-funct. This works towards bazelbuild#660 It's one of the minor issues.

comius · 2022-12-22T14:04:13Z

I prepared PRs that fix this issue:

First two PRs should be reviewed before Kotlin compiler is release on bazel-central-registry.

restingbull · 2022-12-22T22:42:28Z

Move kt_jvm_import (and kt_js_import) targets from the kotlin_complier repository into the rules_kotlin repository (just export files instead from kotlin_complier repo) to break dependency edge from compiler repo to rules_kotlin

To keep the api stable (and avoid cyclical refs), we can use jvm_import. I've updated the pr.

release tgz contains rkt_1_{4-7}.tgz, legacy.tgz which additionally describe Kotlin/Java compiler flags

If I understand this correctly, the bzlmod does not allow for the practice of "sub repositories" -- instead, it provides extensions. If so, then it's just a matter of remapping the repos to extension and setting a default configuration.

~~Also, silly question: how do we register default toolchains?~~
Ah, interesting. You can do it in the MODULE.bazel. The docs do not make that clear.

Move Kotlin specific targets (like `kt_jvm_import`) from `BUILD.com_github_jetbrains_kotlin` to `//kotlin/compiler`. This will make it possible to release `kotlin-compiler` module on `bazel-central-registry` without depending on `rules_kotlin`. The release will contain the new form `BUILD.com_github_jetbrains_kotlin` which doesn't depend on `rules_kotlin`. RELNOTES[INC]: This breaks users that depend on `@com_github_jetbrains_kotlin//:*` targets. The same targets can be found under `@io_bazel_rules_kotlin//kotlin/compiler:*`. It's not possible to add an `alias` to `@com_github_jetbrains_kotlin` repository, becuase it would already create a dependency on `rules_kotlin` repository in the bzlmod world. Technically it's possible to release 2 bzlmod modules that have a circular dependency. But this might create some unexpected problems. It addition it would be harder to convince `com_github_jetbrains_kotlin` owners to depend on `rules_kotlin`. Works toward: bazelbuild#660

Add `capabilities.bzl` to Kotlin compiler repository. Generate `kt_kotlinc_options` rule from it, that is filter out options that are not available in a specific version. This change makes a narrow interface between Kotlin compiler and Kotlin rules. It will make it possible to release and use new versions of Kotlin compiler independently from Kotlin rules. The release of Kotlin compiler should include the new `capabilities.bzl` file. The `capabilities.bzl` files were generated by grepping respective version of Kotlin compiler sources for `@Argument` annotation (some of them are not documented). The `legacy` file was generated from Kotlin compiler 1.3.0 additionally removing options that weren't available in `src/legacy`. There are some minor differences from previous `src/legacy` - javac opts are the same for versions. Works toward: bazelbuild#660

yrom · 2023-03-24T09:30:32Z

How is it going? I tried to enable bzlmod, but rules_kotlin does not work properly and requires a large number of patches 😢 Then I gave up

auzhva · 2023-07-02T14:03:30Z

Hi! Are there any news from there? Thank you!

shs96c · 2023-08-30T08:25:08Z

Gentle nudge. Would love to be able to use rules_kotlin with bzlmod natively.

luispadron · 2023-08-31T20:57:55Z

+1 this is blocking some folks who depend on rules_kotlin from using bzlmod

cgruber added status: open - investigating component: common P3 type: task Actions to be taken labels Feb 4, 2022

comius self-assigned this Dec 20, 2022

comius mentioned this issue Dec 20, 2022

wanted: com_google_protobuf bazelbuild/bazel-central-registry#320

Closed

1 task

This was referenced Dec 20, 2022

Convert strings to label with the correct repository #896

Merged

Remove repository mapping #897

Closed

Decouple Kotlin compiler from Kotlin rules #899

Open

Refactor compiler configuration repositories #900

Closed

comius mentioned this issue Dec 22, 2022

Support bzlmod #902

Closed

restingbull assigned restingbull and unassigned comius Jul 7, 2023

Bencodes mentioned this issue Sep 14, 2023

Add support for Bzlmod #1006

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release rules_kotlin as a Bazel module #660

Release rules_kotlin as a Bazel module #660

fmeum commented Jan 15, 2022 •

edited

Loading

cgruber commented Feb 4, 2022

comius commented Dec 20, 2022 •

edited

Loading

fmeum commented Dec 20, 2022

comius commented Dec 22, 2022 •

edited

Loading

restingbull commented Dec 22, 2022 •

edited

Loading

yrom commented Mar 24, 2023

auzhva commented Jul 2, 2023

shs96c commented Aug 30, 2023

luispadron commented Aug 31, 2023

Release rules_kotlin as a Bazel module #660

Release rules_kotlin as a Bazel module #660

Comments

fmeum commented Jan 15, 2022 • edited Loading

cgruber commented Feb 4, 2022

comius commented Dec 20, 2022 • edited Loading

fmeum commented Dec 20, 2022

comius commented Dec 22, 2022 • edited Loading

restingbull commented Dec 22, 2022 • edited Loading

yrom commented Mar 24, 2023

auzhva commented Jul 2, 2023

shs96c commented Aug 30, 2023

luispadron commented Aug 31, 2023

fmeum commented Jan 15, 2022 •

edited

Loading

comius commented Dec 20, 2022 •

edited

Loading

comius commented Dec 22, 2022 •

edited

Loading

restingbull commented Dec 22, 2022 •

edited

Loading