Add sidekiq

.env.example

@@ -26,3 +26,6 @@ GOOGLE_OAUTH_CLIENT_SECRET='google-oauth-client-secret'
 
 # Application Monitoring
 NEW_RELIC_LICENSE_KEY='replace with newrelic licence key'
+
+# Redis url
+REDIS_URL='redis://127.0.0.1:6379/12'

Gemfile

@@ -122,6 +122,9 @@ group :development, :test do
 
   # help to kill N+1 queries and unused eager loading. https://github.com/flyerhzm/bullet
   gem "bullet"
+
+  # Background job processing adapter
+  gem "sidekiq"
 end
 
 group :development do

Gemfile.lock

@@ -414,6 +414,10 @@ GEM
       activesupport (>= 3)
     shoulda-matchers (5.1.0)
       activesupport (>= 5.2.0)
+    sidekiq (6.4.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
     simple_po_parser (1.1.5)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -516,6 +520,7 @@ DEPENDENCIES
   selenium-webdriver (>= 4.0.0)
   shoulda-callback-matchers (~> 1.1.1)
   shoulda-matchers (~> 5.1)
+  sidekiq
   simplecov
   spring
   stripe

Procfile

@@ -0,0 +1,2 @@
+web: bundle exec puma -t 5:5 -p ${PORT:-3000} -e ${RACK_ENV:-production}
+worker: bundle exec sidekiq -e production -C config/sidekiq.yml

Procfile.dev

@@ -1,2 +1,3 @@
 web: bin/rails s -b 0.0.0.0 -p 3000
 webpacker: bin/webpack-dev-server
+sidekiq: bundle exec sidekiq -e development -C config/sidekiq.yml

README.md

@@ -37,41 +37,45 @@ nvm install $(cat .nvmrc)
 ```
 brew install postgresql
 ```
+6. Install Redis
+```
+brew install redis
+```
 
-6. Install gem
+7. Install gem
 
 ```
 bundle install
 ```
 
-7. Install node packages
+8. Install node packages
 
 ```
 yarn install
 ```
 
-8. Setup ENV's
+9. Setup ENV's
 
 ```
 cp .env.example .env
 ```
 
-9. Update `DATABASE_URL` in `.env` as per local `psql` creds. For example, if
+10. Update `DATABASE_URL` in `.env` as per local `psql` creds. For example, if
    the user is `root` and password is `password`, change the variable as
    `DATABASE_URL="postgres://root:password@localhost/miru_web?encoding=utf8&pool=5&timeout=5000"`
 
-10. Update `APP_BASE_URL` in `.env` to `localhost:3000`
-11. Run `bin/rails db:create RAILS_ENV=development` to create the database
-12. Run `bin/rails db:migrate RAILS_ENV=development` for migrations
-13. Run `bin/rails db:seed` for populating the database with initial data
+11. Update `APP_BASE_URL` in `.env` to `localhost:3000`
+12. Run `bin/rails db:create RAILS_ENV=development` to create the database
+13. Run `bin/rails db:migrate RAILS_ENV=development` for migrations
+14. Run `bin/rails db:seed` for populating the database with initial data
 
-14. Run app in local env
+15. Run app in local env
 
 ```
 foreman start -f Procfile.dev
 ```
 
-15. Navigate to [http://0.0.0.0:3000](http://0.0.0.0:3000)
+16. Navigate to [http://0.0.0.0:3000](http://0.0.0.0:3000)
 
 ### To receive the emails in non-production apps.
 

config/environments/development.rb

@@ -78,6 +78,8 @@
   config.action_mailer.delivery_method = ENV.fetch("MAILER_DELIVERY_METHOD", "letter_opener").to_sym
   config.action_mailer.perform_deliveries = true
 
+  config.active_job.queue_adapter = :sidekiq
+
   Rails.application.config.after_initialize do
     Bullet.enable = true
     Bullet.bullet_logger = true

config/environments/production.rb

@@ -125,4 +125,5 @@
   host = ENV.fetch("APP_BASE_URL", "#{ENV["HEROKU_APP_NAME"] + ".herokuapp.com"}")
   config.action_mailer.default_url_options = { host: host }
   config.action_mailer.asset_host = host
+  config.active_job.queue_adapter = :sidekiq
 end

config/initializers/sidekiq.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: ENV["REDIS_URL"], size: 4, network_timeout: 5 }
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = { url: ENV["REDIS_URL"], size: 4, network_timeout: 5 }
+end

config/routes.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "sidekiq/web"
+
 class ActionDispatch::Routing::Mapper
   def draw(routes_name)
     instance_eval(File.read(Rails.root.join("config/routes/#{routes_name}.rb")))
@@ -50,4 +52,6 @@ def draw(routes_name)
     get "profile", to: "users/registrations#edit"
     delete "profile/purge_avatar", to: "users/registrations#purge_avatar"
   end
+
+  mount Sidekiq::Web => "/sidekiq"
 end

config/sidekiq.yml

@@ -0,0 +1,11 @@
+development:
+  :concurrency: 1
+production:
+  :concurrency: 1
+:queues:
+  - default
+  - mailers
+  - action_mailbox_routing
+  - action_mailbox_incineration
+  - active_storage_analysis
+  - active_storage_purge

spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require "simplecov"
 require "pundit/rspec"
+require "sidekiq/testing"
 
 if ENV.fetch("COVERAGE", false)
   SimpleCov.start "rails" do