sqs_web 0.0.1

data/lib/sqs_web/application/views/message.erb

@@ -0,0 +1,47 @@
+<li class="job" id="message_<%= message.message_id %>">
+  <input type="checkbox" class="bulk_check" id="batch_action_item_<%= message.message_id %>" value="<%= message.message_id %>/<%= queue[:name] %>" name="message_collection[]" form="bulk_action_form"/>
+  <dl>
+    <dt>ID</dt>
+    <dd>
+      <a name="<%= message.message_id %>"></a>
+      <a href="#<%= message.message_id %>"><%=h message.message_id %></a>
+      <div class="controls">
+        <form action="<%= u("remove/#{queue[:name]}/#{message.message_id}") %>" method="post">
+          <%= csrf_token_tag %>
+          <input type="submit" value="Remove" />
+        </form>
+        or
+        <form action="<%= u("requeue/#{queue[:name]}/#{message.message_id}") %>" method="post">
+          <%= csrf_token_tag %>
+          <input type="submit" value="Move to Source Queue" />
+        </form>
+      </div>
+    </dd>
+    <% if message.attributes["ApproximateReceiveCount"] %>
+      <dt>Receive Count</dt>
+      <dd><%=h message.attributes["ApproximateReceiveCount"] %></dd>
+    <% end %>
+    <dt>Queue Name</dt>
+    <dd><%=h queue[:name] %></dd>
+    <dt>Origin Queue</dt>
+    <dd><%=h queue[:source_url] %></dd>
+    <dt>Message Body</dt>
+    <dd>
+    <pre><%=h message.body %></pre>
+    </dd>
+    <dt>Raw Message</dt>
+    <dd>
+      <div class="backtrace">
+        <pre><%=h message.inspect.to_yaml[0..100] + '...' %></pre>
+      </div>
+      <a class="backtrace" href="#">Toggle full message</a>
+      <div class="backtrace full hide">
+        <pre><%=h message.inspect.to_yaml %></pre>
+      </div>
+    </dd>
+    <dt>Enqueued At</dt>
+    <dd class="time">
+      <%=h Time.at(message.attributes["SentTimestamp"].to_i/1000).rfc822 %>
+    </dd>
+  </dl>
+</li>

data/lib/sqs_web/application/views/overview.erb

@@ -0,0 +1,17 @@
+<h1>
+  Overview
+</h1>
+<p class="sub">
+  The list below shows an overview of messages in the SQS queues.
+</p>
+<table class="overview">
+  <tr>
+    <th>Queue Name</th>
+    <th>Visible Messages Count</th>
+    <th>In Flight Messages Count</th>
+    <th>Source Queue</th>
+  </tr>
+  <% @queues.each do |queue| %>
+    <%= partial :queue_stats, {:queue => queue, :stats => @stats[queue[:name]]} %>
+  <% end %>
+</table>

data/lib/sqs_web/application/views/queue_stats.erb

@@ -0,0 +1,14 @@
+<tr>
+  <td>
+    <%= queue[:name] %>
+  </td>
+  <td>
+     <%= stats[:visible] %>
+  </td>
+  <td>
+     <%= stats[:in_flight] %>
+  </td>
+  <td>
+    <%= queue[:source_url] || "N/A" %>
+  </td>
+</tr>

data/lib/sqs_web/application/views/working.erb

@@ -0,0 +1,13 @@
+<h1>Working</h1>
+<p class="sub">
+  The list below contains jobs currently being processed.
+</p>
+<p class="sub">
+  <%= "Showing #{start} to #{start + per_page} of #{@all_jobs.count} working jobs." %>
+</p>
+<ul class="job">
+  <% @jobs.each do |job| %>
+    <%= partial :job, {:job => job} %>
+  <% end %>
+</ul>
+<%= partial :next_more, :start => start, :total_size => @all_jobs.count, :per_page => per_page %>

data/lib/sqs_web/railtie.rb

@@ -0,0 +1,7 @@
+# Sinatra will automatically use Rails sessions if mounted within a Rails app.
+#
+# If you enable sessions in a Sinatra app, and then mount it in a Rails 4 app,
+# Rack::Session will blow up because ActionDispatch::Request::Session does not
+# implement #each.
+
+SqsWeb.disable :sessions

data/lib/sqs_web.rb

@@ -0,0 +1,9 @@
+require 'sqs_web/application/flash_message'
+require 'sqs_web/application/navigation'
+require 'sqs_web/application/controller_action'
+require 'sqs_web/application/app'
+require 'sqs_web/application/sqs_action'
+require 'sqs_web/application/poller_action'
+require 'sqs_web/application/exception_handle'
+require 'sqs_web/railtie' if defined?(Rails)
+SqsAction.initialize_aws

data/spec/integration/app_spec.rb

@@ -0,0 +1,369 @@
+require 'support/rails_app'
+require 'support/fake_sqs'
+
+Capybara.app = RailsApp
+
+RSpec.describe "Mounted in Rails Application", :sqs do
+
+  SOURCE_QUEUE_NAME = "TestSourceQueue"
+
+  DLQ_QUEUE_NAME = "TestSourceQueueDLQ"
+
+  let(:sqs) { Aws::SQS::Client.new(region: "us-east-1", credentials: Aws::Credentials.new("fake", "fake")) }
+
+  let(:source_queue_url) { sqs.get_queue_url(queue_name: SOURCE_QUEUE_NAME).queue_url }
+
+  let(:dlq_queue_url) { sqs.get_queue_url(queue_name: DLQ_QUEUE_NAME).queue_url }
+
+  before do
+    sqs.config.endpoint = $fake_sqs.uri
+    [SOURCE_QUEUE_NAME, DLQ_QUEUE_NAME].each{|queue_name| sqs.create_queue(queue_name: queue_name)}
+    dlq_arn = sqs.get_queue_attributes(queue_url: dlq_queue_url).attributes.fetch("QueueArn")
+    #Set DLQ
+    sqs.set_queue_attributes(
+      queue_url: source_queue_url, 
+      attributes: {
+        "RedrivePolicy" => "{\"deadLetterTargetArn\":\"#{dlq_arn}\",\"maxReceiveCount\":10}"
+      }
+    )
+    SqsWeb.options[:queues] = [SOURCE_QUEUE_NAME, DLQ_QUEUE_NAME]
+  end
+
+  # basic smoke test all the tabs
+  %w(overview dlq_console).each do |tab|
+    specify "test_#{tab}" do
+      visit "/sqs/#{tab}"
+      expect(page.status_code).to eq 200
+    end
+  end
+
+  describe "Overview page" do
+    it "will show Visible Messages" do
+      default_messages
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{SOURCE_QUEUE_NAME} 5 0 N/A")
+      match_content(page, "#{DLQ_QUEUE_NAME} 3 0 #{source_queue_url}")
+    end
+
+    specify "In Flight Messages" do
+      default_messages
+
+      receive_messages(source_queue_url, {count: 3})
+      receive_messages(dlq_queue_url, {count: 2})
+      
+      visit "/sqs/overview"
+
+      match_content(page, "#{SOURCE_QUEUE_NAME} 2 3 N/A")
+      match_content(page, "#{DLQ_QUEUE_NAME} 1 2 #{source_queue_url}")
+    end
+
+    specify "should be default page" do
+      visit "/sqs"
+
+      expect(current_path).to eq "/sqs/overview"
+    end
+
+    specify "handle non existent queues" do
+      SqsWeb.options[:queues] = ["BOGUSQUEUE"]
+
+      visit "/sqs/overview"
+
+      match_content(page, "Aws::SQS::Errors::NonExistentQueue: BOGUSQUEUE")
+    end
+  end
+
+  describe "DLQ Console", js: true do
+
+    it "should only show unique entries for each message" do
+      message_ids = generate_messages(dlq_queue_url, 5).map{|c| c.message_id}
+
+      visit "/sqs/dlq_console"
+
+      message_ids.each{|message_id| expect(page.all("#message_#{message_id}").count).to eq 1}
+    end
+
+    it "should delete single message" do
+      messages = generate_messages(dlq_queue_url, 2)
+      deleted_message_id = messages.pop.message_id
+      retained_message_id = messages.pop.message_id
+
+      visit "/sqs/dlq_console"
+
+      first("#message_#{deleted_message_id}").hover
+
+      within("#message_#{deleted_message_id}") do
+        click_on "Remove"
+      end
+
+      success_message = "Message ID: #{deleted_message_id} in Queue #{DLQ_QUEUE_NAME} was successfully removed."
+      expect(first("#alert").text).to eq success_message
+
+      expect(page.all("#message_#{deleted_message_id}").count).to eq 0
+      expect(page.all("#message_#{retained_message_id}").count).to eq 1
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{DLQ_QUEUE_NAME} 1 0 #{source_queue_url}")
+    end
+
+    it "should handle deleting single message that is already deleted" do
+      deleted_message_id = generate_messages(dlq_queue_url, 1).first.message_id
+      
+      visit "/sqs/dlq_console"
+
+      sqs.purge_queue({ queue_url: dlq_queue_url })
+
+      first("#message_#{deleted_message_id}").hover
+
+      within("#message_#{deleted_message_id}") do
+        click_on "Remove"
+      end
+      
+      error_message = "Message ID: #{deleted_message_id} in Queue #{DLQ_QUEUE_NAME} has already been deleted or is not visible."
+      expect(first("#alert").text).to eq error_message
+    end
+
+    it "should remove multiple selected messages" do
+      messages = generate_messages(dlq_queue_url, 6)
+      deleted_message_ids = messages.pop(4).map{|c| c.message_id}
+      retained_message_ids = messages.pop(2).map{|c| c.message_id}
+
+      visit "/sqs/dlq_console"
+
+      deleted_message_ids.each do |message_id|
+        first("#batch_action_item_#{message_id}").set(true)
+      end
+      
+      click_on "Bulk Remove"
+
+      expect(first("#alert").text).to eq "Selected messages have been removed successfully."
+
+      deleted_message_ids.each{|message_id| expect(page.all("#message_#{message_id}").count).to eq 0}
+      retained_message_ids.each{|message_id| expect(page.all("#message_#{message_id}").count).to eq 1}
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{DLQ_QUEUE_NAME} 2 0 #{source_queue_url}")
+    end
+
+    it "should handle removing multiple selected messages where one or more is already deleted or not visible" do
+      generate_messages(dlq_queue_url, 3)
+      
+      visit "/sqs/dlq_console"
+      
+      messages = receive_messages(dlq_queue_url, {count: 3}).messages
+      sqs.delete_message({queue_url: dlq_queue_url, receipt_handle: messages[2].receipt_handle})
+      sqs.change_message_visibility_batch({
+        queue_url: dlq_queue_url,
+        entries: messages.take(2).map do |message| 
+          {id: message.message_id, receipt_handle: message.receipt_handle, visibility_timeout: 0}
+        end
+      })
+      messages.each do |message|
+        first("#batch_action_item_#{message.message_id}").set(true)
+      end
+      
+      click_on "Bulk Remove"
+
+      expect(first("#alert").text).to eq "One or more messages may have already been removed or is not visible."
+
+      messages.each{|message| expect(page.all("#message_#{message.message_id}").count).to eq 0}
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{DLQ_QUEUE_NAME} 0 0 #{source_queue_url}")
+    end
+
+    it "should handle clicking on Bulk Remove without any selection" do
+      messages = generate_messages(dlq_queue_url, 3)
+      
+      visit "/sqs/dlq_console"
+
+      click_on "Bulk Remove"
+
+      expect(first("#alert").text).to eq ""
+
+      messages.each{|message| expect(page.all("#message_#{message.message_id}").count).to eq 1}
+    end
+
+    it "should render all information related to the visible messages" do
+      generate_messages(dlq_queue_url, 1)
+
+      visit "/sqs/dlq_console"
+
+      message = receive_messages(dlq_queue_url).messages.first
+      message.attributes["ApproximateReceiveCount"] = "1"
+
+      message_metadata = <<-EOF
+      ID #{message.message_id} or Receive Count 1 
+      Queue Name #{DLQ_QUEUE_NAME} Origin Queue #{source_queue_url}
+      Message Body Test_0
+      EOF
+
+      message_entry = first("#message_#{message.message_id}")
+      
+      within(message_entry) do 
+        click_on "Toggle full message"
+        first(".toggle_format").click
+      end
+      
+      match_content(message_entry, normalize_whitespace(message_metadata))
+      match_content(message_entry, normalize_whitespace(message.inspect.to_yaml.split('receipt_handle')[0]))
+      match_content(message_entry, normalize_whitespace(message.inspect.to_yaml.split('md5', 2)[1]))
+      match_content(message_entry, normalize_whitespace("Enqueued At #{Time.at(message.attributes["SentTimestamp"].to_i/1000).rfc822}"))
+    end
+
+    it "should not display any messages that are not in a DLQ" do
+      generate_messages(source_queue_url, 1)
+
+      visit "/sqs/dlq_console"
+
+      message = receive_messages(source_queue_url).messages.first
+
+      expect(first("#message_#{message.message_id}")).to be_nil
+
+      match_content(page, "Showing 0 visible messages")
+    end
+
+    it "should be able to move a single message to source queue" do
+      message_id = generate_messages(dlq_queue_url, 1).first.message_id
+      
+            
+      visit "/sqs/dlq_console"
+
+      first("#message_#{message_id}").hover
+
+      within("#message_#{message_id}") do
+        click_on "Move to Source Queue"
+      end
+
+      success_message = "Message ID: #{message_id} in Queue #{DLQ_QUEUE_NAME} was successfully moved to Source Queue #{source_queue_url}."
+      expect(first("#alert").text).to eq success_message
+      expect(page.all("#message_#{message_id}").count).to eq 0
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{SOURCE_QUEUE_NAME} 1 0 N/A")
+      match_content(page, "#{DLQ_QUEUE_NAME} 0 0 #{source_queue_url}")
+
+      moved_message = receive_messages(source_queue_url).messages.first
+      expect(moved_message).to_not be_nil
+      expect(moved_message.body).to eq "Test_0"
+      expect(moved_message.attributes["ApproximateReceiveCount"]).to eq "1"
+      expect(moved_message.message_attributes["foo_class"].to_hash).to eq({string_value: "FooWorker", data_type: "String"})
+    end
+
+    it "should move multiple selected messages" do
+      messages = generate_messages(dlq_queue_url, 6)
+      retained_message_ids = messages.pop(2).map{|c| c.message_id}
+      moved_message_ids = messages.pop(4).map{|c| c.message_id}
+
+      visit "/sqs/dlq_console"
+
+      moved_message_ids.each do |message_id|
+        first("#batch_action_item_#{message_id}").set(true)
+      end
+      
+      click_on "Bulk Move to Source Queue"
+
+      expect(first("#alert").text).to eq "Selected messages have been requeued successfully."
+
+      moved_message_ids.each{|message_id| expect(page.all("#message_#{message_id}").count).to eq 0}
+      retained_message_ids.each{|message_id| expect(page.all("#message_#{message_id}").count).to eq 1}
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{SOURCE_QUEUE_NAME} 4 0 N/A")
+      match_content(page, "#{DLQ_QUEUE_NAME} 2 0 #{source_queue_url}")
+
+      moved_messages = receive_messages(source_queue_url, {count: 4}).messages.sort_by{|c| c.body}
+      moved_messages.each_with_index do |moved_message, index|
+        expect(moved_message).to_not be_nil
+        expect(moved_message.body).to match "Test_#{index}"
+        expect(moved_message.attributes["ApproximateReceiveCount"]).to eq "1"
+        expect(moved_message.message_attributes["foo_class"].to_hash).to eq({string_value: "FooWorker", data_type: "String"})
+      end
+    end
+
+    it "should handle moving multiple selected messages where one or more is already deleted or not visible" do
+      generate_messages(dlq_queue_url, 3)
+      
+      visit "/sqs/dlq_console"
+      
+      messages = receive_messages(dlq_queue_url, {count: 3}).messages
+      sqs.delete_message({queue_url: dlq_queue_url, receipt_handle: messages[2].receipt_handle})
+      sqs.change_message_visibility_batch({
+        queue_url: dlq_queue_url,
+        entries: messages.take(2).map do |message| 
+          {id: message.message_id, receipt_handle: message.receipt_handle, visibility_timeout: 0}
+        end
+      })
+      messages.each do |message|
+        first("#batch_action_item_#{message.message_id}").set(true)
+      end
+      
+      click_on "Bulk Move to Source Queue"
+
+      expect(first("#alert").text).to eq "One or more messages may have already been requeued or is not visible."
+
+      messages.each{|message| expect(page.all("#message_#{message.message_id}").count).to eq 0}
+
+      visit "/sqs/overview"
+
+      match_content(page, "#{SOURCE_QUEUE_NAME} 2 0 N/A")
+      match_content(page, "#{DLQ_QUEUE_NAME} 0 0 #{source_queue_url}")
+    end
+
+    it "should handle clicking on Bulk Move to Source Queue without any selection" do
+      messages = generate_messages(dlq_queue_url, 3)
+      
+      visit "/sqs/dlq_console"
+
+      click_on "Bulk Move to Source Queue"
+
+      expect(first("#alert").text).to eq ""
+
+      messages.each{|message| expect(page.all("#message_#{message.message_id}").count).to eq 1}
+    end
+
+    it "should have a select/unselect all function" do
+      messages = generate_messages(dlq_queue_url, 3)
+      
+      visit "/sqs/dlq_console"
+
+      first("#select_all").click
+
+      page.all(".bulk_check").each{|node| expect(node["checked"]).to eq true}
+
+      first("#select_all").click
+
+      page.all(".bulk_check").each{|node| expect(node["checked"]).to eq false}
+    end
+  end
+
+  def receive_messages(queue_url, options = {count: 1})
+    sqs.receive_message({
+      queue_url: queue_url,
+      attribute_names: ["All"],
+      message_attribute_names: ["All"],
+      max_number_of_messages: options[:count],
+      wait_time_seconds: 1,
+      visibility_timeout: options[:visibility_timeout]
+    })
+  end
+
+  def default_messages
+    generate_messages(source_queue_url, 5) + generate_messages(dlq_queue_url, 3)
+  end
+
+  def generate_messages(queue_url, count=1)
+    messages = []
+    count.times do |time|
+      messages << sqs.send_message(queue_url: queue_url, message_body: "Test_#{time}", 
+        message_attributes: {"foo_class"=> {string_value: "FooWorker", data_type: "String"}})
+    end
+    messages
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "codeclimate-test-reporter"
+require "byebug"
+require 'capybara-webkit'
+require 'capybara/rspec'
+CodeClimate::TestReporter.start
+
+ENV['RACK_ENV'] = 'development'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.include Capybara::DSL
+end
+
+Capybara.javascript_driver = :webkit
+
+def match_content(actual, expected)
+  actual_text = actual.respond_to?(:text) ? normalize_whitespace(actual.text) : actual
+  expect(actual_text).to include(expected), <<-EOF
+  expected
+  "#{actual_text}"
+  to have content
+  "#{expected}"
+  EOF
+end
+
+def normalize_whitespace(content)
+  Capybara::Helpers.normalize_whitespace(content)
+end

data/spec/support/fake_sqs.rb

@@ -0,0 +1,19 @@
+require "fake_sqs/test_integration"
+
+db = ENV["SQS_DATABASE"] || ":memory:"
+puts "\n\e[34mRunning specs with database \e[33m#{db}\e[0m"
+$fake_sqs = FakeSQS::TestIntegration.new(
+  database: db,
+  sqs_endpoint: "localhost",
+  sqs_port: 4568,
+)
+
+SqsWeb.options[:aws][:access_key_id] = "fake"
+SqsWeb.options[:aws][:secret_access_key] = "fake"
+SqsWeb.options[:aws][:endpoint] = $fake_sqs.uri
+
+RSpec.configure do |config|
+  config.before(:each, :sqs) { $fake_sqs.start }
+  config.before(:each, :sqs) { $fake_sqs.reset }
+  config.after(:suite) { $fake_sqs.stop }
+end

data/spec/support/rails_app.rb

@@ -0,0 +1,12 @@
+require "action_controller/railtie"
+require "logger"
+require "sqs_web"
+
+class RailsApp < Rails::Application
+  config.logger = Rails.logger = Logger.new($stdout)
+  config.secret_token = "a3d6cee7966878577a764ed273359d9e"
+
+  routes.draw do
+    match "/sqs" => SqsWeb, :anchor => false, via: [:get, :post]
+  end
+end

data/sqs_web.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |gem|
+  gem.name        = "sqs_web"
+  gem.version     = "0.0.1"
+  gem.author      = "Nathaniel Ritholtz"
+  gem.email       = "nritholtz@gmail.com"
+  gem.homepage    = "https://github.com/nritholtz/sqs_web"
+  gem.summary     = "Web interface for SQS inspired by delayed_job_web"
+  gem.description = gem.summary
+  gem.license     = "MIT"
+
+  gem.executables = ["sqs_web"]
+
+  gem.files = [
+    "Gemfile",
+    "README.markdown",
+    "Rakefile",
+    "sqs_web.gemspec"
+  ] + %x{ git ls-files }.split("\n").select { |d| d =~ %r{^(lib|spec|bin)} }
+
+  gem.extra_rdoc_files = [
+    "README.markdown"
+  ]
+
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_runtime_dependency "sinatra",      [">= 1.4.4"]
+  gem.add_dependency 'aws-sdk', '~> 2.1.33'
+
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rails",     ["~> 3.0"]
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "codeclimate-test-reporter"
+  gem.add_development_dependency "byebug"
+  gem.add_development_dependency "capybara-webkit"
+  #gem.add_development_dependency "fake_sqs",  ["~> 0.3.1"]
+end