feat!: Extract enums to top level and use them in Js interface (#126)

* Use enums in Js interface * Fix tests * Opt-in for JsExport annotation * Fix code review comments * Use last snapshot version of expression-parser * Use last snapshot version of expression-parser
dhis2 · Apr 11, 2024 · c6ff765 · c6ff765
1 parent 63f89f0
commit c6ff765
Show file tree

Hide file tree

Showing 38 changed files with 254 additions and 280 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -63,9 +63,14 @@ kotlin {
 
 
     sourceSets {
+        all {
+            languageSettings.apply {
+                optIn("kotlin.js.ExperimentalJsExport")
+            }
+        }
         val commonMain by getting {
             dependencies {
-                implementation("org.hisp.dhis.lib.expression:expression-parser:1.1.0-SNAPSHOT")
+                implementation("org.hisp.dhis.lib.expression:expression-parser:1.1.0-20240411.094221-16")
                 implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.1")
             }
         }

diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -2,7 +2,7 @@ plugins {
     `kotlin-dsl`
 }
 
-val kotlinVersion = "1.9.21"
+val kotlinVersion = "1.9.22"
 val dokkaVersion = "1.9.10"
 val nexusPluginVersion = "1.3.0"
 val npmPluginVersion = "3.4.1"

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/api/ItemValueType.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/api/ItemValueType.kt
@@ -1,6 +1,7 @@
 package org.hisp.dhis.rules.api
 
 import org.hisp.dhis.lib.expression.spi.ValueType
+import kotlin.js.JsExport
 
 /*
 * Copyright (c) 2004-2020, University of Oslo
@@ -30,9 +31,7 @@ import org.hisp.dhis.lib.expression.spi.ValueType
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
-/**
- * @author Zubair Asghar
- */
+@JsExport
 enum class ItemValueType(val value: String) {
     NUMBER("1.0"),
     DATE("2020-01-01"),

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/engine/DefaultRuleEngine.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/engine/DefaultRuleEngine.kt
@@ -1,6 +1,7 @@
 package org.hisp.dhis.rules.engine
 
 import org.hisp.dhis.lib.expression.Expression
+import org.hisp.dhis.lib.expression.ExpressionMode
 import org.hisp.dhis.lib.expression.spi.IllegalExpressionException
 import org.hisp.dhis.lib.expression.spi.ParseException
 import org.hisp.dhis.lib.expression.spi.ValueType
@@ -51,15 +52,15 @@ internal class DefaultRuleEngine: RuleEngine {
 
     override fun validate(expression: String, dataItemStore: Map<String, DataItem>): RuleValidationResult {
         // Rule condition expression should be evaluated against Boolean
-        return getExpressionDescription(expression, Expression.Mode.RULE_ENGINE_CONDITION, dataItemStore)
+        return getExpressionDescription(expression, ExpressionMode.RULE_ENGINE_CONDITION, dataItemStore)
     }
 
     override fun validateDataFieldExpression(expression: String, dataItemStore: Map<String, DataItem>): RuleValidationResult {
         // Rule action data field should be evaluated against all i.e Boolean, String, Date and Numerical value
-        return getExpressionDescription(expression, Expression.Mode.RULE_ENGINE_ACTION, dataItemStore)
+        return getExpressionDescription(expression, ExpressionMode.RULE_ENGINE_ACTION, dataItemStore)
     }
 
-    private fun getExpressionDescription(expression: String, mode: Expression.Mode, dataItemStore: Map<String, DataItem>): RuleValidationResult {
+    private fun getExpressionDescription(expression: String, mode: ExpressionMode, dataItemStore: Map<String, DataItem>): RuleValidationResult {
         return try {
             val validationMap: Map<String, ValueType> = dataItemStore.mapValues { e -> e.value.valueType.toValueType() }
             Expression(expression, mode, false).validate(validationMap)

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleConditionEvaluator.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleConditionEvaluator.kt
@@ -1,6 +1,7 @@
 package org.hisp.dhis.rules.engine
 
 import org.hisp.dhis.lib.expression.Expression
+import org.hisp.dhis.lib.expression.ExpressionMode
 import org.hisp.dhis.lib.expression.spi.ExpressionData
 import org.hisp.dhis.lib.expression.spi.IllegalExpressionException
 import org.hisp.dhis.rules.createLogger
@@ -57,7 +58,7 @@ internal class RuleConditionEvaluator {
                         rule.condition,
                         valueMap,
                         supplementaryData,
-                        Expression.Mode.RULE_ENGINE_CONDITION
+                        ExpressionMode.RULE_ENGINE_CONDITION
                     ).toBoolean()
                 ) {
                     for (action in rule.actions) {
@@ -68,7 +69,7 @@ internal class RuleConditionEvaluator {
                                     unwrapVariableName(action.content()!!),
                                     RuleVariableValue(
                                         RuleValueType.TEXT,
-                                        process(action.data, valueMap, supplementaryData, Expression.Mode.RULE_ENGINE_ACTION),
+                                        process(action.data, valueMap, supplementaryData, ExpressionMode.RULE_ENGINE_ACTION),
                                         listOf(),
                                         null
                                     ),
@@ -134,7 +135,7 @@ internal class RuleConditionEvaluator {
 
     private fun process(
         condition: String?, valueMap: Map<String, RuleVariableValue>,
-        supplementaryData: Map<String, List<String>>, mode: Expression.Mode
+        supplementaryData: Map<String, List<String>>, mode: ExpressionMode
     ): String {
         if (condition==null || condition.isEmpty()) {
             return ""
@@ -180,15 +181,15 @@ internal class RuleConditionEvaluator {
         supplementaryData: Map<String, List<String>>
     ): RuleEffect {
         if (ruleAction.type == "ASSIGN") {
-            val data = process(ruleAction.data, valueMap, supplementaryData, Expression.Mode.RULE_ENGINE_ACTION)
+            val data = process(ruleAction.data, valueMap, supplementaryData, ExpressionMode.RULE_ENGINE_ACTION)
             updateValueMap(ruleAction.field()!!, RuleVariableValue(RuleValueType.TEXT, data, listOf(), null), valueMap)
             return if (data.isEmpty()) {
                 RuleEffect(rule.uid, ruleAction, null)
             } else {
                 RuleEffect(rule.uid, ruleAction, data)
             }
         }
-        val data = if (!ruleAction.data.isNullOrEmpty()) process(ruleAction.data, valueMap, supplementaryData, Expression.Mode.RULE_ENGINE_ACTION) else ""
+        val data = if (!ruleAction.data.isNullOrEmpty()) process(ruleAction.data, valueMap, supplementaryData, ExpressionMode.RULE_ENGINE_ACTION) else ""
         return RuleEffect(
             rule.uid,
             ruleAction,

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/Option.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/Option.kt
@@ -1,8 +1,6 @@
 package org.hisp.dhis.rules.models
 
-import kotlin.js.ExperimentalJsExport
 import kotlin.js.JsExport
 
 @JsExport
-@OptIn(ExperimentalJsExport::class)
 data class Option(val name: String, val code: String)
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleAttributeValue.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleAttributeValue.kt
@@ -1,10 +1,8 @@
 package org.hisp.dhis.rules.models
 
-import kotlin.js.ExperimentalJsExport
 import kotlin.js.JsExport
 
 @JsExport
-@OptIn(ExperimentalJsExport::class)
 data class RuleAttributeValue(
     val trackedEntityAttribute: String,
     val value: String

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEnrollment.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEnrollment.kt
@@ -7,14 +7,8 @@ data class RuleEnrollment(
     val programName: String,
     val incidentDate: LocalDate,
     val enrollmentDate: LocalDate,
-    val status: Status,
+    val status: RuleEnrollmentStatus,
     val organisationUnit: String,
     val organisationUnitCode: String,
     val attributeValues: List<RuleAttributeValue>
-) {
-    enum class Status {
-        ACTIVE,
-        COMPLETED,
-        CANCELLED
-    }
-}
+)
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEnrollmentStatus.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEnrollmentStatus.kt
@@ -0,0 +1,10 @@
+package org.hisp.dhis.rules.models
+
+import kotlin.js.JsExport
+
+@JsExport
+enum class RuleEnrollmentStatus {
+    ACTIVE,
+    COMPLETED,
+    CANCELLED
+}
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEvent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEvent.kt
@@ -7,20 +7,11 @@ data class RuleEvent(
     val event: String,
     val programStage: String,
     val programStageName: String,
-    val status: Status,
+    val status: RuleEventStatus,
     val eventDate: Instant,
     val dueDate: LocalDate?,
     val completedDate: LocalDate?,
     val organisationUnit: String,
     val organisationUnitCode: String?,
     val dataValues: List<RuleDataValue>
-) {
-    enum class Status {
-        ACTIVE,
-        COMPLETED,
-        SCHEDULE,
-        SKIPPED,
-        VISITED,
-        OVERDUE
-    }
-}
+)
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEventStatus.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleEventStatus.kt
@@ -0,0 +1,13 @@
+package org.hisp.dhis.rules.models
+
+import kotlin.js.JsExport
+
+@JsExport
+enum class RuleEventStatus {
+    ACTIVE,
+    COMPLETED,
+    SCHEDULE,
+    SKIPPED,
+    VISITED,
+    OVERDUE
+}
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValidationResult.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValidationResult.kt
@@ -1,10 +1,6 @@
 package org.hisp.dhis.rules.models
 
-import org.hisp.dhis.rules.api.RuleEngine
-import org.hisp.dhis.rules.engine.DefaultRuleEngine
-import kotlin.js.ExperimentalJsExport
 import kotlin.js.JsExport
-import kotlin.jvm.JvmOverloads
 import kotlin.jvm.JvmStatic
 
 /*
@@ -36,7 +32,6 @@ import kotlin.jvm.JvmStatic
  */
 
 @JsExport
-@OptIn(ExperimentalJsExport::class)
 data class RuleValidationResult(
         val valid: Boolean,
         val errorMessage: String? = null,

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValueType.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValueType.kt
@@ -1,5 +1,8 @@
 package org.hisp.dhis.rules.models
 
+import kotlin.js.JsExport
+
+@JsExport
 enum class RuleValueType(private val defaultValue: Any) {
     TEXT(""),
     NUMERIC(0.0),

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/TrackerObjectType.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/TrackerObjectType.kt
@@ -1,8 +1,11 @@
 package org.hisp.dhis.rules.models
 
+import kotlin.js.JsExport
+
 /**
  * This Enum specify the type of tracker object.
  */
+@JsExport
 enum class TrackerObjectType(private val type: String) {
     EVENT("event"),
     ENROLLMENT("enrollment")

diff --git a/src/commonTest/kotlin/org/hisp/dhis/rules/ConstantsValueTest.kt b/src/commonTest/kotlin/org/hisp/dhis/rules/ConstantsValueTest.kt
@@ -50,7 +50,7 @@ class ConstantsValueTest {
             programName = "test_program",
             incidentDate = LocalDate.Companion.currentDate(),
             enrollmentDate = LocalDate.Companion.currentDate(),
-            status = RuleEnrollment.Status.ACTIVE,
+            status = RuleEnrollmentStatus.ACTIVE,
             organisationUnit = "test_ou",
             organisationUnitCode = "test_ou_code",
             attributeValues = listOf(RuleAttributeValue("test_attribute", "test_value"))
@@ -76,7 +76,7 @@ class ConstantsValueTest {
             programName = "test_program",
             incidentDate = LocalDate.Companion.currentDate(),
             enrollmentDate = LocalDate.Companion.currentDate(),
-            status = RuleEnrollment.Status.ACTIVE,
+            status = RuleEnrollmentStatus.ACTIVE,
             organisationUnit = "test_ou",
             organisationUnitCode = "test_ou_code",
             attributeValues = listOf(RuleAttributeValue("test_attribute", "test_value"))
@@ -104,7 +104,7 @@ class ConstantsValueTest {
             programName = "test_program",
             incidentDate = LocalDate.Companion.currentDate(),
             enrollmentDate = LocalDate.Companion.currentDate(),
-            status = RuleEnrollment.Status.ACTIVE,
+            status = RuleEnrollmentStatus.ACTIVE,
             organisationUnit = "test_ou",
             organisationUnitCode = "test_ou_code",
             attributeValues = listOf(RuleAttributeValue("test_attribute", "test_value"))
@@ -126,7 +126,7 @@ class ConstantsValueTest {
             event = "test_event",
             programStage = "test_program_stage",
             programStageName = "",
-            status = RuleEvent.Status.ACTIVE,
+            status = RuleEventStatus.ACTIVE,
             eventDate = Clock.System.now(),
             dueDate = LocalDate.currentDate(),
             organisationUnit = "",

diff --git a/src/commonTest/kotlin/org/hisp/dhis/rules/ProgramRuleVariableTest.kt b/src/commonTest/kotlin/org/hisp/dhis/rules/ProgramRuleVariableTest.kt
@@ -224,7 +224,7 @@ class ProgramRuleVariableTest {
             PROGRAM_NAME,
             INCIDENT_DATE,
             ENROLLMENT_DATE,
-            RuleEnrollment.Status.ACTIVE,
+            RuleEnrollmentStatus.ACTIVE,
             ORGANISATION_UNIT,
             ORGANISATION_UNIT_CODE,
             listOf(RuleAttributeValue("test_attribute", "test_value"))
@@ -246,11 +246,11 @@ class ProgramRuleVariableTest {
         private val INCIDENT_DATE = LocalDate.parse(INCIDENT_DATE_STRING)
         private const val PROGRAM_STAGE = "program stage"
         private const val PROGRAM_STAGE_NAME = "program stage name"
-        private val RULE_EVENT_STATUS = RuleEvent.Status.ACTIVE
+        private val RULE_EVENT_STATUS = RuleEventStatus.ACTIVE
         private const val ORGANISATION_UNIT = "organisation unit"
         private const val ORGANISATION_UNIT_CODE = "organisation unit code"
         private const val ENROLLMENT_ID = "enrollment id"
-        private val ENROLLMENT_STATUS = RuleEnrollment.Status.ACTIVE
+        private val ENROLLMENT_STATUS = RuleEnrollmentStatus.ACTIVE
         private const val EVENT_ID = "event id"
         private const val PROGRAM_NAME = "program name"
     }

diff --git a/src/commonTest/kotlin/org/hisp/dhis/rules/RuleEngineEffectTypesTest.kt b/src/commonTest/kotlin/org/hisp/dhis/rules/RuleEngineEffectTypesTest.kt
@@ -5,18 +5,15 @@ import kotlinx.datetime.LocalDate
 import org.hisp.dhis.rules.RuleEngineTestUtils.getRuleEngineContext
 import org.hisp.dhis.rules.api.RuleEngine
 import org.hisp.dhis.rules.api.RuleEngineContext
-import org.hisp.dhis.rules.models.Rule
-import org.hisp.dhis.rules.models.RuleAction
-import org.hisp.dhis.rules.models.RuleDataValue
-import org.hisp.dhis.rules.models.RuleEvent
+import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.utils.currentDate
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 // ToDo: function tests (check that function invocations are producing expected values; check nested function invocation)
 // ToDo: various source type tests (referencing variables from different events)
 class RuleEngineEffectTypesTest {
-    private fun getTestRuleEvent(status: RuleEvent.Status): RuleEvent {
+    private fun getTestRuleEvent(status: RuleEventStatus): RuleEvent {
         return RuleEvent(
             event = "test_event",
             programStage = "test_program_stage",
@@ -39,7 +36,7 @@ class RuleEngineEffectTypesTest {
     fun simpleConditionMustResultInAssignEffect() {
         val ruleAction = RuleAction("'test_string'", "ASSIGN", mapOf(Pair("field", "test_data_element")))
         val rule = Rule("true", listOf(ruleAction))
-        val ruleEffects = RuleEngine.getInstance().evaluate(getTestRuleEvent(RuleEvent.Status.ACTIVE), null, emptyList(), RuleEngineContext(listOf(rule)))
+        val ruleEffects = RuleEngine.getInstance().evaluate(getTestRuleEvent(RuleEventStatus.ACTIVE), null, emptyList(), RuleEngineContext(listOf(rule)))
         assertEquals(1, ruleEffects.size)
         assertEquals("test_string", ruleEffects[0].data)
         assertEquals(ruleAction, ruleEffects[0].ruleAction)
@@ -49,7 +46,7 @@ class RuleEngineEffectTypesTest {
     fun simpleConditionMustResultInAssignEffectMultipleExecution() {
         val ruleAction = RuleAction("'test_string'", "ASSIGN", mapOf(Pair("field", "test_data_element")))
         val rule = Rule("true", listOf(ruleAction))
-        val ruleEffects = RuleEngine.getInstance().evaluateAll(null, listOf(getTestRuleEvent(RuleEvent.Status.ACTIVE)), getRuleEngineContext(listOf(rule)))
+        val ruleEffects = RuleEngine.getInstance().evaluateAll(null, listOf(getTestRuleEvent(RuleEventStatus.ACTIVE)), getRuleEngineContext(listOf(rule)))
         assertEquals(1, ruleEffects.size)
         assertEquals("test_string", ruleEffects[0].ruleEffects[0].data)
         assertEquals(ruleAction, ruleEffects[0].ruleEffects[0].ruleAction)
@@ -59,7 +56,7 @@ class RuleEngineEffectTypesTest {
     fun testEnvironmentVariableExpression() {
         val ruleAction = RuleAction("", "HIDEFIELD", mapOf(Pair("content", "test_action_content"), Pair("field", "test_data_element")))
         val rule = Rule("V{event_status} =='COMPLETED'", listOf(ruleAction))
-        val ruleEffects = RuleEngine.getInstance().evaluate(getTestRuleEvent(RuleEvent.Status.COMPLETED), null, emptyList(), RuleEngineContext(listOf(rule)))
+        val ruleEffects = RuleEngine.getInstance().evaluate(getTestRuleEvent(RuleEventStatus.COMPLETED), null, emptyList(), RuleEngineContext(listOf(rule)))
         assertEquals(1, ruleEffects.size)
         assertEquals("", ruleEffects[0].data)
         assertEquals(ruleAction, ruleEffects[0].ruleAction)