roundhouse-x 0.1.0

data/lib/roundhouse/web.rb

@@ -0,0 +1,264 @@
+require 'erb'
+require 'yaml'
+require 'sinatra/base'
+
+require 'roundhouse'
+require 'roundhouse/api'
+require 'roundhouse/paginator'
+require 'roundhouse/web_helpers'
+
+module Roundhouse
+  class Web < Sinatra::Base
+    include Roundhouse::Paginator
+
+    enable :sessions
+    use Rack::Protection, :use => :authenticity_token unless ENV['RACK_ENV'] == 'test'
+
+    set :root, File.expand_path(File.dirname(__FILE__) + "/../../web")
+    set :public_folder, proc { "#{root}/assets" }
+    set :views, proc { "#{root}/views" }
+    set :locales, ["#{root}/locales"]
+
+    helpers WebHelpers
+
+    DEFAULT_TABS = {
+      "Dashboard" => '',
+      "Busy"      => 'busy',
+      "Queues"    => 'queues',
+      "Retries"   => 'retries',
+      "Scheduled" => 'scheduled',
+      "Dead"      => 'morgue',
+    }
+
+    class << self
+      def default_tabs
+        DEFAULT_TABS
+      end
+
+      def custom_tabs
+        @custom_tabs ||= {}
+      end
+      alias_method :tabs, :custom_tabs
+
+      attr_accessor :app_url
+    end
+
+    get "/busy" do
+      erb :busy
+    end
+
+    post "/busy" do
+      if params['identity']
+        p = Roundhouse::Process.new('identity' => params['identity'])
+        p.quiet! if params[:quiet]
+        p.stop! if params[:stop]
+      else
+        processes.each do |pro|
+          pro.quiet! if params[:quiet]
+          pro.stop! if params[:stop]
+        end
+      end
+      redirect "#{root_path}busy"
+    end
+
+    get "/queues" do
+      @queues = Roundhouse::Queue.all
+      erb :queues
+    end
+
+    get "/queues/:name" do
+      halt 404 unless params[:name]
+      @count = (params[:count] || 25).to_i
+      @name = params[:name]
+      @queue = Roundhouse::Queue.new(@name)
+      (@current_page, @total_size, @messages) = page("queue:#{@name}", params[:page], @count)
+      @messages = @messages.map { |msg| Roundhouse::Job.new(msg, @name) }
+      erb :queue
+    end
+
+    post "/queues/:name" do
+      Roundhouse::Queue.new(params[:name]).clear
+      redirect "#{root_path}queues"
+    end
+
+    post "/queues/:name/delete" do
+      Roundhouse::Job.new(params[:key_val], params[:name]).delete
+      redirect_with_query("#{root_path}queues/#{params[:name]}")
+    end
+
+    get '/morgue' do
+      @count = (params[:count] || 25).to_i
+      (@current_page, @total_size, @dead) = page("dead", params[:page], @count, reverse: true)
+      @dead = @dead.map { |msg, score| Roundhouse::SortedEntry.new(nil, score, msg) }
+      erb :morgue
+    end
+
+    get "/morgue/:key" do
+      halt 404 unless params['key']
+      @dead = Roundhouse::DeadSet.new.fetch(*parse_params(params['key'])).first
+      redirect "#{root_path}morgue" if @dead.nil?
+      erb :dead
+    end
+
+    post '/morgue' do
+      redirect request.path unless params['key']
+
+      params['key'].each do |key|
+        job = Roundhouse::DeadSet.new.fetch(*parse_params(key)).first
+        retry_or_delete_or_kill job, params if job
+      end
+      redirect_with_query("#{root_path}morgue")
+    end
+
+    post "/morgue/all/delete" do
+      Roundhouse::DeadSet.new.clear
+      redirect "#{root_path}morgue"
+    end
+
+    post "/morgue/all/retry" do
+      Roundhouse::DeadSet.new.retry_all
+      redirect "#{root_path}morgue"
+    end
+
+    post "/morgue/:key" do
+      halt 404 unless params['key']
+      job = Roundhouse::DeadSet.new.fetch(*parse_params(params['key'])).first
+      retry_or_delete_or_kill job, params if job
+      redirect_with_query("#{root_path}morgue")
+    end
+
+
+    get '/retries' do
+      @count = (params[:count] || 25).to_i
+      (@current_page, @total_size, @retries) = page("retry", params[:page], @count)
+      @retries = @retries.map { |msg, score| Roundhouse::SortedEntry.new(nil, score, msg) }
+      erb :retries
+    end
+
+    get "/retries/:key" do
+      @retry = Roundhouse::RetrySet.new.fetch(*parse_params(params['key'])).first
+      redirect "#{root_path}retries" if @retry.nil?
+      erb :retry
+    end
+
+    post '/retries' do
+      redirect request.path unless params['key']
+
+      params['key'].each do |key|
+        job = Roundhouse::RetrySet.new.fetch(*parse_params(key)).first
+        retry_or_delete_or_kill job, params if job
+      end
+      redirect_with_query("#{root_path}retries")
+    end
+
+    post "/retries/all/delete" do
+      Roundhouse::RetrySet.new.clear
+      redirect "#{root_path}retries"
+    end
+
+    post "/retries/all/retry" do
+      Roundhouse::RetrySet.new.retry_all
+      redirect "#{root_path}retries"
+    end
+
+    post "/retries/:key" do
+      job = Roundhouse::RetrySet.new.fetch(*parse_params(params['key'])).first
+      retry_or_delete_or_kill job, params if job
+      redirect_with_query("#{root_path}retries")
+    end
+
+    get '/scheduled' do
+      @count = (params[:count] || 25).to_i
+      (@current_page, @total_size, @scheduled) = page("schedule", params[:page], @count)
+      @scheduled = @scheduled.map { |msg, score| Roundhouse::SortedEntry.new(nil, score, msg) }
+      erb :scheduled
+    end
+
+    get "/scheduled/:key" do
+      @job = Roundhouse::ScheduledSet.new.fetch(*parse_params(params['key'])).first
+      redirect "#{root_path}scheduled" if @job.nil?
+      erb :scheduled_job_info
+    end
+
+    post '/scheduled' do
+      redirect request.path unless params['key']
+
+      params['key'].each do |key|
+        job = Roundhouse::ScheduledSet.new.fetch(*parse_params(key)).first
+        delete_or_add_queue job, params if job
+      end
+      redirect_with_query("#{root_path}scheduled")
+    end
+
+    post "/scheduled/:key" do
+      halt 404 unless params['key']
+      job = Roundhouse::ScheduledSet.new.fetch(*parse_params(params['key'])).first
+      delete_or_add_queue job, params if job
+      redirect_with_query("#{root_path}scheduled")
+    end
+
+    get '/' do
+      @redis_info = redis_info.select{ |k, v| REDIS_KEYS.include? k }
+      stats_history = Roundhouse::Stats::History.new((params[:days] || 30).to_i)
+      @processed_history = stats_history.processed
+      @failed_history = stats_history.failed
+      erb :dashboard
+    end
+
+    REDIS_KEYS = %w(redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human)
+
+    get '/dashboard/stats' do
+      redirect "#{root_path}stats"
+    end
+
+    get '/stats' do
+      roundhouse_stats = Roundhouse::Stats.new
+      redis_stats   = redis_info.select { |k, v| REDIS_KEYS.include? k }
+
+      content_type :json
+      Roundhouse.dump_json(
+        roundhouse: {
+          processed:       roundhouse_stats.processed,
+          failed:          roundhouse_stats.failed,
+          busy:            roundhouse_stats.workers_size,
+          processes:       roundhouse_stats.processes_size,
+          enqueued:        roundhouse_stats.enqueued,
+          scheduled:       roundhouse_stats.scheduled_size,
+          retries:         roundhouse_stats.retry_size,
+          dead:            roundhouse_stats.dead_size,
+          default_latency: roundhouse_stats.default_queue_latency
+        },
+        redis: redis_stats
+      )
+    end
+
+    get '/stats/queues' do
+      queue_stats = Roundhouse::Stats::Queues.new
+
+      content_type :json
+      Roundhouse.dump_json(
+        queue_stats.lengths
+      )
+    end
+
+    private
+
+    def retry_or_delete_or_kill job, params
+      if params['retry']
+        job.retry
+      elsif params['delete']
+        job.delete
+      elsif params['kill']
+        job.kill
+      end
+    end
+
+    def delete_or_add_queue job, params
+      if params['delete']
+        job.delete
+      elsif params['add_to_queue']
+        job.add_to_queue
+      end
+    end
+  end
+end

data/lib/roundhouse/web_helpers.rb

@@ -0,0 +1,249 @@
+require 'uri'
+
+module Roundhouse
+  # This is not a public API
+  module WebHelpers
+    def strings(lang)
+      @@strings ||= {}
+      @@strings[lang] ||= begin
+        # Allow roundhouse-web extensions to add locale paths
+        # so extensions can be localized
+        settings.locales.each_with_object({}) do |path, global|
+          find_locale_files(lang).each do |file|
+            strs = YAML.load(File.open(file))
+            global.deep_merge!(strs[lang])
+          end
+        end
+      end
+    end
+
+    def locale_files
+      @@locale_files = settings.locales.flat_map do |path|
+        Dir["#{path}/*.yml"]
+      end
+    end
+
+    def find_locale_files(lang)
+      locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
+    end
+
+    # This is a hook for a Roundhouse Pro feature.  Please don't touch.
+    def filtering(*)
+    end
+
+    # This view helper provide ability display you html code in
+    # to head of page. Example:
+    #
+    #   <% add_to_head do %>
+    #     <link rel="stylesheet" .../>
+    #     <meta .../>
+    #   <% end %>
+    #
+    def add_to_head(&block)
+      @head_html ||= []
+      @head_html << block if block_given?
+    end
+
+    def display_custom_head
+      return unless defined?(@head_html)
+      @head_html.map { |block| capture(&block) }.join
+    end
+
+    # Simple capture method for erb templates. The origin was
+    # capture method from sinatra-contrib library.
+    def capture(&block)
+      block.call
+      eval('', block.binding)
+    end
+
+    # Given a browser request Accept-Language header like
+    # "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2", this function
+    # will return "fr" since that's the first code with a matching
+    # locale in web/locales
+    def locale
+      @locale ||= begin
+        locale = 'en'.freeze
+        languages = request.env['HTTP_ACCEPT_LANGUAGE'.freeze] || 'en'.freeze
+        languages.downcase.split(','.freeze).each do |lang|
+          next if lang == '*'.freeze
+          lang = lang.split(';'.freeze)[0]
+          break locale = lang if find_locale_files(lang).any?
+        end
+        locale
+      end
+    end
+
+    def get_locale
+      strings(locale)
+    end
+
+    def t(msg, options={})
+      string = get_locale[msg] || msg
+      if options.empty?
+        string
+      else
+        string % options
+      end
+    end
+
+    def workers
+      @workers ||= Roundhouse::Workers.new
+    end
+
+    def processes
+      @processes ||= Roundhouse::ProcessSet.new
+    end
+
+    def stats
+      @stats ||= Roundhouse::Stats.new
+    end
+
+    def retries_with_score(score)
+      Roundhouse.redis do |conn|
+        conn.zrangebyscore('retry', score, score)
+      end.map { |msg| Roundhouse.load_json(msg) }
+    end
+
+    def location
+      Roundhouse.redis { |conn| conn.client.location }
+    end
+
+    def redis_connection
+      Roundhouse.redis { |conn| conn.client.id }
+    end
+
+    def namespace
+      @@ns ||= Roundhouse.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+    end
+
+    def redis_info
+      Roundhouse.redis do |conn|
+        # admin commands can't go through redis-namespace starting
+        # in redis-namespace 2.0
+        if conn.respond_to?(:namespace)
+          conn.redis.info
+        else
+          conn.info
+        end
+      end
+    end
+
+    def root_path
+      "#{env['SCRIPT_NAME']}/"
+    end
+
+    def current_path
+      @current_path ||= request.path_info.gsub(/^\//,'')
+    end
+
+    def current_status
+      workers.size == 0 ? 'idle' : 'active'
+    end
+
+    def relative_time(time)
+      %{<time datetime="#{time.getutc.iso8601}">#{time}</time>}
+    end
+
+    def job_params(job, score)
+      "#{score}-#{job['jid']}"
+    end
+
+    def parse_params(params)
+      score, jid = params.split("-")
+      [score.to_f, jid]
+    end
+
+    SAFE_QPARAMS = %w(page poll)
+
+    # Merge options with current params, filter safe params, and stringify to query string
+    def qparams(options)
+      options = options.stringify_keys
+      params.merge(options).map do |key, value|
+        SAFE_QPARAMS.include?(key) ? "#{key}=#{value}" : next
+      end.join("&")
+    end
+
+    def truncate(text, truncate_after_chars = 2000)
+      truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
+    end
+
+    def display_args(args, truncate_after_chars = 2000)
+      args.map do |arg|
+        h(truncate(to_display(arg)))
+      end.join(", ")
+    end
+
+    def csrf_tag
+      "<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>"
+    end
+
+    def to_display(arg)
+      begin
+        arg.inspect
+      rescue
+        begin
+          arg.to_s
+        rescue => ex
+          "Cannot display argument: [#{ex.class.name}] #{ex.message}"
+        end
+      end
+    end
+
+    RETRY_JOB_KEYS = Set.new(%w(
+      queue class args retry_count retried_at failed_at
+      jid error_message error_class backtrace
+      error_backtrace enqueued_at retry wrapped
+    ))
+
+    def retry_extra_items(retry_job)
+      @retry_extra_items ||= {}.tap do |extra|
+        retry_job.item.each do |key, value|
+          extra[key] = value unless RETRY_JOB_KEYS.include?(key)
+        end
+      end
+    end
+
+    def number_with_delimiter(number)
+      begin
+        Float(number)
+      rescue ArgumentError, TypeError
+        return number
+      end
+
+      options = {delimiter: ',', separator: '.'}
+      parts = number.to_s.to_str.split('.')
+      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}")
+      parts.join(options[:separator])
+    end
+
+    def h(text)
+      ::Rack::Utils.escape_html(text)
+    rescue ArgumentError => e
+      raise unless e.message.eql?('invalid byte sequence in UTF-8')
+      text.encode!('UTF-16', 'UTF-8', invalid: :replace, replace: '').encode!('UTF-8', 'UTF-16')
+      retry
+    end
+
+    # Any paginated list that performs an action needs to redirect
+    # back to the proper page after performing that action.
+    def redirect_with_query(url)
+      r = request.referer
+      if r && r =~ /\?/
+        ref = URI(r)
+        redirect("#{url}?#{ref.query}")
+      else
+        redirect url
+      end
+    end
+
+    def environment_title_prefix
+      environment = Roundhouse.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+
+      "[#{environment.upcase}] " unless environment == "production"
+    end
+
+    def product_version
+      "Roundhouse v#{Roundhouse::VERSION}"
+    end
+  end
+end

data/lib/roundhouse/worker.rb

@@ -0,0 +1,90 @@
+require 'roundhouse/client'
+require 'roundhouse/core_ext'
+
+module Roundhouse
+
+  ##
+  # Include this module in your worker class and you can easily create
+  # asynchronous jobs:
+  #
+  # class HardWorker
+  #   include Roundhouse::Worker
+  #
+  #   def perform(*args)
+  #     # do some work
+  #   end
+  # end
+  #
+  # Then in your Rails app, you can do this:
+  #
+  #   HardWorker.perform_async(queue_id, 1, 2, 3)
+  #
+  # Note that perform_async is a class method, perform is an instance method.
+  module Worker
+    attr_accessor :jid
+
+    def self.included(base)
+      raise ArgumentError, "You cannot include Roundhouse::Worker in an ActiveJob: #{base.name}" if base.ancestors.any? {|c| c.name == 'ActiveJob::Base' }
+
+      base.extend(ClassMethods)
+      base.class_attribute :roundhouse_options_hash
+      base.class_attribute :roundhouse_retry_in_block
+      base.class_attribute :roundhouse_retries_exhausted_block
+    end
+
+    def logger
+      Roundhouse.logger
+    end
+
+    module ClassMethods
+
+      def perform_async(queue_id, *args)
+        client_push('queue_id' => queue_id, 'class' => self, 'args' => args)
+      end
+
+      def perform_in(queue_id, interval, *args)
+        int = interval.to_f
+        now = Time.now
+        ts = (int < 1_000_000_000 ? (now + interval).to_f : int)
+
+        item = { 'queue_id' => queue_id, 'class' => self, 'args' => args, 'at' => ts }
+
+        # Optimization to enqueue something now that is scheduled to go out now or in the past
+        item.delete('at'.freeze) if ts <= now.to_f
+
+        client_push(item)
+      end
+      alias_method :perform_at, :perform_in
+
+      ##
+      # Allows customization for this type of Worker.
+      # Legal options:
+      #
+      #   :retry - enable the RetryJobs middleware for this Worker, default *true*
+      #   :backtrace - whether to save any error backtrace in the retry payload to display in web UI,
+      #      can be true, false or an integer number of lines to save, default *false*
+      #   :pool - use the given Redis connection pool to push this type of job to a given shard.
+      def roundhouse_options(opts={})
+        self.roundhouse_options_hash = get_roundhouse_options.merge(opts.stringify_keys)
+      end
+
+      def roundhouse_retry_in(&block)
+        self.roundhouse_retry_in_block = block
+      end
+
+      def roundhouse_retries_exhausted(&block)
+        self.roundhouse_retries_exhausted_block = block
+      end
+
+      def get_roundhouse_options # :nodoc:
+        self.roundhouse_options_hash ||= Roundhouse.default_worker_options
+      end
+
+      def client_push(item) # :nodoc:
+        pool = Thread.current[:roundhouse_via_pool] || get_roundhouse_options['pool'] || Roundhouse.redis_pool
+        Roundhouse::Client.new(pool).push(item.stringify_keys)
+      end
+
+    end
+  end
+end