Add support for iOS targets #512

nathanfallet · 2025-07-31T08:24:01Z

I added iOS native targets

Fixes #177

Type of the change

Checklist for all pull requests

The pull request has a description of the proposed change
I read the Contributing Guidelines before opening the pull request
The pull request uses develop as the base branch
Tests for the changes have been added
All new and existing tests passed

Additional steps for pull requests adding a new feature

An issue describing the proposed change exists
The pull request includes a link to the issue
The change was discussed and approved in the issue
Docs have been added / updated

nathanfallet · 2025-07-31T08:58:58Z

It's ready for review now.

kagg886 · 2025-07-31T09:33:22Z

wow，that's good.

if we have multi engine in context(like okhttp),does we have some api to choose it?

nathanfallet · 2025-07-31T09:44:55Z

There is the engineFactory function for Ollama, but for other things I think it chooses in what's available (it works with Js engine already so it should work the same with other platforms)

nathanfallet · 2025-07-31T13:04:32Z

I also made a PR in kotlin-logging, so if I can have additional watchos targets directly I take them.
In my KMP libraries (like kourier or kdriver) I'm using the KtorSimpleLogger because it does the work for me without any additional librairies 👀

devcrocod

Please add only the following ios targets: iosArm64, iosX64, iosSimulatorArm64.

Also, have you tested it locally with ios?
Do we need to change the workflow for ios?

README.md

nathanfallet · 2025-07-31T15:34:54Z

The more target we support, the more users can use the library everywhere. I always try to support as much targets as possible to be the more KMP possible.
I remember when I started to work with KMP, I was sometimes limited because some libraries were not supporting all iOS or watchOS targets, so I could not use it in my app. I don't want anyone to experience this again.

Also, there is not much work since Ktor does all the work of multiplatform abstraction, so we maintain only common code.

nathanfallet · 2025-07-31T15:50:05Z

Imagine I want to build a Desktop Native Windows app. Why shouldn't I be allowed to use Koog?

So it perfectly makes sense as a library to be available on as many platforms as possible.

nathanfallet · 2025-07-31T22:38:01Z

The latest version of Kotlin Logging was published with the Kotlin 2.2.0 compiler so it does not work. Do I rollback and skip some watchOS targets? Or do I upgrade the project to use Kotlin 2.2.0 too?

devcrocod · 2025-08-01T10:40:46Z

@nathanfallet
I understand and support the idea of adding more targets. However, Koog is a framework, and with every new target comes a certain level of responsibility and maintenance overhead

Also, there is not much work since Ktor does all the work of multiplatform abstraction, so we maintain only common code.

That’s not entirely accurate, we rely on other dependencies as well. In addition, supporting more targets complicates the @Tool, which currently has a JVM-only implementation

Linux is particularly useful to use the library with Ktor Native on any Linux or Docker environment. Because Ktor Native is way smaller in binary size and memory consumption than Ktor JVM.

Imagine I want to build a Desktop Native Windows app. Why shouldn't I be allowed to use Koog?

In practice, all of these use cases are already covered by the JVM target. Also, Compose doesn’t support these native targets

Another important point is that Kotlin officially treats Linux as Tier 2 and Windows as Tier 3 platforms. This means Kotlin does not test mingwX64 on CI, and we might encounter compiler issues when building Koog for Windows. To manage this risk, we would need to introduce a tiered support model within Koog as well. So that users have a clear understanding of what’s officially supported and what may be unstable. Otherwise, we’d tie our release stability to the state of Kotlin’s native targets, which could negatively impact our main JVM releases

Therefore, I suggest that in this PR we proceed only with iOS support. For the other native targets, we can open a separate issue to discuss support levels, the process for adding and releasing them, and associated maintenance implications

nathanfallet · 2025-08-01T11:02:29Z

Okay, I'll comment out the other targets, so we can uncomment them later when we want to (but they will be ready)

EDIT: I made the change. I kept the targets inside comments so we can easily get them again later when we want, as well as the xxxMain folders (appleMain is used for iOS, but other are unused for now but will be later so we don't have to rewrite it)

nathanfallet · 2025-08-01T11:20:13Z

I will take a look about adding tests for iOS (configuring GH Actions to run on macOS)

nathanfallet · 2025-08-01T16:26:32Z

@devcrocod What do you think now? Also, I launched ios tests on macOS, but I might need to move some tests from jvmTest to commonTest, because otherwise they won't run on iOS (but strange thing since js & wasmjs are already added but they don't have any tests 🤷‍♂️). At least I can confirm iOS is compiling correctly from them succeeding.

devcrocod

I think it’s better to clean up the code from other targets to avoid confusion for other users and contributors

The main question is about testing, I hope @aozherelyeva can help with that part

devcrocod · 2025-08-06T13:23:05Z

.github/workflows/checks.yml

@@ -98,6 +98,10 @@ jobs:
        if: matrix.os != 'ubuntu-latest'
        run: ./gradlew jvmTest --continue

+      - name: iosX64Test with Gradle Wrapper


I think the iosSimulatorArm64 tests should also be added, right?

@aozherelyeva How will this affect our current testing?

The only failing test is OpenAIEmbedderTest, but I'm not sure whether it's a critical issue, as JVM target is running for it without a problem.

I'm not even sure we should run them for the iOS target. @nathanfallet WDYT?

The only failing test is OpenAIEmbedderTest

In my opinion, this is an issue because the provider code has no platform-specific dependencies and should run on any target

I also checked that macos-latest refers to macOS 14 on arm64, so iosX64Test won’t run on it. gradle will just skip it, since for arm devices it should be iosSimulatorArm64

Hm, yes, I also see that iosX64Test is being skipped... good point!
@nathanfallet could you take a look at the tests?

devcrocod · 2025-08-06T13:25:10Z

agents/agents-features/agents-features-common/build.gradle.kts

+        linuxMain {
+            dependencies {
+                api(libs.ktor.client.curl)
+            }
+        }
+
+        mingwMain {
+            dependencies {
+                api(libs.ktor.client.winhttp)
+            }
+        }


need to remove all such places

It’s strange that this doesn’t lead to an exception

devcrocod · 2025-08-06T13:28:08Z

agents/agents-utils/src/appleMain/kotlin/ai/koog/agents/utils/Coroutines.apple.kt

If use native/, it will cover all cases with Kotlin/Native

Or do you think we’ll need to split it into specific targets in the future?

devcrocod · 2025-08-06T13:29:50Z

buildSrc/src/main/kotlin/ai.kotlin.multiplatform.gradle.kts

+    // Tiers are in accordance with <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()
+    //watchosDeviceArm64()


I don’t think leaving commented-out code is a good practice
At the very least, adding the targets to the build script in the future won’t be a difficult task

devcrocod · 2025-08-06T13:30:46Z

prompt/prompt-executor/prompt-executor-clients/prompt-executor-ollama-client/build.gradle.kts

+        linuxMain {
+            dependencies {
+                api(libs.ktor.client.curl)
+            }
+        }
+
+        mingwMain {
+            dependencies {
+                api(libs.ktor.client.winhttp)
+            }
+        }


please drop it

devcrocod · 2025-08-06T13:33:31Z

...lama-client/src/appleMain/kotlin/ai/koog/prompt/executor/ollama/client/OllamaClient.apple.kt

It would be good to get rid of the explicit/actual here, since ktor can choose the required engine automatically
However, if you decide to keep it, you’ll also need to remove it for linux and mingw, or place it under native/

nathanfallet · 2025-08-12T16:53:06Z

@aozherelyeva @devcrocod I think we're good! I only kept changes related to iOS (linux and mingw changes were totally removed) and I also updated CI to run iOS tests for arm instead of previous ones.

nathanfallet · 2025-08-12T21:10:07Z

Wait, iosSimulatorArm64Test fails. But I noticed there is no such tests for js and wasm. So this might be a bigger issue related to all non jvm platforms...

devcrocod · 2025-08-19T12:05:05Z

I found the problem:
the OpenAIEmbedderTest tests are failing because in these tests the MockOpenAIEmbedderClient inherits from OpenAIClient(""). In Kotlin/Native this causes an error due to top-level initialization of the httpClient. If we change the inheritance to LLMEmbeddingProvider, like in the case of Ollama, it fixes the issue. However, in that case I’m not entirely sure about the correctness of the tests.

@aozherelyeva could you please advise?

…support for #512)

aozherelyeva · 2025-08-19T17:04:57Z

Thanks to @devcrocod, the problem is found and already solved. So now the iosSimulatorArm64Test target shall fully pass! 😃

aozherelyeva

LGTM test-wise!

nathanfallet · 2025-08-21T19:35:46Z

I guess it's good now. So excited for the multiplatform area to start!

…s apple klib)

devcrocod

finally 🎉

aozherelyeva · 2025-08-25T19:21:22Z

Congrats! 🚀 🔥

kagg886 · 2025-08-26T01:03:38Z

Congratulations！🎆🎆🎆

nicolasf · 2025-08-26T19:19:10Z

Hi!

I can't build Koog on my Mac with these changes. I'm building from 8b313b0.
I didn't have time to debug this yet, but commenting out the ios targets fixes the issue for me.

Here's the build error:

> Task :integration-tests:generateMetadataFileForIosArm64Publication FAILED

[Incubating] Problems report is available at: file:///Users/nicolas/Projects/koog/build/reports/problems/problems-report.html

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':integration-tests:generateMetadataFileForIosArm64Publication'.
> java.io.FileNotFoundException: /Users/nicolas/Projects/koog/integration-tests/build/libs/integration-tests-iosArm64Main-0.3.0.1.klib (No such file or directory)

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.

Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

For more on this, please refer to https://docs.gradle.org/8.14.1/userguide/command_line_interface.html#sec:command_line_warnings in the Gradle documentation.

BUILD FAILED in 4s
125 actionable tasks: 8 executed, 4 from cache, 113 up-to-date

Might be some issue on my side, but I thought it was worth sharing.

nathanfallet · 2025-08-26T19:59:15Z

@nicolasf Your error mentions 0.3.0.1 which is not publicly available (you can find it on https://packages.jetbrains.team/maven/p/grazi/grazie-platform-public/ai/koog/koog-agents/ but you need to add the repository to your gradle settings). But I don't get how it is related to the iOS target.

nicolasf · 2025-08-26T20:27:06Z

@nathanfallet
The error happens when building koog itself locally from the develop branch.
I forgot to add the command I'm using, which explains why it shows as 0.3.0.1:

BRANCH_KOOG_IS_RELEASING_FROM=develop TC_BUILD_COUNTER=1 ./gradlew publishToMavenLocal

The error will also happen without the env vars, but for 0.3.0 instead.

If no one else has issues building it, it might be something on my environment.

Thanks.

ychescale9 · 2025-08-28T03:40:11Z

have the iOS targets been published to maven central?

nathanfallet mentioned this pull request Jul 31, 2025

Support for Foundation Models for Apple Platform #381

Open

nathanfallet changed the title ~~adding more multiplatform~~ Add support for more multiplatform targets (Apple, Linux, Windows) Jul 31, 2025

nathanfallet mentioned this pull request Jul 31, 2025

Adding missing watchos targets oshai/kotlin-logging#538

Merged

devcrocod requested changes Jul 31, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

nathanfallet changed the title ~~Add support for more multiplatform targets (Apple, Linux, Windows)~~ Add support for iOS targets Aug 1, 2025

This was referenced Aug 1, 2025

Add support for Linux Native KMP target #519

Open

Add support for Windows Native KMP targets (mingw) #520

Open

aozherelyeva requested review from devcrocod, Ololoshechkin and tiginamaria August 6, 2025 10:48

devcrocod requested a review from aozherelyeva August 6, 2025 13:22

devcrocod requested changes Aug 6, 2025

View reviewed changes

aozherelyeva added a commit that referenced this pull request Aug 19, 2025

Consolidate embedding model test cases into a single test structure (…

9c0237e

…support for #512)

aozherelyeva mentioned this pull request Aug 19, 2025

Consolidate embedding model test cases into a single test structure #600

Merged

15 tasks

aozherelyeva added a commit that referenced this pull request Aug 19, 2025

Consolidate embedding model test cases into a single test structure (…

2f24a56

…support for #512)

devcrocod force-pushed the adding-more-multiplatform branch from b8b3546 to 600d415 Compare August 19, 2025 19:43

aozherelyeva approved these changes Aug 20, 2025

View reviewed changes

devcrocod force-pushed the adding-more-multiplatform branch from 600d415 to 9a604fe Compare August 24, 2025 19:21

nathanfallet and others added 12 commits August 25, 2025 18:33

adding more multiplatform

38ae1be

update readme with new supported platforms

16a2038

fix missing ollama engineFactoryProvider actual declarations

f3fe350

chore: update kotlin logging for missing watchos targets

772efbb

revert: only keep ios targets (other ones will be for later)

0d85150

update readme again

5992b27

configure macos gh actions + ios tests + fix annotations (26.0.2 fixe…

60d3c43

…s apple klib)

add javadoc artifact in Maven publishing configuration (JetBrains#447)

c3c42e7

fixup! revert grazie public deletion

e2aa4db

apply requested changes

baac7d9

oops

96074c5

undo unknown changes

735d298

devcrocod force-pushed the adding-more-multiplatform branch from 9a604fe to 735d298 Compare August 25, 2025 16:34

fix naming test for kotlin/native

3cda067

devcrocod self-requested a review August 25, 2025 18:32

devcrocod approved these changes Aug 25, 2025

View reviewed changes

devcrocod merged commit 8779986 into JetBrains:develop Aug 25, 2025
6 of 7 checks passed

nathanfallet deleted the adding-more-multiplatform branch September 2, 2025 17:44

Add support for iOS targets #512

Add support for iOS targets #512

Uh oh!

Conversation

nathanfallet commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of the change

Checklist for all pull requests

Additional steps for pull requests adding a new feature

Uh oh!

nathanfallet commented Jul 31, 2025

Uh oh!

kagg886 commented Jul 31, 2025

Uh oh!

nathanfallet commented Jul 31, 2025

Uh oh!

nathanfallet commented Jul 31, 2025

Uh oh!

devcrocod left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nathanfallet commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathanfallet commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathanfallet commented Jul 31, 2025

Uh oh!

devcrocod commented Aug 1, 2025

Uh oh!

nathanfallet commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathanfallet commented Aug 1, 2025

Uh oh!

nathanfallet commented Aug 1, 2025

Uh oh!

devcrocod left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nathanfallet commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nathanfallet commented Aug 12, 2025

Uh oh!

devcrocod commented Aug 19, 2025

Uh oh!

aozherelyeva commented Aug 19, 2025

Uh oh!

aozherelyeva left a comment

Choose a reason for hiding this comment

Uh oh!

nathanfallet commented Aug 21, 2025

Uh oh!

devcrocod left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nathanfallet commented Jul 31, 2025 •

edited

Loading

nathanfallet commented Jul 31, 2025 •

edited

Loading

nathanfallet commented Jul 31, 2025 •

edited

Loading

nathanfallet commented Aug 1, 2025 •

edited

Loading

nathanfallet commented Aug 12, 2025 •

edited

Loading