Merge pull request #2996 from DataDog/typo/flags-of-module

[flags] feat: scaffold openfeature provider module

Co-authored-by: typotter <[email protected]>

Author: dd-mergequeue[bot]

LICENSE-3rdparty.csv

@@ -61,6 +61,7 @@ import,com.squareup.moshi,Apache-2.0,"Copyright 2013 Square, Inc"
 import,com.squareup.sqldelight,Apache-2.0,"Copyright 2016 Square, Inc"
 import,com.fasterxml.jackson,Apache-2.0,"Copyright 2020 Datadog, Inc."
 import,com.datadoghq,Apache-2.0,"Copyright 2017 Datadog, Inc"
+import,dev.openfeature,Apache-2.0,Copyright 2022 The OpenFeature Authors
 import,io.coil-kt,Apache-2.0,Copyright 2021 Coil Contributors
 import,io.opentelemetry,Apache-2.0,Copyright 2019 The OpenTelemetry Authors
 import,io.opentracing,Apache-2.0,Copyright 2016-2017 The OpenTracing Authors

ci/pipelines/default-pipeline.yml

@@ -112,6 +112,7 @@ analysis:detekt-custom:
     - ./gradlew :features:dd-sdk-android-trace:customDetektRules
     - ./gradlew :features:dd-sdk-android-trace-otel:customDetektRules
     - ./gradlew :features:dd-sdk-android-webview:customDetektRules
+    - ./gradlew :features:dd-sdk-android-flags-openfeature:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-coil:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-compose:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-fresco:customDetektRules

features/dd-sdk-android-flags-openfeature/.gitignore

@@ -0,0 +1,5 @@
+/build
+*.iml
+.gradle
+/local.properties
+.DS_Store

features/dd-sdk-android-flags-openfeature/api/apiSurface

@@ -0,0 +1,3 @@
+class com.datadog.android.flags.openfeature.DatadogFlagsProvider
+  fun helloWorld(): String
+  companion object 

features/dd-sdk-android-flags-openfeature/api/dd-sdk-android-flags-openfeature.api

@@ -0,0 +1,9 @@
+public final class com/datadog/android/flags/openfeature/DatadogFlagsProvider {
+	public static final field Companion Lcom/datadog/android/flags/openfeature/DatadogFlagsProvider$Companion;
+	public fun <init> ()V
+	public final fun helloWorld ()Ljava/lang/String;
+}
+
+public final class com/datadog/android/flags/openfeature/DatadogFlagsProvider$Companion {
+}
+

features/dd-sdk-android-flags-openfeature/build.gradle.kts

@@ -0,0 +1,83 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+import com.datadog.gradle.config.androidLibraryConfig
+import com.datadog.gradle.config.dependencyUpdateConfig
+import com.datadog.gradle.config.detektCustomConfig
+import com.datadog.gradle.config.javadocConfig
+import com.datadog.gradle.config.junitConfig
+import com.datadog.gradle.config.kotlinConfig
+import com.datadog.gradle.config.publishingConfig
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    // Build
+    id("com.android.library")
+    kotlin("android")
+
+    // Publish
+    `maven-publish`
+    signing
+    id("org.jetbrains.dokka-javadoc")
+
+    // Analysis tools
+    id("com.github.ben-manes.versions")
+
+    // Tests
+    id("de.mobilej.unmock")
+    id("org.jetbrains.kotlinx.kover")
+
+    // Internal Generation
+    id("com.datadoghq.dependency-license")
+    id("apiSurface")
+    id("transitiveDependencies")
+    id("verificationXml")
+    id("binary-compatibility-validator")
+}
+
+android {
+    namespace = "com.datadog.android.flags.openfeature"
+}
+
+dependencies {
+    // datadog
+    api(project(":dd-sdk-android-core"))
+    api(project(":features:dd-sdk-android-flags"))
+    implementation(project(":dd-sdk-android-internal"))
+
+    // OpenFeature SDK
+    api(libs.openFeatureKotlinSdk)
+
+    implementation(libs.kotlin)
+    implementation(libs.androidXAnnotation)
+
+    testImplementation(project(":tools:unit")) {
+        attributes {
+            attribute(
+                com.android.build.api.attributes.ProductFlavorAttr.of("platform"),
+                objects.named("jvm")
+            )
+        }
+    }
+    testImplementation(libs.bundles.jUnit5)
+    testImplementation(libs.bundles.testTools)
+    unmock(libs.robolectric)
+}
+
+unMock {
+    keepStartingWith("org.json")
+}
+
+kotlinConfig(jvmBytecodeTarget = JvmTarget.JVM_11)
+androidLibraryConfig()
+junitConfig()
+javadocConfig()
+dependencyUpdateConfig()
+publishingConfig(
+    "OpenFeature Provider integration for the Datadog Feature Flags " +
+        "library for Android applications."
+)
+detektCustomConfig()

features/dd-sdk-android-flags-openfeature/src/main/kotlin/com/datadog/android/flags/openfeature/DatadogFlagsProvider.kt

@@ -0,0 +1,24 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.flags.openfeature
+
+/**
+ * OpenFeature Provider implementation backed by Datadog Feature Flags.
+ */
+class DatadogFlagsProvider {
+
+    /**
+     * Simple hello world method so the module is not empty.
+     *
+     * @return A greeting message
+     */
+    fun helloWorld(): String = GREETING
+
+    companion object {
+        private const val GREETING = "Hello from DatadogFlagsProvider!"
+    }
+}

features/dd-sdk-android-flags-openfeature/src/test/kotlin/com/datadog/android/flags/openfeature/DatadogFlagsProviderTest.kt

@@ -0,0 +1,42 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.flags.openfeature
+
+import com.datadog.tools.unit.forge.BaseConfigurator
+import fr.xgouchet.elmyr.junit5.ForgeConfiguration
+import fr.xgouchet.elmyr.junit5.ForgeExtension
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+import org.junit.jupiter.api.extension.Extensions
+import org.mockito.junit.jupiter.MockitoExtension
+import org.mockito.junit.jupiter.MockitoSettings
+import org.mockito.quality.Strictness
+
+@Extensions(
+    ExtendWith(MockitoExtension::class),
+    ExtendWith(ForgeExtension::class)
+)
+@MockitoSettings(strictness = Strictness.STRICT_STUBS)
+@ForgeConfiguration(BaseConfigurator::class)
+internal class DatadogFlagsProviderTest {
+
+    lateinit var provider: DatadogFlagsProvider
+
+    @BeforeEach
+    fun setUp() {
+        provider = DatadogFlagsProvider()
+    }
+
+    @Test
+    fun `M return greeting W helloWorld()`() {
+        val result = provider.helloWorld()
+
+        assertThat(result).isEqualTo("Hello from DatadogFlagsProvider!")
+    }
+}

features/dd-sdk-android-flags-openfeature/transitiveDependencies

@@ -0,0 +1,9 @@
+Dependencies List
+
+androidx.annotation:annotation-jvm:1.9.1                        :   59 Kb
+dev.openfeature:kotlin-sdk-android:0.6.2                        :  118 Kb
+org.jetbrains.kotlin:kotlin-stdlib:2.1.21                       : 1683 Kb
+org.jetbrains:annotations:23.0.0                                :   28 Kb
+
+Total transitive dependencies size                              : 1889 Kb
+

gradle/libs.versions.toml

@@ -95,6 +95,7 @@ newPipeExtractor = "v0.24.6"
 navigation3 = "1.0.0-alpha01"
 kotlinxSerializationCore = "1.8.1"
 lifecycleViewmodelNav3 = "1.0.0-alpha01"
+openFeature = "0.6.2"
 
 # Local Server
 ktor = "2.3.13"
@@ -248,6 +249,8 @@ rxJava3 = { module = "io.reactivex.rxjava3:rxjava", version.ref = "rxJava3" }
 rxJava3Android = { module = "io.reactivex.rxjava3:rxandroid", version.ref = "rxJava3" }
 timber = { module = "com.jakewharton.timber:timber", version.ref = "timber" }
 
+openFeatureKotlinSdk = { module = "dev.openfeature:kotlin-sdk", version.ref = "openFeature" }
+
 coroutinesCore = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
 
 exoplayer = { module = "com.google.android.exoplayer:exoplayer", version.ref = "exoplayer" }