diff --git a/app/assets/stylesheets/base/_facets.scss b/app/assets/stylesheets/base/_facets.scss index 3df026424..9ca4e8695 100644 --- a/app/assets/stylesheets/base/_facets.scss +++ b/app/assets/stylesheets/base/_facets.scss @@ -56,7 +56,7 @@ ul.unstyled { width: 100%; } -.nav-item > a { +.nav-item > a, .nav-item > span { position: relative; display: block; color: #333; diff --git a/app/controllers/concerns/searchable_index.rb b/app/controllers/concerns/searchable_index.rb index d99eab3fa..492bd26e9 100644 --- a/app/controllers/concerns/searchable_index.rb +++ b/app/controllers/concerns/searchable_index.rb @@ -20,6 +20,7 @@ module SearchableIndex included do attr_reader :facet_fields, :search_params, :facet_params, :page, :sort_by, :index_resources before_action :set_params, only: [:index, :count] + before_action :limit_filters, only: [:index, :count] before_action :fetch_resources, only: [:index, :count] helper 'search' @@ -141,4 +142,11 @@ def pagination_params def search_and_facet_params params.permit(*(@model.search_and_facet_keys | [:page_size, :page_number, :page, :per_page])) end + + def limit_filters + if !request.format.json? && !request.format.json_api? && current_user.nil? && @facet_params&.values && + TeSS::Config.filter_limit && @facet_params.values.flatten.length > TeSS::Config.filter_limit + handle_error(400, t('search.errors.filter_limit_reached')) + end + end end \ No newline at end of file diff --git a/app/helpers/search_helper.rb b/app/helpers/search_helper.rb index e7788b5cc..dcd7bd6ea 100644 --- a/app/helpers/search_helper.rb +++ b/app/helpers/search_helper.rb @@ -29,7 +29,7 @@ def filter_link(name, value, count, html_options = {}, &block) parameters.delete('page') #remove the page option if it exists html_options.reverse_merge!(title: value.to_s) - link_to parameters, html_options do + content = -> do if block_given? block.call else @@ -37,6 +37,14 @@ def filter_link(name, value, count, html_options = {}, &block) content_tag(:span, "#{count}", class: 'facet-count') end end + + if filter_limit_reached? + html_options[:class] = [html_options[:class], 'filter-limit-reached'].compact.join(' ') + + content_tag(:span, html_options, &content) + else + link_to parameters, html_options, &content + end end def remove_filter_link(name, value, html_options = {}, &block) @@ -75,4 +83,9 @@ def toggle_hidden_facet_link facet ".html_safe end + + def filter_limit_reached? + current_user.nil? && @facet_params&.values && TeSS::Config.filter_limit && + @facet_params.values.flatten.length >= TeSS::Config.filter_limit + end end diff --git a/app/views/search/common/_facet_sidebar_boolean_filter.html.erb b/app/views/search/common/_facet_sidebar_boolean_filter.html.erb index 11337528d..7350fcbf2 100644 --- a/app/views/search/common/_facet_sidebar_boolean_filter.html.erb +++ b/app/views/search/common/_facet_sidebar_boolean_filter.html.erb @@ -19,7 +19,7 @@
  • <%= filter_link(facet_field, 'true', count) do %> <%= enable_text %> diff --git a/app/views/search/common/_search_panel.html.erb b/app/views/search/common/_search_panel.html.erb index 9631b644a..14d7f9ed8 100644 --- a/app/views/search/common/_search_panel.html.erb +++ b/app/views/search/common/_search_panel.html.erb @@ -21,6 +21,9 @@ <%= content_for(:display_options) %> <% if TeSS::Config.solr_enabled %> + <% if filter_limit_reached? %> +
    <%= t('search.errors.filter_limit_reached') %>
    + <% end %> diff --git a/config/locales/en.yml b/config/locales/en.yml index c60e6c4e5..04944a6bc 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -1197,7 +1197,6 @@ en: Groups is a feature which for now is used only to manage access of private spaces. A user being part of a group has access to every private space which requires the group. Each group has multiple owners. A owner can add and remove people to the group. - orcid: orcid: error: 'An error occurred whilst trying to authenticate your ORCID.' link: 'Link your ORCID' @@ -1240,4 +1239,7 @@ en: info: "This %{resource_type} originated from another TeSS registry. For complete, up-to-date information, please visit the original entry:" link: Go to original entry other_space: - link: View in space \ No newline at end of file + link: View in space + search: + errors: + filter_limit_reached: Filter limit reached, please log in to apply additional filters. \ No newline at end of file diff --git a/config/tess.example.yml b/config/tess.example.yml index c8a51db5e..7e05df924 100644 --- a/config/tess.example.yml +++ b/config/tess.example.yml @@ -288,6 +288,7 @@ default: &default space: primary: '#260252' secondary: '#5c29b1' + filter_limit: # Maximum number of filter values allowed for anonymous users development: <<: *default diff --git a/test/controllers/materials_controller_test.rb b/test/controllers/materials_controller_test.rb index c667f058c..6c181f12a 100644 --- a/test/controllers/materials_controller_test.rb +++ b/test/controllers/materials_controller_test.rb @@ -1763,4 +1763,83 @@ class MaterialsControllerTest < ActionController::TestCase assert_select '#space-info', count: 0 end end + + test 'displays warning when filter limit reached for anonymous users' do + with_settings(solr_enabled: true, filter_limit: 2) do + Material.stub(:search_and_filter, MockSearch.new(Material.all)) do + get :index, params: { keywords: ['dancing', 'singing'] } + + assert_response :success + end + end + + assert_select 'div.alert', text: /Filter limit reached/ + assert_select '.facet-option.filter-limit-reached' + end + + test 'does not display filter limit warning for logged-in users' do + sign_in(@user) + + with_settings(solr_enabled: true, filter_limit: 2) do + Material.stub(:search_and_filter, MockSearch.new(Material.all)) do + get :index, params: { keywords: ['dancing', 'singing'] } + + assert_response :success + end + end + + assert_select 'div.alert', text: /Filter limit reached/, count: 0 + assert_select '.facet-option.filter-limit-reached', count: 0 + end + + test 'throws error if filter limit exceeded for anonymous users' do + with_settings(solr_enabled: true, filter_limit: 2) do + Material.stub(:search_and_filter, MockSearch.new(Material.all)) do + get :index, params: { keywords: ['dancing', 'singing', 'acrobatics'] } + + assert_response :bad_request + end + end + + assert_select '#error-message', text: /Filter limit reached/ + end + + test 'does not throw error if filter limit exceeded for logged-in users' do + sign_in(@user) + + with_settings(solr_enabled: true, filter_limit: 2) do + Material.stub(:search_and_filter, MockSearch.new(Material.all)) do + get :index, params: { keywords: ['dancing', 'singing', 'acrobatics'] } + + assert_response :success + end + end + + assert_select '#error-message', count: 0 + assert_select 'div.alert', text: /Filter limit reached/, count: 0 + assert_select '.facet-option.filter-limit-reached', count: 0 + end + + test 'does not throw error if filter limit exceeded for API requests' do + with_settings(solr_enabled: true, filter_limit: 2) do + Material.stub(:search_and_filter, MockSearch.new(Material.all)) do + get :index, params: { keywords: ['dancing', 'singing', 'acrobatics'], format: :json_api } + + assert_response :success + assert_not_nil assigns(:materials) + assert_valid_json_api_response + body = nil + assert_nothing_raised do + body = JSON.parse(response.body) + end + + assert body['data'].any? + assert body['meta']['results-count'] > 0 + assert_includes body['meta']['facets']['keywords'], 'acrobatics' + assert body['meta']['available-facets'].keys.any? + assert body['meta']['available-facets'].values.any? + assert body['links']['self'].include?('acrobatics') + end + end + end end