add kt_plugin rule #308

IljaKroonen · 2020-04-02T11:40:20Z

Proposal for implementing a kt_plugin rule

kotlin/internal/jvm/jvm.bzl

kotlin/internal/jvm/plugins.bzl

restingbull · 2020-04-02T13:46:45Z

kotlin/internal/repositories/BUILD.com_github_jetbrains_kotlin

@@ -42,6 +42,11 @@ kt_jvm_import(
    ]
 ]

+java_import(


kt_jvm_import

kotlin/internal/jvm/impl.bzl

kotlin/internal/jvm/compile.bzl

restingbull

A few changes, the largest being to use providers over aspect.

IljaKroonen · 2020-04-02T14:28:48Z

@restingbull Thank you for taking a look. Could you please also have a look at my questions in the issue?

#239 (comment)

…spect

restingbull

LGTM.

One nit, mostly to future proof -- otherwise, it's good to go.

kotlin/internal/jvm/compile.bzl

restingbull · 2020-04-03T14:42:45Z

examples/plugin/src/BUILD

+kt_plugin(
+    name = "open_for_testing_plugin",
+    id = "org.jetbrains.kotlin.allopen",
+    options = ["annotation=plugin.OpenForTesting"],


I'm being pedantic... and defensive about the long term maintenance.

Could you make the options in an attr.string_dict?

e.g.
options = {
"annotation":"plugin.OpenForTesting"
}

and assemble thiem with an equals in the impl.

It's safer to maintain and validate (I know, it sounds weird, but it can be an issue. One doesn't normally consider sanitizing input in build tooling... but, well, it's necessary) if the arguments are split into key/value pairs.

I changed the interface, and added a check for equal signs being in the key part of the dict.

…ad of a list

cgruber · 2020-04-03T18:20:43Z

taking my own look, but first-cut, this is awesome, and thank you.

cgruber

This looks pretty great. Can you please add a blurb in the README?

Also, we need to add some way to add annotation processor options, and handle disabling/altering kapt, but that totally can be a follow-up. This keeps kapt as a special case, and I think that's still the best approach.

cgruber · 2020-04-03T18:39:38Z

src/main/kotlin/io/bazel/kotlin/builder/toolchain/KotlinKaptCompilerPluginArgsEncoder.kt

@@ -22,7 +22,7 @@ import java.io.ObjectOutputStream
 import java.util.Base64

 // TODO(hs) move the kapt specific stuff to the JVM package.
-class KotlinCompilerPluginArgsEncoder(
+class KotlinKaptCompilerPluginArgsEncoder(


Nit: Probably doesn't need Kotlin as a prefix here, as it's implied in Kapt.

cgruber · 2020-04-03T18:42:49Z

kotlin/internal/jvm/jvm.bzl

+        "id": attr.string(
+            doc = """The ID of the plugin""",
+        ),
+        "options": attr.string_dict(


So these are passed to the plugin globally, right? I take it in this PR we're not considering per-target options?

What do you mean with per-target options? In the current implementation, the user can specify a different plugin for each target if he wants to, with different options.

Oh wait - I think I just realized something - this change doesn't create an exported_plugins equivalent. That's fine, but we'll need to file an issue to add that. I was thinking about this (my comment above) in the context of something like an exported_plugins feature, but it's irrelevant if that feature isn't even present.

cgruber · 2020-04-03T18:51:34Z

examples/plugin/src/BUILD

@@ -0,0 +1,34 @@
+load("//kotlin:kotlin.bzl", "kt_compiler_plugin", "kt_jvm_library")
+
+kt_compiler_plugin(


cgruber

Meant to specify request changes. (Just the readme. The nits are optional)

IljaKroonen · 2020-04-04T08:39:43Z

@cgruber I added a better docstring for the rule, and mentioned the existence of an example in the Readme.

I can also add the usage doc of kt_compiler_plugin directly in the readme, but it would feel strange to me in the current readme, which does not currently explain the rules but instead just links to https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html

When do the docs at https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html get updated? Does that happen with each release?

restingbull · 2020-04-05T15:15:18Z

@cgruber I added a better docstring for the rule, and mentioned the existence of an example in the Readme.

I can also add the usage doc of kt_compiler_plugin directly in the readme, but it would feel strange to me in the current readme, which does not currently explain the rules but instead just links to https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html

When do the docs at https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html get updated? Does that happen with each release?

Yup --- it's auto generated by skydoc.

However, that is just the api documentation. In the readme (and we should probably break it out, but that is beyond the pr scope, we have been putting guidance on how to use features. If you could put a small section on how to use compiler plugins, and link to the examples, I'll take on the larger effort of creating docs that off configuration guidance.

Thanks again for doing this!

IljaKroonen · 2020-04-05T21:05:19Z

I see, I will add it to the Readme.

Also, I discovered a problem with intellij plugin sync

ERROR: /home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/com_github_jetbrains_kotlin/BUILD.bazel:50:1: in @intellij_aspect//:intellij_info_bundled.bzl%intellij_info_aspect aspect on kt_jvm_import rule @com_github_jetbrains_kotlin//:noarg-compiler-plugin: 
Traceback (most recent call last):
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/com_github_jetbrains_kotlin/BUILD.bazel", line 50
		@intellij_aspect//:intellij_info_bundled.bzl%intellij_info_aspect(...)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_bundled.bzl", line 54, in _aspect_impl
		intellij_info_aspect_impl(<3 more arguments>)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_impl.bzl", line 1020, in intellij_info_aspect_impl
		ctx.actions.write(ide_info_file, <1 more arguments>)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_impl.bzl", line 1020, in ctx.actions.write
		info.to_proto()
Invalid text format, expected a struct, a dict, a string, a bool, or an int but got a NoneType for list element in struct field 'source_jars'

I'm going to look into that.

I also added examples of the sam-with-receiver and noarg plugins.

restingbull · 2020-04-05T21:51:48Z

kotlin/internal/repositories/BUILD.com_github_jetbrains_kotlin

@@ -42,6 +42,21 @@ kt_jvm_import(
    ]
 ]

+kt_jvm_import(
+    name = "allopen-compiler-plugin",
+    jars = ["lib/allopen-compiler-plugin.jar"],


Change this to "jar" not source jars.

That worked! Sync works now.

restingbull · 2020-04-05T21:52:17Z

I see, I will add it to the Readme.

Also, I discovered a problem with intellij plugin sync

ERROR: /home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/com_github_jetbrains_kotlin/BUILD.bazel:50:1: in @intellij_aspect//:intellij_info_bundled.bzl%intellij_info_aspect aspect on kt_jvm_import rule @com_github_jetbrains_kotlin//:noarg-compiler-plugin: 
Traceback (most recent call last):
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/com_github_jetbrains_kotlin/BUILD.bazel", line 50
		@intellij_aspect//:intellij_info_bundled.bzl%intellij_info_aspect(...)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_bundled.bzl", line 54, in _aspect_impl
		intellij_info_aspect_impl(<3 more arguments>)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_impl.bzl", line 1020, in intellij_info_aspect_impl
		ctx.actions.write(ide_info_file, <1 more arguments>)
	File "/home/ilja/.cache/bazel/_bazel_ilja/196978b91c60203b138288a6f78fa12b/external/intellij_aspect/intellij_info_impl.bzl", line 1020, in ctx.actions.write
		info.to_proto()
Invalid text format, expected a struct, a dict, a string, a bool, or an int but got a NoneType for list element in struct field 'source_jars'

I'm going to look into that.

I also added examples of the sam-with-receiver and noarg plugins.

The error is probably related to bazelbuild/intellij#1616.

If you change to jar, it should work properly. I'll clean up the jars handling.

cgruber · 2020-04-06T20:56:20Z

This all looks great to me. Thank you so much for this work.

* upstream/master: Fix non-reproducible archives (bazelbuild#304) Adds a kt_plugin rule (bazelbuild#308) Ensure that KotlionBuilder workers use a clean directory for each compilation. (bazelbuild#298) Apply autoformatting to all files. (bazelbuild#302) Optional outputs (bazelbuild#291) Change plugins to use depsets, as opposed to lists. (bazelbuild#292) Add Corbin to the codeowners. (bazelbuild#293) Update Protobuf to 3.11.3 (bazelbuild#286) Remove tree artifacts (bazelbuild#287) Cleanup src tree (bazelbuild#288) Update README.md (bazelbuild#285) Filter non-kotlin code out of generated sources (bazelbuild#263) Update readme so the dev instructions highlight using a local clone (bazelbuild#283) Remove third_party checked in jars, and properly pull maven dependencies. (bazelbuild#279) Only propagate srcjar if it isn't the default empty jar added in ae70089 to fix bazelbuild/intellij#1616 (bazelbuild#276) Allow resources to be in a kotlin directory (bazelbuild#268)

Creates a `kt_compiler_plugin` rule to allow kotlin compiler plugins to be specified, and then included with a `plugins=` attribute on kt_jvm_* jobs. This should support arbitrary kotlin compiler plugins, such as the android extensions, open-for-testing, and others. This does _not_ add an exported_plugins infrastructure (such as you get with java_plugins), and it does not change the special-case handling of kapt. It also doesn't do anything to resolve plugin inter-0compatibilities (e.g. the ABI plugin possibly needing information from the parcelizable, or other such interactions) The latter are issues yet to be figured out int he kotlinc plugin infrastructure, and we'll adapt this rule as appropriate. Also adds docs and examples.

add kt_plugin rule

117e212

restingbull reviewed Apr 2, 2020

View reviewed changes

kotlin/internal/jvm/jvm.bzl Outdated Show resolved Hide resolved

restingbull reviewed Apr 2, 2020

View reviewed changes

kotlin/internal/jvm/plugins.bzl Outdated Show resolved Hide resolved

restingbull reviewed Apr 2, 2020

View reviewed changes

kotlin/internal/jvm/impl.bzl Outdated Show resolved Hide resolved

restingbull reviewed Apr 2, 2020

View reviewed changes

kotlin/internal/jvm/compile.bzl Show resolved Hide resolved

restingbull requested changes Apr 2, 2020

View reviewed changes

restingbull mentioned this pull request Apr 2, 2020

[RFC] Add kotlinc option support in toolchain #303

Closed

IljaKroonen added 4 commits April 3, 2020 16:17

Rename kt_plugin to kt_compiler_plugin, and use provider instead of a…

21ff945

…spect

Remove unnecessary aspect changes

1718190

Use kt_jvm_import instead of java_import in repositories

6df9dd3

Fix obsolete naming

dd8f48b

restingbull reviewed Apr 3, 2020

View reviewed changes

Change interface of kt_compiler_plugin to use a dict of options inste…

7c17fb1

…ad of a list

cgruber reviewed Apr 3, 2020

View reviewed changes

cgruber marked this pull request as ready for review April 3, 2020 18:55

cgruber requested review from djwhang, jin and timpeut as code owners April 3, 2020 18:55

cgruber requested changes Apr 3, 2020

View reviewed changes

IljaKroonen added 3 commits April 4, 2020 09:48

Merge

f7a943d

Fix redundant name

ad8139d

Add some docs

bf5df18

restingbull approved these changes Apr 5, 2020

View reviewed changes

Add examples for noarg and sam with receive compiler plugins

0d6b8c5

IljaKroonen added 2 commits April 5, 2020 23:13

Add Readme entry explaining how to use compiler plugins

da43437

Fix no arg plugin example

0079a79

restingbull reviewed Apr 5, 2020

View reviewed changes

Use jar attribute instead of jars to avoid intellij sync problem

3d37724

restingbull requested a review from cgruber April 6, 2020 02:52

cgruber approved these changes Apr 6, 2020

View reviewed changes

cgruber merged commit 484f116 into bazelbuild:master Apr 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add kt_plugin rule #308

add kt_plugin rule #308

IljaKroonen commented Apr 2, 2020

restingbull Apr 2, 2020

IljaKroonen Apr 3, 2020

restingbull left a comment

IljaKroonen commented Apr 2, 2020

restingbull left a comment

restingbull Apr 3, 2020

IljaKroonen Apr 3, 2020

cgruber commented Apr 3, 2020

cgruber left a comment

cgruber Apr 3, 2020

IljaKroonen Apr 4, 2020

cgruber Apr 3, 2020

IljaKroonen Apr 3, 2020

cgruber Apr 6, 2020

cgruber Apr 3, 2020

cgruber left a comment

IljaKroonen commented Apr 4, 2020

restingbull commented Apr 5, 2020 •

edited

IljaKroonen commented Apr 5, 2020 •

edited

restingbull Apr 5, 2020

IljaKroonen Apr 5, 2020

restingbull commented Apr 5, 2020

cgruber commented Apr 6, 2020

		@@ -0,0 +1,34 @@
		load("//kotlin:kotlin.bzl", "kt_compiler_plugin", "kt_jvm_library")

		kt_compiler_plugin(

add kt_plugin rule #308

add kt_plugin rule #308

Conversation

IljaKroonen commented Apr 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

restingbull left a comment

Choose a reason for hiding this comment

IljaKroonen commented Apr 2, 2020

restingbull left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cgruber commented Apr 3, 2020

cgruber left a 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

cgruber left a comment

Choose a reason for hiding this comment

IljaKroonen commented Apr 4, 2020

restingbull commented Apr 5, 2020 • edited

IljaKroonen commented Apr 5, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

restingbull commented Apr 5, 2020

cgruber commented Apr 6, 2020

restingbull commented Apr 5, 2020 •

edited

IljaKroonen commented Apr 5, 2020 •

edited