Merge pull request #100 from tcarac/csv_export

feat: Add CSV Export

.gitignore

@@ -9,5 +9,4 @@ test/dummy/storage/
 test/dummy/tmp/
 
 *.gem
-
-coverage/
+coverage/

CHANGES.md

@@ -1,5 +1,8 @@
 - Unreleased
 
+- 1.3.0
+  - added csv export
+
 - 1.2.3
   - typo fix https://github.com/igorkasyanchuk/rails_performance/pull/91
   - added ignored_paths https://github.com/igorkasyanchuk/rails_performance/pull/96

app/controllers/rails_performance/base_controller.rb

@@ -1,6 +1,7 @@
 module RailsPerformance
   class BaseController < ActionController::Base
-    layout 'rails_performance/layouts/rails_performance'
+    include RailsPerformance::Concerns::CsvExportable
+    layout "rails_performance/layouts/rails_performance"
 
     before_action :verify_access
 
@@ -12,10 +13,9 @@ class BaseController < ActionController::Base
 
     private
 
-    def verify_access
-      result = RailsPerformance.verify_access_proc.call(self)
-      redirect_to('/', error: 'Access Denied', status: 401) unless result
-    end
-
+      def verify_access
+        result = RailsPerformance.verify_access_proc.call(self)
+        redirect_to("/", error: "Access Denied", status: 401) unless result
+      end
   end
-end
+end

app/controllers/rails_performance/concerns/csv_exportable.rb

@@ -0,0 +1,29 @@
+require "csv"
+module RailsPerformance
+  module Concerns
+    module CsvExportable
+      extend ActiveSupport::Concern
+
+      def export_to_csv(filename, data)
+        return if data.blank?
+
+        send_data generate_csv(data),
+                  filename: "#{filename}_#{Time.zone.today}.csv",
+                  type: "text/csv",
+                  disposition: "attachment"
+      end
+
+      private
+
+        def generate_csv(data)
+          CSV.generate(headers: true) do |csv|
+            headers = data.first.keys
+            csv << headers.map(&:to_s)
+            data.each do |entry|
+              csv << headers.map { |header| entry[header].to_s }
+            end
+          end
+        end
+    end
+  end
+end

app/controllers/rails_performance/rails_performance_controller.rb

@@ -1,30 +1,36 @@
-require_relative './base_controller.rb'
+require_relative "base_controller"
 
 module RailsPerformance
   class RailsPerformanceController < RailsPerformance::BaseController
-
     protect_from_forgery except: :recent
 
     if RailsPerformance.enabled
       def index
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :requests
+        )
         db                         = @datasource.db
 
         @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
       end
 
       def summary
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
+        @datasource                = RailsPerformance::DataSource.new(
+          **prepare_query, type: :requests
+        )
         db                         = @datasource.db
 
         @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
-        @data                      = RailsPerformance::Reports::BreakdownReport.new(db, title: "Requests").data
-
+        @data                      = RailsPerformance::Reports::BreakdownReport.new(
+          db, title: "Requests"
+        ).data
         respond_to do |format|
           format.js {}
-          format.any { render plain: "Doesn't open in new window. Wait until full page load." }
+          format.any do
+            render plain: "Doesn't open in new window. Wait until full page load."
+          end
         end
       end
 
@@ -33,24 +39,44 @@ def trace
         @data   = RailsPerformance::Reports::TraceReport.new(request_id: params[:id]).data
         respond_to do |format|
           format.js {}
-          format.any { render plain: "Doesn't open in new window. Wait until full page load." }
+          format.any do
+            render plain: "Doesn't open in new window. Wait until full page load."
+          end
         end
       end
 
       def crashes
-        @datasource   = RailsPerformance::DataSource.new(**prepare_query({status_eq: 500}), type: :requests)
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query({ status_eq: 500 }), type: :requests
+        )
         db            = @datasource.db
         @data         = RailsPerformance::Reports::CrashReport.new(db).data
+
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "error_report", @data
+          end
+        end
       end
 
       def requests
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
         db          = @datasource.db
-        @data       = RailsPerformance::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count).data
+        @data       = RailsPerformance::Reports::RequestsReport.new(db,
+                                                                    group: :controller_action_format, sort: :count).data
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "requests_report", @data
+          end
+        end
       end
 
       def recent
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
         db          = @datasource.db
         @data       = RailsPerformance::Reports::RecentRequestsReport.new(db).data(params[:from_timei])
 
@@ -73,51 +99,72 @@ def recent
         # "email"=>nil,
         # "user_agent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36"}]
 
-        respond_to do |page|
-          page.html
-          page.js
+        respond_to do |format|
+          format.html
+          format.js
+          format.csv do
+            export_to_csv "recent_requests_report", @data
+          end
         end
       end
 
       def slow
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
         db          = @datasource.db
         @data       = RailsPerformance::Reports::SlowRequestsReport.new(db).data
+
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "slow_requests_report", @data
+          end
+        end
       end
 
       def sidekiq
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :sidekiq)
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :sidekiq
+        )
         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 delayed_job
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :delayed_job)
+        @datasource                = RailsPerformance::DataSource.new(
+          **prepare_query, type: :delayed_job
+        )
         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 custom
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :custom)
+        @datasource                = RailsPerformance::DataSource.new(
+          **prepare_query, type: :custom
+        )
         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 grape
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :grape)
+        @datasource                = RailsPerformance::DataSource.new(
+          **prepare_query, type: :grape
+        )
         db                         = @datasource.db
         @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
         @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       def rake
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :rake)
+        @datasource                = RailsPerformance::DataSource.new(
+          **prepare_query, type: :rake
+        )
         db                         = @datasource.db
         @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
         @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
@@ -129,6 +176,5 @@ def prepare_query(query = params)
         RailsPerformance::Rails::QueryBuilder.compose_from(query)
       end
     end
-
   end
 end

app/views/rails_performance/rails_performance/_export.html.erb

@@ -0,0 +1,3 @@
+<%= link_to request.original_url + '.csv', class: 'icon download_icon' do %>
+  <%= icon('download') %>
+<% end %>

app/views/rails_performance/rails_performance/crashes.html.erb

@@ -1,6 +1,13 @@
 <div class="card">
   <div class="card-content">
-    <h2 class="subtitle">Crash Report</h2>
+    <div class="columns is-vcentered">
+      <div class="column">
+      <h2 class="subtitle">Crash Report</h2>
+      </div>
+      <div class="column is-narrow">
+        <%= render "export" %>
+      </div>
+    </div>
     <table class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

app/views/rails_performance/rails_performance/recent.html.erb

@@ -6,14 +6,16 @@
       <div class="column">
         <h2 class="subtitle">Recent Requests (last <%= RailsPerformance.recent_requests_time_window / 60 %> minutes)<h2>
       </div>
-      <div class="column right-text is-size-5 has-text-right">
-        <label id="autoupdate_label">
-          <input id="autoupdate" type="checkbox"/>
-          Auto-update
-        </label>
+      <div class="column is-narrow">
+        <%= render "export" %> 
       </div>
     </div>
-
+    <div class="has-text-right">
+      <label id="autoupdate_label">
+        <input id="autoupdate" type="checkbox" />
+        Auto-update
+      </label>
+    </div>
     <table id="recent" class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

app/views/rails_performance/rails_performance/requests.html.erb

@@ -1,6 +1,13 @@
 <div class="card">
   <div class="card-content">
-    <h2 class="subtitle">Requests (path, total number, average response time)</h2>
+    <div class="columns is-vcentered">
+      <div class="column">
+        <h2 class="subtitle">Requests (path, total number, average response time)</h2>
+      </div>
+      <div class="column is-narrow">
+        <%= render "export" %> 
+      </div>
+    </div>
     <table class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

app/views/rails_performance/rails_performance/slow.html.erb

@@ -6,6 +6,9 @@
       <div class="column">
         <h2 class="subtitle">Slow Requests (last <%= RailsPerformance.slow_requests_time_window / 60 %> minutes + slower than <%= RailsPerformance.slow_requests_threshold %>ms)<h2>
       </div>
+      <div class="column is-narrow">
+        <%= render "export" %> 
+      </div>
     </div>
 
     <table id="recent" class="table is-fullwidth is-hoverable is-narrow">

app/views/rails_performance/shared/_header.html.erb

@@ -39,7 +39,6 @@
     <div class="navbar-end">
       <div class="navbar-item">
         <div class="buttons">
-          <%#= link_to 'Export to CSV', '#', target: '_blank', class: "button is-primary" %>
           <%= link_to RailsPerformance.home_link, class: "button is-light home_icon" do %>
             <%= icon('home') %>
           <% end %>

app/views/rails_performance/stylesheets/style.css

@@ -56,6 +56,12 @@
   height: 24px;
 }
 
+.download_icon svg {
+  width: 24px;
+  height: 24px;
+  color: red;
+}
+
 .user-agent-icon svg {
   width: 12px;
   height: 12px;