torquebox-sidekiq-service 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'sidekiq'
+
+group :test do
+  gem 'minitest'
+  gem 'rake'
+  gem 'minitest-reporters'
+end
+
+group :development do
+  gem 'jeweler'
+end

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,92 @@
+TorqueBox Sidekiq Service
+=========================
+
+This library provides a TorqueBox service for running Sidekiq inside the TorqueBox application server.  It replaces the
+Sidekiq CLI client typically used to start up TorqueBox.
+
+Rationale
+---------
+
+The TorqueBox application server has a lot of features that are only accessible by running within the container.  E.g.,
+if your application uses the TorqueBox cache provider you cannot access that cache from an external process, like a
+traditional Sidekiq setup.  This can be confusing as something as benign as `Rails.cache` can have different values in
+the same environment depending on how the code was invoked.
+
+There are several other reasons why a TorqueBox service may make sense for you:
+
+* Reduced memory consumption, as you'll only be using one JVM
+* High availability, as TorqueBox can move a singleton service to any other node in a cluster
+* Simpler process management, as Sidekiq will start as part of your normal application deploy
+** No need for monit or similar tools in production
+** No need for foreman or similar tools in development
+* Easier to debug & profile by way of TorqueBox's debugging and profiling capabilities
+* Better opportunity for JVM JIT optimization
+
+Of course, for every item that I think is a pro, someone else may think is a con.  Depending on perspective, some flaws
+with this approach are:
+
+* Not maintained by Sidekiq
+* If the TorqueBox process dies Sidekiq goes with it
+* Harder to measure just Sidekiq's memory footprint
+* May no longer be able to deploy front-end independently of back-end (not strictly true since you can deploy multiple apps)
+
+
+Usage
+-----
+
+If you want to run multiple Sidekiq processors in the same app, you'll need to use a bounded pool for the services runtime.
+
+E.g., if you want to run two processors, with no other services, your torquebox.yml will need to have something like:
+
+<pre>
+pooling:
+  services:
+    type: bounded
+    min: 2
+    max: 2
+</pre>
+
+Then your service configuration would look like:
+
+<pre>
+services:
+  background-default:
+    service: TorqueBox::SidekiqService
+    config:
+      queues: ['default']
+      index: 0
+      concurrency: 50
+
+  background-deletes:
+    service: TorqueBox::SidekiqService
+    config:
+      queues: ['deletes']
+      index: 1
+      concurrency: 50
+</pre>
+
+By default, services are [singletons](http://torquebox.org/documentation/2.3.0/services.html#ha-singleton-services) in
+TorqueBox, meaning they will run on only one node in the cluster.  If that node ever goes down, the service will be
+started on another available node.  Alternatively, you can run a Sidekiq processor on all nodes by disabling the
+singleton setting, like so:
+
+<pre>
+services:
+  background-default:
+    service: TorqueBox::SidekiqService
+    singleton: false
+    config:
+      queues: ['default']
+      index: 0
+      concurrency: 50
+</pre>
+
+
+Notes
+-----
+
+The torquebox-sidekiq-service must be loaded before you configure any Sidekiq server middleware.  If it isn't loaded,
+Sidekiq assumes your runtime environment is only as a client and will then ignore any server middleware configuration.
+It'll then go on to use its default server middleware, which can lead to some confusing results.  If you're on Rails,
+everything in your Gemfile will be loaded by default so you won't have anything else to do.  Otherwise, make sure you
+require the library.

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "torquebox-sidekiq-service"
+  gem.homepage = "http://github.com/mogotest/torquebox-sidekiq-service"
+  gem.license = "ASLv2"
+  gem.summary = 'A TorqueBox service for running Sidekiq in the TorqueBox application server.'
+  gem.description = <<-DESC
+    The TorqueBox Sidekiq service replaces the traditional Sidekiq CLI client for starting a Sidekiq processor.  This
+    allows TorqueBox features only available in-container to be usable by all your Sidekiq workers.  It has the added
+    benefit of reducing memory overhead by running in a single JVM and allows for better optimization through JIT and
+    better debugging & profiling through TorqueBox's runtime inspection facilities.
+  DESC
+  gem.email = "nirvdrum@gmail.com"
+  gem.authors = ["Kevin Menard"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/torque_box/sidekiq_service.rb

@@ -0,0 +1,44 @@
+module TorqueBox
+  class SidekiqService
+    attr_accessor :config, :launcher
+
+    CONFIG_OPTIONS_TO_STRIP = [:config_file, :daemon, :environment, :pidfile, :require, :tag]
+
+    def initialize(opts = {})
+      @config = opts.symbolize_keys.reject { |k, _| CONFIG_OPTIONS_TO_STRIP.include?(k) }
+    end
+
+    def start
+      Thread.new { run }
+    end
+
+    def stop
+      launcher.stop
+    end
+
+    def run
+      Sidekiq.options.merge!(config)
+      Sidekiq.options[:queues] << 'default' if Sidekiq.options[:queues].empty?
+
+      if Sidekiq.options.has_key?(:logfile)
+        Sidekiq::Logging.initialize_logger(Sidekiq.options[:logfile])
+      else
+        Sidekiq::Logging.logger = TorqueBox::Logger.new('sidekiq') if ENV.has_key?('TORQUEBOX_CONTEXT')
+      end
+
+      require 'celluloid'
+
+      if Sidekiq.options.has_key?(:verbose)
+        Sidekiq.logger.level = Logger::DEBUG
+        Celluloid.logger = Sidekiq.logger
+      end
+
+      require 'sidekiq/manager'
+      require 'sidekiq/scheduled'
+      require 'sidekiq/launcher'
+      @launcher = Sidekiq::Launcher.new(Sidekiq.options)
+
+      launcher.run
+    end
+  end
+end

data/lib/torquebox-sidekiq-service.rb

@@ -0,0 +1,10 @@
+# This is needed to make Sidekiq think it's working in a server capacity.
+module Sidekiq
+  class CLI
+  end
+end
+
+# Sidekiq requires its processor to be available if configuring server middleware.
+require 'sidekiq/processor'
+
+require 'torque_box/sidekiq_service'

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+require 'torquebox-sidekiq-service'
+
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+MiniTest::Reporters.use!

data/test/sidekiq_service_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class SidekiqServiceTest < MiniTest::Unit::TestCase
+  describe 'configuration' do
+    it 'should remove the daemon config option' do
+      service = TorqueBox::SidekiqService.new(daemon: true)
+      assert !service.config.has_key?(:daemon)
+    end
+
+    it 'should remove the environment config option' do
+      service = TorqueBox::SidekiqService.new(environment: 'production')
+      assert !service.config.has_key?(:environment)
+    end
+
+    it 'should remove the tag config option' do
+      service = TorqueBox::SidekiqService.new(tag: 'my-tag')
+      assert !service.config.has_key?(:tag)
+    end
+
+    it 'should remove the require config option' do
+      service = TorqueBox::SidekiqService.new(require: './lib')
+      assert !service.config.has_key?(:require)
+    end
+
+    it 'should remove the config_file config option' do
+      service = TorqueBox::SidekiqService.new(config_file: './config/sidekiq.yml')
+      assert !service.config.has_key?(:config_file)
+    end
+
+    it 'should remove the pidfile config option' do
+      service = TorqueBox::SidekiqService.new(pidfile: './tmp/sidekiq.pid')
+      assert !service.config.has_key?(:pidfile)
+    end
+  end
+end

data/torquebox-sidekiq-service.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "torquebox-sidekiq-service"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Menard"]
+  s.date = "2013-03-14"
+  s.description = "    The TorqueBox Sidekiq service replaces the traditional Sidekiq CLI client for starting a Sidekiq processor.  This\n    allows TorqueBox features only available in-container to be usable by all your Sidekiq workers.  It has the added\n    benefit of reducing memory overhead by running in a single JVM and allows for better optimization through JIT and\n    better debugging & profiling through TorqueBox's runtime inspection facilities.\n"
+  s.email = "nirvdrum@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/torque_box/sidekiq_service.rb",
+    "lib/torquebox-sidekiq-service.rb",
+    "test/helper.rb",
+    "test/sidekiq_service_test.rb",
+    "torquebox-sidekiq-service.gemspec"
+  ]
+  s.homepage = "http://github.com/mogotest/torquebox-sidekiq-service"
+  s.licenses = ["ASLv2"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A TorqueBox service for running Sidekiq in the TorqueBox application server."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<torquebox-sidekiq-service>, [">= 0"])
+      s.add_runtime_dependency(%q<sidekiq>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<torquebox-sidekiq-service>, [">= 0"])
+      s.add_dependency(%q<sidekiq>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<torquebox-sidekiq-service>, [">= 0"])
+    s.add_dependency(%q<sidekiq>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: torquebox-sidekiq-service
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Menard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: torquebox-sidekiq-service
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: |2
+      The TorqueBox Sidekiq service replaces the traditional Sidekiq CLI client for starting a Sidekiq processor.  This
+      allows TorqueBox features only available in-container to be usable by all your Sidekiq workers.  It has the added
+      benefit of reducing memory overhead by running in a single JVM and allows for better optimization through JIT and
+      better debugging & profiling through TorqueBox's runtime inspection facilities.
+email: nirvdrum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/torque_box/sidekiq_service.rb
+- lib/torquebox-sidekiq-service.rb
+- test/helper.rb
+- test/sidekiq_service_test.rb
+- torquebox-sidekiq-service.gemspec
+homepage: http://github.com/mogotest/torquebox-sidekiq-service
+licenses:
+- ASLv2
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+      segments:
+      - 0
+      hash: 2
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A TorqueBox service for running Sidekiq in the TorqueBox application server.
+test_files: []