apps/workbench/app/helpers/provenance_helper.rb

   1 module ProvenanceHelper
   2
   3   class GenerateGraph
   4     def initialize(pdata, opts)
   5       @pdata = pdata
   6       @opts = opts
   7       @visited = {}
   8       @jobs = {}
   9       @node_extra = {}
  10     end
  11
  12     def self.collection_uuid(uuid)
  13       m = CollectionsHelper.match(uuid)
  14       if m
  15         if m[2]
  16           return m[1]+m[2]
  17         else
  18           return m[1]
  19         end
  20       else
  21         nil
  22       end
  23     end
  24
  25     def url_for u
  26       p = { :host => @opts[:request].host,
  27         :port => @opts[:request].port,
  28         :protocol => @opts[:request].protocol }
  29       p.merge! u
  30       Rails.application.routes.url_helpers.url_for (p)
  31     end
  32
  33     def determine_fillcolor(n)
  34       fillcolor = %w(aaaaaa aaffaa aaaaff aaaaaa ffaaaa)[n || 0] || 'aaaaaa'
  35       "style=filled,fillcolor=\"##{fillcolor}\""
  36     end
  37
  38     def describe_node(uuid)
  39       uuid = uuid.to_sym
  40       bgcolor = determine_fillcolor @opts[:pips].andand[uuid]
  41
  42       rsc = ArvadosBase::resource_class_for_uuid uuid.to_s
  43       if rsc
  44         href = url_for ({:controller => rsc.to_s.tableize,
  45                           :action => :show,
  46                           :id => uuid.to_s })
  47
  48         #"\"#{uuid}\" [label=\"#{rsc}\\n#{uuid}\",href=\"#{href}\"];\n"
  49         if rsc == Collection
  50           if Collection.is_empty_blob_locator? uuid.to_s
  51             # special case
  52             return "\"#{uuid}\" [label=\"(empty collection)\"];\n"
  53           end
  54           if @pdata[uuid]
  55             if @pdata[uuid][:name]
  56               return "\"#{uuid}\" [label=\"#{@pdata[uuid][:name]}\",href=\"#{href}\",shape=oval,#{bgcolor}];\n"
  57             else
  58               files = nil
  59               if @pdata[uuid].respond_to? :files
  60                 files = @pdata[uuid].files
  61               elsif @pdata[uuid][:files]
  62                 files = @pdata[uuid][:files]
  63               end
  64
  65               if files
  66                 i = 0
  67                 label = ""
  68                 while i < 3 and i < files.length
  69                   label += "\\n" unless label == ""
  70                   label += files[i][1]
  71                   i += 1
  72                 end
  73                 if i < files.length
  74                   label += "\\n&vellip;"
  75                 end
  76                 extra_s = @node_extra[uuid].andand.map { |k,v|
  77                   "#{k}=\"#{v}\""
  78                 }.andand.join ","
  79                 return "\"#{uuid}\" [label=\"#{label}\",href=\"#{href}\",shape=oval,#{bgcolor},#{extra_s}];\n"
  80               end
  81             end
  82           end
  83         end
  84         return "\"#{uuid}\" [label=\"#{rsc}\",href=\"#{href}\",#{bgcolor}];\n"
  85       end
  86       "\"#{uuid}\" [#{bgcolor}];\n"
  87     end
  88
  89     def job_uuid(job)
  90       if @opts[:combine_jobs] == :script_only
  91         uuid = "#{job[:script]}"
  92       elsif @opts[:combine_jobs] == :script_and_version
  93         uuid = "#{job[:script]}_#{job[:script_version]}"
  94       else
  95         uuid = "#{job[:uuid]}"
  96       end
  97
  98       @jobs[uuid] = [] unless @jobs[uuid]
  99       @jobs[uuid] << job unless @jobs[uuid].include? job
 100
 101       uuid
 102     end
 103
 104     def edge(tail, head, extra)
 105       if @opts[:direction] == :bottom_up
 106         gr = "\"#{tail}\" -> \"#{head}\""
 107       else
 108         gr = "\"#{head}\" -> \"#{tail}\""
 109       end
 110       if extra.length > 0
 111         gr += " ["
 112         extra.each do |k, v|
 113           gr += "#{k}=\"#{v}\","
 114         end
 115         gr += "]"
 116       end
 117       gr += ";\n"
 118       gr
 119     end
 120
 121     def script_param_edges(job, prefix, sp)
 122       gr = ""
 123       case sp
 124       when Hash
 125         sp.each do |k, v|
 126           if prefix.size > 0
 127             k = prefix + "::" + k.to_s
 128           end
 129           gr += script_param_edges(job, k.to_s, v)
 130         end
 131       when Array
 132         i = 0
 133         node = ""
 134         sp.each do |v|
 135           if GenerateGraph::collection_uuid(v)
 136             gr += script_param_edges(job, "#{prefix}[#{i}]", v)
 137           elsif @opts[:all_script_parameters]
 138             node += "', '" unless node == ""
 139             node = "['" if node == ""
 140             node += "#{v}"
 141           end
 142           i += 1
 143         end
 144         unless node == ""
 145           node += "']"
 146           gr += "\"#{node}\" [label=\"#{node}\"];\n"
 147           gr += edge(job_uuid(job), node, {:label => prefix})
 148         end
 149       when String
 150         return '' if sp.empty?
 151         m = GenerateGraph::collection_uuid(sp)
 152         if m and (@pdata[m.intern] or (not @opts[:pdata_only]))
 153           gr += edge(job_uuid(job), m, {:label => prefix})
 154           gr += generate_provenance_edges(m)
 155         elsif @opts[:all_script_parameters]
 156           gr += "\"#{sp}\" [label=\"#{sp}\"];\n"
 157           gr += edge(job_uuid(job), sp, {:label => prefix})
 158         end
 159       end
 160       gr
 161     end
 162
 163     def generate_provenance_edges(uuid)
 164       gr = ""
 165       m = GenerateGraph::collection_uuid(uuid)
 166       uuid = m if m
 167
 168       uuid = uuid.intern if uuid
 169
 170       if (not uuid) or uuid.empty? or @visited[uuid]
 171         return ""
 172       end
 173
 174       if not @pdata[uuid] then
 175         return describe_node(uuid)
 176       else
 177         @visited[uuid] = true
 178       end
 179
 180       if m
 181         # uuid is a collection
 182         if not Collection.is_empty_blob_locator? uuid.to_s
 183           @pdata.each do |k, job|
 184             if job[:output] == uuid.to_s
 185               extra = { label: 'output' }
 186               if job[:output_is_persistent]
 187                 extra[:label] += ' (persistent)'
 188                 @node_extra[uuid] ||= {}
 189                 @node_extra[uuid][:penwidth] = 4
 190               end
 191               gr += edge(uuid, job_uuid(job), extra)
 192               gr += generate_provenance_edges(job[:uuid])
 193             end
 194             if job[:log] == uuid.to_s
 195               gr += edge(uuid, job_uuid(job), {:label => "log"})
 196               gr += generate_provenance_edges(job[:uuid])
 197             end
 198           end
 199         end
 200         gr += describe_node(uuid)
 201       else
 202         # uuid is something else
 203         rsc = ArvadosBase::resource_class_for_uuid uuid.to_s
 204
 205         if rsc == Job
 206           job = @pdata[uuid]
 207           if job
 208             gr += script_param_edges(job, "", job[:script_parameters])
 209
 210             if @opts[:script_version_nodes]
 211               gr += describe_node(job[:script_version])
 212               gr += edge(job_uuid(job), job[:script_version], {:label => "script_version"})
 213             end
 214           end
 215         elsif rsc == Link
 216           # do nothing
 217         else
 218           gr += describe_node(uuid)
 219         end
 220       end
 221
 222       @pdata.each do |k, link|
 223         if link[:head_uuid] == uuid.to_s and link[:link_class] == "provenance"
 224           href = url_for ({:controller => Link.to_s.tableize,
 225                             :action => :show,
 226                             :id => link[:uuid] })
 227
 228           gr += describe_node(link[:tail_uuid])
 229           gr += edge(link[:head_uuid], link[:tail_uuid], {:label => link[:name], :href => href})
 230           gr += generate_provenance_edges(link[:tail_uuid])
 231         end
 232       end
 233
 234       gr
 235     end
 236
 237     def describe_jobs
 238       gr = ""
 239       @jobs.each do |k, v|
 240         href = url_for ({:controller => Job.to_s.tableize,
 241                           :action => :index })
 242
 243         gr += "\"#{k}\" [href=\"#{href}?"
 244
 245         n = 0
 246         v.each do |u|
 247           gr += "uuid%5b%5d=#{u[:uuid]}&"
 248           n |= @opts[:pips][u[:uuid].intern] if @opts[:pips] and @opts[:pips][u[:uuid].intern]
 249         end
 250
 251         gr += "\",label=\""
 252
 253         if @opts[:combine_jobs] == :script_only
 254           gr += "#{v[0][:script]}"
 255         elsif @opts[:combine_jobs] == :script_and_version
 256           gr += "#{v[0][:script]}" # Just show the name but the nodes will be distinct
 257         else
 258           gr += "#{v[0][:script]}\\n#{v[0][:finished_at]}"
 259         end
 260         gr += "\",#{determine_fillcolor n}];\n"
 261       end
 262       gr
 263     end
 264
 265   end
 266
 267   def self.create_provenance_graph(pdata, svgId, opts={})
 268     if pdata.is_a? Array or pdata.is_a? ArvadosResourceList
 269       p2 = {}
 270       pdata.each do |k|
 271         p2[k[:uuid].intern] = k if k[:uuid]
 272       end
 273       pdata = p2
 274     end
 275
 276     unless pdata.is_a? Hash
 277       raise "create_provenance_graph accepts Array or Hash for pdata only, pdata is #{pdata.class}"
 278     end
 279
 280     gr = """strict digraph {
 281 node [fontsize=10,shape=box];
 282 edge [fontsize=10];
 283 """
 284
 285     if opts[:direction] == :bottom_up
 286       gr += "edge [dir=back];"
 287     end
 288
 289     g = GenerateGraph.new(pdata, opts)
 290
 291     pdata.each do |k, v|
 292       gr += g.generate_provenance_edges(k)
 293     end
 294
 295     gr += g.describe_jobs
 296
 297     gr += "}"
 298     svg = ""
 299
 300     require 'open3'
 301
 302     Open3.popen2("dot", "-Tsvg") do |stdin, stdout, wait_thr|
 303       stdin.print(gr)
 304       stdin.close
 305       svg = stdout.read()
 306       wait_thr.value
 307       stdout.close()
 308     end
 309
 310     svg = svg.sub(/<\?xml.*?\?>/m, "")
 311     svg = svg.sub(/<!DOCTYPE.*?>/m, "")
 312     svg = svg.sub(/<svg /, "<svg id=\"#{svgId}\" ")
 313   end
 314
 315   def self.find_collections(sp)
 316     c = []
 317     case sp
 318     when Hash
 319       sp.each do |k, v|
 320         c.concat(find_collections(v))
 321       end
 322     when Array
 323       sp.each do |v|
 324         c.concat(find_collections(v))
 325       end
 326     when String
 327       if !sp.empty?
 328         m = GenerateGraph::collection_uuid(sp)
 329         if m
 330           c << m
 331         end
 332       end
 333     end
 334     c
 335   end
 336 end