services/api/app/controllers/arvados/v1/jobs_controller.rb

   1 class Arvados::V1::JobsController < ApplicationController
   2   accept_attribute_as_json :script_parameters, Hash
   3   accept_attribute_as_json :runtime_constraints, Hash
   4   accept_attribute_as_json :tasks_summary, Hash
   5   skip_before_filter :find_object_by_uuid, :only => :queue
   6   skip_before_filter :render_404_if_no_object, :only => :queue
   7
   8   def create
   9     [:repository, :script, :script_version, :script_parameters].each do |r|
  10       if !resource_attrs[r]
  11         return send_error("#{r} attribute must be specified",
  12                           status: :unprocessable_entity)
  13       end
  14     end
  15
  16     # We used to ask for the minimum_, exclude_, and no_reuse params
  17     # in the job resource. Now we advertise them as flags that alter
  18     # the behavior of the create action.
  19     [:minimum_script_version, :exclude_script_versions].each do |attr|
  20       if resource_attrs.has_key? attr
  21         params[attr] = resource_attrs.delete attr
  22       end
  23     end
  24     if resource_attrs.has_key? :no_reuse
  25       params[:find_or_create] = !resource_attrs.delete(:no_reuse)
  26     end
  27
  28     if params[:find_or_create]
  29       load_filters_param
  30       if @filters.empty?  # Translate older creation parameters into filters.
  31         @filters = [:repository, :script].map do |attrsym|
  32           [attrsym.to_s, "=", resource_attrs[attrsym]]
  33         end
  34         @filters.append(["script_version", "in",
  35                          Commit.find_commit_range(current_user,
  36                                                   resource_attrs[:repository],
  37                                                   params[:minimum_script_version],
  38                                                   resource_attrs[:script_version],
  39                                                   params[:exclude_script_versions])])
  40         if image_search = resource_attrs[:runtime_constraints].andand["docker_image"]
  41           image_tag = resource_attrs[:runtime_constraints]["docker_image_tag"]
  42           image_locator = Collection.
  43             uuids_for_docker_image(image_search, image_tag, @read_users).first
  44           return super if image_locator.nil?  # We won't find anything to reuse.
  45           @filters.append(["docker_image_locator", "=", image_locator])
  46         else
  47           @filters.append(["docker_image_locator", "=", nil])
  48         end
  49       else  # Check specified filters for some reasonableness.
  50         filter_names = @filters.map { |f| f.first }.uniq
  51         ["repository", "script"].each do |req_filter|
  52           if not filter_names.include?(req_filter)
  53             raise ArgumentError.new("#{req_filter} filter required")
  54           end
  55         end
  56       end
  57
  58       # Search for a reusable Job, and return it if found.
  59       @objects = Job.readable_by(current_user)
  60       apply_filters
  61       @object = nil
  62       incomplete_job = nil
  63       @objects.each do |j|
  64         if j.nondeterministic != true and
  65             ((j.success == true and j.output != nil) or j.running == true) and
  66             j.script_parameters == resource_attrs[:script_parameters]
  67           if j.running
  68             # We'll use this if we don't find a job that has completed
  69             incomplete_job ||= j
  70           else
  71             # Record the first job in the list
  72             if !@object
  73               @object = j
  74             end
  75             # Ensure that all candidate jobs actually did produce the same output
  76             if @object.output != j.output
  77               @object = nil
  78               break
  79             end
  80           end
  81         end
  82         @object ||= incomplete_job
  83         if @object
  84           return show
  85         end
  86       end
  87     end
  88
  89     super
  90   end
  91
  92   def cancel
  93     reload_object_before_update
  94     @object.update_attributes! cancelled_at: Time.now
  95     show
  96   end
  97
  98   class LogStreamer
  99     Q_UPDATE_INTERVAL = 12
 100     def initialize(job, opts={})
 101       @job = job
 102       @opts = opts
 103     end
 104     def each
 105       if @job.finished_at
 106         yield "#{@job.uuid} finished at #{@job.finished_at}\n"
 107         return
 108       end
 109       while not @job.started_at
 110         # send a summary (job queue + available nodes) to the client
 111         # every few seconds while waiting for the job to start
 112         last_ack_at ||= Time.now - Q_UPDATE_INTERVAL - 1
 113         if Time.now - last_ack_at >= Q_UPDATE_INTERVAL
 114           nodes_in_state = {idle: 0, alloc: 0}
 115           ActiveRecord::Base.uncached do
 116             Node.where('hostname is not ?', nil).collect do |n|
 117               if n.info[:slurm_state]
 118                 nodes_in_state[n.info[:slurm_state]] ||= 0
 119                 nodes_in_state[n.info[:slurm_state]] += 1
 120               end
 121             end
 122           end
 123           job_queue = Job.queue
 124           n_queued_before_me = 0
 125           job_queue.each do |j|
 126             break if j.uuid == @job.uuid
 127             n_queued_before_me += 1
 128           end
 129           yield "#{Time.now}" \
 130             " job #{@job.uuid}" \
 131             " queue_position #{n_queued_before_me}" \
 132             " queue_size #{job_queue.size}" \
 133             " nodes_idle #{nodes_in_state[:idle]}" \
 134             " nodes_alloc #{nodes_in_state[:alloc]}\n"
 135           last_ack_at = Time.now
 136         end
 137         sleep 3
 138         ActiveRecord::Base.uncached do
 139           @job.reload
 140         end
 141       end
 142     end
 143   end
 144
 145   def queue
 146     params[:order] ||= ['priority desc', 'created_at']
 147     load_limit_offset_order_params
 148     load_where_param
 149     @where.merge!({
 150                     started_at: nil,
 151                     is_locked_by_uuid: nil,
 152                     cancelled_at: nil,
 153                     success: nil
 154                   })
 155     load_filters_param
 156     find_objects_for_index
 157     index
 158   end
 159
 160   def self._queue_requires_parameters
 161     self._index_requires_parameters
 162   end
 163
 164   protected
 165
 166   def load_filters_param
 167     # Convert Job-specific git and Docker filters into normal SQL filters.
 168     super
 169     script_info = {"repository" => nil, "script" => nil}
 170     script_range = {"exclude_versions" => []}
 171     @filters.select! do |filter|
 172       if (script_info.has_key? filter[0]) and (filter[1] == "=")
 173         if script_info[filter[0]].nil?
 174           script_info[filter[0]] = filter[2]
 175         elsif script_info[filter[0]] != filter[2]
 176           raise ArgumentError.new("incompatible #{filter[0]} filters")
 177         end
 178       end
 179       case filter[0..1]
 180       when ["script_version", "in git"]
 181         script_range["min_version"] = filter.last
 182         false
 183       when ["script_version", "not in git"]
 184         begin
 185           script_range["exclude_versions"] += filter.last
 186         rescue TypeError
 187           script_range["exclude_versions"] << filter.last
 188         end
 189         false
 190       when ["docker_image_locator", "in docker"], ["docker_image_locator", "not in docker"]
 191         filter[1].sub!(/ docker$/, '')
 192         search_list = filter[2].is_a?(Enumerable) ? filter[2] : [filter[2]]
 193         filter[2] = search_list.flat_map do |search_term|
 194           image_search, image_tag = search_term.split(':', 2)
 195           Collection.uuids_for_docker_image(image_search, image_tag, @read_users)
 196         end
 197         true
 198       else
 199         true
 200       end
 201     end
 202
 203     # Build a real script_version filter from any "not? in git" filters.
 204     if (script_range.size > 1) or script_range["exclude_versions"].any?
 205       script_info.each_pair do |key, value|
 206         if value.nil?
 207           raise ArgumentError.new("script_version filter needs #{key} filter")
 208         end
 209       end
 210       last_version = begin resource_attrs[:script_version] rescue "HEAD" end
 211       @filters.append(["script_version", "in",
 212                        Commit.find_commit_range(current_user,
 213                                                 script_info["repository"],
 214                                                 script_range["min_version"],
 215                                                 last_version,
 216                                                 script_range["exclude_versions"])])
 217     end
 218   end
 219 end