Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetbrains/kotlin-compiler-server
Server for executing kotlin code
https://github.com/jetbrains/kotlin-compiler-server
kotlin kotlin-compiler kotlin-playground spring spring-boot
Last synced: about 17 hours ago
JSON representation
Server for executing kotlin code
- Host: GitHub
- URL: https://github.com/jetbrains/kotlin-compiler-server
- Owner: JetBrains
- License: apache-2.0
- Created: 2019-11-04T10:50:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-20T13:35:37.000Z (2 days ago)
- Last Synced: 2024-12-22T07:04:55.578Z (about 17 hours ago)
- Topics: kotlin, kotlin-compiler, kotlin-playground, spring, spring-boot
- Language: Kotlin
- Homepage:
- Size: 2.27 MB
- Stars: 253
- Watchers: 9
- Forks: 73
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kotlin compiler server
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[ ](https://kotlinlang.org/)
[](https://www.apache.org/licenses/LICENSE-2.0)
A REST server for compiling and executing Kotlin code.
The server provides the API for [Kotlin Playground](https://github.com/JetBrains/kotlin-playground) library.
## How to start :checkered_flag:
### Simple Spring Boot application
Download Kotlin dependencies and build an executor before starting the server:
```shell script
$ ./gradlew build -x test
```
Start the Spring Boot project. The main class: `com.compiler.server.CompilerApplication`
### With Docker
To build the app inside a Docker container, run the following command from the project directory:
```shell
$ ./docker-image-build.sh
```
### From Amazon lambda
Based on [aws-serverless-container](https://github.com/awslabs/aws-serverless-java-container).
```shell script
$ ./gradlew buildLambda
```
Getting `.zip` file from `build/distributions`.
Lambda handler: `com.compiler.server.lambdas.StreamLambdaHandler::handleRequest`.
Publish your Lambda function: you can follow the instructions
in [AWS Lambda's documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-java-how-to-create-deployment-package.html)
on how to package your function for deployment.
### From Kotless
Add [Kotless](https://github.com/JetBrains/kotless) and
remove [aws-serverless-container](https://github.com/awslabs/aws-serverless-java-container) =)
## API Documentation :page_with_curl:
Swagger url: http://localhost:8080/swagger-ui/
## How to add your dependencies to kotlin compiler :books:
Just put whatever you need as dependencies
to [build.gradle.kts](https://github.com/JetBrains/kotlin-compiler-server/blob/master/build.gradle.kts) via a
task called `kotlinDependency`:
```
kotlinDependency "your dependency"
```
NOTE: If the library you're adding uses reflection, accesses the file system, or performs any other type of
security-sensitive operations, don't forget to
configure
the [executor.policy](https://github.com/JetBrains/kotlin-compiler-server/blob/master/executor.policy)
. [Click here](https://docs.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html) for more information
about *Java Security Policy*.
**How to set Java Security Policy in `executors.policy`**
If you want to configure a custom dependency, use the marker `@LIB_DIR@`:
```
grant codeBase "file:%%LIB_DIR%%/junit-4.12.jar"{
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
permission java.lang.RuntimePermission "setIO";
permission java.io.FilePermission "<>", "read";
permission java.lang.RuntimePermission "accessDeclaredMembers";
};
```
## CORS configuration
Set the environment variables
| ENV | Default value |
|-----------------------------------|---------------|
| ACCESS_CONTROL_ALLOW_ORIGIN_VALUE | * |
| ACCESS_CONTROL_ALLOW_HEADER_VALUE | * |
## Configure logging
We use `prod` spring active profile to stream logs as JSON format.
You can set the spring profile by supplying `-Dspring.profiles.active=prod` or set env variable `SPRING_PROFILES_ACTIVE` to `prod` value.
### Unsuccessful execution logs
In case of an unsuccessful execution in the standard output will be the event with INFO level:
```json
{
"date_time": "31/Aug/2021:11:49:45 +03:00",
"@version": "1",
"message": "Code execution is complete.",
"logger_name": "com.compiler.server.service.KotlinProjectExecutor",
"thread_name": "http-nio-8080-exec-1",
"level": "INFO",
"level_value": 20000,
"hasErrors": true,
"confType": "JAVA",
"kotlinVersion": "$kotlinVersion"
}
```
## Kotlin release guide :rocket:
1) Update the kotlin version
in [libs.versions.toml](https://github.com/JetBrains/kotlin-compiler-server/blob/master/gradle/libs.versions.toml)
2) Make sure everything is going well via the task:
```shell script
$ ./gradlew build
```
3) Save branch with the name of the kotlin version. Pattern: `/^[0-9.]+$/` (optional)
4) Bump version on GitHub [releases](https://github.com/JetBrains/kotlin-compiler-server/releases) (optional)
### Gradle Build Scans
[Gradle Build Scans](https://scans.gradle.com/) can provide insights into an Kotlin Compiler Server Build.
JetBrains runs a [Gradle Develocity server](https://ge.jetbrains.com/scans?search.rootProjectNames=kotlinx-atomicfu).
that can be used to automatically upload reports.
To automatically opt in add the following to `$GRADLE_USER_HOME/gradle.properties`.
```properties
org.jetbrains.kotlin.compiler.server.build.scan.enabled=true
# optionally provide a username that will be attached to each report
org.jetbrains..kotlin.compiler.server.build.scan.username=John Wick
```
Also you need to create an access key:
```bash
./gradlew provisionDevelocityAccessKey
```
A Build Scan may contain identifiable information. See the Terms of Use https://gradle.com/legal/terms-of-use/.