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