From 04fe5d1fc44593bd6a549631f1423631911e0b96 Mon Sep 17 00:00:00 2001 From: James Cole Date: Sun, 12 May 2024 18:24:38 +0200 Subject: [PATCH] Correct account balances better. --- .../Correction/CorrectAccountBalance.php | 10 ++- .../Observer/TransactionJournalObserver.php | 2 + app/Handlers/Observer/TransactionObserver.php | 13 +++- .../Models/AccountBalanceCalculator.php | 71 +++++++++++++------ ...12_060551_create_account_balance_table.php | 3 +- 5 files changed, 75 insertions(+), 24 deletions(-) diff --git a/app/Console/Commands/Correction/CorrectAccountBalance.php b/app/Console/Commands/Correction/CorrectAccountBalance.php index b4f25c9fd0..483e6c3b94 100644 --- a/app/Console/Commands/Correction/CorrectAccountBalance.php +++ b/app/Console/Commands/Correction/CorrectAccountBalance.php @@ -6,8 +6,10 @@ use DB; use FireflyIII\Console\Commands\ShowsFriendlyMessages; use FireflyIII\Models\AccountBalance; use FireflyIII\Models\Transaction; +use FireflyIII\Models\TransactionJournal; use FireflyIII\Support\Models\AccountBalanceCalculator; use Illuminate\Console\Command; +use Illuminate\Support\Facades\Log; use stdClass; /** @@ -33,6 +35,12 @@ class CorrectAccountBalance extends Command private function correctBalanceAmounts(): void { - AccountBalanceCalculator::recalculate(null); + AccountBalanceCalculator::recalculate(null, null); + foreach(TransactionJournal::all() as $journal) { + Log::debug(sprintf('Recalculating account balances for journal #%d', $journal->id)); + foreach($journal->transactions as $transaction) { + AccountBalanceCalculator::recalculate($transaction->account, $journal); + } + } } } diff --git a/app/Handlers/Observer/TransactionJournalObserver.php b/app/Handlers/Observer/TransactionJournalObserver.php index 3bb106783e..24bf335dac 100644 --- a/app/Handlers/Observer/TransactionJournalObserver.php +++ b/app/Handlers/Observer/TransactionJournalObserver.php @@ -24,6 +24,7 @@ declare(strict_types=1); namespace FireflyIII\Handlers\Observer; use FireflyIII\Models\TransactionJournal; +use Illuminate\Support\Facades\Log; /** * Class TransactionJournalObserver @@ -48,4 +49,5 @@ class TransactionJournalObserver $transactionJournal->destJournalLinks()->delete(); $transactionJournal->auditLogEntries()->delete(); } + } diff --git a/app/Handlers/Observer/TransactionObserver.php b/app/Handlers/Observer/TransactionObserver.php index 2462331ae9..029cbb01e4 100644 --- a/app/Handlers/Observer/TransactionObserver.php +++ b/app/Handlers/Observer/TransactionObserver.php @@ -43,6 +43,17 @@ class TransactionObserver public function updated(Transaction $transaction): void { app('log')->debug('Observe "updated" of a transaction.'); - AccountBalanceCalculator::recalculate($transaction->account); + AccountBalanceCalculator::recalculate($transaction->account, null); + if((float)$transaction->amount > 0) { + AccountBalanceCalculator::recalculateByJournal($transaction->transactionJournal); + } + } + public function created(Transaction $transaction): void + { + app('log')->debug('Observe "created" of a transaction.'); + AccountBalanceCalculator::recalculate($transaction->account, null); + if((float)$transaction->amount > 0) { + AccountBalanceCalculator::recalculateByJournal($transaction->transactionJournal); + } } } diff --git a/app/Support/Models/AccountBalanceCalculator.php b/app/Support/Models/AccountBalanceCalculator.php index ccd5c62dfb..97585bc288 100644 --- a/app/Support/Models/AccountBalanceCalculator.php +++ b/app/Support/Models/AccountBalanceCalculator.php @@ -27,26 +27,32 @@ use DB; use FireflyIII\Models\Account; use FireflyIII\Models\AccountBalance; use FireflyIII\Models\Transaction; +use FireflyIII\Models\TransactionJournal; use Illuminate\Support\Facades\Log; use stdClass; class AccountBalanceCalculator { - public static function recalculate(?Account $account): void + public static function recalculate(?Account $account, ?TransactionJournal $transactionJournal): void { // first collect normal amounts (in whatever currency), and set them. // select account_id, transaction_currency_id, foreign_currency_id, sum(amount), sum(foreign_amount) from transactions group by account_id, transaction_currency_id, foreign_currency_id - $query = Transaction::groupBy(['account_id', 'transaction_currency_id', 'foreign_currency_id']); - + $query = Transaction::groupBy(['transactions.account_id', 'transactions.transaction_currency_id', 'transactions.foreign_currency_id']); + $title = 'balance'; if (null !== $account) { - $query->where('account_id', $account->id); + $query->where('transactions.account_id', $account->id); + } + if (null !== $transactionJournal) { + $query->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id'); + $query->where('transaction_journals.date', '<=', $transactionJournal->date); + $title = 'balance_after_journal'; } - $result = $query->get(['account_id', 'transaction_currency_id', 'foreign_currency_id', DB::raw('SUM(amount) as sum_amount'), DB::raw('SUM(foreign_amount) as sum_foreign_amount')]); + $result = $query->get(['transactions.account_id', 'transactions.transaction_currency_id', 'transactions.foreign_currency_id', DB::raw('SUM(transactions.amount) as sum_amount'), DB::raw('SUM(transactions.foreign_amount) as sum_foreign_amount')]); // reset account balances: - self::resetAccountBalances($account); + self::resetAccountBalances($title, $account, $transactionJournal); /** @var stdClass $row */ foreach ($result as $row) { @@ -57,48 +63,73 @@ class AccountBalanceCalculator $sumForeignAmount = $row->sum_foreign_amount; // first create for normal currency: - $entry = self::getBalance('balance', $account, $transactionCurrency); - $entry->balance = bcadd($entry->balance, $sumAmount); + $entry = self::getBalance($title, $account, $transactionCurrency, $transactionJournal?->id); + $entry->balance = bcadd($entry->balance, $sumAmount); + $entry->transaction_journal_id = $transactionJournal?->id; $entry->save(); - Log::debug(sprintf('Set balance entry #%d to amount %s', $entry->id, $entry->balance)); + Log::debug(sprintf('Set balance entry "%s" #%d to amount %s', $title, $entry->id, $entry->balance)); // then do foreign amount, if present: if ($foreignCurrency > 0) { - $entry = self::getBalance('balance', $account, $foreignCurrency); - $entry->balance = bcadd($entry->balance, $sumForeignAmount); + $entry = self::getBalance($title, $account, $foreignCurrency, $transactionJournal?->id); + $entry->balance = bcadd($entry->balance, $sumForeignAmount); + $entry->transaction_journal_id = $transactionJournal?->id; $entry->save(); - Log::debug(sprintf('Set balance entry #%d to amount %s', $entry->id, $entry->balance)); + Log::debug(sprintf('Set balance entry "%s" #%d to amount %s', $title, $entry->id, $entry->balance)); } } return; } - private static function getBalance(string $title, int $account, int $currency): AccountBalance + private static function getBalance(string $title, int $account, int $currency, ?int $journal): AccountBalance { - $entry = AccountBalance::where('title', $title)->where('account_id', $account)->where('transaction_currency_id', $currency)->first(); + $query = AccountBalance::where('title', $title)->where('account_id', $account)->where('transaction_currency_id', $currency); + + if (null !== $journal) { + $query->where('transaction_journal_id', $journal); + } + + $entry = $query->first(); if (null !== $entry) { - Log::debug(sprintf('Found account balance for account #%d and currency #%d: %s', $account, $currency, $entry->balance)); + Log::debug(sprintf('Found account balance "%s" for account #%d and currency #%d: %s', $title, $account, $currency, $entry->balance)); return $entry; } $entry = new AccountBalance; $entry->title = $title; $entry->account_id = $account; $entry->transaction_currency_id = $currency; + $entry->transaction_journal_id = $journal; $entry->balance = '0'; $entry->save(); Log::debug(sprintf('Created new account balance for account #%d and currency #%d: %s', $account, $currency, $entry->balance)); return $entry; } - private static function resetAccountBalances(?Account $account): void + private static function resetAccountBalances(string $title, ?Account $account, ?TransactionJournal $transactionJournal): void { - if (null === $account) { - AccountBalance::whereNotNull('updated_at')->update(['balance' => '0']); + if (null === $account && null === $transactionJournal) { + AccountBalance::whereNotNull('updated_at')->where('title', $title)->update(['balance' => '0']); Log::debug('Set ALL balances to zero.'); return; } - AccountBalance::where('account_id', $account->id)->update(['balance' => '0']); - Log::debug(sprintf('Set balances of account #%d to zero.', $account->id)); + if(null !== $account && null === $transactionJournal) { + AccountBalance::where('account_id', $account->id)->where('title', $title)->update(['balance' => '0']); + Log::debug(sprintf('Set balances of account #%d to zero.', $account->id)); + return; + } + AccountBalance::where('account_id', $account->id)->where('transaction_journal_id', $transactionJournal->id)->where('title', $title)->update(['balance' => '0']); + Log::debug(sprintf('Set balances of account #%d + journal #%d to zero.', $account->id, $transactionJournal->id)); + + + } + + public static function recalculateByJournal(TransactionJournal $transactionJournal) + { + Log::debug(sprintf('Recalculate balance after journal #%d', $transactionJournal->id)); + // update both account balances, but limit to this transaction or earlier. + foreach ($transactionJournal->transactions as $transaction) { + self::recalculate($transaction->account, $transactionJournal); + } } diff --git a/database/migrations/2024_05_12_060551_create_account_balance_table.php b/database/migrations/2024_05_12_060551_create_account_balance_table.php index 432023e6e4..cec533c42e 100644 --- a/database/migrations/2024_05_12_060551_create_account_balance_table.php +++ b/database/migrations/2024_05_12_060551_create_account_balance_table.php @@ -25,8 +25,7 @@ return new class extends Migration { $table->foreign('transaction_currency_id')->references('id')->on('transaction_currencies')->onDelete('cascade'); - - $table->unique(['account_id', 'transaction_currency_id', 'title'], 'unique_account_currency'); + $table->unique(['account_id', 'transaction_currency_id', 'transaction_journal_id','date', 'title'], 'unique_account_currency'); }); } }