Merged master
[arvados.git] / 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 render json: {
12           :error => "#{r} attribute must be specified"
13         }, status: :unprocessable_entity
14       end
15     end
16
17     r = Commit.find_commit_range(current_user,
18                                  resource_attrs[:repository],
19                                  resource_attrs[:minimum_script_version],
20                                  resource_attrs[:script_version],
21                                  resource_attrs[:exclude_script_versions])
22     if !resource_attrs[:nondeterministic] and !resource_attrs[:no_reuse]
23       # Search for jobs where the script_version is in the list of commits
24       # returned by find_commit_range
25       @object = nil
26       Job.readable_by(current_user).where(script: resource_attrs[:script],
27                                           script_version: r).
28         each do |j|
29         if j.nondeterministic != true and
30             j.success != false and
31             j.script_parameters == resource_attrs[:script_parameters]
32           # Record the first job in the list
33           if !@object
34             @object = j
35           end
36           # Ensure that all candidate jobs actually did produce the same output
37           if @object.output != j.output
38             @object = nil
39             break
40           end
41         end
42         if @object
43           return show
44         end
45       end
46     end
47     if r
48       resource_attrs[:script_version] = r[0]
49     end
50
51     # Don't pass these on to activerecord
52     resource_attrs.delete(:minimum_script_version)
53     resource_attrs.delete(:exclude_script_versions)
54     resource_attrs.delete(:no_reuse)
55     super
56   end
57
58   def cancel
59     reload_object_before_update
60     @object.update_attributes! cancelled_at: Time.now
61     show
62   end
63
64   class LogStreamer
65     Q_UPDATE_INTERVAL = 12
66     def initialize(job, opts={})
67       @job = job
68       @opts = opts
69     end
70     def each
71       if @job.finished_at
72         yield "#{@job.uuid} finished at #{@job.finished_at}\n"
73         return
74       end
75       while not @job.started_at
76         # send a summary (job queue + available nodes) to the client
77         # every few seconds while waiting for the job to start
78         last_ack_at ||= Time.now - Q_UPDATE_INTERVAL - 1
79         if Time.now - last_ack_at >= Q_UPDATE_INTERVAL
80           nodes_in_state = {idle: 0, alloc: 0}
81           ActiveRecord::Base.uncached do
82             Node.where('hostname is not ?', nil).collect do |n|
83               if n.info[:slurm_state]
84                 nodes_in_state[n.info[:slurm_state]] ||= 0
85                 nodes_in_state[n.info[:slurm_state]] += 1
86               end
87             end
88           end
89           job_queue = Job.queue
90           n_queued_before_me = 0
91           job_queue.each do |j|
92             break if j.uuid == @job.uuid
93             n_queued_before_me += 1
94           end
95           yield "#{Time.now}" \
96             " job #{@job.uuid}" \
97             " queue_position #{n_queued_before_me}" \
98             " queue_size #{job_queue.size}" \
99             " nodes_idle #{nodes_in_state[:idle]}" \
100             " nodes_alloc #{nodes_in_state[:alloc]}\n"
101           last_ack_at = Time.now
102         end
103         sleep 3
104         ActiveRecord::Base.uncached do
105           @job.reload
106         end
107       end
108       @redis = Redis.new(:timeout => 0)
109       if @redis.exists @job.uuid
110         # A log buffer exists. Start by showing the last few KB.
111         @redis.
112           getrange(@job.uuid, 0 - [@opts[:buffer_size], 1].max, -1).
113           sub(/^[^\n]*\n?/, '').
114           split("\n").
115           each do |line|
116           yield "#{line}\n"
117         end
118       end
119       # TODO: avoid missing log entries between getrange() above and
120       # subscribe() below.
121       @redis.subscribe(@job.uuid) do |event|
122         event.message do |channel, msg|
123           if msg == "end"
124             @redis.unsubscribe @job.uuid
125           else
126             yield "#{msg}\n"
127           end
128         end
129       end
130     end
131   end
132
133   def self._log_tail_follow_requires_parameters
134     {
135       buffer_size: {type: 'integer', required: false, default: 2**13}
136     }
137   end
138   def log_tail_follow
139     if !@object.andand.uuid
140       return render_not_found
141     end
142     if client_accepts_plain_text_stream
143       self.response.headers['Last-Modified'] = Time.now.ctime.to_s
144       self.response_body = LogStreamer.new @object, {
145         buffer_size: (params[:buffer_size].to_i rescue 2**13)
146       }
147     else
148       render json: {
149         href: url_for(uuid: @object.uuid),
150         comment: ('To retrieve the log stream as plain text, ' +
151                   'use a request header like "Accept: text/plain"')
152       }
153     end
154   end
155
156   def queue
157     load_where_param
158     @where.merge!({
159                     started_at: nil,
160                     is_locked_by_uuid: nil,
161                     cancelled_at: nil,
162                     success: nil
163                   })
164     params[:order] ||= 'priority desc, created_at'
165     find_objects_for_index
166     index
167   end
168
169   def self._queue_requires_parameters
170     self._index_requires_parameters
171   end
172 end