Skip to content

feat: Multiplatform OFREP provider #6

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.

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

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
11 changes: 11 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
plugins {
alias(libs.plugins.kotlin.multiplatform) apply false
alias(libs.plugins.android.library) apply false
alias(libs.plugins.nexus.publish)
alias(libs.plugins.ktlint) apply false
alias(libs.plugins.binary.compatibility.validator) apply false
}

allprojects {
Expand All @@ -9,6 +13,13 @@ allprojects {
group = project.extra["groupId"].toString()
version = project.extra["version"].toString()

subprojects {
plugins.withId("org.jetbrains.kotlin.multiplatform") {
apply(plugin = "org.jlleitschuh.gradle.ktlint")
apply(plugin = "org.jetbrains.kotlinx.binary-compatibility-validator")
}
}

nexusPublishing {
this.repositories {
sonatype {
Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
org.gradle.configuration-cache=true
org.gradle.jvmargs=-Xmx1g "-XX:MaxMetaspaceSize=768m

# This seems to be necessary for Coroutines to work on JS. Otherwise getting the following error:
# > Task :providers:env-var:compileTestDevelopmentExecutableKotlinJs FAILED
Expand Down
13 changes: 11 additions & 2 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
[versions]
kotlin = "2.1.21"
kotlinx-coroutines = "1.10.2"
open-feature-kotlin-sdk = "0.4.1"
open-feature-kotlin-sdk = "0.5.0"
android = "8.10.1"
ktor = "3.1.3"

[libraries]
ktor-core = { module="io.ktor:ktor-client-core", version.ref="ktor" }
ktor-cio = { module="io.ktor:ktor-client-cio", version.ref="ktor" }
ktor-client-content-negotiation = { module="io.ktor:ktor-client-content-negotiation", version.ref="ktor" }
ktor-serialization-kotlinx-json = { module="io.ktor:ktor-serialization-kotlinx-json", version.ref="ktor" }
ktor-client-mock = { module="io.ktor:ktor-client-mock", version.ref="ktor" }
openfeature-kotlin-sdk = { group="dev.openfeature", name="kotlin-sdk", version.ref="open-feature-kotlin-sdk" }
kotlin-test = { group="org.jetbrains.kotlin", name="kotlin-test", version.ref="kotlin" }
kotlinx-coroutines-core = { group="org.jetbrains.kotlinx", name="kotlinx-coroutines-core", version.ref="kotlinx-coroutines" }
Expand All @@ -12,6 +19,8 @@ kotlinx-coroutines-test = { group="org.jetbrains.kotlinx", name="kotlinx-corouti
[plugins]
kotlin-multiplatform = { id="org.jetbrains.kotlin.multiplatform", version.ref="kotlin" }
kotlinx-atomicfu = { id="org.jetbrains.kotlinx.atomicfu", version="0.27.0" }
kotlinx-serialization = { id="org.jetbrains.kotlin.plugin.serialization", version="2.1.21" }
ktlint = { id="org.jlleitschuh.gradle.ktlint", version="12.3.0" }
nexus-publish = { id="io.github.gradle-nexus.publish-plugin", version="2.0.0" }
binary-compatibility-validator = { id="org.jetbrains.kotlinx.binary-compatibility-validator", version="0.17.0" }
binary-compatibility-validator = { id="org.jetbrains.kotlinx.binary-compatibility-validator", version="0.17.0" }
android-library = { id="com.android.library", version.ref="android" }
1,569 changes: 1,560 additions & 9 deletions kotlin-js-store/yarn.lock

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions providers/env-var/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest

plugins {
alias(libs.plugins.kotlin.multiplatform)
alias(libs.plugins.binary.compatibility.validator)
alias(libs.plugins.ktlint)
// Needed for the JS coroutine support for the tests
alias(libs.plugins.kotlinx.atomicfu)
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package dev.openfeature.kotlin.contrib.providers.envvar

import dev.openfeature.sdk.EvaluationContext
import dev.openfeature.sdk.FeatureProvider
import dev.openfeature.sdk.Hook
import dev.openfeature.sdk.ProviderEvaluation
import dev.openfeature.sdk.ProviderMetadata
import dev.openfeature.sdk.Reason
import dev.openfeature.sdk.Value
import dev.openfeature.sdk.exceptions.OpenFeatureError
import dev.openfeature.kotlin.sdk.EvaluationContext
import dev.openfeature.kotlin.sdk.FeatureProvider
import dev.openfeature.kotlin.sdk.Hook
import dev.openfeature.kotlin.sdk.ProviderEvaluation
import dev.openfeature.kotlin.sdk.ProviderMetadata
import dev.openfeature.kotlin.sdk.Reason
import dev.openfeature.kotlin.sdk.Value
import dev.openfeature.kotlin.sdk.exceptions.OpenFeatureError

/** EnvVarProvider is the Kotlin provider implementation for the environment variables. */
class EnvVarProvider(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dev.openfeature.kotlin.contrib.providers.envvar

import dev.openfeature.sdk.Client
import dev.openfeature.sdk.OpenFeatureAPI
import dev.openfeature.sdk.Reason
import dev.openfeature.kotlin.sdk.Client
import dev.openfeature.kotlin.sdk.OpenFeatureAPI
import dev.openfeature.kotlin.sdk.Reason
import kotlinx.coroutines.test.runTest
import kotlin.test.Test
import kotlin.test.assertEquals
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dev.openfeature.kotlin.contrib.providers.envvar

import dev.openfeature.sdk.FeatureProvider
import dev.openfeature.sdk.ImmutableContext
import dev.openfeature.sdk.ProviderEvaluation
import dev.openfeature.sdk.Reason
import dev.openfeature.sdk.Value
import dev.openfeature.sdk.exceptions.OpenFeatureError
import dev.openfeature.kotlin.sdk.FeatureProvider
import dev.openfeature.kotlin.sdk.ImmutableContext
import dev.openfeature.kotlin.sdk.ProviderEvaluation
import dev.openfeature.kotlin.sdk.Reason
import dev.openfeature.kotlin.sdk.Value
import dev.openfeature.kotlin.sdk.exceptions.OpenFeatureError
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
Expand Down
32 changes: 32 additions & 0 deletions providers/ofrep/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Kotlin OFREP Provider

This provider is designed to use the [OpenFeature Remote Evaluation Protocol (OFREP)](https://openfeature.dev/specification/appendix-c).

## Supported platforms

| Supported | Platform | Supported versions |
|-----------|----------------------|--------------------------------------------------------------------------------|
| ✅ | Android | |
| ✅ | JVM | JDK 11+ |
| ✅ | Native | Linux x64 |
| ❌ | Native | [Other native targets](https://kotlinlang.org/docs/native-target-support.html) |
| ✅ | Javascript (Node.js) | |
| ✅ | Javascript (Browser) | |
| ❌ | Wasm | |


## Installation

```kotlin
implementation("dev.openfeature.kotlin.contrib.providers:ofrep:0.1.0")
```

## Usage

To use the `OfrepProvider` create an instance and use it as a provider:

```kotlin
val options = OfrepOptions(endpoint="https://localhost:8080")
val provider = OfrepProvider(options)
OpenFeatureAPI.setProviderAndWait(provider)
```
77 changes: 77 additions & 0 deletions providers/ofrep/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import org.jetbrains.kotlin.gradle.dsl.JvmTarget

plugins {
alias(libs.plugins.kotlin.multiplatform)
alias(libs.plugins.kotlinx.serialization)
alias(libs.plugins.android.library)
// Needed for the JS coroutine support for the tests
alias(libs.plugins.kotlinx.atomicfu)
}

kotlin {
androidTarget()
jvm {
compilations.all {
compileTaskProvider.configure {
compilerOptions {
jvmTarget.set(JvmTarget.JVM_11)
}
}
}
}
linuxX64 {}
js {
nodejs {}
browser {
testTask {
useKarma {
useChromeHeadless()
}
}
}
}

sourceSets {
commonMain.dependencies {
api(libs.openfeature.kotlin.sdk)

api(libs.kotlinx.coroutines.core)
api(libs.ktor.core)
implementation(libs.ktor.cio)
implementation(libs.ktor.client.content.negotiation)
implementation(libs.ktor.serialization.kotlinx.json)
}
commonTest.dependencies {
implementation(libs.kotlin.test)
implementation(libs.kotlinx.coroutines.test)
implementation(libs.ktor.client.mock)
}
}
}

android {
namespace = "dev.openfeature.kotlin.contrib.providers.ofrep"
compileSdk = 35

defaultConfig {
minSdk = 21
}

compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}

publishing {
singleVariant("release") {
withJavadocJar()
withSourcesJar()
}
}

testOptions {
unitTests {
isIncludeAndroidResources = true
}
}
}
Loading
Loading