sitehub 0.5.0.alpha5 → 0.5.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7189b64635170892f88906d52c53a757bdffd12
-  data.tar.gz: c928e7fb8bcb65d9375b6ac448298de8f6d6449f
+  metadata.gz: d1e90e8f9c72c559c959b6c4c837c6ae2e603d38
+  data.tar.gz: a2ff9aa2f206dd91a5e62ef74636dc415a518769
 SHA512:
-  metadata.gz: 9c57e15219c0a8f28e450b294b143db8b6d9b7851cbca600618c174533020116eda0dbbfb989c7179f827b8c4e3f95fe7b47bc129b3a4a7be05f339b34148640
-  data.tar.gz: d87d4cab4c1d81cea2cd40d269a579e916d89e023d598e44fe2210500981a317237508b3bbca11ed467b28d8da337c80afa0ed4a84dec655ccb5aacdfb33c20a
+  metadata.gz: a73a1a9a8903b3cab50b954dc9d32198c07491142ddae30fb8cde8dbc8812b878e6c01b3709150694515d600e11baeeb7728e0e9f092ce303d6ef96c0650b1b8
+  data.tar.gz: c94a341dc37f74025d6ce74295bf54bb96fa8ae44f2feacbcbfdff203b25ce785b1a7eec6c4b10b1ab6ad32eda2e044ef650d2cdcf7279a06d9b37a6ba3b4735

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sitehub (0.5.0.alpha5)
+    sitehub (0.5.0.alpha6)
       activesupport
       em-http-request
       em-synchrony
@@ -37,7 +37,7 @@ GEM
     cookiejar (0.3.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    daemons (1.2.3)
+    daemons (1.2.4)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)

data/lib/sitehub/candidate_routes/class_methods.rb

@@ -0,0 +1,42 @@
+class SiteHub
+  class CandidateRoutes
+    module ClassMethods
+      extend CollectionMethods
+
+      # TODO: support nested routes, i.e. support rule name being passed in
+      def from_hash(hash, sitehub_cookie_name)
+        new(sitehub_cookie_name: sitehub_cookie_name,
+            sitehub_cookie_path: hash[:sitehub_cookie_path],
+            mapped_path: hash[:path], calling_scope: self) do
+          handle_routes(hash, self)
+          default url: hash[:default] if hash[:default]
+        end
+      end
+
+      private
+
+      def handle_routes(hash, routes)
+        extract_splits(hash, routes)
+        extract_routes(hash, routes)
+      end
+
+      def extract_routes(hash, routes)
+        collection(hash, :routes).each do |route|
+          routes.route(url: route[:url], label: route[:label])
+        end
+      end
+
+      def extract_splits(hash, routes)
+        collection(hash, :splits).each do |split|
+          if split[:splits] || split[:routes]
+            routes.split(percentage: split[:percentage], label: split[:label]) do
+              handle_routes(split, self)
+            end
+          else
+            routes.split(percentage: split[:percentage], label: split[:label], url: split[:url])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sitehub/{route_builder.rb → candidate_routes.rb}

@@ -3,6 +3,8 @@ require 'sitehub/equality'
 require 'sitehub/nil_route'
 require 'sitehub/identifier'
 require 'sitehub/getter_setter_methods'
+require 'sitehub/candidate_routes/class_methods'
+
 require_relative 'collection/split_route_collection'
 require_relative 'rules'
 require_relative 'resolver'
@@ -12,81 +14,38 @@ require_relative 'forward_proxy'
 require_relative 'downstream_client'
 
 class SiteHub
-  class RouteBuilder
+  class CandidateRoutes
     class InvalidDefinitionException < Exception
     end
 
     ROUTES_WITH_SPLITS_MSG = 'you cant register routes and splits at the same level'.freeze
     INVALID_SPLIT_MSG = 'url must be defined if not supplying a block'.freeze
-    RULE_NOT_SPECIFIED_MSG = 'rule must be specified when supplying a block'.freeze
+    RULE_NOT_SPECIFIED_MSG = 'rule must be supplied'.freeze
+    PERCENTAGE_NOT_SPECIFIED_MSG = 'percentage must be supplied'.freeze
     IGNORING_URL_MSG = 'Block supplied, ignoring URL parameter'.freeze
     URL_REQUIRED_MSG = 'URL must be supplied for splits and routes'.freeze
 
-    class << self
-      # TODO: support nest splits and routes
-      def from_hash(hash, sitehub_cookie_name)
-        new(sitehub_cookie_name: sitehub_cookie_name,
-            sitehub_cookie_path: hash[:sitehub_cookie_path],
-            mapped_path: hash[:path]) do
-          extend CollectionMethods
-
-          collection(hash, :splits).each do |split|
-            split(percentage: split[:percentage], url: split[:url], label: split[:label])
-          end
-
-          collection(hash, :routes).each do |route|
-            route(url: route[:url], label: route[:label])
-          end
-
-          default url: hash[:default] if hash[:default]
-        end
-      end
-    end
-
-    extend GetterSetterMethods
+    extend CollectionMethods, ClassMethods, GetterSetterMethods
     include Rules, Equality, Middleware
 
-    transient :id
-
     getter_setters :sitehub_cookie_path, :sitehub_cookie_name
-    attr_reader :mapped_path, :id
-
-    def initialize(id: nil, sitehub_cookie_name:, sitehub_cookie_path: nil, mapped_path:, rule: nil, &block)
-      @id = Identifier.new(id)
-      @mapped_path = mapped_path
-      @sitehub_cookie_name = sitehub_cookie_name
-      @sitehub_cookie_path = sitehub_cookie_path
-      @splits = Collection::SplitRouteCollection.new
-      @routes = Collection::RouteCollection.new
-      rule(rule)
+    attr_reader :mapped_path, :id, :calling_scope
 
-      return unless block_given?
+    transient :calling_scope
 
-      instance_eval(&block)
-      raise InvalidDefinitionException unless valid?
-    end
-
-    def add_route(label:, rule: nil, percentage: nil, url: nil, &block)
+    def add(label:, rule: nil, percentage: nil, url: nil, &block)
       child_label = id.child_label(label)
 
       route = if block
-                raise InvalidDefinitionException, RULE_NOT_SPECIFIED_MSG unless percentage || rule
+                raise InvalidDefinitionException, candidate_definition_msg unless percentage || rule
                 warn(IGNORING_URL_MSG) if url
                 new(rule: rule, id: child_label, &block).build
               else
-                raise InvalidDefinitionException, RULE_NOT_SPECIFIED_MSG unless url
+                raise InvalidDefinitionException, URL_REQUIRED_MSG unless url
                 forward_proxy(url: url, label: child_label, rule: rule)
               end
 
-      routes.add(Identifier.new(label), route, percentage)
-    end
-
-    def default_route
-      routes.default
-    end
-
-    def default_route?
-      !default_route.nil?
+      candidates.add(Identifier.new(label), route, percentage)
     end
 
     def build
@@ -94,8 +53,23 @@ class SiteHub
       self
     end
 
+    def candidates(collection = nil)
+      return @endpoints ||= Collection::RouteCollection.new unless collection
+
+      raise InvalidDefinitionException, ROUTES_WITH_SPLITS_MSG if @endpoints && !@endpoints.equal?(collection)
+      @endpoints = collection
+    end
+
     def default(url:)
-      routes.default = forward_proxy(label: :default, url: url)
+      candidates.default = forward_proxy(label: :default, url: url)
+    end
+
+    def default_route
+      candidates.default
+    end
+
+    def default_route?
+      !default_route.nil?
     end
 
     def forward_proxy(label:, url:, rule: nil)
@@ -109,35 +83,59 @@ class SiteHub
       end
     end
 
+    def initialize(id: nil, sitehub_cookie_name:, sitehub_cookie_path: nil, mapped_path:, rule: nil, calling_scope: nil, &block)
+      @id = Identifier.new(id)
+      @calling_scope = calling_scope
+      @mapped_path = mapped_path
+      @sitehub_cookie_name = sitehub_cookie_name
+      @sitehub_cookie_path = sitehub_cookie_path
+      @splits = Collection::SplitRouteCollection.new
+      @routes = Collection::RouteCollection.new
+      rule(rule)
+
+      return unless block_given?
+
+      instance_eval(&block)
+      raise InvalidDefinitionException unless valid?
+    end
+
+    def method_missing(method, *args, &block)
+      super unless calling_scope
+      calling_scope.send(method, *args, &block)
+    rescue NoMethodError
+      super
+    end
+
     def resolve(id: nil, env:)
       id = Identifier.new(id)
-      if id.valid? && (route = routes[id.root])
+      if id.valid? && (route = candidates[id.root])
         route.resolve(id: id.sub_id, env: env)
       else
-        routes.resolve(env: env) || default_route
+        candidates.resolve(env: env) || default_route
       end
     end
 
     def route(url: nil, label:, rule: nil, &block)
-      routes(@routes)
-      add_route(label: label, rule: rule, url: url, &block)
+      candidates(@routes)
+      add(label: label, rule: rule, url: url, &block)
     end
 
-    def routes(collection = nil)
-      return @endpoints ||= Collection::RouteCollection.new unless collection
-
-      raise InvalidDefinitionException, ROUTES_WITH_SPLITS_MSG if @endpoints && !@endpoints.equal?(collection)
-      @endpoints = collection
+    def split(percentage:, url: nil, label:, &block)
+      candidates(@splits)
+      add(label: label, percentage: percentage, url: url, &block)
     end
 
-    def split(percentage:, url: nil, label:, &block)
-      routes(@splits)
-      add_route(label: label, percentage: percentage, url: url, &block)
+    def splits?
+      candidates.is_a?(Collection::SplitRouteCollection)
     end
 
     def valid?
       return true if default_route?
-      routes.valid?
+      candidates.valid?
+    end
+
+    def [](key)
+      candidates[Identifier.new(key)]
     end
 
     private
@@ -150,7 +148,7 @@ class SiteHub
     end
 
     def build_with_middleware
-      routes = routes().values.find_all { |route| route.is_a?(Route) }
+      routes = candidates.values.find_all { |route| route.is_a?(Route) }
 
       routes << default_route if default_route?
 
@@ -160,13 +158,22 @@ class SiteHub
       end
     end
 
+    def candidate_definition_msg
+      splits? ? PERCENTAGE_NOT_SPECIFIED_MSG : RULE_NOT_SPECIFIED_MSG
+    end
+
     def new(id:, rule: nil, &block)
+      inherited_middleware = middlewares
+
       self.class.new(id: id,
                      sitehub_cookie_name: sitehub_cookie_name,
                      sitehub_cookie_path: sitehub_cookie_path,
                      mapped_path: mapped_path,
                      rule: rule,
-                     &block)
+                     calling_scope: calling_scope) do
+        middlewares.concat(inherited_middleware)
+        instance_eval(&block)
+      end
     end
   end
 end

data/lib/sitehub/collection_methods.rb

@@ -0,0 +1,12 @@
+class SiteHub
+  module CollectionMethods
+    def collection(hash, item)
+      hash[item] || []
+    end
+
+    def collection!(hash, item)
+      return hash[item] if hash[item]
+      raise ConfigError, "missing: #{item}"
+    end
+  end
+end

data/lib/sitehub/cookie/rewriting.rb

@@ -0,0 +1,42 @@
+require 'sitehub/cookie'
+require 'sitehub/constants'
+class SiteHub
+  # TODO: - change in to object and remove .reek exclusions for UtilityFunction
+  class Cookie
+    module Rewriting
+      ENDING_WITH_NEWLINE = /#{NEW_LINE}$/
+
+      def rewrite_cookies(headers, substitute_domain:)
+        cookies_hash = cookies_string_as_hash(headers[Constants::HttpHeaderKeys::SET_COOKIE])
+
+        cookies_hash.values.each do |cookie|
+          domain_attribute = cookie.find(:domain) || next
+          update_domain(domain_attribute, substitute_domain)
+        end
+        headers[Constants::HttpHeaderKeys::SET_COOKIE] = cookies_hash_to_string(cookies_hash)
+      end
+
+      def update_domain(domain_attribute, substitute_domain)
+        substitute = substitute_domain.dup
+        if domain_attribute.value.start_with?(FULL_STOP)
+          domain_attribute.update(substitute.prepend(FULL_STOP))
+        else
+          domain_attribute.update(substitute)
+        end
+      end
+
+      def cookies_hash_to_string(cookies_hash)
+        cookies_hash.values.inject(EMPTY_STRING.dup) do |cookie_string, cookie|
+          cookie_string << "#{cookie}#{NEW_LINE}"
+        end.sub(ENDING_WITH_NEWLINE, EMPTY_STRING)
+      end
+
+      def cookies_string_as_hash(cookie_string)
+        cookie_string.lines.each_with_object({}) do |cookie_line, cookies|
+          cookie = SiteHub::Cookie.new(cookie_line)
+          cookies[cookie.name] = cookie
+        end
+      end
+    end
+  end
+end

data/lib/sitehub/core.rb

@@ -1,4 +1,5 @@
-require 'sitehub/route_builder'
+require 'sitehub/collection_methods'
+require 'sitehub/candidate_routes'
 require 'forwardable'
 
 class SiteHub
@@ -8,17 +9,6 @@ class SiteHub
   class ConfigError < Exception
   end
 
-  module CollectionMethods
-    def collection(hash, item)
-      hash[item] || []
-    end
-
-    def collection!(hash, item)
-      return hash[item] if hash[item]
-      raise ConfigError, "missing: #{item}"
-    end
-  end
-
   class Core
     class << self
       # TODO: default action for missing key, throw exception?
@@ -28,7 +18,7 @@ class SiteHub
           sitehub_cookie_name config[:sitehub_cookie_name] if config[:sitehub_cookie_name]
 
           collection!(config, :proxies).each do |proxy|
-            routes.add_route route_builder: RouteBuilder.from_hash(proxy, sitehub_cookie_name)
+            mappings.add_route route_builder: CandidateRoutes.from_hash(proxy, sitehub_cookie_name)
           end
 
           collection(config, :reverse_proxies).each do |proxy|
@@ -41,25 +31,25 @@ class SiteHub
     include Equality
     extend Forwardable
 
-    attr_reader :routes, :reverse_proxies
-    def_delegator :routes, :sitehub_cookie_name
+    attr_reader :mappings, :reverse_proxies
+    def_delegator :mappings, :sitehub_cookie_name
 
     def initialize(&block)
       @reverse_proxies = {}
-      @routes = Middleware::Routes.new
+      @mappings = Middleware::CandidateRouteMappings.new
       instance_eval(&block) if block
     end
 
     def build
-      Middleware::ReverseProxy.new(routes.init, reverse_proxies)
+      Middleware::ReverseProxy.new(mappings.init, reverse_proxies)
     end
 
     def proxy(opts = {}, &block)
       mapped_path, url = *(opts.respond_to?(:to_a) ? opts.to_a : [opts]).flatten
 
-      routes.add_route(url: url,
-                       mapped_path: mapped_path,
-                       &block)
+      mappings.add_route(url: url,
+                         mapped_path: mapped_path,
+                         &block)
     end
 
     def reverse_proxy(hash)

data/lib/sitehub/identifier.rb

@@ -34,10 +34,10 @@ class SiteHub
       other.respond_to?(:to_sym) && to_sym == other.to_sym
     end
 
+    alias eql? ==
+
     def hash
       components.hash
     end
-
-    alias eql? ==
   end
 end

data/lib/sitehub/middleware/{routes.rb → candidate_route_mappings.rb}

@@ -8,7 +8,7 @@ require 'em-http'
 
 class SiteHub
   module Middleware
-    class Routes < Hash
+    class CandidateRouteMappings < Hash
       NIL_ROUTE = NilRoute.new
 
       include Equality
@@ -39,9 +39,9 @@ class SiteHub
           return
         end
 
-        self[mapped_path] = RouteBuilder.new(sitehub_cookie_name: sitehub_cookie_name,
-                                             mapped_path: mapped_path,
-                                             &block).tap do |builder|
+        self[mapped_path] = CandidateRoutes.new(sitehub_cookie_name: sitehub_cookie_name,
+                                                mapped_path: mapped_path,
+                                                &block).tap do |builder|
           builder.default(url: url) if url
         end
       end

data/lib/sitehub/middleware/config_loader.rb

@@ -28,6 +28,7 @@ class SiteHub
         @app.call env
       end
 
+      # TODO: handle errors connecting to the config server
       def load_config
         config = cache.fetch(:sitehub_config, expires_in: 30) do
           config_server.get

data/lib/sitehub/middleware/reverse_proxy.rb

@@ -1,4 +1,4 @@
-require 'sitehub/cookie_rewriting'
+require 'sitehub/cookie/rewriting'
 require 'sitehub/location_rewriters'
 require 'sitehub/request_mapping'
 require 'sitehub/constants'
@@ -6,7 +6,7 @@ require 'sitehub/constants'
 class SiteHub
   module Middleware
     class ReverseProxy
-      include CookieRewriting, Constants::HttpHeaderKeys, Equality
+      include Cookie::Rewriting, Constants::HttpHeaderKeys, Equality
 
       attr_reader :path_directives
 

data/lib/sitehub/middleware.rb

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(__dir__)
 require 'middleware/logging'
 require 'middleware/transaction_id'
 require 'middleware/error_handling'
-require 'middleware/routes'
+require 'middleware/candidate_route_mappings'
 require 'middleware/reverse_proxy'
 require 'middleware/config_loader'
 require 'rack/ssl-enforcer'

data/lib/sitehub/request.rb

@@ -77,7 +77,7 @@ class SiteHub
       mapping.computed_uri
     end
 
-    memoize :url, :path, :uri, :mapped?, :mapping, :headers, :body, :request_method
+    memoize :url, :path, :uri, :mapping, :headers, :body, :request_method
 
     private
 

data/lib/sitehub/version.rb

@@ -1,3 +1,3 @@
 class SiteHub
-  VERSION = '0.5.0.alpha5'.freeze
+  VERSION = '0.5.0.alpha6'.freeze
 end

data/spec/integration/access_logs_spec.rb

@@ -0,0 +1,75 @@
+require 'cgi'
+describe 'access_logs' do
+  let(:downstream_url) { 'http://localhost:12345/experiment1' }
+
+  let(:experiment_body_1) { 'experiment1_body' }
+
+  let(:access_logger) { StringIO.new }
+
+  before do
+    WebMock.enable!
+  end
+
+  let(:app) do
+    downstream_url = downstream_url()
+    access_logger = access_logger()
+
+    sitehub = SiteHub.build do
+      access_logger access_logger
+      error_logger StringIO.new
+
+      proxy '/endpoint' do
+        split(label: :experiment1, percentage: 100) do
+          split percentage: 100, label: 'variant1', url: downstream_url
+        end
+      end
+    end
+    Async::Middleware.new(sitehub)
+  end
+
+  let(:query_string) { '' }
+  let(:request_url) { "/endpoint#{query_string.empty? ? '' : "?#{query_string}"}" }
+
+  subject do
+    query_string_hash = CGI.parse(query_string).collect { |key, value| [key, value.first] }.to_h
+    stub_request(:get, downstream_url).with(query: query_string_hash)
+    get(request_url)
+    access_logger.string
+  end
+
+  context 'query string' do
+    context 'present' do
+      let(:query_string) { 'key=value' }
+      it 'logs it' do
+        expect(subject).to include(query_string)
+      end
+    end
+
+    context 'not present' do
+      let(:query_string) { '' }
+      it 'is not logged' do
+        expect(subject).to include(query_string)
+      end
+    end
+  end
+
+  it 'logs the transaction id' do
+    expect(subject).to match(/transaction_id:.*?\s/)
+  end
+
+  it 'logs the response status' do
+    expect(subject).to include('200')
+  end
+
+  it 'logs the downstream url that was proxied to' do
+    expect(subject).to include("#{request_url} => #{downstream_url}")
+  end
+
+  it 'has the required format' do
+    processing_time_matcher = '\d{1}\.\d{4}'
+    transaction_id_matcher = '[a-z\d]+'
+    expected_response_status = 200
+    puts subject
+    expect(subject).to match(/transaction_id:#{transaction_id_matcher}:\s"GET\s#{request_url}\s=>\s#{downstream_url}\s"\s#{expected_response_status}\s-\s#{processing_time_matcher}/)
+  end
+end