right_agent 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aa97d267e37f937d75b168f61595f4471ecfa5c
-  data.tar.gz: 84807b3fb6847703f579eb823893bfe67cba9a4c
+  metadata.gz: 2f847073e46487c064b8b6f889f911cce5e4f108
+  data.tar.gz: 3d3e8c151fd4175d18925826183e06fa53492d1b
 SHA512:
-  metadata.gz: 557cff491092e4a661ea21bfa169a7adbe824530eabed61d657ef90ef93fb25ebda7e0d52e49074171c9c554bcb5cf2677150f2b3cea95c845c1310b79ce4098
-  data.tar.gz: ed3487e962eb4a1fbdf2199778c9168cc4e58b3a3e988d671b14dab290006c1bdd5c73ead3f08db4aba5bc8ffcac934d43646a9747324d1b75c9bf839f574575
+  metadata.gz: 9422e92a47df194278674c186abb7f0b28d8235b901ae01a5c1313f4e3955a66515717a6b2ef47acd90a8e838f4c6734399978b5d50a8ed24096bfcae0e8e7b3
+  data.tar.gz: ad341db3b0ff0a704ccee785966cefedc0c134ec7c71a259e6973969a968b05a6358b3685b90c4d76dd030b09ee0cd444f6d706aab7a00909b8ee864e127015f

data/lib/right_agent/clients/balanced_http_client.rb

@@ -59,6 +59,9 @@ module RightScale
     # Text used for filtered parameter value
     FILTERED_PARAM_VALUE = "<hidden>"
 
+    # Parameters whose contents are also to have filtering applied
+    CONTENT_FILTERED_PARAMS = ["payload"]
+
     # Environment variables to examine for proxy settings, in order
     PROXY_ENVIRONMENT_VARIABLES = ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy', 'ALL_PROXY']
 
@@ -71,7 +74,8 @@ module RightScale
     # @option options [String] :health_check_path in URI for health check resource;
     #   defaults to DEFAULT_HEALTH_CHECK_PATH
     # @option options [Array] :filter_params symbols or strings for names of request parameters
-    #   whose values are to be hidden when logging; can be augmented on individual requests
+    #   whose values are to be hidden when logging; also applied to contents of any parameters
+    #   in CONTENT_FILTERED_PARAMS; can be augmented on individual requests
     # @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying
     #   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous
     def initialize(urls, options = {})
@@ -140,9 +144,9 @@ module RightScale
     # @option options [Numeric] :open_timeout maximum wait for connection; defaults to DEFAULT_OPEN_TIMEOUT
     # @option options [Numeric] :request_timeout maximum wait for response; defaults to DEFAULT_REQUEST_TIMEOUT
     # @option options [String] :request_uuid uniquely identifying request; defaults to random generated UUID
-    # @option options [Array] :filter_params symbols or strings for names of request
-    #   parameters whose values are to be hidden when logging in addition to the ones
-    #   provided during object initialization
+    # @option options [Array] :filter_params symbols or strings for names of request parameters whose
+    #   values are to be hidden when logging in addition to the ones provided during object initialization;
+    #   also applied to contents of any parameters named :payload
     # @option options [Hash] :headers to be added to request
     # @option options [Numeric] :poll_timeout maximum wait for individual poll; defaults to :request_timeout
     # @option options [Symbol] :log_level to use when logging information about the request other than errors;
@@ -359,8 +363,7 @@ module RightScale
     #
     # @return [String] Log text
     def log_text(path, params, filter, host = nil, exception = nil)
-      filtered_params = (exception || Log.level == :debug) ? filter(params, filter).inspect : nil
-      text = filtered_params ? "#{path} #{filtered_params}" : path
+      text = "#{path} #{filter(params, filter).inspect}"
       text = "[#{host}#{text}]" if host
       text << " | #{self.class.exception_text(exception)}" if exception
       text
@@ -368,8 +371,9 @@ module RightScale
 
     # Apply parameter hiding filter
     #
-    # @param [Hash, Object] params to be filtered
-    # @param [Array] filter names of params as strings (not symbols) whose value is to be hidden
+    # @param [Hash, Object] params to be filtered with strings or symbols as keys
+    # @param [Array] filter names of params as strings (not symbols) whose value is to be hidden;
+    #   also filter the contents of any CONTENT_FILTERED_PARAMS
     #
     # @return [Hash] filtered parameters
     def filter(params, filter)
@@ -377,7 +381,14 @@ module RightScale
         params
       else
         filtered_params = {}
-        params.each { |k, p| filtered_params[k] = filter.include?(k.to_s) ? FILTERED_PARAM_VALUE : p }
+        params.each do |k, p|
+          s = k.to_s
+          if filter.include?(s)
+            filtered_params[k] = FILTERED_PARAM_VALUE
+          else
+            filtered_params[k] = CONTENT_FILTERED_PARAMS.include?(s) ? filter(p, filter) : p
+          end
+        end
         filtered_params
       end
     end

data/lib/right_agent/clients/base_retry_client.rb

@@ -76,7 +76,8 @@ module RightScale
     # @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying
     #   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous
     # @option options [Array] :filter_params symbols or strings for names of request parameters
-    #   whose values are to be hidden when logging; can be augmented on individual requests
+    #   whose values are to be hidden when logging; also applied to contents of any parameters
+    #   named :payload; can be augmented on individual requests
     #
     # @return [Boolean] whether currently connected
     #

data/lib/right_agent/clients/right_http_client.rb

@@ -49,8 +49,8 @@ module RightScale
     # @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying
     #   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous
     # @option options [Boolean] :long_polling_only never attempt to create a WebSocket, always long-polling instead
-    # @option options [Array] :filter_params symbols or strings for names of request parameters
-    #   whose values are to be hidden when logging
+    # @option options [Array] :filter_params symbols or strings for names of request parameters whose
+    #   values are to be hidden when logging; also applied to contents of any parameters named :payload
     #
     # @return [TrueClass] always true
     #

data/lib/right_agent/clients/router_client.rb

@@ -88,6 +88,8 @@ module RightScale
     # @option options [Numeric] :reconnect_interval for reconnect attempts after lose connectivity
     # @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying
     #   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous
+    # @option options [Array] :filter_params symbols or strings for names of request parameters whose
+    #   values are to be hidden when logging; also applied to contents of any parameters named :payload
     #
     # @raise [ArgumentError] auth client does not support this client type
     def initialize(auth_client, options)

data/right_agent.gemspec

@@ -25,8 +25,8 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '2.4.1'
-  spec.date      = '2014-08-25'
+  spec.version   = '2.4.2'
+  spec.date      = '2014-08-26'
   spec.authors   = ['Lee Kirchhoff', 'Raphael Simon', 'Tony Spataro', 'Scott Messier']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_agent'

data/spec/clients/balanced_http_client_spec.rb

@@ -123,26 +123,26 @@ describe RightScale::BalancedHttpClient do
     end
 
     it "uses specified request UUID" do
-      @log.should_receive(:info).with("Requesting POST <my uuid> /foo/bar").once
+      @log.should_receive(:info).with("Requesting POST <my uuid> /foo/bar {}").once
       @log.should_receive(:info).with("Completed <my uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes")
       @client.request(:post, @path, @params, :request_uuid => "my uuid")
     end
 
     it "generates request UUID if none specified" do
-      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar").once
+      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar {}").once
       @log.should_receive(:info).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes").once
       @client.request(:post, @path)
     end
 
     it "logs request before sending it" do
-      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar").once
+      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar {}").once
       flexmock(@http_client).should_receive(:request).and_raise(RuntimeError).once
       @client.request(:post, @path) rescue nil
     end
 
     it "logs using specified :log_level" do
       @params = {:some => "data"}
-      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar").once
+      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\"}").once
       @log.should_receive(:debug).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes").once
       @client.request(:post, @path, @params, :log_level => :debug)
     end
@@ -170,7 +170,7 @@ describe RightScale::BalancedHttpClient do
     end
 
     it "logs successful completion of request" do
-      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar")
+      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar {}")
       @log.should_receive(:info).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes").once
       @client.request(:post, @path, @params, @options)
     end
@@ -530,27 +530,10 @@ describe RightScale::BalancedHttpClient do
     end
 
     context "when no exception" do
-
-      context "and Log.level is :info with no host" do
-        it "generates text containing path" do
-          text = @client.send(:log_text, @path, {:value => 123}, [])
-          text.should == "/foo/bar"
-        end
-      end
-
-      context "and Log.level is :info with host" do
-        it "generates text containing host and path" do
-          text = @client.send(:log_text, @path, {:value => 123}, [], @url)
-          text.should == "[http://my.com/foo/bar]"
-        end
-      end
-
-      context "and Log.level is :debug" do
-        it "generates text containing containing host, path, and filtered parameters" do
-          @log.should_receive(:level).and_return(:debug)
-          text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], @url)
-          text.should == "[http://my.com/foo/bar {:some=>\"data\", :secret=>\"<hidden>\"}]"
-        end
+      it "generates text containing containing host, path, and filtered parameters" do
+        @log.should_receive(:level).and_return(:debug)
+        text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], @url)
+        text.should == "[http://my.com/foo/bar {:some=>\"data\", :secret=>\"<hidden>\"}]"
       end
     end
 
@@ -593,6 +576,13 @@ describe RightScale::BalancedHttpClient do
     it "does not filter if params is not a hash" do
       @client.send(:filter, "params", ["secret"]).should == "params"
     end
+
+    it "also applies filters to any parameter named :payload or 'payload'" do
+      filter = ["secret", "very_secret"]
+      params = {:some => 1, :payload => {:secret => "data"}, "payload" => {:very_secret => "data"}, :secret => "data"}
+      @client.send(:filter, params, filter).should == {:some => 1, :payload => {:secret => "<hidden>"},
+                                                       "payload" => { :very_secret => "<hidden>"}, :secret => "<hidden>"}
+    end
   end
 
   context :split do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_agent
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Lee Kirchhoff
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_support