2018-07-18 16:03:33 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-12-06 16:31:58 +00:00
|
|
|
module Users
|
|
|
|
# Service for refreshing the authorized projects of a user.
|
|
|
|
#
|
|
|
|
# This particular service class can not be used to update data for the same
|
|
|
|
# user concurrently. Doing so could lead to an incorrect state. To ensure this
|
|
|
|
# doesn't happen a caller must synchronize access (e.g. using
|
|
|
|
# `Gitlab::ExclusiveLease`).
|
|
|
|
#
|
|
|
|
# Usage:
|
|
|
|
#
|
|
|
|
# user = User.find_by(username: 'alice')
|
|
|
|
# service = Users::RefreshAuthorizedProjectsService.new(some_user)
|
|
|
|
# service.execute
|
|
|
|
class RefreshAuthorizedProjectsService
|
|
|
|
attr_reader :user
|
|
|
|
|
|
|
|
LEASE_TIMEOUT = 1.minute.to_i
|
|
|
|
|
|
|
|
# user - The User for which to refresh the authorized projects.
|
2020-02-13 21:08:59 +00:00
|
|
|
def initialize(user, incorrect_auth_found_callback: nil, missing_auth_found_callback: nil)
|
2016-12-06 16:31:58 +00:00
|
|
|
@user = user
|
2020-02-13 21:08:59 +00:00
|
|
|
@incorrect_auth_found_callback = incorrect_auth_found_callback
|
|
|
|
@missing_auth_found_callback = missing_auth_found_callback
|
2016-12-06 16:31:58 +00:00
|
|
|
|
|
|
|
# We need an up to date User object that has access to all relations that
|
|
|
|
# may have been created earlier. The only way to ensure this is to reload
|
|
|
|
# the User object.
|
2019-04-08 13:33:36 +00:00
|
|
|
user.reset
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def execute
|
2017-01-16 21:34:13 +00:00
|
|
|
lease_key = "refresh_authorized_projects:#{user.id}"
|
|
|
|
lease = Gitlab::ExclusiveLease.new(lease_key, timeout: LEASE_TIMEOUT)
|
|
|
|
|
|
|
|
until uuid = lease.try_obtain
|
|
|
|
# Keep trying until we obtain the lease. If we don't do so we may end up
|
|
|
|
# not updating the list of authorized projects properly. To prevent
|
|
|
|
# hammering Redis too much we'll wait for a bit between retries.
|
2017-06-19 14:12:05 +00:00
|
|
|
sleep(0.1)
|
2017-01-16 21:34:13 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
begin
|
|
|
|
execute_without_lease
|
|
|
|
ensure
|
|
|
|
Gitlab::ExclusiveLease.cancel(lease_key, uuid)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# This method returns the updated User object.
|
|
|
|
def execute_without_lease
|
2016-12-06 16:31:58 +00:00
|
|
|
current = current_authorizations_per_project
|
|
|
|
fresh = fresh_access_levels_per_project
|
|
|
|
|
|
|
|
remove = current.each_with_object([]) do |(project_id, row), array|
|
|
|
|
# rows not in the new list or with a different access level should be
|
|
|
|
# removed.
|
|
|
|
if !fresh[project_id] || fresh[project_id] != row.access_level
|
2020-02-13 21:08:59 +00:00
|
|
|
if incorrect_auth_found_callback
|
|
|
|
incorrect_auth_found_callback.call(project_id, row.access_level)
|
|
|
|
end
|
|
|
|
|
2017-01-06 17:26:06 +00:00
|
|
|
array << row.project_id
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
add = fresh.each_with_object([]) do |(project_id, level), array|
|
|
|
|
# rows not in the old list or with a different access level should be
|
|
|
|
# added.
|
|
|
|
if !current[project_id] || current[project_id].access_level != level
|
2020-02-13 21:08:59 +00:00
|
|
|
if missing_auth_found_callback
|
|
|
|
missing_auth_found_callback.call(project_id, level)
|
|
|
|
end
|
|
|
|
|
2016-12-06 16:31:58 +00:00
|
|
|
array << [user.id, project_id, level]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-01-16 21:34:13 +00:00
|
|
|
update_authorizations(remove, add)
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
# Updates the list of authorizations for the current user.
|
|
|
|
#
|
|
|
|
# remove - The IDs of the authorization rows to remove.
|
|
|
|
# add - Rows to insert in the form `[user id, project id, access level]`
|
|
|
|
def update_authorizations(remove = [], add = [])
|
Use CTEs for nested groups and authorizations
This commit introduces the usage of Common Table Expressions (CTEs) to
efficiently retrieve nested group hierarchies, without having to rely on
the "routes" table (which is an _incredibly_ inefficient way of getting
the data). This requires a patch to ActiveRecord (found in the added
initializer) to work properly as ActiveRecord doesn't support WITH
statements properly out of the box.
Unfortunately MySQL provides no efficient way of getting nested groups.
For example, the old routes setup could easily take 5-10 seconds
depending on the amount of "routes" in a database. Providing vastly
different logic for both MySQL and PostgreSQL will negatively impact the
development process. Because of this the various nested groups related
methods return empty relations when used in combination with MySQL.
For project authorizations the logic is split up into two classes:
* Gitlab::ProjectAuthorizations::WithNestedGroups
* Gitlab::ProjectAuthorizations::WithoutNestedGroups
Both classes get the fresh project authorizations (= as they should be
in the "project_authorizations" table), including nested groups if
PostgreSQL is used. The logic of these two classes is quite different
apart from their public interface. This complicates development a bit,
but unfortunately there is no way around this.
This commit also introduces Gitlab::GroupHierarchy. This class can be
used to get the ancestors and descendants of a base relation, or both by
using a UNION. This in turn is used by methods such as:
* Namespace#ancestors
* Namespace#descendants
* User#all_expanded_groups
Again this class relies on CTEs and thus only works on PostgreSQL. The
Namespace methods will return an empty relation when MySQL is used,
while User#all_expanded_groups will return only the groups a user is a
direct member of.
Performance wise the impact is quite large. For example, on GitLab.com
Namespace#descendants used to take around 580 ms to retrieve data for a
particular user. Using CTEs we are able to reduce this down to roughly 1
millisecond, returning the exact same data.
== On The Fly Refreshing
Refreshing of authorizations on the fly (= when
users.authorized_projects_populated was not set) is removed with this
commit. This simplifies the code, and ensures any queries used for
authorizations are not mutated because they are executed in a Rails
scope (e.g. Project.visible_to_user).
This commit includes a migration to schedule refreshing authorizations
for all users, ensuring all of them have their authorizations in place.
Said migration schedules users in batches of 5000, with 5 minutes
between every batch to smear the load around a bit.
== Spec Changes
This commit also introduces some changes to various specs. For example,
some specs for ProjectTeam assumed that creating a personal project
would _not_ lead to the owner having access, which is incorrect. Because
we also no longer refresh authorizations on the fly for new users some
code had to be added to the "empty_project" factory. This chunk of code
ensures that the owner's permissions are refreshed after creating the
project, something that is normally done in Projects::CreateService.
2017-04-24 15:19:22 +00:00
|
|
|
return if remove.empty? && add.empty?
|
2016-12-06 16:31:58 +00:00
|
|
|
|
|
|
|
User.transaction do
|
|
|
|
user.remove_project_authorizations(remove) unless remove.empty?
|
|
|
|
ProjectAuthorization.insert_authorizations(add) unless add.empty?
|
|
|
|
end
|
|
|
|
|
|
|
|
# Since we batch insert authorization rows, Rails' associations may get
|
|
|
|
# out of sync. As such we force a reload of the User object.
|
2019-04-08 13:33:36 +00:00
|
|
|
user.reset
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def fresh_access_levels_per_project
|
|
|
|
fresh_authorizations.each_with_object({}) do |row, hash|
|
|
|
|
hash[row.project_id] = row.access_level
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def current_authorizations_per_project
|
2017-03-16 15:22:09 +00:00
|
|
|
current_authorizations.index_by(&:project_id)
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_authorizations
|
2017-01-06 17:26:06 +00:00
|
|
|
user.project_authorizations.select(:project_id, :access_level)
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def fresh_authorizations
|
2019-07-24 09:20:54 +00:00
|
|
|
Gitlab::ProjectAuthorizations.new(user).calculate
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
2020-02-13 21:08:59 +00:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
attr_reader :incorrect_auth_found_callback, :missing_auth_found_callback
|
2016-12-06 16:31:58 +00:00
|
|
|
end
|
|
|
|
end
|