Files
sure/test/models/rule/action_test.rb
Juan José Mata bf90cad9a0 Add Recent Runs visibility for rule executions (#376)
* Add Recent Runs visibility for rule executions

Adds a comprehensive tracking system for rule execution history with the following features:

- Creates RuleRun model to track execution metadata:
  * Date/time of execution
  * Execution type (manual/scheduled)
  * Success/failure status
  * Rule reference
  * Transaction counts (processed and modified)
  * Error messages for failed runs

- Updates RuleJob to automatically record execution results:
  * Captures transaction processing statistics
  * Handles success/failure states
  * Stores error details for debugging

- Adds "Recent Runs" section to rules index page:
  * Paginated display (20 runs per page)
  * Columnar layout similar to LLM usage page
  * Visual status indicators (success/failed badges)
  * Error tooltips for failed runs
  * Responsive design with design system tokens

- Includes i18n translations for all user-facing strings

This provides users with visibility into rule execution history, making it easier to debug issues and monitor rule performance.

* Update schema.rb with rule_runs table definition

* Linter noise

* Separate transaction counts into Queued, Processed, and Modified

Previously, the code eagerly reported transactions as "processed" when they
were only queued for processing. This commit separates the counts into three
distinct metrics:

- Transactions Queued: Count of transactions matching the rule's filter
  conditions before any processing begins
- Transactions Processed: Count of transactions that were actually processed
  and modified by the rule actions
- Transactions Modified: Count of transactions that had their values changed
  (currently same as Processed, but allows for future differentiation)

Changes:
- Add transactions_queued column to rule_runs table
- Update RuleJob to track all three counts separately
- Update action executors to return count of modified transactions
- Update Rule#apply to aggregate modification counts from actions
- Add transactions_queued label to locales
- Update Recent Runs view to display new column
- Add validation for transactions_queued in RuleRun model

The tracking now correctly reports:
1. How many transactions matched the filter (queued)
2. How many were actually modified (processed/modified)
3. Distinguishes between matching and modifying transactions

* Add Pending status to track async rule execution progress

Introduced a new "pending" status for rule runs to properly track async
AI operations. The system now:

- Tracks pending async jobs with a counter that decrements as jobs complete
- Updates transactions_modified incrementally as each job finishes
- Only counts transactions that were actually modified (not just queued)
- Displays pending status with yellow badge in the UI
- Automatically transitions from pending to success when all jobs complete

This provides better visibility into long-running AI categorization and
merchant detection operations, showing real-time progress as Sidekiq
processes the batches.

* Fix migration version to 7.2 as per project standards

* Consolidate rule_runs migrations into single migration file

Merged three separate migrations (create, add_transactions_queued,
add_pending_jobs_count) into a single CreateRuleRuns migration.
This provides better clarity and maintains a clean migration history.

Changes:
- Updated CreateRuleRuns migration to include all columns upfront
- Removed redundant add_column migrations
- Updated schema version to 2025_11_24_000000

* Linter and test fixes

* Space optimization

* LLM l10n is better than no l10n

* Fix implementation for tags/AI rules

* Fix tests

* Use batch_size

* Consider jobs "unknown" status sometimes

* Rabbit suggestion

* Rescue block for RuleRun.create!

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-07 16:30:02 +01:00

104 lines
3.0 KiB
Ruby

require "test_helper"
class Rule::ActionTest < ActiveSupport::TestCase
include EntriesTestHelper
setup do
@family = families(:dylan_family)
@transaction_rule = rules(:one)
@account = @family.accounts.create!(name: "Rule test", balance: 1000, currency: "USD", accountable: Depository.new)
@grocery_category = @family.categories.create!(name: "Grocery")
@whole_foods_merchant = @family.merchants.create!(name: "Whole Foods", type: "FamilyMerchant")
# Some sample transactions to work with
@txn1 = create_transaction(date: Date.current, account: @account, amount: 100, name: "Rule test transaction1", merchant: @whole_foods_merchant).transaction
@txn2 = create_transaction(date: Date.current, account: @account, amount: -200, name: "Rule test transaction2").transaction
@txn3 = create_transaction(date: 1.day.ago.to_date, account: @account, amount: 50, name: "Rule test transaction3").transaction
@rule_scope = @account.transactions
end
test "set_transaction_category" do
# Does not modify transactions that are locked (user edited them)
@txn1.lock_attr!(:category_id)
action = Rule::Action.new(
rule: @transaction_rule,
action_type: "set_transaction_category",
value: @grocery_category.id
)
action.apply(@rule_scope)
assert_nil @txn1.reload.category
[ @txn2, @txn3 ].each do |transaction|
assert_equal @grocery_category.id, transaction.reload.category_id
end
end
test "set_transaction_tags" do
tag = @family.tags.create!(name: "Rule test tag")
# Does not modify transactions that are locked (user edited them)
@txn1.lock_attr!(:tag_ids)
action = Rule::Action.new(
rule: @transaction_rule,
action_type: "set_transaction_tags",
value: tag.id
)
action.apply(@rule_scope)
assert_equal [], @txn1.reload.tags
[ @txn2, @txn3 ].each do |transaction|
assert_equal [ tag ], transaction.reload.tags
end
end
test "set_transaction_merchant" do
merchant = @family.merchants.create!(name: "Rule test merchant")
# Does not modify transactions that are locked (user edited them)
@txn1.lock_attr!(:merchant_id)
action = Rule::Action.new(
rule: @transaction_rule,
action_type: "set_transaction_merchant",
value: merchant.id
)
action.apply(@rule_scope)
assert_not_equal merchant.id, @txn1.reload.merchant_id
[ @txn2, @txn3 ].each do |transaction|
assert_equal merchant.id, transaction.reload.merchant_id
end
end
test "set_transaction_name" do
new_name = "Renamed Transaction"
# Does not modify transactions that are locked (user edited them)
@txn1.entry.lock_attr!(:name)
action = Rule::Action.new(
rule: @transaction_rule,
action_type: "set_transaction_name",
value: new_name
)
action.apply(@rule_scope)
assert_not_equal new_name, @txn1.reload.entry.name
[ @txn2, @txn3 ].each do |transaction|
assert_equal new_name, transaction.reload.entry.name
end
end
end