demo: AI Assistants

.github/workflows/pullpreview.yml

@@ -30,6 +30,7 @@ jobs:
         echo "OPENPROJECT_FEATURE__SHOW__CHANGES__ACTIVE=true" >> .env.pullpreview
         echo "OPENPROJECT_FEATURE__AI__TEXT__TRANSFORM__ACTIONS__ACTIVE=true" >> .env.pullpreview
         echo "OPENPROJECT_FEATURE__LLM__CONNECTION__ACTIVE=true" >> .env.pullpreview
+        echo "OPENPROJECT_FEATURE__AI__ASSISTANCE__ACTIVE=true" >> .env.pullpreview
         echo "OPENPROJECT_FEATURE__SEMANTIC__SEARCH__ACTIVE=false" >> .env.pullpreview
         echo "OPENPROJECT_LOOKBOOK__ENABLED=true" >> .env.pullpreview
         echo "OPENPROJECT_HSTS=false" >> .env.pullpreview

app/components/ai/assistance/chat_component.html.erb

@@ -0,0 +1,94 @@
+<%#
+  -- copyright
+  OpenProject is an open source project management software.
+  Copyright (C) the OpenProject GmbH
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License version 3.
+
+  OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+  Copyright (C) 2006-2013 Jean-Philippe Lang
+  Copyright (C) 2010-2013 the ChiliProject Team
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+  See COPYRIGHT and LICENSE files for more details.
+
+  ++#
+%>
+
+<%# position: relative keeps absolutely positioned form labels inside the scrolling body;
+    without it they stretch the dialog and give it a second scrollbar. %>
+<%= component_wrapper(data: wrapper_data, class: "position-relative") do %>
+  <% if messages.empty? %>
+    <%= render(Primer::Beta::Blankslate.new(data: { test_selector: "ai-assistance-chat-empty" })) do |slate| %>
+      <% slate.with_visual_icon(icon: :sparkle) %>
+      <% slate.with_heading(tag: :h3).with_content(empty_title) %>
+      <% slate.with_description { empty_description } %>
+    <% end %>
+  <% end %>
+
+  <% messages.each_with_index do |message, index| %>
+    <% last = index == messages.size - 1 %>
+    <% if message.from_start? %>
+      <%= render(Primer::Box.new(display: :flex, align_items: :center, my: 3, data: { test_selector: "ai-assistance-chat-start" })) do %>
+        <%= render(Primer::Box.new(flex: 1, border: :top)) %>
+        <%= render(Primer::Beta::Text.new(color: :muted, font_size: :small, text_align: :center, px: 2)) do %>
+          <%= start_text %><br>
+          <%= helpers.format_time(message.created_at) %>
+        <% end %>
+        <%= render(Primer::Box.new(flex: 1, border: :top)) %>
+      <% end %>
+    <% elsif message.from_user? %>
+      <%= render(Primer::Box.new(display: :flex, justify_content: :flex_end, mb: 2)) do %>
+        <%= render(Primer::Box.new(bg: :accent, border_radius: 2, p: 2, style: "max-width: 85%; white-space: pre-wrap;", data: { test_selector: "ai-assistance-chat-question" })) { message.content } %>
+      <% end %>
+    <% else %>
+      <%= render(Primer::Box.new(mb: 3, data: { test_selector: "ai-assistance-chat-answer", controller: (last ? "scroll-into-view" : nil) })) do %>
+        <% if message.failed? %>
+          <%= render(Primer::Alpha::Banner.new(scheme: :danger)) { t("ai_assistance.chat.failed") } %>
+        <% elsif message.done? && message.content.present? %>
+          <div class="op-uc-container"><%= helpers.format_text(message.content) %></div>
+          <%= render(Primer::Beta::ClipboardCopyButton.new(id: "ai-assistance-copy-#{message.id}", value: message.content,
+                                                           aria: { label: t("ai_assistance.chat.copy") },
+                                                           scheme: :invisible, size: :small,
+                                                           data: { test_selector: "ai-assistance-chat-copy" })) %>
+        <% end %>
+        <% if message.proposals.any? %>
+          <%= render(Primer::Beta::BorderBox.new(mt: 2, data: { test_selector: "ai-assistance-proposals" })) do |box| %>
+            <% message.proposals.each do |proposal| %>
+              <% box.with_row { render(AI::Assistance::ProposalItemComponent.new(proposal:, read_only:)) } %>
+            <% end %>
+          <% end %>
+        <% end %>
+        <% if message.pending? %>
+          <%= render(Primer::Beta::Text.new(tag: :p, color: :muted, mt: 2)) do %>
+            <%= render(Primer::Beta::Spinner.new(size: :small, mr: 1)) %><%= pending_text(index.positive? ? messages[index - 1] : nil) %>
+          <% end %>
+          <% steps = tool_steps(message) %>
+          <% if steps.any? %>
+            <ul class="list-style-none pl-4 mt-1" data-test-selector="ai-assistance-tool-steps">
+              <% steps.each do |step| %>
+                <li><%= render(Primer::Beta::Text.new(color: :muted, font_size: :small)) { step } %></li>
+              <% end %>
+            </ul>
+          <% end %>
+        <% end %>
+        <%= render(AI::Assistance::RunEventsComponent.new(events: message.events)) %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+<% end %>

app/components/ai/assistance/chat_component.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module AI
+  module Assistance
+    # The conversation in the dialog body. Replaced after each question, and polled while
+    # an answer is pending.
+    class ChatComponent < ApplicationComponent
+      include OpTurbo::Streamable
+      include Polling
+
+      attr_reader :place, :skill, :chat, :read_only
+
+      def initialize(place:, skill:, chat:, read_only: false)
+        super
+        @place = place
+        @skill = skill
+        @chat = chat
+        @read_only = read_only
+      end
+
+      def self.wrapper_key = "ai-assistance-chat"
+
+      # Changes with each event of a pending answer, so a poll can show the tool calls so far.
+      def self.progress_reference(chat)
+        chat.messages.select(&:pending?).sum { |message| message.events.size }.to_s
+      end
+
+      def messages
+        chat ? chat.messages.includes(:proposals).to_a : []
+      end
+
+      def pending?
+        chat&.pending?
+      end
+
+      def wrapper_data
+        return {} unless pending?
+
+        poll_data(url_helpers.poll_ai_assistance_chat_path(chat_id: chat.id))
+          .merge(poll_for_changes_reference_value: self.class.progress_reference(chat))
+      end
+
+      # Off a work package, a skill proposes nothing.
+      def read_only?
+        skill.scope_read_only? || !place.work_package?
+      end
+
+      def empty_title
+        place.work_package? ? I18n.t("ai_assistance.chat.empty_title") : I18n.t("ai_assistance.chat.empty_title_generic")
+      end
+
+      def empty_description
+        if place.work_package?
+          I18n.t("ai_assistance.chat.#{read_only? ? 'empty_description_read_only' : 'empty_description'}")
+        elsif place.project
+          I18n.t("ai_assistance.chat.empty_description_project", project: place.project.name)
+        else
+          I18n.t("ai_assistance.chat.empty_description_generic")
+        end
+      end
+
+      def start_text
+        I18n.t("ai_assistance.chat.started", user: chat.user.name, skill: skill.display_label)
+      end
+
+      # The tool calls of a pending answer, for example "Count work packages (project_id: 1, open: true)".
+      def tool_steps(message)
+        message.events.select { |event| event["kind"] == "tool_call" }.map do |event|
+          data = event["data"]
+          arguments = (data["arguments"] || {}).map { |key, value| "#{key}: #{value}" }.join(", ")
+          I18n.t("ai_assistance.chat.tool_step", tool: tool_title(data["name"]), arguments:)
+        end
+      end
+
+      def pending_text(previous)
+        key = previous&.from_start? && place.label ? "working_on" : "answering"
+        I18n.t("ai_assistance.chat.#{key}", assistant: skill.assistant.name, id: place.label)
+      end
+
+      private
+
+      def tool_title(name)
+        McpTools.all.find { |tool| tool.name == name }&.default_title || name
+      end
+    end
+  end
+end

app/components/ai/assistance/chat_dialog_component.html.erb

@@ -0,0 +1,41 @@
+<%#
+  -- copyright
+  OpenProject is an open source project management software.
+  Copyright (C) the OpenProject GmbH
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License version 3.
+
+  OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+  Copyright (C) 2006-2013 Jean-Philippe Lang
+  Copyright (C) 2010-2013 the ChiliProject Team
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+  See COPYRIGHT and LICENSE files for more details.
+
+  ++#
+%>
+
+<%= render(Primer::Alpha::Dialog.new(id: DIALOG_ID, title:, size: :xlarge,
+                                     data: { test_selector: "ai-assistance-chat-dialog", "keep-open-on-submit": true })) do |dialog| %>
+  <% dialog.with_header(variant: :large) %>
+  <% dialog.with_body do %>
+    <%= render(AI::Assistance::ChatComponent.new(place:, skill:, chat:, read_only:)) %>
+  <% end %>
+  <% dialog.with_footer(show_divider: true) do %>
+    <%= render(AI::Assistance::ChatFormComponent.new(place:, skill:, chat:, read_only:, dialog_id: DIALOG_ID)) %>
+  <% end %>
+<% end %>

app/components/ai/assistance/chat_dialog_component.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module AI
+  module Assistance
+    class ChatDialogComponent < ApplicationComponent
+      include OpTurbo::Streamable
+
+      DIALOG_ID = "ai-assistance-chat-dialog"
+
+      attr_reader :place, :skill, :chat, :read_only
+
+      def initialize(place:, skill:, chat:, read_only: false)
+        super
+        @place = place
+        @skill = skill
+        @chat = chat
+        @read_only = read_only
+      end
+
+      def title = skill.full_label
+    end
+  end
+end

app/components/ai/assistance/chat_form_component.html.erb

@@ -0,0 +1,69 @@
+<%#
+  -- copyright
+  OpenProject is an open source project management software.
+  Copyright (C) the OpenProject GmbH
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License version 3.
+
+  OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+  Copyright (C) 2006-2013 Jean-Philippe Lang
+  Copyright (C) 2010-2013 the ChiliProject Team
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+  See COPYRIGHT and LICENSE files for more details.
+
+  ++#
+%>
+
+<%= component_wrapper(class: "width-full") do %>
+  <% if read_only %>
+    <%= render(Primer::Box.new(display: :flex, align_items: :center, data: { test_selector: "ai-assistance-chat-read-only" })) do %>
+      <%= render(Primer::Beta::Text.new(color: :muted, font_size: :small, flex: 1)) { t("ai_assistance.chat.not_offered") } %>
+      <%= render(Primer::Beta::Button.new(type: :button, ml: 2, data: { close_dialog_id: dialog_id })) { t(:button_close) } %>
+    <% end %>
+  <% else %>
+    <%= primer_form_with(url: send_path, method: :post, html: { class: "mb-0" }, data: { test_selector: "ai-assistance-chat-form" }) do %>
+      <%= hidden_field_tag :skill_id, skill.id %>
+      <% if chat %>
+        <%= hidden_field_tag :chat_id, chat.id %>
+      <% end %>
+      <%= render(Primer::Alpha::TextArea.new(name: :content, label: t("ai_assistance.chat.question"), visually_hide_label: true,
+                                             placeholder:,
+                                             rows: 2, full_width: true, disabled: pending?)) %>
+      <%= render(Primer::Box.new(display: :flex, align_items: :center, mt: 2)) do %>
+        <%= render(Primer::Beta::Button.new(type: :submit, scheme: :invisible, formaction: new_chat_path, formnovalidate: true,
+                                            data: { test_selector: "ai-assistance-new-chat" })) do |button| %>
+          <% button.with_leading_visual_icon(icon: :plus) %>
+          <%= t("ai_assistance.chat.new") %>
+        <% end %>
+        <% if rerun? %>
+          <%= render(Primer::Beta::Button.new(type: :submit, scheme: :invisible, formaction: rerun_path, formnovalidate: true,
+                                              disabled: pending?, data: { test_selector: "ai-assistance-rerun" })) do |button| %>
+            <% button.with_leading_visual_icon(icon: :sync) %>
+            <%= t("ai_assistance.chat.rerun") %>
+          <% end %>
+        <% end %>
+        <%= render(Primer::Box.new(flex: 1)) %>
+        <%= render(Primer::Beta::Button.new(type: :button, mr: 2, data: { close_dialog_id: dialog_id })) { t(:button_close) } %>
+        <%= render(Primer::Beta::Button.new(type: :submit, scheme: :primary, disabled: pending?, data: { test_selector: "ai-assistance-chat-send" })) do |button| %>
+          <% button.with_leading_visual_icon(icon: :"paper-airplane") %>
+          <%= t("ai_assistance.chat.send") %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>