Files
sure/app/models/simplefin_entry/processor.rb
LPW c391ba2b23 Harden SimpleFIN sync: protect user data, fix stuck syncs, optimize API calls (#671)
* Implement entry protection flags for sync overwrites

- Added `user_modified` and `import_locked` flags to `entries` table to prevent provider sync from overwriting user-edited and imported data.
- Introduced backfill migration to mark existing entries based on conditions.
- Enhanced sync and processing logic to respect protection flags, track skipped entries, and log detailed stats.
- Updated UI to display skipped/protected entries and reasons in sync summaries.

* Localize error details summary text and adjust `sync_account_later` method placement

* Restored schema.rb

---------

Co-authored-by: luckyPipewrench <luckypipewrench@proton.me>
2026-01-16 12:34:06 +01:00

211 lines
7.3 KiB
Ruby

require "digest/md5"
class SimplefinEntry::Processor
include CurrencyNormalizable
# simplefin_transaction is the raw hash fetched from SimpleFin API and converted to JSONB
# @param import_adapter [Account::ProviderImportAdapter, nil] Optional shared adapter for accumulating skipped entries
def initialize(simplefin_transaction, simplefin_account:, import_adapter: nil)
@simplefin_transaction = simplefin_transaction
@simplefin_account = simplefin_account
@shared_import_adapter = import_adapter
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: explicit flag OR inferred from posted=0 + transacted_at
# SimpleFIN indicates pending via:
# 1. pending: true (explicit flag)
# 2. posted=0 (epoch zero) + transacted_at present (implicit - some banks use this pattern)
#
# Note: We only infer from posted=0, NOT from posted=nil/blank, because some providers
# don't supply posted dates even for settled transactions (would cause false positives).
# We always set the key (true or false) to ensure deep_merge overwrites any stale value
is_pending = if ActiveModel::Type::Boolean.new.cast(data[:pending])
true
else
# Infer pending ONLY when posted is explicitly 0 (epoch) AND transacted_at is present
# posted=nil/blank is NOT treated as pending (some providers omit posted for settled txns)
posted_val = data[:posted]
transacted_val = data[:transacted_at]
posted_is_epoch_zero = posted_val.present? && posted_val.to_i.zero?
transacted_present = transacted_val.present? && transacted_val.to_i > 0
posted_is_epoch_zero && transacted_present
end
if is_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
# Use shared adapter if provided, otherwise create new one
@import_adapter ||= @shared_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