govuk_app_config 6.0.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59fb9ea4411ba3ec2be3af84e9888920a6ca07547bfcd199d00b9c921a461639
-  data.tar.gz: aeaea12af9e8ca7612d39c002bd5d5658e5683477f667b5a9419bd1f9529feb2
+  metadata.gz: 55aadf4fdd96125cdacca3f50768c74005433fecadc2271248ec9d59973b5f80
+  data.tar.gz: 577a4e8061b5458e912d1ab16236c7011f8695c53fd8427a3378529c482466cc
 SHA512:
-  metadata.gz: c46413f09bb129baefa17951e539b8304faaa85c6eae9c7be8fd410677f322c67b65b091b01918555d450518692dd12348b8212cb039dbae6cd429959f8b818b
-  data.tar.gz: 5bafc15ab122c9088039093ed786420dc080bd7f20265157e536e0388133d44707c4146bd8d619a0926f13883ce8c314371f0985e4ce7087d1998e8d413dc59a
+  metadata.gz: 5736f71ea147e470900633ea0a46625b316703a38d636b18b30b5ad616af62b715f4c990953cc97c7950fdee3f5226629938d1e5f84c06a6373a36a194cda8ff
+  data.tar.gz: af25d35eb1873b93b7848a12f406a4c83dcde832b9af598d2263815bc4be071bf6c20ca5300f23a86102e4afe99cd226687dc3673341960a91059ff75c400111

data/CHANGELOG.md

@@ -1,8 +1,17 @@
-## 6.0.1
+# 7.1.0
+
+* `GovukError` now allows specifying any name for the Sentry environment tag via the `SENTRY_CURRENT_ENV` environment variable. The environment name no longer has to match one of a fixed set of strings in order for `GovukError` to log events to Sentry.
+
+# 7.0.0
+
+* BREAKING: Remove [unicorn](https://rubygems.org/gems/unicorn/) and `GovukUnicorn`. All production GOV.UK apps are now using [Puma](https://rubygems.org/gems/puma/) instead.
+* `GovukStatsd` is deprecated and will be removed in a future major release.
+
+# 6.0.1
 
 * Add support for configuring timeouts for puma-based applications
 
-## 6.0.0
+# 6.0.0
 
 * BREAKING: Drop support for Ruby 2.7
 * Register the Prometheus exporter in Sinatra middleware

data/README.md

@@ -2,12 +2,12 @@
 
 Adds the basics of a GOV.UK application:
 
-- Unicorn as a web server
+- Puma as a web server
 - Error reporting with Sentry
-- Statsd client for reporting stats
+- Prometheus monitoring for EKS
+- Statsd client for reporting stats (deprecated; use Prometheus instead)
 - Rails logging
 - Content Security Policy generation for frontend apps
-- Prometheus monitoring for EKS
 
 ## Installation
 
@@ -17,43 +17,34 @@ Add this line to your application's Gemfile:
 gem "govuk_app_config"
 ```
 
-And then execute:
+Then run `bundle`.
 
-    $ bundle
 
-
-## Unicorn
+## Puma
 
 ### Configuration
 
-Find or create a `config/unicorn.rb` in the app
-
-At the start of the file insert:
+Create a file `config/puma.rb` in the app, containing:
 
 ```rb
-require "govuk_app_config/govuk_unicorn"
-GovukUnicorn.configure(self)
+require "govuk_app_config/govuk_puma"
+GovukPuma.configure_rails(self)
 ```
 
 ### Usage
 
-To serve an app with unicorn run:
+To run an app locally with Puma, run: `bundle exec puma` or `bundle exec rails s`.
 
-```sh
-$ bundle exec unicorn -c config/unicorn.rb
-```
 
 ## Error reporting
 
 ### Automatic error reporting
 
-If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanism will make sure that your application is configured to send errors to Sentry.
-
-Your app will have to have the following environment variables set:
+If you include `govuk_app_config` in your `Gemfile` and set the following environment variables, your application will automatically log errors to Sentry.
 
 - `SENTRY_DSN` - the [Data Source Name (DSN)][dsn] for Sentry
-- `SENTRY_CURRENT_ENV` - e.g. "production". Make sure it is [configured to be active](#active-sentry-environments).
-- `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name.hostname`
+- `SENTRY_CURRENT_ENV` - the `environment` tag to pass to Sentry, for example `production`
+- `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name.hostname` (deprecated; statsd functionality will be removed in a future release)
 
 [dsn]: https://docs.sentry.io/quickstart/#about-the-dsn
 
@@ -80,18 +71,6 @@ GovukError.notify(
 )
 ```
 
-### Active Sentry environments
-
-GovukError will only send errors to Sentry if your `SENTRY_CURRENT_ENV` matches one of the 'active environments' in the [default configuration](https://github.com/alphagov/govuk_app_config/blob/master/lib/govuk_app_config/govuk_error/configure.rb). This is to prevent temporary test environments from flooding our Sentry account with errors.
-
-You can add your environment to the list of active Sentry environments like so:
-
-```ruby
-GovukError.configure do |config|
-  config.enabled_environments << "my-test-environment"
-end
-```
-
 ### Error configuration
 
 You can exclude certain errors from being reported using this:
@@ -125,7 +104,19 @@ end
 
 `GovukError.configure` has the same options as the Sentry client, Raven. See [the Raven docs for all configuration options](https://docs.sentry.io/clients/ruby/config).
 
-## Statsd
+
+## Prometheus monitoring
+
+Create a `/config/initializers/prometheus.rb` file in the app and add the following
+
+```ruby
+require "govuk_app_config/govuk_prometheus_exporter"
+GovukPrometheusExporter.configure
+```
+
+## Statsd (deprecated)
+
+⚠️ Statsd support is deprecated and will be removed in a future major release of govuk_app_config.
 
 Use `GovukStatsd` to send stats to graphite. It has the same interface as [the Ruby Statsd client](https://github.com/reinh/statsd).
 
@@ -145,10 +136,12 @@ GovukStatsd.time("account.activate") { @account.activate! }
 This Gem provides a common "health check" framework for apps. See [the health
 check docs](docs/healthchecks.md) for more information on how to use it.
 
+
 ## Rails logging
 
 In Rails applications, the application will be configured to send JSON-formatted
-logs to `STDOUT` and unstructed logs to `STDERR`.
+logs to `STDOUT` and unstructured logs to `STDERR`.
+
 
 ## Content Security Policy generation
 
@@ -163,18 +156,10 @@ app with the following content:
 GovukContentSecurityPolicy.configure
 ```
 
-## i18n rules 
+## Internationalisation rules
 
 Some frontend apps support languages that are not defined in the i18n gem. This provides them with our own custom rules for these languages.
 
-## Prometheus monitoring for EKS
-
-Create a `/config/initializers/prometheus.rb` file in the app and add the following
-
-```ruby
-require "govuk_app_config/govuk_prometheus_exporter"	
-GovukPrometheusExporter.configure	
-```
 
 ## License
 

data/govuk_app_config.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sentry-rails", "~> 5.3"
   spec.add_dependency "sentry-ruby", "~> 5.3"
   spec.add_dependency "statsd-ruby", "~> 1.5"
-  spec.add_dependency "unicorn", "~> 6.1"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "climate_control"

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -13,19 +13,6 @@ module GovukError
     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
-        integration-eks
-        staging
-        staging-eks
-        production
-        production-eks
-      ]
-
       self.excluded_exceptions = [
         # Default ActionDispatch rescue responses
         "ActionController::RoutingError",

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "6.0.1".freeze
+  VERSION = "7.1.0".freeze
 end

data/lib/govuk_app_config.rb

@@ -3,9 +3,6 @@ require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
 require "govuk_app_config/govuk_proxy/static_proxy"
 require "govuk_app_config/govuk_healthcheck"
-# This require is deprecated and should be removed on next major version bump
-# and should be required by applications directly.
-require "govuk_app_config/govuk_unicorn"
 require "govuk_app_config/govuk_prometheus_exporter"
 
 if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 7.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -134,20 +134,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: unicorn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -313,7 +299,6 @@ files:
 - lib/govuk_app_config/govuk_proxy/static_proxy.rb
 - lib/govuk_app_config/govuk_puma.rb
 - lib/govuk_app_config/govuk_statsd.rb
-- lib/govuk_app_config/govuk_unicorn.rb
 - lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb
 - lib/govuk_app_config/railtie.rb
 - lib/govuk_app_config/version.rb
@@ -336,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.12
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications

data/lib/govuk_app_config/govuk_unicorn.rb

@@ -1,20 +0,0 @@
-module GovukUnicorn
-  def self.configure(config)
-    config.worker_processes Integer(ENV.fetch("UNICORN_WORKER_PROCESSES", 2))
-
-    config.timeout Integer(ENV.fetch("UNICORN_TIMEOUT", 60))
-
-    if ENV["GOVUK_APP_LOGROOT"]
-      config.stdout_path "#{ENV['GOVUK_APP_LOGROOT']}/app.out.log"
-      config.stderr_path "#{ENV['GOVUK_APP_LOGROOT']}/app.err.log"
-    end
-
-    config.before_exec do |_server|
-      next unless ENV["GOVUK_APP_ROOT"]
-
-      ENV["BUNDLE_GEMFILE"] = "#{ENV['GOVUK_APP_ROOT']}/Gemfile"
-    end
-
-    config.check_client_connection true
-  end
-end