Files
sure/test/controllers/snaptrade_items_controller_test.rb
Juan José Mata b3f70c8951 feat:Add SnapTrade OAuth device flow (#2523)
* Add SnapTrade OAuth connection flow

* Restore SnapTrade brokerage portal links

* Guard SnapTrade OAuth setup completion

* Move SnapTrade OAuth start to POST

* Use one SnapTrade item in provider panel

* Fix SnapTrade OAuth controller tests

* Fix SnapTrade OAuth drawer completion redirect

* Update SnapTrade limits message.

* Restrict SnapTrade OAuth scopes
2026-06-29 00:30:03 +02:00

535 lines
20 KiB
Ruby

require "test_helper"
class SnaptradeItemsControllerTest < ActionDispatch::IntegrationTest
setup do
sign_in @user = users(:family_admin)
@snaptrade_item = snaptrade_items(:configured_item)
end
def sign_out
@user.sessions.each do |session|
delete session_path(session)
end
end
test "connect handles decryption error gracefully" do
SnaptradeItem.any_instance
.stubs(:user_registered?)
.raises(ActiveRecord::Encryption::Errors::Decryption.new("cannot decrypt"))
get connect_snaptrade_item_url(@snaptrade_item)
assert_redirected_to settings_providers_path
assert_match(/Unable to read SnapTrade credentials/, flash[:alert])
end
test "connect handles general error gracefully" do
SnaptradeItem.any_instance
.stubs(:user_registered?)
.raises(StandardError.new("something broke"))
get connect_snaptrade_item_url(@snaptrade_item)
assert_redirected_to settings_providers_path
assert_match(/Failed to connect/, flash[:alert])
end
test "connect redirects to portal when successful" do
portal_url = "https://app.snaptrade.com/portal/test123"
SnaptradeItem.any_instance.stubs(:user_registered?).returns(true)
SnaptradeItem.any_instance.stubs(:connection_portal_url).returns(portal_url)
get connect_snaptrade_item_url(@snaptrade_item)
assert_redirected_to portal_url
end
test "complete oauth device flow preserves provider oauth error fields" do
error = Provider::Snaptrade::ApiError.new(
"SnapTrade OAuth error (poll_device_token): authorization_pending",
status_code: 400,
response_body: {
error: "authorization_pending",
error_description: "The user has not completed authorization",
error_uri: "https://api.snaptrade.com/docs/oauth",
interval: 5
}.to_json
)
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.raises(error)
post complete_oauth_device_flow_snaptrade_item_url(@snaptrade_item), params: { device_code: "device-code" }, as: :json
assert_response :bad_request
payload = JSON.parse(response.body)
assert_equal "authorization_pending", payload["error"]
assert_equal "The user has not completed authorization", payload["error_description"]
assert_equal "https://api.snaptrade.com/docs/oauth", payload["error_uri"]
assert_equal 5, payload["interval"]
end
test "complete oauth device flow falls back to api error message without json body" do
error = Provider::Snaptrade::ApiError.new(
"SnapTrade OAuth error (poll_device_token): invalid response",
status_code: 502,
response_body: "upstream unavailable"
)
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.raises(error)
post complete_oauth_device_flow_snaptrade_item_url(@snaptrade_item), params: { device_code: "device-code" }, as: :json
assert_response :bad_gateway
payload = JSON.parse(response.body)
assert_equal "SnapTrade OAuth error (poll_device_token): invalid response", payload["error"]
end
test "complete oauth device flow does not expose non-api provider error details" do
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.raises(Provider::Snaptrade::ConfigurationError.new("missing secret at /srv/app/config.yml"))
post complete_oauth_device_flow_snaptrade_item_url(@snaptrade_item), params: { device_code: "device-code" }, as: :json
assert_response :unprocessable_entity
payload = JSON.parse(response.body)
assert_equal "Unable to complete SnapTrade OAuth device authorization. Please try again.", payload["error"]
end
test "start oauth device flow does not expose provider error details" do
SnaptradeItem.any_instance
.stubs(:start_oauth_device_flow)
.raises(Provider::Snaptrade::ApiError.new("upstream leaked internal path /srv/app/config.yml"))
post start_oauth_device_flow_snaptrade_item_url(@snaptrade_item)
assert_response :unprocessable_entity
payload = JSON.parse(response.body)
assert_equal "Unable to start SnapTrade OAuth device authorization. Please try again.", payload["error"]
end
test "start oauth device flow falls back to read for invalid scope" do
SnaptradeItem.any_instance
.expects(:start_oauth_device_flow)
.with(scope: "read")
.returns("device_code" => "device-code")
post start_oauth_device_flow_snaptrade_item_url(@snaptrade_item), params: { scope: "write" }
assert_response :success
assert_equal "device-code", JSON.parse(response.body)["device_code"]
end
test "oauth_connect renders start form without side effects" do
sign_out
sign_in @user = users(:empty)
@user.family.snaptrade_items.destroy_all
Provider::Snaptrade.stubs(:oauth_client_id_configured?).returns(true)
SnaptradeItem.any_instance
.expects(:start_oauth_device_flow)
.never
assert_no_difference "SnaptradeItem.count" do
get oauth_connect_snaptrade_items_url
end
assert_response :success
assert_match "turbo-frame id=\"drawer\"", response.body
assert_match "Start authorization", response.body
assert_no_match "Open SnapTrade", response.body
end
test "start_oauth_connect renders device authorization instructions" do
Provider::Snaptrade.stubs(:oauth_client_id_configured?).returns(true)
SnaptradeItem.any_instance
.stubs(:start_oauth_device_flow)
.returns(
"device_code" => "device-code",
"user_code" => "ABCD-EFGH",
"verification_uri" => "https://dashboard.snaptrade.com/activate",
"verification_uri_complete" => "https://dashboard.snaptrade.com/activate?user_code=ABCD-EFGH",
"expires_in" => 600,
"interval" => 5
)
post start_oauth_connect_snaptrade_items_url
assert_response :success
assert_match "turbo-frame id=\"drawer\"", response.body
assert_match "ABCD-EFGH", response.body
assert_match "Open SnapTrade", response.body
end
test "start_oauth_connect falls back to read for invalid scope" do
Provider::Snaptrade.stubs(:oauth_client_id_configured?).returns(true)
SnaptradeItem.any_instance
.expects(:start_oauth_device_flow)
.with(scope: "read")
.returns(
"device_code" => "device-code",
"user_code" => "ABCD-EFGH",
"verification_uri" => "https://dashboard.snaptrade.com/activate",
"expires_in" => 600,
"interval" => 5
)
post start_oauth_connect_snaptrade_items_url, params: { scope: "write" }
assert_response :success
assert_match "ABCD-EFGH", response.body
end
test "oauth_connect explains missing oauth client id without creating item" do
sign_out
sign_in @user = users(:empty)
@user.family.snaptrade_items.destroy_all
Provider::Snaptrade.stubs(:oauth_client_id_configured?).returns(false)
assert_no_difference "SnaptradeItem.count" do
get oauth_connect_snaptrade_items_url
end
assert_response :unprocessable_entity
assert_match "SNAPTRADE_OAUTH_CLIENT_ID", response.body
end
test "start_oauth_connect creates oauth-only item when snaptrade is not configured" do
sign_out
sign_in @user = users(:empty)
@user.family.snaptrade_items.destroy_all
Provider::Snaptrade.stubs(:oauth_client_id_configured?).returns(true)
SnaptradeItem.any_instance
.stubs(:start_oauth_device_flow)
.returns(
"device_code" => "device-code",
"user_code" => "ABCD-EFGH",
"verification_uri" => "https://dashboard.snaptrade.com/activate",
"expires_in" => 600,
"interval" => 5
)
assert_difference "SnaptradeItem.count", 1 do
post start_oauth_connect_snaptrade_items_url
end
assert_response :success
assert_match "ABCD-EFGH", response.body
assert_not @user.family.snaptrade_items.reload.last.credentials_configured?
end
test "select_accounts redirects unregistered users into connect flow" do
sign_out
sign_in @user = users(:empty)
snaptrade_item = snaptrade_items(:pending_registration_item)
get select_accounts_snaptrade_items_url, params: { accountable_type: "Investment", return_to: "setup_accounts" }
assert_redirected_to oauth_connect_snaptrade_items_path(
item_id: snaptrade_item.id,
accountable_type: "Investment",
return_to: "setup_accounts"
)
end
test "complete oauth device flow registers credentialed items and routes to setup" do
sign_out
sign_in @user = users(:empty)
snaptrade_item = snaptrade_items(:pending_registration_item)
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.returns(
"token_type" => "Bearer",
"scope" => "read",
"expires_in" => 3600
)
SnaptradeItem.any_instance
.stubs(:user_registered?)
.returns(false, true)
SnaptradeItem.any_instance
.expects(:ensure_user_registered!)
.once
.returns(true)
assert_difference "Sync.count", 1 do
post complete_oauth_device_flow_snaptrade_item_url(snaptrade_item), params: {
device_code: "device-code",
accountable_type: "Investment",
return_to: "setup_accounts"
}
end
assert_redirected_to setup_accounts_snaptrade_item_path(
snaptrade_item,
accountable_type: "Investment",
return_to: "setup_accounts"
)
assert_equal "SnapTrade authorization complete.", flash[:notice]
end
test "complete oauth device flow streams top-level navigation from drawer frame" do
sign_out
sign_in @user = users(:empty)
snaptrade_item = snaptrade_items(:pending_registration_item)
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.returns(
"token_type" => "Bearer",
"scope" => "read",
"expires_in" => 3600
)
SnaptradeItem.any_instance
.stubs(:user_registered?)
.returns(false, true)
SnaptradeItem.any_instance
.expects(:ensure_user_registered!)
.once
.returns(true)
setup_path = setup_accounts_snaptrade_item_path(
snaptrade_item,
accountable_type: "Investment",
return_to: "setup_accounts"
)
assert_difference "Sync.count", 1 do
post complete_oauth_device_flow_snaptrade_item_url(snaptrade_item), params: {
device_code: "device-code",
accountable_type: "Investment",
return_to: "setup_accounts"
}, headers: { "Turbo-Frame" => "drawer" }
end
assert_response :success
assert_equal "text/vnd.turbo-stream.html", response.media_type
assert_match %(<turbo-stream action="redirect"), response.body
assert_match ERB::Util.html_escape(setup_path), response.body
assert_equal "SnapTrade authorization complete.", flash[:notice]
end
test "complete oauth device flow does not mark oauth-only items as setup complete" do
sign_out
sign_in @user = users(:empty)
snaptrade_item = @user.family.snaptrade_items.create!(name: "OAuth-only SnapTrade")
SnaptradeItem.any_instance
.stubs(:complete_oauth_device_flow!)
.returns(
"token_type" => "Bearer",
"scope" => "read",
"expires_in" => 3600
)
assert_no_difference "Sync.count" do
post complete_oauth_device_flow_snaptrade_item_url(snaptrade_item), params: {
device_code: "device-code"
}
end
assert_redirected_to settings_providers_path
assert_match(/API credentials are required/, flash[:alert])
end
test "select_accounts redirects registered users to setup flow" do
get select_accounts_snaptrade_items_url, params: { accountable_type: "Investment", return_to: "/accounts" }
assert_redirected_to setup_accounts_snaptrade_item_path(@snaptrade_item, accountable_type: "Investment", return_to: "/accounts")
end
test "preload_accounts redirects unregistered users into connect flow" do
sign_out
sign_in @user = users(:empty)
assert_no_difference "Sync.count" do
get preload_accounts_snaptrade_items_url
end
assert_redirected_to oauth_connect_snaptrade_items_path(item_id: snaptrade_items(:pending_registration_item).id)
end
test "preload_accounts redirects registered users to setup flow and queues sync" do
assert_difference "Sync.count", 1 do
get preload_accounts_snaptrade_items_url
end
assert_redirected_to setup_accounts_snaptrade_item_path(@snaptrade_item)
end
test "entry routing prefers a registered active item over a pending one" do
pending_item = @user.family.snaptrade_items.create!(
name: "Pending Registration",
client_id: "pending_client_id",
consumer_key: "pending_consumer_key",
status: :good,
scheduled_for_deletion: false,
pending_account_setup: true
)
get select_accounts_snaptrade_items_url, params: { accountable_type: "Investment", return_to: "/accounts" }
assert_redirected_to setup_accounts_snaptrade_item_path(@snaptrade_item, accountable_type: "Investment", return_to: "/accounts")
assert_difference "Sync.count", 1 do
get preload_accounts_snaptrade_items_url
end
assert_redirected_to setup_accounts_snaptrade_item_path(@snaptrade_item)
assert_not pending_item.user_registered?
end
test "setup_accounts shows linkable investment and crypto accounts in dropdown" do
get setup_accounts_snaptrade_item_url(@snaptrade_item)
assert_response :success
# Investment and crypto accounts (no provider) should appear in the link dropdown
assert_match accounts(:investment).name, response.body
assert_match accounts(:crypto).name, response.body
# Depository should NOT appear in the link dropdown (wrong type)
# The depository name may appear elsewhere on the page, so check the select options specifically
refute_match(/option.*#{accounts(:depository).name}/, response.body)
end
test "setup_accounts excludes accounts that already have a provider from dropdown" do
# Link the investment account to a snaptrade_account
AccountProvider.create!(
account: accounts(:investment),
provider: snaptrade_accounts(:fidelity_401k)
)
get setup_accounts_snaptrade_item_url(@snaptrade_item)
assert_response :success
# Investment account is now linked → should NOT appear in link dropdown options
refute_match(/option.*#{accounts(:investment).name}/, response.body)
# Crypto still unlinked → should appear
assert_match accounts(:crypto).name, response.body
end
test "select_existing_account prefers registered active item over pending one" do
pending_item = @user.family.snaptrade_items.create!(
name: "Pending Registration",
client_id: "pending_client_id",
consumer_key: "pending_consumer_key",
status: :good,
scheduled_for_deletion: false,
pending_account_setup: true
)
pending_item.snaptrade_accounts.create!(
snaptrade_account_id: "pending_snaptrade_account",
name: "Pending Brokerage Account",
brokerage_name: "Pending Broker",
currency: "USD",
current_balance: 0
)
get select_existing_account_snaptrade_items_url, params: { account_id: accounts(:investment).id }
assert_response :success
assert_includes response.body, snaptrade_accounts(:fidelity_401k).name
refute_includes response.body, "Pending Brokerage Account"
end
test "link_existing_account links account to snaptrade_account" do
account = accounts(:investment)
snaptrade_account = snaptrade_accounts(:fidelity_401k)
assert_difference "AccountProvider.count", 1 do
post link_existing_account_snaptrade_items_url, params: {
account_id: account.id,
snaptrade_account_id: snaptrade_account.id,
snaptrade_item_id: @snaptrade_item.id
}
end
assert_redirected_to account_path(account)
assert_match(/Successfully linked/, flash[:notice])
snaptrade_account.reload
assert_equal account, snaptrade_account.current_account
end
test "link_existing_account handles missing account gracefully" do
snaptrade_account = snaptrade_accounts(:fidelity_401k)
assert_no_difference "AccountProvider.count" do
post link_existing_account_snaptrade_items_url, params: {
account_id: "nonexistent",
snaptrade_account_id: snaptrade_account.id,
snaptrade_item_id: @snaptrade_item.id
}
end
assert_redirected_to settings_providers_path
assert_match(/not found/i, flash[:alert])
end
# --- setup_accounts throttle-sync fix ---
#
# The fix on setup_accounts ensures sync_later is only called when there are no
# accounts AND the item has never been synced (last_synced_at.blank?). This
# prevents the infinite-spinner loop where every page load re-triggered a sync
# even after SnapTrade already confirmed 0 linked accounts.
#
# Three view-state branches we need to cover:
# A) No accounts + never synced → trigger sync, render spinner
# B) No accounts + synced once, now idle → skip sync, show "no accounts found"
# C) No accounts + synced once, still syncing → show spinner, do NOT re-queue
test "setup_accounts triggers sync and shows spinner when item has no accounts and has never been synced" do
# Pre-condition: no snaptrade_accounts and no completed syncs (last_synced_at is nil)
@snaptrade_item.snaptrade_accounts.destroy_all
@snaptrade_item.syncs.destroy_all
assert_difference "Sync.count", 1 do
get setup_accounts_snaptrade_item_url(@snaptrade_item)
end
assert_response :success
assert_select "#snaptrade-sync-spinner", count: 1, message: "Expected the spinner to be shown on first visit with no accounts"
assert_select ".no-accounts-found", count: 0, message: "Expected the no-accounts UI to be hidden while syncing"
end
test "setup_accounts shows no-accounts-found state after a completed sync returns zero accounts" do
# Pre-condition: no snaptrade_accounts, but there IS a past completed sync
@snaptrade_item.snaptrade_accounts.destroy_all
@snaptrade_item.syncs.destroy_all
@snaptrade_item.syncs.create!(status: :completed, completed_at: 1.minute.ago)
# Item is not currently syncing → @syncing is false
assert_not @snaptrade_item.reload.syncing?, "Item should not be syncing for this test"
assert_no_difference "Sync.count" do
get setup_accounts_snaptrade_item_url(@snaptrade_item)
end
assert_response :success
assert_select ".no-accounts-found", count: 1, message: "Expected the no-accounts UI to be shown after a completed sync with zero accounts"
assert_select "#snaptrade-sync-spinner", count: 0, message: "Expected the spinner to be hidden when there is no active sync"
assert_select "a[href=?]", connect_snaptrade_item_path(@snaptrade_item), text: /Connect Brokerage/
assert_no_match oauth_connect_snaptrade_items_path(item_id: @snaptrade_item.id), response.body
end
test "setup_accounts does not re-queue a sync when a sync is already in progress" do
# Pre-condition: no accounts, one past completed sync, + one visible (in-flight) sync
@snaptrade_item.snaptrade_accounts.destroy_all
@snaptrade_item.syncs.destroy_all
@snaptrade_item.syncs.create!(status: :completed, completed_at: 5.minutes.ago)
@snaptrade_item.syncs.create!(status: :pending, created_at: 1.minute.ago) # visible/in-flight
assert @snaptrade_item.reload.syncing?, "Item should be syncing for this test"
assert_no_difference "Sync.count" do
get setup_accounts_snaptrade_item_url(@snaptrade_item)
end
assert_response :success
assert_select "#snaptrade-sync-spinner", count: 1, message: "Expected the spinner to be shown while sync is in progress"
assert_select ".no-accounts-found", count: 0, message: "Expected the no-accounts UI to be hidden while a sync is active"
end
end