services/api/app/models/job.rb

   1 class Job < ArvadosModel
   2   include AssignUuid
   3   include KindAndEtag
   4   include CommonApiTemplate
   5   serialize :script_parameters, Hash
   6   serialize :runtime_constraints, Hash
   7   serialize :tasks_summary, Hash
   8   before_create :ensure_unique_submit_id
   9   before_create :ensure_script_version_is_commit
  10   before_update :ensure_script_version_is_commit
  11   after_commit :trigger_crunch_dispatch_if_cancelled, :on => :update
  12
  13   has_many :commit_ancestors, :foreign_key => :descendant, :primary_key => :script_version
  14
  15   class SubmitIdReused < StandardError
  16   end
  17
  18   api_accessible :user, extend: :common do |t|
  19     t.add :submit_id
  20     t.add :priority
  21     t.add :script
  22     t.add :script_parameters
  23     t.add :script_version
  24     t.add :cancelled_at
  25     t.add :cancelled_by_client_uuid
  26     t.add :cancelled_by_user_uuid
  27     t.add :started_at
  28     t.add :finished_at
  29     t.add :output
  30     t.add :output_is_persistent
  31     t.add :success
  32     t.add :running
  33     t.add :is_locked_by_uuid
  34     t.add :log
  35     t.add :runtime_constraints
  36     t.add :tasks_summary
  37     t.add :dependencies
  38     t.add :log_stream_href
  39     t.add :log_buffer
  40     t.add :nondeterministic
  41     t.add :repository
  42   end
  43
  44   def assert_finished
  45     update_attributes(finished_at: finished_at || Time.now,
  46                       success: success.nil? ? false : success,
  47                       running: false)
  48   end
  49
  50   def log_stream_href
  51     unless self.finished_at
  52       "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}/log_tail_follow"
  53     end
  54   end
  55
  56   def self.queue
  57     self.where('started_at is ? and is_locked_by_uuid is ? and cancelled_at is ? and success is ?',
  58                nil, nil, nil, nil).
  59       order('priority desc, created_at')
  60   end
  61
  62   def self.running
  63     self.where('running = ?', true).
  64       order('priority desc, created_at')
  65   end
  66
  67   protected
  68
  69   def foreign_key_attributes
  70     super + %w(output log)
  71   end
  72
  73   def ensure_script_version_is_commit
  74     if self.is_locked_by_uuid and self.started_at
  75       # Apparently client has already decided to go for it. This is
  76       # needed to run a local job using a local working directory
  77       # instead of a commit-ish.
  78       return true
  79     end
  80     if new_record? or script_version_changed?
  81       sha1 = Commit.find_commit_range(current_user, nil, nil, self.script_version, nil)[0] rescue nil
  82       if sha1
  83         self.script_version = sha1
  84       else
  85         raise ArgumentError.new("Specified script_version does not resolve to a commit")
  86       end
  87     end
  88   end
  89
  90   def ensure_unique_submit_id
  91     if !submit_id.nil?
  92       if Job.where('submit_id=?',self.submit_id).first
  93         raise SubmitIdReused.new
  94       end
  95     end
  96     true
  97   end
  98
  99   def dependencies
 100     deps = {}
 101     queue = self.script_parameters.values
 102     while not queue.empty?
 103       queue = queue.flatten.compact.collect do |v|
 104         if v.is_a? Hash
 105           v.values
 106         elsif v.is_a? String
 107           v.match(/^(([0-9a-f]{32})\b(\+[^,]+)?,?)*$/) do |locator|
 108             deps[locator.to_s] = true
 109           end
 110           nil
 111         end
 112       end
 113     end
 114     deps.keys
 115   end
 116
 117   def permission_to_update
 118     if is_locked_by_uuid_was and !(current_user and
 119                                    (current_user.uuid == is_locked_by_uuid_was or
 120                                     current_user.uuid == system_user.uuid))
 121       if script_changed? or
 122           script_parameters_changed? or
 123           script_version_changed? or
 124           (!cancelled_at_was.nil? and
 125            (cancelled_by_client_uuid_changed? or
 126             cancelled_by_user_uuid_changed? or
 127             cancelled_at_changed?)) or
 128           started_at_changed? or
 129           finished_at_changed? or
 130           running_changed? or
 131           success_changed? or
 132           output_changed? or
 133           log_changed? or
 134           tasks_summary_changed?
 135         logger.warn "User #{current_user.uuid if current_user} tried to change protected job attributes on locked #{self.class.to_s} #{uuid_was}"
 136         return false
 137       end
 138     end
 139     if !is_locked_by_uuid_changed?
 140       super
 141     else
 142       if !current_user
 143         logger.warn "Anonymous user tried to change lock on #{self.class.to_s} #{uuid_was}"
 144         false
 145       elsif is_locked_by_uuid_was and is_locked_by_uuid_was != current_user.uuid
 146         logger.warn "User #{current_user.uuid} tried to steal lock on #{self.class.to_s} #{uuid_was} from #{is_locked_by_uuid_was}"
 147         false
 148       elsif !is_locked_by_uuid.nil? and is_locked_by_uuid != current_user.uuid
 149         logger.warn "User #{current_user.uuid} tried to lock #{self.class.to_s} #{uuid_was} with uuid #{is_locked_by_uuid}"
 150         false
 151       else
 152         super
 153       end
 154     end
 155   end
 156
 157   def update_modified_by_fields
 158     if self.cancelled_at_changed?
 159       # Ensure cancelled_at cannot be set to arbitrary non-now times,
 160       # or changed once it is set.
 161       if self.cancelled_at and not self.cancelled_at_was
 162         self.cancelled_at = Time.now
 163         self.cancelled_by_user_uuid = current_user.uuid
 164         self.cancelled_by_client_uuid = current_api_client.uuid
 165         @need_crunch_dispatch_trigger = true
 166       else
 167         self.cancelled_at = self.cancelled_at_was
 168         self.cancelled_by_user_uuid = self.cancelled_by_user_uuid_was
 169         self.cancelled_by_client_uuid = self.cancelled_by_client_uuid_was
 170       end
 171     end
 172     super
 173   end
 174
 175   def trigger_crunch_dispatch_if_cancelled
 176     if @need_crunch_dispatch_trigger
 177       File.open(Rails.configuration.crunch_refresh_trigger, 'wb') do
 178         # That's all, just create/touch a file for crunch-job to see.
 179       end
 180     end
 181   end
 182
 183   def log_buffer
 184     begin
 185       @@redis ||= Redis.new(:timeout => 0)
 186       if @@redis.exists uuid
 187         @@redis.getrange(uuid, 0 - 2**10, -1)
 188       end
 189     rescue Redis::CannotConnectError
 190       return '(not available)'
 191     end
 192   end
 193 end