fixes #19035 - rewrite TopbarSweeper without rails-observers

Moves from the observer object into two mixins, one on the model and one
on the top-level controllers to observe creates/updates/destroys on
monitored models. Replaces rails-observers as it lacks Rails 5 support.

Gemfile

@@ -29,7 +29,6 @@ gem 'net-ssh'
 gem 'net-ldap', '>= 0.8.0'
 gem 'net-ping', :require => false
 gem 'activerecord-session_store', '>= 0.1.1', '< 2'
-gem 'rails-observers', '~> 0.1'
 gem 'sprockets', '~> 3'
 gem 'sprockets-rails', '>= 2.3.3', '< 3'
 gem 'responders', '~> 2.0'

app/controllers/api/base_controller.rb

@@ -11,8 +11,6 @@ class BaseController < ActionController::Base
     before_action :session_expiry, :update_activity_time
     around_action :set_timezone
 
-    cache_sweeper :topbar_sweeper
-
     respond_to :json
 
     after_action :log_response_body

app/controllers/application_controller.rb

@@ -25,8 +25,6 @@ class ApplicationController < ActionController::Base
 
   attr_reader :original_search_parameter
 
-  cache_sweeper :topbar_sweeper
-
   def welcome
     if (model_of_controller.first.nil? rescue false)
       @welcome = true

app/controllers/concerns/application_shared.rb

@@ -4,6 +4,7 @@ module ApplicationShared
   include Foreman::Controller::MigrationChecker
   include Foreman::Controller::Authentication
   include Foreman::Controller::Session
+  include Foreman::Controller::TopbarSweeper
   include Foreman::ThreadSession::Cleaner
   include FindCommon
 

app/controllers/concerns/foreman/controller/taxonomies_controller.rb

@@ -109,7 +109,7 @@ def clear
   def clear_current_taxonomy_from_session
     taxonomy_class.current = nil
     session[taxonomy_id] = nil
-    TopbarSweeper.expire_cache(self)
+    TopbarSweeper.expire_cache
   end
 
   def mismatches
@@ -222,6 +222,6 @@ def switch_taxonomy
     taxonomy_class.current = @taxonomy
     session[taxonomy_id] = @taxonomy ? @taxonomy.id : nil
 
-    TopbarSweeper.expire_cache(self)
+    TopbarSweeper.expire_cache
   end
 end

app/controllers/concerns/foreman/controller/topbar_sweeper.rb

@@ -0,0 +1,18 @@
+module Foreman
+  module Controller
+    module TopbarSweeper
+      extend ActiveSupport::Concern
+
+      included do
+        around_action :set_topbar_sweeper_controller
+      end
+
+      def set_topbar_sweeper_controller
+        ::TopbarSweeper.instance.controller = self
+        yield
+      ensure
+        ::TopbarSweeper.instance.controller = nil
+      end
+    end
+  end
+end

app/controllers/users_controller.rb

@@ -106,7 +106,7 @@ def logout
       return
     end
 
-    TopbarSweeper.expire_cache(self)
+    TopbarSweeper.expire_cache
     sso_logout_path = get_sso_method.try(:logout_url)
     session[:user] = @user = User.current = nil
     if flash[:notice] || flash[:error]
@@ -149,7 +149,7 @@ def login_user(user)
     uri                    = session.to_hash.with_indifferent_access[:original_uri]
     session[:original_uri] = nil
     set_current_taxonomies(user, {:session => session})
-    TopbarSweeper.expire_cache(self)
+    TopbarSweeper.expire_cache
     redirect_to (uri || hosts_path)
   end
 

app/models/concerns/topbar_cache_expiry.rb

@@ -0,0 +1,13 @@
+module TopbarCacheExpiry
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :expire_topbar_cache_within_controller
+    after_update :expire_topbar_cache_within_controller
+    after_destroy :expire_topbar_cache_within_controller
+  end
+
+  def expire_topbar_cache_within_controller
+    expire_topbar_cache if TopbarSweeper.instance.controller.present?
+  end
+end

app/models/filter.rb

@@ -1,6 +1,7 @@
 class Filter < ActiveRecord::Base
   include Taxonomix
   include Authorizable
+  include TopbarCacheExpiry
 
   attr_writer :resource_type
   attr_accessor :unlimited
@@ -140,9 +141,9 @@ def search_condition
     searches.join(' and ')
   end
 
-  def expire_topbar_cache(sweeper)
-    role.users.each      { |u| u.expire_topbar_cache(sweeper) }
-    role.usergroups.each { |g| g.expire_topbar_cache(sweeper) }
+  def expire_topbar_cache
+    role.users.each      { |u| u.expire_topbar_cache }
+    role.usergroups.each { |g| g.expire_topbar_cache }
   end
 
   def disable_overriding!

app/models/taxonomy.rb

@@ -3,6 +3,7 @@ class Taxonomy < ActiveRecord::Base
 
   include Authorizable
   include NestedAncestryCommon
+  include TopbarCacheExpiry
 
   serialize :ignore_types, Array
 
@@ -170,8 +171,8 @@ def dup
     end
   end
 
-  def expire_topbar_cache(sweeper)
-    (users+User.only_admin).each { |u| u.expire_topbar_cache(sweeper) }
+  def expire_topbar_cache
+    (users+User.only_admin).each { |u| u.expire_topbar_cache }
   end
 
   def parent_params(include_source = false)

app/models/user.rb

@@ -11,6 +11,7 @@ class User < ActiveRecord::Base
   include UserTime
   include UserUsergroupCommon
   include Exportable
+  include TopbarCacheExpiry
   audited :except => [:last_login_on, :password, :password_hash, :password_salt, :password_confirmation]
 
   ANONYMOUS_ADMIN = 'foreman_admin'
@@ -428,9 +429,8 @@ def self.random_password(size = 16)
     size.times.collect {|i| set[rand(set.size)] }.join
   end
 
-  def expire_topbar_cache(sweeper)
-    return if sweeper.controller.nil?
-    sweeper.expire_fragment(TopbarSweeper.fragment_name(id))
+  def expire_topbar_cache
+    TopbarSweeper.expire_cache(self)
   end
 
   def external_usergroups

app/models/user_role.rb

@@ -16,6 +16,8 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 class UserRole < ActiveRecord::Base
+  include TopbarCacheExpiry
+
   belongs_to :owner, :polymorphic => true
   belongs_to :role
 

app/models/usergroup.rb

@@ -4,6 +4,7 @@ class Usergroup < ActiveRecord::Base
   extend FriendlyId
   friendly_id :name
   include Parameterizable::ByIdName
+  include TopbarCacheExpiry
   include UserUsergroupCommon
 
   validates_lengths_from_database
@@ -66,8 +67,8 @@ def all_usergroups(group_list = [self], user_list = [])
     group_list.uniq.sort
   end
 
-  def expire_topbar_cache(sweeper)
-    users.each { |u| u.expire_topbar_cache(sweeper) }
+  def expire_topbar_cache
+    users.each { |u| u.expire_topbar_cache }
   end
 
   def add_users(userlist)

app/services/topbar_sweeper.rb

@@ -0,0 +1,22 @@
+class TopbarSweeper
+  include Singleton
+  attr_accessor :controller
+
+  def expire_cache(user = User.current)
+    controller.expire_fragment(self.class.fragment_name(user.id)) if controller.present? && user.present?
+  end
+
+  class << self
+    delegate :expire_cache, to: :instance
+
+    def fragment_name(id = User.current.id)
+      "tabs_and_title_records-#{id}"
+    end
+
+    def expire_cache_all_users
+      User.unscoped.pluck(:id).each do |id|
+        Rails.cache.delete("views/#{fragment_name(id)}")
+      end
+    end
+  end
+end

test/integration/top_bar_test.rb

@@ -70,5 +70,27 @@ def setup
     assert page.has_selector?('h1', :text => "Trends")
   end
 
+  test "taxonomy switcher" do
+    with_controller_caching(DashboardController, LocationsController) do
+      visit root_path
+      within("li.org-switcher") do
+        assert has_selector?(:xpath, "//a[contains(@class, 'dropdown-toggle') and text() = 'Any Context']")
+        assert has_link?(taxonomies(:location1), href: select_location_path(taxonomies(:location1)))
+        click_link(taxonomies(:location1))
+      end
+
+      # Page change within location context
+      within("li.org-switcher") do
+        assert has_selector?(:xpath, "//a[contains(@class, 'dropdown-toggle') and text() = '#{taxonomies(:location1).name}']")
+        click_link('Any Location')
+      end
+
+      # Page change out of location context
+      within("li.org-switcher") do
+        assert has_selector?(:xpath, "//a[contains(@class, 'dropdown-toggle') and text() = 'Any Context']")
+      end
+    end
+  end
+
   #PENDING - click on Menu Bar js
 end

test/integration_test_helper.rb

@@ -124,6 +124,13 @@ def set_request_user(user)
     user = users(user) unless user.is_a?(User)
     create_cookie('test_user', user.login)
   end
+
+  def with_controller_caching(*controller_klasses)
+    controller_klasses.each { |c| c.perform_caching = true }
+    yield
+  ensure
+    controller_klasses.each { |c| c.perform_caching = false }
+  end
 end
 
 class IntegrationTestWithJavascript < ActionDispatch::IntegrationTest