diff --git a/Gemfile b/Gemfile index 86ebc229..90f29163 100644 --- a/Gemfile +++ b/Gemfile @@ -48,3 +48,5 @@ gem "ostruct" gem "csv" gem "minitest", "~> 5.0" + +gem "solid_queue" diff --git a/Gemfile.lock b/Gemfile.lock index c975de51..33ce6476 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - rails_performance (1.6.0) + rails_performance (1.7.0.beta1) browser railties redis @@ -132,7 +132,13 @@ GEM zeitwerk (~> 2.6) erb (5.1.1) erubi (1.13.1) + et-orbi (1.4.0) + tzinfo ffi (1.17.2) + ffi (1.17.2-arm64-darwin) + fugit (1.11.2) + et-orbi (~> 1, >= 1.2.11) + raabro (~> 1.4) get_process_mem (1.0.0) bigdecimal (>= 2.0) ffi (~> 1.0) @@ -168,7 +174,6 @@ GEM nokogiri (~> 1) rake mini_mime (1.1.5) - mini_portile2 (2.8.9) minitest (5.26.0) mustermann (3.0.4) ruby2_keywords (~> 0.0.1) @@ -184,8 +189,7 @@ GEM net-smtp (0.5.1) net-protocol nio4r (2.7.4) - nokogiri (1.18.10) - mini_portile2 (~> 2.8.2) + nokogiri (1.18.10-arm64-darwin) racc (~> 1.4) orm_adapter (0.5.0) ostruct (0.6.3) @@ -202,6 +206,7 @@ GEM stringio puma (7.0.4) nio4r (~> 2.0) + raabro (1.4.0) racc (1.8.1) rack (3.2.3) rack-session (2.1.1) @@ -289,6 +294,13 @@ GEM simplecov_json_formatter (~> 0.1) simplecov-html (0.13.2) simplecov_json_formatter (0.1.4) + solid_queue (1.2.1) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11.0) + railties (>= 7.1) + thor (>= 1.3.1) sprockets (4.2.2) concurrent-ruby (~> 1.0) logger @@ -297,8 +309,7 @@ GEM actionpack (>= 6.1) activesupport (>= 6.1) sprockets (>= 3.0.0) - sqlite3 (2.7.4) - mini_portile2 (~> 2.8.0) + sqlite3 (2.7.4-arm64-darwin) standard (1.51.1) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.0) @@ -339,7 +350,7 @@ GEM zeitwerk (2.7.3) PLATFORMS - ruby + arm64-darwin-24 DEPENDENCIES actionmailer @@ -360,6 +371,7 @@ DEPENDENCIES rails_performance! sidekiq simplecov + solid_queue sprockets-rails sqlite3 standard diff --git a/README.md b/README.md index 2b0ee1cb..acfab06a 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ It allows you to track: - simple 500-crashes reports - deployment events (or custom events) - Sidekiq jobs +- SolidQueue jobs +- ActiveJob jobs - Delayed Job jobs - Grape API inside Rails app - Rake tasks performance @@ -310,8 +312,12 @@ Just clone the repo, setup dummy app (`rails db:migrate`). After this: -- rails s -- rake test +- `rails s` +- `cd test/dummy` and `bundle exec rails db:migrate:queue` +- `cd test/dummy` and `bundle exec bin/jobs` (if you want to test ActiveJob) +- `rake test` + +If you need to start with solid queue `SOLID_QUEUE_IN_PUMA=true rails s`. If you need quickly clear Redis data, you can use `rails runner 'RailsPerformance.redis.flushdb'`. @@ -360,6 +366,14 @@ The idea of this gem grew from curiosity how many RPM my app receiving per day. 4. Run `rails s` in the root folder 5. Run `rails test` to run tests +## Running with different versions of Rails + +```bash +BUNDLE_GEMFILE=gemfiles/rails_7.2.gemfile bundle +BUNDLE_GEMFILE=gemfiles/rails_8.0.gemfile bundle +BUNDLE_GEMFILE=gemfiles/rails_8.1.gemfile bundle +``` + ## Contributing You are welcome to contribute. I've a big list of TODO. diff --git a/app/controllers/rails_performance/rails_performance_controller.rb b/app/controllers/rails_performance/rails_performance_controller.rb index 82948eeb..815dd019 100644 --- a/app/controllers/rails_performance/rails_performance_controller.rb +++ b/app/controllers/rails_performance/rails_performance_controller.rb @@ -75,6 +75,14 @@ def requests end end + def jobs + @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :jobs) + db = @datasource.db + @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data + @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data + @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data + end + def recent @datasource = RailsPerformance::DataSource.new(**prepare_query(params), type: :requests) db = @datasource.db diff --git a/app/helpers/rails_performance/rails_performance_helper.rb b/app/helpers/rails_performance/rails_performance_helper.rb index f9d8353d..acfeac55 100644 --- a/app/helpers/rails_performance/rails_performance_helper.rb +++ b/app/helpers/rails_performance/rails_performance_helper.rb @@ -71,7 +71,7 @@ def report_name(h) def status_tag(status) klass = case status.to_s - when /error/ + when /error/, /exception/ "tag is-danger" when /^5/ "tag is-danger" @@ -140,6 +140,8 @@ def active?(section) "is-active" if controller_name == "rails_performance" && action_name == "rake" when :custom "is-active" if controller_name == "rails_performance" && action_name == "custom" + when :jobs + "is-active" if controller_name == "rails_performance" && action_name == "jobs" end end end diff --git a/app/views/rails_performance/rails_performance/jobs.html.erb b/app/views/rails_performance/rails_performance/jobs.html.erb new file mode 100644 index 00000000..8b7a538f --- /dev/null +++ b/app/views/rails_performance/rails_performance/jobs.html.erb @@ -0,0 +1,69 @@ +ActiveJob + +<% unless @datasource.default? %> + <%#= link_to raw("← Back"), rails_performance_path, class: "back_link" %> +<% end %> + +
+
+

ActiveJob Workers Throughput Report

+ + <%= raw @throughput_report_data.to_json %> + +

All active jobs in the application

+
+
+ +
+ +
+
+

Average Execution Time

+ + <%= raw @response_time_report_data.to_json %> + +

All workers in the application

+
+
+ +
+ +
+
+

Recent Jobs (last <%= RailsPerformance.recent_requests_time_window / 60 %> minutes)

+ + + + + + + + + + + + + + <% if @recent_report_data.empty? %> + + + + <% end %> + <% @recent_report_data.each do |e| %> + + + + + + + + + <% end %> + +
DatetimeJob IDQueueWorkerStatusDuration
Nothing to show here. Try to make a few requests in the main app.
<%= format_datetime e[:datetime] %><%= e[:jid] %><%= e[:queue] %><%= e[:worker] %> + <%= status_tag e[:status] %> + + <%= ms e[:duration], 1 %> +
+

+
diff --git a/app/views/rails_performance/shared/_header.html.erb b/app/views/rails_performance/shared/_header.html.erb index 322b1806..a5f7e272 100644 --- a/app/views/rails_performance/shared/_header.html.erb +++ b/app/views/rails_performance/shared/_header.html.erb @@ -22,6 +22,9 @@ <% end %> <%= link_to 'Slow Requests', rails_performance.rails_performance_slow_url, class: "navbar-item #{active?(:slow)}" %> <%= link_to '500 Errors', rails_performance.rails_performance_crashes_url, class: "navbar-item #{active?(:crashes)}" %> + <% if defined?(::ActiveJob) %> + <%= link_to 'ActiveJob', rails_performance.rails_performance_jobs_url, class: "navbar-item #{active?(:jobs)}" %> + <% end %> <% if defined?(Sidekiq) %> <%= link_to 'Sidekiq', rails_performance.rails_performance_sidekiq_url, class: "navbar-item #{active?(:sidekiq)}" %> <% end %> diff --git a/config/routes.rb b/config/routes.rb index f0d10021..d5b57cb5 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -15,6 +15,7 @@ get "/rake" => "rails_performance#rake", :as => :rails_performance_rake get "/custom" => "rails_performance#custom", :as => :rails_performance_custom get "/resources" => "rails_performance#resources", :as => :rails_performance_resources + get "/jobs" => "rails_performance#jobs", :as => :rails_performance_jobs end Rails.application.routes.draw do diff --git a/gemfiles/rails_7.2.gemfile b/gemfiles/rails_7.2.gemfile index 7107fa89..73af61b2 100644 --- a/gemfiles/rails_7.2.gemfile +++ b/gemfiles/rails_7.2.gemfile @@ -7,6 +7,7 @@ gem "debug" gem "sqlite3" gem "simplecov", require: false, group: :test gem "sidekiq" +gem "solid_queue" gem "grape" gem "mimemagic", "0.4.3" gem "delayed_job_active_record" diff --git a/gemfiles/rails_7.2.gemfile.lock b/gemfiles/rails_7.2.gemfile.lock index a2968413..b5a25e91 100644 --- a/gemfiles/rails_7.2.gemfile.lock +++ b/gemfiles/rails_7.2.gemfile.lock @@ -1,7 +1,7 @@ PATH remote: .. specs: - rails_performance (1.6.0) + rails_performance (1.7.0.beta1) browser railties redis @@ -139,6 +139,8 @@ GEM zeitwerk (~> 2.6) erb (6.0.1) erubi (1.13.1) + et-orbi (1.4.0) + tzinfo ffi (1.17.3-aarch64-linux-gnu) ffi (1.17.3-aarch64-linux-musl) ffi (1.17.3-arm-linux-gnu) @@ -147,6 +149,9 @@ GEM ffi (1.17.3-x86_64-darwin) ffi (1.17.3-x86_64-linux-gnu) ffi (1.17.3-x86_64-linux-musl) + fugit (1.12.1) + et-orbi (~> 1.4) + raabro (~> 1.4) get_process_mem (1.0.0) bigdecimal (>= 2.0) ffi (~> 1.0) @@ -230,6 +235,7 @@ GEM stringio puma (7.1.0) nio4r (~> 2.0) + raabro (1.4.0) racc (1.8.1) rack (3.2.4) rack-session (2.1.1) @@ -319,6 +325,13 @@ GEM simplecov_json_formatter (~> 0.1) simplecov-html (0.13.2) simplecov_json_formatter (0.1.4) + solid_queue (1.3.0) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11) + railties (>= 7.1) + thor (>= 1.3.1) sprockets (4.2.2) concurrent-ruby (~> 1.0) logger @@ -402,6 +415,7 @@ DEPENDENCIES rails_performance! sidekiq simplecov + solid_queue sprockets-rails sqlite3 standard diff --git a/gemfiles/rails_8.0.gemfile b/gemfiles/rails_8.0.gemfile index 76798868..34a33cd1 100644 --- a/gemfiles/rails_8.0.gemfile +++ b/gemfiles/rails_8.0.gemfile @@ -7,6 +7,7 @@ gem "debug" gem "sqlite3" gem "simplecov", require: false, group: :test gem "sidekiq" +gem "solid_queue" gem "grape" gem "mimemagic", "0.4.3" gem "delayed_job_active_record" diff --git a/gemfiles/rails_8.0.gemfile.lock b/gemfiles/rails_8.0.gemfile.lock index bc920da2..485abf7b 100644 --- a/gemfiles/rails_8.0.gemfile.lock +++ b/gemfiles/rails_8.0.gemfile.lock @@ -1,7 +1,7 @@ PATH remote: .. specs: - rails_performance (1.6.0) + rails_performance (1.7.0.beta1) browser railties redis @@ -136,6 +136,8 @@ GEM zeitwerk (~> 2.6) erb (6.0.1) erubi (1.13.1) + et-orbi (1.4.0) + tzinfo ffi (1.17.3-aarch64-linux-gnu) ffi (1.17.3-aarch64-linux-musl) ffi (1.17.3-arm-linux-gnu) @@ -144,6 +146,9 @@ GEM ffi (1.17.3-x86_64-darwin) ffi (1.17.3-x86_64-linux-gnu) ffi (1.17.3-x86_64-linux-musl) + fugit (1.12.1) + et-orbi (~> 1.4) + raabro (~> 1.4) get_process_mem (1.0.0) bigdecimal (>= 2.0) ffi (~> 1.0) @@ -227,6 +232,7 @@ GEM stringio puma (7.1.0) nio4r (~> 2.0) + raabro (1.4.0) racc (1.8.1) rack (3.2.4) rack-session (2.1.1) @@ -315,6 +321,13 @@ GEM simplecov_json_formatter (~> 0.1) simplecov-html (0.13.2) simplecov_json_formatter (0.1.4) + solid_queue (1.3.0) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11) + railties (>= 7.1) + thor (>= 1.3.1) sprockets (4.2.2) concurrent-ruby (~> 1.0) logger @@ -399,6 +412,7 @@ DEPENDENCIES rails_performance! sidekiq simplecov + solid_queue sprockets-rails sqlite3 standard diff --git a/gemfiles/rails_8.1.gemfile b/gemfiles/rails_8.1.gemfile index d723c4be..bd423bf8 100644 --- a/gemfiles/rails_8.1.gemfile +++ b/gemfiles/rails_8.1.gemfile @@ -7,6 +7,7 @@ gem "debug" gem "sqlite3" gem "simplecov", require: false, group: :test gem "sidekiq" +gem "solid_queue" gem "grape" gem "mimemagic", "0.4.3" gem "delayed_job_active_record" diff --git a/gemfiles/rails_8.1.gemfile.lock b/gemfiles/rails_8.1.gemfile.lock index c8955206..24b0761a 100644 --- a/gemfiles/rails_8.1.gemfile.lock +++ b/gemfiles/rails_8.1.gemfile.lock @@ -1,7 +1,7 @@ PATH remote: .. specs: - rails_performance (1.6.0) + rails_performance (1.7.0.beta1) browser railties redis @@ -139,6 +139,8 @@ GEM zeitwerk (~> 2.6) erb (6.0.1) erubi (1.13.1) + et-orbi (1.4.0) + tzinfo ffi (1.17.3-aarch64-linux-gnu) ffi (1.17.3-aarch64-linux-musl) ffi (1.17.3-arm-linux-gnu) @@ -147,6 +149,9 @@ GEM ffi (1.17.3-x86_64-darwin) ffi (1.17.3-x86_64-linux-gnu) ffi (1.17.3-x86_64-linux-musl) + fugit (1.12.1) + et-orbi (~> 1.4) + raabro (~> 1.4) get_process_mem (1.0.0) bigdecimal (>= 2.0) ffi (~> 1.0) @@ -230,6 +235,7 @@ GEM stringio puma (7.1.0) nio4r (~> 2.0) + raabro (1.4.0) racc (1.8.1) rack (3.2.4) rack-session (2.1.1) @@ -318,6 +324,13 @@ GEM simplecov_json_formatter (~> 0.1) simplecov-html (0.13.2) simplecov_json_formatter (0.1.4) + solid_queue (1.3.0) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11) + railties (>= 7.1) + thor (>= 1.3.1) sprockets (4.2.2) concurrent-ruby (~> 1.0) logger @@ -402,6 +415,7 @@ DEPENDENCIES rails_performance! sidekiq simplecov + solid_queue sprockets-rails sqlite3 standard diff --git a/lib/rails_performance.rb b/lib/rails_performance.rb index 78f01821..0531d782 100644 --- a/lib/rails_performance.rb +++ b/lib/rails_performance.rb @@ -13,6 +13,7 @@ require_relative "rails_performance/models/rake_record" require_relative "rails_performance/models/resource_record" require_relative "rails_performance/models/custom_record" +require_relative "rails_performance/models/active_job_record" require_relative "rails_performance/data_source" require_relative "rails_performance/utils" require_relative "rails_performance/reports/base_report" @@ -178,9 +179,9 @@ def self.log(message) return unless RailsPerformance.debug if ::Rails.logger - # puts(message) + puts(message) if ENV["DEV_LOGS"] == "true" ::Rails.logger.debug(message) - else + elsif ENV["DEV_LOGS"] == "true" puts(message) end end diff --git a/lib/rails_performance/data_source.rb b/lib/rails_performance/data_source.rb index 97855de8..6e391350 100644 --- a/lib/rails_performance/data_source.rb +++ b/lib/rails_performance/data_source.rb @@ -7,7 +7,8 @@ class DataSource grape: RailsPerformance::Models::GrapeRecord, rake: RailsPerformance::Models::RakeRecord, custom: RailsPerformance::Models::CustomRecord, - resources: RailsPerformance::Models::ResourceRecord + resources: RailsPerformance::Models::ResourceRecord, + jobs: RailsPerformance::Models::ActiveJobRecord } attr_reader :q, :klass, :type, :days @@ -68,6 +69,8 @@ def query "rake|*#{compile_rake_query}*|END|#{RailsPerformance::SCHEMA}" when :custom "custom|*#{compile_custom_query}*|END|#{RailsPerformance::SCHEMA}" + when :jobs + "active_job|*#{compile_active_job_query}*|END|#{RailsPerformance::SCHEMA}" else raise "wrong type: \"#{type}\" for datasource query builder" end @@ -94,6 +97,15 @@ def compile_sidekiq_query str.join("*") end + def compile_active_job_query + str = [] + str << "queue|#{q[:queue]}|" if q[:queue].present? + str << "worker|#{q[:worker]}|" if q[:worker].present? + str << "datetime|#{q[:on].strftime("%Y%m%d")}*|" if q[:on].present? + str << "status|#{q[:status]}|" if q[:status].present? + str.join("*") + end + def compile_resource_query str = [] str << "server|#{q[:server]}|" if q[:server].present? diff --git a/lib/rails_performance/engine.rb b/lib/rails_performance/engine.rb index 75f6f04f..3189b851 100644 --- a/lib/rails_performance/engine.rb +++ b/lib/rails_performance/engine.rb @@ -57,6 +57,11 @@ class Engine < ::Rails::Engine end end + if defined?(::ActiveJob) + require_relative "gems/active_job_ext" + RailsPerformance::Gems::ActiveJobExt.init + end + if defined?(::Grape) require_relative "gems/grape_ext" RailsPerformance::Gems::GrapeExt.init diff --git a/lib/rails_performance/gems/active_job_ext.rb b/lib/rails_performance/gems/active_job_ext.rb new file mode 100644 index 00000000..74af814f --- /dev/null +++ b/lib/rails_performance/gems/active_job_ext.rb @@ -0,0 +1,42 @@ +module RailsPerformance + module Gems + class ActiveJobExt + module AroundPerform + extend ActiveSupport::Concern + + included do + around_perform do |job, block| + now = RailsPerformance::Utils.time + exception = nil + record = RailsPerformance::Models::ActiveJobRecord.new( + worker: job.class.name, + queue: job.queue_name, + enqueued_ati: job.enqueued_at.to_i, + datetimei: job.scheduled_at.to_i, + jid: job.job_id, + start_timei: now.to_i, + datetime: now.strftime(RailsPerformance::FORMAT) + ) + result = block.call + record.status = "success" + result + rescue Exception => ex # rubocop:disable Lint/RescueException + record.status = "exception" + record.message = ex.message + exception = ex + ensure + # store in ms instead of seconds + record.duration = (RailsPerformance::Utils.time - now) * 1000 + record.save + CurrentRequest.cleanup + raise exception if exception + end + end + end + + def self.init + ActiveJob::Base.send :include, AroundPerform + end + end + end +end diff --git a/lib/rails_performance/gems/sidekiq_ext.rb b/lib/rails_performance/gems/sidekiq_ext.rb index 18b10338..08cbc583 100644 --- a/lib/rails_performance/gems/sidekiq_ext.rb +++ b/lib/rails_performance/gems/sidekiq_ext.rb @@ -6,6 +6,7 @@ def initialize(options = nil) def call(worker, msg, queue) now = RailsPerformance::Utils.time + exception = nil record = RailsPerformance::Models::SidekiqRecord.new( enqueued_ati: msg["enqueued_at"].to_i, datetimei: msg["created_at"].to_i, @@ -22,12 +23,13 @@ def call(worker, msg, queue) rescue Exception => ex # rubocop:disable Lint/RescueException record.status = "exception" record.message = ex.message - raise ex + exception = ex ensure # store in ms instead of seconds record.duration = (RailsPerformance::Utils.time - now) * 1000 record.save CurrentRequest.cleanup + raise exception if exception end end end diff --git a/lib/rails_performance/models/active_job_record.rb b/lib/rails_performance/models/active_job_record.rb new file mode 100644 index 00000000..dd1451e1 --- /dev/null +++ b/lib/rails_performance/models/active_job_record.rb @@ -0,0 +1,60 @@ +module RailsPerformance + module Models + class ActiveJobRecord < BaseRecord + attr_accessor :queue, :worker, :jid, :datetimei, :enqueued_ati, :datetime, :start_timei, :duration, :status, :message + + # deserialize from redis + def self.from_db(key, value) + items = key.split("|") + + ActiveJobRecord.new( + queue: items[2], + worker: items[4], + jid: items[6], + datetime: items[8], + datetimei: items[10], + enqueued_ati: items[12], + start_timei: items[14], + status: items[16], + json: value + ) + end + + def initialize(queue:, worker:, jid:, datetime:, datetimei:, enqueued_ati:, start_timei:, duration: nil, status: nil, message: nil, json: "{}") + @queue = queue + @worker = worker + @jid = jid + @datetime = datetime + @datetimei = datetimei.to_i + @start_timei = start_timei + @enqueued_ati = enqueued_ati + @duration = duration + @status = status + @message = message + @json = json + end + + # For UI + def record_hash + { + worker: worker, + queue: queue, + jid: jid, + datetimei: datetimei, + datetime: RailsPerformance::Utils.from_datetimei(start_timei.to_i), + start_timei: start_timei, + duration: value["duration"], + message: value["message"], + status: status + } + end + + # serialize to redis + def save + key = "active_job|queue|#{queue}|worker|#{worker}|jid|#{jid}|datetime|#{datetime}|datetimei|#{datetimei}|enqueued_ati|#{enqueued_ati}|start_timei|#{start_timei}|status|#{status}|END|#{RailsPerformance::SCHEMA}" + value = {duration:, message:} + Utils.save_to_redis(key, value) + end + end + end +end diff --git a/lib/rails_performance/version.rb b/lib/rails_performance/version.rb index f9c4ba8d..78928bd4 100644 --- a/lib/rails_performance/version.rb +++ b/lib/rails_performance/version.rb @@ -1,5 +1,5 @@ module RailsPerformance - VERSION = "1.6.0" + VERSION = "1.7.0.beta1" SCHEMA = "1.0.2" EVENTS_SCHEMA = "1.0.0" end diff --git a/test/active_job_ext_test.rb b/test/active_job_ext_test.rb new file mode 100644 index 00000000..894ed548 --- /dev/null +++ b/test/active_job_ext_test.rb @@ -0,0 +1,43 @@ +require "test_helper" + +class ActiveJobExtTest < ActiveSupport::TestCase + test "storing" do + record = dummy_active_job_event + record.save + end + + test "record" do + RailsPerformance.duration = 3.hours + + key = "active_job|queue|default|worker|SimpleWorker|jid|7d48fbf20976c224510dbc60|datetime|1583146613|datetimei|1583146614|enqueued_ati|1583146615|start_timei|1583146616|status|success|END|#{RailsPerformance::SCHEMA}" + + value = '{"duration": 123, "message":"hello"}' + + record = RailsPerformance::Models::ActiveJobRecord.from_db(key, value) + assert_equal record.queue, "default" + assert_equal record.worker, "SimpleWorker" + assert_equal record.value["message"], "hello" + assert_equal record.value["duration"], 123 + assert_equal record.jid, "7d48fbf20976c224510dbc60" + assert_equal record.datetimei, 1583146614 + + record = RailsPerformance::Models::ActiveJobRecord.from_db(key, nil) + assert_equal record.queue, "default" + assert_equal record.worker, "SimpleWorker" + assert_nil record.value["message"] + end + + test "performs" do + RailsPerformance.duration = 3.hours + + begin + MyJob.perform_now + rescue + end + + @datasource = RailsPerformance::DataSource.new(q: {}, type: :jobs) + db = @datasource.db + + assert db.data.size > 0 + end +end diff --git a/test/dummy/app/controllers/home_controller.rb b/test/dummy/app/controllers/home_controller.rb index 5c113438..e3178c8f 100644 --- a/test/dummy/app/controllers/home_controller.rb +++ b/test/dummy/app/controllers/home_controller.rb @@ -1,5 +1,7 @@ class HomeController < ApplicationController def index + MyJob.perform_later + rand(10).times { AdvancedWorker.perform_async } SecondWorker.perform_async diff --git a/test/dummy/app/jobs/my_job.rb b/test/dummy/app/jobs/my_job.rb new file mode 100644 index 00000000..b361a068 --- /dev/null +++ b/test/dummy/app/jobs/my_job.rb @@ -0,0 +1,14 @@ +class MyJob < ApplicationJob + self.queue_adapter = :solid_queue + + queue_as :default + + def perform(*args) + timer = rand(5000) / 1000.0 + sleep(timer) + # to test during development + # File.open("tmp/my_job.txt", "a") { |f| f.puts "MyJob performed at #{Time.current}" } + 1 / 0 if rand(1..10) == 1 + 42 + end +end diff --git a/test/dummy/bin/jobs b/test/dummy/bin/jobs new file mode 100755 index 00000000..dcf59f30 --- /dev/null +++ b/test/dummy/bin/jobs @@ -0,0 +1,6 @@ +#!/usr/bin/env ruby + +require_relative "../config/environment" +require "solid_queue/cli" + +SolidQueue::Cli.start(ARGV) diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb index 6f8daeb8..2a713ebe 100644 --- a/test/dummy/config/application.rb +++ b/test/dummy/config/application.rb @@ -22,5 +22,8 @@ class Application < Rails::Application # Application configuration can go into files in config/initializers # -- all .rb files in that directory are automatically loaded after loading # the framework and any gems in your application. + + config.active_job.queue_adapter = :solid_queue + config.solid_queue.connects_to = {database: {writing: :queue}} end end diff --git a/test/dummy/config/database.yml b/test/dummy/config/database.yml index 4a8a1b26..09f3b011 100644 --- a/test/dummy/config/database.yml +++ b/test/dummy/config/database.yml @@ -1,25 +1,31 @@ -# SQLite. Versions 3.8.0 and up are supported. -# gem install sqlite3 -# -# Ensure the SQLite 3 gem is defined in your Gemfile -# gem 'sqlite3' -# default: &default adapter: sqlite3 pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> timeout: 5000 development: - <<: *default - database: db/development.sqlite3 + primary: + <<: *default + database: storage/development.sqlite3 + queue: + <<: *default + database: storage/development_queue.sqlite3 + migrations_paths: db/queue_migrate -# Warning: The database defined as "test" will be erased and -# re-generated from your development database when you run "rake". -# Do not set this db to the same as development or production. test: - <<: *default - database: db/test.sqlite3 + primary: + <<: *default + database: storage/test.sqlite3 + queue: + <<: *default + database: storage/test_queue.sqlite3 + migrations_paths: db/queue_migrate production: - <<: *default - database: db/production.sqlite3 + primary: + <<: *default + database: storage/production.sqlite3 + queue: + <<: *default + database: storage/production_queue.sqlite3 + migrations_paths: db/queue_migrate diff --git a/test/dummy/config/environments/production.rb b/test/dummy/config/environments/production.rb index aec64cdf..39083ce7 100644 --- a/test/dummy/config/environments/production.rb +++ b/test/dummy/config/environments/production.rb @@ -50,7 +50,8 @@ # config.cache_store = :mem_cache_store # Replace the default in-process and non-durable queuing backend for Active Job. - # config.active_job.queue_adapter = :resque + config.active_job.queue_adapter = :solid_queue + config.solid_queue.connects_to = {database: {writing: :queue}} # Ignore bad email addresses and do not raise email delivery errors. # Set this to true and configure the email server for immediate delivery to raise delivery errors. diff --git a/test/dummy/config/queue.yml b/test/dummy/config/queue.yml new file mode 100644 index 00000000..9eace59c --- /dev/null +++ b/test/dummy/config/queue.yml @@ -0,0 +1,18 @@ +default: &default + dispatchers: + - polling_interval: 1 + batch_size: 500 + workers: + - queues: "*" + threads: 3 + processes: <%= ENV.fetch("JOB_CONCURRENCY", 1) %> + polling_interval: 0.1 + +development: + <<: *default + +test: + <<: *default + +production: + <<: *default diff --git a/test/dummy/config/recurring.yml b/test/dummy/config/recurring.yml new file mode 100644 index 00000000..0671d793 --- /dev/null +++ b/test/dummy/config/recurring.yml @@ -0,0 +1,11 @@ + +development: + my_job: + class: MyJob + schedule: every 5 seconds + + +production: + clear_solid_queue_finished_jobs: + command: "SolidQueue::Job.clear_finished_in_batches(sleep_between_batches: 0.3)" + schedule: every hour at minute 12 diff --git a/test/dummy/db/queue_schema.rb b/test/dummy/db/queue_schema.rb new file mode 100644 index 00000000..a57f7c8c --- /dev/null +++ b/test/dummy/db/queue_schema.rb @@ -0,0 +1,141 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[7.2].define(version: 2024_10_01_093648) do + create_table "solid_queue_blocked_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.string "concurrency_key", null: false + t.datetime "expires_at", null: false + t.datetime "created_at", null: false + t.index ["concurrency_key", "priority", "job_id"], name: "index_solid_queue_blocked_executions_for_release" + t.index ["expires_at", "concurrency_key"], name: "index_solid_queue_blocked_executions_for_maintenance" + t.index ["job_id"], name: "index_solid_queue_blocked_executions_on_job_id", unique: true + end + + create_table "solid_queue_claimed_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.bigint "process_id" + t.datetime "created_at", null: false + t.index ["job_id"], name: "index_solid_queue_claimed_executions_on_job_id", unique: true + t.index ["process_id", "job_id"], name: "index_solid_queue_claimed_executions_on_process_id_and_job_id" + end + + create_table "solid_queue_failed_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.text "error" + t.datetime "created_at", null: false + t.index ["job_id"], name: "index_solid_queue_failed_executions_on_job_id", unique: true + end + + create_table "solid_queue_jobs", force: :cascade do |t| + t.string "queue_name", null: false + t.string "class_name", null: false + t.text "arguments" + t.integer "priority", default: 0, null: false + t.string "active_job_id" + t.datetime "scheduled_at" + t.datetime "finished_at" + t.string "concurrency_key" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["active_job_id"], name: "index_solid_queue_jobs_on_active_job_id" + t.index ["class_name"], name: "index_solid_queue_jobs_on_class_name" + t.index ["finished_at"], name: "index_solid_queue_jobs_on_finished_at" + t.index ["queue_name", "finished_at"], name: "index_solid_queue_jobs_for_filtering" + t.index ["scheduled_at", "finished_at"], name: "index_solid_queue_jobs_for_alerting" + end + + create_table "solid_queue_pauses", force: :cascade do |t| + t.string "queue_name", null: false + t.datetime "created_at", null: false + t.index ["queue_name"], name: "index_solid_queue_pauses_on_queue_name", unique: true + end + + create_table "solid_queue_processes", force: :cascade do |t| + t.string "kind", null: false + t.datetime "last_heartbeat_at", null: false + t.bigint "supervisor_id" + t.integer "pid", null: false + t.string "hostname" + t.text "metadata" + t.datetime "created_at", null: false + t.string "name", null: false + t.index ["last_heartbeat_at"], name: "index_solid_queue_processes_on_last_heartbeat_at" + t.index ["name", "supervisor_id"], name: "index_solid_queue_processes_on_name_and_supervisor_id", unique: true + t.index ["supervisor_id"], name: "index_solid_queue_processes_on_supervisor_id" + end + + create_table "solid_queue_ready_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.datetime "created_at", null: false + t.index ["job_id"], name: "index_solid_queue_ready_executions_on_job_id", unique: true + t.index ["priority", "job_id"], name: "index_solid_queue_poll_all" + t.index ["queue_name", "priority", "job_id"], name: "index_solid_queue_poll_by_queue" + end + + create_table "solid_queue_recurring_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.string "task_key", null: false + t.datetime "run_at", null: false + t.datetime "created_at", null: false + t.index ["job_id"], name: "index_solid_queue_recurring_executions_on_job_id", unique: true + t.index ["task_key", "run_at"], name: "index_solid_queue_recurring_executions_on_task_key_and_run_at", unique: true + end + + create_table "solid_queue_recurring_tasks", force: :cascade do |t| + t.string "key", null: false + t.string "schedule", null: false + t.string "command", limit: 2048 + t.string "class_name" + t.text "arguments" + t.string "queue_name" + t.integer "priority", default: 0 + t.boolean "static", default: true, null: false + t.text "description" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["key"], name: "index_solid_queue_recurring_tasks_on_key", unique: true + t.index ["static"], name: "index_solid_queue_recurring_tasks_on_static" + end + + create_table "solid_queue_scheduled_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.datetime "scheduled_at", null: false + t.datetime "created_at", null: false + t.index ["job_id"], name: "index_solid_queue_scheduled_executions_on_job_id", unique: true + t.index ["scheduled_at", "priority", "job_id"], name: "index_solid_queue_dispatch_all" + end + + create_table "solid_queue_semaphores", force: :cascade do |t| + t.string "key", null: false + t.integer "value", default: 1, null: false + t.datetime "expires_at", null: false + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["expires_at"], name: "index_solid_queue_semaphores_on_expires_at" + t.index ["key", "value"], name: "index_solid_queue_semaphores_on_key_and_value" + t.index ["key"], name: "index_solid_queue_semaphores_on_key", unique: true + end + + add_foreign_key "solid_queue_blocked_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_claimed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_failed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_ready_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_recurring_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_scheduled_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade +end diff --git a/test/dummy/db/schema.rb b/test/dummy/db/schema.rb index e609b97e..e60e6d08 100644 --- a/test/dummy/db/schema.rb +++ b/test/dummy/db/schema.rb @@ -34,8 +34,8 @@ t.string "email", default: "", null: false t.string "encrypted_password", default: "", null: false t.string "reset_password_token" - t.datetime "reset_password_sent_at" - t.datetime "remember_created_at" + t.datetime "reset_password_sent_at", precision: nil + t.datetime "remember_created_at", precision: nil t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true end end diff --git a/test/rails_performance_controller_test.rb b/test/rails_performance_controller_test.rb index ddb1c27a..c9b8a6fd 100644 --- a/test/rails_performance_controller_test.rb +++ b/test/rails_performance_controller_test.rb @@ -127,6 +127,14 @@ def requests_report_data assert_response :success end + test "should get active jobs with params" do + setup_db + setup_active_jobs_db + get "/rails/performance/jobs" + assert_response :success + assert response.body.include?("AAWorker") + end + test "should get delayed_job with params" do setup_db setup_sidekiq_db diff --git a/test/test_helper.rb b/test/test_helper.rb index 24cadcc9..ef9e27b8 100644 --- a/test/test_helper.rb +++ b/test/test_helper.rb @@ -92,11 +92,28 @@ def dummy_delayed_job_record(datetimei: RailsPerformance::Utils.time.to_i, statu ) end +def dummy_active_job_event(worker: "AAWorker", queue: "default", jid: "jxzet-#{Time.current.to_i}", datetimei: Time.current.to_i, enqueued_ati: Time.current.to_i, start_timei: Time.current.to_i, duration: rand(60), status: "success") + RailsPerformance::Models::ActiveJobRecord.new( + queue: queue, + worker: worker, + jid: jid, + datetimei: datetimei, + enqueued_ati: enqueued_ati, + datetime: RailsPerformance::Utils.from_datetimei(datetimei).strftime(RailsPerformance::FORMAT), + start_timei: start_timei, + duration: duration, + status: status + ) +end + def reset_redis RailsPerformance.redis.flushdb end # TODO improve +def setup_active_jobs_db(event = dummy_active_job_event) + event.save +end def setup_db(event = dummy_event) event.save