refactor: Clean up description call to rule engine (#117)

* refactor: Clean up description call to rule engine * refactor: Clean up evaluation call to rule engine * refactor: Clean up evaluation call to rule engine * refactor: EventDate changed from LocalDate to Instant * Refactor package structure * Refactor package structure * Fix RuleAction interface * Fix RuleAction interface * Fix RuleEngine API interface * Make engine package internal * Make rule engine getInstance static for Java * Update build.gradle.kts
dhis2 · Jan 17, 2024 · 23dd168 · 23dd168
1 parent dbc11b0
commit 23dd168
Show file tree

Hide file tree

Showing 72 changed files with 1,297 additions and 2,255 deletions.
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngine.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngine.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineContext.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineContext.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineExecution.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineExecution.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineFilter.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineFilter.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineIntent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineIntent.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineMultipleExecution.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleEngineMultipleExecution.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/RuleExpressionEvaluator.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/RuleExpressionEvaluator.kt
diff --git a/...in/kotlin/org/hisp/dhis/rules/DataItem.kt → ...otlin/org/hisp/dhis/rules/api/DataItem.kt b/...in/kotlin/org/hisp/dhis/rules/DataItem.kt → ...otlin/org/hisp/dhis/rules/api/DataItem.kt
@@ -1,4 +1,4 @@
-package org.hisp.dhis.rules
+package org.hisp.dhis.rules.api
 
 /**
  * Class is place holder for program rule variable, Constant and program environment variable display name and type.

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/api/EnvironmentVariables.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/api/EnvironmentVariables.kt
@@ -0,0 +1,27 @@
+package org.hisp.dhis.rules.api
+
+import org.hisp.dhis.rules.utils.RuleEngineUtils
+
+object EnvironmentVariables {
+    val ENV_VARIABLES = mapOf(
+        Pair(RuleEngineUtils.ENV_VAR_COMPLETED_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_CURRENT_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_EVENT_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_INCIDENT_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_ENROLLMENT_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_DUE_DATE, ItemValueType.DATE),
+        Pair(RuleEngineUtils.ENV_VAR_EVENT_COUNT, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_TEI_COUNT, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_ENROLLMENT_COUNT, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_EVENT_ID, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_PROGRAM_STAGE_ID, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_ENROLLMENT_ID, ItemValueType.NUMBER),
+        Pair(RuleEngineUtils.ENV_VAR_ENROLLMENT_STATUS, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_EVENT_STATUS, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_OU, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_OU_CODE, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_ENVIRONMENT, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_PROGRAM_NAME, ItemValueType.TEXT),
+        Pair(RuleEngineUtils.ENV_VAR_PROGRAM_STAGE_NAME, ItemValueType.TEXT)
+    )
+}
diff --git a/...tlin/org/hisp/dhis/rules/ItemValueType.kt → .../org/hisp/dhis/rules/api/ItemValueType.kt b/...tlin/org/hisp/dhis/rules/ItemValueType.kt → .../org/hisp/dhis/rules/api/ItemValueType.kt
@@ -1,4 +1,4 @@
-package org.hisp.dhis.rules
+package org.hisp.dhis.rules.api
 
 import org.hisp.dhis.lib.expression.spi.ValueType
 

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngine.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngine.kt
@@ -0,0 +1,20 @@
+package org.hisp.dhis.rules.api
+
+import org.hisp.dhis.rules.engine.DefaultRuleEngine
+import org.hisp.dhis.rules.models.*
+import kotlin.jvm.JvmStatic
+
+interface RuleEngine {
+    fun validate(expression: String, dataItemStore: Map<String, DataItem>): RuleValidationResult
+    fun validateDataFieldExpression(expression: String, dataItemStore: Map<String, DataItem>): RuleValidationResult
+    fun evaluateAll(enrollmentTarget: RuleEnrollment?, eventsTarget: List<RuleEvent>, executionContext: RuleEngineContext): List<RuleEffects>
+    fun evaluate(target: RuleEnrollment, ruleEvents: List<RuleEvent>, executionContext: RuleEngineContext): List<RuleEffect>
+    fun evaluate(target: RuleEvent, ruleEnrollment: RuleEnrollment?, ruleEvents: List<RuleEvent>, executionContext: RuleEngineContext): List<RuleEffect>
+
+    companion object {
+        @JvmStatic
+        fun getInstance(): RuleEngine {
+            return DefaultRuleEngine()
+        }
+    }
+}
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngineContext.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngineContext.kt
@@ -0,0 +1,13 @@
+package org.hisp.dhis.rules.api
+
+import org.hisp.dhis.rules.models.Rule
+import org.hisp.dhis.rules.models.RuleEnrollment
+import org.hisp.dhis.rules.models.RuleEvent
+import org.hisp.dhis.rules.models.RuleVariable
+
+data class RuleEngineContext(
+    val rules: List<Rule>,
+    val ruleVariables: List<RuleVariable> = emptyList(),
+    val supplementaryData: Map<String, List<String>> = emptyMap(),
+    val constantsValues: Map<String, String> = emptyMap()
+)