Files
sure/config/routes.rb
LPW 84bfe5b7ab Add external AI assistant with Pipelock security proxy (#1069)
* feat(helm): add Pipelock ConfigMap, scanning config, and consolidate compose

- Add ConfigMap template rendering DLP, response scanning, MCP input/tool
  scanning, and forward proxy settings from values
- Mount ConfigMap as /etc/pipelock/pipelock.yaml volume in deployment
- Add checksum/config annotation for automatic pod restart on config change
- Gate HTTPS_PROXY/HTTP_PROXY env injection on forwardProxy.enabled (skip
  in MCP-only mode)
- Use hasKey for all boolean values to prevent Helm default swallowing false
- Single source of truth for ports (forwardProxy.port/mcpProxy.port)
- Pipelock-specific imagePullSecrets with fallback to app secrets
- Merge standalone compose.example.pipelock.yml into compose.example.ai.yml
- Add pipelock.example.yaml for Docker Compose users
- Add exclude-paths to CI workflow for locale file false positives

* Add external assistant support (OpenAI-compatible SSE proxy)

Allow self-hosted instances to delegate chat to an external AI agent
via an OpenAI-compatible streaming endpoint. Configurable per-family
through Settings UI or ASSISTANT_TYPE env override.

- Assistant::External::Client: SSE streaming HTTP client (no new gems)
- Settings UI with type selector, env lock indicator, config status
- Helm chart and Docker Compose env var support
- 45 tests covering client, config, routing, controller, integration

* Add session key routing, email allowlist, and config plumbing

Route to the actual OpenClaw session via x-openclaw-session-key header
instead of creating isolated sessions. Gate external assistant access
behind an email allowlist (EXTERNAL_ASSISTANT_ALLOWED_EMAILS env var).
Plumb session_key and allowedEmails through Helm chart, compose, and
env template.

* Add HTTPS_PROXY support to External::Client for Pipelock integration

Net::HTTP does not auto-read HTTPS_PROXY/HTTP_PROXY env vars (unlike
Faraday). Explicitly resolve proxy from environment in build_http so
outbound traffic to the external assistant routes through Pipelock's
forward proxy when enabled. Respects NO_PROXY for internal hosts.

* Add UI fields for external assistant config (Setting-backed with env fallback)

Follow the same pattern as OpenAI settings: database-backed Setting
fields with env var defaults. Self-hosters can now configure the
external assistant URL, token, and agent ID from the browser
(Settings > Self-Hosting > AI Assistant) instead of requiring env vars.
Fields disable when the corresponding env var is set.

* Improve external assistant UI labels and add help text

Change placeholder to generic OpenAI-compatible URL pattern. Add help
text under each field explaining where the values come from: URL from
agent provider, token for authentication, agent ID for multi-agent
routing.

* Add external assistant docs and fix URL help text

Add External AI Assistant section to docs/hosting/ai.md covering setup
(UI and env vars), how it works, Pipelock security scanning, access
control, and Docker Compose example. Drop "chat completions" jargon
from URL help text.

* Harden external assistant: retry logic, disconnect UI, error handling, and test coverage

- Add retry with backoff for transient network errors (no retry after streaming starts)
- Add disconnect button with confirmation modal in self-hosting settings
- Narrow rescue scope with fallback logging for unexpected errors
- Safe cleanup of partial responses on stream interruption
- Gate ai_available? on family assistant_type instead of OR-ing all providers
- Truncate conversation history to last 20 messages
- Proxy-aware HTTP client with NO_PROXY support
- Sanitize protocol to use generic headers (X-Agent-Id, X-Session-Key)
- Full test coverage for streaming, retries, proxy routing, config, and disconnect

* Exclude external assistant client from Pipelock scan-diff

False positive: `@token` instance variable flagged as "Credential in URL".
Temporary workaround until Pipelock supports inline suppression.

* Address review feedback: NO_PROXY boundary fix, SSE done flag, design tokens

- Fix NO_PROXY matching to require domain boundary (exact match or .suffix),
  case-insensitive. Prevents badexample.com matching example.com.
- Add done flag to SSE streaming so read_body stops after [DONE]
- Move MAX_CONVERSATION_MESSAGES to class level
- Use bg-success/bg-destructive design tokens for status indicators
- Add rationale comment for pipelock scan exclusion
- Update docs last-updated date

* Address second round of review feedback

- Allowlist email comparison is now case-insensitive and nil-safe
- Cap SSE buffer at 1 MB to prevent memory blowup from malformed streams
- Don't expose upstream HTTP response body in user-facing errors (log it instead)
- Fix frozen string warning on buffer initialization
- Fix "builtin" typo in docs (should be "built-in")

* Protect completed responses from cleanup, sanitize error messages

- Don't destroy a fully streamed assistant message if post-stream
  metadata update fails (only cleanup partial responses)
- Log raw connection/HTTP errors internally, show generic messages
  to users to avoid leaking network/proxy details
- Update test assertions for new error message wording

* Fix SSE content guard and NO_PROXY test correctness

Use nil check instead of present? for SSE delta content to preserve
whitespace-only chunks (newlines, spaces) that can occur in code output.

Fix NO_PROXY test to use HTTP_PROXY matching the http:// client URL so
the proxy resolution and NO_PROXY bypass logic are actually exercised.

* Forward proxy credentials to Net::HTTP

Pass proxy_uri.user and proxy_uri.password to Net::HTTP.new so
authenticated proxies (http://user:pass@host:port) work correctly.
Without this, credentials parsed from the proxy URL were silently
dropped. Nil values are safe as positional args when no creds exist.

* Update pipelock integration to v0.3.1 with full scanning config

Bump Helm image tag from 0.2.7 to 0.3.1. Add missing security
sections to both the Helm ConfigMap and compose example config:
mcp_tool_policy, mcp_session_binding, and tool_chain_detection.
These protect the /mcp endpoint against tool injection, session
hijacking, and multi-step exfiltration chains.

Add version and mode fields to config files. Enable include_defaults
for DLP and response scanning to merge user patterns with the 35
built-in patterns. Remove redundant --mode CLI flag from the Helm
deployment template since mode is now in the config file.
2026-03-03 15:47:51 +01:00

509 lines
14 KiB
Ruby

require "sidekiq/web"
require "sidekiq/cron/web"
Rails.application.routes.draw do
resources :indexa_capital_items, only: [ :index, :new, :create, :show, :edit, :update, :destroy ] do
collection do
get :preload_accounts
get :select_accounts
post :link_accounts
get :select_existing_account
post :link_existing_account
end
member do
post :sync
get :setup_accounts
post :complete_account_setup
end
end
resources :mercury_items, only: %i[index new create show edit update destroy] do
collection do
get :preload_accounts
get :select_accounts
post :link_accounts
get :select_existing_account
post :link_existing_account
end
member do
post :sync
get :setup_accounts
post :complete_account_setup
end
end
resources :coinbase_items, only: [ :index, :new, :create, :show, :edit, :update, :destroy ] do
collection do
get :preload_accounts
get :select_accounts
post :link_accounts
get :select_existing_account
post :link_existing_account
end
member do
post :sync
get :setup_accounts
post :complete_account_setup
end
end
resources :snaptrade_items, only: [ :index, :new, :create, :show, :edit, :update, :destroy ] do
collection do
get :preload_accounts
get :select_accounts
post :link_accounts
get :select_existing_account
post :link_existing_account
get :callback
end
member do
post :sync
get :connect
get :setup_accounts
post :complete_account_setup
get :connections
delete :delete_connection
delete :delete_orphaned_user
end
end
# CoinStats routes
resources :coinstats_items, only: [ :index, :new, :create, :update, :destroy ] do
collection do
post :link_wallet
end
member do
post :sync
end
end
resources :enable_banking_items, only: [ :new, :create, :update, :destroy ] do
collection do
get :callback
post :link_accounts
get :select_existing_account
post :link_existing_account
end
member do
post :sync
get :select_bank
post :authorize
post :reauthorize
get :setup_accounts
post :complete_account_setup
post :new_connection
end
end
use_doorkeeper
# MFA routes
resource :mfa, controller: "mfa", only: [ :new, :create ] do
get :verify
post :verify, to: "mfa#verify_code"
delete :disable
end
mount Lookbook::Engine, at: "/design-system"
# Uses basic auth - see config/initializers/sidekiq.rb
mount Sidekiq::Web => "/sidekiq"
# AI chats
resources :chats do
resources :messages, only: :create
member do
post :retry
end
end
resources :family_exports, only: %i[new create index destroy] do
member do
get :download
end
end
get "changelog", to: "pages#changelog"
get "feedback", to: "pages#feedback"
patch "dashboard/preferences", to: "pages#update_preferences"
resource :current_session, only: %i[update]
resource :registration, only: %i[new create]
resources :sessions, only: %i[index new create destroy]
get "/auth/mobile/:provider", to: "sessions#mobile_sso_start"
match "/auth/:provider/callback", to: "sessions#openid_connect", via: %i[get post]
match "/auth/failure", to: "sessions#failure", via: %i[get post]
get "/auth/logout/callback", to: "sessions#post_logout"
resource :oidc_account, only: [] do
get :link, on: :collection
post :create_link, on: :collection
get :new_user, on: :collection
post :create_user, on: :collection
end
resource :password_reset, only: %i[new create edit update]
resource :password, only: %i[edit update]
resource :email_confirmation, only: :new
resources :users, only: %i[update destroy] do
delete :reset, on: :member
delete :reset_with_sample_data, on: :member
patch :rule_prompt_settings, on: :member
get :resend_confirmation_email, on: :member
end
resource :onboarding, only: :show do
collection do
get :preferences
get :goals
get :trial
end
end
namespace :settings do
resource :profile, only: [ :show, :destroy ]
resource :preferences, only: :show
resource :hosting, only: %i[show update] do
delete :clear_cache, on: :collection
delete :disconnect_external_assistant, on: :collection
end
resource :payment, only: :show
resource :security, only: :show
resources :sso_identities, only: :destroy
resource :api_key, only: [ :show, :new, :create, :destroy ]
resource :ai_prompts, only: :show
resource :llm_usage, only: :show
resource :guides, only: :show
resource :bank_sync, only: :show, controller: "bank_sync"
resource :providers, only: %i[show update]
end
resource :subscription, only: %i[new show create] do
collection do
get :upgrade
get :success
end
end
resources :tags, except: :show do
resources :deletions, only: %i[new create], module: :tag
delete :destroy_all, on: :collection
end
namespace :category do
resource :dropdown, only: :show
end
resources :categories, except: :show do
resources :deletions, only: %i[new create], module: :category
post :bootstrap, on: :collection
delete :destroy_all, on: :collection
end
resources :reports, only: %i[index] do
patch :update_preferences, on: :collection
get :export_transactions, on: :collection
get :google_sheets_instructions, on: :collection
get :print, on: :collection
end
resources :budgets, only: %i[index show edit update], param: :month_year do
get :picker, on: :collection
resources :budget_categories, only: %i[index show update]
end
resources :family_merchants, only: %i[index new create edit update destroy] do
collection do
get :merge
post :perform_merge
end
end
resources :transfers, only: %i[new create destroy show update]
resources :imports, only: %i[index new show create update destroy] do
member do
post :publish
put :revert
put :apply_template
end
resource :upload, only: %i[show update], module: :import
resource :configuration, only: %i[show update], module: :import
resource :clean, only: :show, module: :import
resource :confirm, only: :show, module: :import
resources :rows, only: %i[show update], module: :import
resources :mappings, only: :update, module: :import
end
resources :holdings, only: %i[index new show update destroy] do
member do
post :unlock_cost_basis
patch :remap_security
post :reset_security
end
end
resources :trades, only: %i[show new create update destroy] do
member do
post :unlock
end
end
resources :valuations, only: %i[show new create update destroy] do
post :confirm_create, on: :collection
post :confirm_update, on: :member
end
namespace :transactions do
resource :bulk_deletion, only: :create
resource :bulk_update, only: %i[new create]
end
resources :transactions, only: %i[index new create show update destroy] do
resource :transfer_match, only: %i[new create]
resource :category, only: :update, controller: :transaction_categories
collection do
delete :clear_filter
patch :update_preferences
end
member do
get :convert_to_trade
post :create_trade_from_transaction
post :mark_as_recurring
post :merge_duplicate
post :dismiss_duplicate
post :unlock
end
end
resources :recurring_transactions, only: %i[index destroy] do
collection do
match :identify, via: [ :get, :post ]
match :cleanup, via: [ :get, :post ]
patch :update_settings
end
member do
match :toggle_status, via: [ :get, :post ]
end
end
resources :accountable_sparklines, only: :show, param: :accountable_type
direct :entry do |entry, options|
if entry.new_record?
route_for entry.entryable_name.pluralize, options
else
route_for entry.entryable_name, entry, options
end
end
resources :rules, except: :show do
member do
get :confirm
post :apply
end
collection do
delete :destroy_all
get :confirm_all
post :apply_all
post :clear_ai_cache
end
end
resources :accounts, only: %i[index new show destroy], shallow: true do
member do
post :sync
get :sparkline
patch :toggle_active
get :select_provider
get :confirm_unlink
delete :unlink
end
collection do
post :sync_all
end
end
# Convenience routes for polymorphic paths
# Example: account_path(Account.new(accountable: Depository.new)) => /depositories/123
direct :edit_account do |model, options|
route_for "edit_#{model.accountable_name}", model, options
end
resources :depositories, only: %i[new create edit update]
resources :investments, only: %i[new create edit update]
resources :properties, only: %i[new create edit update] do
member do
get :balances
patch :update_balances
get :address
patch :update_address
end
end
resources :vehicles, only: %i[new create edit update]
resources :credit_cards, only: %i[new create edit update]
resources :loans, only: %i[new create edit update]
resources :cryptos, only: %i[new create edit update]
resources :other_assets, only: %i[new create edit update]
resources :other_liabilities, only: %i[new create edit update]
resources :securities, only: :index
resources :invite_codes, only: %i[index create destroy]
resources :invitations, only: [ :new, :create, :destroy ] do
get :accept, on: :member
end
# API routes
namespace :api do
namespace :v1 do
# Authentication endpoints
post "auth/signup", to: "auth#signup"
post "auth/login", to: "auth#login"
post "auth/refresh", to: "auth#refresh"
post "auth/sso_exchange", to: "auth#sso_exchange"
patch "auth/enable_ai", to: "auth#enable_ai"
# Production API endpoints
resources :accounts, only: [ :index, :show ]
resources :categories, only: [ :index, :show ]
resources :merchants, only: %i[index show]
resources :tags, only: %i[index show create update destroy]
resources :transactions, only: [ :index, :show, :create, :update, :destroy ]
resources :trades, only: [ :index, :show, :create, :update, :destroy ]
resources :holdings, only: [ :index, :show ]
resources :valuations, only: [ :create, :update, :show ]
resources :imports, only: [ :index, :show, :create ]
resource :usage, only: [ :show ], controller: :usage
post :sync, to: "sync#create"
resources :chats, only: [ :index, :show, :create, :update, :destroy ] do
resources :messages, only: [ :create ] do
post :retry, on: :collection
end
end
delete "users/reset", to: "users#reset"
delete "users/me", to: "users#destroy"
# Test routes for API controller testing (only available in test environment)
if Rails.env.test?
get "test", to: "test#index"
get "test_not_found", to: "test#not_found"
get "test_family_access", to: "test#family_access"
get "test_scope_required", to: "test#scope_required"
get "test_multiple_scopes_required", to: "test#multiple_scopes_required"
end
end
end
resources :currencies, only: %i[show]
resources :impersonation_sessions, only: [ :create ] do
post :join, on: :collection
delete :leave, on: :collection
member do
put :approve
put :reject
put :complete
end
end
resources :plaid_items, only: %i[new edit create destroy] do
collection do
get :select_existing_account
post :link_existing_account
end
member do
post :sync
end
end
resources :simplefin_items, only: %i[index new create show edit update destroy] do
collection do
get :select_existing_account
post :link_existing_account
end
member do
post :sync
post :balances
get :setup_accounts
post :complete_account_setup
end
end
resources :lunchflow_items, only: %i[index new create show edit update destroy] do
collection do
get :preload_accounts
get :select_accounts
post :link_accounts
get :select_existing_account
post :link_existing_account
end
member do
post :sync
get :setup_accounts
post :complete_account_setup
end
end
namespace :webhooks do
post "plaid"
post "plaid_eu"
post "stripe"
end
get "redis-configuration-error", to: "pages#redis_configuration_error"
# MCP server endpoint for external AI assistants (JSON-RPC 2.0)
post "mcp", to: "mcp#handle"
# Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
# Can be used by load balancers and uptime monitors to verify that the app is live.
get "up" => "rails/health#show", as: :rails_health_check
# Render dynamic PWA files from app/views/pwa/*
get "service-worker" => "rails/pwa#service_worker", as: :pwa_service_worker
get "manifest" => "rails/pwa#manifest", as: :pwa_manifest
get "imports/:import_id/upload/sample_csv", to: "import/uploads#sample_csv", as: :import_upload_sample_csv
privacy_url = ENV["LEGAL_PRIVACY_URL"].presence
terms_url = ENV["LEGAL_TERMS_URL"].presence
get "privacy", to: privacy_url ? redirect(privacy_url) : "pages#privacy"
get "terms", to: terms_url ? redirect(terms_url) : "pages#terms"
get "intro", to: "pages#intro"
# Admin namespace for super admin functionality
namespace :admin do
resources :sso_providers do
member do
patch :toggle
post :test_connection
end
end
resources :users, only: [ :index, :update ]
end
# Defines the root path route ("/")
root "pages#dashboard"
end