Merge pull request #371 from appsignal/jobs-http-test-setups

Test new enqueue and HTTP client Ruby instrumentations

Author: unflxw

.github/workflows/ci.yml

@@ -286,6 +286,8 @@ jobs:
           - ruby/rails7-sequel
           - ruby/rails7-sidekiq
           - ruby/rails8-delayed-job
+          - ruby/rails8-que
+          - ruby/rails8-resque
           - ruby/rails8-sidekiq
           - ruby/rails8-sidekiq-opentelemetry
           - ruby/sinatra-redis

README.md

@@ -129,6 +129,8 @@ rake app=ruby/rails7-sidekiq app:up
 rake app=ruby/rails7-solid-cache app:up
 rake app=ruby/rails7-solid-queue app:up
 rake app=ruby/rails8-delayed-job app:up
+rake app=ruby/rails8-que app:up
+rake app=ruby/rails8-resque app:up
 rake app=ruby/rails8-sidekiq app:up
 rake app=ruby/rails8-sidekiq-opentelemetry app:up
 rake app=ruby/shoryuken app:up
@@ -221,6 +223,8 @@ rake app=ruby/rails7-sequel app:bot
 rake app=ruby/rails7-sidekiq app:bot
 rake app=ruby/rails7-solid-cache app:bot
 rake app=ruby/rails7-solid-queue app:bot
+rake app=ruby/rails8-que app:bot
+rake app=ruby/rails8-resque app:bot
 rake app=ruby/rails8-sidekiq app:bot
 rake app=ruby/rails8-sidekiq-opentelemetry app:bot
 rake app=ruby/sinatra-alpine app:bot
@@ -265,6 +269,8 @@ rake app=ruby/rails7-sequel mode=collector app:up
 rake app=ruby/rails7-solid-cache mode=collector app:up
 rake app=ruby/rails7-solid-queue mode=collector app:up
 rake app=ruby/rails8-delayed-job mode=collector app:up
+rake app=ruby/rails8-que mode=collector app:up
+rake app=ruby/rails8-resque mode=collector app:up
 rake app=ruby/rails8-sidekiq mode=collector app:up
 rake app=ruby/sinatra-alpine mode=collector app:up
 rake app=ruby/sinatra-gvltools mode=collector app:up
@@ -360,6 +366,8 @@ rake app=ruby/rails7-sidekiq app:restart
 rake app=ruby/rails7-solid-cache app:restart
 rake app=ruby/rails7-solid-queue app:restart
 rake app=ruby/rails8-delayed-job app:restart
+rake app=ruby/rails8-que app:restart
+rake app=ruby/rails8-resque app:restart
 rake app=ruby/rails8-sidekiq app:restart
 rake app=ruby/rails8-sidekiq-opentelemetry app:restart
 rake app=ruby/shoryuken app:restart
@@ -462,6 +470,8 @@ rake app=ruby/rails7-sidekiq app:bash
 rake app=ruby/rails7-solid-cache app:bash
 rake app=ruby/rails7-solid-queue app:bash
 rake app=ruby/rails8-delayed-job app:bash
+rake app=ruby/rails8-que app:bash
+rake app=ruby/rails8-resque app:bash
 rake app=ruby/rails8-sidekiq app:bash
 rake app=ruby/rails8-sidekiq-opentelemetry app:bash
 rake app=ruby/shoryuken app:bash
@@ -564,6 +574,8 @@ rake app=ruby/rails7-sidekiq app:console
 rake app=ruby/rails7-solid-cache app:console
 rake app=ruby/rails7-solid-queue app:console
 rake app=ruby/rails8-delayed-job app:console
+rake app=ruby/rails8-que app:console
+rake app=ruby/rails8-resque app:console
 rake app=ruby/rails8-sidekiq app:console
 rake app=ruby/rails8-sidekiq-opentelemetry app:console
 rake app=ruby/shoryuken app:console
@@ -666,6 +678,8 @@ rake app=ruby/rails7-sidekiq app:diagnose
 rake app=ruby/rails7-solid-cache app:diagnose
 rake app=ruby/rails7-solid-queue app:diagnose
 rake app=ruby/rails8-delayed-job app:diagnose
+rake app=ruby/rails8-que app:diagnose
+rake app=ruby/rails8-resque app:diagnose
 rake app=ruby/rails8-sidekiq app:diagnose
 rake app=ruby/rails8-sidekiq-opentelemetry app:diagnose
 rake app=ruby/shoryuken app:diagnose
@@ -768,6 +782,8 @@ rake app=ruby/rails7-sidekiq app:tail:appsignal
 rake app=ruby/rails7-solid-cache app:tail:appsignal
 rake app=ruby/rails7-solid-queue app:tail:appsignal
 rake app=ruby/rails8-delayed-job app:tail:appsignal
+rake app=ruby/rails8-que app:tail:appsignal
+rake app=ruby/rails8-resque app:tail:appsignal
 rake app=ruby/rails8-sidekiq app:tail:appsignal
 rake app=ruby/rails8-sidekiq-opentelemetry app:tail:appsignal
 rake app=ruby/shoryuken app:tail:appsignal

ruby/rails6-shoryuken/app/app/controllers/tests_controller.rb

@@ -16,4 +16,9 @@ def active_job_error_job
     ErrorJob.perform_later("ActiveJob ErrorJob queued")
     render :html => "ActiveJob ErrorJob queued, refresh to queue a new one!"
   end
+
+  def shoryuken_native_job
+    NativeWorker.perform_async(:body => "Native Shoryuken job queued")
+    render :html => "Native Shoryuken job queued, refresh to queue a new one!"
+  end
 end

ruby/rails6-shoryuken/app/app/views/tests/index.html.erb

@@ -5,4 +5,5 @@
   <li><%= link_to "Slow request", slow_path %></li>
   <li><%= link_to "ActiveJob ErrorJob", active_job_error_job_path %></li>
   <li><%= link_to "ActiveJob PerformanceJob", active_job_performance_job_path %></li>
+  <li><%= link_to "Native Shoryuken worker", shoryuken_native_job_path %></li>
 </ul>

ruby/rails6-shoryuken/app/app/workers/native_worker.rb

@@ -0,0 +1,14 @@
+# A native Shoryuken worker (as opposed to the Active Job jobs in app/jobs).
+# Enqueuing it with `NativeWorker.perform_async` from a web request records an
+# `enqueue.shoryuken` event on that request's transaction, through Shoryuken's
+# client middleware. It uses its own queue so it doesn't clash with the Active
+# Job adapter, which owns the "default" queue.
+class NativeWorker
+  include Shoryuken::Worker
+
+  shoryuken_options :queue => "native", :auto_delete => true, :body_parser => :json
+
+  def perform(_sqs_msg, body)
+    puts "Performing NativeWorker job: #{body}"
+  end
+end

ruby/rails6-shoryuken/app/config/initializers/shoryuken.rb

@@ -17,3 +17,10 @@
     verify_checksums: false # Disable for mock server
   )
 end
+
+# Load the native worker on boot so it registers for its queue. In development
+# classes load lazily, so without this the Shoryuken server wouldn't know to
+# route the "native" queue to NativeWorker.
+Rails.application.config.to_prepare do
+  NativeWorker
+end

ruby/rails6-shoryuken/app/config/routes.rb

@@ -3,5 +3,6 @@
   get "/error", to: "tests#error"
   get "/active_job_performance_job", to: "tests#active_job_performance_job"
   get "/active_job_error_job", to: "tests#active_job_error_job"
+  get "/shoryuken_native_job", to: "tests#shoryuken_native_job"
   root :to => "tests#index"
 end

ruby/rails6-shoryuken/app/processmon.toml

@@ -11,6 +11,7 @@ args = [
   "exec",
   "shoryuken",
   "-q=default",
+  "-q=native",
   "-R"
 ]
 working_dir = "/app"

ruby/rails6-shoryuken/commands/run

@@ -22,5 +22,6 @@ bin/rails db:migrate
 
 echo "Create sqs queues in mock server"
 bundle exec shoryuken sqs create default
+bundle exec shoryuken sqs create native
 
 /commands/processmon processmon.toml

ruby/rails7-sidekiq/app/Gemfile

@@ -12,6 +12,7 @@ gem "sidekiq", "~> 7.1.6"
 gem "appsignal", :path => "/integration"
 gem "excon"
 gem "http"
+gem "faraday"
 
 # The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
 gem "sprockets-rails"