Merge branch 'master' into 2051-nondeterministic-jobs
[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(:repository)
53     resource_attrs.delete(:minimum_script_version)
54     resource_attrs.delete(:exclude_script_versions)
55     resource_attrs.delete(:no_reuse)
56     super
57   end
58
59   def cancel
60     reload_object_before_update
61     @object.update_attributes cancelled_at: Time.now
62     show
63   end
64
65   class LogStreamer
66     Q_UPDATE_INTERVAL = 12
67     def initialize(job, opts={})
68       @job = job
69       @opts = opts
70     end
71     def each
72       if @job.finished_at
73         yield "#{@job.uuid} finished at #{@job.finished_at}\n"
74         return
75       end
76       while not @job.started_at
77         # send a summary (job queue + available nodes) to the client
78         # every few seconds while waiting for the job to start
79         last_ack_at ||= Time.now - Q_UPDATE_INTERVAL - 1
80         if Time.now - last_ack_at >= Q_UPDATE_INTERVAL
81           nodes_in_state = {idle: 0, alloc: 0}
82           ActiveRecord::Base.uncached do
83             Node.where('hostname is not ?', nil).collect do |n|
84               if n.info[:slurm_state]
85                 nodes_in_state[n.info[:slurm_state]] ||= 0
86                 nodes_in_state[n.info[:slurm_state]] += 1
87               end
88             end
89           end
90           job_queue = Job.queue
91           n_queued_before_me = 0
92           job_queue.each do |j|
93             break if j.uuid == @job.uuid
94             n_queued_before_me += 1
95           end
96           yield "#{Time.now}" \
97             " job #{@job.uuid}" \
98             " queue_position #{n_queued_before_me}" \
99             " queue_size #{job_queue.size}" \
100             " nodes_idle #{nodes_in_state[:idle]}" \
101             " nodes_alloc #{nodes_in_state[:alloc]}\n"
102           last_ack_at = Time.now
103         end
104         sleep 3
105         ActiveRecord::Base.uncached do
106           @job.reload
107         end
108       end
109       @redis = Redis.new(:timeout => 0)
110       if @redis.exists @job.uuid
111         # A log buffer exists. Start by showing the last few KB.
112         @redis.
113           getrange(@job.uuid, 0 - [@opts[:buffer_size], 1].max, -1).
114           sub(/^[^\n]*\n?/, '').
115           split("\n").
116           each do |line|
117           yield "#{line}\n"
118         end
119       end
120       # TODO: avoid missing log entries between getrange() above and
121       # subscribe() below.
122       @redis.subscribe(@job.uuid) do |event|
123         event.message do |channel, msg|
124           if msg == "end"
125             @redis.unsubscribe @job.uuid
126           else
127             yield "#{msg}\n"
128           end
129         end
130       end
131     end
132   end
133
134   def self._log_tail_follow_requires_parameters
135     {
136       buffer_size: {type: 'integer', required: false, default: 2**13}
137     }
138   end
139   def log_tail_follow
140     if !@object.andand.uuid
141       return render_not_found
142     end
143     if client_accepts_plain_text_stream
144       self.response.headers['Last-Modified'] = Time.now.ctime.to_s
145       self.response_body = LogStreamer.new @object, {
146         buffer_size: (params[:buffer_size].to_i rescue 2**13)
147       }
148     else
149       render json: {
150         href: url_for(uuid: @object.uuid),
151         comment: ('To retrieve the log stream as plain text, ' +
152                   'use a request header like "Accept: text/plain"')
153       }
154     end
155   end
156
157   def queue
158     load_where_param
159     @where.merge!({
160                     started_at: nil,
161                     is_locked_by_uuid: nil,
162                     cancelled_at: nil,
163                     success: nil
164                   })
165     params[:order] ||= 'priority desc, created_at'
166     find_objects_for_index
167     index
168   end
169
170   def self._queue_requires_parameters
171     self._index_requires_parameters
172   end
173 end