From 9a5a38a529dfdb7579a015845c01a80679923f17 Mon Sep 17 00:00:00 2001 From: Krzysztof Kotlarek Date: Fri, 12 Mar 2021 08:42:53 +1100 Subject: [PATCH] FIX: deprecation warning - initialization autoloaded the constant (#12347) Get rid of deprecation related to Zeitwerk autoloader. --- config/application.rb | 3 + config/initializers/002-freedom_patches.rb | 6 +- config/initializers/005-site_settings.rb | 34 +-- config/initializers/100-i18n.rb | 20 +- config/initializers/100-logster.rb | 250 +++++++++--------- .../zeitwerk.rb => zeitwerk_config.rb} | 0 6 files changed, 163 insertions(+), 150 deletions(-) rename lib/{freedom_patches/zeitwerk.rb => zeitwerk_config.rb} (100%) diff --git a/config/application.rb b/config/application.rb index 00a93c6a262..111c989f899 100644 --- a/config/application.rb +++ b/config/application.rb @@ -55,6 +55,8 @@ require 'pry-rails' if Rails.env.development? require 'discourse_fonts' +require_relative '../lib/zeitwerk_config.rb' + if defined?(Bundler) bundler_groups = [:default] @@ -116,6 +118,7 @@ module Discourse config.autoload_paths += Dir["#{config.root}/lib/validators/"] Rails.autoloaders.main.ignore(Dir["#{config.root}/app/models/reports"]) + Rails.autoloaders.main.ignore(Dir["#{config.root}/lib/freedom_patches"]) # Only load the plugins named here, in the order given (default is alphabetical). # :all can be used as a placeholder for all plugins not explicitly named. diff --git a/config/initializers/002-freedom_patches.rb b/config/initializers/002-freedom_patches.rb index 255652ba206..520e82ac295 100644 --- a/config/initializers/002-freedom_patches.rb +++ b/config/initializers/002-freedom_patches.rb @@ -1,5 +1,7 @@ # frozen_string_literal: true -Dir["#{Rails.root}/lib/freedom_patches/*.rb"].each do |f| - require(f) +Rails.application.reloader.to_prepare do + Dir["#{Rails.root}/lib/freedom_patches/*.rb"].each do |f| + require(f) + end end diff --git a/config/initializers/005-site_settings.rb b/config/initializers/005-site_settings.rb index 4ecaa85df33..f437b739883 100644 --- a/config/initializers/005-site_settings.rb +++ b/config/initializers/005-site_settings.rb @@ -16,24 +16,26 @@ if GlobalSetting.skip_redis? return end -reload_settings = lambda { - RailsMultisite::ConnectionManagement.safe_each_connection do - begin - SiteSetting.refresh! +Rails.application.reloader.to_prepare do + reload_settings = lambda { + RailsMultisite::ConnectionManagement.safe_each_connection do + begin + SiteSetting.refresh! - unless String === SiteSetting.push_api_secret_key && SiteSetting.push_api_secret_key.length == 32 - SiteSetting.push_api_secret_key = SecureRandom.hex + unless String === SiteSetting.push_api_secret_key && SiteSetting.push_api_secret_key.length == 32 + SiteSetting.push_api_secret_key = SecureRandom.hex + end + rescue ActiveRecord::StatementInvalid + # This will happen when migrating a new database end - rescue ActiveRecord::StatementInvalid - # This will happen when migrating a new database + end + } + + reload_settings.call + + if !Rails.configuration.cache_classes + ActiveSupport::Reloader.to_prepare do + reload_settings.call end end -} - -reload_settings.call - -if !Rails.configuration.cache_classes - ActiveSupport::Reloader.to_prepare do - reload_settings.call - end end diff --git a/config/initializers/100-i18n.rb b/config/initializers/100-i18n.rb index 739fca222dd..1a49029738f 100644 --- a/config/initializers/100-i18n.rb +++ b/config/initializers/100-i18n.rb @@ -5,15 +5,17 @@ require 'i18n/backend/discourse_i18n' require 'i18n/backend/fallback_locale_list' -I18n.backend = I18n::Backend::DiscourseI18n.new -I18n.fallbacks = I18n::Backend::FallbackLocaleList.new -I18n.config.missing_interpolation_argument_handler = proc { throw(:exception) } -I18n.reload! -I18n.init_accelerator!(overrides_enabled: ENV['DISABLE_TRANSLATION_OVERRIDES'] != '1') +Rails.application.reloader.to_prepare do + I18n.backend = I18n::Backend::DiscourseI18n.new + I18n.fallbacks = I18n::Backend::FallbackLocaleList.new + I18n.config.missing_interpolation_argument_handler = proc { throw(:exception) } + I18n.reload! + I18n.init_accelerator!(overrides_enabled: ENV['DISABLE_TRANSLATION_OVERRIDES'] != '1') -unless Rails.env.test? - MessageBus.subscribe("/i18n-flush") do - I18n.reload! - ExtraLocalesController.clear_cache! + unless Rails.env.test? + MessageBus.subscribe("/i18n-flush") do + I18n.reload! + ExtraLocalesController.clear_cache! + end end end diff --git a/config/initializers/100-logster.rb b/config/initializers/100-logster.rb index 099747ae82a..5b89d984f58 100644 --- a/config/initializers/100-logster.rb +++ b/config/initializers/100-logster.rb @@ -1,148 +1,152 @@ # frozen_string_literal: true if GlobalSetting.skip_redis? - if Rails.logger.respond_to? :chained - Rails.logger = Rails.logger.chained.first + Rails.application.reloader.to_prepare do + if Rails.logger.respond_to? :chained + Rails.logger = Rails.logger.chained.first + end end return end -if Rails.env.development? && RUBY_VERSION.match?(/^2\.5\.[23]/) - STDERR.puts "WARNING: Discourse development environment runs slower on Ruby 2.5.3 or below" - STDERR.puts "We recommend you upgrade to Ruby 2.6.1 for the optimal development performance" +Rails.application.reloader.to_prepare do + if Rails.env.development? && RUBY_VERSION.match?(/^2\.5\.[23]/) + STDERR.puts "WARNING: Discourse development environment runs slower on Ruby 2.5.3 or below" + STDERR.puts "We recommend you upgrade to Ruby 2.6.1 for the optimal development performance" - # we have to used to older and slower version of the logger cause the new one exposes a Ruby bug in - # the Queue class which causes segmentation faults - Logster::Scheduler.disable -end - -if Rails.env.development? && !Sidekiq.server? && ENV["RAILS_LOGS_STDOUT"] == "1" - console = ActiveSupport::Logger.new(STDOUT) - original_logger = Rails.logger.chained.first - console.formatter = original_logger.formatter - console.level = original_logger.level - - unless ActiveSupport::Logger.logger_outputs_to?(original_logger, STDOUT) - original_logger.extend(ActiveSupport::Logger.broadcast(console)) + # we have to used to older and slower version of the logger cause the new one exposes a Ruby bug in + # the Queue class which causes segmentation faults + Logster::Scheduler.disable end -end -if Rails.env.production? - Logster.store.ignore = [ - # honestly, Rails should not be logging this, its real noisy - /^ActionController::RoutingError \(No route matches/, + if Rails.env.development? && !Sidekiq.server? && ENV["RAILS_LOGS_STDOUT"] == "1" + console = ActiveSupport::Logger.new(STDOUT) + original_logger = Rails.logger.chained.first + console.formatter = original_logger.formatter + console.level = original_logger.level - /^PG::Error: ERROR:\s+duplicate key/, + unless ActiveSupport::Logger.logger_outputs_to?(original_logger, STDOUT) + original_logger.extend(ActiveSupport::Logger.broadcast(console)) + end + end - /^ActionController::UnknownFormat/, - /^ActionController::UnknownHttpMethod/, - /^AbstractController::ActionNotFound/, - # ignore any empty JS errors that contain blanks or zeros for line and column fields - # - # Line: - # Column: - # - /(?m).*?Line: (?:\D|0).*?Column: (?:\D|0)/, + if Rails.env.production? + Logster.store.ignore = [ + # honestly, Rails should not be logging this, its real noisy + /^ActionController::RoutingError \(No route matches/, - # suppress empty JS errors (covers MSIE 9, etc) - /^(Syntax|Script) error.*Line: (0|1)\b/m, + /^PG::Error: ERROR:\s+duplicate key/, - # CSRF errors are not providing enough data - # suppress unconditionally for now - /^Can't verify CSRF token authenticity.$/, + /^ActionController::UnknownFormat/, + /^ActionController::UnknownHttpMethod/, + /^AbstractController::ActionNotFound/, + # ignore any empty JS errors that contain blanks or zeros for line and column fields + # + # Line: + # Column: + # + /(?m).*?Line: (?:\D|0).*?Column: (?:\D|0)/, - # Yandex bot triggers this JS error a lot - /^Uncaught ReferenceError: I18n is not defined/, + # suppress empty JS errors (covers MSIE 9, etc) + /^(Syntax|Script) error.*Line: (0|1)\b/m, - # related to browser plugins somehow, we don't care - /Error calling method on NPObject/, + # CSRF errors are not providing enough data + # suppress unconditionally for now + /^Can't verify CSRF token authenticity.$/, - # 404s can be dealt with elsewhere - /^ActiveRecord::RecordNotFound/, + # Yandex bot triggers this JS error a lot + /^Uncaught ReferenceError: I18n is not defined/, - # bad asset requested, no need to log - /^ActionController::BadRequest/, + # related to browser plugins somehow, we don't care + /Error calling method on NPObject/, - # we can't do anything about invalid parameters - /Rack::QueryParser::InvalidParameterError/, + # 404s can be dealt with elsewhere + /^ActiveRecord::RecordNotFound/, - # we handle this cleanly in the message bus middleware - # no point logging to logster - /RateLimiter::LimitExceeded.*/m, + # bad asset requested, no need to log + /^ActionController::BadRequest/, - # see https://github.com/rails/rails/issues/34599 - # Poll defines an enum with the value `open` ActiveRecord then attempts - # AR then warns cause #open is being redefined, it is already defined - # privately in Kernel per: http://ruby-doc.org/core-2.5.3/Kernel.html#method-i-open - # Once the rails issue is fixed we can stop this error suppression and stop defining - # scopes for the enums - /^Creating scope :open\. Overwriting existing method Poll\.open\./, + # we can't do anything about invalid parameters + /Rack::QueryParser::InvalidParameterError/, + + # we handle this cleanly in the message bus middleware + # no point logging to logster + /RateLimiter::LimitExceeded.*/m, + + # see https://github.com/rails/rails/issues/34599 + # Poll defines an enum with the value `open` ActiveRecord then attempts + # AR then warns cause #open is being redefined, it is already defined + # privately in Kernel per: http://ruby-doc.org/core-2.5.3/Kernel.html#method-i-open + # Once the rails issue is fixed we can stop this error suppression and stop defining + # scopes for the enums + /^Creating scope :open\. Overwriting existing method Poll\.open\./, + ] + Logster.config.env_expandable_keys.push(:hostname, :problem_db) + end + + Logster.store.max_backlog = GlobalSetting.max_logster_logs + + # TODO logster should be able to do this automatically + Logster.config.subdirectory = "#{GlobalSetting.relative_url_root}/logs" + + Logster.config.application_version = Discourse.git_version + Logster.config.enable_custom_patterns_via_ui = true + Logster.config.enable_js_error_reporting = GlobalSetting.enable_js_error_reporting + + store = Logster.store + redis = Logster.store.redis + store.redis_prefix = Proc.new { redis.namespace } + store.redis_raw_connection = redis.without_namespace + severities = [Logger::WARN, Logger::ERROR, Logger::FATAL, Logger::UNKNOWN] + + RailsMultisite::ConnectionManagement.each_connection do + error_rate_per_minute = SiteSetting.alert_admins_if_errors_per_minute rescue 0 + + if (error_rate_per_minute || 0) > 0 + store.register_rate_limit_per_minute(severities, error_rate_per_minute) do |rate| + MessageBus.publish("/logs_error_rate_exceeded", + { + rate: rate, + duration: 'minute', + publish_at: Time.current.to_i + }, + group_ids: [Group::AUTO_GROUPS[:admins]] + ) + end + end + + error_rate_per_hour = SiteSetting.alert_admins_if_errors_per_hour rescue 0 + + if (error_rate_per_hour || 0) > 0 + store.register_rate_limit_per_hour(severities, error_rate_per_hour) do |rate| + MessageBus.publish("/logs_error_rate_exceeded", + { + rate: rate, + duration: 'hour', + publish_at: Time.current.to_i, + }, + group_ids: [Group::AUTO_GROUPS[:admins]] + ) + end + end + end + + if Rails.configuration.multisite + if Rails.logger.respond_to? :chained + chained = Rails.logger.chained + chained && chained.first.formatter = RailsMultisite::Formatter.new + end + end + + Logster.config.project_directories = [ + { path: Rails.root.to_s, url: "https://github.com/discourse/discourse", main_app: true } ] - Logster.config.env_expandable_keys.push(:hostname, :problem_db) -end + Discourse.plugins.each do |plugin| + next if !plugin.metadata.url -Logster.store.max_backlog = GlobalSetting.max_logster_logs - -# TODO logster should be able to do this automatically -Logster.config.subdirectory = "#{GlobalSetting.relative_url_root}/logs" - -Logster.config.application_version = Discourse.git_version -Logster.config.enable_custom_patterns_via_ui = true -Logster.config.enable_js_error_reporting = GlobalSetting.enable_js_error_reporting - -store = Logster.store -redis = Logster.store.redis -store.redis_prefix = Proc.new { redis.namespace } -store.redis_raw_connection = redis.without_namespace -severities = [Logger::WARN, Logger::ERROR, Logger::FATAL, Logger::UNKNOWN] - -RailsMultisite::ConnectionManagement.each_connection do - error_rate_per_minute = SiteSetting.alert_admins_if_errors_per_minute rescue 0 - - if (error_rate_per_minute || 0) > 0 - store.register_rate_limit_per_minute(severities, error_rate_per_minute) do |rate| - MessageBus.publish("/logs_error_rate_exceeded", - { - rate: rate, - duration: 'minute', - publish_at: Time.current.to_i - }, - group_ids: [Group::AUTO_GROUPS[:admins]] - ) - end - end - - error_rate_per_hour = SiteSetting.alert_admins_if_errors_per_hour rescue 0 - - if (error_rate_per_hour || 0) > 0 - store.register_rate_limit_per_hour(severities, error_rate_per_hour) do |rate| - MessageBus.publish("/logs_error_rate_exceeded", - { - rate: rate, - duration: 'hour', - publish_at: Time.current.to_i, - }, - group_ids: [Group::AUTO_GROUPS[:admins]] - ) - end + Logster.config.project_directories << { + path: "#{Rails.root.to_s}/plugins/#{plugin.directory_name}", + url: plugin.metadata.url + } end end - -if Rails.configuration.multisite - if Rails.logger.respond_to? :chained - chained = Rails.logger.chained - chained && chained.first.formatter = RailsMultisite::Formatter.new - end -end - -Logster.config.project_directories = [ - { path: Rails.root.to_s, url: "https://github.com/discourse/discourse", main_app: true } -] -Discourse.plugins.each do |plugin| - next if !plugin.metadata.url - - Logster.config.project_directories << { - path: "#{Rails.root.to_s}/plugins/#{plugin.directory_name}", - url: plugin.metadata.url - } -end diff --git a/lib/freedom_patches/zeitwerk.rb b/lib/zeitwerk_config.rb similarity index 100% rename from lib/freedom_patches/zeitwerk.rb rename to lib/zeitwerk_config.rb