save benchmark data as csv

Author: jvmvik

Gemfile

@@ -17,6 +17,8 @@ group :test, :development do
   gem 'rspec', '~>3.11'
   # code coverage to monitor rspec tests
   gem 'simplecov'
+  # save CSV files
+  gem 'csv'
 
   # Thread pool example file: thread_pool_spec.rb
   # https://github.com/mperham/connection_pool/tree/main

serpapi.gemspec

@@ -29,5 +29,6 @@ information.'
   s.add_development_dependency 'rspec', '~>3.11'
   s.add_development_dependency 'yard', '~>0.9.28'
   s.add_development_dependency 'rubocop', '~>1.75.7'
+  s.add_development_dependency 'csv'
 
 end

spec/serpapi/client/benchmark/benchmark_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'csv'
 
 # This benchmark demonstrates that persistent connections are 2x quicker than regular HTTP connection.
 #
@@ -14,47 +15,84 @@
 # ````
 # For an example of thread pool where the socket connection can be shared see: thread_pool_spec.rb 
 
+# Create unique filename with client_type, connection_type, and RUBY_VERSION
+timestamp = Time.now.strftime('%Y%m%d_%H%M%S_%L')
+CSV_FN = "serpapi_ruby_#{RUBY_VERSION.gsub('.', '_')}_#{timestamp}.csv"
+# Create the CSV file with headers if it doesn't exist
+CSV.open(CSV_FN, 'w') do |csv|
+  csv << ['timestamp', 'client_type', 'connection_type', 'requests_count', 'total_time_seconds', 'avg_time_per_request', 'requests_per_second', 'ruby_version']
+end
+
+def save(client_type, connection_type, requests_count, runtime)
+  # Create CSV with headers and data
+  CSV.open(CSV_FN, 'a') do |csv|
+    # Add the data row
+    avg_time = runtime / requests_count
+    rps = requests_count / runtime
+    
+    csv << [
+      Time.now.iso8601,
+      client_type,
+      connection_type,
+      requests_count,
+      runtime.round(5),
+      avg_time.round(5),
+      rps.round(2),
+      RUBY_VERSION
+    ]
+  end
+
+  puts "update benchmark result to: #{File.absolute_path(CSV_FN)}"
+end
+
 describe 'benchmark SerpApi client with/without persistent connection' do
 
   # number of sequential requests
-  n = 10
+  n = 25
 
   it 'regular get' do
+    puts "start SerpApi regular get benchmark with #{n} requests"
     runtime = Benchmark.measure do
       client = SerpApi::Client.new(persistent: false, engine: 'google', api_key: ENV['SERPAPI_KEY'])
       results = n.times.map { |x| client.search(q: "coffee #{x}") }
       client.close
     end.total
-    puts "serpapi client took #{runtime}s to completed #{n} requests without HTTP persistent connection"
+    puts "regular get took #{runtime}s to completed #{n} requests without HTTP persistent connection"
+    save('SerpApi', 'non-persistent', n, runtime)
   end
 
   it 'keep alive' do
+    puts "start SerpApi keep alive benchmark with #{n} requests"
     runtime = Benchmark.measure do
       client = SerpApi::Client.new(persistent: true, engine: 'google', api_key: ENV['SERPAPI_KEY'],)
       results = n.times.map { |x| client.search(q: "coffee #{n+x}") }
       client.close 
     end.total
-    puts "serpapi client took #{runtime}s to completed #{n} requests with HTTP persistent connection"
+    puts "keep alive took #{runtime}s to completed #{n} requests with HTTP persistent connection"
+    save('SerpApi', 'persistent', n, runtime)
   end
 
 end
 
 describe 'benchmark client using http.rb as a baseline' do
 
-  n = 10
+  n = 25
   host = "http://api.icndb.com"
   endpoint = "/jokes/random"
 
   it 'regular get' do
+    puts "start HTTP.rb regular get benchmark with #{n} requests"
     runtime = Benchmark.measure do
       n.times do 
         HTTP.get(host + endpoint)
       end
     end.total
     puts "http.rb took #{runtime}s to completed #{n} requests without HTTP persistent connection"
+    save('HTTP.rb', 'non-persistent', n, runtime)
   end
 
   it 'keep alive' do
+    puts "start HTTP.rb keep alive benchmark with #{n} requests"
     runtime = Benchmark.measure do
       begin
         # create HTTP client with persistent connection to api.icndb.com:
@@ -67,7 +105,7 @@
         http.close if http
       end
     end.total
-    puts "http.rb took #{runtime}s to completed #{n} requests with HTTP persistent connection"
-    #expect(runtime).to be_within(0.1).of(0.02) # Adjust the tolerance as needed
+    puts "keep alive took #{runtime}s to completed #{n} requests with HTTP persistent connection"
+    save('HTTP.rb', 'persistent', n, runtime)
   end
 end