Files
sure/app/models/simplefin_entry/processor.rb
LPW c12c585a0e Harden SimpleFin sync: retries, safer imports, manual relinking, and data-quality reconciliation (#544)
* Add tests and enhance logic for SimpleFin account synchronization and reconciliation

- Added retry logic with exponential backoff for network errors in `Provider::Simplefin`.
- Introduced tests to verify retry functionality and error handling for rate-limit, server errors, and stale data.
- Updated `SimplefinItem` to detect stale sync status and reconciliation issues.
- Enhanced UI to display stale sync warnings and data integrity notices.
- Improved SimpleFin account matching during updates with multi-tier strategy (ID, fingerprint, fuzzy match).
- Added transaction reconciliation logic to detect data gaps, transaction count drops, and duplicate transaction IDs.

* Introduce `SimplefinConnectionUpdateJob` for asynchronous SimpleFin connection updates

- Moved SimpleFin connection update logic to `SimplefinConnectionUpdateJob` to improve response times by offloading network retries, data fetching, and reconciliation tasks.
- Enhanced SimpleFin account matching with a multi-tier strategy (ID, fingerprint, fuzzy name match).
- Added retry logic and bounded latency for token claim requests in `Provider::Simplefin`.
- Updated tests to cover the new job flow and ensure correct account reconciliation during updates.

* Remove unused SimpleFin account matching logic and improve error handling in `SimplefinConnectionUpdateJob`

- Deleted the multi-tier account matching logic from `SimplefinItemsController` as it is no longer used.
- Enhanced error handling in `SimplefinConnectionUpdateJob` to gracefully handle import failures, ensuring orphaned items can be manually resolved.
- Updated job flow to conditionally set item status based on the success of import operations.

* Fix SimpleFin sync: check both legacy FK and AccountProvider for linked accounts

* Add crypto, checking, savings, and cash account detection; refine subtype selection and linking

- Enhanced `Simplefin::AccountTypeMapper` to include detection for crypto, checking, savings, and standalone cash accounts.
- Improved subtype selection UI with validation and warning indicators for missing selections.
- Updated SimpleFin account linking to handle both legacy FK and `AccountProvider` associations consistently.
- Refined job flow and importer logic for better handling of linked accounts and subtype inference.

* Improve `SimplefinConnectionUpdateJob` and holdings processing logic

- Fixed race condition in `SimplefinConnectionUpdateJob` by moving `destroy_later` calls outside of transactions.
- Updated fuzzy name match logic to use Levenshtein distance for better accuracy.
- Enhanced synthetic ticker generation in holdings processor with hash suffix for uniqueness.

* Refine SimpleFin entry processing logic and ensure `extra` data persistence

- Simplified pending flag determination to rely solely on provider-supplied values.
- Fixed potential stale values in `extra` by ensuring deep merge overwrite with `entry.transaction.save!`.

* Replace hardcoded fallback transaction description with localized string

* Refine pending flag logic in SimpleFin processor tests

- Adjust test to prevent falsely inferring pending status from missing posted dates.
- Ensure provider explicitly sets pending flag for transactions.

* Add `has_many :holdings` association to `AccountProvider` with `dependent: :nullify`

---------

Co-authored-by: Josh Waldrep <joshua.waldrep5+github@gmail.com>
2026-01-05 22:11:47 +01:00

190 lines
6.1 KiB
Ruby

require "digest/md5"
class SimplefinEntry::Processor
include CurrencyNormalizable
# simplefin_transaction is the raw hash fetched from SimpleFin API and converted to JSONB
def initialize(simplefin_transaction, simplefin_account:)
@simplefin_transaction = simplefin_transaction
@simplefin_account = simplefin_account
end
def process
import_adapter.import_transaction(
external_id: external_id,
amount: amount,
currency: currency,
date: date,
name: name,
source: "simplefin",
merchant: merchant,
notes: notes,
extra: extra_metadata
)
end
private
attr_reader :simplefin_transaction, :simplefin_account
def extra_metadata
sf = {}
# Preserve raw strings from provider so nothing is lost
sf["payee"] = data[:payee] if data.key?(:payee)
sf["memo"] = data[:memo] if data.key?(:memo)
sf["description"] = data[:description] if data.key?(:description)
# Include provider-supplied extra hash if present
sf["extra"] = data[:extra] if data[:extra].is_a?(Hash)
# Pending detection: only use explicit provider flag
# We always set the key (true or false) to ensure deep_merge overwrites any stale value
if ActiveModel::Type::Boolean.new.cast(data[:pending])
sf["pending"] = true
Rails.logger.debug("SimpleFIN: flagged pending transaction #{external_id}")
else
sf["pending"] = false
end
# FX metadata: when tx currency differs from account currency
tx_currency = parse_currency(data[:currency])
acct_currency = account.currency
if tx_currency.present? && acct_currency.present? && tx_currency != acct_currency
sf["fx_from"] = tx_currency
# Prefer transacted_at for fx date, fallback to posted
fx_d = transacted_date || posted_date
sf["fx_date"] = fx_d&.to_s
end
return nil if sf.empty?
{ "simplefin" => sf }
end
def import_adapter
@import_adapter ||= Account::ProviderImportAdapter.new(account)
end
def account
simplefin_account.current_account
end
def data
@data ||= simplefin_transaction.with_indifferent_access
end
def external_id
id = data[:id].presence
raise ArgumentError, "SimpleFin transaction missing id: #{data.inspect}" unless id
"simplefin_#{id}"
end
def name
# Use SimpleFin's rich, clean data to create informative transaction names
payee = data[:payee]
description = data[:description]
# Combine payee + description when both are present and different
if payee.present? && description.present? && payee != description
"#{payee} - #{description}"
elsif payee.present?
payee
elsif description.present?
description
else
data[:memo] || I18n.t("transactions.unknown_name")
end
end
def amount
parsed_amount = case data[:amount]
when String
BigDecimal(data[:amount])
when Numeric
BigDecimal(data[:amount].to_s)
else
BigDecimal("0")
end
# SimpleFin uses banking convention (expenses negative, income positive)
# Maybe expects opposite convention (expenses positive, income negative)
# So we negate the amount to convert from SimpleFin to Maybe format
-parsed_amount
rescue ArgumentError => e
Rails.logger.error "Failed to parse SimpleFin transaction amount: #{data[:amount].inspect} - #{e.message}"
raise
end
def currency
parse_currency(data[:currency]) || account.currency
end
def log_invalid_currency(currency_value)
Rails.logger.warn("Invalid currency code '#{currency_value}' in SimpleFIN transaction #{external_id}, falling back to account currency")
end
# UI/entry date selection by account type:
# - Credit cards/loans: prefer transaction date (matches statements), then posted
# - Others: prefer posted date, then transaction date
# Epochs parsed as UTC timestamps via DateUtils
def date
# Prefer transaction date for revolving debt (credit cards/loans); otherwise prefer posted date
acct_type = simplefin_account&.account_type.to_s.strip.downcase.tr(" ", "_")
if %w[credit_card credit loan mortgage].include?(acct_type)
t = transacted_date
return t if t
p = posted_date
return p if p
else
p = posted_date
return p if p
t = transacted_date
return t if t
end
Rails.logger.error("SimpleFin transaction missing posted/transacted date: #{data.inspect}")
raise ArgumentError, "Invalid date format: #{data[:posted].inspect} / #{data[:transacted_at].inspect}"
end
def posted_date
val = data[:posted]
# Treat 0 / "0" as missing to avoid Unix epoch 1970-01-01
return nil if val == 0 || val == "0"
Simplefin::DateUtils.parse_provider_date(val)
end
def transacted_date
val = data[:transacted_at]
Simplefin::DateUtils.parse_provider_date(val)
end
def merchant
# Use SimpleFin's clean payee data for merchant detection
payee = data[:payee]&.strip
return nil unless payee.present?
@merchant ||= import_adapter.find_or_create_merchant(
provider_merchant_id: generate_merchant_id(payee),
name: payee,
source: "simplefin"
)
rescue ActiveRecord::RecordInvalid => e
Rails.logger.error "SimplefinEntry::Processor - Failed to create merchant '#{payee}': #{e.message}"
nil
end
def generate_merchant_id(merchant_name)
# Generate a consistent ID for merchants without explicit IDs
"simplefin_#{Digest::MD5.hexdigest(merchant_name.downcase)}"
end
def notes
# Prefer memo if present; include payee when it differs from description for richer context
memo = data[:memo].to_s.strip
payee = data[:payee].to_s.strip
description = data[:description].to_s.strip
parts = []
parts << memo if memo.present?
if payee.present? && payee != description
parts << "Payee: #{payee}"
end
parts.presence&.join(" | ")
end
end