hey_doctor 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +97 -0
  4. data/Rakefile +10 -0
  5. data/app/services/hey_doctor/check_application_health_service.rb +29 -0
  6. data/app/services/hey_doctor/check_database_health_service.rb +43 -0
  7. data/app/services/hey_doctor/check_redis_health_service.rb +31 -0
  8. data/lib/hey_doctor.rb +22 -0
  9. data/lib/hey_doctor/engine.rb +10 -0
  10. data/lib/hey_doctor/version.rb +5 -0
  11. data/lib/tasks/hey_doctor_tasks.rake +5 -0
  12. data/spec/dummy/Rakefile +6 -0
  13. data/spec/dummy/app/assets/config/manifest.js +1 -0
  14. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  15. data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
  16. data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
  17. data/spec/dummy/app/controllers/application_controller.rb +2 -0
  18. data/spec/dummy/app/controllers/home_controller.rb +5 -0
  19. data/spec/dummy/app/javascript/packs/application.js +15 -0
  20. data/spec/dummy/app/jobs/application_job.rb +7 -0
  21. data/spec/dummy/app/mailers/application_mailer.rb +4 -0
  22. data/spec/dummy/app/models/application_record.rb +3 -0
  23. data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
  24. data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
  25. data/spec/dummy/bin/rails +4 -0
  26. data/spec/dummy/bin/rake +4 -0
  27. data/spec/dummy/bin/setup +33 -0
  28. data/spec/dummy/config.ru +11 -0
  29. data/spec/dummy/config/application.rb +42 -0
  30. data/spec/dummy/config/boot.rb +5 -0
  31. data/spec/dummy/config/cable.yml +10 -0
  32. data/spec/dummy/config/database.yml +21 -0
  33. data/spec/dummy/config/environment.rb +5 -0
  34. data/spec/dummy/config/environments/development.rb +66 -0
  35. data/spec/dummy/config/environments/production.rb +113 -0
  36. data/spec/dummy/config/environments/test.rb +59 -0
  37. data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -0
  38. data/spec/dummy/config/initializers/backtrace_silencers.rb +8 -0
  39. data/spec/dummy/config/initializers/cors.rb +16 -0
  40. data/spec/dummy/config/initializers/filter_parameter_logging.rb +6 -0
  41. data/spec/dummy/config/initializers/inflections.rb +16 -0
  42. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  43. data/spec/dummy/config/initializers/redis.rb +1 -0
  44. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  45. data/spec/dummy/config/locales/en.yml +33 -0
  46. data/spec/dummy/config/puma.rb +43 -0
  47. data/spec/dummy/config/routes.rb +3 -0
  48. data/spec/dummy/config/storage.yml +34 -0
  49. data/spec/dummy/db/schema.rb +18 -0
  50. data/spec/dummy/log/development.log +1693 -0
  51. data/spec/dummy/log/test.log +1258 -0
  52. data/spec/dummy/tmp/development_secret.txt +1 -0
  53. data/spec/dummy/tmp/pids/server.pid +1 -0
  54. data/spec/lib/hey_doctor/hey_doctor_spec.rb +42 -0
  55. data/spec/rails_helper.rb +27 -0
  56. data/spec/requests/health_check_spec.rb +28 -0
  57. data/spec/services/hey_doctor/check_application_health_service_spec.rb +46 -0
  58. data/spec/services/hey_doctor/check_database_health_service_spec.rb +91 -0
  59. data/spec/services/hey_doctor/check_redis_health_service_spec.rb +56 -0
  60. data/spec/spec_helper.rb +25 -0
  61. metadata +240 -0
@@ -0,0 +1,11 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require_relative "config/environment"
4
+ require "hey_doctor"
5
+
6
+ map '/_ah/health' do
7
+ run HeyDoctor::Rack::HealthCheck.new
8
+ end
9
+
10
+ run Rails.application
11
+ Rails.application.load_server
@@ -0,0 +1,42 @@
1
+ require_relative "boot"
2
+
3
+ require "rails"
4
+ # Pick the frameworks you want:
5
+ require "active_model/railtie"
6
+ require "active_job/railtie"
7
+ require "active_record/railtie"
8
+ require "active_storage/engine"
9
+ require "action_controller/railtie"
10
+ require "action_mailer/railtie"
11
+ require "action_mailbox/engine"
12
+ require "action_text/engine"
13
+ require "action_view/railtie"
14
+ require "action_cable/engine"
15
+ # require "sprockets/railtie"
16
+ # require "rails/test_unit/railtie"
17
+
18
+ # Require the gems listed in Gemfile, including any gems
19
+ # you've limited to :test, :development, or :production.
20
+ Bundler.require(*Rails.groups)
21
+ require "hey_doctor"
22
+ require 'dotenv-rails'
23
+ require 'redis'
24
+
25
+ module Dummy
26
+ class Application < Rails::Application
27
+ config.load_defaults Rails::VERSION::STRING.to_f
28
+ config.autoload_paths += Dir[Rails.root.join('lib')]
29
+ # Configuration for the application, engines, and railties goes here.
30
+ #
31
+ # These settings can be overridden in specific environments using the files
32
+ # in config/environments, which are processed later.
33
+ #
34
+ # config.time_zone = "Central Time (US & Canada)"
35
+ # config.eager_load_paths << Rails.root.join("extras")
36
+
37
+ # Only loads a smaller set of middleware suitable for API only apps.
38
+ # Middleware like session, flash, cookies can be added back manually.
39
+ # Skip views, helpers and assets when generating a new resource.
40
+ config.api_only = true
41
+ end
42
+ end
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
3
+
4
+ require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
5
+ $LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
@@ -0,0 +1,10 @@
1
+ development:
2
+ adapter: async
3
+
4
+ test:
5
+ adapter: test
6
+
7
+ production:
8
+ adapter: redis
9
+ url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
10
+ channel_prefix: dummy_production
@@ -0,0 +1,21 @@
1
+ default: &default
2
+ adapter: postgresql
3
+ encoding: unicode
4
+ pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
5
+ host: <%= ENV['DATABASE_HOST'] %>
6
+ username: <%= ENV['DATABASE_USER'] %>
7
+ password: <%= ENV['DATABASE_PASSWORD'] %>
8
+
9
+ development:
10
+ <<: *default
11
+ database: dummy_development
12
+
13
+ test:
14
+ <<: *default
15
+ database: dummy_test
16
+
17
+ production:
18
+ <<: *default
19
+ database: dummy_production
20
+ username: dummy
21
+ password: <%= ENV['DUMMY_DATABASE_PASSWORD'] %>
@@ -0,0 +1,5 @@
1
+ # Load the Rails application.
2
+ require_relative "application"
3
+
4
+ # Initialize the Rails application.
5
+ Rails.application.initialize!
@@ -0,0 +1,66 @@
1
+ require "active_support/core_ext/integer/time"
2
+
3
+ Rails.application.configure do
4
+ # Settings specified here will take precedence over those in config/application.rb.
5
+
6
+ # In the development environment your application's code is reloaded any time
7
+ # it changes. This slows down response time but is perfect for development
8
+ # since you don't have to restart the web server when you make code changes.
9
+ config.cache_classes = false
10
+
11
+ # Do not eager load code on boot.
12
+ config.eager_load = false
13
+
14
+ # Show full error reports.
15
+ config.consider_all_requests_local = true
16
+
17
+ # Enable/disable caching. By default caching is disabled.
18
+ # Run rails dev:cache to toggle caching.
19
+ if Rails.root.join('tmp', 'caching-dev.txt').exist?
20
+ config.cache_store = :memory_store
21
+ config.public_file_server.headers = {
22
+ 'Cache-Control' => "public, max-age=#{2.days.to_i}"
23
+ }
24
+ else
25
+ config.action_controller.perform_caching = false
26
+
27
+ config.cache_store = :null_store
28
+ end
29
+
30
+ # Store uploaded files on the local file system (see config/storage.yml for options).
31
+ config.active_storage.service = :local
32
+
33
+ # Don't care if the mailer can't send.
34
+ config.action_mailer.raise_delivery_errors = false
35
+
36
+ config.action_mailer.perform_caching = false
37
+
38
+ # Print deprecation notices to the Rails logger.
39
+ config.active_support.deprecation = :log
40
+
41
+ # Raise exceptions for disallowed deprecations.
42
+ config.active_support.disallowed_deprecation = :raise
43
+
44
+ # Tell Active Support which deprecation messages to disallow.
45
+ config.active_support.disallowed_deprecation_warnings = []
46
+
47
+ # Raise an error on page load if there are pending migrations.
48
+ config.active_record.migration_error = :page_load
49
+
50
+ # Highlight code that triggered database queries in logs.
51
+ config.active_record.verbose_query_logs = true
52
+
53
+
54
+ # Raises error for missing translations.
55
+ # config.i18n.raise_on_missing_translations = true
56
+
57
+ # Annotate rendered view with file names.
58
+ # config.action_view.annotate_rendered_view_with_filenames = true
59
+
60
+ # Use an evented file watcher to asynchronously detect changes in source code,
61
+ # routes, locales, etc. This feature depends on the listen gem.
62
+ # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
63
+
64
+ # Uncomment if you wish to allow Action Cable access from any origin.
65
+ # config.action_cable.disable_request_forgery_protection = true
66
+ end
@@ -0,0 +1,113 @@
1
+ require "active_support/core_ext/integer/time"
2
+
3
+ Rails.application.configure do
4
+ # Settings specified here will take precedence over those in config/application.rb.
5
+
6
+ # Code is not reloaded between requests.
7
+ config.cache_classes = true
8
+
9
+ # Eager load code on boot. This eager loads most of Rails and
10
+ # your application in memory, allowing both threaded web servers
11
+ # and those relying on copy on write to perform better.
12
+ # Rake tasks automatically ignore this option for performance.
13
+ config.eager_load = true
14
+
15
+ # Full error reports are disabled and caching is turned on.
16
+ config.consider_all_requests_local = false
17
+
18
+ # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
19
+ # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
20
+ # config.require_master_key = true
21
+
22
+ # Disable serving static files from the `/public` folder by default since
23
+ # Apache or NGINX already handles this.
24
+ config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
25
+
26
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
27
+ # config.asset_host = 'http://assets.example.com'
28
+
29
+ # Specifies the header that your server uses for sending files.
30
+ # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
31
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
32
+
33
+ # Store uploaded files on the local file system (see config/storage.yml for options).
34
+ config.active_storage.service = :local
35
+
36
+ # Mount Action Cable outside main process or domain.
37
+ # config.action_cable.mount_path = nil
38
+ # config.action_cable.url = 'wss://example.com/cable'
39
+ # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
40
+
41
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
42
+ # config.force_ssl = true
43
+
44
+ # Include generic and useful information about system operation, but avoid logging too much
45
+ # information to avoid inadvertent exposure of personally identifiable information (PII).
46
+ config.log_level = :info
47
+
48
+ # Prepend all log lines with the following tags.
49
+ config.log_tags = [ :request_id ]
50
+
51
+ # Use a different cache store in production.
52
+ # config.cache_store = :mem_cache_store
53
+
54
+ # Use a real queuing backend for Active Job (and separate queues per environment).
55
+ # config.active_job.queue_adapter = :resque
56
+ # config.active_job.queue_name_prefix = "dummy_production"
57
+
58
+ config.action_mailer.perform_caching = false
59
+
60
+ # Ignore bad email addresses and do not raise email delivery errors.
61
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
62
+ # config.action_mailer.raise_delivery_errors = false
63
+
64
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
65
+ # the I18n.default_locale when a translation cannot be found).
66
+ config.i18n.fallbacks = true
67
+
68
+ # Send deprecation notices to registered listeners.
69
+ config.active_support.deprecation = :notify
70
+
71
+ # Log disallowed deprecations.
72
+ config.active_support.disallowed_deprecation = :log
73
+
74
+ # Tell Active Support which deprecation messages to disallow.
75
+ config.active_support.disallowed_deprecation_warnings = []
76
+
77
+ # Use default logging formatter so that PID and timestamp are not suppressed.
78
+ config.log_formatter = ::Logger::Formatter.new
79
+
80
+ # Use a different logger for distributed setups.
81
+ # require "syslog/logger"
82
+ # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
83
+
84
+ if ENV["RAILS_LOG_TO_STDOUT"].present?
85
+ logger = ActiveSupport::Logger.new(STDOUT)
86
+ logger.formatter = config.log_formatter
87
+ config.logger = ActiveSupport::TaggedLogging.new(logger)
88
+ end
89
+
90
+ # Do not dump schema after migrations.
91
+ config.active_record.dump_schema_after_migration = false
92
+
93
+ # Inserts middleware to perform automatic connection switching.
94
+ # The `database_selector` hash is used to pass options to the DatabaseSelector
95
+ # middleware. The `delay` is used to determine how long to wait after a write
96
+ # to send a subsequent read to the primary.
97
+ #
98
+ # The `database_resolver` class is used by the middleware to determine which
99
+ # database is appropriate to use based on the time delay.
100
+ #
101
+ # The `database_resolver_context` class is used by the middleware to set
102
+ # timestamps for the last write to the primary. The resolver uses the context
103
+ # class timestamps to determine how long to wait before reading from the
104
+ # replica.
105
+ #
106
+ # By default Rails will store a last write timestamp in the session. The
107
+ # DatabaseSelector middleware is designed as such you can define your own
108
+ # strategy for connection switching and pass that into the middleware through
109
+ # these configuration options.
110
+ # config.active_record.database_selector = { delay: 2.seconds }
111
+ # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
112
+ # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
113
+ end
@@ -0,0 +1,59 @@
1
+ require "active_support/core_ext/integer/time"
2
+
3
+ # The test environment is used exclusively to run your application's
4
+ # test suite. You never need to work with it otherwise. Remember that
5
+ # your test database is "scratch space" for the test suite and is wiped
6
+ # and recreated between test runs. Don't rely on the data there!
7
+
8
+ Rails.application.configure do
9
+ # Settings specified here will take precedence over those in config/application.rb.
10
+
11
+ config.cache_classes = true
12
+
13
+ # Do not eager load code on boot. This avoids loading your whole application
14
+ # just for the purpose of running a single test. If you are using a tool that
15
+ # preloads Rails for running tests, you may have to set it to true.
16
+ config.eager_load = false
17
+
18
+ # Configure public file server for tests with Cache-Control for performance.
19
+ config.public_file_server.enabled = true
20
+ config.public_file_server.headers = {
21
+ 'Cache-Control' => "public, max-age=#{1.hour.to_i}"
22
+ }
23
+
24
+ # Show full error reports and disable caching.
25
+ config.consider_all_requests_local = true
26
+ config.action_controller.perform_caching = false
27
+ config.cache_store = :null_store
28
+
29
+ # Raise exceptions instead of rendering exception templates.
30
+ config.action_dispatch.show_exceptions = false
31
+
32
+ # Disable request forgery protection in test environment.
33
+ config.action_controller.allow_forgery_protection = false
34
+
35
+ # Store uploaded files on the local file system in a temporary directory.
36
+ config.active_storage.service = :test
37
+
38
+ config.action_mailer.perform_caching = false
39
+
40
+ # Tell Action Mailer not to deliver emails to the real world.
41
+ # The :test delivery method accumulates sent emails in the
42
+ # ActionMailer::Base.deliveries array.
43
+ config.action_mailer.delivery_method = :test
44
+
45
+ # Print deprecation notices to the stderr.
46
+ config.active_support.deprecation = :stderr
47
+
48
+ # Raise exceptions for disallowed deprecations.
49
+ config.active_support.disallowed_deprecation = :raise
50
+
51
+ # Tell Active Support which deprecation messages to disallow.
52
+ config.active_support.disallowed_deprecation_warnings = []
53
+
54
+ # Raises error for missing translations.
55
+ # config.i18n.raise_on_missing_translations = true
56
+
57
+ # Annotate rendered view with file names.
58
+ # config.action_view.annotate_rendered_view_with_filenames = true
59
+ end
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # ActiveSupport::Reloader.to_prepare do
4
+ # ApplicationController.renderer.defaults.merge!(
5
+ # http_host: 'example.org',
6
+ # https: false
7
+ # )
8
+ # end
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| /my_noisy_library/.match?(line) }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code
7
+ # by setting BACKTRACE=1 before calling your invocation, like "BACKTRACE=1 ./bin/rails runner 'MyClass.perform'".
8
+ Rails.backtrace_cleaner.remove_silencers! if ENV["BACKTRACE"]
@@ -0,0 +1,16 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Avoid CORS issues when API is called from the frontend app.
4
+ # Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
5
+
6
+ # Read more: https://github.com/cyu/rack-cors
7
+
8
+ # Rails.application.config.middleware.insert_before 0, Rack::Cors do
9
+ # allow do
10
+ # origins 'example.com'
11
+ #
12
+ # resource '*',
13
+ # headers: :any,
14
+ # methods: [:get, :post, :put, :patch, :delete, :options, :head]
15
+ # end
16
+ # end
@@ -0,0 +1,6 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Configure sensitive parameters which will be filtered from the log file.
4
+ Rails.application.config.filter_parameters += [
5
+ :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
6
+ ]
@@ -0,0 +1,16 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format. Inflections
4
+ # are locale specific, and you may define rules for as many different
5
+ # locales as you wish. All of these examples are active by default:
6
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
7
+ # inflect.plural /^(ox)$/i, '\1en'
8
+ # inflect.singular /^(ox)en/i, '\1'
9
+ # inflect.irregular 'person', 'people'
10
+ # inflect.uncountable %w( fish sheep )
11
+ # end
12
+
13
+ # These inflection rules are supported but not enabled by default:
14
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
15
+ # inflect.acronym 'RESTful'
16
+ # end
@@ -0,0 +1,4 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
@@ -0,0 +1 @@
1
+ Redis.current ||= Redis.new(url: ENV['REDIS_URL'])
@@ -0,0 +1,14 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # This file contains settings for ActionController::ParamsWrapper which
4
+ # is enabled by default.
5
+
6
+ # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7
+ ActiveSupport.on_load(:action_controller) do
8
+ wrap_parameters format: [:json]
9
+ end
10
+
11
+ # To enable root element in JSON for ActiveRecord objects.
12
+ # ActiveSupport.on_load(:active_record) do
13
+ # self.include_root_in_json = true
14
+ # end
@@ -0,0 +1,33 @@
1
+ # Files in the config/locales directory are used for internationalization
2
+ # and are automatically loaded by Rails. If you want to use locales other
3
+ # than English, add the necessary files in this directory.
4
+ #
5
+ # To use the locales, use `I18n.t`:
6
+ #
7
+ # I18n.t 'hello'
8
+ #
9
+ # In views, this is aliased to just `t`:
10
+ #
11
+ # <%= t('hello') %>
12
+ #
13
+ # To use a different locale, set it with `I18n.locale`:
14
+ #
15
+ # I18n.locale = :es
16
+ #
17
+ # This would use the information in config/locales/es.yml.
18
+ #
19
+ # The following keys must be escaped otherwise they will not be retrieved by
20
+ # the default I18n backend:
21
+ #
22
+ # true, false, on, off, yes, no
23
+ #
24
+ # Instead, surround them with single quotes.
25
+ #
26
+ # en:
27
+ # 'true': 'foo'
28
+ #
29
+ # To learn more, please read the Rails Internationalization guide
30
+ # available at https://guides.rubyonrails.org/i18n.html.
31
+
32
+ en:
33
+ hello: "Hello world"