support enabling webvalve in non-local, production-like envs

CHANGELOG.md

@@ -9,6 +9,15 @@ and this project aims to adhere to [Semantic Versioning](http://semver.org/spec/
 ### Added
 ### Removed
 
+## [0.11.0] - 2019-09-23
+### Changed
+- rework configuration so that WebValve has 3 operating modes: off,
+    on+allowing, and on+intercepting. support toggling the latter two
+    modes with
+    `WEBVALVED_ENABLED=1`+`WEBVALVE_SERVICE_ENABLED_DEFAULT=1` and
+    `WEBVALVED_ENABLED=1`+`WEBVALVE_SERVICE_ENABLED_DEFAULT=0`.
+    (https://github.com/Betterment/webvalve/pull/34)
+
 ## [0.10.0] - 2019-09-23
 ### Changed
 - `Webvalve.register` no longer accepts classes; you must provide class names as strings. Fixes a Rails 6 deprecation warning. (https://github.com/Betterment/webvalve/pull/35)

README.md

@@ -227,12 +227,22 @@ not registered.
 
 ## Frequently Asked Questions
 
-> Can I use WebValve in environments like staging and demo?
+> Can I use WebValve in environments like staging, demo, and production?
 
 Yes! By default WebValve is only enabled in test and development
 environments; however, it can be enabled in other environments by
-setting `WEBVALVE_ENABLED=true`. This can be useful for spinning up
-cheap, one-off environments for user-testing or demos.
+setting `WEBVALVE_ENABLED=true` (actually, any of 1/t/true will work).
+This can be useful for spinning up cheap, one-off environments for
+user-testing or demos. When WebValve is enabled in any environment other
+than development/test it will default services to enabled rather than
+disabled, allowing all traffic to pass-thru. This ensures that
+production-like environments are run integrated by default. You can
+change this behavior by setting `WEBVALVE_SERVICE_ENABLED_DEFAULT=false`
+(any of 0/f/false will work). This will default to the same experience
+as local development, defaulting services to disabled, intercepting all
+traffic. In either of these modes, you can use the
+`$SERVICE_ENABLED=true/false` to toggle a specific service into the
+desired state.
 
 > Can I use WebValve without Rails?
 

design/adr-001.md

@@ -0,0 +1,110 @@
+# ADR 001: Use ENV variable to control behavior in production-like envs
+
+## Status
+
+Accepted
+
+## Context
+
+We would like to be able to use WebValve to fake external service
+integrations in production-like environments.
+
+When using WebValve in a production-like environment, we'd like to be
+able to support three different use-cases:
+* enable all services by default, and don't load WebValve at all. This
+    is equivalent to WebValve's current production behavior:
+    zero-overhead, no risk of accidentally loading a fake service
+    instead of a real one.
+* enable all services by default (as if WebValve is disabled) but allow
+    each service to be flipped into faking mode based on an env
+    variable. This allows us to support faking a service in a staging
+    environment where we cannot actually integrate with a real or
+    sandbox version of the external service while still connecting to
+    real versions of all other services.
+* disable all services by default (as if WebValve is enabled) but allow
+    each service to be flipped into real mode based on an env variable.
+    This allows us to spin up cheap one-off environments for
+    user-testing, proof-of-concepting, etc.
+
+In summary, we need ways to control:
+* the activation of WebValve: loading the library, loading
+    the fakes, configuring WebMock
+* the default mode of WebValve: intercepting vs. allowing
+    (pass-through)
+* the explicit enabling / disabling of individual services
+
+We came up with a few approaches to support these use-cases:
+
+*Activate if required*
+This will load and activate WebValve when it's required. If you don't
+want to activate it, don't require it. The downside to this approach is
+it's easy to accidentally load WebValve in the wrong env. Additionally,
+in an env where we want to enable all services by default and only
+disable select ones, we'd have to define the ${SERVICE}_ENABLED env
+variable for all services and update each time we add a new services,
+which can be quite annoying.
+
+*Activate based on env variables*
+Introduce a new WEBVALVE_SERVICE_ENABLED_DEFAULT env variable that
+controls the default service enabled behavior, or the "mode" webvalve
+runs in: on and allowing traffic by default, or on and intercepting
+traffic by default. If the WEBVALVE_ENABLED variable is unset, don't
+activate the lib. If WEBVALVE_ENABLED is set to truthy (1/t/true) and
+WEBVALVE_SERVICE_ENABLED_DEFAULT is unset then load in passthru mode,
+allowing fakes to be toggled on explicitly via their ${SERVICE}_ENABLED
+env variable. If WEBVALVE_ENABLED is explicitly set to to truthy and
+WEBVALVE_SERVICE_ENABLED_DEFAULT is set to falsey (0/f/false) then load
+in intercepting mode, allowing fakes to be toggled off explicitly via
+their ${SERVICE}_ENABLED env variable.
+
+*Don't support it at all*
+Lastly, a sort of non-option option: don't support faking in
+production-like envs. Don't support any envs other than dev and test.
+Advise that the gem should only go in the dev/test group. This is safest
+for production use, but means that production-like envs that want to
+swap out real versions of services would have to do it by actually
+deploying a version of their fake service and connecting to it out of
+process as if it were a real service. This is nice from the "make it
+real" angle, but introduces quite a bit of overhead and it's
+well-aligned with the WebValve philosophy of making things convenient
+and as isolated as possible.
+
+## Decision
+
+We chose the "Activate based on env variables" approach. It introduces
+more complexity to this library, but support for these use-cases feels
+worth it. We're not the happiest with having
+`WEBVALVE_SERVICE_ENABLED_DEFAULT` as an env variable name, but I think
+that we can document it clearly to head off confusion for the power
+users that actually want to utilize WebValve in production-like
+environments. For the standard user, nothing about how they're currently
+using WebValve will change.
+
+Here's a summary of the behavior based on environment.
+
+When the env is test/development
+* webvalve is enabled and always runs in intercepting mode where
+  services are intercepted by default
+
+When the env is NOT test/development, e.g. production
+* webvalve is disabled unless WEBVALVE_ENABLED=1/t/true
+* when WEBVALVE_ENABLED is truthy, webvalve is enabled in allowing mode
+  where all traffic is allowed by default
+* $SERVICE_ENABLED=0/f/false can be used to switch a service into intercepting
+  mode, i.e. enable the fake service
+* when WEBVALVE_ENABLED is truthy and
+  WEBVALVE_SERVICE_ENABLED_DEFAULT=0/f/false then webvalve is enabled in
+  intercepting mode where all traffic is intercepted by default
+* $SERVICE_ENABLED=1/t/true can be used to switch a service into
+  allowing mode, i.e. allow the traffic to that service to go through to
+  the internet
+
+## Consequences
+
+More complexity to manage in this library.
+
+Controlling WebValve activation via an ENV variable, makes it slightly
+easier to unintentionally enable WebValve in production.
+
+The current behavior of WEBVALVE_ENABLED in production is slightly
+altered: by default we will allow all traffic in production.

lib/webvalve.rb

@@ -3,9 +3,6 @@
 require 'active_support/core_ext'
 
 module WebValve
-  ALWAYS_ENABLED_ENVS = %w(development test).freeze
-  ENABLED_VALUES = %w(1 t true).freeze
-
   class << self
     # @!method setup
     #   @see WebValve::Manager#setup
@@ -15,23 +12,11 @@ class << self
     #   @see WebValve::Manager#allow_url
     # @!method reset
     #   @see WebValve::Manager#reset
-    delegate :setup, :register, :allow_url, :reset, to: :manager
+    # @!method enabled?
+    #   @see WebValve::Manager#enabled?
+    delegate :setup, :register, :allow_url, :reset, :enabled?, to: :manager
     attr_writer :logger
 
-    def enabled?
-      if env.in?(ALWAYS_ENABLED_ENVS)
-        if ENV.key? 'WEBVALVE_ENABLED'
-          logger.warn(<<~MESSAGE)
-            WARNING: Ignoring WEBVALVE_ENABLED environment variable setting (#{ENV['WEBVALVE_ENABLED']})
-            WebValve is always enabled in development and test environments.
-          MESSAGE
-        end
-        true
-      else
-        ENABLED_VALUES.include?(ENV['WEBVALVE_ENABLED'])
-      end
-    end
-
     def config_paths
       @config_paths ||= Set.new
     end

lib/webvalve/fake_service_config.rb

@@ -7,9 +7,12 @@ def initialize(service_class_name:, url: nil)
       @custom_service_url = url
     end
 
-    def should_intercept?
-      WebValve.env.test? || # always intercept in test
-        (WebValve.enabled? && !service_enabled_in_env?)
+    def explicitly_enabled?
+      value_from_env.present? && WebValve::ENABLED_VALUES.include?(value_from_env.to_s)
+    end
+
+    def explicitly_disabled?
+      value_from_env.present? && WebValve::DISABLED_VALUES.include?(value_from_env.to_s)
     end
 
     def service_url
@@ -24,6 +27,10 @@ def service_url
 
     attr_reader :custom_service_url
 
+    def value_from_env
+      ENV["#{service_name.to_s.upcase}_ENABLED"]
+    end
+
     def missing_url_message
       <<~MESSAGE
         There is no URL defined for #{service_class_name}.
@@ -36,10 +43,6 @@ def strip_basic_auth(url)
       url.to_s.sub(%r(\Ahttp(s)?://[^@/]+@), 'http\1://')
     end
 
-    def service_enabled_in_env?
-      WebValve::ENABLED_VALUES.include?(ENV["#{service_name.to_s.upcase}_ENABLED"])
-    end
-
     def default_service_url
       ENV["#{service_name.to_s.upcase}_API_URL"]
     end

lib/webvalve/manager.rb

@@ -3,6 +3,10 @@
 require 'set'
 
 module WebValve
+  ALWAYS_ENABLED_ENVS = %w(development test).freeze
+  ENABLED_VALUES = %w(1 t true).freeze
+  DISABLED_VALUES = %w(0 f false).freeze
+
   # @api private
   class Manager
     include Singleton
@@ -19,16 +23,46 @@ def allow_url(url)
     end
 
     def setup
-      fake_service_configs.each do |config|
-        if config.should_intercept?
-          webmock_service config
-        else
-          allowlist_service config
+      return unless enabled?
+
+      if intercepting?
+        fake_service_configs.each do |config|
+          if !WebValve.env.test? && config.explicitly_enabled?
+            allowlist_service config
+          else
+            webmock_service config
+          end
+        end
+        WebMock.disable_net_connect! webmock_disable_options
+        WebMock.enable!
+      end
+
+      if allowing?
+        fake_service_configs.each do |config|
+          if config.explicitly_disabled?
+            webmock_service config
+          end
+        end
+        if fake_service_configs.any?(&:explicitly_disabled?)
+          WebMock.allow_net_connect!
+          WebMock.enable!
         end
       end
+    end
+
+    # @api private
+    def enabled?
+      in_always_intercepting_env? || explicitly_enabled?
+    end
+
+    # @api private
+    def intercepting?
+      in_always_intercepting_env? || (explicitly_enabled? && !services_enabled_by_default?)
+    end
 
-      WebMock.enable!
-      WebMock.disable_net_connect! webmock_disable_options
+    # @api private
+    def allowing?
+      !in_always_intercepting_env? && explicitly_enabled? && services_enabled_by_default?
     end
 
     # @api private
@@ -49,6 +83,38 @@ def allowlisted_urls
 
     private
 
+    def explicitly_enabled?
+      ENABLED_VALUES.include?(ENV['WEBVALVE_ENABLED'])
+    end
+
+    def services_enabled_by_default?
+      if WebValve.env.in?(ALWAYS_ENABLED_ENVS)
+        if ENV.key? 'WEBVALVE_SERVICE_ENABLED_DEFAULT'
+          WebValve.logger.warn(<<~MESSAGE)
+            WARNING: Ignoring WEBVALVE_SERVICE_ENABLED_DEFAULT environment variable setting (#{ENV['WEBVALVE_SERVICE_ENABLED_DEFAULT']})
+            WebValve is always enabled in intercepting mode in development and test environments.
+          MESSAGE
+        end
+        false
+      else
+        ENABLED_VALUES.include?(ENV.fetch('WEBVALVE_SERVICE_ENABLED_DEFAULT', '1'))
+      end
+    end
+
+    def in_always_intercepting_env?
+      if WebValve.env.in?(ALWAYS_ENABLED_ENVS)
+        if ENV.key? 'WEBVALVE_ENABLED'
+          WebValve.logger.warn(<<~MESSAGE)
+            WARNING: Ignoring WEBVALVE_ENABLED environment variable setting (#{ENV['WEBVALVE_ENABLED']})
+            WebValve is always enabled in development and test environments.
+          MESSAGE
+        end
+        true
+      else
+        false
+      end
+    end
+
     def webmock_disable_options
       { allow_localhost: true }.tap do |opts|
         opts[:allow] = allowlisted_url_regexps unless WebValve.env.test?

lib/webvalve/version.rb

@@ -1,3 +1,3 @@
 module WebValve
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end