Project

General

Profile

Actions
Copy link

Idea #8647

closed

[Workbench] "Work unit" user interface

Added by Tom Clegg about 8 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
-
Category:
Workbench
Target version:
-
Start date:
03/07/2016
Due date:
Story points:
-

Description

A work unit is a "view model". It corresponds to an Arvados object like a Job or a Pipeline Instance. Its purpose is to provide the information needed by views. As much as possible, we want our views to not know/care exactly which type of object the work unit represents.

For example, a dashboard view might show a heterogeneous list of pipeline instances, jobs, and (crunch2) containers. The view code is simple: it says "show progress bar at X%", it doesn't say "if showing a pipeline then add all components' progress and divide by # components". The latter is the kind of code that belongs in the work unit.

class Job
  def work_unit label
    JobWorkUnit.new(self, label)
  end
end

class WorkUnit
  # This is just an abstract class that documents the WorkUnit interface; a
  # class can implement the interface without being a subclass of WorkUnit.
  def label
    # returns the label that was assigned when creating the work unit
  end
  def uuid
    # returns the arvados UUID of the underlying object
  end
  def components
    # returns an array of component (child) work units
  end
end

class ProxyWorkUnit < WorkUnit
  def initialize proxied, label
    self.label = label
    self.proxied = proxied
  end
  def label
    self.label
  end
  def uuid
    self.proxied.uuid
  end
end

class JobWorkUnit < ProxyWorkUnit
  def components
    n = -1
    self.proxied.job_tasks.map do |t|
      n++
      t.work_unit("task #{n}")
    end
  end
end

Related issues

Related to Arvados - Idea #8651: [Workbench] Add "work unit" Ruby interface definitionClosed03/07/2016Actions
Actions
Copy link

Also available in: Atom PDF