FIN-349 fix issue in the importing of budget information.

Author: gjong

bpmn-process/src/main/java/com/jongsoft/finance/bpmn/delegate/budget/ProcessBudgetCreateDelegate.java

@@ -1,9 +1,14 @@
 package com.jongsoft.finance.bpmn.delegate.budget;
 
 import com.jongsoft.finance.ProcessMapper;
+import com.jongsoft.finance.domain.user.Budget;
+import com.jongsoft.finance.messaging.EventBus;
+import com.jongsoft.finance.messaging.commands.budget.CloseBudgetCommand;
+import com.jongsoft.finance.messaging.commands.budget.CreateBudgetCommand;
 import com.jongsoft.finance.providers.BudgetProvider;
 import com.jongsoft.finance.security.CurrentUserProvider;
 import com.jongsoft.finance.serialized.BudgetJson;
+import com.jongsoft.lang.Control;
 import jakarta.inject.Singleton;
 import lombok.extern.slf4j.Slf4j;
 import org.camunda.bpm.engine.delegate.DelegateExecution;
@@ -14,7 +19,7 @@
  * This delegate will create process a serialize {@link BudgetJson} into a new budget period in the system. It will
  * either create the first budget or close the existing and create a new one.
  * <p>
- *      This delegate expects the following variables to be present:
+ * This delegate expects the following variables to be present:
  * </p>
  * <ul>
  *     <li>budget, a JSON serialized {@link BudgetJson} to be created in the system</li>
@@ -39,7 +44,6 @@ public class ProcessBudgetCreateDelegate implements JavaDelegate {
 
     @Override
     public void execute(DelegateExecution execution) {
-        var userAccount = currentUserProvider.currentUser();
         var budgetJson = mapper.readSafe(
                 execution.<StringValue>getVariableLocalTyped("budget").getValue(),
                 BudgetJson.class);
@@ -48,16 +52,50 @@ public void execute(DelegateExecution execution) {
                 execution.getCurrentActivityName(),
                 budgetJson.getStart());
 
+        var start = budgetJson.getStart().withDayOfMonth(1);
         var year = budgetJson.getStart().getYear();
         var month = budgetJson.getStart().getMonthValue();
 
+        // create or update the budget period
+        var oldBudget = budgetProvider.lookup(year, month);
+        if (oldBudget.isPresent()) {
+            log.debug("{}: Budget period already exists for period '{}' with start '{}'",
+                    execution.getCurrentActivityName(),
+                    start,
+                    oldBudget.get().getStart());
+            // close the existing budget
+            EventBus.getBus()
+                    .send(new CloseBudgetCommand(oldBudget.get().getId(), start));
+            // create new budget
+            EventBus.getBus()
+                    .send(new CreateBudgetCommand(Budget.builder()
+                            .start(start)
+                            .expectedIncome(budgetJson.getExpectedIncome())
+                            .expenses(oldBudget.get().getExpenses())
+                            .build()));
+        } else {
+            log.debug("{}: Creating new budget period for period '{}'",
+                    execution.getCurrentActivityName(),
+                    start);
+            EventBus.getBus().send(new CreateBudgetCommand(
+                    Budget.builder()
+                            .start(start)
+                            .expectedIncome(budgetJson.getExpectedIncome())
+                            .build()));
+        }
+
+        log.trace("{}: Budget period updated for period '{}'",
+                execution.getCurrentActivityName(),
+                budgetJson.getStart());
+
         var budget = budgetProvider.lookup(year, month)
-                .map(b -> b.indexBudget(budgetJson.getStart(), budgetJson.getExpectedIncome()))
-                .getOrSupply(() -> userAccount.createBudget(budgetJson.getStart(), budgetJson.getExpectedIncome()));
+                .getOrThrow(() -> new IllegalStateException("Budget period not found for period " + start));
 
-        budgetJson.getExpenses().stream()
-                .filter(e -> budget.determineExpense(e.getName()) == null)
-                .forEach(e -> budget.createExpense(e.getName(), e.getLowerBound(), e.getUpperBound()));
+        budgetJson.getExpenses()
+                // update or create the expenses
+                .forEach(e -> Control.Option(budget.determineExpense(e.getName()))
+                        .ifPresent(currentExpense -> currentExpense.updateExpense(e.getUpperBound()))
+                        .elseRun(() -> budget.createExpense(e.getName(), e.getLowerBound(), e.getUpperBound())));
     }
 
 }

bpmn-process/src/main/java/com/jongsoft/finance/bpmn/delegate/user/ParseUserConfigurationDelegate.java

@@ -2,6 +2,7 @@
 
 import com.jongsoft.finance.ProcessMapper;
 import com.jongsoft.finance.StorageService;
+import com.jongsoft.finance.serialized.BudgetJson;
 import com.jongsoft.finance.serialized.ExportJson;
 import com.jongsoft.finance.serialized.RuleConfigJson;
 import com.jongsoft.lang.Control;
@@ -11,6 +12,7 @@
 import org.camunda.bpm.engine.delegate.JavaDelegate;
 
 import java.nio.charset.StandardCharsets;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
 import java.util.stream.Collectors;
@@ -51,8 +53,12 @@ public void execute(DelegateExecution execution) throws Exception {
             execution.setVariableLocal("ruleStorageToken", null);
         }
 
+        var sortedBudgets = profileJson.getBudgetPeriods().stream()
+                .sorted(Comparator.comparing(BudgetJson::getStart))
+                .toList();
+
         execution.setVariableLocal("accounts", serialize(profileJson.getAccounts()));
-        execution.setVariableLocal("budgetPeriods", serialize(profileJson.getBudgetPeriods()));
+        execution.setVariableLocal("budgetPeriods", serialize(sortedBudgets));
         execution.setVariableLocal("contracts", serialize(profileJson.getContracts()));
         execution.setVariableLocal("categories", serialize(profileJson.getCategories()));
         execution.setVariableLocal("tags", Control.Option(profileJson.getTags()).getOrSupply(List::of));

bpmn-process/src/test/java/com/jongsoft/finance/bpmn/ProfileImportIT.java

@@ -132,4 +132,15 @@ void runWithContracts(RuntimeContext context) {
                 LocalDate.of(2018, 12, 31));
     }
 
+//    @Test
+//    @DisplayName("Import a profile with budgets")
+//    void runWithBudgets(RuntimeContext context) {
+//        context
+//            .withStorage()
+//            .withStorage("my-sample-token", "/profile-test/budget-only.json");
+//
+//        context.execute("ImportUserProfile", Map.of(
+//                "storageToken", "my-sample-token"))
+//                .verifyCompleted();
+//    }
 }

bpmn-process/src/test/resources/profile-test/budget-only.json

@@ -0,0 +1,151 @@
+{
+  "budgetPeriods": [
+    {
+      "start": "2011-12-31",
+      "end": "2012-12-31",
+      "expectedIncome": 2500.0,
+      "expenses": [
+        {
+          "name": "Sparen",
+          "lowerBound": 50.0,
+          "upperBound": 150.0
+        },
+        {
+          "name": "Vervoer",
+          "lowerBound": 300.0,
+          "upperBound": 500.0
+        },
+        {
+          "name": "Abonnementen",
+          "lowerBound": 100.0,
+          "upperBound": 200.0
+        },
+        {
+          "name": "Huishoudelijke kosten",
+          "lowerBound": 700.0,
+          "upperBound": 800.0
+        },
+        {
+          "name": "Boodschappen",
+          "lowerBound": 250.0,
+          "upperBound": 350.0
+        }
+      ]
+    },
+    {
+      "start": "2012-12-31",
+      "end": "2016-05-31",
+      "expectedIncome": 3000.0,
+      "expenses": [
+        {
+          "name": "Vervoer",
+          "lowerBound": 360.0,
+          "upperBound": 600.0
+        },
+        {
+          "name": "Boodschappen",
+          "lowerBound": 300.0,
+          "upperBound": 420.0
+        },
+        {
+          "name": "Abonnementen",
+          "lowerBound": 120.0,
+          "upperBound": 240.0
+        },
+        {
+          "name": "Sparen",
+          "lowerBound": 60.0,
+          "upperBound": 180.0
+        },
+        {
+          "name": "Huishoudelijke kosten",
+          "lowerBound": 840.0,
+          "upperBound": 1440.0
+        }
+      ]
+    },
+    {
+      "start": "2016-05-31",
+      "end": "2018-07-31",
+      "expectedIncome": 3100.0,
+      "expenses": [
+        {
+          "name": "Huishoudelijke kosten",
+          "lowerBound": 868.0,
+          "upperBound": 1488.0
+        },
+        {
+          "name": "Vervoer",
+          "lowerBound": 372.0,
+          "upperBound": 620.0
+        },
+        {
+          "name": "Abonnementen",
+          "lowerBound": 124.0,
+          "upperBound": 248.0
+        },
+        {
+          "name": "Boodschappen",
+          "lowerBound": 310.0,
+          "upperBound": 434.0
+        },
+        {
+          "name": "Sparen",
+          "lowerBound": 62.0,
+          "upperBound": 186.0
+        }
+      ]
+    },
+    {
+      "start": "2018-07-31",
+      "expectedIncome": 3600.0,
+      "expenses": [
+        {
+          "name": "Vervoer",
+          "lowerBound": 432.0,
+          "upperBound": 720.0
+        },
+        {
+          "name": "Gezondheid & persoonlijke verzorging",
+          "lowerBound": 99.99,
+          "upperBound": 100.0
+        },
+        {
+          "name": "Restaurants & Bars",
+          "lowerBound": 199.99,
+          "upperBound": 200.0
+        },
+        {
+          "name": "Sparen",
+          "lowerBound": 72.0,
+          "upperBound": 216.0
+        },
+        {
+          "name": "Abonnementen",
+          "lowerBound": 144.0,
+          "upperBound": 288.0
+        },
+        {
+          "name": "Winkelen",
+          "lowerBound": 399.99,
+          "upperBound": 400.0
+        },
+        {
+          "name": "Vrije tijd",
+          "lowerBound": 149.99,
+          "upperBound": 150.0
+        },
+        {
+          "name": "Boodschappen",
+          "lowerBound": 360.0,
+          "upperBound": 504.0
+        },
+        {
+          "name": "Huishoudelijke kosten",
+          "lowerBound": 1008.0,
+          "upperBound": 1200.0
+        }
+      ]
+    }
+  ]
+}

domain/src/main/java/com/jongsoft/finance/domain/user/Budget.java

@@ -7,6 +7,7 @@
 import com.jongsoft.finance.messaging.commands.budget.CloseBudgetCommand;
 import com.jongsoft.finance.messaging.commands.budget.CreateBudgetCommand;
 import com.jongsoft.finance.messaging.commands.budget.CreateExpenseCommand;
+import com.jongsoft.finance.messaging.commands.budget.UpdateExpenseCommand;
 import com.jongsoft.lang.Collections;
 import com.jongsoft.lang.collection.Sequence;
 import lombok.AllArgsConstructor;
@@ -59,6 +60,17 @@ Expense indexExpense(BigDecimal deviation) {
                     .build();
         }
 
+        @BusinessMethod
+        public void updateExpense(double expectedExpense) {
+            lowerBound = expectedExpense - .01;
+            upperBound = expectedExpense;
+
+            EventBus.getBus()
+                    .send(new UpdateExpenseCommand(
+                            id,
+                            BigDecimal.valueOf(expectedExpense)));
+        }
+
         public double computeBudget() {
             return BigDecimal.valueOf(lowerBound)
                     .add(BigDecimal.valueOf(upperBound))

domain/src/main/java/com/jongsoft/finance/messaging/commands/budget/UpdateExpenseCommand.java

@@ -0,0 +1,9 @@
+package com.jongsoft.finance.messaging.commands.budget;
+
+import com.jongsoft.finance.core.ApplicationEvent;
+
+import java.math.BigDecimal;
+
+public record UpdateExpenseCommand(long id, BigDecimal amount)
+        implements ApplicationEvent {
+}

jpa-repository/src/main/java/com/jongsoft/finance/jpa/budget/BudgetProviderJpa.java

@@ -47,7 +47,7 @@ public Optional<Budget> lookup(int year, int month) {
                 select b from BudgetJpa b
                 where b.user.username = :username
                     and b.from <= :start
-                    and (b.until is null or b.until >= :end)""";
+                    and (b.until is null or b.until > :end)""";
 
         return reactiveEntityManager.<BudgetJpa>blocking()
                 .hql(hql)

jpa-repository/src/main/java/com/jongsoft/finance/jpa/budget/CreateBudgetHandler.java

@@ -53,6 +53,7 @@ public void handle(CreateBudgetCommand command) {
     }
 
     private Collection<ExpensePeriodJpa> createExpenses(BudgetJpa budget, Sequence<Budget.Expense> expenses) {
+        log.debug("Creating {} expenses for budget period {}", expenses.size(), budget.getFrom());
         return expenses.map(expense ->
                         ExpensePeriodJpa.builder()
                                 .budget(budget)

jpa-repository/src/main/java/com/jongsoft/finance/jpa/budget/ExpenseJpa.java

@@ -1,13 +1,11 @@
 package com.jongsoft.finance.jpa.budget;
 
+import com.jongsoft.finance.jpa.core.entity.EntityJpa;
+import com.jongsoft.finance.jpa.user.entity.UserAccountJpa;
 import jakarta.persistence.Entity;
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.ManyToOne;
 import jakarta.persistence.Table;
-
-import com.jongsoft.finance.jpa.core.entity.EntityJpa;
-
-import com.jongsoft.finance.jpa.user.entity.UserAccountJpa;
 import lombok.Builder;
 import lombok.Getter;
 

jpa-repository/src/main/java/com/jongsoft/finance/jpa/budget/ExpensePeriodJpa.java

@@ -10,10 +10,12 @@
 
 import lombok.Builder;
 import lombok.Getter;
+import lombok.Setter;
 
 import java.math.BigDecimal;
 
 @Getter
+@Setter
 @Entity
 @Table(name = "budget_period")
 public class ExpensePeriodJpa extends EntityJpa {