omf_web 0.9.1 → 0.9.3

data/.gitignore

@@ -15,7 +15,6 @@ tmp
 # YARD artifacts
 .yardoc
 _yardoc
-doc/
 
 Gemfile.lock
 share/htdocs/vendor/valums-file-uploader-cf7bfb1/.gitignore

data/README.md

@@ -10,12 +10,18 @@
 ## Try the simple example
 
     git init /tmp/foo
-    ruby example/simple/simple_viz_server.rb start -p 4000
+    ruby -I lib -rubygems example/demo/demo_viz_server.rb start
+    
+This will start a web server at port 3000. Point your browser there and you should see somthing like:
 
-_4000 is the port number. For all options, please take a look at "thin -h" for more options_
+![Screenshot of starting page](https://raw.github.com/mytestbed/omf_web/master/doc/screenshot.png "Screenshot")
+
+For additional options start the server with -h.
 
 ## Design Notes
 
+ ** These notes are way out of date. Look at the 'demo' example for some guidance **
+
 This module is used to define and run a web server which allows a user to explore and
 intereact with various experiments. It is a stand-alone unit communicating through
 the OMF messaging framework with other entities.

data/example/demo/data_sources/mobile_network.rb

@@ -24,16 +24,19 @@ OMF::Web.register_datasource nw, :index => :id
 # Move mobile node
 Thread.new do
   begin
+    ts = 0
     angle = 0
     delta = Math::PI / 6
     twoPi = 2 * Math::PI
     r = 0.25
     loop do
       sleep 1
+      ts = ts + 1
       angle += delta
       angle -= twoPi if angle >= twoPi
       nw.transaction do 
         m = nw.node(:m1)
+        #m[:ts] = ts
         m[:x] = r * Math.sin(angle) + 0.5
         m[:y] = r * Math.cos(angle) + 0.5
         l[:load] = rand()

data/example/demo/data_sources/static_network.rb

@@ -0,0 +1,54 @@
+
+
+
+
+require 'omf-oml/network'
+require 'omf-oml/table'
+
+include OMF::OML
+  
+nw = OmlNetwork.new 'static_network'
+nw.node_schema [[:x, :float], [:y, :float], [:capacity, :float]]
+nw.create_node :n0, :x => 0.2, :y => 0.2, :capacity =>  0.3
+nw.create_node :n1, :x => 0.8, :y => 0.2, :capacity =>  0.5
+nw.create_node :n2, :x => 0.5, :y => 0.5, :capacity =>  0.8
+nw.create_node :n3, :x => 0.8, :y => 0.8, :capacity =>  0.8
+nw.create_node :n4, :x => 0.2, :y => 0.8, :capacity =>  0.8
+
+nw.link_schema [[:ts, :float], [:load, :float]]
+links = []
+links << nw.create_link(:l02, :n0, :n2, :ts => 0, :load => 0.0)
+links << nw.create_link(:l12, :n1, :n2, :ts => 0, :load => 0.25)
+links << nw.create_link(:l23, :n2, :n3, :ts => 0, :load => 0.5)
+links << nw.create_link(:l24, :n2, :n4, :ts => 0, :load => 0.75)
+
+require 'omf_web'
+OMF::Web.register_datasource nw, :index => :id
+
+# Create a table which serves the history of an individual link as a slice
+#
+link_history = nw.to_table(:links)
+OMF::Web.register_datasource link_history, :name => 'link_history'
+
+# Change load
+Thread.new do
+  begin
+    ts = 0
+    loop do
+      sleep 1
+      ts = ts + 1
+      frac = 1.0 / links.length
+      nw.transaction do
+        links.each_with_index do |l, i| 
+          l[:ts] = ts
+          l[:load] = rand() * frac + i * frac 
+        end
+      end
+    end
+  rescue Exception => ex
+    puts ex
+    puts ex.backtrace.join("\n")
+  end
+end
+
+

data/example/demo/widgets/charts_tab.yaml

@@ -11,6 +11,21 @@ widget:
   priority: 900
   type: layout/tabbed
   widgets: 
+    
+    - name: Multi Barchart
+      type: data/multi_barchart
+      data_source: 
+        name: movies_year_genre
+      mapping:
+        label: genre
+        value: count
+        group_by: year
+      rotate_labels: 0
+      axis:
+        x:
+          ticks: 
+            format: false
+    
     - name: Line Chart
       type: data/line_chart3
       data_source: 
@@ -29,6 +44,9 @@ widget:
       margin:
         bottom: 30
 
+    - name: Dynamic
+      id_ref: line_chart
+      
     - name: Discrete Barchart
       type: data/discrete_bar_chart
       data_source: 
@@ -50,20 +68,6 @@ widget:
           ticks: 
             format: ",.2f"
 
-    - name: Multi Barchart
-      type: data/multi_barchart
-      data_source: 
-        name: movies_year_genre
-      mapping:
-        label: genre
-        value: count
-        group_by: year
-      rotate_labels: 0
-      axis:
-        x:
-          ticks: 
-            format: false
-
     - name: Pie Chart
       type: data/pie_chart2
       data_source: 
@@ -91,11 +95,12 @@ widget:
           scale: 0.04 # 1.0 / 25
           color: red_yellow20_green() # () indicates a color scale  
           
-    - name: Network
+    - name: Mobile Network
       type: data/network2
       data_source: 
         name: mobile_network
-        dynamic: 1
+        unique_column: id  # only use the latest link and row descriptions
+        dynamic: true
       mapping:
         nodes:
           x:

data/example/demo/widgets/linked_graphs_tab.yaml

@@ -0,0 +1,95 @@
+
+
+# Define a 'dashboard' consisting of two columns of widgets
+#
+
+widget:
+  id: linked_graphs
+  name: Linked Graphs
+  top_level: true
+  priority: 300
+  type: layout/two_columns/50_50
+  left:
+    - name: Network
+      type: data/network2
+      width: 1.0
+      data_source: 
+        name: static_network
+        unique_column: id  # only use the latest link and row descriptions
+        dynamic: true
+      mapping:
+        nodes:
+          x:
+            property: x
+          y: 
+            property: y
+        links:
+          stroke_width:
+            property: load
+            scale: 20
+            min: 3
+          stroke_color:
+            property: load
+            color: red_yellow20_green() #green_yellow80_red()
+      margin: 
+        left: 30
+        right: 30
+      interaction_mode: click  # click on link to create event
+
+
+    # - name: Link Stats All
+      # type: data/line_chart3
+      # #area: true # color the area between line and zero line
+      # data_source: 
+        # name: static_network/links
+        # dynamic: true
+      # group_by: name
+      # mapping:
+        # x_axis: ts
+        # y_axis: 
+          # property:  load 
+          # min: 0
+          # max: 1
+      # axis:
+        # x:
+          # ticks:
+            # type: time
+            # #transition: 0
+          # legend: Time (sec)
+        # y:
+          # legend: Load (bps)
+      # margin: 
+        # left: 100
+        
+  right:
+    - name: Single Link Stats
+      type: data/line_chart3
+      #area: true # color the area between line and zero line
+      data_source:
+        name: link_history
+        #name: static_network/links   
+        
+        # Only fetch a 'slice' of the underlying data source. A slice
+        # is defined by specific value in the 'slice_column' of all rows
+        slice:
+          slice_column: id
+          event:
+            name: graph.static_network_links.selected
+            key: id
+      group_by: name
+      mapping:
+        x_axis: ts
+        y_axis: 
+          property:  load 
+          min: 0
+          max: 1
+      axis:
+        x:
+          ticks:
+            type: time
+            #transition: 0
+          legend: Time (sec)
+        y:
+          legend: Load (bps)
+      margin: 
+        left: 100

data/example/demo/widgets/mobile_network_widget.yaml

@@ -7,7 +7,7 @@ widget:
   width: 1.0
   data_source: 
     name: mobile_network
-    dynamic: 1
+    unique_column: id  # only use the latest link and row descriptions
   mapping:
     nodes:
       x:

data/example/demo/widgets/pie_chart_widget.yaml

@@ -7,7 +7,7 @@
 widget:
   id: pie
   name: Pie Chart
-  type: data/pie_chart
+  type: data/pie_chart2
   data_sources: animals
   mapping :
     value: count

data/lib/omf-web/config.ru

@@ -2,7 +2,7 @@
 require 'omf_common/lobject'
 
 use ::Rack::ShowExceptions
-use ::Rack::Lint
+#use ::Rack::Lint
 
 OMF::Web::Runner.instance.life_cycle(:pre_rackup)
 options = OMF::Web::Runner.instance.options
@@ -15,7 +15,7 @@ end
 map '/_ws' do
   begin
     require 'omf-web/rack/websocket_handler'
-    run OMF::Web::Rack::WebsocketHandler.new # :backend => { :debug => true }
+    run OMF::Web::Rack::WebsocketHandler.new #:backend => { :debug => true }
   rescue Exception => ex
     OMF::Common::Loggable.logger('web').error "#{ex}"
   end

data/lib/omf-web/data_source_proxy.rb

@@ -13,8 +13,14 @@ module OMF::Web
     
     @@datasources = {}
     
+    # Register a data source.
+    #
+    # params data_source - Data source to register
+    # params opts:
+    #          name - Name to use instead of data source's native name
+    #
     def self.register_datasource(data_source, opts = {})
-      name = data_source.name.to_sym
+      name = (opts[:name] || data_source.name).to_sym
       if (@@datasources.key? name)
         raise "Repeated try to register data source '#{name}'"
       end
@@ -31,6 +37,8 @@ module OMF::Web
       unless dsp = OMF::Web::SessionStore[name, :dsp]
         if ds = @@datasources[name]
           dsp = OMF::Web::SessionStore[name, :dsp] = self.new(name, ds)
+        else
+          warn "Requesting unknown datasource '#{name}', only know about '#{@@datasources.keys.join(', ')}'."
         end
       end
       dsp
@@ -49,28 +57,48 @@ module OMF::Web
       unless ds_descr.is_a? Hash
         raise "Expected Hash, but got '#{ds_descr.class}::#{ds_descr.inspect}'"
       end
-      ds_name = ds_descr[:name].to_sym
+      unless ds_name = ds_descr[:name]
+        raise "Missing 'name' attribute in datasource description. (#{ds_descr.inspect})"
+      end
+      ds_name = ds_name.to_sym
       ds = @@datasources[ds_name]
       unless ds
-        raise "Unknown data source '#{ds_name}' (#{@@datasources.keys.inspect})"
+        # let's check for sub table, such as network/nodes
+        main, sub = ds_descr[:name].split('/')
+        if (sub)
+          if ds_top = @@datasources[main.to_sym]
+            ds = ds_top[sub.to_sym]
+          end
+        end
+        unless ds
+          raise "Unknown data source '#{ds_name}' (#{@@datasources.keys.inspect})"
+        end
       end
       if ds.is_a? Hash
-        n_name = "#{ds_name}_nodes".to_sym
-        l_name = "#{ds_name}_links".to_sym
-        if (nodes = OMF::Web::SessionStore[n_name, :dsp])
-          # assume links exist as well
-          links = OMF::Web::SessionStore[l_name, :dsp]                
-        else
-          nodes = OMF::Web::SessionStore[n_name, :dsp] = self.new(n_name, ds[:nodes])
-          links = OMF::Web::SessionStore[l_name, :dsp] = self.new(l_name, ds[:links])
+        proxies = ds.map do |name, ds|
+          id = "#{ds_name}_#{name}".to_sym
+          proxy = OMF::Web::SessionStore[id, :dsp] ||= self.new(id, ds)
         end
-        return [nodes, links]
+        return proxies
+          
+        # n_name = "#{ds_name}_nodes".to_sym
+        # l_name = "#{ds_name}_links".to_sym
+        # if (nodes = OMF::Web::SessionStore[n_name, :dsp])
+          # # assume links exist as well
+          # links = OMF::Web::SessionStore[l_name, :dsp]                
+        # else
+          # nodes = OMF::Web::SessionStore[n_name, :dsp] = self.new(n_name, ds[:nodes])
+          # links = OMF::Web::SessionStore[l_name, :dsp] = self.new(l_name, ds[:links])
+        # end
+        # return [nodes, links]
       end
       
       proxy = OMF::Web::SessionStore[ds_name, :dsp] ||= self.new(ds_name, ds)
       return [proxy]
     end
     
+    attr_reader :name
+    
     def reset()
       # TODO: Figure out partial sending 
     end
@@ -80,19 +108,53 @@ module OMF::Web
       [res.to_json, "text/json"]
     end
     
+    # Register callback to be informed of changes to the underlying data source.
+    # Call block when new rows are becoming available. Block needs ot return 
+    # true if it wants to continue receiving updates.
+    #
+    # offset: Number of records already downloaded
+    #
+    def on_changed(offset, &block)
+      ds = @data_source
+      rows = ds.rows[(offset - ds.offset) .. -1]
+      if rows && rows.length > 0
+        debug "on_changed: sending #{rows.length}"
+        block.call rows, ds.offset
+      end
+      @data_source.on_row_added(block.object_id) do |row, offset|
+        debug "on_changed: more data: #{row.inspect}"
+        block.call [row], offset
+      end
+    end
     
-    def to_javascript(update_interval = 0)
-      is_dynamic = update_interval > 0 ? ".is_dynamic(#{update_interval})" : ""
+    # Create a new data source which only contains a slice of the underlying data source
+    def create_slice(col_name, col_value)
+      ds = @data_source.create_sliced_table(col_name, col_value)
+      dsp = self.class.new(ds.name, ds)
+      def dsp.release; @data_source.release end
+      dsp
+    end
+    
+    def to_javascript(opts)
+      #puts "to_java>>>>> #{opts.inspect}"
+      sid = Thread.current["sessionID"]
+      opts = opts.dup
+      opts[:name] = @name
+      opts[:schema] = @data_source.schema
+      opts[:update_url] = "/_update/#{@name}?sid=#{sid}"
+      opts[:sid] = sid
+      unless opts[:slice] # don't send any data if this is a sliced one
+        opts[:rows] = @data_source.rows[0 .. 20]
+        opts[:offset] = @data_source.offset
+      end
+      #puts "to_java2>>>>> #{opts.to_json.inspect}"
+      
       %{
-        OML.data_sources.register('#{@name}', 
-                                  '/_update/#{@name}?sid=#{Thread.current["sessionID"]}',
-                                  #{@data_source.schema.to_json},
-                                  #{@data_source.rows.to_json})#{is_dynamic};
+        OML.data_sources.register(#{opts.to_json});
       }
      
     end
     
-    
     def initialize(name, data_source)
       @name = name
       @data_source = data_source

data/lib/omf-web/rack/websocket_handler.rb

@@ -7,46 +7,100 @@ module OMF::Web::Rack
   
   class WebsocketHandler < ::Rack::WebSocket::Application
     include OMF::Common::Loggable
-    extend OMF::Common::Loggable    
+    extend OMF::Common::Loggable 
+    
+    def on_open(env)
+      #puts ">>>>> OPEN"
+    end   
   
-    def on_message(env, msg)
+    def on_message(env, msg_s)
       begin
-        #puts "message received: " + msg
-        
-        ma = msg.split(':')
-        cmd = ma.shift.to_sym
-        if (cmd == :id)
-          begin
-            h = OMF::Web::SessionStore.find_tab_from_path(ma)
-            Thread.current["sessionID"] = h[:sid]
-            @tab_inst = h[:tab_inst]
-            @sub_path = h[:sub_path]
-            @tab_inst.on_ws_open(self, @sub_path.dup)
-          rescue Exception => ex
-            error ex
-            debug "#{ex.backtrace.join("\n")}"
-            send_data("{error: '#{ex.to_s}'}")
-            return
-          end
+        req = ::Rack::Request.new(env)
+        sid = req.params['sid']
+        Thread.current["sessionID"] = sid
 
-        else
-          send_data("{error: 'Unknown command -#{cmd}-'}")
+        msg = JSON.parse(msg_s)
+        debug("Msg(#{sid}): #{msg.inspect}")
+        msg_type = msg['type']
+        args = msg['args']
+        msg_handler = "on_#{msg_type}".to_sym
+        unless respond_to? msg_handler
+          warn "Received unknonw request '#{msg_type}'"
+          send_data({type: 'reply', status: 'error', err_msg: "Unknown message type '#{msg_type}'"}.to_json)
+          return
         end
+        context = OMF::Web::SessionStore[args['name'], :ws] ||= {}
+        send(msg_handler, args, context)
       rescue Exception => ex
-        error(ex)
+        error ex
+        debug "#{ex.backtrace.join("\n")}"
+        send_data({type: 'reply', status: 'exception', err_msg: ex.to_s}.to_json)
       end
       #puts "message processed"      
     end
   
     def on_close(env)
       begin
-        puts "client disconnected"
+        debug "client disconnected"
         @tab_inst.on_ws_close(self, @sub_path) if @tab_inst
         @tab_inst = nil
       rescue Exception => ex
         error(ex)
       end
     end
+    
+    def on_register_data_source(args, context)
+      dsp = find_data_source(args)
+      return unless dsp  # should define appropriate exception
+      debug "Received registration for datasource proxy '#{dsp}'"
+      dsp.on_changed(args['offset']) do |new_rows, offset|
+        msg = {
+          type: 'datasource_update',
+          datasource: dsp.name,
+          rows: new_rows,
+          offset: offset
+        }
+        send_data(msg.to_json)
+      end
+      send_data({type: 'reply', status: 'ok'}.to_json)
+    end
+    
+    # args {"slice"=>{"col_name"=>"id", "col_value"=>"e8..."}, "ds_name"=>"individual_link"}}
+    def on_request_slice(args, context)
+      dsp = find_data_source(args)
+      return unless dsp  # should define appropriate exception
+      
+      sargs = args['slice']
+      col_name = sargs['col_name']
+      col_value = sargs['col_value']
+      debug "Creating slice '#{col_name}:#{col_value}' data source '#{dsp}'"
+      
+      if old_sdsp = context[:sliced_datasource]
+        return if old_sdsp[:column_name] == col_name
+        old_sdsp[:dsp].release
+      end
+      sdsp = dsp.create_slice(col_name, col_value)
+      context[:sliced_datasource] = {:col_name => col_name, :dsp => sdsp}
+      sdsp.on_changed(0) do |new_rows, offset|
+        msg = {
+          type: 'datasource_update',
+          datasource: args['ds_name'],
+          rows: new_rows,
+          offset: offset
+        }
+        send_data(msg.to_json)
+      end
+    end
+    
+    def find_data_source(args)
+      ds_name = args['ds_name']
+      unless dsp = OMF::Web::DataSourceProxy[ds_name]
+        warn "Request for unknown datasource '#{ds_name}'."
+        send_data({type: 'reply', status: 'error', err_msg: "Unknown datasource '#{ds_name}'"}.to_json)
+        return nil
+      end
+      dsp
+    end
 
   end # WebsocketHandler