Move unread notification count from webui to notification controller

Author: krauselukas

src/api/app/controllers/webui/users/notifications_controller.rb

@@ -32,8 +32,6 @@ class Webui::Users::NotificationsController < Webui::WebuiController
   before_action :set_ordered_notifications, only: :index
   before_action :paginate_notifications, only: :index
 
-  skip_before_action :set_unread_notifications_count, only: :update
-
   def index; end
 
   def update
@@ -44,7 +42,6 @@ def update
     # rubocop:enable Rails/SkipsModelValidations
 
     # manually update the count and the filtered subset after the update
-    set_unread_notifications_count # before_action filter method defined in the Webui controller
     filter_notifications
     set_preloaded_notifications
     set_ordered_notifications
@@ -55,7 +52,7 @@ def update
       format.js do
         render partial: 'update', locals: {
           notifications: @notifications,
-          unread_notifications_count: @unread_notifications_count,
+          unread_notifications_count: unread_notifications.count,
           selected_filter: @selected_filter,
           total_count_notifications: @notifications.count,
           user: User.session
@@ -73,7 +70,7 @@ def autocomplete_projects
   def count_for_notification_types
     counted_notifications = {}
     # notifiable_type: 'Report', 'WorkflowRun', 'Decision', 'Comment', 'BsRequest', 'Group'
-    counted_notifiable_types = @notifications.unread.group(:notifiable_type).count
+    counted_notifiable_types = unread_notifications.group(:notifiable_type).count
 
     NOTIFICATION_TYPES_KEY_MAP.each do |notifications_key, notification_types_key|
       counted_notifications[notifications_key] = counted_notifiable_types[notification_types_key] || 0
@@ -87,6 +84,7 @@ def count_for_event_types
 
     # event_type: 'Event::RelationshipCreate', 'Event::RelationshipDelete', 'Event::BuildFail',
     counted_event_types = @notifications.unread.group(:event_type).count
+
     EVENT_TYPES_KEY_MAP.each do |notifications_key, event_types_key|
       counted_notifications[notifications_key] = counted_event_types[event_types_key] || 0
     end
@@ -101,18 +99,26 @@ def count_for_notification_kinds
     when 'all'
       count = @notifications.count
     when 'unread'
-      count = @unread_notifications_count # Variable set in the Webui controller
+      count = unread_notifications.count
     when 'incoming_requests'
-      count = @notifications.unread.for_incoming_requests(User.session).count
+      count = unread_notifications.for_incoming_requests(User.session).count
     when 'outgoing_requests'
-      count = @notifications.unread.for_outgoing_requests(User.session).count
+      count = unread_notifications.for_outgoing_requests(User.session).count
     end
 
     render partial: 'counter', locals: { id: "count_#{params[:notification_kind]}", count: count }
   end
 
+  def count_for_unread
+    render partial: 'unread_counter', locals: { count: unread_notifications.count }
+  end
+
   private
 
+  def unread_notifications
+    @notifications.unread
+  end
+
   def set_filter_kind
     @filter_kind = Array(params[:kind].presence || 'all')
     @filter_kind.reject! { |kind| ALLOWED_FILTERS.exclude?(kind) }

src/api/app/controllers/webui/webui_controller.rb

@@ -24,7 +24,6 @@ class Webui::WebuiController < ActionController::Base
   before_action :current_announcement, unless: -> { request.xhr? }
   before_action :fetch_watchlist_items
   before_action :set_paper_trail_whodunnit
-  before_action :set_unread_notifications_count, unless: -> { request.xhr? }
 
   # :notice and :alert are default, we add :success and :error
   add_flash_types :success, :error
@@ -184,10 +183,6 @@ def fetch_watchlist_items
     end
   end
 
-  def set_unread_notifications_count
-    @unread_notifications_count = User.session ? User.session.unread_notifications_count : 0
-  end
-
   def add_arrays(arr1, arr2)
     # we assert that both have the same size
     ret = []

src/api/app/models/user.rb

@@ -741,10 +741,6 @@ def tasks
     end
   end
 
-  def unread_notifications_count
-    notifications.for_web.unread.size
-  end
-
   def update_globalroles(global_roles)
     roles.replace(global_roles + roles.where(global: false))
   end

src/api/app/views/layouts/webui/_bottom_navigation.html.haml

@@ -7,7 +7,7 @@
           %span.d-block Watchlist
       %li.nav-item.border-start.border-gray-500
         = link_to(my_notifications_path, id: 'bottom-notifications-counter', class: 'nav-link text-light px-1 py-2', alt: 'Notifications') do
-          = render partial: 'layouts/webui/unread_notifications_counter', locals: { unread_notifications_count: unread_notifications_count }
+          = render partial: 'layouts/webui/unread_notifications_counter'
       - if content_for?(:actions)
         %li.nav-item.border-start.border-gray-500
           = link_to('javascript:void(0)', class: 'nav-link px-1 py-2 text-light', alt: 'Actions', data: { toggle: 'actions' }) do

src/api/app/views/layouts/webui/_top_navigation.html.haml

@@ -11,7 +11,7 @@
             %span.d-block Watchlist
         .toggler.text-center.justify-content-center.nav-item
           = link_to(my_notifications_path, id: 'top-notifications-counter', class: 'nav-link p-0 w-100', alt: 'Notifications') do
-            = render partial: 'layouts/webui/unread_notifications_counter', locals: { unread_notifications_count: unread_notifications_count }
+            = render partial: 'layouts/webui/unread_notifications_counter'
         .toggler.text-center.justify-content-center.nav-item.dropdown
           = link_to('#', class: 'nav-link dropdown-toggle', id: 'top-navigation-profile-dropdown', role: 'button',
                     'data-bs-toggle': 'dropdown', aria: { haspopup: true, expanded: false }) do

src/api/app/views/layouts/webui/_unread_notifications_counter.html.haml

@@ -1,5 +1,5 @@
 .notifications-counter
   %i.fas.fa-bell
-  - if defined?(unread_notifications_count) && unread_notifications_count&.positive?
-    %span.badge.text-bg-primary.align-text-top= unread_notifications_count
+  = turbo_frame_tag 'unread_notification_count', loading: 'lazy', src: count_for_unread_my_notifications_path do
+    %i.fas.fa-spinner.fa-spin
   %span.d-block Notifications

src/api/app/views/webui/users/notifications/_unread_counter.html.haml

@@ -0,0 +1,2 @@
+= turbo_frame_tag 'unread_notification_count' do
+  %span.badge.text-bg-primary.align-text-top= count

src/api/config/routes/webui.rb

@@ -383,6 +383,7 @@
         get :count_for_notification_types
         get :count_for_event_types
         get :count_for_notification_kinds
+        get :count_for_unread
       end
     end