feat(sampleapp): Adding sample app (#132)

Signed-off-by: Nicklas Lundin <[email protected]>
Signed-off-by: Nicklas Lundin <[email protected]>

Author: nicklasl

README.md

@@ -211,6 +211,14 @@ This should only be called when your application is in the process of shutting d
 ```kotlin
 OpenFeatureAPI.shutdown()
 ```
+## Sample app
+
+In the repo there is also a sample app currently under development. 
+The sample app can be used to try out development of a [Provider](#develop-a-provider), a [Hook](#develop-a-hook) 
+or to validate changes to the SDK itself. 
+
+The sample app should not be used as a reference implementation of how to use the OpenFeature SDK 
+in an Android app.
 
 ## Extending
 

build.gradle.kts

@@ -1,6 +1,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 plugins {
     id("com.android.library").version("7.4.2").apply(false)
+    id("com.android.application").version("7.4.2").apply(false)
     id("org.jetbrains.kotlin.android").version("1.8.10").apply(false)
     id("org.jlleitschuh.gradle.ktlint").version("11.6.1").apply(true)
     id("io.github.gradle-nexus.publish-plugin").version("2.0.0").apply(true)

release-please-config.json

@@ -10,7 +10,8 @@
                 "README.md",
                 "build.gradle.kts",
                 "android/build.gradle.kts"
-            ]
+            ],
+            "exclude-paths": ["sampleapp"]
         }
     },
     "changelog-sections": [

sampleapp/.gitignore

@@ -0,0 +1 @@
+/build

sampleapp/build.gradle.kts

@@ -0,0 +1,64 @@
+plugins {
+    id("com.android.application")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    namespace = "dev.openfeature.sdk.sampleapp"
+    compileSdk = 33
+
+    defaultConfig {
+        applicationId = "dev.openfeature.sdk.sampleapp"
+        minSdk = 28
+        targetSdk = 33
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        vectorDrawables {
+            useSupportLibrary = true
+        }
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_11
+        targetCompatibility = JavaVersion.VERSION_11
+    }
+    kotlinOptions {
+        jvmTarget = "11"
+    }
+    buildFeatures {
+        compose = true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion = "1.4.4"
+    }
+    packagingOptions {
+        resources {
+            excludes += "/META-INF/{AL2.0,LGPL2.1}"
+        }
+    }
+}
+
+dependencies {
+    implementation(project(":android"))
+    implementation("androidx.core:core-ktx:1.7.0")
+    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.6.1")
+    implementation("androidx.activity:activity-compose:1.3.0")
+    implementation(platform("androidx.compose:compose-bom:2022.10.00"))
+    implementation("androidx.compose.ui:ui")
+    implementation("androidx.compose.ui:ui-graphics")
+    implementation("androidx.compose.ui:ui-tooling-preview")
+    implementation("androidx.compose.material3:material3")
+    debugImplementation("androidx.compose.ui:ui-tooling")
+    debugImplementation("androidx.compose.ui:ui-test-manifest")
+}

sampleapp/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

sampleapp/src/main/AndroidManifest.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.OpenFeature">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.OpenFeature">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

sampleapp/src/main/java/dev/openfeature/sdk/sampleapp/ExampleProvider.kt

@@ -0,0 +1,92 @@
+package dev.openfeature.sdk.sampleapp
+
+import dev.openfeature.sdk.*
+import kotlinx.coroutines.delay
+
+class ExampleProvider(override val hooks: List<Hook<*>> = listOf()) : FeatureProvider {
+
+    private var currentContext: EvaluationContext? = ImmutableContext()
+    var delayTime = 1000L
+    var returnDefaults = false
+    val flags = mutableMapOf<String, Any>().apply {
+        put("booleanFlag", true)
+        put("stringFlag", "this is a string")
+        put("intFlag", 1337)
+        put("doubleFlag", 42.0)
+        put(
+            "objectFlag",
+            Value.Structure(mapOf("key1" to Value.String("value"), "key2" to Value.Integer(10)))
+        )
+    }
+
+    override val metadata: ProviderMetadata
+        get() = object : ProviderMetadata {
+            override val name: String = "ExampleProvider"
+        }
+
+    override suspend fun initialize(initialContext: EvaluationContext?) {
+        currentContext = initialContext
+        // Simulate a delay in the provider initialization
+        delay(delayTime)
+    }
+
+    override fun shutdown() {
+
+    }
+
+    override suspend fun onContextSet(
+        oldContext: EvaluationContext?,
+        newContext: EvaluationContext
+    ) {
+        currentContext = newContext
+        delay(delayTime)
+    }
+
+    override fun getBooleanEvaluation(
+        key: String,
+        defaultValue: Boolean,
+        context: EvaluationContext?
+    ): ProviderEvaluation<Boolean> = generateProviderEvaluation<Boolean>(defaultValue, key)
+
+    override fun getStringEvaluation(
+        key: String,
+        defaultValue: String,
+        context: EvaluationContext?
+    ): ProviderEvaluation<String> = generateProviderEvaluation<String>(defaultValue, key)
+
+    override fun getIntegerEvaluation(
+        key: String,
+        defaultValue: Int,
+        context: EvaluationContext?
+    ): ProviderEvaluation<Int> = generateProviderEvaluation<Int>(defaultValue, key)
+
+    override fun getDoubleEvaluation(
+        key: String,
+        defaultValue: Double,
+        context: EvaluationContext?
+    ): ProviderEvaluation<Double> = generateProviderEvaluation<Double>(defaultValue, key)
+
+    override fun getObjectEvaluation(
+        key: String,
+        defaultValue: Value,
+        context: EvaluationContext?
+    ): ProviderEvaluation<Value> = generateProviderEvaluation<Value>(defaultValue, key)
+
+    private inline fun <reified T> generateProviderEvaluation(
+        defaultValue: T,
+        key: String
+    ): ProviderEvaluation<T> {
+        if (returnDefaults) {
+            return ProviderEvaluation(defaultValue, null, reason = "returnDefaults")
+        }
+        return with(flags) {
+            if (containsKey(key) && get(key) is T) {
+                ProviderEvaluation(get(key) as T, "variant1", reason = "match")
+            } else if (containsKey(key)) {
+                ProviderEvaluation(defaultValue, null, reason = "invalid type")
+            } else {
+                ProviderEvaluation(defaultValue, null, reason = "notfound")
+            }
+        }
+    }
+}