feat: [DHIS2-16688] replace rule engine

jest.config.js

@@ -1,5 +1,12 @@
 const config = {
     moduleDirectories: ['core_modules', 'node_modules'],
+    transform: {
+        '^.+\\.m?[t|j]sx?$': require.resolve('./node_modules/@dhis2/cli-app-scripts/config/jest.transform.js'),
+    },
+    transformIgnorePatterns: ['/node_modules/(?!@dhis2/rule-engine/)'],
+    moduleNameMapper: {
+        '@dhis2/rule-engine(.*)': '<rootDir>/node_modules/@dhis2/rule-engine/rule-engine.mjs',
+    },
 };
 
 module.exports = config;

package.json

@@ -18,6 +18,7 @@
         "@dhis2/d2-ui-org-unit-tree": "^7.3.3",
         "@dhis2/d2-ui-rich-text": "^7.4.0",
         "@dhis2/d2-ui-sharing-dialog": "^7.3.3",
+        "@dhis2/rule-engine": "^3.3.9",
         "@dhis2/ui": "^9.10.1",
         "@dhis2-ui/calendar": "^10.4.0",
         "@joakim_sm/react-infinite-calendar": "^2.4.2",
@@ -31,6 +32,7 @@
         "d2-manifest": "^1.0.0",
         "d2-utilizr": "^0.2.15",
         "date-fns": "^1.29.0",
+        "eslint-import-resolver-exports": "^1.0.0-beta.5",
         "history": "^5.3.0",
         "leaflet": "^1.7.1",
         "leaflet-draw": "^1.0.4",

packages/rules-engine/src/rulesEngine.types.js

@@ -109,7 +109,7 @@ export type DataElement = {
     name: string,
 };
 
-export type DataElements = { [elementId: string]: DataElement };
+export type DataElements = { [elementId: ?string]: DataElement };
 
 export type RuleVariable = {
     variableValue: any,
@@ -132,7 +132,7 @@ export type TrackedEntityAttribute = {
 };
 
 export type TrackedEntityAttributes = {
-    [id: string]: TrackedEntityAttribute
+    [id: ?string]: TrackedEntityAttribute
 };
 
 export type OrgUnitGroup = $ReadOnly<{|

packages/rules-engine/src/services/VariableService/variableService.types.js

@@ -51,6 +51,8 @@ export type Enrollment = {
     +enrolledAt?: string,
     +occurredAt?: string,
     +enrollmentId?: string,
+    +programName?: string,
+    +enrollmentStatus?: string,
 };
 
 export type Option = {

src/components/AppLoader/init.js

@@ -11,7 +11,7 @@ import { loadMetaData, cacheSystemSettings } from 'capture-core/metaDataStoreLoa
 import { buildMetaDataAsync, buildSystemSettingsAsync } from 'capture-core/metaDataMemoryStoreBuilders';
 import { initControllersAsync } from 'capture-core/storageControllers';
 import { DisplayException } from 'capture-core/utils/exceptions';
-import { rulesEngine } from '../../core_modules/capture-core/rules/rulesEngine';
+import { initRulesEngine } from '../../core_modules/capture-core/rules/rulesEngine';
 
 function setLogLevel() {
     const levels = {
@@ -157,15 +157,24 @@ export async function initializeAsync(
         },
     });
 
-    rulesEngine.setSelectedUserRoles(userRoles.map(({ id }) => id));
-
     const systemSettings = await onQueryApi({
         resource: 'system/info',
         params: {
             fields: 'dateFormat,serverTimeZoneId,calendar',
         },
     });
 
+    // initialize rule engine
+    let ruleEngineSettings;
+    try {
+        ruleEngineSettings = await onQueryApi({
+            resource: 'dataStore/capture/ruleEngine',
+        });
+    } catch {
+        ruleEngineSettings = { version: 'default' };
+    }
+    initRulesEngine(ruleEngineSettings.version, userRoles);
+
     // initialize storage controllers
     try {
         await initControllersAsync(onCacheExpired, currentUserId);

src/core_modules/capture-core-utils/featuresSupport/support.js

@@ -17,6 +17,7 @@ export const FEATURES = Object.freeze({
     newOrgUnitModeQueryParam: 'newOrgUnitModeQueryParam',
     moreGenericErrorMessages: 'moreGenericErrorMessages',
     sendEmptyScheduledAt: 'sendEmptyScheduledAt',
+    kotlinRuleEngine: 'kotlinRuleEngine',
 });
 
 // The first minor version that supports the feature
@@ -38,6 +39,7 @@ const MINOR_VERSION_SUPPORT = Object.freeze({
     [FEATURES.newOrgUnitModeQueryParam]: 41,
     [FEATURES.moreGenericErrorMessages]: 42,
     [FEATURES.sendEmptyScheduledAt]: 41,
+    [FEATURES.kotlinRuleEngine]: 42,
 });
 
 export const hasAPISupportForFeature = (minorVersion: string | number, featureName: string) =>

src/core_modules/capture-core/components/DataEntries/Enrollment/actions/enrollment.actionBatchs.js

@@ -5,7 +5,7 @@ import type {
     Enrollment,
     TEIValues,
     OrgUnit,
-} from '@dhis2/rules-engine-javascript';
+} from '../../../../rules/RuleEngine/types/ruleEngine.types';
 import {
     getApplicableRuleEffectsForTrackerProgram,
     updateRulesEffects,

src/core_modules/capture-core/components/Pages/common/EnrollmentOverviewDomain/useRuleEffects/useRuleEffects.js

@@ -2,7 +2,7 @@
 import { useEffect, useMemo, useState } from 'react';
 import { convertValue } from '../../../../../converters/serverToClient';
 import { getApplicableRuleEffectsForTrackerProgram } from '../../../../../rules';
-import { dataElementTypes, type TrackerProgram } from '../../../../../metaData';
+import { dataElementTypes, getTrackerProgramThrowIfNotFound, type TrackerProgram } from '../../../../../metaData';
 import type { UseRuleEffectsInput } from './useRuleEffects.types';
 
 // $FlowFixMe
@@ -48,12 +48,14 @@ const useEnrollmentData = enrollment => useMemo(() => {
         return undefined;
     }
 
-    const { enrollment: enrollmentId, enrolledAt, occurredAt } = enrollment;
+    const { enrollment: enrollmentId, enrolledAt, occurredAt, status, program } = enrollment;
 
     return {
         enrolledAt: convertDate(enrolledAt),
         occurredAt: occurredAt ? convertDate(occurredAt) : undefined,
         enrollmentId,
+        enrollmentStatus: status,
+        programName: getTrackerProgramThrowIfNotFound(program).name,
     };
 }, [enrollment]);
 

src/core_modules/capture-core/components/WidgetEventEdit/DataEntry/epics/editEventDataEntry.epics.js

@@ -9,7 +9,8 @@ import {
     batchActionTypes as editEventDataEntryBatchActionTypes,
     actionTypes as editEventDataEntryActionTypes,
 } from '../editEventDataEntry.actions';
-import { getProgramThrowIfNotFound } from '../../../../metaData';
+import { getProgramThrowIfNotFound, dataElementTypes } from '../../../../metaData';
+import { convertValue } from '../../../../converters/serverToClient';
 import {
     getCurrentClientValues,
     getCurrentClientMainData,
@@ -85,7 +86,7 @@ const runRulesForEditSingleEvent = async ({
             program,
             stage,
             orgUnit: coreOrgUnit,
-            currentEvent: { ...currentEvent, createdAt: apiCurrentEventOriginal.createdAt },
+            currentEvent: { ...currentEvent, createdAt: convertValue(apiCurrentEventOriginal.createdAt, dataElementTypes.DATETIME) },
             otherEvents: prepareEnrollmentEventsForRulesEngine(apiOtherEvents),
             enrollmentData: getEnrollmentForRulesEngine(enrollment),
             attributeValues: getAttributeValuesForRulesEngine(attributeValues, program.attributes),

src/core_modules/capture-core/components/WidgetEventEdit/helpers/getEnrollmentForRulesEngine.js

@@ -1,14 +1,28 @@
 // @flow
 import { convertServerToClient } from '../../../converters';
-import { dataElementTypes } from '../../../metaData';
+import { dataElementTypes, getTrackerProgramThrowIfNotFound } from '../../../metaData';
 import type {
     EnrollmentData,
 } from '../../Pages/common/EnrollmentOverviewDomain/useCommonEnrollmentDomainData';
 
-export const getEnrollmentForRulesEngine = ({ enrolledAt, occurredAt, enrollment }: EnrollmentData = {}): { enrollmentId: string, enrolledAt: string, occurredAt?: string } => ({
+export const getEnrollmentForRulesEngine = ({
+    enrolledAt,
+    occurredAt,
+    enrollment,
+    status,
+    program,
+}: EnrollmentData = {}): {
+    enrollmentId: string,
+    enrolledAt: string,
+    occurredAt?: string,
+    enrollmentStatus: string,
+    programName: string,
+} => ({
     enrollmentId: enrollment,
     // $FlowFixMe
     enrolledAt: convertServerToClient(enrolledAt, dataElementTypes.DATE),
     // $FlowFixMe
     occurredAt: convertServerToClient(occurredAt, dataElementTypes.DATE),
+    enrollmentStatus: status,
+    programName: getTrackerProgramThrowIfNotFound(program).name,
 });

src/core_modules/capture-core/components/WidgetProfile/DataEntry/ProgramRules/getRulesActionsForTEI.js

@@ -9,23 +9,31 @@ import type {
     ProgramRulesContainer,
     EventsData,
     DataElements,
-} from '@dhis2/rules-engine-javascript';
-import { rulesEngine } from '../../../../rules/rulesEngine';
-import type { RenderFoundation } from '../../../../metaData';
+} from '../../../../rules/RuleEngine';
+import { ruleEngine } from '../../../../rules/rulesEngine';
+import {
+    dataElementTypes,
+    type RenderFoundation,
+} from '../../../../metaData';
 import {
     updateRulesEffects,
     postProcessRulesEffects,
     buildEffectsHierarchy,
     validateAssignEffects,
 } from '../../../../rules';
+import { convertServerToClient } from '../../../../converters';
 import type { QuerySingleResource } from '../../../../utils/api';
+import type { EnrollmentData } from '../Types';
 
-const getEnrollmentForRulesExecution = enrollment =>
+const getEnrollmentForRulesExecution = (enrollment: ?EnrollmentData, programName: string): ?Enrollment =>
     enrollment && {
-        // $FlowFixMe[prop-missing]
         enrollmentId: enrollment.enrollment,
-        enrolledAt: enrollment.enrolledAt,
-        occurredAt: enrollment.occurredAt,
+        // $FlowFixMe
+        enrolledAt: convertServerToClient(enrollment.enrolledAt, dataElementTypes.DATE),
+        // $FlowFixMe
+        occurredAt: convertServerToClient(enrollment.occurredAt, dataElementTypes.DATE),
+        enrollmentStatus: enrollment.status,
+        programName,
     };
 
 const getDataElementsForRulesExecution = (dataElements: ?DataElements) =>
@@ -54,26 +62,28 @@ export const getRulesActionsForTEI = ({
     otherEvents,
     dataElements,
     userRoles,
+    programName,
 }: {
     foundation: RenderFoundation,
     formId: string,
     orgUnit: OrgUnit,
-    enrollmentData?: ?Enrollment,
+    enrollmentData?: EnrollmentData,
     teiValues?: ?TEIValues,
     trackedEntityAttributes: ?TrackedEntityAttributes,
     optionSets: OptionSets,
     rulesContainer: ProgramRulesContainer,
     otherEvents?: ?EventsData,
     dataElements: ?DataElements,
     userRoles: Array<string>,
+    programName: string,
 }) => {
-    const effects: OutputEffects = rulesEngine.getProgramRuleEffects({
+    const effects: OutputEffects = ruleEngine().getProgramRuleEffects({
         programRulesContainer: rulesContainer,
         currentEvent: null,
         otherEvents,
         dataElements: getDataElementsForRulesExecution(dataElements),
         trackedEntityAttributes,
-        selectedEnrollment: getEnrollmentForRulesExecution(enrollmentData),
+        selectedEnrollment: getEnrollmentForRulesExecution(enrollmentData, programName),
         selectedEntity: teiValues,
         selectedOrgUnit: orgUnit,
         selectedUserRoles: userRoles,
@@ -95,30 +105,33 @@ export const getRulesActionsForTEIAsync = async ({
     otherEvents,
     dataElements,
     userRoles,
+    programName,
     querySingleResource,
     onGetValidationContext,
 }: {
     foundation: RenderFoundation,
     formId: string,
     orgUnit: OrgUnit,
-    enrollmentData?: ?Enrollment,
+    enrollmentData?: EnrollmentData,
     teiValues?: ?TEIValues,
     trackedEntityAttributes: ?TrackedEntityAttributes,
     optionSets: OptionSets,
     rulesContainer: ProgramRulesContainer,
     otherEvents?: ?EventsData,
     dataElements: ?DataElements,
     userRoles: Array<string>,
+    programName: string,
     querySingleResource: QuerySingleResource,
     onGetValidationContext: () => Object,
 }) => {
-    const effects: OutputEffects = rulesEngine.getProgramRuleEffects({
+    const effects: OutputEffects = ruleEngine().getProgramRuleEffects({
         programRulesContainer: rulesContainer,
         currentEvent: null,
         otherEvents,
         dataElements: getDataElementsForRulesExecution(dataElements),
         trackedEntityAttributes,
-        selectedEnrollment: getEnrollmentForRulesExecution(enrollmentData),
+        // $FlowFixMe (flow doesn't understand that selectedEnrollment.enrolledAt/occurredAt are strings)
+        selectedEnrollment: getEnrollmentForRulesExecution(enrollmentData, programName),
         selectedEntity: teiValues,
         selectedOrgUnit: orgUnit,
         selectedUserRoles: userRoles,

src/core_modules/capture-core/components/WidgetProfile/DataEntry/ProgramRules/rulesContainer.js

@@ -23,7 +23,7 @@ const addProgramRules = (program, programRules) => {
     }));
 };
 
-const addRulesAndVariablesFromProgramIndicators = (program, programIndicators) => {
+const addRulesAndVariablesFromProgramIndicators = (rulesContainer, programIndicators, programId) => {
     const validProgramIndicators = programIndicators.filter((indicator) => {
         if (!indicator.expression) {
             log.error(
@@ -43,13 +43,13 @@ const addRulesAndVariablesFromProgramIndicators = (program, programIndicators) =
         ...programIndicator,
         programId: getProgramId(programIndicator),
     }));
-    const { rules, variables } = getRulesAndVariablesFromProgramIndicators(indicators, program.id);
+    const { rules, variables } = getRulesAndVariablesFromProgramIndicators(indicators, programId);
 
     if (variables) {
-        program.programRuleVariables = [...program.programRuleVariables, ...variables];
+        rulesContainer.programRuleVariables = [...rulesContainer.programRuleVariables, ...variables];
     }
     if (rules) {
-        program.programRules = [...program.programRules, ...rules];
+        rulesContainer.programRules = [...rulesContainer.programRules, ...rules];
     }
 };
 
@@ -70,7 +70,7 @@ export const buildRulesContainer = async ({
 
     programRuleVariables && addProgramVariables(rulesContainer, programRuleVariables);
     programRules && addProgramRules(rulesContainer, programRules);
-    programIndicators && addRulesAndVariablesFromProgramIndicators(rulesContainer, programIndicators);
+    programIndicators && addRulesAndVariablesFromProgramIndicators(rulesContainer, programIndicators, programAPI.id);
     rulesContainer.constants = constants;
 
     setRulesContainer(rulesContainer);

src/core_modules/capture-core/components/WidgetProfile/DataEntry/Types/EnrollmentData.type.js

@@ -0,0 +1,7 @@
+// @flow
+export type EnrollmentData = {
+    enrollment: string,
+    enrolledAt: string,
+    occurredAt: string,
+    status: string,
+};

src/core_modules/capture-core/components/WidgetProfile/DataEntry/Types/index.js

@@ -0,0 +1,2 @@
+// @flow
+export { EnrollmentData } from './EnrollmentData.type';

src/core_modules/capture-core/components/WidgetProfile/DataEntry/dataEntry.actions.js

@@ -1,15 +1,15 @@
 // @flow
 import { batchActions } from 'redux-batched-actions';
+import { convertGeometryOut } from 'capture-core/components/DataEntries/converters';
 import type {
     OrgUnit,
     TrackedEntityAttributes,
     OptionSets,
     ProgramRulesContainer,
     EventsData,
     DataElements,
-    Enrollment,
-} from '@dhis2/rules-engine-javascript';
-import { convertGeometryOut } from 'capture-core/components/DataEntries/converters';
+} from '../../../rules/RuleEngine';
+import type { EnrollmentData } from './Types';
 import { actionCreator } from '../../../actions/actions.utils';
 import { effectMethods } from '../../../trackerOffline';
 import type { RenderFoundation } from '../../../metaData';
@@ -54,13 +54,14 @@ const dataEntryPropsToInclude: Array<Object> = [
 
 type Context = {
     orgUnit: OrgUnit,
+    programName: string,
     trackedEntityAttributes: ?TrackedEntityAttributes,
     optionSets: OptionSets,
     rulesContainer: ProgramRulesContainer,
     formFoundation: RenderFoundation,
     otherEvents?: ?EventsData,
     dataElements: ?DataElements,
-    enrollment?: ?Enrollment,
+    enrollment?: EnrollmentData,
     userRoles: Array<string>,
     state: ReduxState,
 };
@@ -89,6 +90,7 @@ export const getUpdateFieldActions = async ({
         dataElements,
         enrollment,
         userRoles,
+        programName,
     } = context;
     const { dataEntryId, itemId, elementId, value, uiState } = innerAction.payload || {};
     const fieldData: FieldData = {
@@ -110,6 +112,7 @@ export const getUpdateFieldActions = async ({
         otherEvents,
         dataElements,
         userRoles,
+        programName,
         querySingleResource,
         onGetValidationContext,
     });