Cover Faraday and chained HTTP.rb requests

Add Faraday GET/POST endpoints to rails7-sidekiq so the new automated
Faraday integration is exercised (and its downstream Net::HTTP event
suppressed). Add chained HTTP.rb requests -- a headers chain and a
followed redirect -- which run through HTTP::Session on http 6 and were
previously uninstrumented.

Targets:
appsignal/appsignal-ruby#1523 (Faraday)
appsignal/appsignal-ruby#1528 (HTTP.rb chained)

Author: unflxw

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"

ruby/rails7-sidekiq/app/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: /integration
   specs:
-    appsignal (4.0.0)
-      rack
+    appsignal (4.8.6)
+      logger
+      rack (>= 2.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -105,11 +106,30 @@ GEM
     debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
+    domain_name (0.6.20240107)
     drb (2.2.1)
     erubi (1.12.0)
     excon (0.110.0)
+    faraday (2.14.3)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    ffi (1.17.4)
+    ffi-compiler (1.4.2)
+      ffi (>= 1.15.5)
+      rake
     globalid (1.2.1)
       activesupport (>= 6.1)
+    http (5.3.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.1.6)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     importmap-rails (1.2.1)
@@ -122,6 +142,11 @@ GEM
     jbuilder (2.11.5)
       actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
+    json (2.20.0)
+    llhttp-ffi (0.5.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    logger (1.7.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -139,6 +164,8 @@ GEM
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     mutex_m (0.2.0)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
     net-imap (0.4.11)
       date
       net-protocol
@@ -250,6 +277,7 @@ GEM
       railties (>= 6.0.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.1.1)
     web-console (4.2.1)
       actionview (>= 6.0.0)
       activemodel (>= 6.0.0)
@@ -277,6 +305,8 @@ DEPENDENCIES
   capybara
   debug
   excon
+  faraday
+  http
   importmap-rails
   jbuilder
   pg (~> 1.1)

ruby/rails7-sidekiq/app/app/controllers/requests_controller.rb

@@ -46,6 +46,56 @@ def perform_http_rb_get
     redirect_to requests_path, :notice => %(Request "#{params[:action]}" made)
   end
 
+  # In http 6 a chained request (`HTTP.follow.get`, `HTTP.headers(...).get`,
+  # etc.) runs through `HTTP::Session#request` instead of `HTTP::Client#request`.
+  # These actions exercise that path so it records a `request.http_rb` event.
+  def perform_http_rb_headers
+    HTTP.headers("X-Custom-Header" => "AppSignal")
+      .get("http://localhost:4001/requests/http_rb_target")
+    redirect_to requests_path, :notice => %(Request "#{params[:action]}" made)
+  end
+
+  # A followed redirect should stay a single `request.http_rb` event spanning
+  # every hop, not one event per hop.
+  def perform_http_rb_follow
+    HTTP.follow.get("http://localhost:4001/requests/http_rb_redirect")
+    redirect_to requests_path, :notice => %(Request "#{params[:action]}" made)
+  end
+
+  def http_rb_target
+    sleep 1
+    render :html => "HTTP.rb request target"
+  end
+
+  def http_rb_redirect
+    redirect_to http_rb_target_requests_path
+  end
+
+  # Faraday defaults to the Net::HTTP adapter, so this also exercises AppSignal
+  # suppressing the downstream Net::HTTP event: the request should be recorded
+  # once, as a `request.faraday` event.
+  def perform_faraday_get
+    handle_response Faraday.get("http://localhost:4001/requests/faraday_get?query=param")
+  end
+
+  def perform_faraday_post
+    handle_response Faraday.post(
+      "http://localhost:4001/requests/faraday_post",
+      URI.encode_www_form(:language => "ruby", :library => "faraday"),
+      "Content-Type" => "application/x-www-form-urlencoded"
+    )
+  end
+
+  def faraday_get
+    sleep 1
+    render :html => "Faraday GET request"
+  end
+
+  def faraday_post
+    sleep 1
+    render :html => "Faraday POST request"
+  end
+
   def handle_response(response)
     unless response.status == 200
       raise "Request failed with status #{response.status}"

ruby/rails7-sidekiq/app/app/views/requests/index.html.erb

@@ -11,4 +11,8 @@
   <li><%= link_to "Excon HTTP OPTIONS", perform_excon_options_requests_path %></li>
   <li><%= link_to "Excon HTTP TRACE", perform_excon_trace_requests_path %></li>
   <li><%= link_to "HTTP.rb GET", perform_http_rb_get_requests_path %></li>
+  <li><%= link_to "HTTP.rb GET (chained headers)", perform_http_rb_headers_requests_path %></li>
+  <li><%= link_to "HTTP.rb GET (followed redirect)", perform_http_rb_follow_requests_path %></li>
+  <li><%= link_to "Faraday HTTP GET", perform_faraday_get_requests_path %></li>
+  <li><%= link_to "Faraday HTTP POST", perform_faraday_post_requests_path %></li>
 </ul>

ruby/rails7-sidekiq/app/config/routes.rb

@@ -49,6 +49,14 @@ class SinatraApp < Sinatra::Base
       get :perform_excon_trace
       match "/excon_trace" => "requests#excon_trace", :via => :trace
       get :perform_http_rb_get
+      get :perform_http_rb_headers
+      get :perform_http_rb_follow
+      get :http_rb_target
+      get :http_rb_redirect
+      get :perform_faraday_get
+      get :faraday_get
+      get :perform_faraday_post
+      post :faraday_post
     end
   end