X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/611a3323ea110671c5fa021e14f93b24e4a6d7b7..37e995fb7423b2b353c599e2a1b00bda7c29ee6f:/services/api/lib/load_param.rb diff --git a/services/api/lib/load_param.rb b/services/api/lib/load_param.rb index 8d5a9d21ee..3e1e8b5eba 100644 --- a/services/api/lib/load_param.rb +++ b/services/api/lib/load_param.rb @@ -6,7 +6,7 @@ # @where, @filters, @limit, @offset, @orders module LoadParam - # Default limit on number of rows to return in a single query. + # Default number of rows to return in a single query. DEFAULT_LIMIT = 100 # Load params[:where] into @where @@ -17,7 +17,7 @@ module LoadParam @where = params[:where] elsif params[:where].is_a? String begin - @where = Oj.load(params[:where]) + @where = SafeJSON.load(params[:where]) raise unless @where.is_a? Hash rescue raise ArgumentError.new("Could not parse \"where\" param as an object") @@ -33,7 +33,7 @@ module LoadParam @filters += params[:filters] elsif params[:filters].is_a? String and !params[:filters].empty? begin - f = Oj.load params[:filters] + f = SafeJSON.load(params[:filters]) if not f.nil? raise unless f.is_a? Array @filters += f @@ -44,10 +44,6 @@ module LoadParam end end - def default_orders - ["#{table_name}.modified_at desc"] - end - # Load params[:limit], params[:offset] and params[:order] # into @limit, @offset, @orders def load_limit_offset_order_params @@ -55,7 +51,8 @@ module LoadParam unless params[:limit].to_s.match(/^\d+$/) raise ArgumentError.new("Invalid value for limit parameter") end - @limit = params[:limit].to_i + @limit = [params[:limit].to_i, + Rails.configuration.max_items_per_response].min else @limit = DEFAULT_LIMIT end @@ -75,7 +72,7 @@ module LoadParam (case params[:order] when String if params[:order].starts_with? '[' - od = Oj.load(params[:order]) + od = SafeJSON.load(params[:order]) raise unless od.is_a? Array od else @@ -95,11 +92,11 @@ module LoadParam # has used set_table_name to use an alternate table name from the Rails standard. # I could not find a perfect way to handle this well, but ActiveRecord::Base.send(:descendants) # would be a place to start if this ever becomes necessary. - if attr.match /^[a-z][_a-z0-9]+$/ and + if attr.match(/^[a-z][_a-z0-9]+$/) and model_class.columns.collect(&:name).index(attr) and ['asc','desc'].index direction.downcase @orders << "#{table_name}.#{attr} #{direction.downcase}" - elsif attr.match /^([a-z][_a-z0-9]+)\.([a-z][_a-z0-9]+)$/ and + elsif attr.match(/^([a-z][_a-z0-9]+)\.([a-z][_a-z0-9]+)$/) and ['asc','desc'].index(direction.downcase) and ActiveRecord::Base.connection.tables.include?($1) and $1.classify.constantize.columns.collect(&:name).index($2) @@ -110,8 +107,34 @@ module LoadParam end end - if @orders.empty? - @orders = default_orders + # If the client-specified orders don't amount to a full ordering + # (e.g., [] or ['owner_uuid desc']), fall back on the default + # orders to ensure repeating the same request (possibly with + # different limit/offset) will return records in the same order. + # + # Clean up the resulting list of orders such that no column + # uselessly appears twice (Postgres might not optimize this out + # for us) and no columns uselessly appear after a unique column + # (Postgres does not optimize this out for us; as of 9.2, "order + # by id, modified_at desc, uuid" is slow but "order by id" is + # fast). + orders_given_and_default = @orders + model_class.default_orders + order_cols_used = {} + @orders = [] + orders_given_and_default.each do |order| + otablecol = order.split(' ')[0] + + next if order_cols_used[otablecol] + order_cols_used[otablecol] = true + + @orders << order + + otable, ocol = otablecol.split('.') + if otable == table_name and model_class.unique_columns.include?(ocol) + # we already have a full ordering; subsequent entries would be + # superfluous + break + end end case params[:select] @@ -119,7 +142,7 @@ module LoadParam @select = params[:select] when String begin - @select = Oj.load params[:select] + @select = SafeJSON.load(params[:select]) raise unless @select.is_a? Array or @select.nil? rescue raise ArgumentError.new("Could not parse \"select\" param as an array") @@ -130,8 +153,9 @@ module LoadParam # Any ordering columns must be selected when doing select, # otherwise it is an SQL error, so filter out invaliding orderings. @orders.select! { |o| + col, dir = o.split # match select column against order array entry - @select.select { |s| /^#{table_name}.#{s}( (asc|desc))?$/.match o }.any? + @select.select { |s| col == "#{table_name}.#{s}" }.any? } end