feat!: Kotlin Multiplatform support (#148)

Signed-off-by: Bence Hornák <[email protected]>

Author: bencehornak

.editorconfig

@@ -68,8 +68,8 @@ ij_kotlin_method_call_chain_wrap = normal
 ij_kotlin_method_parameters_new_line_after_left_paren = true
 ij_kotlin_method_parameters_right_paren_on_new_line = true
 ij_kotlin_method_parameters_wrap = on_every_item
-ij_kotlin_name_count_to_use_star_import = 5
-ij_kotlin_name_count_to_use_star_import_for_members = 3
+ij_kotlin_name_count_to_use_star_import = 999
+ij_kotlin_name_count_to_use_star_import_for_members = 999
 ij_kotlin_packages_to_use_import_on_demand = unset
 ij_kotlin_parameter_annotation_wrap = off
 ij_kotlin_space_after_comma = true
@@ -130,4 +130,7 @@ max_line_length=120
 
 # Ignore max line for kotlin test files, the same as Detekt.
 [**/{test,androidTest}/**/*.kt]
-max_line_length=off
+max_line_length=off
+
+[*.kts]
+max_line_length = off

.github/workflows/ci.yaml

@@ -14,5 +14,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      # For browser tests
+      - uses: browser-actions/setup-chrome@v1
+
       - name: Run checks
         run: ./gradlew check --no-daemon --stacktrace

.gitignore

@@ -3,3 +3,4 @@
 
 .idea
 local.properties
+.kotlin

CONTRIBUTING.md

@@ -16,6 +16,20 @@ Manual formatting is done by invoking
 ./gradlew ktlintFormat
 ```
 
+## Testing
+
+Prerequisite for browser tests: Install Google Chrome (or Google Chrome headless)
+
+To run tests on all supported platforms:
+```
+./gradlew allTests
+```
+
+To run all verifications:
+```
+./gradlew check
+```
+
 ## Releases
 
 This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes in the library, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request), based on the PR title. The semantics of the PR title are enforced by the `lint-pr.yml` workflow. When Release Please's running PR is merged, a new release is created, and the associated artifacts are published.

README.md

@@ -35,27 +35,70 @@
 
 ### Requirements
 
-- The Android minSdk version supported is: `21`.
+The following [Kotlin Multiplatform Targets](https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-dsl-reference.html#targets) are supported:
 
-Note that this library is intended to be used in a mobile context, and has not been evaluated for use in other types of applications (e.g. server applications).
+| Supported | Platform             | Supported versions                                                             |
+|-----------|----------------------|--------------------------------------------------------------------------------|
+| ✅         | Android              | SDK 21+                                                                        |
+| ✅         | JVM                  | JDK 11+                                                                        |
+| ✅         | Native               | Linux x64                                                                      |
+| ❌         | Native               | [Other native targets](https://kotlinlang.org/docs/native-target-support.html) |
+| ✅         | Javascript (Node.js) |                                                                                |
+| ✅         | Javascript (Browser) |                                                                                |
+| ❌         | Wasm                 |                                                                                |
 
-### Install
 
-#### Maven Central
+Note that this library adheres to the
+[Static Context Paradigm](https://openfeature.dev/docs/reference/concepts/sdk-paradigms), so it is
+intended to be used on the **client side** (i.e. mobile apps, web apps and desktop apps), and has
+not been evaluated for use in other types of applications (e.g. server applications).
 
-Installation via Maven Central is preferred, using the following dependency:
+### Installation
+
+Installation is preferred via Maven Central.
+
+#### In Android projects
+
+> [!IMPORTANT]
+> Before version 0.6.0 the Maven artifact's id was `android-sdk`. When upgrading to 0.6.0 or higher
+> please do make sure to use the new artifact id, which is `kotlin-sdk`.
 
 <!-- x-release-please-start-version -->
+
 ```kotlin
 dependencies {
-    api("dev.openfeature:android-sdk:0.5.3")
+    api("dev.openfeature:kotlin-sdk:0.5.3")
 }
 ```
+<!-- x-release-please-end -->
+
+#### In multiplatform projects
+
+<!-- x-release-please-start-version -->
+```kotlin
+kotlin {
+    sourceSets {
+        commonMain.dependencies {
+            api("dev.openfeature:kotlin-sdk:0.5.3")
+        }
+    }
+}
+```
+<!-- x-release-please-end -->
+
 
 ### Usage
 
+> [!NOTE]
+> In version 0.6.0 the base package name has changed from `dev.openfeature.sdk` to
+> `dev.openfeature.kotlin.sdk`. When upgrading to 0.6.0 or higher please update your imports
+> accordingly.
+> 
+> **Example:** `import dev.openfeature.sdk.EvaluationContext` ->
+> `import dev.openfeature.kotlin.sdk.EvaluationContext`.
+
 ```kotlin
-coroutineScope.launch(Dispatchers.IO) {
+coroutineScope.launch(Dispatchers.Default) {
   // configure a provider, wait for it to complete its initialization tasks
   OpenFeatureAPI.setProviderAndWait(customProvider)
   val client = OpenFeatureAPI.getClient()
@@ -90,7 +133,7 @@ If the provider you're looking for hasn't been created yet, see the [develop a p
 Once you've added a provider as a dependency, it can be registered with OpenFeature like this:
 
 ```kotlin
-coroutineScope.launch(Dispatchers.IO) {
+coroutineScope.launch(Dispatchers.Default) {
     OpenFeatureAPI.setProviderAndWait(MyProvider())
 }
 ```
@@ -195,7 +238,7 @@ viewModelScope.launch {
 viewModelScope.launch {
   OpenFeatureAPI.setProviderAndWait(
     MyFeatureProvider(),
-    Dispatchers.IO,
+    Dispatchers.Default,
     myEvaluationContext
   )
 }