[arvados] created: 2.7.0-6602-g8a47094aa4
git repository hosting
git at public.arvados.org
Tue May 21 17:54:21 UTC 2024
at 8a47094aa45b6352e71141c39f69c28c7f38b08c (commit)
commit 8a47094aa45b6352e71141c39f69c28c7f38b08c
Author: Tom Clegg <tom at curii.com>
Date: Tue May 21 13:53:23 2024 -0400
12917: Support include=container_uuid at groups#contents endpoint.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at curii.com>
diff --git a/services/api/app/controllers/arvados/v1/groups_controller.rb b/services/api/app/controllers/arvados/v1/groups_controller.rb
index be73d39dd1..11212e1b69 100644
--- a/services/api/app/controllers/arvados/v1/groups_controller.rb
+++ b/services/api/app/controllers/arvados/v1/groups_controller.rb
@@ -7,6 +7,7 @@ require "trashable"
class Arvados::V1::GroupsController < ApplicationController
include TrashableController
+ before_action :load_include_param, only: [:shared, :contents]
skip_before_action :find_object_by_uuid, only: :shared
skip_before_action :render_404_if_no_object, only: :shared
@@ -40,7 +41,7 @@ class Arvados::V1::GroupsController < ApplicationController
type: 'boolean', required: false, default: false, description: 'Include contents from child groups recursively.',
},
include: {
- type: 'string', required: false, description: 'Include objects referred to by listed field in "included" (only owner_uuid).',
+ type: 'array', required: false, description: 'Include objects referred to by listed fields in "included" response field. Subsets of ["owner_uuid", "container_uuid"] are supported.',
},
include_old_versions: {
type: 'boolean', required: false, default: false, description: 'Include past collection versions.',
@@ -130,6 +131,7 @@ class Arvados::V1::GroupsController < ApplicationController
end
def contents
+ @orig_select = @select
load_searchable_objects
list = {
:kind => "arvados#objectList",
@@ -143,7 +145,7 @@ class Arvados::V1::GroupsController < ApplicationController
list[:items_available] = @items_available
end
if @extra_included
- list[:included] = @extra_included.as_api_response(nil, {select: @select})
+ list[:included] = @extra_included.as_api_response(nil, {select: @orig_select})
end
send_json(list)
end
@@ -158,7 +160,6 @@ class Arvados::V1::GroupsController < ApplicationController
# This also returns (in the "included" field) the objects that own
# those projects (users or non-project groups).
#
- #
# The intended use of this endpoint is to support clients which
# wish to browse those projects which are visible to the user but
# are not part of the "home" project.
@@ -170,14 +171,22 @@ class Arvados::V1::GroupsController < ApplicationController
apply_where_limit_order_params
- if params["include"] == "owner_uuid"
+ if @include.include?("owner_uuid")
owners = @objects.map(&:owner_uuid).to_set
- @extra_included = []
+ @extra_included ||= []
[Group, User].each do |klass|
@extra_included += klass.readable_by(*@read_users).where(uuid: owners.to_a).to_a
end
end
+ if @include.include?("container_uuid")
+ @extra_included ||= []
+ container_uuids = @objects.map { |o|
+ o.respond_to?(:container_uuid) ? o.container_uuid : nil
+ }.compact.to_set.to_a
+ @extra_included += Container.where(uuid: container_uuids).to_a
+ end
+
index
end
@@ -189,6 +198,19 @@ class Arvados::V1::GroupsController < ApplicationController
protected
+ def load_include_param
+ @include = params[:include]
+ if @include.nil? || @include == ""
+ @include = Set[]
+ elsif @include.is_a?(String) && @include.start_with?('[')
+ @include = SafeJSON.load(@include).to_set
+ elsif @include.is_a?(String)
+ @include = Set[@include]
+ else
+ return send_error("'include' parameter must be a string or array", status: 422)
+ end
+ end
+
def load_searchable_objects
all_objects = []
@items_available = 0
@@ -262,6 +284,9 @@ class Arvados::V1::GroupsController < ApplicationController
klasses.each do |klass|
all_attributes.concat klass.selectable_attributes
end
+ if klasses.include?(ContainerRequest) && @include.include?("container_uuid")
+ all_attributes.concat Container.selectable_attributes
+ end
@select.each do |check|
if !all_attributes.include? check
raise ArgumentError.new "Invalid attribute '#{check}' in select"
@@ -371,7 +396,7 @@ class Arvados::V1::GroupsController < ApplicationController
limit_all = all_objects.count
end
- if params["include"] == "owner_uuid"
+ if @include.include?("owner_uuid")
owners = klass_object_list[:items].map {|i| i[:owner_uuid]}.to_set
[Group, User].each do |ownerklass|
ownerklass.readable_by(*@read_users).where(uuid: owners.to_a).each do |ow|
@@ -379,6 +404,13 @@ class Arvados::V1::GroupsController < ApplicationController
end
end
end
+
+ if @include.include?("container_uuid") && klass == ContainerRequest
+ containers = klass_object_list[:items].collect { |cr| cr[:container_uuid] }.to_set
+ Container.where(uuid: containers.to_a).each do |c|
+ included_by_uuid[c.uuid] = c
+ end
+ end
end
# Only error out when every searchable object type errored out
@@ -389,7 +421,7 @@ class Arvados::V1::GroupsController < ApplicationController
raise ArgumentError.new(error_msg)
end
- if params["include"]
+ if !@include.empty?
@extra_included = included_by_uuid.values
end
@@ -420,5 +452,4 @@ class Arvados::V1::GroupsController < ApplicationController
"EXISTS(SELECT 1 FROM groups as gp where gp.uuid=#{klass.table_name}.owner_uuid and gp.group_class != 'project')",
user_uuid: current_user.uuid)
end
-
end
diff --git a/services/api/test/functional/arvados/v1/groups_controller_test.rb b/services/api/test/functional/arvados/v1/groups_controller_test.rb
index 6e167bb91e..52ed140bae 100644
--- a/services/api/test/functional/arvados/v1/groups_controller_test.rb
+++ b/services/api/test/functional/arvados/v1/groups_controller_test.rb
@@ -947,6 +947,7 @@ class Arvados::V1::GroupsControllerTest < ActionController::TestCase
end
get :contents, params: {:include => "owner_uuid", :exclude_home_project => true}
+ assert_response 200
assert_equal 1, json_response['items'].length
assert_equal groups(:project_owned_by_foo).uuid, json_response['items'][0]["uuid"]
@@ -963,6 +964,42 @@ class Arvados::V1::GroupsControllerTest < ActionController::TestCase
assert_response 422
end
+ [[false, 'owner_uuid'],
+ [false, []],
+ [false, ''],
+ [true, 'container_uuid'],
+ [true, ['container_uuid']],
+ [true, ['owner_uuid', 'container_uuid'], ['uuid', 'container_uuid', 'state', 'output']],
+ ].each do |check_container_included, include_param, select_param|
+ test "contents, include=#{include_param.inspect}" do
+ authorize_with :active
+ get :contents, params: {
+ :id => users(:active).uuid,
+ :include => include_param,
+ :limit => 1000,
+ :select => select_param,
+ }
+ assert_response 200
+ if include_param.empty?
+ assert_equal false, json_response.include?('included')
+ return
+ end
+ incl = {}
+ json_response['included'].andand.each do |ctr|
+ incl[ctr['uuid']] = ctr
+ end
+ next if !check_container_included
+ checked_crs = 0
+ json_response['items'].each do |item|
+ next if !item['container_uuid']
+ assert_equal item['container_uuid'], incl[item['container_uuid']]['uuid']
+ assert_not_empty incl[item['container_uuid']]['state']
+ checked_crs += 1
+ end
+ assert_operator 0, :<, checked_crs
+ end
+ end
+
test "include_trash does not return trash inside frozen project" do
authorize_with :active
trashtime = Time.now - 1.second
diff --git a/services/api/test/integration/groups_test.rb b/services/api/test/integration/groups_test.rb
index bc5a08c2c8..4c688756d7 100644
--- a/services/api/test/integration/groups_test.rb
+++ b/services/api/test/integration/groups_test.rb
@@ -157,6 +157,23 @@ class GroupsTest < ActionDispatch::IntegrationTest
end
end
end
+
+ test "group contents with include=array" do
+ get "/arvados/v1/groups/contents",
+ params: {
+ filters: [["uuid", "is_a", "arvados#container_request"]].to_json,
+ include: ["container_uuid"].to_json,
+ select: ["uuid", "state"],
+ limit: 1000,
+ },
+ headers: auth(:active)
+ assert_response 200
+ incl = {}
+ json_response['included'].each { |i| incl[i['uuid']] = i }
+ json_response['items'].each do |c|
+ assert_not_nil incl[c['container_uuid']]['state']
+ end
+ end
end
class NonTransactionalGroupsTest < ActionDispatch::IntegrationTest
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list