livechat 0.7.1 → 0.8.0

data/app/views/livechat/conversations/index.html.erb

@@ -1,105 +1,107 @@
 <% content_for :body_class, 'lvc-inbox' %>
 
-<h1><%= t('livechat.dashboard.title', default: 'LiveChat') %></h1>
+<%= render layout: 'livechat/shared/dashboard' do %>
+  <h1><%= t('livechat.dashboard.title', default: 'LiveChat') %></h1>
 
-<div class="inbox-shell <%= 'has-selected' if @selected_conversation %>">
-  <aside class="inbox-sidebar" aria-label="<%= t('livechat.dashboard.conversations', default: 'Conversations') %>">
-    <div class="tabs">
-      <% Livechat::Conversation::STATUSES.each do |status| %>
-        <%= link_to conversations_path(status: status, q: @query), class: ('active' if @status == status) do %>
-          <%= t("livechat.statuses.#{status}", default: status.humanize) %>
-          <span class="count"><%= @counts.fetch(status, 0) %></span>
+  <div class="inbox-shell <%= 'has-selected' if @selected_conversation %>">
+    <aside class="inbox-sidebar" aria-label="<%= t('livechat.dashboard.conversations', default: 'Conversations') %>">
+      <div class="tabs">
+        <% Livechat::Conversation::STATUSES.each do |status| %>
+          <%= link_to conversations_path(status: status, q: @query), class: ('active' if @status == status) do %>
+            <%= t("livechat.statuses.#{status}", default: status.humanize) %>
+            <span class="count"><%= @counts.fetch(status, 0) %></span>
+          <% end %>
         <% end %>
-      <% end %>
-    </div>
+      </div>
 
-    <%= form_with url: conversations_path, method: :get, class: 'filters' do %>
-      <input type="hidden" name="status" value="<%= @status %>">
-      <input type="search" name="q" value="<%= @query %>"
-             placeholder="<%= t('livechat.dashboard.search', default: 'Search') %>"
-             aria-label="<%= t('livechat.dashboard.search', default: 'Search') %>">
-      <button type="submit"><%= t('livechat.dashboard.search', default: 'Search') %></button>
-    <% end %>
+      <%= form_with url: conversations_path, method: :get, class: 'filters' do %>
+        <input type="hidden" name="status" value="<%= @status %>">
+        <input type="search" name="q" value="<%= @query %>"
+               placeholder="<%= t('livechat.dashboard.search', default: 'Search') %>"
+               aria-label="<%= t('livechat.dashboard.search', default: 'Search') %>">
+        <button type="submit"><%= t('livechat.dashboard.search', default: 'Search') %></button>
+      <% end %>
 
-    <%# The list keeps itself fresh (dashboard.js reloads when the token moves) —
-        unless the agent is mid-search or mid-reply, whose typing must never be eaten. %>
-    <% cable = livechat_cable_data('livechat:inbox') %>
-    <div id="lvc-index" data-poll-url="<%= poll_conversations_path %>"
-         data-token="<%= [Livechat::Message.maximum(:id).to_i, Livechat::Conversation.count,
-                          @counts.fetch('open', 0)].join('-') %>"
-         <%= tag.attributes(data: cable) if cable.any? %>></div>
+      <%# The list keeps itself fresh (dashboard.js reloads when the token moves) —
+          unless the agent is mid-search or mid-reply, whose typing must never be eaten. %>
+      <% cable = livechat_cable_data('livechat:inbox') %>
+      <div id="lvc-index" data-poll-url="<%= poll_conversations_path %>"
+           data-token="<%= [Livechat::Message.maximum(:id).to_i, Livechat::Conversation.count,
+                            @counts.fetch('open', 0)].join('-') %>"
+           <%= tag.attributes(data: cable) if cable.any? %>></div>
 
-    <div class="conversation-list">
-      <% if @conversations.empty? %>
-        <p class="empty"><%= t('livechat.dashboard.empty',
-                               default: 'Nothing here. When a visitor writes, the conversation lands on this page.') %></p>
-      <% else %>
-        <% @conversations.each do |conversation| %>
-          <% unread = @unread.fetch(conversation.id, 0) %>
-          <%= link_to conversations_path(status: @status, q: @query, offset: @offset,
-                                         conversation_id: conversation.id),
-                      class: ['conversation-row',
-                              ('active' if @selected_conversation&.id == conversation.id),
-                              ('unread' if unread.positive?)].compact do %>
-            <span class="conversation-main">
-              <span class="conversation-topline">
-                <span class="conversation-name"><%= conversation.display_name %></span>
-                <span class="muted conversation-time">
-                  <% if conversation.last_activity_at %>
-                    <%= time_ago_in_words(conversation.last_activity_at) %>
+      <div class="conversation-list">
+        <% if @conversations.empty? %>
+          <p class="empty"><%= t('livechat.dashboard.empty',
+                                 default: 'Nothing here. When a visitor writes, the conversation lands on this page.') %></p>
+        <% else %>
+          <% @conversations.each do |conversation| %>
+            <% unread = @unread.fetch(conversation.id, 0) %>
+            <%= link_to conversations_path(status: @status, q: @query, offset: @offset,
+                                           conversation_id: conversation.id),
+                        class: ['conversation-row',
+                                ('active' if @selected_conversation&.id == conversation.id),
+                                ('unread' if unread.positive?)].compact do %>
+              <span class="conversation-main">
+                <span class="conversation-topline">
+                  <span class="conversation-name"><%= conversation.display_name %></span>
+                  <span class="muted conversation-time">
+                    <% if conversation.last_activity_at %>
+                      <%= time_ago_in_words(conversation.last_activity_at) %>
+                    <% end %>
+                  </span>
+                </span>
+                <span class="muted conversation-meta">
+                  <span class="case-id">#<%= conversation.id %></span>
+                  <% if conversation.visitor_email.present? && conversation.visitor_email != conversation.display_name %>
+                    <span><%= conversation.visitor_email %></span>
                   <% end %>
                 </span>
+                <span class="muted conversation-preview"><%= conversation.last_message_preview %></span>
               </span>
-              <span class="muted conversation-meta">
-                <span class="case-id">#<%= conversation.id %></span>
-                <% if conversation.visitor_email.present? && conversation.visitor_email != conversation.display_name %>
-                  <span><%= conversation.visitor_email %></span>
-                <% end %>
-              </span>
-              <span class="muted conversation-preview"><%= conversation.last_message_preview %></span>
-            </span>
-            <span class="conversation-side">
-              <% if unread.positive? %>
-                <span class="badge unread-count"><%= unread %></span>
-              <% end %>
-              <span class="avatars">
-                <% @agents.fetch(conversation.id, []).each do |label| %>
-                  <%= livechat_agent_avatar(label) %>
+              <span class="conversation-side">
+                <% if unread.positive? %>
+                  <span class="badge unread-count"><%= unread %></span>
                 <% end %>
+                <span class="avatars">
+                  <% @agents.fetch(conversation.id, []).each do |label| %>
+                    <%= livechat_agent_avatar(label) %>
+                  <% end %>
+                </span>
               </span>
-            </span>
+            <% end %>
           <% end %>
         <% end %>
-      <% end %>
-    </div>
-
-    <div class="pager">
-      <% if @offset.positive? %>
-        <%= link_to t('livechat.dashboard.newer', default: 'Newer'),
-                    conversations_path(status: @status, q: @query,
-                                       offset: [@offset - Livechat::ConversationsController::PER_PAGE, 0].max) %>
-      <% end %>
-      <% if @more %>
-        <%= link_to t('livechat.dashboard.older', default: 'Older'),
-                    conversations_path(status: @status, q: @query,
-                                       offset: @offset + Livechat::ConversationsController::PER_PAGE) %>
-      <% end %>
-    </div>
-  </aside>
+      </div>
 
-  <main class="inbox-thread" aria-label="<%= t('livechat.dashboard.current_chat', default: 'Current chat') %>">
-    <% if @selected_conversation %>
-      <p class="mobile-back">
-        <%= link_to "← #{t('livechat.dashboard.back', default: 'All conversations')}",
-                    conversations_path(status: @status, q: @query, offset: @offset) %>
-      </p>
-      <%= render 'thread_panel', conversation: @selected_conversation, messages: @messages, autofocus: false %>
-    <% else %>
-      <div class="empty-state">
-        <h2><%= t('livechat.dashboard.select_conversation', default: 'Select a conversation') %></h2>
-        <p class="muted"><%= t('livechat.dashboard.select_conversation_hint',
-                               default: 'Open a chat from the list to read context and reply.') %></p>
+      <div class="pager">
+        <% if @offset.positive? %>
+          <%= link_to t('livechat.dashboard.newer', default: 'Newer'),
+                      conversations_path(status: @status, q: @query,
+                                         offset: [@offset - Livechat::ConversationsController::PER_PAGE, 0].max) %>
+        <% end %>
+        <% if @more %>
+          <%= link_to t('livechat.dashboard.older', default: 'Older'),
+                      conversations_path(status: @status, q: @query,
+                                         offset: @offset + Livechat::ConversationsController::PER_PAGE) %>
+        <% end %>
       </div>
-    <% end %>
-  </main>
-</div>
+    </aside>
+
+    <main class="inbox-thread" aria-label="<%= t('livechat.dashboard.current_chat', default: 'Current chat') %>">
+      <% if @selected_conversation %>
+        <p class="mobile-back">
+          <%= link_to "← #{t('livechat.dashboard.back', default: 'All conversations')}",
+                      conversations_path(status: @status, q: @query, offset: @offset) %>
+        </p>
+        <%= render 'thread_panel', conversation: @selected_conversation, messages: @messages, autofocus: false %>
+      <% else %>
+        <div class="empty-state">
+          <h2><%= t('livechat.dashboard.select_conversation', default: 'Select a conversation') %></h2>
+          <p class="muted"><%= t('livechat.dashboard.select_conversation_hint',
+                                 default: 'Open a chat from the list to read context and reply.') %></p>
+        </div>
+      <% end %>
+    </main>
+  </div>
+<% end %>

data/app/views/livechat/conversations/show.html.erb

@@ -1,8 +1,10 @@
 <%# Fill the viewport and scroll only the thread (see .lvc-convo in the layout). %>
 <% content_for :body_class, 'lvc-convo' %>
 
-<p class="breadcrumb">
-  <%= link_to "← #{t('livechat.dashboard.back', default: 'All conversations')}", conversations_path %>
-</p>
+<%= render layout: 'livechat/shared/dashboard' do %>
+  <p class="breadcrumb">
+    <%= link_to "← #{t('livechat.dashboard.back', default: 'All conversations')}", conversations_path %>
+  </p>
 
-<%= render 'thread_panel', conversation: @conversation, messages: @messages %>
+  <%= render 'thread_panel', conversation: @conversation, messages: @messages %>
+<% end %>

data/app/views/livechat/shared/_dashboard.html.erb

@@ -0,0 +1,18 @@
+<%# The inbox's own shell, rendered by the views rather than the layout.
+    That is deliberate: `config.agent_layout` and `config.base_controller_class`
+    both let a host replace the layout, and assets declared in a layout the host
+    replaces simply vanish — the inbox then renders unstyled with its thread
+    polling and keyboard submit dead. Declaring them here means every layout
+    works, host or gem.
+
+    The `lvc-dashboard` wrapper is what scopes dashboard.css (see the comment at
+    the top of that file), so it has to enclose the content, not precede it. %>
+<%= stylesheet_link_tag "#{dashboard_stylesheet_path}?v=#{Livechat::Widget.dashboard_stylesheet_fingerprint}",
+                        'data-turbo-track': 'reload' %>
+<%# Same-origin script instead of inline handlers, so thread polling and
+    keyboard submit work under strict script-src CSPs. %>
+<%= javascript_include_tag "#{dashboard_script_path}?v=#{Livechat::Widget.dashboard_fingerprint}",
+                           defer: true, nonce: true %>
+<div class="lvc-dashboard">
+  <%= yield %>
+</div>

data/config/routes.rb

@@ -17,12 +17,17 @@ Livechat::Engine.routes.draw do
 
   # Message attachments, gated by the engine (never a public blob URL). One
   # route for both sides — the controller decides whether you're the visitor
-  # who owns the thread or an agent. Above the conversations catch-all, and
-  # id-constrained so it never shadows a numeric conversation path.
-  get 'attachments/:id', to: 'attachments#show', as: :attachment, constraints: { id: /\d+/ }
+  # who owns the thread or an agent. Declared above the conversations catch-all,
+  # which is what keeps it from being shadowed — no id constraint needed, and a
+  # digits-only one would have made the tables bigint-only (see below).
+  get 'attachments/:id', to: 'attachments#show', as: :attachment
 
   # The inbox. Flat, human URLs: the mount path IS the conversation list.
-  resources :conversations, path: '', only: %i[index show], constraints: { id: /\d+/ } do
+  # No `id: /\d+/` constraint: it made these routes bigint-only, which forced the
+  # tables to be bigint too, and a uuid-keyed host could then never attach a file
+  # (its active_storage_attachments.record_id is a uuid column). Every fixed-name
+  # route above is declared first, so ordering already disambiguates.
+  resources :conversations, path: '', only: %i[index show] do
     collection do
       get :poll, action: :index_poll
     end

data/lib/generators/livechat/install/install_generator.rb

@@ -2,11 +2,13 @@
 
 require 'rails/generators'
 require 'rails/generators/active_record'
+require_relative '../migration_helpers'
 
 module Livechat
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include ActiveRecord::Generators::Migration
+      include MigrationHelpers
 
       source_root File.expand_path('templates', __dir__)
 
@@ -32,12 +34,6 @@ module Livechat
         say 'Optional: run `bin/rails livechat:seed_demo` for sample conversations.'
         say "Set config.mailer_from + config.agent_emails to hear about new messages by email.\n"
       end
-
-      private
-
-      def migration_version
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
     end
   end
 end

data/lib/generators/livechat/install/templates/create_livechat_tables.rb.tt

@@ -2,7 +2,7 @@
 
 class CreateLivechatTables < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :livechat_conversations do |t|
+    create_table :livechat_conversations<%= primary_key_type_option %> do |t|
       t.string :visitor_token
       t.string :visitor_id
       t.string :visitor_label
@@ -20,8 +20,10 @@ class CreateLivechatTables < ActiveRecord::Migration<%= migration_version %>
     add_index :livechat_conversations, :status
     add_index :livechat_conversations, :last_activity_at
 
-    create_table :livechat_messages do |t|
-      t.references :conversation, null: false
+    create_table :livechat_messages<%= primary_key_type_option %> do |t|
+      # index: false — the (conversation_id, id) index below already covers
+      # lookups by conversation_id, being a leftmost prefix of it.
+      t.references :conversation, null: false, index: false<%= foreign_key_type_option %>
       t.string :author_type, null: false
       t.string :agent_id
       t.string :agent_label

data/lib/generators/livechat/install/templates/initializer.rb

@@ -15,6 +15,14 @@ Livechat.configure do |config|
   #
   # Render the inbox inside your app's admin layout. Default: the gem's
   # standalone inbox layout.
+  # Two ways to put the inbox inside an admin you already have.
+  #
+  # The whole stack — your layout, helpers, authentication and any request
+  # context your before_actions set up. Only the inbox inherits it; the
+  # widget's endpoints stay public, so this cannot gate a visitor's chat.
+  # config.base_controller_class = "Admin::BaseController"
+  #
+  # Or the layout alone:
   # config.agent_layout = "admin/application"
 
   # Resolve the current user (optional). Return an object responding to #id,

data/lib/generators/livechat/migration_helpers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Livechat
+  module Generators
+    # Shared bits every migration-writing generator needs.
+    module MigrationHelpers
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      # Follow the host's own key type instead of forcing bigint. An app that
+      # keys its models with uuids has a uuid
+      # `active_storage_attachments.record_id`, so a bigint table here could
+      # never take a message attachment: the foreign key has nowhere to point
+      # and `attach` raises NotNullViolation.
+      #
+      # Same lookup Rails' own Active Storage, Action Text and Action Mailbox
+      # migrations do, so a host that set it once gets consistent tables from
+      # all of them.
+      #
+      # Rendered as options rather than bare values, because a template is
+      # expanded at generate time: emitting the method name would put
+      # `id: primary_key_type` in the migration, where nothing defines it.
+      def primary_key_type_option
+        primary_key_type ? ", id: :#{primary_key_type}" : ''
+      end
+
+      # The engine's own foreign key (messages -> conversations) has to match
+      # whatever the referenced table's primary key became, or the reference
+      # column is a bigint pointing at a uuid.
+      def foreign_key_type_option
+        primary_key_type ? ", type: :#{primary_key_type}" : ''
+      end
+
+      def primary_key_type
+        config = Rails.configuration.generators
+        config.options[config.orm][:primary_key_type]
+      end
+    end
+  end
+end

data/lib/livechat/configuration.rb

@@ -5,6 +5,10 @@ module Livechat
   # works with zero configuration; the hooks below let an app decide who can
   # chat, who answers, and how everyone is named.
   class Configuration
+    # The gem's own agent layout. Compared against, so DashboardController can
+    # tell "the host left this alone" from "the host chose this".
+    DEFAULT_AGENT_LAYOUT = 'livechat/application'
+
     # Shown in the widget header and in notification emails. nil resolves to
     # the Rails application name.
     attr_accessor :app_name
@@ -22,6 +26,21 @@ module Livechat
     # inside your app's admin shell, e.g. "admin/application".
     attr_accessor :agent_layout
 
+    # The controller the INBOX inherits from, as a String so it resolves lazily
+    # rather than at config time. Default: a plain 'ActionController::Base',
+    # where `authorize_agent` is the only gate.
+    #
+    # Name the controller your own admin already inherits from and the inbox
+    # adopts that whole stack — layout, helpers, authentication, and any request
+    # context your before_actions set up. `agent_layout` covers only the layout,
+    # which leaves a host layout calling its own helpers to raise NameError under
+    # the engine's isolated namespace.
+    #
+    # Only the inbox uses it. The widget's endpoints stay on the engine's own
+    # public controller, so an admin base controller here can never demand a
+    # staff session from a visitor starting a chat.
+    attr_accessor :base_controller_class
+
     # Resolve the current user (optional). Return an object responding to
     # #id, or nil. Receives the request. Signed-in users keep one conversation
     # across devices; guests are tracked with a cookie.
@@ -109,7 +128,8 @@ module Livechat
       @app_name = nil
       @enabled = ->(_request) { true }
       @authorize_agent = ->(_request) { Rails.env.development? }
-      @agent_layout = 'livechat/application'
+      @agent_layout = DEFAULT_AGENT_LAYOUT
+      @base_controller_class = 'ActionController::Base'
       @current_user = ->(_request) {}
       @visitor_label = ->(user) { user.try(:name).presence || user.try(:email).presence || user.to_s }
       @agent_label = ->(user) { user.try(:name).presence || user.try(:email).presence || user.to_s }