govuk_app_config 4.0.0.pre.3 → 4.0.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64e3b5e80cdc107dd26911c7bf2cf9e298fe37fbb7b7cc28b3c860f74424843e
-  data.tar.gz: 45051a0d49d02e14b1385894ac53f61ebdaffa11f9379c6f2ac7c1c5752d0794
+  metadata.gz: 494d23c9b999e7cfd6a7e2fac76f1a52cdf70aa5b7c62509e48693c13bb07d7c
+  data.tar.gz: ccd962b2f670063ead978e49f38affcf925b1e05a47b4a97066b88b5243dcbaa
 SHA512:
-  metadata.gz: 33ac4913c546cbf10958b1efca95792886bb4d2dac81aa4303bea4343515d23fabedc94e272a5aa6383cff6c27448d4bcd8ceda27d4329f7be3dbb651f86ca79
-  data.tar.gz: aee0bd0ff3a81e6ade12461b81a10073c903eb7c35762f744c89d4feec0fe5f933bcb20609e75add6b94d8e60c0c49d836527517c8defcdcc3ee23856143be02
+  metadata.gz: 624aefd37a2c76460bfecdbf17071991fa3745249ac27b9bb6026bc67e4e335cd94bdf67d82f8521557c8661fca36ced879a68a346bfe592786e88df0f06ddbe
+  data.tar.gz: 7cbbc37819f1b176dde9d4d90bf71b333621cdfabfd042b2fe439223aa47a98c43713b86f2784c6ced2c43a9f28cb01bf83f021e724de7def9e4a7a74dd0c264

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 4.0.0.pre.4
+
+- Fix Sentry client initialisation ([#205](https://github.com/alphagov/govuk_app_config/pull/205)).
+- BREAKING: non-Rails apps will need to manually call `GovukError.configure` in order to initialise Sentry.
+- BREAKING: `GovukError.configure` can only be called once by the downstream application.
+
 # 4.0.0.pre.3
 
 - Include [sentry-rails](https://github.com/getsentry/sentry-ruby/tree/master/sentry-rails) by default ([#203](https://github.com/alphagov/govuk_app_config/pull/203)).

data/README.md

@@ -87,7 +87,7 @@ You can add your environment to the list of active Sentry environments like so:
 
 ```ruby
 GovukError.configure do |config|
-  config.active_sentry_environments << "my-test-environment"
+  config.enabled_environments << "my-test-environment"
 end
 ```
 

data/lib/govuk_app_config.rb

@@ -1,7 +1,6 @@
 require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
-require "govuk_app_config/govuk_error/configure"
 require "govuk_app_config/govuk_healthcheck"
 require "govuk_app_config/govuk_i18n"
 # This require is deprecated and should be removed on next major version bump

data/lib/govuk_app_config/govuk_error.rb

@@ -5,6 +5,12 @@ require "govuk_app_config/govuk_error/configuration"
 require "govuk_app_config/version"
 
 module GovukError
+  class AlreadyInitialised < StandardError
+    def initialize(msg = "You can only call GovukError.configure once!")
+      super
+    end
+  end
+
   def self.notify(exception_or_message, args = {})
     # Allow users to use `parameters` as a key like the Airbrake
     # client, allowing easy upgrades.
@@ -14,11 +20,23 @@ module GovukError
     args[:tags] ||= {}
     args[:tags][:govuk_app_config_version] = GovukAppConfig::VERSION
 
-    Sentry.capture_exception(exception_or_message, args)
+    if exception_or_message.is_a?(String)
+      Sentry.capture_message(exception_or_message, args)
+    else
+      Sentry.capture_exception(exception_or_message, args)
+    end
+  end
+
+  def self.is_configured?
+    Sentry.get_current_client != nil
   end
 
   def self.configure
-    @configuration ||= Configuration.new(Sentry::Configuration.new)
-    yield @configuration
+    raise GovukError::AlreadyInitialised if is_configured?
+
+    Sentry.init do |sentry_config|
+      config = Configuration.new(sentry_config)
+      yield config if block_given?
+    end
   end
 end

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -3,20 +3,82 @@ require "govuk_app_config/govuk_error/govuk_data_sync"
 
 module GovukError
   class Configuration < SimpleDelegator
-    attr_reader :data_sync, :sentry_environment
-    attr_accessor :active_sentry_environments, :data_sync_excluded_exceptions
+    attr_reader :data_sync
+    attr_accessor :data_sync_excluded_exceptions
 
     def initialize(_sentry_configuration)
       super
-      @sentry_environment = ENV["SENTRY_CURRENT_ENV"]
       @data_sync = GovukDataSync.new(ENV["GOVUK_DATA_SYNC_PERIOD"])
-      self.active_sentry_environments = []
-      self.data_sync_excluded_exceptions = []
+      set_up_defaults
+    end
+
+    def set_up_defaults
+      # These are the environments (described by the `SENTRY_CURRENT_ENV`
+      # ENV variable) where we want to capture Sentry errors. If
+      # `SENTRY_CURRENT_ENV` isn't in this list, or isn't defined, then
+      # don't capture the error.
+      self.enabled_environments = %w[
+        integration-blue-aws
+        staging
+        production
+      ]
+
+      self.excluded_exceptions = [
+        # Default ActionDispatch rescue responses
+        "ActionController::RoutingError",
+        "AbstractController::ActionNotFound",
+        "ActionController::MethodNotAllowed",
+        "ActionController::UnknownHttpMethod",
+        "ActionController::NotImplemented",
+        "ActionController::UnknownFormat",
+        "Mime::Type::InvalidMimeType",
+        "ActionController::MissingExactTemplate",
+        "ActionController::InvalidAuthenticityToken",
+        "ActionController::InvalidCrossOriginRequest",
+        "ActionDispatch::Http::Parameters::ParseError",
+        "ActionController::BadRequest",
+        "ActionController::ParameterMissing",
+        "Rack::QueryParser::ParameterTypeError",
+        "Rack::QueryParser::InvalidParameterError",
+        # Default ActiveRecord rescue responses
+        "ActiveRecord::RecordNotFound",
+        "ActiveRecord::StaleObjectError",
+        "ActiveRecord::RecordInvalid",
+        "ActiveRecord::RecordNotSaved",
+        # Additional items
+        "ActiveJob::DeserializationError",
+        "CGI::Session::CookieStore::TamperedWithCookie",
+        "GdsApi::HTTPIntermittentServerError",
+        "GdsApi::TimedOutException",
+        "Mongoid::Errors::DocumentNotFound",
+        "Sinatra::NotFound",
+        "Slimmer::IntermittentRetrievalError",
+      ]
+
+      # This will exclude exceptions that are triggered by one of the ignored
+      # exceptions. For example, when any exception occurs in a template,
+      # Rails will raise a ActionView::Template::Error, instead of the original error.
+      self.inspect_exception_causes_for_exclusion = true
+
+      # List of exceptions to ignore if they take place during the data sync.
+      # Some errors are transient in nature, e.g. PostgreSQL databases being
+      # unavailable, and add little value. In fact, their presence can greatly
+      # increase the number of errors being sent and risk genuine errors being
+      # rate-limited by Sentry.
+      self.data_sync_excluded_exceptions = [
+        "PG::Error",
+        "GdsApi::ContentStore::ItemNotFound",
+      ]
+
       @before_send_callbacks = [
-        ignore_exceptions_if_not_in_active_sentry_env,
         ignore_excluded_exceptions_in_data_sync,
         increment_govuk_statsd_counters,
       ]
+      # Need to invoke an arbitrary `before_send=` in order to trigger the
+      # `before_send_callbacks` behaviour
+      self.before_send = lambda { |error_or_event, _hint|
+        error_or_event
+      }
     end
 
     def before_send=(closure)
@@ -26,10 +88,6 @@ module GovukError
 
   protected
 
-    def ignore_exceptions_if_not_in_active_sentry_env
-      ->(event, _hint) { event if active_sentry_environments.include?(sentry_environment) }
-    end
-
     def ignore_excluded_exceptions_in_data_sync
       lambda { |event, hint|
         data_sync_ignored_error = data_sync_excluded_exceptions.any? do |exception_to_ignore|

data/lib/govuk_app_config/railtie.rb

@@ -3,5 +3,9 @@ module GovukAppConfig
     config.before_initialize do
       GovukLogging.configure if Rails.env.production?
     end
+
+    config.after_initialize do
+      GovukError.configure unless GovukError.is_configured?
+    end
   end
 end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "4.0.0.pre.3".freeze
+  VERSION = "4.0.0.pre.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre.3
+  version: 4.0.0.pre.4
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -244,7 +244,6 @@ files:
 - lib/govuk_app_config/govuk_content_security_policy.rb
 - lib/govuk_app_config/govuk_error.rb
 - lib/govuk_app_config/govuk_error/configuration.rb
-- lib/govuk_app_config/govuk_error/configure.rb
 - lib/govuk_app_config/govuk_error/govuk_data_sync.rb
 - lib/govuk_app_config/govuk_healthcheck.rb
 - lib/govuk_app_config/govuk_healthcheck/active_record.rb

data/lib/govuk_app_config/govuk_error/configure.rb

@@ -1,62 +0,0 @@
-GovukError.configure do |config|
-  # These are the environments (described by the `SENTRY_CURRENT_ENV`
-  # ENV variable) where we want to capture Sentry errors. If
-  # `SENTRY_CURRENT_ENV` isn't in this list, or isn't defined, then
-  # don't capture the error.
-  config.active_sentry_environments = %w[
-    integration-blue-aws
-    staging
-    production
-  ]
-
-  config.excluded_exceptions = [
-    # Default ActionDispatch rescue responses
-    "ActionController::RoutingError",
-    "AbstractController::ActionNotFound",
-    "ActionController::MethodNotAllowed",
-    "ActionController::UnknownHttpMethod",
-    "ActionController::NotImplemented",
-    "ActionController::UnknownFormat",
-    "Mime::Type::InvalidMimeType",
-    "ActionController::MissingExactTemplate",
-    "ActionController::InvalidAuthenticityToken",
-    "ActionController::InvalidCrossOriginRequest",
-    "ActionDispatch::Http::Parameters::ParseError",
-    "ActionController::BadRequest",
-    "ActionController::ParameterMissing",
-    "Rack::QueryParser::ParameterTypeError",
-    "Rack::QueryParser::InvalidParameterError",
-    # Default ActiveRecord rescue responses
-    "ActiveRecord::RecordNotFound",
-    "ActiveRecord::StaleObjectError",
-    "ActiveRecord::RecordInvalid",
-    "ActiveRecord::RecordNotSaved",
-    # Additional items
-    "ActiveJob::DeserializationError",
-    "CGI::Session::CookieStore::TamperedWithCookie",
-    "GdsApi::HTTPIntermittentServerError",
-    "GdsApi::TimedOutException",
-    "Mongoid::Errors::DocumentNotFound",
-    "Sinatra::NotFound",
-    "Slimmer::IntermittentRetrievalError",
-  ]
-
-  # This will exclude exceptions that are triggered by one of the ignored
-  # exceptions. For example, when any exception occurs in a template,
-  # Rails will raise a ActionView::Template::Error, instead of the original error.
-  config.inspect_exception_causes_for_exclusion = true
-
-  # List of exceptions to ignore if they take place during the data sync.
-  # Some errors are transient in nature, e.g. PostgreSQL databases being
-  # unavailable, and add little value. In fact, their presence can greatly
-  # increase the number of errors being sent and risk genuine errors being
-  # rate-limited by Sentry.
-  config.data_sync_excluded_exceptions = [
-    "PG::Error",
-    "GdsApi::ContentStore::ItemNotFound",
-  ]
-
-  config.before_send = lambda { |error_or_event, _hint|
-    error_or_event
-  }
-end