2016-06-23 11:14:31 -04:00
|
|
|
module API
|
|
|
|
class AccessRequests < Grape::API
|
|
|
|
before { authenticate! }
|
|
|
|
|
|
|
|
helpers ::API::Helpers::MembersHelpers
|
|
|
|
|
|
|
|
%w[group project].each do |source_type|
|
|
|
|
resource source_type.pluralize do
|
|
|
|
# Get a list of group/project access requests viewable by the authenticated user.
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The group/project ID
|
|
|
|
#
|
|
|
|
# Example Request:
|
|
|
|
# GET /groups/:id/access_requests
|
|
|
|
# GET /projects/:id/access_requests
|
|
|
|
get ":id/access_requests" do
|
|
|
|
source = find_source(source_type, params[:id])
|
|
|
|
authorize_admin_source!(source_type, source)
|
|
|
|
|
Improve the performance of the GET /:sources/:id/{access_requests,members} API endpoints
The performance was greatly improved by removing two N+1 queries issues
for each endpoint.
For comparison:
1. `GET /projects/:id/members`
With two N+1 queries issues (one was already fxed in the following
snippet):
```
ProjectMember Load (0.2ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL ORDER BY "members"."id" DESC [["source_type", "Project"],
["source_id", 1], ["source_type", "Project"]]
User Load (0.5ms) SELECT "users".* FROM "users" WHERE "users"."id" IN
(5, 22, 16, 13) ORDER BY "users"."id" DESC
ActiveRecord::SchemaMigration Load (0.2ms) SELECT
"schema_migrations".* FROM "schema_migrations"
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL AND "members"."user_id" = $4 ORDER BY "members"."id" DESC LIMIT 1
[["source_type", "Project"], ["source_id", 1], ["source_type",
"Project"], ["user_id", 5]]
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL AND "members"."user_id" = $4 ORDER BY "members"."id" DESC LIMIT 1
[["source_type", "Project"], ["source_id", 1], ["source_type",
"Project"], ["user_id", 22]]
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL AND "members"."user_id" = $4 ORDER BY "members"."id" DESC LIMIT 1
[["source_type", "Project"], ["source_id", 1], ["source_type",
"Project"], ["user_id", 16]]
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL AND "members"."user_id" = $4 ORDER BY "members"."id" DESC LIMIT 1
[["source_type", "Project"], ["source_id", 1], ["source_type",
"Project"], ["user_id", 13]]
```
Without the N+1 queries issues:
```
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND "members"."requested_at" IS
NULL ORDER BY "members"."id" DESC LIMIT 20 OFFSET 0 [["source_type",
"Project"], ["source_id", 1], ["source_type", "Project"]]
User Load (0.5ms) SELECT "users".* FROM "users" WHERE "users"."id" IN
(5, 22, 16, 13) ORDER BY "users"."id" DESC
```
2. `GET /projects/:id/access_requests`
With two N+1 queries issues:
```
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND ("members"."requested_at" IS
NOT NULL) ORDER BY "members"."id" DESC [["source_type", "Project"],
["source_id", 8], ["source_type", "Project"]]
User Load (0.1ms) SELECT "users".* FROM "users" WHERE "users"."id" =
$1 ORDER BY "users"."id" DESC LIMIT 1 [["id", 24]]
User Load (0.1ms) SELECT "users".* FROM "users" WHERE "users"."id" =
$1 ORDER BY "users"."id" DESC LIMIT 1 [["id", 23]]
ActiveRecord::SchemaMigration Load (0.2ms) SELECT
"schema_migrations".* FROM "schema_migrations"
ProjectMember Load (0.1ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND ("members"."requested_at" IS
NOT NULL) AND "members"."user_id" = $4 ORDER BY "members"."id" DESC
LIMIT 1 [["source_type", "Project"], ["source_id", 8], ["source_type",
"Project"], ["user_id", 24]]
ProjectMember Load (0.2ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND ("members"."requested_at" IS
NOT NULL) AND "members"."user_id" = $4 ORDER BY "members"."id" DESC
LIMIT 1 [["source_type", "Project"], ["source_id", 8], ["source_type",
"Project"], ["user_id", 23]]
```
Without the N+1 queries issues:
```
ProjectMember Load (0.3ms) SELECT "members".* FROM "members" WHERE
"members"."source_type" = $1 AND "members"."type" IN ('ProjectMember')
AND "members"."source_id" = $2 AND "members"."source_type" = $3 AND
"members"."type" IN ('ProjectMember') AND ("members"."requested_at" IS
NOT NULL) ORDER BY "members"."id" DESC LIMIT 20 OFFSET 0
[["source_type", "Project"], ["source_id", 8], ["source_type",
"Project"]]
User Load (0.5ms) SELECT "users".* FROM "users" WHERE "users"."id" IN
(24, 23) ORDER BY "users"."id" DESC
```
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-08-09 06:20:09 -04:00
|
|
|
access_requesters = paginate(source.requesters.includes(:user))
|
2016-06-23 11:14:31 -04:00
|
|
|
|
2016-09-15 12:34:57 -04:00
|
|
|
present access_requesters.map(&:user), with: Entities::AccessRequester, source: source
|
2016-06-23 11:14:31 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Request access to the group/project
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The group/project ID
|
|
|
|
#
|
|
|
|
# Example Request:
|
|
|
|
# POST /groups/:id/access_requests
|
|
|
|
# POST /projects/:id/access_requests
|
|
|
|
post ":id/access_requests" do
|
|
|
|
source = find_source(source_type, params[:id])
|
|
|
|
access_requester = source.request_access(current_user)
|
|
|
|
|
|
|
|
if access_requester.persisted?
|
|
|
|
present access_requester.user, with: Entities::AccessRequester, access_requester: access_requester
|
|
|
|
else
|
|
|
|
render_validation_error!(access_requester)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Approve a group/project access request
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The group/project ID
|
|
|
|
# user_id (required) - The user ID of the access requester
|
|
|
|
# access_level (optional) - Access level
|
|
|
|
#
|
|
|
|
# Example Request:
|
|
|
|
# PUT /groups/:id/access_requests/:user_id/approve
|
|
|
|
# PUT /projects/:id/access_requests/:user_id/approve
|
|
|
|
put ':id/access_requests/:user_id/approve' do
|
|
|
|
required_attributes! [:user_id]
|
|
|
|
source = find_source(source_type, params[:id])
|
|
|
|
authorize_admin_source!(source_type, source)
|
|
|
|
|
|
|
|
member = source.requesters.find_by!(user_id: params[:user_id])
|
|
|
|
if params[:access_level]
|
|
|
|
member.update(access_level: params[:access_level])
|
|
|
|
end
|
|
|
|
member.accept_request
|
|
|
|
|
|
|
|
status :created
|
|
|
|
present member.user, with: Entities::Member, member: member
|
|
|
|
end
|
|
|
|
|
|
|
|
# Deny a group/project access request
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The group/project ID
|
|
|
|
# user_id (required) - The user ID of the access requester
|
|
|
|
#
|
|
|
|
# Example Request:
|
|
|
|
# DELETE /groups/:id/access_requests/:user_id
|
|
|
|
# DELETE /projects/:id/access_requests/:user_id
|
|
|
|
delete ":id/access_requests/:user_id" do
|
|
|
|
required_attributes! [:user_id]
|
|
|
|
source = find_source(source_type, params[:id])
|
|
|
|
|
|
|
|
access_requester = source.requesters.find_by!(user_id: params[:user_id])
|
|
|
|
|
|
|
|
::Members::DestroyService.new(access_requester, current_user).execute
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|