Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved: Enhanced ATP rule group execution logic to make it more efficient #39

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improved: Enhanced ATP rule group execution logic to make it more efficient #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
403ed4d
Improved: Enhanced ATP rule group logic: process all products if the …
ravilodhi Dec 13, 2024
8d293ad
Merge branch 'main' of https://github.com/hotwax/available-to-proimse…
ravilodhi Dec 16, 2024
b2b8a0b
Improved: Modified ATP rule group execution logic to better identify …
ravilodhi Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 145 additions & 5 deletions service/co/hotwax/product/ProductFacilityServices.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,138 @@
<?xml version="1.0" encoding="UTF-8"?>
<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://moqui.org/xsd/service-definition-3.xsd">

<service verb="get" noun="ProductFilterCondition" authenticate="false">
<in-parameters>
<parameter name="ruleGroupId" required="true"/>
<parameter name="productStoreId" required="true"/>
</in-parameters>
<out-parameters>
<parameter name="condition"/>
</out-parameters>
<actions>
<set field="scanAll" from="false"/>

<entity-find-one entity-name="co.hotwax.rule.RuleGroup" value-field="ruleGroup">
<field-map field-name="ruleGroupId" from="ruleGroupId"/>
<field-map field-name="productStoreId" from="productStoreId"/>
</entity-find-one>
<if condition="!ruleGroup">
<return error="true" message="No rule group found."/>
</if>

<!--Fetching last successful job run for the rule group-->
<entity-find entity-name="co.hotwax.rule.RuleGroupRun" list="ruleGroupRuns">
<econditions>
<econdition field-name="ruleGroupId" from="ruleGroupId"/>
<econdition field-name="productStoreId" from="productStoreId"/>
<econdition field-name="hasError" value="N"/>
<econdition field-name="endDate" operator="is-not-null"/>
</econditions>
<order-by field-name="-startDate"/>
</entity-find>
<set field="lastRuleGroupRun" from="ruleGroupRuns ? ruleGroupRuns[0] : null"/>

<if condition="!lastRuleGroupRun || !lastRuleGroupRun.startDate">
<then>
<!--If the rule group has never run then scan all the products -->
<set field="scanAll" from="true"/>
</then>
<else-if condition="!ruleGroup.lastModifiedDate || ruleGroup.lastModifiedDate &gt; lastRuleGroupRun.startDate">
<!--If the rule group is modified after last successful run then scan all the products -->
<set field="scanAll" from="true"/>
</else-if>
<else>
<!--Even if the rule group is not modified after the last successful run check for the internal data modifications as well, e.g. new config facilities are added, or new facility group members are added.-->
<!--For threshold rule groups -->
<if condition="ruleGroup.groupTypeEnumId == 'RG_THRESHOLD'">
<then>
<!--Check if any rule is setup for setting threshold on all the config facilities of a given product store-->
<if condition="ec.entity.find('co.hotwax.common.DecisionRuleAndCondition').condition('ruleGroupId', ruleGroupId).condition('conditionTypeEnumId', 'ENTCT_ATP_FACILITIES').condition('fieldValue', 'ALL').count()">
<entity-find entity-name="co.hotwax.product.store.ProductStoreFacilityDetail" list="configFacilities">
<econditions>
<econdition field-name="productStoreId" from="productStoreId"/>
<econdition field-name="facilityTypeId" value="CONFIGURATION"/>
<date-filter/>
</econditions>
<order-by field-name="-fromDate"/>
</entity-find>
<set field="recentConfigFacility" from="configFacilities ? configFacilities[0] : null"/>

<!--Check the most recent config facility, if it is added after the last run then scan all the products-->
<if condition="recentConfigFacility &amp;&amp; recentConfigFacility.fromDate &gt; lastRuleGroupRun.startDate">
<set field="scanAll" from="true"/>
</if>
</if>
</then>
<else>
<!--For safety stock, store pickup and shipping rule groups -->
<!--Check if any rule is setup for all the facility groups, which means all the physical facilities of a given product store-->
<if condition="ec.entity.find('co.hotwax.common.DecisionRuleAndCondition').condition('ruleGroupId', ruleGroupId).condition('conditionTypeEnumId', 'ENTCT_ATP_FAC_GROUPS').condition('fieldValue', 'ALL').count()">
<!--Fetch the most recently added facility-->
<entity-find entity-name="co.hotwax.product.store.ProductStoreFacilityDetail" list="facilities">
<econditions>
<econdition field-name="productStoreId" from="productStoreId"/>
<econdition field-name="facilityTypeId" operator="not-equals" value="VIRTUAL_FACILITY"/>
<econdition field-name="parentFacilityTypeId" operator="not-equals" value="VIRTUAL_FACILITY"/>
<date-filter/>
</econditions>
<order-by field-name="-fromDate"/>
</entity-find>
<set field="recentFacility" from="facilities ? facilities[0] : null"/>

<!--Check the most recently added facility, if it is added after the last run then scan all the products-->
<if condition="recentFacility &amp;&amp; recentFacility.fromDate &gt; lastRuleGroupRun.startDate">
<set field="scanAll" from="true"/>
</if>
<else>
<!-- Check if rules are setup for facility group(s)-->
<entity-find entity-name="co.hotwax.common.DecisionRuleAndCondition" list="facilityGroupConditions">
<econditions>
<econdition field-name="ruleGroupId" from="ruleGroupId"/>
<econdition field-name="conditionTypeEnumId" value="ENTCT_ATP_FAC_GROUPS"/>
</econditions>
</entity-find>
<if condition="facilityGroupConditions">
<set field="facilityGroupIds" from="[]"/>
<iterate list="facilityGroupConditions" entry="facilityGroupCondition">
<script>facilityGroupIds.addAll(co.hotwax.common.DecisionRuleHelper.valueToCollection(facilityGroupCondition.fieldValue))</script>
</iterate>
<!--Fetch the recent facility added in the facility group(s)-->
<entity-find entity-name="org.apache.ofbiz.product.facility.FacilityGroupMember" list="facilityGroupMembers">
<econditions>
<econdition field-name="facilityGroupId" operator="in" from="facilityGroupIds"/>
</econditions>
<date-filter/>
<order-by field-name="-fromDate"/>
</entity-find>
<set field="recentGroupMember" from="facilityGroupMembers ? facilityGroupMembers[0] : null"/>

<!--Check the most recently added facility, if it is added after the last run then scan all the products-->
<if condition="recentGroupMember &amp;&amp; recentGroupMember.fromDate &gt; lastRuleGroupRun.startDate">
<set field="scanAll" from="true"/>
</if>
</if>
</else>
</if>
</else>
</if>
</else>
</if>

<if condition="!scanAll">
<set field="lastRunStartDateTimeString"
from="java.time.ZonedDateTime.ofInstant(lastRuleGroupRun.startDate.toInstant(), java.time.ZoneId.of('UTC')).format(java.time.format.DateTimeFormatter.ISO_INSTANT)"/>
<set field="condition" value="updatedDatetime:[${lastRunStartDateTimeString} TO *]"/>
</if>
</actions>
</service>
<service verb="run" noun="ExportProductFacilityDetail" authenticate="false" transaction-timeout="7200">
<description>Executes product facility rules.</description>
<in-parameters>
<parameter name="ruleGroupId" type="String" required="true"/>
<parameter name="productStoreId" type="String" required="true"/>
<parameter name="systemMessageRemoteId" type="String" required="true"/>
<parameter name="scanAllProducts" default-value="N"/>
</in-parameters>
<actions>
<entity-find-one entity-name="co.hotwax.rule.RuleGroup" value-field="ruleGroup">
Expand All @@ -31,6 +157,7 @@
import org.kie.api.io.ResourceType;
import org.kie.api.KieBase;
import org.kie.api.KieServices
import co.hotwax.common.CommerceUtil

kieServices = KieServices.Factory.get();
kieHelper = new KieHelper();
Expand All @@ -44,11 +171,22 @@
<set field="viewSize" value="100" type="Integer"/>
<set field="viewIndex" value="0" type="Integer"/>
<set field="fieldsToSelect" value="productId,tags,productFeatures"/>
<set field="serviceContext" from="[viewIndex: viewIndex, viewSize: viewSize, fieldsToSelect: fieldsToSelect]"/>

<if condition="scanAllProducts != 'Y'">
<service-call name="co.hotwax.product.ProductFacilityServices.get#ProductFilterCondition"
in-map="context"
out-map="result"/>
<if condition="result.condition">
<set field="serviceContext.filter" from="result.condition"/>
</if>
</if>

<service-call name="co.hotwax.product.ProductFacilityServices.get#Products"
in-map="[viewIndex: viewIndex, viewSize: viewSize, fieldsToSelect: fieldsToSelect]"
in-map="serviceContext"
out-map="productResult"/>
<if condition="!productResult.productDetail">
<return error="true" message="No products found."/>
<if condition="!productResult.productDetail || productResult.productDetail.totalCount === 0">
<return message="No products found."/>
</if>
<set field="products" from="productResult.productDetail.products"/>
<set field="totalProducts" from="productResult.productDetail.totalCount"/>
Expand All @@ -70,15 +208,15 @@
<set field="csvFilePath" from="result.csvFilePath"/>
<set field="productFacilityDetail" from="[:]"/>
</if>
<if condition="totalProducts &gt; viewSize">
<script>
import co.hotwax.common.CommerceUtil
paginationValues = CommerceUtil.getPaginationValues(viewSize, 0, totalProducts)
viewIndexLast = paginationValues.viewIndexLast
viewIndexList = (1..viewIndexLast).toList()
</script>
<iterate list="viewIndexList" entry="viewIndex">
<service-call name="co.hotwax.product.ProductFacilityServices.get#Products"
in-map="[viewIndex: viewIndex*viewSize, viewSize: viewSize, fieldsToSelect: fieldsToSelect]"
in-map="serviceContext + [viewIndex: viewIndex*viewSize]"
out-map="productResult"/>
<if condition="productResult.productDetail">
<set field="products" from="productResult.productDetail.products"/>
Expand All @@ -98,6 +236,8 @@
</if>
</if>
</iterate>
</if>

<script>
kieSession.dispose();
</script>
Expand Down
6 changes: 5 additions & 1 deletion service/co/hotwax/rule/DecisionRuleServices.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
<parameter name="ruleGroupId" required="true"/>
<parameter name="productStoreId" required="true"/>
<parameter name="systemMessageRemoteId" required="true"/>
<parameter name="scanAllProducts"/>

<!--
In order to leverage the Service semaphore capabilities provided by the framework, we have chosen to include ruleGroupId as an input parameter.
While ruleGroupId already exists in the RuleGroup entity,
Expand Down Expand Up @@ -89,7 +91,7 @@
out-map="ruleGroupResult"/>

<service-call name="co.hotwax.product.ProductFacilityServices.run#ExportProductFacilityDetail"
in-map="[ruleGroupId:ruleGroupId, productStoreId: productStoreId, systemMessageRemoteId: systemMessageRemoteId]"
in-map="[ruleGroupId:ruleGroupId, productStoreId: productStoreId, systemMessageRemoteId: systemMessageRemoteId, scanAllProducts: scanAllProducts]"
out-map="result"/>
<script>
def ruleGroupRunResult = null
Expand Down Expand Up @@ -158,6 +160,7 @@
<in-parameters>
<parameter name="ruleGroupId" required="true"/>
<parameter name="systemMessageRemoteId" required="true"/>
<parameter name="scanAllProducts"/>
<auto-parameters entity-name="moqui.service.job.ServiceJob" include="nonpk">
<exclude field-name="description"/>
<exclude field-name="serviceName"/>
Expand Down Expand Up @@ -210,6 +213,7 @@
<service-call name="create#moqui.service.job.ServiceJobParameter" in-map="[jobName: jobName, parameterName: 'ruleGroupId', parameterValue: ruleGroupId]"/>
<service-call name="create#moqui.service.job.ServiceJobParameter" in-map="[jobName: jobName, parameterName: 'productStoreId', parameterValue: ruleGroup.productStoreId]"/>
<service-call name="create#moqui.service.job.ServiceJobParameter" in-map="[jobName: jobName, parameterName: 'systemMessageRemoteId', parameterValue: systemMessageRemoteId]"/>
<service-call name="create#moqui.service.job.ServiceJobParameter" in-map="[jobName: jobName, parameterName: 'scanAllProducts', parameterValue: scanAllProducts]"/>
<return message="Rule group schedule has been created successfully."/>
<else>
<service-call name="update#moqui.service.job.ServiceJob" in-map="context + [jobName: serviceJob.jobName]" out-map="context"/>
Expand Down