workarea-circuit_breaker 1.0.3

data/test/dummy/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/test/dummy/config/initializers/assets.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+# Add Yarn node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join('node_modules')
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/content_security_policy.rb

@@ -0,0 +1,25 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.config.content_security_policy do |policy|
+#   policy.default_src :self, :https
+#   policy.font_src    :self, :https, :data
+#   policy.img_src     :self, :https, :data
+#   policy.object_src  :none
+#   policy.script_src  :self, :https
+#   policy.style_src   :self, :https
+
+#   # Specify URI for violation reports
+#   # policy.report_uri "/csp-violation-report-endpoint"
+# end
+
+# If you are using UJS then enable automatic nonce generation
+# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Report CSP violations to a specified URI
+# For further information see the following documentation:
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+# Rails.application.config.content_security_policy_report_only = true

data/test/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/test/dummy/config/initializers/workarea.rb

@@ -0,0 +1,5 @@
+Workarea.configure do |config|
+  # Basic site info
+  config.site_name = 'Workarea Circuit Breaker'
+  config.host = 'www.example.com'
+end

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/puma.rb

@@ -0,0 +1,34 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,33 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+# Shared secrets are available across all environments.
+
+# shared:
+#   api_key: a1B2c3D4e5F6
+
+# Environmental secrets are only available for that specific environment.
+
+development:
+  secret_key_base: 9915aad1e1769200f2f0c6679b8bd20578dd01d4e6540473f1fd3715230eec45fb09444717a1933fd1203501e43a2b632ba249a0d95e1a867f9f2ff74e2272ad
+
+test:
+  secret_key_base: 5d899ec36127d53f353c2540adb659e077191718f0fbc8e6cd8353e6cc05574c193fd36dd6cf8314e6b6a9c21bac4206b03fdcac3bc48323d0ace7f0278fa6ea
+  sentry_dsn: <%= ENV["SENTRY_DSN"] %>
+
+# Do not keep production secrets in the unencrypted secrets file.
+# Instead, either read values from the environment.
+# Or, use `bin/rails secrets:setup` to configure encrypted secrets
+# and move the `production:` environment over there.
+
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w[
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+].each { |path| Spring.watch(path) }

data/test/dummy/db/seeds.rb

@@ -0,0 +1,2 @@
+require 'workarea/seeds'
+Workarea::Seeds.run

data/test/integration/workarea/admin/circuits_integration_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module Workarea
+  module Admin
+    class CircuitsIntegrationTest < Workarea::IntegrationTest
+      include Admin::IntegrationTest
+
+      def test_turning_on_circuit
+        post admin.enable_circuit_path(:fake_service)
+        assert(CircuitBreaker[:fake_service].healthy?)
+        assert_equal(
+          I18n.t('workarea.admin.circuit_breaker.flash_messages.turned_on', circuit: "Fake service"),
+          flash[:success]
+        )
+      end
+
+      def test_turning_off_circuit
+        post admin.disable_circuit_path(:fake_service)
+        refute(CircuitBreaker[:fake_service].healthy?)
+        assert_equal(
+          I18n.t('workarea.admin.circuit_breaker.flash_messages.turned_off', circuit: "Fake service", break_for: "5 minutes"),
+          flash[:success]
+        )
+      end
+    end
+  end
+end

data/test/lib/workarea/circuit_breaker/circuit_test.rb

@@ -0,0 +1,135 @@
+require 'test_helper'
+
+module Workarea
+  module CircuitBreaker
+    class CircuitTest < Workarea::TestCase
+      include CircuitBreakerSupport
+
+      def test_healthy?
+        assert(circuit.healthy?)
+      end
+
+      def test_healthy_with_redis_pool_timeout
+        with_connection_pool_timeouts do
+          assert(circuit.healthy?)
+        end
+      end
+
+      def test_set_healthy
+        3.times { circuit.add_failure message: "failed!" }
+        refute(circuit.healthy?)
+
+        circuit.set_healthy!
+        assert(circuit.healthy?)
+        assert_equal([], CircuitBreaker.redis.with do |redis|
+          redis.zrange circuit.redis_failure_set_key, 0, -1
+        end)
+      end
+
+      def test_set_healthy_with_redis_pool_timeout
+        assert_nothing_raised do
+          with_connection_pool_timeouts do
+            circuit.set_healthy!
+          end
+        end
+      end
+
+      def test_break!
+        circuit.break!
+        refute(circuit.healthy?)
+      end
+
+      def test_add_failure
+        assert_equal(1, circuit.add_failure(message: "Failure"))
+        assert(circuit.healthy?)
+        assert_equal(2, circuit.add_failure(message: "Failure"))
+        assert(circuit.healthy?)
+        assert_equal(3, circuit.add_failure(message: "Failure"))
+        refute(circuit.healthy?)
+      end
+
+      def test_break_with_redis_pool_timeout
+        assert_nothing_raised do
+          with_connection_pool_timeouts do
+            circuit.break!
+          end
+        end
+      end
+
+      def test_wrap_healthy_without_fallback
+        response = circuit.wrap do
+          "healthy response"
+        end
+
+        assert_equal("healthy response", response)
+      end
+
+      def test_wrap_failing_without_fallback
+        error = assert_raises do
+          circuit.wrap do
+            raise 'http timeout'
+          end
+        end
+
+        assert_equal('http timeout', error.message)
+      end
+
+      def test_wrap_failing_with_fallback_with_symbol
+        response = circuit.wrap(fallback: :local_data) do
+          raise "http timeout"
+        end
+
+        assert_equal("fallback response", response)
+      end
+
+      def test_wrap_failing_with_callable_fallback
+        fallback = -> { "callable fallback" }
+
+        response = circuit.wrap(fallback: fallback) do
+          raise "http timeout"
+        end
+
+        assert_equal("callable fallback", response)
+      end
+
+      def test_wrap_when_broken_without_fallback
+        circuit.break!
+
+        assert_raises CircuitBreakerError do
+          circuit.wrap do
+            raise "never used"
+          end
+        end
+      end
+
+      def test_wrap_when_broken_with_fallback
+        circuit.break!
+
+        response = circuit.wrap(fallback: :local_data) do
+          raise "http timeout"
+        end
+
+        assert_equal("fallback response", response)
+      end
+
+      def test_wrap_breaks_circuit
+        circuit.wrap(fallback: :local_data) { raise "http timeout" }
+        assert(circuit.healthy?)
+        circuit.wrap(fallback: :local_data) { raise "http timeout" }
+        assert(circuit.healthy?)
+        circuit.wrap(fallback: :local_data) { raise "http timeout" }
+        refute(circuit.healthy?)
+      end
+
+      private
+
+        def circuit
+          @circuit ||= Circuit.new(:fake_service, { max_fails: 3 })
+        end
+
+        def local_data
+          "fallback response"
+        end
+    end
+  end
+end

data/test/lib/workarea/circuit_breaker/failure_message_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module Workarea
+  module CircuitBreaker
+    class FailureMessageTest < Workarea::TestCase
+      def test_to_s_without_event_id
+        failure_message = FailureMessage.new(message: "Test")
+        assert_equal(13, failure_message.to_s.length)
+        assert_equal("0", failure_message.to_s[8, 1])
+        assert_equal("Test", failure_message.to_s[9, 4])
+      end
+
+      def test_to_s_with_event_id
+        event_id = SecureRandom.uuid.delete("-")
+        failure_message = FailureMessage.new(event_id: event_id, message: "Test")
+        assert_equal(47, failure_message.to_s.length)
+        assert_equal("1", failure_message.to_s[8, 1])
+        assert_equal("20", failure_message.to_s[9, 2])
+        assert_equal(event_id, failure_message.to_s[11, 32])
+        assert_equal("Test", failure_message.to_s[43, 4])
+      end
+
+      def test_from_string_without_event_id
+        string = "2d519d2e0Test"
+        failure_message = FailureMessage.from_string(string, Time.current.to_i)
+
+        assert_equal("2d519d2e", failure_message.id)
+        assert_equal("Test", failure_message.message)
+      end
+
+      def test_from_string_with_event_id
+        string = "6519a8c5120c5d015ec01924a50920efd19a23e555eTest"
+        failure_message = FailureMessage.from_string(string, Time.current.to_i)
+
+        assert_equal("6519a8c5", failure_message.id)
+        assert_equal("c5d015ec01924a50920efd19a23e555e", failure_message.event_id)
+        assert_equal("Test", failure_message.message)
+      end
+    end
+  end
+end