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       Keep::Locator.parse(uuid).andand.strip_hints.andand.to_s
  14     end
  15
  16     def url_for u
  17       p = { :host => @opts[:request].host,
  18         :port => @opts[:request].port,
  19         :protocol => @opts[:request].protocol }
  20       p.merge! u
  21       Rails.application.routes.url_helpers.url_for (p)
  22     end
  23
  24     def determine_fillcolor(n)
  25       fillcolor = %w(666666 669966 666699 666666 996666)[n || 0] || '666666'
  26       "style=\"filled\",color=\"#ffffff\",fillcolor=\"##{fillcolor}\",fontcolor=\"#ffffff\""
  27     end
  28
  29     def describe_node(uuid, describe_opts={})
  30       bgcolor = determine_fillcolor (describe_opts[:pip] || @opts[:pips].andand[uuid])
  31
  32       rsc = ArvadosBase::resource_class_for_uuid uuid
  33
  34       if GenerateGraph::collection_uuid(uuid) || rsc == Collection
  35         if Collection.is_empty_blob_locator? uuid.to_s
  36           # special case
  37           return "\"#{uuid}\" [label=\"(empty collection)\"];\n"
  38         end
  39
  40         href = url_for ({:controller => Collection.to_s.tableize,
  41                           :action => :show,
  42                           :id => uuid.to_s })
  43
  44         return "\"#{uuid}\" [label=\"#{encode_quotes(describe_opts[:label] || (@pdata[uuid] and @pdata[uuid][:name]) || uuid)}\",shape=box,href=\"#{href}\",#{bgcolor}];\n"
  45       else
  46         href = ""
  47         if describe_opts[:href]
  48           href = ",href=\"#{url_for ({:controller => describe_opts[:href][:controller],
  49                             :action => :show,
  50                             :id => describe_opts[:href][:id] })}\""
  51         end
  52         return "\"#{uuid}\" [label=\"#{encode_quotes(describe_opts[:label] || uuid)}\",#{bgcolor},shape=#{describe_opts[:shape] || 'box'}#{href}];\n"
  53       end
  54     end
  55
  56     def job_uuid(job)
  57       d = Digest::MD5.hexdigest(job[:script_parameters].to_json)
  58       if @opts[:combine_jobs] == :script_only
  59         uuid = "#{job[:script]}_#{d}"
  60       elsif @opts[:combine_jobs] == :script_and_version
  61         uuid = "#{job[:script]}_#{job[:script_version]}_#{d}"
  62       else
  63         uuid = "#{job[:uuid]}"
  64       end
  65
  66       @jobs[uuid] = [] unless @jobs[uuid]
  67       @jobs[uuid] << job unless @jobs[uuid].include? job
  68
  69       uuid
  70     end
  71
  72     def edge(tail, head, extra)
  73       if @opts[:direction] == :bottom_up
  74         gr = "\"#{encode_quotes head}\" -> \"#{encode_quotes tail}\""
  75       else
  76         gr = "\"#{encode_quotes tail}\" -> \"#{encode_quotes head}\""
  77       end
  78
  79       if extra.length > 0
  80         gr += " ["
  81         extra.each do |k, v|
  82           gr += "#{k}=\"#{encode_quotes v}\","
  83         end
  84         gr += "]"
  85       end
  86       gr += ";\n"
  87       gr
  88     end
  89
  90     def script_param_edges(uuid, sp)
  91       gr = ""
  92
  93       sp.each do |k, v|
  94         if @opts[:all_script_parameters]
  95           if v.is_a? Array or v.is_a? Hash
  96             encv = JSON.pretty_generate(v).gsub("\n", "\\l") + "\\l"
  97           else
  98             encv = v.to_json
  99           end
 100           gr += "\"#{encode_quotes encv}\" [shape=box];\n"
 101           gr += edge(encv, uuid, {:label => k})
 102         end
 103       end
 104       gr
 105     end
 106
 107     def cr_edges cr
 108       uuid = cr[:uuid]
 109       gr = ""
 110
 111       # Search for input mounts
 112       input_obj = cr[:mounts].andand[:"/var/lib/cwl/cwl.input.json"].andand[:content] || cr[:mounts] || {}
 113       if input_obj
 114         ProvenanceHelper::find_collections input_obj, 'input' do |col_hash, col_uuid, key|
 115           # Only include input PDHs
 116           if col_hash
 117             gr += describe_node(col_hash)
 118             gr += edge(col_hash, uuid, {:label => key})
 119           end
 120         end
 121       end
 122
 123       # Add CR outputs by PDH so they connect with the child CR's inputs.
 124       if cr[:output_uuid]
 125         output_pdh = Collection.find(cr[:output_uuid])[:portable_data_hash]
 126         if output_pdh
 127           gr += describe_node(output_pdh)
 128           gr += edge(uuid, output_pdh, {label: 'output'})
 129         end
 130       end
 131
 132       gr
 133     end
 134
 135     def job_edges job, edge_opts={}
 136       uuid = job_uuid(job)
 137       gr = ""
 138
 139       ProvenanceHelper::find_collections job[:script_parameters] do |collection_hash, collection_uuid, key|
 140         if collection_uuid
 141           gr += describe_node(collection_uuid)
 142           gr += edge(collection_uuid, uuid, {:label => key})
 143         else
 144           gr += describe_node(collection_hash)
 145           gr += edge(collection_hash, uuid, {:label => key})
 146         end
 147       end
 148
 149       if job[:docker_image_locator] and !@opts[:no_docker]
 150         gr += describe_node(job[:docker_image_locator], {label: (job[:runtime_constraints].andand[:docker_image] || job[:docker_image_locator])})
 151         gr += edge(job[:docker_image_locator], uuid, {label: "docker_image"})
 152       end
 153
 154       if @opts[:script_version_nodes]
 155         gr += describe_node(job[:script_version], {:label => "git:#{job[:script_version]}"})
 156         gr += edge(job[:script_version], uuid, {:label => "script_version"})
 157       end
 158
 159       if job[:output] and !edge_opts[:no_output]
 160         gr += describe_node(job[:output])
 161         gr += edge(uuid, job[:output], {label: "output" })
 162       end
 163
 164       if job[:log] and !edge_opts[:no_log]
 165         gr += describe_node(job[:log])
 166         gr += edge(uuid, job[:log], {label: "log"})
 167       end
 168
 169       gr
 170     end
 171
 172     def generate_provenance_edges(uuid)
 173       gr = ""
 174       m = GenerateGraph::collection_uuid(uuid)
 175       uuid = m if m
 176
 177       if uuid.nil? or uuid.empty? or @visited[uuid]
 178         return ""
 179       end
 180
 181       if @pdata[uuid].nil?
 182         return ""
 183       else
 184         @visited[uuid] = true
 185       end
 186
 187       if uuid.start_with? "component_"
 188         # Pipeline component inputs
 189         job = @pdata[@pdata[uuid][:job].andand[:uuid]]
 190
 191         if job
 192           gr += describe_node(job_uuid(job), {label: uuid[38..-1], pip: @opts[:pips].andand[job[:uuid]], shape: "oval",
 193                                 href: {controller: 'jobs', id: job[:uuid]}})
 194           gr += job_edges job, {no_output: true, no_log: true}
 195         end
 196
 197         # Pipeline component output
 198         outuuid = @pdata[uuid][:output_uuid]
 199         if outuuid
 200           outcollection = @pdata[outuuid]
 201           if outcollection
 202             gr += edge(job_uuid(job), outcollection[:portable_data_hash], {label: "output"})
 203             gr += describe_node(outcollection[:portable_data_hash], {label: outcollection[:name]})
 204           end
 205         elsif job and job[:output]
 206           gr += describe_node(job[:output])
 207           gr += edge(job_uuid(job), job[:output], {label: "output" })
 208         end
 209       else
 210         rsc = ArvadosBase::resource_class_for_uuid uuid
 211
 212         if rsc == Job
 213           job = @pdata[uuid]
 214           gr += job_edges job if job
 215         elsif rsc == ContainerRequest
 216           cr = @pdata[uuid]
 217           if cr
 218             gr += cr_edges cr
 219             gr += describe_node(uuid, {href: {controller: 'container_requests',
 220                                               id: uuid},
 221                                        label: @pdata[uuid][:name],
 222                                        shape: 'oval'})
 223             # Search for child CRs
 224             if cr[:container_uuid]
 225               child_crs = ContainerRequest.where(requesting_container_uuid: cr[:container_uuid])
 226               child_crs.each do |child|
 227                 gr += generate_provenance_edges(child[:uuid])
 228                 gr += edge(child[:uuid], uuid, {label: 'child'})
 229               end
 230             end
 231           end
 232         end
 233       end
 234
 235       @pdata.each do |k, link|
 236         if link[:head_uuid] == uuid.to_s and link[:link_class] == "provenance"
 237           href = url_for ({:controller => Link.to_s.tableize,
 238                             :action => :show,
 239                             :id => link[:uuid] })
 240
 241           gr += describe_node(link[:tail_uuid])
 242           gr += edge(link[:head_uuid], link[:tail_uuid], {:label => link[:name], :href => href})
 243           gr += generate_provenance_edges(link[:tail_uuid])
 244         end
 245       end
 246
 247       gr
 248     end
 249
 250     def describe_jobs
 251       gr = ""
 252       @jobs.each do |k, v|
 253         href = url_for ({:controller => Job.to_s.tableize,
 254                           :action => :index })
 255
 256         gr += "\"#{k}\" [href=\"#{href}?"
 257
 258         n = 0
 259         v.each do |u|
 260           gr += ";" unless gr.end_with? "?"
 261           gr += "uuid%5b%5d=#{u[:uuid]}"
 262           n |= @opts[:pips][u[:uuid]] if @opts[:pips] and @opts[:pips][u[:uuid]]
 263         end
 264
 265         gr += "\",label=\""
 266
 267         label = "#{v[0][:script]}"
 268
 269         if label == "run-command" and v[0][:script_parameters][:command].is_a? Array
 270           label = v[0][:script_parameters][:command].join(' ')
 271         end
 272
 273         if not @opts[:combine_jobs]
 274           label += "\\n#{v[0][:finished_at]}"
 275         end
 276
 277         gr += encode_quotes label
 278
 279         gr += "\",#{determine_fillcolor n}];\n"
 280       end
 281       gr
 282     end
 283
 284     def encode_quotes value
 285       value.to_s.gsub("\"", "\\\"").gsub("\n", "\\n")
 286     end
 287   end
 288
 289   def self.create_provenance_graph(pdata, svgId, opts={})
 290     if pdata.is_a? Array or pdata.is_a? ArvadosResourceList
 291       p2 = {}
 292       pdata.each do |k|
 293         p2[k[:uuid]] = k if k[:uuid]
 294       end
 295       pdata = p2
 296     end
 297
 298     unless pdata.is_a? Hash
 299       raise "create_provenance_graph accepts Array or Hash for pdata only, pdata is #{pdata.class}"
 300     end
 301
 302     gr = """strict digraph {
 303 node [fontsize=10,fontname=\"Helvetica,Arial,sans-serif\"];
 304 edge [fontsize=10,fontname=\"Helvetica,Arial,sans-serif\"];
 305 """
 306
 307     if opts[:direction] == :bottom_up
 308       gr += "edge [dir=back];"
 309     end
 310
 311     begin
 312       pdata = pdata.stringify_keys
 313
 314       g = GenerateGraph.new(pdata, opts)
 315
 316       pdata.each do |k, v|
 317         if !opts[:only_components] or k.start_with? "component_"
 318           gr += g.generate_provenance_edges(k)
 319         else
 320           #gr += describe_node(k)
 321         end
 322       end
 323
 324       if !opts[:only_components]
 325         gr += g.describe_jobs
 326       end
 327
 328     rescue => e
 329       Rails.logger.warn "#{e.inspect}"
 330       Rails.logger.warn "#{e.backtrace.join("\n\t")}"
 331       raise
 332     end
 333
 334     gr += "}"
 335     svg = ""
 336
 337     require 'open3'
 338
 339     Open3.popen2("dot", "-Tsvg") do |stdin, stdout, wait_thr|
 340       stdin.print(gr)
 341       stdin.close
 342       svg = stdout.read()
 343       wait_thr.value
 344       stdout.close()
 345     end
 346
 347     svg = svg.sub(/<\?xml.*?\?>/m, "")
 348     svg = svg.sub(/<!DOCTYPE.*?>/m, "")
 349     svg = svg.sub(/<svg /, "<svg id=\"#{svgId}\" ")
 350   end
 351
 352   # yields hash, uuid
 353   # Position indicates whether it is a content hash or arvados uuid.
 354   # One will hold a value, the other will always be nil.
 355   def self.find_collections(sp, key=nil, &b)
 356     case sp
 357     when ArvadosBase
 358       sp.class.columns.each do |c|
 359         find_collections(sp[c.name.to_sym], nil, &b)
 360       end
 361     when Hash
 362       sp.each do |k, v|
 363         find_collections(v, key || k, &b)
 364       end
 365     when Array
 366       sp.each do |v|
 367         find_collections(v, key, &b)
 368       end
 369     when String
 370       if m = /[a-f0-9]{32}\+\d+/.match(sp)
 371         yield m[0], nil, key
 372       elsif m = /[0-9a-z]{5}-4zz18-[0-9a-z]{15}/.match(sp)
 373         yield nil, m[0], key
 374       end
 375     end
 376   end
 377 end