From a4b22bcbe396dbf324531c9b80926b31f37ab67f Mon Sep 17 00:00:00 2001 From: Don Restarone <35935196+donrestarone@users.noreply.github.com> Date: Fri, 10 Mar 2023 20:22:38 -0500 Subject: [PATCH] [feature] enable profiling in production (#1449) * [feature] enable profiling in production (#1448) ## Shows application profiling When enabled, shows profiling information to admin users Screen Shot 2023-03-10 at 6 27 18 PM ## Permissions Ensure user has `show profiler` permission Screen Shot 2023-03-10 at 6 28 13 PM ## Profiling configuration Append `?pp=help` to access the profiling help page Screen Shot 2023-03-10 at 6 27 41 PM ## Improve app performance! Use instrumentation to track down performance bottlenecks and improve app performance Screen Shot 2023-03-10 at 6 29 32 PM * add permissions (#1450) Co-authored-by: donrestarone --------- Co-authored-by: donrestarone --- Gemfile | 10 +++++++--- Gemfile.lock | 10 ++++++++-- app/controllers/application_controller.rb | 9 +++++++-- app/controllers/comfy/admin/users_controller.rb | 1 + app/models/user.rb | 8 ++++++-- app/views/comfy/admin/users/_form.haml | 6 +++++- config/environments/development.rb | 2 -- config/initializers/rack_profiler.rb | 9 +++++++++ .../20230310222034_add_show_profiler_to_users.rb | 5 +++++ db/schema.rb | 3 ++- 10 files changed, 50 insertions(+), 13 deletions(-) create mode 100644 config/initializers/rack_profiler.rb create mode 100644 db/migrate/20230310222034_add_show_profiler_to_users.rb diff --git a/Gemfile b/Gemfile index d817a1493..f74b0f949 100644 --- a/Gemfile +++ b/Gemfile @@ -62,6 +62,13 @@ gem 'net-ssh', '>= 6.0.2' gem 'ed25519', '>= 1.2', '< 2.0' gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' +# Display performance information such as SQL time and flame graphs for each request in your browser. +# Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md +gem 'rack-mini-profiler', '~> 3.0', require: false +gem 'flamegraph' +gem 'stackprof' +gem 'memory_profiler' + group :development, :test do # Call 'byebug' anywhere in the code to stop execution and get a debugger console gem 'byebug', platforms: [:mri, :mingw, :x64_mingw] @@ -69,9 +76,6 @@ group :development, :test do end group :development do - # Display performance information such as SQL time and flame graphs for each request in your browser. - # Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md - gem 'rack-mini-profiler', '~> 2.0' gem 'listen', '~> 3.3' # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring gem 'spring' diff --git a/Gemfile.lock b/Gemfile.lock index f02450659..0095b0b29 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -216,6 +216,7 @@ GEM faker (2.21.0) i18n (>= 1.8.11, < 2) ffi (1.15.5) + flamegraph (0.9.5) font-awesome-sass (5.15.1) sassc (>= 1.11) friendly_id (5.4.2) @@ -276,6 +277,7 @@ GEM mailgun-ruby (1.2.4) rest-client (>= 2.0.2) marcel (1.0.2) + memory_profiler (1.0.1) meta-tags (2.14.0) actionpack (>= 3.2.0, < 6.2) method_source (1.0.0) @@ -317,7 +319,7 @@ GEM rack (>= 0.4) rack-cors (1.1.1) rack (>= 2.0.0) - rack-mini-profiler (2.3.1) + rack-mini-profiler (3.0.0) rack (>= 1.2.0) rack-protection (2.2.0) rack @@ -439,6 +441,7 @@ GEM sshkit (1.21.2) net-scp (>= 1.1.2) net-ssh (>= 2.8.0) + stackprof (0.2.23) stripe (7.1.0) stripe-rails (2.3.5) rails (>= 5.1) @@ -519,6 +522,7 @@ DEPENDENCIES ember-cli-rails (= 0.10.0) exception_notification (~> 4.5) faker + flamegraph friendly_id graphiql-rails graphql (~> 2.0) @@ -531,6 +535,7 @@ DEPENDENCIES listen (~> 3.3) local_time mailgun-ruby + memory_profiler meta-tags mocha net-ssh (>= 6.0.2) @@ -538,7 +543,7 @@ DEPENDENCIES pry puma (~> 5.6) rack-cors - rack-mini-profiler (~> 2.0) + rack-mini-profiler (~> 3.0) rack-timeout (~> 0.6) rails (~> 6.1.5) rails-controller-testing @@ -554,6 +559,7 @@ DEPENDENCIES sinatra sitemap_generator spring + stackprof stripe-rails turbo-rails (~> 1.1) turnout (~> 2.5) diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index e8e58a228..57b2b2e30 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -1,9 +1,8 @@ class ApplicationController < ActionController::Base include ActiveStorage::SetCurrent - before_action :prepare_exception_notifier before_action :store_user_location!, if: :storable_location? - before_action :set_current_user + before_action :prepare_profiler,:prepare_exception_notifier , :set_current_user def after_sign_in_path_for(resource) if session[:user_return_to] then return session[:user_return_to] end @@ -41,6 +40,12 @@ def prepare_exception_notifier } end + def prepare_profiler + if current_user && current_user.can_access_admin? & current_user.show_profiler? + Rack::MiniProfiler.authorize_request + end + end + # Reference: https://github.com/heartcombo/devise/wiki/How-To:-Redirect-back-to-current-page-after-sign-in,-sign-out,-sign-up,-update#storelocation-to-the-rescue def storable_location? request.get? && is_navigational_format? && !devise_controller? && !request.xhr? diff --git a/app/controllers/comfy/admin/users_controller.rb b/app/controllers/comfy/admin/users_controller.rb index 4b3e64b1e..b1fb9ad5b 100644 --- a/app/controllers/comfy/admin/users_controller.rb +++ b/app/controllers/comfy/admin/users_controller.rb @@ -88,6 +88,7 @@ def update_params :can_manage_subdomain_settings, :can_access_admin, :deliver_error_notifications, + :show_profiler, category_ids: [], api_accessibility: {} ) diff --git a/app/models/user.rb b/app/models/user.rb index 88f9caac8..21b6bdc99 100644 --- a/app/models/user.rb +++ b/app/models/user.rb @@ -43,11 +43,14 @@ class User < ApplicationRecord :invitation_limit , :invited_by_type, :invited_by_id, - :invitations_count + :invitations_count, + :global_admin, + :show_profiler, ] FULL_PERMISSIONS = { can_access_admin: true, + can_access_forum: true, can_manage_web: true, can_manage_analytics: true, can_manage_files: true, @@ -57,7 +60,8 @@ class User < ApplicationRecord can_manage_subdomain_settings: true, api_accessibility: {api_namespaces: {all_namespaces: {full_access: 'true'}}, api_keys: {full_access: 'true'}}, can_view_restricted_pages: true, - moderator: true + moderator: true, + deliver_error_notifications: true, } SESSION_TIMEOUT = [ diff --git a/app/views/comfy/admin/users/_form.haml b/app/views/comfy/admin/users/_form.haml index a70106cea..9ba9ea720 100644 --- a/app/views/comfy/admin/users/_form.haml +++ b/app/views/comfy/admin/users/_form.haml @@ -56,7 +56,11 @@ .form-group = f.check_box :deliver_error_notifications %label - Deliver error notifications + Deliver error notifications + .form-group + = f.check_box :show_profiler + %label + Show Profiler .form-group = f.check_box :can_manage_users %label diff --git a/config/environments/development.rb b/config/environments/development.rb index 279990d47..a04b2a873 100644 --- a/config/environments/development.rb +++ b/config/environments/development.rb @@ -84,6 +84,4 @@ # Uncomment if you wish to allow Action Cable access from any origin. # config.action_cable.disable_request_forgery_protection = true - - Rack::MiniProfiler.config.position = 'bottom-right' end \ No newline at end of file diff --git a/config/initializers/rack_profiler.rb b/config/initializers/rack_profiler.rb new file mode 100644 index 000000000..68929eedf --- /dev/null +++ b/config/initializers/rack_profiler.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true +require "rack-mini-profiler" + +# initialization is skipped so trigger it +Rack::MiniProfilerRails.initialize!(Rails.application) +Rack::MiniProfiler.config.position = 'bottom-right' +Rack::MiniProfiler.config.authorization_mode = :allow_authorized +Rack::MiniProfiler.config.enable_hotwire_turbo_drive_support = true +Rack::MiniProfiler.config.enable_advanced_debugging_tools = true \ No newline at end of file diff --git a/db/migrate/20230310222034_add_show_profiler_to_users.rb b/db/migrate/20230310222034_add_show_profiler_to_users.rb new file mode 100644 index 000000000..9e95d3c4f --- /dev/null +++ b/db/migrate/20230310222034_add_show_profiler_to_users.rb @@ -0,0 +1,5 @@ +class AddShowProfilerToUsers < ActiveRecord::Migration[6.1] + def change + add_column :users, :show_profiler, :boolean, default: false + end +end diff --git a/db/schema.rb b/db/schema.rb index 6b2ef576c..87106f5ca 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 2023_01_24_014921) do +ActiveRecord::Schema.define(version: 2023_03_10_222034) do # These are extensions that must be enabled in order to support this database enable_extension "plpgsql" @@ -561,6 +561,7 @@ t.integer "consumed_timestep" t.boolean "otp_required_for_login", default: false t.boolean "can_access_forum", default: false + t.boolean "show_profiler", default: false t.index ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true t.index ["email"], name: "index_users_on_email", unique: true t.index ["invitation_token"], name: "index_users_on_invitation_token", unique: true