layered-assistant-rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c09f437cf1d50e987e065bab63c5a974c569511d6095a09e0fb5e3072119d08b
-  data.tar.gz: 24476722cc3bf5d342cd308974e0fb888f059fd838cb406215e6772211dde587
+  metadata.gz: 0c6156a26192a7edd3fcb67ac5a170aa88ed8b52d2e673787d5595f05c420fbd
+  data.tar.gz: 79ec02dbdf134098f5ddb28d6dc480d626a27d35abb1151e1b6712e5496f09c9
 SHA512:
-  metadata.gz: f26719babe3ba1885f3f96021f5900d202d9aa4ba70353477f6559ac8b04871a5d7bd24d81be0cd3b93866bf8d3e2d7cb83c5fab3b354c618e45555fe96476d4
-  data.tar.gz: 25fcf070c6222f1fca1234939f7f283cdabe0fd232ea407c704c2a8f270ae9ac2caaf57fb775f7d35a15d83c4c3a5921d616a847adf200190c5ecaf4e2bf5017
+  metadata.gz: 3e09ac245b3bbbbb14c7e73540c6bd91d215323de65957b4452d797a6d5e23ddeb03b8fef7da870b781a75b1e18ebd29592563c06eacd3ea1038e7e6aa415447
+  data.tar.gz: a7ce50cbdba541810656dfd56fd660a435bb4d6b87b3f77fa50818c65374db059f7a5ba4d1aa5e2c1e2011efc8e4db706e1579ff9e9ea12c11bc68b2a438d3b3

data/AGENTS.md

@@ -53,7 +53,7 @@ It has its own `AGENTS.md` file — inspect it for context on the apps's convent
 
 ## Conventions
 
-- Use "layered-ui-assistant" not "Layered UI" when referring to the project
+- Use "layered-assistant-rails" not "Layered Assistant Rails" when referring to the project
 - Use normal dashes '-' not long ones '—'
 - Locale: Favour en-GB (British English), unless terms are defined by technical standards (e.g. LICENSE, COLOR).
 - Titles: capitalise first word only (e.g. "This title")

data/README.md

@@ -102,6 +102,40 @@ The `l_assistant_accessible?` helper evaluates the authorize block without side
 <% end %>
 ```
 
+## Record scoping
+
+By default, all records are visible to any authorised user. If your application is multi-tenant or you need to restrict which records a user can see, configure a `scope` block in the initialiser.
+
+The block receives the model class, runs in controller context, and must return an `ActiveRecord::Relation`. The following models are passed through the scope block:
+
+| Model | Description |
+|---|---|
+| `Layered::Assistant::Conversation` | User conversations (has polymorphic `owner`) |
+| `Layered::Assistant::Assistant` | Assistant configurations (has polymorphic `owner`) |
+| `Layered::Assistant::Provider` | API provider credentials (has polymorphic `owner`) |
+
+### Scope all owned resources to the current user
+
+```ruby
+Layered::Assistant.scope do |model_class|
+  model_class.where(owner: current_user)
+end
+```
+
+### Scope conversations only
+
+```ruby
+Layered::Assistant.scope do |model_class|
+  if model_class == Layered::Assistant::Conversation
+    model_class.where(owner: current_user)
+  else
+    model_class.all
+  end
+end
+```
+
+When no scope block is configured, queries are unscoped. Record-level access control is the host application's responsibility; the scope block is the integration point for it.
+
 ## Panel helpers
 
 The engine provides two convenience helpers for wiring the layered-ui panel to the assistant. Use them inside `content_for` blocks in your application layout:
@@ -131,12 +165,22 @@ Both helpers accept keyword arguments that are forwarded as HTML attributes to t
 
 ## Configuration
 
-### Environment Variables
+Optional settings can be added to your initialiser (`config/initializers/layered_assistant.rb`):
+
+```ruby
+# Log API errors to stdout (default: false)
+Layered::Assistant.log_errors = true
+
+# Total timeout in seconds for API requests, including the full streaming response (default: 210).
+# Increase for models with high max_tokens limits or slow providers.
+Layered::Assistant.api_request_timeout = 210
+
+# Disable Active Record Encryption on Provider#secret.
+# Only use this in development/test environments without encryption keys configured.
+Layered::Assistant.skip_db_encryption = true
+```
 
-| Variable | Default | Description |
-|---|---|---|
-| `LAYERED_ASSISTANT_DANGEROUSLY_SKIP_DB_ENCRYPTION` | `nil` | Set to `"yes"` to skip Active Record Encryption on `Provider#secret`. Only for development/test environments without encryption keys configured |
-| `LAYERED_ASSISTANT_LOG_ERRORS` | `nil` | Set to `"yes"` to enable error logging from the AI API clients |
+Note: `skip_db_encryption` is read at class load time, so it must be set before `Layered::Assistant::Provider` is first loaded. A standard Rails initialiser satisfies this requirement.
 
 ## Demo
 

data/app/controllers/concerns/layered/assistant/message_creation.rb

@@ -15,10 +15,7 @@ module Layered
         return { message: message } unless message.persisted?
 
         conversation.update_name_from_content!(content)
-        message.broadcast_created
 
-        models = Model.available
-        selected_model_id = model_id
         assistant_message = nil
         error = nil
 
@@ -28,8 +25,9 @@ module Layered
             content: nil,
             model_id: model_id
           )
-          assistant_message.broadcast_created
 
+          message.broadcast_created
+          assistant_message.broadcast_created
           Messages::ResponseJob.perform_later(assistant_message.id)
         rescue => e
           Rails.logger.error("Assistant response failed: #{e.message}")
@@ -39,8 +37,6 @@ module Layered
         {
           message: message,
           assistant_message: assistant_message,
-          models: models,
-          selected_model_id: selected_model_id,
           error: error
         }
       end

data/app/controllers/concerns/layered/assistant/public/session_conversations.rb

@@ -6,41 +6,40 @@ module Layered
 
         private
 
-        def session_conversation_ids
-          session[:layered_assistant_conversation_ids] ||= []
+        def session_conversation_uids
+          session[:layered_assistant_conversation_uids] ||= []
         end
 
         MAX_SESSION_CONVERSATIONS = 50
 
         def add_conversation_to_session(conversation)
-          ids = session_conversation_ids
-          ids << conversation.id unless ids.include?(conversation.id)
-          ids.shift while ids.size > MAX_SESSION_CONVERSATIONS
+          uids = session_conversation_uids
+          uids << conversation.uid unless uids.include?(conversation.uid)
+          uids.shift while uids.size > MAX_SESSION_CONVERSATIONS
         end
 
-        def find_session_conversation(id)
-          id = id.to_i
-          unless session_conversation_ids.include?(id)
+        def find_session_conversation(uid)
+          unless session_conversation_uids.include?(uid)
             raise ActiveRecord::RecordNotFound, "Conversation not found in session"
           end
 
-          Conversation.joins(:assistant).merge(Assistant.publicly_available).find(id)
+          Conversation.joins(:assistant).merge(Assistant.publicly_available).find_by!(uid: uid)
         rescue ActiveRecord::RecordNotFound
-          remove_conversation_from_session(id)
+          remove_conversation_from_session(uid)
           raise
         end
 
-        def remove_conversation_from_session(id)
-          session_conversation_ids.delete(id.to_i)
+        def remove_conversation_from_session(uid)
+          session_conversation_uids.delete(uid)
         end
 
         def existing_session_conversation_for(assistant)
-          return nil if session_conversation_ids.empty?
+          return nil if session_conversation_uids.empty?
 
           Conversation
             .joins(:assistant)
             .merge(Assistant.publicly_available)
-            .where(id: session_conversation_ids, assistant: assistant)
+            .where(uid: session_conversation_uids, assistant: assistant)
             .order(created_at: :desc)
             .first
         end

data/app/controllers/layered/assistant/application_controller.rb

@@ -20,6 +20,18 @@ module Layered
 
         instance_exec(&block)
       end
+
+      def scoped(model_class)
+        block = Layered::Assistant.scope_block
+        return model_class.all unless block
+
+        result = instance_exec(model_class, &block)
+        unless result.is_a?(ActiveRecord::Relation)
+          raise ArgumentError,
+            "Layered::Assistant.scope must return an ActiveRecord::Relation, got #{result.class}"
+        end
+        result
+      end
     end
   end
 end

data/app/controllers/layered/assistant/assistants_controller.rb

@@ -6,7 +6,7 @@ module Layered
 
       def index
         @page_title = "Assistants"
-        @pagy, @assistants = pagy(Assistant.by_name)
+        @pagy, @assistants = pagy(scoped(Assistant).by_name)
       end
 
       def new
@@ -44,7 +44,7 @@ module Layered
       private
 
       def set_assistant
-        @assistant = Assistant.find(params[:id])
+        @assistant = scoped(Assistant).find(params[:id])
       end
 
       def set_models

data/app/controllers/layered/assistant/conversations_controller.rb

@@ -8,12 +8,12 @@ module Layered
 
       def index
         if params[:assistant_id]
-          @assistant = Assistant.find(params[:assistant_id])
+          @assistant = scoped(Assistant).find(params[:assistant_id])
           @page_title = "Conversations - #{@assistant.name}"
-          @pagy, @conversations = pagy(@assistant.conversations.includes(:owner).by_created_at)
+          @pagy, @conversations = pagy(@assistant.conversations.merge(scoped(Conversation)).includes(:owner).by_created_at)
         else
           @page_title = "Conversations"
-          @pagy, @conversations = pagy(Conversation.includes(:assistant, :owner).by_created_at)
+          @pagy, @conversations = pagy(scoped(Conversation).includes(:assistant, :owner).by_created_at)
         end
       end
 
@@ -60,11 +60,11 @@ module Layered
       private
 
       def set_conversation
-        @conversation = Conversation.find(params[:id])
+        @conversation = scoped(Conversation).find_by!(uid: params[:id])
       end
 
       def set_assistants
-        @assistants = Assistant.by_name
+        @assistants = scoped(Assistant).by_name
       end
 
       def conversation_params

data/app/controllers/layered/assistant/messages_controller.rb

@@ -8,7 +8,7 @@ module Layered
 
       def index
         @page_title = "Messages"
-        @pagy, @messages = pagy(@conversation.messages.by_created_at)
+        @pagy, @messages = pagy(@conversation.messages.includes(:model).by_created_at)
       end
 
       def create
@@ -24,8 +24,8 @@ module Layered
         end
 
         @assistant_message = result[:assistant_message]
-        @models = result[:models]
-        @selected_model_id = result[:selected_model_id]
+        @models = Model.available
+        @selected_model_id = message_params[:model_id]
         @error = result[:error]
 
         respond_to do |format|
@@ -42,7 +42,7 @@ module Layered
       private
 
       def set_conversation
-        @conversation = Conversation.find(params[:conversation_id])
+        @conversation = scoped(Conversation).find_by!(uid: params[:conversation_id])
       end
 
       def set_message

data/app/controllers/layered/assistant/models_controller.rb

@@ -46,7 +46,7 @@ module Layered
       private
 
       def set_provider
-        @provider = Provider.find(params[:provider_id])
+        @provider = scoped(Provider).find(params[:provider_id])
       end
 
       def set_model

data/app/controllers/layered/assistant/panel/conversations_controller.rb

@@ -42,15 +42,15 @@ module Layered
         private
 
         def set_conversation
-          @conversation = Conversation.find(params[:id])
+          @conversation = scoped(Conversation).find_by!(uid: params[:id])
         end
 
         def set_assistants
-          @assistants = Assistant.by_name
+          @assistants = scoped(Assistant).by_name
         end
 
         def set_conversations
-          scope = Conversation.by_created_at
+          scope = scoped(Conversation).by_created_at
           scope = scope.where(assistant_id: params[:assistant_id]) if params[:assistant_id].present?
           @conversations = scope.limit(20)
         end

data/app/controllers/layered/assistant/panel/messages_controller.rb

@@ -20,8 +20,8 @@ module Layered
           end
 
           @assistant_message = result[:assistant_message]
-          @models = result[:models]
-          @selected_model_id = result[:selected_model_id]
+          @models = Model.available
+          @selected_model_id = message_params[:model_id]
           @error = result[:error]
 
           respond_to do |format|
@@ -32,7 +32,7 @@ module Layered
         private
 
         def set_conversation
-          @conversation = Conversation.find(params[:conversation_id])
+          @conversation = scoped(Conversation).find_by!(uid: params[:conversation_id])
         end
 
         def message_params

data/app/controllers/layered/assistant/providers_controller.rb

@@ -5,7 +5,7 @@ module Layered
 
       def index
         @page_title = "Providers"
-        @pagy, @providers = pagy(Provider.sorted)
+        @pagy, @providers = pagy(scoped(Provider).sorted)
       end
 
       def new
@@ -44,7 +44,7 @@ module Layered
       private
 
       def set_provider
-        @provider = Provider.find(params[:id])
+        @provider = scoped(Provider).find(params[:id])
       end
 
       def provider_params

data/app/controllers/layered/assistant/public/assistants_controller.rb

@@ -9,6 +9,9 @@ module Layered
         end
 
         def show
+          conversation = @assistant.conversations.create!(name: Conversation.default_name)
+          add_conversation_to_session(conversation)
+          redirect_to layered_assistant.public_conversation_path(conversation)
         end
       end
     end

data/app/controllers/layered/assistant/public/conversations_controller.rb

@@ -20,6 +20,14 @@ module Layered
 
         def show
           @messages = @conversation.messages.includes(:model).by_created_at
+          @conversations = if session_conversation_uids.any?
+            Conversation.joins(:assistant).merge(Assistant.publicly_available)
+              .where(uid: session_conversation_uids, assistant: @conversation.assistant)
+              .by_created_at
+              .limit(20)
+          else
+            Conversation.none
+          end
         end
 
         private

data/app/controllers/layered/assistant/public/panel/conversations_controller.rb

@@ -36,7 +36,7 @@ module Layered
           def set_conversation
             @conversation = find_session_conversation(params[:id])
           rescue ActiveRecord::RecordNotFound
-            assistant = Conversation.find_by(id: params[:id])&.assistant
+            assistant = Conversation.find_by(uid: params[:id])&.assistant
             if assistant&.public?
               redirect_to layered_assistant.public_panel_conversations_path(assistant_id: assistant.id)
             else
@@ -46,9 +46,9 @@ module Layered
 
           def set_session_conversations
             assistant_id = @conversation&.assistant_id || @assistant&.id
-            @conversations = if session_conversation_ids.any?
+            @conversations = if session_conversation_uids.any?
               scope = Conversation.joins(:assistant).merge(Assistant.publicly_available)
-                .where(id: session_conversation_ids)
+                .where(uid: session_conversation_uids)
                 .by_created_at
               scope = scope.where(assistant_id: assistant_id) if assistant_id
               scope.limit(20)

data/app/controllers/layered/assistant/public/panel/messages_controller.rb

@@ -32,7 +32,7 @@ module Layered
           def set_conversation
             @conversation = find_session_conversation(params[:conversation_id])
           rescue ActiveRecord::RecordNotFound
-            assistant = Conversation.find_by(id: params[:conversation_id])&.assistant
+            assistant = Conversation.find_by(uid: params[:conversation_id])&.assistant
             if assistant&.public?
               redirect_to layered_assistant.new_public_panel_conversation_path(assistant_id: assistant.id)
             else

data/app/helpers/layered/assistant/access_helper.rb

@@ -31,11 +31,11 @@ module Layered
         private
 
         def method_missing(method, ...)
-          @context.send(method, ...)
+          @context.public_send(method, ...)
         end
 
         def respond_to_missing?(method, include_private = false)
-          @context.respond_to?(method, include_private)
+          @context.respond_to?(method, false)
         end
       end
 

data/app/helpers/layered/assistant/messages_helper.rb

@@ -15,6 +15,23 @@ module Layered
 
       ALLOWED_ATTRIBUTES = %w[href title class].freeze
 
+      MIN_RESPONSE_MS_FOR_TPS = 100
+
+      def message_metadata_title(message)
+        total_tokens = message.input_tokens.to_i + message.output_tokens.to_i
+        parts = []
+        if total_tokens > 0
+          prefix = message.tokens_estimated? ? "~" : ""
+          parts << "#{prefix}#{number_with_delimiter(total_tokens)} tokens"
+        end
+        if message.output_tokens.to_i > 0 && message.response_ms.to_i >= MIN_RESPONSE_MS_FOR_TPS
+          tps = (message.output_tokens * 1000.0 / message.response_ms).round(1)
+          parts << "#{tps} tok/s"
+        end
+        parts << "#{message.ttft_ms}ms TTFT" if message.ttft_ms
+        parts.join(" · ")
+      end
+
       def render_message_content(message)
         return if message.content.blank?
 
@@ -24,7 +41,7 @@ module Layered
           syntax_highlighter: nil
         ).to_html
 
-        sanitize(html, tags: ALLOWED_TAGS, attributes: ALLOWED_ATTRIBUTES).html_safe
+        sanitize(html, tags: ALLOWED_TAGS, attributes: ALLOWED_ATTRIBUTES)
       end
 
       private

data/app/javascript/layered_assistant/composer_controller.js

@@ -107,6 +107,9 @@ export default class extends Controller {
   _resetRespondingTimeout() {
     if (!this.respondingValue) return
     clearTimeout(this._respondingTimeout)
-    this._respondingTimeout = setTimeout(() => { this.respondingValue = false }, 60000)
+    this._respondingTimeout = setTimeout(() => {
+      this.respondingValue = false
+      document.dispatchEvent(new CustomEvent("assistant:response-timeout"))
+    }, 30000)
   }
 }

data/app/javascript/layered_assistant/conversation_select_controller.js

@@ -0,0 +1,8 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  navigate(event) {
+    const value = event.target.value
+    if (value) Turbo.visit(value)
+  }
+}

data/app/javascript/layered_assistant/index.js

@@ -1,11 +1,13 @@
 import { application } from "controllers/application"
 import ComposerController from "layered_assistant/composer_controller"
+import ConversationSelectController from "layered_assistant/conversation_select_controller"
 import MessagesController from "layered_assistant/messages_controller"
 import PanelController from "layered_assistant/panel_controller"
 import PanelNavController from "layered_assistant/panel_nav_controller"
 import ProviderTemplateController from "layered_assistant/provider_template_controller"
 
 application.register("composer", ComposerController)
+application.register("conversation-select", ConversationSelectController)
 application.register("messages", MessagesController)
 application.register("panel", PanelController)
 application.register("panel-nav", PanelNavController)

data/app/javascript/layered_assistant/messages_controller.js

@@ -9,14 +9,29 @@ export default class extends Controller {
     this._userInitiated = false
 
     this._markUser = () => { this._userInitiated = true }
+    this._onTimeout = () => {
+      this.listTarget.querySelectorAll(".l-ui-typing-indicator").forEach(el => {
+        const body = el.closest(".l-ui-message__body")
+        el.remove()
+        if (body && body.children.length === 0) {
+          body.insertAdjacentHTML("beforeend", '<div class="l-ui-notice--error" role="status">The response could not be completed.</div>')
+        }
+      })
+    }
     this.element.addEventListener("wheel", this._markUser, { passive: true })
     this.element.addEventListener("touchmove", this._markUser, { passive: true })
     this.element.addEventListener("scroll", this._onScroll, { passive: true })
+    document.addEventListener("assistant:response-timeout", this._onTimeout)
 
     this.scrollToBottom()
 
-    this.observer = new MutationObserver(() => {
+    this.observer = new MutationObserver((mutations) => {
       if (this._pinned) this.scrollToBottom()
+
+      const hasNewChildren = mutations.some(m =>
+        m.type === "childList" && m.target === this.listTarget && m.addedNodes.length > 0
+      )
+      if (hasNewChildren) this._sortMessages()
     })
     this.observer.observe(this.listTarget, { childList: true, subtree: true })
   }
@@ -25,6 +40,7 @@ export default class extends Controller {
     this.element.removeEventListener("wheel", this._markUser)
     this.element.removeEventListener("touchmove", this._markUser)
     this.element.removeEventListener("scroll", this._onScroll)
+    document.removeEventListener("assistant:response-timeout", this._onTimeout)
     this.observer.disconnect()
   }
 
@@ -59,4 +75,18 @@ export default class extends Controller {
   isNearBottom() {
     return this.element.scrollHeight - this.element.scrollTop - this.element.clientHeight <= 32
   }
+
+  _sortMessages() {
+    const children = Array.from(this.listTarget.children)
+    const sorted = children.slice().sort((a, b) => {
+      const aTime = parseInt(a.dataset.createdAt || "0", 10)
+      const bTime = parseInt(b.dataset.createdAt || "0", 10)
+      return aTime - bTime
+    })
+    if (sorted.some((el, i) => el !== children[i])) {
+      this.observer.disconnect()
+      sorted.forEach(el => this.listTarget.appendChild(el))
+      this.observer.observe(this.listTarget, { childList: true, subtree: true })
+    }
+  }
 }

data/app/jobs/layered/assistant/messages/response_job.rb

@@ -22,6 +22,7 @@ module Layered
           end
 
           begin
+            chunk_service.mark_started!
             ClientService.new.call(message: message, stream_proc: stream_proc)
           rescue => e
             Rails.logger.error("Response generation failed: #{e.message}")

data/app/models/layered/assistant/conversation.rb

@@ -17,6 +17,10 @@ module Layered
       scope :by_name, -> { order(name: :asc, created_at: :desc) }
       scope :by_created_at, -> { order(created_at: :desc) }
 
+      def to_param
+        uid
+      end
+
       # Name
       def update_token_totals!
         input = messages.sum(:input_tokens)
@@ -29,15 +33,24 @@ module Layered
       end
 
       def stop_response!
-        message = messages.where(role: :assistant, stopped: false).order(created_at: :desc).first
-        return false unless message
+        with_lock do
+          message = messages.where(role: :assistant, stopped: false).order(created_at: :desc).first
+          return false unless message
+
+          attrs = {
+            stopped: true,
+            output_tokens: TokenEstimator.estimate(message.content) || 0,
+            tokens_estimated: true
+          }
 
-        message.with_lock do
-          return false if message.stopped?
+          if message.input_tokens.nil?
+            prior_content = messages.where("created_at < ?", message.created_at).pluck(:content).compact.join(" ")
+            attrs[:input_tokens] = TokenEstimator.estimate(prior_content) || 0
+          end
 
-          estimated = TokenEstimator.estimate(message.content) || 0
-          message.update!(stopped: true, output_tokens: estimated, tokens_estimated: true)
+          message.update!(attrs)
           update_token_totals!
+          message.reload
           message.broadcast_updated
           message.broadcast_response_complete
         end

data/app/models/layered/assistant/message.rb

@@ -22,7 +22,7 @@ module Layered
       belongs_to :model, optional: true, counter_cache: true
 
       # Scopes
-      scope :by_created_at, -> { order(created_at: :asc) }
+      scope :by_created_at, -> { order(created_at: :asc, id: :asc) }
 
       # Broadcasting
       def broadcast_created

data/app/models/layered/assistant/provider.rb

@@ -13,12 +13,12 @@ module Layered
 
       # Enums
       enum :protocol, {
-        anthropic: "Anthropic",
-        openai: "OpenAI"
+        anthropic: "anthropic",
+        openai: "openai"
       }
 
       # Encryption
-      unless ENV["LAYERED_ASSISTANT_DANGEROUSLY_SKIP_DB_ENCRYPTION"] == "yes"
+      unless Layered::Assistant.skip_db_encryption
         encrypts :secret
       end