Auto commit for release 'develop' on 2024-09-29

# Conflicts:
#	app/Support/Models/AccountBalanceCalculator.php

.env.example

@@ -312,6 +312,12 @@ PUSHER_ID=
 DEMO_USERNAME=
 DEMO_PASSWORD=
 
+#
+# Disable or enable the running balance column data
+# Please disable this. It's a very experimental feature.
+#
+USE_RUNNING_BALANCE=false
+
 #
 # The v2 layout is very experimental. If it breaks you get to keep both parts.
 # Be wary of data loss.

app/Support/Models/AccountBalanceCalculator.php

@@ -78,6 +78,34 @@ class AccountBalanceCalculator
         $object->optimizedCalculation($accounts, $transactionJournal->date);
     }
 
+    private function getLatestBalance(int $accountId, int $currencyId, ?Carbon $notBefore): string
+    {
+        if (null === $notBefore) {
+            return '0';
+        }
+        Log::debug(sprintf('getLatestBalance: notBefore date is "%s", calculating', $notBefore->format('Y-m-d')));
+        $query   = Transaction::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
+            ->whereNull('transactions.deleted_at')
+            ->where('transaction_journals.transaction_currency_id', $currencyId)
+            ->whereNull('transaction_journals.deleted_at')
+            // this order is the same as GroupCollector
+            ->orderBy('transaction_journals.date', 'DESC')
+            ->orderBy('transaction_journals.order', 'ASC')
+            ->orderBy('transaction_journals.id', 'DESC')
+            ->orderBy('transaction_journals.description', 'DESC')
+            ->orderBy('transactions.amount', 'DESC')
+            ->where('transactions.account_id', $accountId)
+        ;
+        $notBefore->startOfDay();
+        $query->where('transaction_journals.date', '<', $notBefore);
+
+        $first   = $query->first(['transactions.id', 'transactions.balance_dirty', 'transactions.transaction_currency_id', 'transaction_journals.date', 'transactions.account_id', 'transactions.amount', 'transactions.balance_after']);
+        $balance = $first->balance_after ?? '0';
+        Log::debug(sprintf('getLatestBalance: found balance: %s in transaction #%d', $balance, $first->id ?? 0));
+
+        return $balance;
+    }
+
     private function getAccountBalanceByAccount(int $account, int $currency): AccountBalance
     {
         $query                          = AccountBalance::where('title', 'balance')->where('account_id', $account)->where('transaction_currency_id', $currency);
@@ -102,6 +130,12 @@ class AccountBalanceCalculator
     private function optimizedCalculation(Collection $accounts, ?Carbon $notBefore = null): void
     {
         Log::debug('start of optimizedCalculation');
+        if (false === config('firefly.feature_flags.running_balance_column')) {
+            Log::debug('optimizedCalculation is disabled, return.');
+
+            return;
+        }
+
         if ($accounts->count() > 0) {
             Log::debug(sprintf('Limited to %d account(s)', $accounts->count()));
         }
@@ -132,7 +166,7 @@ class AccountBalanceCalculator
         foreach ($set as $entry) {
             // start with empty array:
             $balances[$entry->account_id]                                  ??= [];
-            $balances[$entry->account_id][$entry->transaction_currency_id] ??= '0';
+            $balances[$entry->account_id][$entry->transaction_currency_id] ??= $this->getLatestBalance($entry->account_id, $entry->transaction_currency_id, $notBefore);
 
             // before and after are easy:
             $before                                                        = $balances[$entry->account_id][$entry->transaction_currency_id];

app/Support/Twig/General.php

@@ -29,7 +29,6 @@ use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\User\UserRepositoryInterface;
 use FireflyIII\Support\Search\OperatorQuerySearch;
 use League\CommonMark\GithubFlavoredMarkdownConverter;
-use Route;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;
 use Twig\TwigFunction;
@@ -63,12 +62,29 @@ class General extends AbstractExtension
                 }
 
                 /** @var Carbon $date */
-                $date    = session('end', today(config('app.timezone'))->endOfMonth());
-                $info    = app('steam')->balanceByTransactions($account, $date, null);
+                $date           = session('end', today(config('app.timezone'))->endOfMonth());
+                $runningBalance = config('firefly.feature_flags.running_balance_column');
+                $info           = [];
+                if (true === $runningBalance) {
+                    $info = app('steam')->balanceByTransactions($account, $date, null);
+                }
+                if (false === $runningBalance) {
+                    $info[] = app('steam')->balance($account, $date);
+                }
 
-                $strings = [];
+                $strings        = [];
                 foreach ($info as $currencyId => $balance) {
-                    $strings[] = app('amount')->formatByCurrencyId($currencyId, $balance, false);
+                    $balance = (string) $balance;
+                    if (0 === $currencyId) {
+                        // not good code but OK
+                        /** @var AccountRepositoryInterface $accountRepos */
+                        $accountRepos = app(AccountRepositoryInterface::class);
+                        $currency     = $accountRepos->getAccountCurrency($account) ?? app('amount')->getDefaultCurrency();
+                        $strings[]    = app('amount')->formatAnything($currency, $balance, false);
+                    }
+                    if (0 !== $currencyId) {
+                        $strings[] = app('amount')->formatByCurrencyId($currencyId, $balance, false);
+                    }
                 }
 
                 return implode(', ', $strings);
@@ -198,7 +214,7 @@ class General extends AbstractExtension
                     ]
                 );
 
-                return (string)$converter->convert($text);
+                return (string) $converter->convert($text);
             },
             ['is_safe' => ['html']]
         );
@@ -212,8 +228,8 @@ class General extends AbstractExtension
         return new TwigFilter(
             'phphost',
             static function (string $string): string {
-                $proto = (string)parse_url($string, PHP_URL_SCHEME);
-                $host  = (string)parse_url($string, PHP_URL_HOST);
+                $proto = (string) parse_url($string, PHP_URL_SCHEME);
+                $host  = (string) parse_url($string, PHP_URL_HOST);
 
                 return e(sprintf('%s://%s', $proto, $host));
             }

changelog.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 6.1.21 - 2024-09-30
+
+### Added
+
+- Enabled the expression engine built by @michaelhthomas. Read more about it in [the documentation](https://docs.firefly-iii.org/references/firefly-iii/rule-expressions/).
+- Add running balance data, see if it can be used in the layout in the future.
+- [PR 9160](https://github.com/firefly-iii/firefly-iii/pull/9160) (add test cases for api/v1/autocomplete/CategoryController) reported by @tasnim0tantawi
+- [PR 9178](https://github.com/firefly-iii/firefly-iii/pull/9178) (Add  test cases for Api\V1\Controllers\Autocomplete\BillController & BudgetController) reported by @tasnim0tantawi
+- [PR 9171](https://github.com/firefly-iii/firefly-iii/pull/9171) (Add about test) reported by @mzhubail
+
+### Changed
+
+- [PR 9096](https://github.com/firefly-iii/firefly-iii/pull/9096) (chore: fix some comments) reported by @withbest
+
+### Fixed
+
+- [Issue 9078](https://github.com/firefly-iii/firefly-iii/issues/9078) (bcadd exception while using POST transactions) reported by @dbtdsilva
+- [Discussion 9080](https://github.com/orgs/firefly-iii/discussions/9080) (Incorrect sorting on expense accounts) started by @pc-zookeeper
+- [Issue 9084](https://github.com/firefly-iii/firefly-iii/issues/9084) (API Call for bills/nextExpectedMatch does not update) reported by @marcelweikum
+- [Issue 9103](https://github.com/firefly-iii/firefly-iii/issues/9103) (Default Currency does not apply to Accounts.) reported by @chrisgriff1512
+- [Issue 9140](https://github.com/firefly-iii/firefly-iii/issues/9140) (Dashboard 'Today' option chooses 1st of month (not current date)) reported by @PAS-BC
+- [PR 9179](https://github.com/firefly-iii/firefly-iii/pull/9179) (fix Navigation.php MTD logic to make tests pass.) reported by @tasnim0tantawi
+- [PR 9239](https://github.com/firefly-iii/firefly-iii/pull/9239) (Fix webhook index page when Firefly is not served at root) reported by @jfpedroza
+- [Issue 9168](https://github.com/firefly-iii/firefly-iii/issues/9168) (Custom logout URL doesn't work.) reported by @JC5
+- [Issue 9155](https://github.com/firefly-iii/firefly-iii/issues/9155) (internal_reference_is does not correctly match numeric internal references) reported by @Lrns123
+- [Issue 9275](https://github.com/firefly-iii/firefly-iii/issues/9275) (Long wait when editing a transaction) reported by @JC5
+- [Issue 9278](https://github.com/firefly-iii/firefly-iii/issues/9278) (Update to v6.1.20 changed Balance of Account) reported by @JeuJeus
+
+### API
+
+- Expand v2 API
+
 ## 6.1.20 - 2024-09-29
 
 ### Added

config/firefly.php

@@ -65,10 +65,6 @@ use FireflyIII\Support\Binder\UserGroupAccount;
 use FireflyIII\Support\Binder\UserGroupBill;
 use FireflyIII\Support\Binder\UserGroupTransaction;
 use FireflyIII\TransactionRules\Actions\AddTag;
-use FireflyIII\TransactionRules\Actions\AppendDescription;
-use FireflyIII\TransactionRules\Actions\AppendDescriptionToNotes;
-use FireflyIII\TransactionRules\Actions\AppendNotes;
-use FireflyIII\TransactionRules\Actions\AppendNotesToDescription;
 use FireflyIII\TransactionRules\Actions\ClearBudget;
 use FireflyIII\TransactionRules\Actions\ClearCategory;
 use FireflyIII\TransactionRules\Actions\ClearNotes;
@@ -77,10 +73,6 @@ use FireflyIII\TransactionRules\Actions\ConvertToTransfer;
 use FireflyIII\TransactionRules\Actions\ConvertToWithdrawal;
 use FireflyIII\TransactionRules\Actions\DeleteTransaction;
 use FireflyIII\TransactionRules\Actions\LinkToBill;
-use FireflyIII\TransactionRules\Actions\MoveDescriptionToNotes;
-use FireflyIII\TransactionRules\Actions\MoveNotesToDescription;
-use FireflyIII\TransactionRules\Actions\PrependDescription;
-use FireflyIII\TransactionRules\Actions\PrependNotes;
 use FireflyIII\TransactionRules\Actions\RemoveAllTags;
 use FireflyIII\TransactionRules\Actions\RemoveTag;
 use FireflyIII\TransactionRules\Actions\SetAmount;
@@ -110,14 +102,15 @@ return [
     ],
     // some feature flags:
     'feature_flags'                => [
-        'export'            => true,
-        'telemetry'         => false,
-        'webhooks'          => true,
-        'handle_debts'      => true,
-        'expression_engine' => true,
+        'export'                 => true,
+        'telemetry'              => false,
+        'webhooks'               => true,
+        'handle_debts'           => true,
+        'expression_engine'      => true,
+        'running_balance_column' => env('USE_RUNNING_BALANCE', false),
         // see cer.php for exchange rates feature flag.
     ],
-    'version'                      => 'develop/2024-09-28',
+    'version'                      => 'develop/2024-09-29',
     'api_version'                  => '2.1.0',
     'db_version'                   => 24,