-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/commonize-load
- Loading branch information
Showing
14 changed files
with
363 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| name: Run Benchmarks | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
|
|
||
| env: | ||
| BENCHMARK_RESULTS: snake-kmp-benchmarks/build/reports/benchmarks | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| run-benchmark: | ||
| strategy: | ||
| fail-fast: true | ||
| matrix: | ||
| include: | ||
| - os: ubuntu-latest | ||
| - os: macos-latest | ||
| additional-args: '-x jvmBenchmark -x jsBenchmark' | ||
| - os: macos-13 # for macosX64 | ||
| additional-args: '-x jvmBenchmark -x jsBenchmark' | ||
| - os: windows-latest | ||
| additional-args: '-x jvmBenchmark -x jsBenchmark' | ||
| name: Performance regression check on ${{ matrix.os }} runner | ||
| runs-on: ${{ matrix.os }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: 'Set up JDK' | ||
| uses: 'actions/setup-java@v4' | ||
| with: | ||
| java-version: '11' | ||
| distribution: 'zulu' | ||
| cache: 'gradle' | ||
| - name: Validate Gradle Wrapper | ||
| uses: gradle/actions/wrapper-validation@v3 | ||
| - name: Setup Gradle | ||
| uses: gradle/actions/setup-gradle@v3 | ||
| with: | ||
| gradle-version: wrapper | ||
| - name: Run benchmarks | ||
| run: ./gradlew -p snake-kmp-benchmarks benchmark --no-parallel ${{ matrix.additional-args }} | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: bench-results-${{ matrix.os }} | ||
| path: ${{ env.BENCHMARK_RESULTS }}/main/**/*.json | ||
| collect-benchmarks-results: | ||
| runs-on: ubuntu-latest | ||
| needs: | ||
| - run-benchmark | ||
| env: | ||
| RESULTS_DIR: bench-results | ||
| steps: | ||
| # without checkout step 'benchmark-action/github-action-benchmark' action won't work | ||
| - uses: actions/checkout@v4 | ||
| - name: Download benchmark results | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: bench-results-* | ||
| path: ${{ env.RESULTS_DIR }} | ||
| merge-multiple: true | ||
| - name: Prepare and join benchmark reports | ||
| id: prep | ||
| run: | | ||
| for report in $(find ./${{ env.RESULTS_DIR }} -type f -name "*.json") | ||
| do | ||
| file_name=$(basename "$report") | ||
| platform="${file_name%.*}" | ||
| # Trim 'it.krzeminski.snakeyaml.engine.kmp.benchmark.' to make benchmark name more readable | ||
| jq "[ .[] | .benchmark |= \"${platform}.\" + ltrimstr(\"it.krzeminski.snakeyaml.engine.kmp.benchmark.\") | .params |= map_values(. |= match(\"data.+\"; \"g\").string) ]" $report > ${{ env.RESULTS_DIR }}/$platform.json | ||
| done | ||
| AGGREGATED_REPORT=aggregated.json | ||
| # Joined reports looks like this: [[{},{}], [{},{}]] | ||
| # We need to transform them into this: [{},{}] | ||
| ls ${{ env.RESULTS_DIR }}/*.json | ||
| jq -s '[ .[] | .[] ]' ${{ env.RESULTS_DIR }}/*.json > $AGGREGATED_REPORT | ||
| echo "report=$AGGREGATED_REPORT" >> $GITHUB_OUTPUT | ||
| - name: Store benchmark result | ||
| uses: benchmark-action/github-action-benchmark@v1 | ||
| with: | ||
| name: SnakeKMP benchmarks | ||
| tool: 'jmh' | ||
| output-file-path: ${{ steps.prep.outputs.report }} | ||
| comment-on-alert: true | ||
| summary-always: true | ||
| alert-threshold: '150%' | ||
| fail-threshold: '200%' | ||
| gh-repository: github.com/krzema12/snakeyaml-engine-kmp-benchmarks | ||
| github-token: ${{ secrets.PUBLISH_BENCHMARK_RESULTS }} | ||
| # Push and deploy GitHub pages branch automatically only if run in main repo and not in PR | ||
| auto-push: ${{ github.repository == 'krzema12/snakeyaml-engine-kmp' && github.event_name != 'pull_request' }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| plugins { | ||
| kotlin("multiplatform") | ||
| kotlin("plugin.allopen") version "2.0.0" | ||
| id("org.jetbrains.kotlinx.benchmark") version "0.4.11" | ||
| } | ||
|
|
||
| allOpen { | ||
| // JMH requires all benchmark classes to be open | ||
| annotation("org.openjdk.jmh.annotations.State") | ||
| } | ||
|
|
||
| kotlin { | ||
| jvmToolchain(11) | ||
|
|
||
| //region JVM Targets | ||
| jvm() | ||
| //endregion | ||
|
|
||
| //region JS target | ||
| js(IR) { | ||
| nodejs() | ||
| } | ||
| //endregion | ||
|
|
||
| //region Native Targets | ||
| // According to https://kotlinlang.org/docs/native-target-support.html | ||
| // Tier 1 | ||
| macosX64() | ||
| macosArm64() | ||
| iosSimulatorArm64() | ||
| iosX64() | ||
|
|
||
| // Tier 2 | ||
| linuxX64() | ||
| linuxArm64() | ||
| watchosSimulatorArm64() | ||
| watchosX64() | ||
| watchosArm32() | ||
| watchosArm64() | ||
| tvosSimulatorArm64() | ||
| tvosX64() | ||
| tvosArm64() | ||
| iosArm64() | ||
|
|
||
| // Tier 3 | ||
| mingwX64() | ||
| //endregion | ||
|
|
||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
| implementation(project.dependencies.platform("com.squareup.okio:okio-bom:3.9.0")) | ||
| implementation(projects.snakeyamlEngineKmp) | ||
| implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.4.11") | ||
| implementation("com.squareup.okio:okio") | ||
| } | ||
| } | ||
|
|
||
| jvmMain { | ||
| dependencies { | ||
| implementation("org.snakeyaml:snakeyaml-engine:2.7") | ||
| } | ||
| } | ||
|
|
||
| jsMain { | ||
| dependencies { | ||
| implementation("net.thauvin.erik.urlencoder:urlencoder-lib:1.5.0") { | ||
| because("https://github.com/Kotlin/kotlinx-benchmark/issues/185 - only compile dependnecies (declared as api) are using during benchmark compilation") | ||
| } | ||
| implementation("com.squareup.okio:okio-nodefilesystem") | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| benchmark { | ||
| configurations { | ||
| getByName("main") { | ||
| iterations = 10 | ||
| iterationTime = 5 | ||
| iterationTimeUnit = "s" | ||
| param( | ||
| "openAiYamlPath", | ||
| // Absolute path is required by JS target. Otherwise, file cannot be found | ||
| layout.projectDirectory | ||
| .file("data/issues/kmp-issue-204-OpenAI-API.yaml") | ||
| .asFile | ||
| .absolutePath, | ||
| ) | ||
| } | ||
| } | ||
| targets { | ||
| register("jvm") | ||
| register("js") | ||
| register("macosX64") | ||
| register("macosArm64") | ||
| register("iosX64") | ||
| register("iosArm64") | ||
| register("iosSimulatorArm64") | ||
| register("linuxX64") | ||
| register("mingwX64") | ||
| } | ||
| } |
File renamed without changes.
9 changes: 9 additions & 0 deletions
9
...nchmarks/src/commonMain/kotlin/it/krzeminski/snakeyaml/engine/kmp/benchmark/FileSystem.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package it.krzeminski.snakeyaml.engine.kmp.benchmark | ||
|
|
||
| import okio.FileSystem | ||
|
|
||
| /** | ||
| * Because of JS (and Wasm) target it is required to have this method | ||
| * to access the file system in the common code | ||
| */ | ||
| expect fun fileSystem(): FileSystem |
60 changes: 60 additions & 0 deletions
60
...rc/commonMain/kotlin/it/krzeminski/snakeyaml/engine/kmp/benchmark/LoadingTimeBenchmark.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package it.krzeminski.snakeyaml.engine.kmp.benchmark | ||
|
|
||
| import it.krzeminski.snakeyaml.engine.kmp.api.LoadSettings | ||
| import it.krzeminski.snakeyaml.engine.kmp.api.YamlUnicodeReader | ||
| import it.krzeminski.snakeyaml.engine.kmp.composer.Composer | ||
| import it.krzeminski.snakeyaml.engine.kmp.constructor.BaseConstructor | ||
| import it.krzeminski.snakeyaml.engine.kmp.constructor.StandardConstructor | ||
| import it.krzeminski.snakeyaml.engine.kmp.parser.ParserImpl | ||
| import it.krzeminski.snakeyaml.engine.kmp.scanner.StreamReader | ||
| import kotlinx.benchmark.* | ||
| import okio.FileSystem | ||
| import okio.Path.Companion.toPath | ||
| import okio.buffer | ||
| import okio.use | ||
|
|
||
| @State(Scope.Benchmark) | ||
| @BenchmarkMode(Mode.AverageTime) | ||
| @OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS) | ||
| class LoadingTimeBenchmark { | ||
| @Param("") | ||
| var openAiYamlPath: String = "" | ||
|
|
||
| private val loadSettings = LoadSettings.builder().build() | ||
|
|
||
| private lateinit var constructor: BaseConstructor | ||
|
|
||
| @Setup | ||
| fun setUp() { | ||
| constructor = StandardConstructor(loadSettings) | ||
| } | ||
|
|
||
| @Benchmark | ||
| fun loadsOpenAiSchema(): Map<*, *> { | ||
| return with(FILE_SYSTEM) { | ||
| openReadOnly(openAiYamlPath.toPath(normalize = true)).use { handle -> | ||
| handle.source().buffer().use { source -> | ||
| // TODO: there is a Load class in JVM sources that can handle all of it | ||
| // but it is not available for common code. | ||
| // Probably, it should be moved from JVM sources to common sources. | ||
| val reader = StreamReader( | ||
| loadSettings = loadSettings, | ||
| stream = YamlUnicodeReader(source), | ||
| ) | ||
| val composer = Composer( | ||
| settings = loadSettings, | ||
| parser = ParserImpl( | ||
| settings = loadSettings, | ||
| reader = reader, | ||
| ) | ||
| ) | ||
| constructor.constructSingleDocument(composer.getSingleNode()) as Map<*, *> | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private companion object { | ||
| private val FILE_SYSTEM: FileSystem = fileSystem() | ||
| } | ||
| } |
10 changes: 10 additions & 0 deletions
10
...enchmarks/src/jsMain/kotlin/it/krzeminski/snakeyaml/engine/kmp/benchmark/FileSystem.js.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| package it.krzeminski.snakeyaml.engine.kmp.benchmark | ||
|
|
||
| import okio.FileSystem | ||
| import okio.NodeJsFileSystem | ||
|
|
||
| /** | ||
| * Without JS and Wasm targets there is no need in this function | ||
| * but we can keep it so minimize change when those targets are added | ||
| */ | ||
| actual fun fileSystem(): FileSystem = NodeJsFileSystem |
5 changes: 5 additions & 0 deletions
5
...chmarks/src/jvmMain/kotlin/it/krzeminski/snakeyaml/engine/kmp/benchmark/FileSystem.jvm.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package it.krzeminski.snakeyaml.engine.kmp.benchmark | ||
|
|
||
| import okio.FileSystem | ||
|
|
||
| actual fun fileSystem(): FileSystem = FileSystem.SYSTEM |
Oops, something went wrong.