add 'Event Log' modal

2025-02-11 22:23:51 +02:00
parent a315674421
commit e406620044
11 changed files with 201 additions and 0 deletions
@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class SubmissionEventsController < ApplicationController
+  SUBMISSION_EVENT_ICONS = {
+    'view_form' => 'eye',
+    'start_form' => 'player_play',
+    'complete_form' => 'check',
+    'send_email' => 'mail_forward',
+    'click_email' => 'hand_click',
+    'api_complete_form' => 'check',
+    'send_reminder_email' => 'mail_forward',
+    'send_2fa_sms' => '2fa',
+    'send_sms' => 'send',
+    'phone_verified' => 'phone_check',
+    'click_sms' => 'hand_click',
+    'decline_form' => 'x',
+    'start_verification' => 'player_play',
+    'complete_verification' => 'check',
+    'invite_party' => 'user_plus'
+  }.freeze
+
+  load_and_authorize_resource :submission
+
+  # rubocop:disable Metrics
+  def index
+    submitters = @submission.submitters
+    submitters_uuids = (@submission.template_submitters || @submission.template.submitters).pluck('uuid')
+
+    @events_data = @submission.submission_events.sort_by(&:event_timestamp).map do |event|
+      submitter = submitters.find { |e| e.id == event.submitter_id }
+      submitter_name =
+        if event.event_type.include?('sms') || event.event_type.include?('phone')
+          event.data['phone'] || submitter.phone
+        else
+          submitter.name || submitter.email || submitter.phone
+        end
+
+      text =
+        if event.event_type == 'complete_verification'
+          helpers.t('submission_event_names.complete_verification_by_html', provider: event.data['method'],
+                                                                            submitter_name:)
+        elsif event.event_type == 'invite_party' &&
+              (invited_submitter = submitters.find { |e| e.uuid == event.data['uuid'] }) &&
+              (name = submission.template_submitters.find { |e| e['uuid'] == event.data['uuid'] }&.dig('name'))
+          invited_submitter_name = [invited_submitter.name || invited_submitter.email || invited_submitter.phone,
+                                    name].join(' ')
+          helpers.t('submission_event_names.invite_party_by_html', invited_submitter_name:,
+                                                                   submitter_name:)
+        elsif event.event_type.include?('send_')
+          helpers.t("submission_event_names.#{event.event_type}_to_html", submitter_name:)
+        else
+          helpers.t("submission_event_names.#{event.event_type}_by_html", submitter_name:)
+        end
+
+      {
+        timestamp: event.event_timestamp.in_time_zone(current_account.timezone),
+        event_type: event.event_type,
+        submitter_index: submitters_uuids.index(submitter.uuid),
+        text:
+      }
+    end
+  end
+  # rubocop:enable Metrics
+end
@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" width="24" height="24" stroke-width="2">
+  <path d="M7 16h-4l3.47 -4.66a2 2 0 1 0 -3.47 -1.54"></path>
+  <path d="M10 16v-8h4"></path> <path d="M10 12l3 0"></path>
+  <path d="M17 16v-6a2 2 0 0 1 4 0v6"></path>
+  <path d="M17 13l4 0"></path>
+</svg>
@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
+  <path stroke="none" d="M0 0h24v24H0z" fill="none" />
+  <path d="M12 12m-1 0a1 1 0 1 0 2 0a1 1 0 1 0 -2 0" />
+  <path d="M12 12m-9 0a9 9 0 1 0 18 0a9 9 0 1 0 -18 0" />
+</svg>
@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" width="24" height="24" stroke-width="2">
+  <path d="M8 13v-8.5a1.5 1.5 0 0 1 3 0v7.5"></path>
+  <path d="M11 11.5v-2a1.5 1.5 0 0 1 3 0v2.5"></path>
+  <path d="M14 10.5a1.5 1.5 0 0 1 3 0v1.5"></path>
+  <path d="M17 11.5a1.5 1.5 0 0 1 3 0v4.5a6 6 0 0 1 -6 6h-2h.208a6 6 0 0 1 -5.012 -2.7l-.196 -.3c-.312 -.479 -1.407 -2.388 -3.286 -5.728a1.5 1.5 0 0 1 .536 -2.022a1.867 1.867 0 0 1 2.28 .28l1.47 1.47"></path>
+  <path d="M5 3l-1 -1"></path>
+  <path d="M4 7h-1"></path>
+  <path d="M14 3l1 -1"></path>
+  <path d="M15 6h1"></path>
+</svg>
@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" width="24" height="24" stroke-width="2">
+  <path d="M4 12h.01"></path>
+  <path d="M4 6h.01"></path>
+  <path d="M4 18h.01"></path>
+  <path d="M8 18h2"></path>
+  <path d="M8 12h2"></path>
+  <path d="M8 6h2"></path>
+  <path d="M14 6h6"></path>
+  <path d="M14 12h6"></path>
+  <path d="M14 18h6"></path>
+</svg>
@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" width="24" height="24" stroke-width="2">
+  <path d="M5 4h4l2 5l-2.5 1.5a11 11 0 0 0 5 5l1.5 -2.5l5 2v4a2 2 0 0 1 -2 2a16 16 0 0 1 -15 -15a2 2 0 0 1 2 -2"></path>
+  <path d="M15 6l2 2l4 -4"></path>
+</svg>
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="<%= local_assigns[:class] %>" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" width="24" height="24" stroke-width="2">
+  <path d="M7 4v16l13 -8z"></path>
+</svg>
@@ -0,0 +1,38 @@
+<% event_colors = %w[bg-red-200 bg-sky-200 bg-emerald-200 bg-yellow-300 bg-purple-200 bg-pink-200 bg-cyan-200 bg-orange-200 bg-lime-200 bg-indigo-200] %>
+<%= render 'shared/turbo_modal_large', title: t('event_log') do %>
+  <div class="pl-8 pr-4 py-4">
+    <ol class="relative border-s border-neutral-300 space-y-10">
+      <li class="ml-6">
+        <span class="absolute flex items-center justify-center w-6 h-6 rounded-full -start-3 ring-8 ring-base-100 text-base-content bg-gray-200">
+          <%= svg_icon('file_text', class: 'w-3.5 h-3.5') %>
+        </span>
+        <p class="text-sm leading-none text-base-content/60 pt-1">
+          <%= l(@submission.created_at.in_time_zone(current_account.timezone), format: :long, locale: current_account.locale) %>
+        </p>
+        <p class="text-base-content/80 mt-2">
+          <% if @submission.source == 'invite' %>
+            <%= t('submission_created_by_email_invite_html', email: @submission.created_by_user.email) %>
+          <% elsif @submission.created_by_user %>
+            <%= t('submission_created_by_email_via_source_html', email: @submission.created_by_user.email, source: t("submission_sources.#{@submission.source}")) %>
+          <% else %>
+            <%= t('submission_created_via_source_html', source: t("submission_sources.#{@submission.source}")) %>
+          <% end %>
+        </p>
+      </li>
+      <% @events_data.each do |row| %>
+        <% bg_class = event_colors[row[:submitter_index] % event_colors.length] %>
+        <li class="ml-6">
+          <span class="absolute flex items-center justify-center w-6 h-6 rounded-full -start-3 ring-8 ring-base-100 text-base-content <%= bg_class %>">
+            <%= svg_icon(SubmissionEventsController::SUBMISSION_EVENT_ICONS.fetch(row[:event_type], 'circle_dot'), class: 'w-3.5 h-3.5') %>
+          </span>
+          <p class="text-sm leading-none text-base-content/60 pt-1">
+            <%= l(row[:timestamp], format: :long, locale: current_account.locale) %>
+          </p>
+          <p class="text-base-content/80 mt-2">
+            <%= row[:text] %>
+          </p>
+        </li>
+      <% end %>
+    </ol>
+  </div>
+<% end %>
@@ -19,6 +19,11 @@
          <%= svg_icon('external_link', class: 'w-6 h-6') %>
          <span class="hidden md:inline"><%= t('audit_log') %></span>
        </a>
+      <% else %>
+        <%= link_to submission_events_path(@submission), class: 'white-button', data: { turbo_frame: :modal } do %>
+          <%= svg_icon('logs', class: 'w-6 h-6') %>
+          <span class="hidden md:block"><%= t('event_log') %></span>
+        <% end %>
      <% end %>
      <% if last_submitter %>
        <% if is_all_completed || !is_combined_enabled %>
@@ -695,6 +695,15 @@ en: &en
  overdue_payment: Overdue Payment
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Your Pro Plan has been suspended due to unpaid invoices. You can update your payment details to settle the invoice and continue using DocuSeal or cancel your subscription.
  manage_subscription: Manage Subscription
+  submission_created_by_email_invite_html: '<b>Submission created</b> by %{email} invite'
+  submission_created_by_email_via_source_html: '<b>Submission created</b> by %{email} via %{source}'
+  submission_created_via_source_html: '<b>Submission created</b> via %{source}'
+  submission_sources:
+    api: API
+    bulk: Bulk Send
+    embed: Embedding
+    invie: Invite
+    link: Link
  submission_event_names:
    send_email_to_html: '<b>Email sent</b> to %{submitter_name}'
    send_reminder_email_to_html: '<b>Reminder email sent</b> to %{submitter_name}'
@@ -1410,6 +1419,15 @@ es: &es
  overdue_payment: Pago Atrasado
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Tu plan Pro ha sido suspendido debido a facturas impagas. Puedes actualizar tus datos de pago para liquidar la factura y seguir usando DocuSeal o cancelar tu suscripción.
  manage_subscription: Gestionar Suscripción
+  submission_created_by_email_invite_html: '<b>Envío creado</b> por invitación de %{email}'
+  submission_created_by_email_via_source_html: '<b>Envío creado</b> por %{email} a través de %{source}'
+  submission_created_via_source_html: '<b>Envío creado</b> a través de %{source}'
+  submission_sources:
+    api: API
+    bulk: Envío masivo
+    embed: Integración
+    invite: Invitación
+    link: Enlace
  submission_event_names:
    send_email_to_html: '<b>Correo electrónico enviado</b> a %{submitter_name}'
    send_reminder_email_to_html: '<b>Correo de recordatorio enviado</b> a %{submitter_name}'
@@ -2124,6 +2142,15 @@ it: &it
  overdue_payment: Pagamento Scaduto
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Il tuo piano Pro è stato sospeso a causa di fatture non pagate. Puoi aggiornare i tuoi dati di pagamento per saldare la fattura e continuare a utilizzare DocuSeal o annullare l'abbonamento.
  manage_subscription: Gestisci Abbonamento
+  submission_created_by_email_invite_html: '<b>Invio creato</b> tramite invito di %{email}'
+  submission_created_by_email_via_source_html: '<b>Invio creato</b> da %{email} tramite %{source}'
+  submission_created_via_source_html: '<b>Invio creato</b> tramite %{source}'
+  submission_sources:
+    api: API
+    bulk: Invio massivo
+    embed: Incorporamento
+    invite: Invito
+    link: Link
  submission_event_names:
    send_email_to_html: '<b>E-mail inviato</b> a %{submitter_name}'
    send_reminder_email_to_html: '<b>E-mail di promemoria inviato</b> a %{submitter_name}'
@@ -2840,6 +2867,15 @@ fr: &fr
  overdue_payment: Paiement En Retard
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Votre plan Pro a été suspendu en raison de factures impayées. Vous pouvez mettre à jour vos informations de paiement pour régler la facture et continuer à utiliser DocuSeal ou annuler votre abonnement.
  manage_subscription: Gérer l'Abonnement
+  submission_created_by_email_invite_html: "<b>Soumission créée</b> par l'invitation de %{email}"
+  submission_created_by_email_via_source_html: '<b>Soumission créée</b> par %{email} via %{source}'
+  submission_created_via_source_html: '<b>Soumission créée</b> via %{source}'
+  submission_sources:
+    api: API
+    bulk: Envoi en masse
+    embed: Intégration
+    invite: Invitation
+    link: Lien
  submission_event_names:
    send_email_to_html: '<b>E-mail envoyé</b> à %{submitter_name}'
    send_reminder_email_to_html: '<b>E-mail de rappel envoyé</b> à %{submitter_name}'
@@ -3555,6 +3591,15 @@ pt: &pt
  overdue_payment: Pagamento Atrasado
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Seu plano Pro foi suspenso devido a faturas não pagas. Você pode atualizar seus dados de pagamento para quitar a fatura e continuar usando o DocuSeal ou cancelar sua assinatura.
  manage_subscription: Gerenciar Assinatura
+  submission_created_by_email_invite_html: '<b>Envio criado</b> por convite de %{email}'
+  submission_created_by_email_via_source_html: '<b>Envio criado</b> por %{email} via %{source}'
+  submission_created_via_source_html: '<b>Envio criado</b> via %{source}'
+  submission_sources:
+    api: API
+    bulk: Envio em massa
+    embed: Incorporação
+    invite: Convite
+    link: Link
  submission_event_names:
    send_email_to_html: '<b>E-mail enviado</b> para %{submitter_name}'
    send_reminder_email_to_html: '<b>E-mail de lembrete enviado</b> para %{submitter_name}'
@@ -4270,6 +4315,15 @@ de: &de
  overdue_payment: Überfällige Zahlung
  your_pro_plan_has_been_suspended_due_to_unpaid_invoices_you_can_update_your_payment_details_to_settle_the_invoice_and_continue_using_docuseal_or_cancel_your_subscription: Ihr Pro-Plan wurde aufgrund unbezahlter Rechnungen ausgesetzt. Sie können Ihre Zahlungsdaten aktualisieren, um die Rechnung zu begleichen und DocuSeal weiterhin zu nutzen, oder Ihr Abonnement kündigen.
  manage_subscription: Abonnement Verwalten
+  submission_created_by_email_invite_html: '<b>Übermittlung erstellt</b> durch Einladung von %{email}'
+  submission_created_by_email_via_source_html: '<b>Übermittlung erstellt</b> durch %{email} über %{source}'
+  submission_created_via_source_html: '<b>Übermittlung erstellt</b> über %{source}'
+  submission_sources:
+    api: API
+    bulk: Massenversand
+    embed: Einbettung
+    invite: Einladung
+    link: Link
  submission_event_names:
    send_email_to_html: '<b>E-Mail gesendet</b> an %{submitter_name}'
    send_reminder_email_to_html: '<b>Erinnerungs-E-Mail gesendet</b> an %{submitter_name}'
@@ -72,6 +72,7 @@ Rails.application.routes.draw do
  resources :submissions, only: %i[index], controller: 'submissions_dashboard'
  resources :submissions, only: %i[show destroy] do
    resources :unarchive, only: %i[create], controller: 'submissions_unarchive'
+    resources :events, only: %i[index], controller: 'submission_events'
  end
  resources :submitters, only: %i[edit update]
  resources :console_redirect, only: %i[index]