right_support 2.12.1 → 2.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7074bbc2d6d01fc7eb2bb07e1feeef2ba2f53ed
-  data.tar.gz: 95c557ae302fce0f8612aa6db52f5c4741bf8748
+  metadata.gz: 88f99381f01a8163458dfbb3428605aa10504ecf
+  data.tar.gz: c15fde263a3abf66adf8a665b7aabb27a530a89a
 SHA512:
-  metadata.gz: ffb1c16256704d39e72a2661d8a3fb4c7cda875cc3de50eab7d6825ae42cb4b178c3ca01110d28d6655bc0d40674478e6b6565f605cd045c56ca438cb993f1f0
-  data.tar.gz: 62082378411fc6876b5d76f06bc8ec1a48960521ef4221e24aee9b6e187fa2e2df394364fb58b34cdc317a5ada5b7fa433c69b13c6670752d3e2caf8cf27ca04
+  metadata.gz: c54a1945a13c506c38e2cfc337db07c9d68c2691fc2e501dc68ec16f1fa95670797927f384dd6bb2635c6b01d39b27c5a66994e8ffc910dded8ff505010c15e6
+  data.tar.gz: 08b6bac68cc7b5ebbb12a319fac566b904ef993f452956ac39c9a8371961c2c0fabe1849f407a5681560f627fe80e2c1b588089653db8ee9ef1a3a4e68fe287b

data/VERSION

@@ -1 +1 @@
-2.12.1
+2.13.3

data/lib/right_support/data/hash_tools.rb

@@ -486,5 +486,81 @@ module RightSupport::Data
         raise NoJson, "JSON is unavailable"
       end
     end
+
+    # provides a canonical representation of a header key that is acceptable to
+    # Rack, etc. the web standard for canonical header keys is all lowercase
+    # except with the first character capitalized at the start and after each
+    # dash. underscores are converted to dash characters.
+    def self.canonicalize_header_key(key)
+      key.to_s.downcase.gsub('_', '-').gsub(/(^|-)(.)/) { $1 + $2.upcase }
+    end
+
+    # @return [String] header value by canonical key name, if present.
+    def self.header_value_get(headers, key)
+      return nil unless headers
+      canonical_key = canonicalize_header_key(key)
+      value = nil
+      headers.each do |k, v|
+        if canonicalize_header_key(k) == canonical_key
+          value = v
+          break
+        end
+      end
+      value
+    end
+
+    # safely sets a header value by first locating any existing key by canonical
+    # search. if you know that the header hash is already canonical then you can
+    # alternatively set by using the canonicalized key.
+    #
+    # @param [Hash] headers to modify
+    # @param [String] key for header
+    # @param [String] value for header
+    #
+    # @return [Hash] updated headers
+    def self.header_value_set(headers, key, value)
+      headers ||= {}
+      canonical_key = canonicalize_header_key(key)
+      headers.each do |k, v|
+        if canonicalize_header_key(k) == canonical_key
+          key = k
+          break
+        end
+      end
+      headers[key] = value
+      headers
+    end
+
+    # duplicates the given headers hash after canonicalizing header keys.
+    #
+    # @param [Hash] headers to canonicalize
+    #
+    # @return [Hash] canonicalized headers
+    def self.canonicalize_headers(headers)
+      headers.inject({}) do |h, (k, v)|
+        h[canonicalize_header_key(k)] = v
+        h
+      end
+    end
+
+    # merges source headers hash into the duplicated target headers canonically.
+    # also supports removal of a target header when the source value is nil.
+    #
+    # @param [Hash] target to merge to
+    # @param [String] source to merge from
+    # @return [Hash] merged headers
+    def self.merge_headers(target, source)
+      target = canonicalize_headers(target)
+      (source || {}).each do |k, v|
+        canonical_key = canonicalize_header_key(k)
+        if v.nil?
+          target.delete(canonical_key)
+        else
+          target[canonical_key] = v
+        end
+      end
+      target
+    end
+
   end
 end

data/lib/right_support/net/request_balancer.rb

@@ -403,7 +403,17 @@ module RightSupport::Net
       stats = get_stats
       exceptions.each_pair do |endpoint, list|
         summary = []
-        list.each { |e| summary << e.class }
+        list.each do |e|
+          if e.message.to_s.empty?
+            summary << e.class.name
+          else
+            message_top = e.message.to_s.lines.first.chomp
+            if message_top.length > 128
+              message_top = message_top[0, 124] + ' ...'
+            end
+            summary << "#{e.class.name}: #{message_top}"
+          end
+        end
         health = stats[endpoint] if stats[endpoint] != 'n/a'
         if hostname = lookup_hostname(endpoint)
           msg << "'#{hostname}' (#{endpoint}#{", "+health if health}) => [#{summary.uniq.join(', ')}]"

data/lib/right_support/notifiers/utilities/backtrace_decoder.rb

@@ -99,7 +99,6 @@ class RightSupport::Notifier::Utility::BacktraceDecoder
     frames = []
     trace ||= []
     trace = trace[@backtrace_offset..-1] if @backtrace_offset > 0
-    gems_finder = '/gems/'
     seen_root_path = false
     trace.each do |t|
       has_root_path = false
@@ -134,8 +133,29 @@ class RightSupport::Notifier::Utility::BacktraceDecoder
           # rubygems or '/vendor/bundle/.../gems/' prefixes are only noise that
           # makes the trace harder to read for a human. '/gems/' may also appear
           # more than once so use the last found.
-          if gems_offset = file.rindex(gems_finder)
-            file = file[gems_offset + gems_finder.length..-1]
+          #
+          # also note that vendored gitted gems and their binstubs can appear
+          # directly under the '<app root>/vendor/bundle|cache/' directory and
+          # so are not explicitly under a '/gems/' directory.
+          founder = nil
+          founder_offset = nil
+          %w(
+            /gems/
+            /vendor/cache/
+            /vendor/bundle/
+          ).each do |finder|
+            if founder_offset = file.rindex(finder)
+              founder = finder
+              break
+            end
+          end
+          if founder
+            file = file[founder_offset + founder.length..-1]
+
+            # note that vendored gems are also technically on the 'root path'
+            # but we do not want to include them in the 'seen root path'
+            # logic because we want to see the trace back to real app code.
+            has_root_path = false
           end
         end
       else

data/lib/right_support/rack.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# Copyright (c) 2011-2016 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -25,11 +25,10 @@ module RightSupport
   # A namespace for Rack middleware and other enhancements.
   #
   module Rack
-
+    autoload :LogSetter, 'right_support/rack/log_setter'
+    autoload :RequestLogger, 'right_support/rack/request_logger'
+    autoload :RequestTracker, 'right_support/rack/request_tracker'
+    autoload :Runtime, 'right_support/rack/runtime'
+    autoload :SharedEnvironment, 'right_support/rack/shared_environment'
   end
 end
-
-require 'right_support/rack/log_setter'
-require 'right_support/rack/request_logger'
-require 'right_support/rack/request_tracker'
-require 'right_support/rack/runtime'

data/lib/right_support/rack/request_logger.rb

@@ -185,44 +185,21 @@ module RightSupport::Rack
       raise
     end
 
-    # provides a canonical representation of a header key that is acceptable to
-    # Rack, etc.
+    # @deprecated in favor of RightSupport::Data::HashTools.canonicalize_header_key
     def self.canonicalize_header_key(key)
+      # the legacy implementation is train-case but HashTools uses the more
+      # commonly accepted Canonical-Key style (preferred by golang, etc).
       key.downcase.gsub('_', '-')
     end
 
-    # @return [String] header value by canonical key name, if present.
+    # @deprecated in favor of RightSupport::Data::HashTools.header_value_get
     def self.header_value_get(headers, key)
-      return nil unless headers
-      key = canonicalize_header_key(key)
-      value = nil
-      headers.each do |k, v|
-        if canonicalize_header_key(k) == key
-          value = v
-          break
-        end
-      end
-      value
+      return ::RightSupport::Data::HashTools.header_value_get(headers, key)
     end
 
-    # safely sets a header value by first locating any existing key by canonical
-    # search.
-    #
-    # @param [Hash] headers to modify
-    # @param [String] key for header
-    # @param [String] value for header
-    # @return [Hash] updated headers
+    # @deprecated in favor of RightSupport::Data::HashTools.header_value_set
     def self.header_value_set(headers, key, value)
-      headers ||= {}
-      key = canonicalize_header_key(key)
-      headers.each do |k, v|
-        if canonicalize_header_key(k) == key
-          key = k
-          break
-        end
-      end
-      headers[key] = value
-      headers
+      return ::RightSupport::Data::HashTools.header_value_set(headers, key, value)
     end
 
     # Formats a concise error message with limited backtrace, etc.
@@ -342,7 +319,7 @@ module RightSupport::Rack
     # @return [TrueClass] always true
     def log_request_end(logger, env, status, headers, body, began_at)
       duration = (Time.now - began_at) * 1000
-      unless content_length = self.class.header_value_get(headers, 'Content-Length')
+      unless content_length = ::RightSupport::Data::HashTools.header_value_get(headers, 'Content-Length')
         case body
         when Array
           content_length = body.reduce(0) {|accum, e| accum += e.bytesize}

data/lib/right_support/rack/request_tracker.rb

@@ -49,6 +49,13 @@ module RightSupport::Rack
     # value to finding and replacing with _id in all cases.
     REQUEST_UUID_ENV_NAME = 'rack.request_uuid'.freeze
 
+    # records count of additional API calls made by an application while
+    # handling a request, etc. this is useful for generating an incremental
+    # request [UU]ID to be forwarded to other services for additional API calls.
+    #
+    # @see RightSupport::Rack::RequestTracker.next_request_uuid
+    API_CALL_COUNTER_ENV_KEY = 'request_tracker.api_call_counter'
+
     # @deprecated do not send the lineage header as support may go away.
     REQUEST_LINEAGE_UUID_HEADER = 'HTTP_X_REQUEST_LINEAGE_UUID'.freeze
 
@@ -118,23 +125,57 @@ module RightSupport::Rack
     end
 
     # copies the request [UU]ID from the request environment to the given hash,
-    # if present. does nothing if request [UU]ID is not set (because middleware
-    # was not present, etc.)
+    # if present.
     #
-    # @param [Hash] from_env as source
+    # @param [Hash] from_env as source hash
     # @param [Hash] to_headers as target
+    # @param [Hash] options
+    # @option options [Proc|Method] :generator as callback to generate a new
+    #  request uuid when not present or nil
+    # @option options [Proc|Method] :modifier as callback to modify request uuid
+    #  before it is finally inserted in headers or nil. this can be useful for
+    #  appending a counter for each new API call made by a request handler, etc.
+    #  only called if identifier was retrieved from the environment hash because
+    #  an explicity-set (or generated) ID value is used without modification.
+    # @option options [TrueClass|FalseClass] :return_request_uuid as true to
+    #  return a tuple of [to_headers, request_uuid] instead. false to only
+    #  return updated to_headers (default).
     #
-    # @return [Hash] updated headers
-    def self.copy_request_uuid(from_env, to_headers)
+    # @return [Hash|Array] updated to_headers (default) or tuple of
+    #  [to_headers, request_uuid]. see :return_request_uuid option.
+    def self.copy_request_uuid(from_env, to_headers, options = {})
+      options = {
+        generator: nil,
+        modifier: nil,
+        return_request_uuid: false
+      }.merge(options)
+      from_env ||= {}
       to_headers ||= {}
-      if from_env
+
+      # keep existing ID value, if any.
+      request_uuid = ::RightSupport::Data::HashTools.header_value_get(
+        to_headers,
+        REQUEST_ID_HEADER)
+      unless request_uuid
+        # attempt to find ID key in environment hash.
         if request_uuid = from_env[REQUEST_UUID_ENV_NAME]
-          # note we always forward the _ID header as the standard. none of the
-          # RS code ever actually accepted the _UUID header so that is a
-          # non-issue.
-          to_headers[REQUEST_ID_HEADER] = request_uuid
+          # use modifier, if any.
+          if modifier = options[:modifier]
+            request_uuid = modifier.call(request_uuid)
+          end
+        else
+          # use generator, if any.
+          if generator = options[:generator]
+            request_uuid = generator.call
+          end
         end
+
+        # note that we will always forward the _ID header as the standard.
+        # none of the RS code ever actually accepted the _UUID header so that
+        # is a non-issue.
+        to_headers[REQUEST_ID_HEADER] = request_uuid if request_uuid
       end
+      return [to_headers, request_uuid] if options[:return_request_uuid]
       to_headers
     end
 
@@ -146,5 +187,13 @@ module RightSupport::Rack
       Generator.generate
     end
 
+    # @return [String] next request [UU]ID
+    def self.next_request_uuid(env, base_request_uuid = nil)
+      base_request_uuid ||= env[REQUEST_UUID_ENV_NAME] || 'missing'
+      env[API_CALL_COUNTER_ENV_KEY] ||= 0
+      n = env[API_CALL_COUNTER_ENV_KEY] += 1
+      "#{base_request_uuid}_#{n}"
+    end
+
   end # RequestTracker
 end # RightSupport::Rack

data/lib/right_support/rack/shared_environment.rb

@@ -0,0 +1,112 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport::Rack
+
+  # provides shared access to the Rack request environment hash for any method
+  # executing on the request thread without needing to pass the hash explicitly.
+  # explicit parameter passing is preferred when writing new code, of course,
+  # but it can be difficult to update old code with new parameters going several
+  # layers deep. this middleware attempts to simplify those changes.
+  #
+  # note that only the request thread receives the environment hash so any
+  # threads spawned by the request thread will need to explicitly reference any
+  # needed hash values and/or the entire hash using the accessors.
+  class SharedEnvironment
+
+    # the symbol that represents the Rack request environment hash in TLS.
+    ENVIRONMENT_HASH_SYMBOL = :rack_request_environment_hash
+
+    # @param [Object] app to call
+    # @param [Hash] options
+    # @option options [TrueClass|FalseClass] :fiber_local as false to set the
+    #  environment hash visible to all fibers of the current thread (default) or
+    #  true to set a fiber-local environment hash. if your app does not attempt
+    #  to use fibers then either will work as every thread has a root fiber.
+    #  if your app creates fibers while handling requests then the default of
+    #  thread-local is probably best because the environment hash is shared with
+    #  all fibers. keep in mind that the thread and its root fiber keep distinct
+    #  hashes so you must reference one or the other.
+    def initialize(app, options = {})
+      options = {
+        fiber_local: false
+      }.merge(options)
+      @app = app
+      @fiber_local = !!options[:fiber_local]
+    end
+
+    def call(env)
+      # sanity check in case the application developer is unaware that the
+      # execution model is using fibers instead of threads, etc.
+      fail 'Environment hash is already set.' unless get_environment_hash.empty?
+      set_environment_hash(env)
+      return @app.call(env)
+    ensure
+      # only intended for use by the application; middleware already has env
+      # available on each call. reset to nil before falling back.
+      # also note that there is no such animal as thread_variable_delete, etc.
+      set_environment_hash(nil)
+    end
+
+    # @return [Hash] environment hash or empty
+    def get_environment_hash
+      return self.class.get_environment_hash(@fiber_local)
+    end
+
+    # @param [Hash] env as environment hash or nil or empty
+    #
+    # @return [TrueClass] always true
+    def set_environment_hash(env)
+      return self.class.set_environment_hash(env, @fiber_local)
+    end
+
+    # gets the environment hash for current thread or fiber.
+    #
+    # @return [Hash] environment hash or empty
+    def self.get_environment_hash(fiber_local = false)
+      current = ::Thread.current
+      if fiber_local
+        # note that in ruby 1.8 this would have referred to thread-local storage
+        # but in ruby 1.9+ it refers to fiber-local storage.
+        current[ENVIRONMENT_HASH_SYMBOL] || {}
+      else
+        # in ruby 1.9+ you must explicitly call for thread-local variables.
+        current.thread_variable_get(ENVIRONMENT_HASH_SYMBOL) || {}
+      end
+    end
+
+    # sets the environment hash for current thread or fiber.
+    #
+    # @param [Hash] env as environment hash or nil or empty
+    #
+    # @return [TrueClass] always true
+    def self.set_environment_hash(env, fiber_local = false)
+      current = ::Thread.current
+      if fiber_local
+        current[ENVIRONMENT_HASH_SYMBOL] = env
+      else
+        current.thread_variable_set(ENVIRONMENT_HASH_SYMBOL, env)
+      end
+    end
+
+  end
+end

data/right_support.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: right_support 2.12.1 ruby lib
+# stub: right_support 2.13.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.12.1"
+  s.version = "2.13.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tony Spataro", "Sergey Sergyenko", "Ryan Williamson", "Lee Kirchhoff", "Alexey Karpik", "Scott Messier"]
-  s.date = "2016-08-04"
+  s.date = "2016-09-12"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [
@@ -88,6 +88,7 @@ Gem::Specification.new do |s|
     "lib/right_support/rack/request_logger.rb",
     "lib/right_support/rack/request_tracker.rb",
     "lib/right_support/rack/runtime.rb",
+    "lib/right_support/rack/shared_environment.rb",
     "lib/right_support/ruby.rb",
     "lib/right_support/ruby/easy_singleton.rb",
     "lib/right_support/ruby/object_extensions.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_support
 version: !ruby/object:Gem::Version
-  version: 2.12.1
+  version: 2.13.3
 platform: ruby
 authors:
 - Tony Spataro
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -162,6 +162,7 @@ files:
 - lib/right_support/rack/request_logger.rb
 - lib/right_support/rack/request_tracker.rb
 - lib/right_support/rack/runtime.rb
+- lib/right_support/rack/shared_environment.rb
 - lib/right_support/ruby.rb
 - lib/right_support/ruby/easy_singleton.rb
 - lib/right_support/ruby/object_extensions.rb