Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

support existing storied queries and clients by allowing favored filter

ulferts280127117f9a
diff --git a/app/components/projects/projects_filters_component.rb b/app/components/projects/projects_filters_component.rb
index 35b284cd572..b992cebd33b 100644
--- a/app/components/projects/projects_filters_component.rb
+++ b/app/components/projects/projects_filters_component.rb
@@ -62,6 +62,12 @@ class Projects::ProjectsFiltersComponent < Filter::FilterComponent
Queries::Projects::Filters::TypeFilter
]
- allowlist.any? { |clazz| filter.is_a? clazz }
+ # FavoritedFilter used to be called favored. The filter should not break for stored queries. Therefore,
+ # the filter is instantiated twice, once for "favorited", once for "favored".
+ # At the same time, the "Favorite" filter should not be displayed twice in the filter list.
+ # Removing it here has the drawback of a stored "favored" filter not showing up in the component.
+ # This is accepted.
+
+ allowlist.any? { |clazz| filter.is_a? clazz } && filter.name != :favored
end
end
diff --git a/app/models/queries/projects/filters/favorited_filter.rb b/app/models/queries/projects/filters/favorited_filter.rb
index 11039427f73..65b17e6093b 100644
--- a/app/models/queries/projects/filters/favorited_filter.rb
+++ b/app/models/queries/projects/filters/favorited_filter.rb
@@ -32,7 +32,20 @@ class Queries::Projects::Filters::FavoritedFilter < Queries::Projects::Filters::
include Queries::Filters::Shared::BooleanFilter
def self.key
- :favorited
+ # The filter used to be called favored.
+ # To support:
+ # * Stored queries
+ # * API clients
+ # having that filter, the old key is also supported.
+ /favorited|favored/
+ end
+
+ def self.all_for(context = nil)
+ # Override superclass method to support the old name of the filter (see above).
+ [
+ create!(name: :favorited, context:),
+ create!(name: :favored, context:)
+ ]
end
def human_name