1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-08-07 06:25:19 +02:00
Maybe/test/models/balance/reverse_calculator_test.rb
Zach Gollwitzer da2045dbd8
Additional cache columns on balances for activity view breakdowns (#2505)
* Initial schema iteration

* Add new balance components

* Add existing data migrator to backfill components

* Update calculator test assertions for new balance components

* Update flow assertions for forward calculator

* Update reverse calculator flows assumptions

* Forward calculator tests passing

* Get all calculator tests passing

* Assert flows factor
2025-07-23 10:06:25 -04:00

490 lines
22 KiB
Ruby

require "test_helper"
class Balance::ReverseCalculatorTest < ActiveSupport::TestCase
include LedgerTestingHelper
# When syncing backwards, we start with the account balance and generate everything from there.
test "when missing anchor and no entries, falls back to cached account balance" do
account = create_account_with_ledger(
account: { type: Depository, balance: 20000, cash_balance: 20000, currency: "USD" },
entries: []
)
assert_equal 20000, account.balance
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
}
]
)
end
# An artificial constraint we put on the reverse sync because it's confusing in both the code and the UI
# to think about how an absolute "Valuation" affects balances when syncing backwards. Furthermore, since
# this is typically a Plaid sync, we expect Plaid to provide us the history.
# Note: while "reconciliation" valuations don't affect balance, `current_anchor` and `opening_anchor` do.
test "reconciliation valuations do not affect balance for reverse syncs" do
account = create_account_with_ledger(
account: { type: Depository, balance: 20000, cash_balance: 20000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 },
{ type: "reconciliation", date: 1.day.ago, balance: 17000 }, # Ignored
{ type: "reconciliation", date: 2.days.ago, balance: 17000 }, # Ignored
{ type: "opening_anchor", date: 4.days.ago, balance: 15000 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
# The "opening anchor" works slightly differently than most would expect. Since it's an artificial
# value provided by the user to set the date/balance of the start of the account, we must assume
# that there are "missing" entries following it. Because of this, we cannot "carry forward" this value
# like we do for a "forward sync". We simply sync backwards normally, then set the balance on opening
# date equal to this anchor. This is not "ideal", but is a constraint put on us since we cannot guarantee
# a 100% full entries history.
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: 0
}, # Current anchor
{
date: 1.day.ago,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: 0
},
{
date: 2.days.ago,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: 0
},
{
date: 3.days.ago,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
},
{
date: 4.days.ago,
legacy_balances: { balance: 15000, cash_balance: 15000 },
balances: { start: 15000, start_cash: 15000, start_non_cash: 0, end_cash: 15000, end_non_cash: 0, end: 15000 },
flows: 0,
adjustments: 0
} # Opening anchor
]
)
end
# Investment account balances are made of two components: cash and holdings.
test "anchors on investment accounts calculate cash balance dynamically based on holdings value" do
account = create_account_with_ledger(
account: { type: Investment, balance: 20000, cash_balance: 10000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 }, # "Total account value is $20,000 today"
{ type: "opening_anchor", date: 1.day.ago, balance: 15000 } # "Total account value was $15,000 at the start of the account"
],
holdings: [
{ date: Date.current, ticker: "AAPL", qty: 100, price: 100, amount: 10000 },
{ date: 1.day.ago, ticker: "AAPL", qty: 100, price: 100, amount: 10000 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 10000 },
balances: { start: 20000, start_cash: 10000, start_non_cash: 10000, end_cash: 10000, end_non_cash: 10000, end: 20000 },
flows: { market_flows: 0 },
adjustments: 0
}, # Since $10,000 of holdings, cash has to be $10,000 to reach $20,000 total value
{
date: 1.day.ago,
legacy_balances: { balance: 15000, cash_balance: 5000 },
balances: { start: 15000, start_cash: 5000, start_non_cash: 10000, end_cash: 5000, end_non_cash: 10000, end: 15000 },
flows: { market_flows: 0 },
adjustments: 0
} # Since $10,000 of holdings, cash has to be $5,000 to reach $15,000 total value
]
)
end
test "transactions on depository accounts affect cash balance" do
account = create_account_with_ledger(
account: { type: Depository, balance: 20000, cash_balance: 20000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 },
{ type: "transaction", date: 2.days.ago, amount: 100 }, # expense
{ type: "transaction", date: 4.days.ago, amount: -500 } # income
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: 0
}, # Current balance
{
date: 1.day.ago,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: 0,
adjustments: 0
}, # No change
{
date: 2.days.ago,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20100, start_cash: 20100, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: { cash_inflows: 0, cash_outflows: 100 },
adjustments: 0
}, # After expense (+100)
{
date: 3.days.ago,
legacy_balances: { balance: 20100, cash_balance: 20100 },
balances: { start: 20100, start_cash: 20100, start_non_cash: 0, end_cash: 20100, end_non_cash: 0, end: 20100 },
flows: 0,
adjustments: 0
}, # Before expense
{
date: 4.days.ago,
legacy_balances: { balance: 20100, cash_balance: 20100 },
balances: { start: 19600, start_cash: 19600, start_non_cash: 0, end_cash: 20100, end_non_cash: 0, end: 20100 },
flows: { cash_inflows: 500, cash_outflows: 0 },
adjustments: 0
}, # After income (-500)
{
date: 5.days.ago,
legacy_balances: { balance: 19600, cash_balance: 19600 },
balances: { start: 19600, start_cash: 19600, start_non_cash: 0, end_cash: 19600, end_non_cash: 0, end: 19600 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
} # After income (-500)
]
)
end
test "transactions on credit card accounts affect cash balance inversely" do
account = create_account_with_ledger(
account: { type: CreditCard, balance: 2000, cash_balance: 2000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 2000 },
{ type: "transaction", date: 2.days.ago, amount: 100 }, # expense (increases cash balance)
{ type: "transaction", date: 4.days.ago, amount: -500 } # CC payment (reduces cash balance)
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
# Reversed order: showing how we work backwards
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 2000, cash_balance: 2000 },
balances: { start: 2000, start_cash: 2000, start_non_cash: 0, end_cash: 2000, end_non_cash: 0, end: 2000 },
flows: 0,
adjustments: 0
}, # Current balance
{
date: 1.day.ago,
legacy_balances: { balance: 2000, cash_balance: 2000 },
balances: { start: 2000, start_cash: 2000, start_non_cash: 0, end_cash: 2000, end_non_cash: 0, end: 2000 },
flows: 0,
adjustments: 0
}, # No change
{
date: 2.days.ago,
legacy_balances: { balance: 2000, cash_balance: 2000 },
balances: { start: 1900, start_cash: 1900, start_non_cash: 0, end_cash: 2000, end_non_cash: 0, end: 2000 },
flows: { cash_inflows: 0, cash_outflows: 100 },
adjustments: 0
}, # After expense (+100)
{
date: 3.days.ago,
legacy_balances: { balance: 1900, cash_balance: 1900 },
balances: { start: 1900, start_cash: 1900, start_non_cash: 0, end_cash: 1900, end_non_cash: 0, end: 1900 },
flows: 0,
adjustments: 0
}, # Before expense
{
date: 4.days.ago,
legacy_balances: { balance: 1900, cash_balance: 1900 },
balances: { start: 2400, start_cash: 2400, start_non_cash: 0, end_cash: 1900, end_non_cash: 0, end: 1900 },
flows: { cash_inflows: 500, cash_outflows: 0 },
adjustments: 0
}, # After CC payment (-500)
{
date: 5.days.ago,
legacy_balances: { balance: 2400, cash_balance: 2400 },
balances: { start: 2400, start_cash: 2400, start_non_cash: 0, end_cash: 2400, end_non_cash: 0, end: 2400 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
}
]
)
end
# A loan is a special case where despite being a "non-cash" account, it is typical to have "payment" transactions that reduce the loan principal (non cash balance)
test "loan payment transactions affect non cash balance" do
account = create_account_with_ledger(
account: { type: Loan, balance: 198000, cash_balance: 0, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 198000 },
# "Loan payment" of $2000, which reduces the principal
# TODO: We'll eventually need to calculate which portion of the txn was "interest" vs. "principal", but for now we'll just assume it's all principal
# since we don't have a first-class way to track interest payments yet.
{ type: "transaction", date: 1.day.ago.to_date, amount: -2000 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 198000, cash_balance: 0 },
balances: { start: 198000, start_cash: 0, start_non_cash: 198000, end_cash: 0, end_non_cash: 198000, end: 198000 },
flows: 0,
adjustments: 0
},
{
date: 1.day.ago,
legacy_balances: { balance: 198000, cash_balance: 0 },
balances: { start: 200000, start_cash: 0, start_non_cash: 200000, end_cash: 0, end_non_cash: 198000, end: 198000 },
flows: { non_cash_inflows: 2000, non_cash_outflows: 0, cash_inflows: 0, cash_outflows: 0 },
adjustments: 0
},
{
date: 2.days.ago,
legacy_balances: { balance: 200000, cash_balance: 0 },
balances: { start: 200000, start_cash: 0, start_non_cash: 200000, end_cash: 0, end_non_cash: 200000, end: 200000 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
}
]
)
end
test "non cash accounts can only use valuations and transactions will be recorded but ignored for balance calculation" do
[ Property, Vehicle, OtherAsset, OtherLiability ].each do |account_type|
account = create_account_with_ledger(
account: { type: account_type, balance: 1000, cash_balance: 0, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 1000 },
# Will be ignored for balance calculation due to account type of non-cash
{ type: "transaction", date: 1.day.ago, amount: -100 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 1000, cash_balance: 0 },
balances: { start: 1000, start_cash: 0, start_non_cash: 1000, end_cash: 0, end_non_cash: 1000, end: 1000 },
flows: 0,
adjustments: 0
},
{
date: 1.day.ago,
legacy_balances: { balance: 1000, cash_balance: 0 },
balances: { start: 1000, start_cash: 0, start_non_cash: 1000, end_cash: 0, end_non_cash: 1000, end: 1000 },
flows: 0,
adjustments: 0
},
{
date: 2.days.ago,
legacy_balances: { balance: 1000, cash_balance: 0 },
balances: { start: 1000, start_cash: 0, start_non_cash: 1000, end_cash: 0, end_non_cash: 1000, end: 1000 },
flows: 0,
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
}
]
)
end
end
# When syncing backwards, trades from the past should NOT affect the current balance or previous balances.
# They should only affect the *cash* component of the historical balances
test "holdings and trades sync" do
# Account starts with $20,000 total value, $19,000 cash, $1,000 in holdings
account = create_account_with_ledger(
account: { type: Investment, balance: 20000, cash_balance: 19000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 },
# Bought 10 AAPL shares 1 day ago, so cash is $19,000, $1,000 in holdings, total value is $20,000
{ type: "trade", date: 1.day.ago.to_date, ticker: "AAPL", qty: 10, price: 100 }
],
holdings: [
{ date: Date.current, ticker: "AAPL", qty: 10, price: 100, amount: 1000 },
{ date: 1.day.ago.to_date, ticker: "AAPL", qty: 10, price: 100, amount: 1000 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
# Given constant prices, overall balance (account value) should be constant
# (the single trade doesn't affect balance; it just alters cash vs. holdings composition)
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 19000, start_non_cash: 1000, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { market_flows: 0 },
adjustments: 0
}, # Current: $19k cash + $1k holdings (anchor)
{
date: 1.day.ago.to_date,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { cash_inflows: 0, cash_outflows: 1000, non_cash_inflows: 1000, non_cash_outflows: 0, net_market_flows: 0 },
adjustments: 0
}, # After trade: $19k cash + $1k holdings
{
date: 2.days.ago.to_date,
legacy_balances: { balance: 20000, cash_balance: 20000 },
balances: { start: 20000, start_cash: 20000, start_non_cash: 0, end_cash: 20000, end_non_cash: 0, end: 20000 },
flows: { market_flows: 0 },
adjustments: { cash_adjustments: 0, non_cash_adjustments: 0 }
} # At first, account is 100% cash, no holdings (no trades)
]
)
end
# A common scenario with Plaid is they'll give us holding records for today, but no trade history for some of them.
# This is because they only supply 2 years worth of historical data. Our system must properly handle this.
test "properly calculates balances when a holding has no trade history" do
# Account starts with $20,000 total value, $19,000 cash, $1,000 in holdings ($500 AAPL, $500 MSFT)
account = create_account_with_ledger(
account: { type: Investment, balance: 20000, cash_balance: 19000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 },
# A holding *with* trade history (5 shares of AAPL, purchased 1 day ago)
{ type: "trade", date: 1.day.ago.to_date, ticker: "AAPL", qty: 5, price: 100 }
],
holdings: [
# AAPL holdings
{ date: Date.current, ticker: "AAPL", qty: 5, price: 100, amount: 500 },
{ date: 1.day.ago.to_date, ticker: "AAPL", qty: 5, price: 100, amount: 500 },
# MSFT holdings without trade history - Balance calculator doesn't care how the holdings were created. It just reads them and assumes they are accurate.
{ date: Date.current, ticker: "MSFT", qty: 5, price: 100, amount: 500 },
{ date: 1.day.ago.to_date, ticker: "MSFT", qty: 5, price: 100, amount: 500 },
{ date: 2.days.ago.to_date, ticker: "MSFT", qty: 5, price: 100, amount: 500 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 19000, start_non_cash: 1000, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { market_flows: 0 },
adjustments: 0
}, # Current: $19k cash + $1k holdings ($500 MSFT, $500 AAPL)
{
date: 1.day.ago.to_date,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 19500, start_non_cash: 500, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { cash_inflows: 0, cash_outflows: 500, non_cash_inflows: 500, non_cash_outflows: 0, market_flows: 0 },
adjustments: 0
}, # After AAPL trade: $19k cash + $1k holdings
{
date: 2.days.ago.to_date,
legacy_balances: { balance: 20000, cash_balance: 19500 },
balances: { start: 19500, start_cash: 19500, start_non_cash: 0, end_cash: 19500, end_non_cash: 500, end: 20000 },
flows: { market_flows: -500 },
adjustments: 0
} # Before AAPL trade: $19.5k cash + $500 MSFT
]
)
end
test "uses provider reported holdings and cash value on current day" do
# Implied holdings value of $1,000 from provider
account = create_account_with_ledger(
account: { type: Investment, balance: 20000, cash_balance: 19000, currency: "USD" },
entries: [
{ type: "current_anchor", date: Date.current, balance: 20000 },
{ type: "opening_anchor", date: 2.days.ago, balance: 15000 }
],
holdings: [
# Create holdings that differ in value from provider ($2,000 vs. the $1,000 reported by provider)
{ date: Date.current, ticker: "AAPL", qty: 10, price: 100, amount: 1000 },
{ date: 1.day.ago, ticker: "AAPL", qty: 10, price: 100, amount: 1000 },
{ date: 2.days.ago, ticker: "AAPL", qty: 10, price: 100, amount: 1000 }
]
)
calculated = Balance::ReverseCalculator.new(account).calculate
assert_calculated_ledger_balances(
calculated_data: calculated,
expected_data: [
# No matter what, we force current day equal to the "anchor" balance (what provider gave us), and let "cash" float based on holdings value
# This ensures the user sees the same top-line number reported by the provider (even if it creates a discrepancy in the cash balance)
{
date: Date.current,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 19000, start_non_cash: 1000, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { market_flows: 0 },
adjustments: 0
},
{
date: 1.day.ago,
legacy_balances: { balance: 20000, cash_balance: 19000 },
balances: { start: 20000, start_cash: 19000, start_non_cash: 1000, end_cash: 19000, end_non_cash: 1000, end: 20000 },
flows: { market_flows: 0 },
adjustments: 0
},
{
date: 2.days.ago,
legacy_balances: { balance: 15000, cash_balance: 14000 },
balances: { start: 15000, start_cash: 14000, start_non_cash: 1000, end_cash: 14000, end_non_cash: 1000, end: 15000 },
flows: { market_flows: 0 },
adjustments: 0
} # Opening anchor sets absolute balance
]
)
end
end