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

introduce setting to switch between sql strategies

ulfertse14e1c168df2
diff --git a/app/models/work_packages/scopes/allowed_to.rb b/app/models/work_packages/scopes/allowed_to.rb
index 620d5c2bffc..da5776a8109 100644
--- a/app/models/work_packages/scopes/allowed_to.rb
+++ b/app/models/work_packages/scopes/allowed_to.rb
@@ -36,46 +36,67 @@ module WorkPackages::Scopes
# Returns an ActiveRecord::Relation to find all work packages for which
# +user+ has the given +permission+ either directly on the work package
# or by the linked project
- def allowed_to(user, permission) # rubocop:disable Metrics/AbcSize
+ def allowed_to(user, permission) # rubocop:disable Metrics/PerceivedComplexity
permissions = Authorization.contextual_permissions(permission, :work_package, raise_on_unknown: true)
return none if user.locked?
return none if permissions.empty?
if user.admin? && permissions.all?(&:grant_to_admin?)
- where(id: allowed_to_admin_relation(permissions))
+ admin_allowed_to(permissions)
elsif user.anonymous?
- where(project_id: Project.allowed_to(user, permissions))
+ anonymous_allowed_to(user, permissions)
+ elsif Setting.large_instance_wp_allowed_to_sql?
+ logged_in_non_admin_allowed_to_large_instances(user, permissions)
else
- # allowed_via_wp_membership = allowed_to_member_relation(user, permissions)
- allowed_via_project_or_work_package_membership = Project.unscoped.allowed_to_member_union(user,
- permissions,
- entity_types: ["WorkPackage"])
-
- allowed_by_projects_and_work_packages = Arel.sql(<<~SQL.squish)
- SELECT * from work_packages
- WHERE project_id in (SELECT id FROM allowed_projects)
- /* Take all work packages allowed by either project wide or entity specific membership
- But now remove all those that are in a project for which an entity specific membership exists (but is not for that entity)
- unless there is also a project specific membership in that same project. */
+ logged_in_non_admin_allowed_to_small_instances(user, permissions)
+ end
+ end
+
+ private
+
+ def admin_allowed_to(permissions)
+ where(id: allowed_to_admin_relation(permissions))
+ end
+
+ def anonymous_allowed_to(user, permissions)
+ where(project_id: Project.allowed_to(user, permissions))
+ end
+
+ def logged_in_non_admin_allowed_to_small_instances(user, permissions)
+ allowed_via_wp_membership = allowed_to_member_relation(user, permissions)
+ allowed_via_project_membership = Project.unscoped.allowed_to(user, permissions)
+
+ where(project_id: allowed_via_project_membership.select(:id))
+ .or(where(id: allowed_via_wp_membership.select(arel_table[:id])))
+ end
+
+ def logged_in_non_admin_allowed_to_large_instances(user, permissions)
+ allowed_via_project_or_work_package_membership = Project.unscoped.allowed_to_member_union(user,
+ permissions,
+ entity_types: ["WorkPackage"])
+
+ allowed_by_projects_and_work_packages = Arel.sql(<<~SQL.squish)
+ SELECT * from work_packages
+ WHERE project_id in (SELECT id FROM allowed_projects)
+ /* Take all work packages allowed by either project wide or entity specific membership
+ But now remove all those that are in a project for which an entity specific membership exists (but is not for that entity)
+ unless there is also a project specific membership in that same project. */
+ AND NOT EXISTS (
+ SELECT 1 FROM allowed_projects
+ WHERE allowed_projects.id = project_id AND allowed_projects.entity_id IS NOT NULL AND allowed_projects.entity_id != work_packages.id
AND NOT EXISTS (
SELECT 1 FROM allowed_projects
- WHERE allowed_projects.id = project_id AND allowed_projects.entity_id IS NOT NULL AND allowed_projects.entity_id != work_packages.id
- AND NOT EXISTS (
- SELECT 1 FROM allowed_projects
- WHERE allowed_projects.id = project_id AND allowed_projects.entity_id IS NULL
- )
+ WHERE allowed_projects.id = project_id AND allowed_projects.entity_id IS NULL
)
- SQL
+ )
+ SQL
- with(allowed_projects: Arel.sql(allowed_via_project_or_work_package_membership.to_sql),
- allowed_by_projects_and_work_packages:)
- .from("allowed_by_projects_and_work_packages work_packages")
- end
+ with(allowed_projects: Arel.sql(allowed_via_project_or_work_package_membership.to_sql),
+ allowed_by_projects_and_work_packages:)
+ .from("allowed_by_projects_and_work_packages work_packages")
end
- private
-
def allowed_to_admin_relation(permissions)
unscoped
.joins(:project)
diff --git a/config/constants/settings/definition.rb b/config/constants/settings/definition.rb
index 9da4db2930c..38145d0b631 100644
--- a/config/constants/settings/definition.rb
+++ b/config/constants/settings/definition.rb
@@ -622,6 +622,11 @@ module Settings
journal_aggregation_time_minutes: {
default: 5
},
+ large_instance_wp_allowed_to_sql: {
+ description: "When querying for allowed work packages, use SQL better suited for instances " \
+ "with a larger set of work packages, projects, members and users",
+ default: false
+ },
ldap_force_no_page: {
description: "Force LDAP to respond as a single page, in case paged responses do not work with your server.",
format: :string,
diff --git a/spec/models/work_packages/scopes/allowed_to_spec.rb b/spec/models/work_packages/scopes/allowed_to_spec.rb
index a566837527a..cc54b2dea1d 100644
--- a/spec/models/work_packages/scopes/allowed_to_spec.rb
+++ b/spec/models/work_packages/scopes/allowed_to_spec.rb
@@ -119,103 +119,142 @@ RSpec.describe WorkPackage, ".allowed_to" do
end
end
- context "when the user has the permission directly on the work package" do
- let(:work_package_permissions) { [action] }
-
- before do
- create(:member, project: private_project, entity: work_package_in_private_project,
- user:, roles: [work_package_role])
- end
-
- subject { described_class.allowed_to(user, action) }
-
- it "returns the authorized work package" do
- expect(subject).to contain_exactly(work_package_in_private_project)
- end
-
- context "when the project is archived" do
- before do
- public_project.update!(active: false)
- private_project.update!(active: false)
+ context "when the user is a non admin, logged in user" do
+ shared_context "for a non admin, logged in user" do
+ context "when the user has the permission directly on the work package" do
+ let(:work_package_permissions) { [action] }
+
+ before do
+ create(:member, project: private_project, entity: work_package_in_private_project,
+ user:, roles: [work_package_role])
+ end
+
+ subject { described_class.allowed_to(user, action) }
+
+ it "returns the authorized work package" do
+ expect(subject).to contain_exactly(work_package_in_private_project)
+ end
+
+ context "when the project is archived" do
+ before do
+ public_project.update!(active: false)
+ private_project.update!(active: false)
+ end
+
+ it "returns no work packages" do
+ expect(subject).to be_empty
+ end
+ end
+
+ context "when the user is locked" do
+ before do
+ user.locked!
+ end
+
+ it "returns no work packages" do
+ expect(subject).to be_empty
+ end
+ end
end
- it "returns no work packages" do
- expect(subject).to be_empty
+ context "when the user has the permission on the project the work package belongs to" do
+ let(:project_permissions) { [action] }
+
+ before do
+ create(:member, project: private_project, user:, roles: [project_role])
+ end
+
+ subject { described_class.allowed_to(user, action) }
+
+ it "returns the authorized work packages" do
+ expect(subject).to contain_exactly(
+ work_package_in_private_project,
+ other_work_package_in_private_project
+ )
+ end
+
+ context "when the project is archived" do
+ before do
+ public_project.update!(active: false)
+ private_project.update!(active: false)
+ end
+
+ it "returns no work packages" do
+ expect(subject).to be_empty
+ end
+ end
+
+ context "when the user is locked" do
+ before do
+ user.locked!
+ end
+
+ it "returns no work packages" do
+ expect(subject).to be_empty
+ end
+ end
end
- end
- context "when the user is locked" do
- before do
- user.locked!
- end
+ context "when the user has a different permission on the project, but the requested one on a specific work package" do
+ let(:project_permissions) { [:view_work_packages] }
+ let(:work_package_permissions) { %i[view_work_packages edit_work_packages] }
- it "returns no work packages" do
- expect(subject).to be_empty
- end
- end
- end
+ before do
+ create(:member, project: private_project, entity: work_package_in_private_project, user:, roles: [work_package_role])
+ create(:member, project: private_project, user:, roles: [project_role])
+ end
- context "when the user has the permission on the project the work package belongs to" do
- let(:project_permissions) { [action] }
+ context "and requesting a permission that is only granted on the single work package" do
+ subject { described_class.allowed_to(user, :edit_work_packages) }
- before do
- create(:member, project: private_project, user:, roles: [project_role])
- end
-
- subject { described_class.allowed_to(user, action) }
+ it "returns the authorized work packages" do
+ expect(subject).to contain_exactly(work_package_in_private_project)
+ end
+ end
- it "returns the authorized work packages" do
- expect(subject).to contain_exactly(
- work_package_in_private_project,
- other_work_package_in_private_project
- )
- end
+ context "and requesting a permission that is granted on the project and the work package" do
+ subject { described_class.allowed_to(user, :view_work_packages) }
- context "when the project is archived" do
- before do
- public_project.update!(active: false)
- private_project.update!(active: false)
+ it "returns the authorized work packages" do
+ expect(subject).to contain_exactly(work_package_in_private_project, other_work_package_in_private_project)
+ end
+ end
end
- it "returns no work packages" do
- expect(subject).to be_empty
- end
- end
+ context "when the user isn`t member in the project" do
+ let(:user) { create(:user) }
+ let(:action) { :view_work_packages }
- context "when the user is locked" do
- before do
- user.locked!
- end
+ before do
+ non_member_role.save!
+ end
- it "returns no work packages" do
- expect(subject).to be_empty
- end
- end
- end
+ subject { described_class.allowed_to(user, action) }
- context "when the user has a different permission on the project, but the requested one on a specific work package" do
- let(:project_permissions) { [:view_work_packages] }
- let(:work_package_permissions) { %i[view_work_packages edit_work_packages] }
+ context "with the non member role having the permission" do
+ let(:non_member_permissions) { [action] }
- before do
- create(:member, project: private_project, entity: work_package_in_private_project, user:, roles: [work_package_role])
- create(:member, project: private_project, user:, roles: [project_role])
- end
+ it "returns work packages in the public project" do
+ expect(subject).to contain_exactly(work_package_in_public_project)
+ end
+ end
- context "and requesting a permission that is only granted on the single work package" do
- subject { described_class.allowed_to(user, :edit_work_packages) }
+ context "with the non member role lacking the permission" do
+ let(:non_member_permissions) { [] }
- it "returns the authorized work packages" do
- expect(subject).to contain_exactly(work_package_in_private_project)
+ it "is empty" do
+ expect(subject).to be_empty
+ end
+ end
end
end
- context "and requesting a permission that is granted on the project and the work package" do
- subject { described_class.allowed_to(user, :view_work_packages) }
+ context "in non large instances", with_settings: { large_instance_wp_allowed_to_sql: false } do
+ include_context "for a non admin, logged in user"
+ end
- it "returns the authorized work packages" do
- expect(subject).to contain_exactly(work_package_in_private_project, other_work_package_in_private_project)
- end
+ context "in large instances", with_settings: { large_instance_wp_allowed_to_sql: true } do
+ include_context "for a non admin, logged in user"
end
end
@@ -245,31 +284,4 @@ RSpec.describe WorkPackage, ".allowed_to" do
end
end
end
-
- context "when the user isn`t member in the project" do
- let(:user) { create(:user) }
- let(:action) { :view_work_packages }
-
- before do
- non_member_role.save!
- end
-
- subject { described_class.allowed_to(user, action) }
-
- context "with the non member role having the permission" do
- let(:non_member_permissions) { [action] }
-
- it "returns work packages in the public project" do
- expect(subject).to contain_exactly(work_package_in_public_project)
- end
- end
-
- context "with the non member role lacking the permission" do
- let(:non_member_permissions) { [] }
-
- it "is empty" do
- expect(subject).to be_empty
- end
- end
- end
end