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