Personal finance AI (v1) (#2022)

* AI sidebar

* Add chat and message models with associations

* Implement AI chat functionality with sidebar and messaging system

- Add chat and messages controllers
- Create chat and message views
- Implement chat-related routes
- Add message broadcasting and user interactions
- Update application layout to support chat sidebar
- Enhance user model with initials method

* Refactor AI sidebar with enhanced chat menu and interactions

- Update sidebar layout with dynamic width and improved responsiveness
- Add new chat menu Stimulus controller for toggling between chat and chat list views
- Improve chat list display with recent chats and empty state
- Extract AI avatar to a partial for reusability
- Enhance message display and interaction styling
- Add more contextual buttons and interaction hints

* Improve chat scroll behavior and message styling

- Refactor chat scroll functionality with Stimulus controller
- Optimize message scrolling in chat views
- Update message styling for better visual hierarchy
- Enhance chat container layout with flex and auto-scroll
- Simplify message rendering across different chat views

* Extract AI avatar to a shared partial for consistent styling

- Refactor AI avatar rendering across chat views
- Replace hardcoded avatar markup with a reusable partial
- Simplify avatar display in chats and messages views

* Update sidebar controller to handle right panel width dynamically

- Add conditional width class for right sidebar panel
- Ensure consistent sidebar toggle behavior for both left and right panels
- Use specific width class for right panel (w-[375px])

* Refactor chat form and AI greeting with flexible partials

- Extract message form to a reusable partial with dynamic context support
- Create flexible AI greeting partial for consistent welcome messages
- Simplify chat and sidebar views by leveraging new partials
- Add support for different form scenarios (chat, new chat, sidebar)
- Improve code modularity and reduce duplication

* Add chat clearing functionality with dynamic menu options

- Implement clear chat action in ChatsController
- Add clear chat route to support clearing messages
- Update AI sidebar with dropdown menu for chat actions
- Preserve system message when clearing chat
- Enhance chat interaction with new menu options

* Add frontmatter to project structure documentation

- Create initial frontmatter for structure.mdc file
- Include description and configuration options
- Prepare for potential dynamic documentation rendering

* Update general project rules with additional guidelines

- Add rule for using `Current.family` instead of `current_family`
- Include new guidelines for testing, API routes, and solution approach
- Expand project-specific rules for more consistent development practices

* Add OpenAI gem and AI-friendly data representations

- Add `ruby-openai` gem for AI integration
- Implement `to_ai_readable_hash` methods in BalanceSheet and IncomeStatement
- Include Promptable module in both models
- Add savings rate calculation method in IncomeStatement
- Prepare financial models for AI-powered insights and interactions

* Enhance AI Financial Assistant with Advanced Querying and Debugging Capabilities

- Implement comprehensive AI financial query system with function-based interactions
- Add detailed debug logging for AI responses and function calls
- Extend BalanceSheet and IncomeStatement models with AI-friendly methods
- Create robust error handling and fallback mechanisms for AI queries
- Update chat and message views to support debug mode and enhanced rendering
- Add AI query routes and initial test coverage for financial assistant

* Refactor AI sidebar and chat layout with improved structure and comments

- Remove inline AI chat from application layout
- Enhance AI sidebar with more semantic HTML structure
- Add descriptive comments to clarify different sections of chat view
- Improve flex layout and scrolling behavior in chat messages container
- Optimize message rendering with more explicit class names and structure

* Add Markdown rendering support for AI chat messages

- Implement `markdown` helper method in ApplicationHelper using Redcarpet
- Update message view to render AI messages with Markdown formatting
- Add comprehensive Markdown rendering options (tables, code blocks, links)
- Enhance AI Financial Assistant prompt to encourage Markdown usage
- Remove commented Markdown CSS in Tailwind application stylesheet

* Missing comma

* Enhance AI response processing with chat history context

* Improve AI debug logging with payload size limits and internal message flag

* Enhance AI chat interaction with improved thinking indicator and scrolling behavior

* Add AI consent and enable/disable functionality for AI chat

* Upgrade Biome and refactor JavaScript template literals

- Update @biomejs/biome to latest version with caret (^) notation
- Refactor AI query and chat controllers to use template literals
- Standardize npm scripts formatting in package.json

* Add beta testing usage note to AI consent modal

* Update test fixtures and configurations for AI chat functionality

- Add family association to chat fixtures and tests
- Set consistent password digest for test users
- Enable AI for test users
- Add OpenAI access token for test environment
- Update chat and user model tests to include family context

* Simplify data model and get tests passing

* Remove structure.mdc from version control

* Integrate AI chat styles into existing prose pattern

* Match Figma design spec, implement Turbo frames and actions for chats controller

* AI rules refresh

* Consolidate Stimulus controllers, thinking state, controllers, and views

* Naming, domain alignment

* Reset migrations

* Improve data model to support tool calls and message types

* Tool calling tests and fixtures

* Tool call implementation and test

* Get assistant test working again

* Test updates

* Process tool calls within provider

* Chat UI back to working state again

* Remove stale code

* Tests passing

* Update openai class naming to avoid conflicts

* Reconfigure test env

* Rebuild gemfile

* Fix naming conflicts for ChatResponse

* Message styles

* Use OpenAI conversation state management

* Assistant function base implementation

* Add back thinking messages, clean up error handling for chat

* Fix sync error when security price has bad data from provider

* Add balance sheet function to assistant

* Add better function calling error visibility

* Add income statement function

* Simplify and clean up "thinking" interactions with Turbo frames

* Remove stale data definitions from functions

* Ensure VCR fixtures working with latest code

* basic stream implementation

* Get streaming working

* Make AI sidebar wider when left sidebar is collapsed

* Get tests working with streaming responses

* Centralize provider error handling

* Provider data boundaries

---------

Co-authored-by: Josh Pigford <josh@joshpigford.com>

app/controllers/application_controller.rb

@@ -1,10 +1,11 @@
 class ApplicationController < ActionController::Base
-  include Onboardable, Localize, AutoSync, Authentication, Invitable, SelfHostable, StoreLocation, Impersonatable, Breadcrumbable
+  include Onboardable, Localize, AutoSync, Authentication, Invitable, SelfHostable, StoreLocation, Impersonatable, Breadcrumbable, FeatureGuardable
   include Pagy::Backend
 
   helper_method :require_upgrade?, :subscription_pending?
 
   before_action :detect_os
+  before_action :set_default_chat
 
   private
     def require_upgrade?
@@ -33,4 +34,10 @@ class ApplicationController < ActionController::Base
       else ""
       end
     end
+
+    # By default, we show the user the last chat they interacted with
+    def set_default_chat
+      @last_viewed_chat = Current.user&.last_viewed_chat
+      @chat = @last_viewed_chat
+    end
 end

app/controllers/chats_controller.rb

@@ -0,0 +1,67 @@
+class ChatsController < ApplicationController
+  include ActionView::RecordIdentifier
+
+  guard_feature unless: -> { Current.user.ai_enabled? }
+
+  before_action :set_chat, only: [ :show, :edit, :update, :destroy ]
+
+  def index
+    @chat = nil # override application_controller default behavior of setting @chat to last viewed chat
+    @chats = Current.user.chats.order(created_at: :desc)
+  end
+
+  def show
+    set_last_viewed_chat(@chat)
+  end
+
+  def new
+    @chat = Current.user.chats.new(title: "New chat #{Time.current.strftime("%Y-%m-%d %H:%M")}")
+  end
+
+  def create
+    @chat = Current.user.chats.start!(chat_params[:content], model: chat_params[:ai_model])
+    set_last_viewed_chat(@chat)
+    redirect_to chat_path(@chat, thinking: true)
+  end
+
+  def edit
+  end
+
+  def update
+    @chat.update!(chat_params)
+
+    respond_to do |format|
+      format.html { redirect_back_or_to chat_path(@chat), notice: "Chat updated" }
+      format.turbo_stream { render turbo_stream: turbo_stream.replace(dom_id(@chat, :title), partial: "chats/chat_title", locals: { chat: @chat }) }
+    end
+  end
+
+  def destroy
+    @chat.destroy
+    clear_last_viewed_chat
+
+    redirect_to chats_path, notice: "Chat was successfully deleted"
+  end
+
+  def retry
+    @chat.retry_last_message!
+    redirect_to chat_path(@chat, thinking: true)
+  end
+
+  private
+    def set_chat
+      @chat = Current.user.chats.find(params[:id])
+    end
+
+    def set_last_viewed_chat(chat)
+      Current.user.update!(last_viewed_chat: chat)
+    end
+
+    def clear_last_viewed_chat
+      Current.user.update!(last_viewed_chat: nil)
+    end
+
+    def chat_params
+      params.require(:chat).permit(:title, :content, :ai_model)
+    end
+end

app/controllers/concerns/feature_guardable.rb

@@ -0,0 +1,23 @@
+# Simple feature guard that renders a 403 Forbidden status with a message
+# when the feature is disabled.
+#
+# Example:
+#
+# class MessagesController < ApplicationController
+#   guard_feature unless: -> { Current.user.ai_enabled? }
+# end
+#
+module FeatureGuardable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def guard_feature(**options)
+      before_action :guard_feature, **options
+    end
+  end
+
+  private
+    def guard_feature
+      render plain: "Feature disabled: #{controller_name}##{action_name}", status: :forbidden
+    end
+end

app/controllers/messages_controller.rb

@@ -0,0 +1,24 @@
+class MessagesController < ApplicationController
+  guard_feature unless: -> { Current.user.ai_enabled? }
+
+  before_action :set_chat
+
+  def create
+    @message = UserMessage.create!(
+      chat: @chat,
+      content: message_params[:content],
+      ai_model: message_params[:ai_model]
+    )
+
+    redirect_to chat_path(@chat, thinking: true)
+  end
+
+  private
+    def set_chat
+      @chat = Current.user.chats.find(params[:chat_id])
+    end
+
+    def message_params
+      params.require(:message).permit(:content, :ai_model)
+    end
+end

app/controllers/pages_controller.rb

@@ -10,7 +10,7 @@ class PagesController < ApplicationController
   end
 
   def changelog
-    @release_notes = Providers.github.fetch_latest_release_notes
+    @release_notes = github_provider.fetch_latest_release_notes
 
     render layout: "settings"
   end
@@ -26,4 +26,9 @@ class PagesController < ApplicationController
     @invite_code = InviteCode.order("RANDOM()").limit(1).first
     render layout: false
   end
+
+  private
+    def github_provider
+      Provider::Registry.get_provider(:github)
+    end
 end

app/controllers/settings/hostings_controller.rb

@@ -1,11 +1,13 @@
 class Settings::HostingsController < ApplicationController
   layout "settings"
 
-  before_action :raise_if_not_self_hosted
+  guard_feature unless: -> { self_hosted? }
+
   before_action :ensure_admin, only: :clear_cache
 
   def show
-    @synth_usage = Providers.synth&.usage
+    synth_provider = Provider::Registry.get_provider(:synth)
+    @synth_usage = synth_provider&.usage
   end
 
   def update
@@ -37,10 +39,6 @@ class Settings::HostingsController < ApplicationController
       params.require(:setting).permit(:require_invite_for_signup, :require_email_confirmation, :synth_api_key)
     end
 
-    def raise_if_not_self_hosted
-      raise "Settings not available on non-self-hosted instance" unless self_hosted?
-    end
-
     def ensure_admin
       redirect_to settings_hosting_path, alert: t(".not_authorized") unless Current.user.admin?
     end

app/controllers/users_controller.rb

@@ -17,11 +17,19 @@ class UsersController < ApplicationController
         redirect_to settings_profile_path, alert: error_message
       end
     else
+      was_ai_enabled = @user.ai_enabled
       @user.update!(user_params.except(:redirect_to, :delete_profile_image))
       @user.profile_image.purge if should_purge_profile_image?
 
+      # Add a special notice if AI was just enabled
+      notice = if !was_ai_enabled && @user.ai_enabled
+        "AI Assistant has been enabled successfully."
+      else
+        t(".success")
+      end
+
       respond_to do |format|
-        format.html { handle_redirect(t(".success")) }
+        format.html { handle_redirect(notice) }
         format.json { head :ok }
       end
     end
@@ -66,7 +74,7 @@ class UsersController < ApplicationController
 
     def user_params
       params.require(:user).permit(
-        :first_name, :last_name, :email, :profile_image, :redirect_to, :delete_profile_image, :onboarded_at, :show_sidebar, :default_period,
+        :first_name, :last_name, :email, :profile_image, :redirect_to, :delete_profile_image, :onboarded_at, :show_sidebar, :default_period, :show_ai_sidebar, :ai_enabled,
         family_attributes: [ :name, :currency, :country, :locale, :date_format, :timezone, :id, :data_enrichment_enabled ]
       )
     end