Skip to content

Update gRPC Docs and Sample #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 18, 2025
Merged

Update gRPC Docs and Sample #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
700e314
Updated gRPC doc for new Gradle configs
Mr3zee Feb 13, 2025
1382c0a
Updated gRPC sample
Mr3zee Feb 13, 2025
790adbd
GH comments
Mr3zee Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 86 additions & 41 deletions docs/pages/kotlinx-rpc/topics/grpc-configuration.topic
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
</p>
<code-block lang="Kotlin">
plugins {
kotlin("jvm") version "2.1.0"
kotlin("plugin.serialization") version "2.1.0"
kotlin("jvm") version "%kotlin-version%"
kotlin("plugin.serialization") version "%kotlin-version%"
id("org.jetbrains.kotlinx.rpc.plugin") version "&lt;version&gt;"
id("com.google.protobuf") version "0.9.4"
}
Expand All @@ -66,65 +66,110 @@
<p>
gRPC requires additional code generation from the <a href="https://github.com/google/protobuf-gradle-plugin">protoc</a>
compiler.
This can be setup up in the following way:
It is set up automatically for you when the <code>com.google.protobuf</code>
plugin is present in the project.
</p>
<p>
We provide additional options for configuration:
</p>
<code-block lang="Kotlin">
protobuf {
protoc {
artifact = "com.google.protobuf:protoc:4.29.3"
}
rpc {
grpc {
// Enforce additional checks on the project configuration
enabled = true

plugins {
create("kotlinx-rpc") {
artifact = "org.jetbrains.kotlinx:kotlinx-rpc-protobuf-plugin:&lt;version&gt;:all@jar"
// Quick access to a `Locator` and `Options`
// for the kotlinx-rpc Protobuf plugin
plugin {
options {
// Add or modify options
option("debugOutput=myFile.txt")
}

locator {
// Override artifact coordinates
artifact = "some-other:artifact:version"
}
}

create("grpc") {
artifact = "io.grpc:protoc-gen-grpc-java:1.69.0"
// same as `plugin`, but for gRPC Java generation
grpcJavaPlugin { ... }
// same as `plugin`, but for gRPC Kotlin generation
grpcKotlinPlugin { ... }

// access `generateProto` tasks
tasks {
plugins {
create("python")
}
}

create("grpckt") {
artifact = "io.grpc:protoc-gen-grpc-kotlin:1.4.1:jdk8@jar"
// access `generateProto` tasks with a filter
tasksMatching { it.isTest }.all {
plugins {
create("cpp")
}
}
}
}
</code-block>
<p>
You can still use <code>protobuf</code> extension to access the configuration.
The following is the equivalent for the above code using the <code>protobuf</code> extension:
</p>
<code-block lang="Kotlin">
protobuf {
plugins {
named(GrpcExtension.LOCATOR_NAME) {
artifact = "some-other:artifact:version"
}

named(GrpcExtension.GRPC_JAVA_LOCATOR_NAME) { ... }
named(GrpcExtension.GRPC_KOTLIN_LOCATOR_NAME) { ... }
}

generateProtoTasks {
all().all {
plugins {
create("kotlinx-rpc") {
option("debugOutput=protobuf-plugin.log")
option("messageMode=interface")
named(GrpcExtension.LOCATOR_NAME) {
option("debugOutput=myFile.txt")
}

create("python")

if (isTest) {
create("cpp")
}
create("grpc")
create("grpckt")
}
}
}
}
</code-block>
<p>
The minimum recommended configuration looks like this:
</p>
<code-block lang="Kotlin">
rpc {
grpc {
enabled = true
}
}
</code-block>
<p>
By default, four source sets will be generated:
</p>
<list>
<li>
Four source sets will be generated:
<list>
<li><code>java</code> - protobuf Java declarations</li>
<li><code>grpc</code> - gRPC Java declarations</li>
<li><code>grpckt</code> - gRPC Kotlin wrappers for Java</li>
<li><code>kotlinx-rpc</code> - pur wrappers for all of the above</li>
</list>
<p>
You won't need to use the first three directly, only the declarations from the <code>kotlinx-rpc</code>
source set are intended to be used.
</p>
Source sets are generated into <code>$BUILD_DIR/generated/source/proto/main</code> directory
unless specified otherwise.
</li>
<li>
<code>option("debugOutput=protobuf-plugin.log")</code> lets you specify the file
for the <code>protoc</code> plugin debug output.
</li>
<li>
<code>option("messageMode=interface")</code> is intended to be like so. Don't change it.
</li>
<li><code>java</code> - protobuf Java declarations</li>
<li><code>grpc</code> - gRPC Java declarations</li>
<li><code>grpckt</code> - gRPC Kotlin wrappers for Java</li>
<li><code>kotlinx-rpc</code> - our wrappers for all of the above</li>
</list>
<p>
Only the declarations from the <code>kotlinx-rpc</code> source set are intended to be used.
</p>
<p>
Source sets are generated into the <code>$BUILD_DIR/generated/source/proto/main</code> directory
unless specified otherwise.
</p>
</chapter>
</topic>
39 changes: 5 additions & 34 deletions samples/grpc-app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
plugins {
kotlin("jvm") version "2.1.10"
kotlin("plugin.serialization") version "2.1.10"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.5.0-grpc-6"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.5.1-grpc-16"
id("com.google.protobuf") version "0.9.4"
}

Expand All @@ -22,42 +22,13 @@ kotlin {
}

dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-rpc-grpc-core:0.5.0-grpc-6")
implementation("org.jetbrains.kotlinx:kotlinx-rpc-grpc-core:0.5.1-grpc-16")
implementation("ch.qos.logback:logback-classic:1.5.16")
implementation("io.grpc:grpc-netty:1.69.0")
}

val buildDirPath: String = project.layout.buildDirectory.get().asFile.absolutePath

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:4.29.3"
}

plugins {
create("kotlinx-rpc") {
artifact = "org.jetbrains.kotlinx:kotlinx-rpc-protobuf-plugin:0.5.0-grpc-6:all@jar"
}

create("grpc") {
artifact = "io.grpc:protoc-gen-grpc-java:1.69.0"
}

create("grpckt") {
artifact = "io.grpc:protoc-gen-grpc-kotlin:1.4.1:jdk8@jar"
}
}

generateProtoTasks {
all().all {
plugins {
create("kotlinx-rpc") {
option("debugOutput=$buildDirPath/protobuf-plugin.log")
option("messageMode=interface")
}
create("grpc")
create("grpckt")
}
}
rpc {
grpc {
enabled = true
}
}