Refactor Logic For Allowing Multiple Hosts

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased]
+
+### Changed
+
+ - Refactor Logic For Allowing Multiple Hosts [#972](https://github.com/portagenetwork/roadmap/pull/972)
+
 ## [4.1.1+portage-4.2.3] - 2024-11-20
 
 ### Added

config/environments/production.rb

@@ -2,7 +2,6 @@
 
 require 'syslog/logger'
 
-# rubocop:disable Metrics/BlockLength
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
@@ -97,12 +96,7 @@
   # This allows us to define the hostname and add it to the whitelist. If you attempt
   # to access the site and receive a 'Blocked host' error then you will need to
   # set this environment variable
-  # Convert comma-separated string to array
-  dmproadmap_hosts = Rails.application.secrets.dmproadmap_host.to_s.split(',').map(&:strip)
-  dmproadmap_hosts.each do |host|
-    config.hosts << host
-  end
+  # Handled by config/initializers/allowed_hosts.rb
 end
-# rubocop:enable Metrics/BlockLength
 # Used by Rails' routes url_helpers (typically when including a link in an email)
 Rails.application.routes.default_url_options[:host] = Rails.application.secrets.dmproadmap_host

config/environments/sandbox.rb

@@ -89,12 +89,6 @@
     authentication: Rails.application.secrets.smtp_authentication || 'plain',
     enable_starttls_auto: true
   }
-
-  # Convert comma-separated string to array
-  dmproadmap_hosts = Rails.application.secrets.dmproadmap_host.to_s.split(',').map(&:strip)
-  dmproadmap_hosts.each do |host|
-    config.hosts << host
-  end
 end
 # Fix JSON Download Error
 Rails.application.routes.default_url_options[:host] = Rails.application.secrets.dmproadmap_host

config/environments/staging.rb

@@ -88,10 +88,5 @@
     authentication: Rails.application.secrets.smtp_authentication || 'plain',
     enable_starttls_auto: true
   }
-  # Convert comma-separated string to array
-  dmproadmap_hosts = Rails.application.secrets.dmproadmap_host.to_s.split(',').map(&:strip)
-  dmproadmap_hosts.each do |host|
-    config.hosts << host
-  end
 end
 Rails.application.routes.default_url_options[:host] = Rails.application.secrets.dmproadmap_host

config/initializers/allowed_hosts.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# This initializer sets the allowed hosts for the app configuration.
+# https://guides.rubyonrails.org/configuring.html#actiondispatch-hostauthorization
+module AllowedHosts
+  def self.add_allowed_hosts(config)
+    # Convert comma-separated string to array
+    hosts = Rails.application.secrets.dmproadmap_host.to_s.split(',').map(&:strip)
+    hosts.each do |host|
+      config.hosts << host
+    end
+  end
+end
+
+# Add the allowed hosts (unless in development or test environment)
+AllowedHosts.add_allowed_hosts(Rails.application.config) unless Rails.env.in?(%w[development test])