govuk_app_config 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3c6597f85f20d601fea02cc8412c6d8440866e0b151d186e10c7d0d7eb52fa
-  data.tar.gz: c1b783944841d1b4a9d6dd4941cb3dbfc68d361215927c78c0931d73a1d851e7
+  metadata.gz: 76fa770ac62a07fcd63f201603abd10f76cd092f5b8ea632ae85115e63d644f7
+  data.tar.gz: 8344992578b29ccca21e15079d5f4ecf07c28efbe416dea31afbb972032c4caa
 SHA512:
-  metadata.gz: 98aa6b485b645c630e0b6d25474096e73be88817aef0e65b7767e3740c2da4feb95d69cd4491fb7762949f232a3f73f7105bfd4b05a2cc73c8cd14076851259d
-  data.tar.gz: db5e291133010b1ddb6c5041a4eaa68fb24bc76920a6f821b1710a66a4e285b97e199cde1371c2d91bdc411708c0a0d0d40d0559e4413c16afa34db4cd4d1af1
+  metadata.gz: 936ed693e0d29e65e844bc30d7108553690939a442c9f80c66f924239ec9c5c852733f6f351ad7925ed372fc0d1d12ab0c591af44448fe5d7429df252dc038e6
+  data.tar.gz: 3e5ab1885b814cf722e1c856b9778c9360f8afd617e437a713a100f959bcfbe47059c1cac358f9edc3c13cc5747135cc5f8c5755564fc908194afa27ddc669bb

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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
 
 * BREAKING: Drop support for Ruby 2.7

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,31 +17,24 @@ Add this line to your application's Gemfile:
 gem "govuk_app_config"
 ```
 
-And then execute:
-
-    $ bundle
+Then run `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
 
@@ -53,7 +46,7 @@ Your app will have to have the following environment variables set:
 
 - `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`
+- `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name.hostname` (deprecated; use Prometheus instead).
 
 [dsn]: https://docs.sentry.io/quickstart/#about-the-dsn
 
@@ -125,7 +118,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 +150,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 +170,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_puma.rb

@@ -9,7 +9,11 @@ module GovukPuma
     end
 
     # `worker_timeout` specifies how many seconds Puma will wait before terminating a worker.
-    timeout = ENV.fetch("RAILS_ENV", "development") == "development" ? 3600 : 15
+    timeout = if ENV.fetch("RAILS_ENV", "development") == "development"
+                3600
+              else
+                Integer(ENV.fetch("PUMA_TIMEOUT", 15))
+              end
     config.worker_timeout timeout
 
     # When changing the min/max threads for Puma, also consider changing ActiveRecord to match.

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "6.0.0".freeze
+  VERSION = "7.0.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.0
+  version: 7.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-04-11 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.11
 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