istox_gruf 2.7.1

data/lib/gruf/synchronized_client.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+require 'concurrent'
+
+module Gruf
+  ##
+  # Ensures that we only have one active call to a given endpoint with a given set of params. This can be useful
+  # to mitigate thundering herds.
+  #
+  class SynchronizedClient < Gruf::Client
+    attr_reader :unsynchronized_methods
+
+    ##
+    # Initialize the client and setup the stub
+    #
+    # @param [Module] service The namespace of the client Stub that is desired to load
+    # @param [Hash] options A hash of options for the client
+    # @option options [Array] :unsynchronized_methods A list of methods (as symbols) that
+    #   should be excluded from synchronization
+    # @option options [Integer] :internal_cache_expiry The length of time to keep results
+    #   around for other threads to fetch (in seconds)
+    # @param [Hash] client_options A hash of options to pass to the gRPC client stub
+    #
+    def initialize(service:, options: {}, client_options: {})
+      @unsynchronized_methods = options.delete(:unsynchronized_methods) { [] }
+      @expiry = options.delete(:internal_cache_expiry) { Gruf.synchronized_client_internal_cache_expiry }
+      @locks = Concurrent::Map.new
+      @results = Concurrent::Map.new
+      super
+    end
+
+    ##
+    # Call the client's method with given params. If another call is already active for the same endpoint and the same
+    # params, block until the active call is complete. When unblocked, callers will get a copy of the original result.
+    #
+    # @param [String|Symbol] request_method The method that is being requested on the service
+    # @param [Hash] params (Optional) A hash of parameters that will be inserted into the gRPC request
+    #   message that is required for the given above call
+    # @param [Hash] metadata (Optional) A hash of metadata key/values that are transported with the client request
+    # @param [Hash] opts (Optional) A hash of options to send to the gRPC request_response method
+    # @return [Gruf::Response] The response from the server
+    # @raise [Gruf::Client::Error|GRPC::BadStatus] If an error occurs, an exception will be raised according to the
+    # error type that was returned
+    #
+    def call(request_method, params = {}, metadata = {}, opts = {}, &block)
+      # Allow for bypassing extra behavior for selected methods
+      return super if unsynchronized_methods.include?(request_method.to_sym)
+
+      # Generate a unique key based on the method and params
+      key = "#{request_method}.#{params.hash}"
+
+      # Create a lock for this call if we haven't seen it already, then acquire it
+      lock = @locks.compute_if_absent(key) { Mutex.new }
+      lock.synchronize do
+        # Return value from results cache if it exists. This occurs for callers that were
+        # waiting on the lock while the first caller was making the actual grpc call.
+        response = @results.get(lock)
+        if response
+          Gruf.logger.debug "Returning cached result for #{key}:#{lock.inspect}"
+          next response
+        end
+
+        # Make the grpc call and record response for other callers that are blocked
+        # on the same lock
+        response = super
+        @results.put(lock, response)
+
+        # Schedule a task to come in later and clean out result to prevent memory bloat
+        Concurrent::ScheduledTask.new(@expiry, args: [@results, lock]) { |h, k| h.delete(k) }.execute
+
+        # Remove the lock from the map. The next caller to come through with the
+        # same params will create a new lock and start the process over again.
+        # Anyone who was waiting on this call will be using a local reference
+        # to the same lock as us, and will fetch the result from the cache.
+        @locks.delete(key)
+
+        # Return response
+        response
+      end
+    end
+  end
+end

data/lib/gruf/timer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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 Gruf
+  ##
+  # Times a given block and returns the result and the elapsed time as a Float
+  #
+  #   result = Timer.time { do_my_thing }
+  #
+  class Timer
+    ##
+    # Represents a timer result that contains both the elapsed time and the result of the block
+    #
+    #   result = Timer.time { do_my_thing }
+    #   result.time # => 1.10123
+    #   result.result # => 'my_thing_is_done'
+    #
+    class Result
+      # @return [Object] result The result of the block that was called
+      attr_reader :result
+      # @return [Float] time The time, in ms, of the block execution
+      attr_reader :time
+
+      ##
+      # Initialize the result object
+      #
+      # @param [Object] result The result of the block that was called
+      # @param [Float] time The time, in ms, of the block execution
+      #
+      def initialize(result, time)
+        @result = result
+        @time = time.to_f
+      end
+
+      ##
+      # Was this result a successful result?
+      #
+      # @return [Boolean] Whether or not this result was a success
+      #
+      def success?
+        !result.is_a?(GRPC::BadStatus) && !result.is_a?(StandardError) && !result.is_a?(GRPC::Core::CallError)
+      end
+    end
+
+    ##
+    # Times a given block by recording start and end times
+    #
+    #  result = Timer.time { do_my_thing }
+    #
+    # @return [Timer::Result] Returns the timed result of the block
+    #
+    def self.time
+      start_time = Time.now
+      begin
+        result = yield
+      rescue GRPC::BadStatus, StandardError, GRPC::Core::CallError => e
+        result = e
+      end
+      end_time = Time.now
+      elapsed = (end_time - start_time) * 1000.0
+      Result.new(result, elapsed)
+    end
+  end
+end

data/lib/gruf/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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 Gruf
+  VERSION = '2.7.1'
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: istox_gruf
+version: !ruby/object:Gem::Version
+  version: 2.7.1
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+description: gRPC Ruby Framework for building complex gRPC applications at scale
+email:
+- splittingred@gmail.com
+executables:
+- gruf
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/gruf
+- lib/gruf.rb
+- lib/gruf/cli/executor.rb
+- lib/gruf/client.rb
+- lib/gruf/client/error.rb
+- lib/gruf/client/error_factory.rb
+- lib/gruf/configuration.rb
+- lib/gruf/controllers/base.rb
+- lib/gruf/controllers/request.rb
+- lib/gruf/controllers/service_binder.rb
+- lib/gruf/error.rb
+- lib/gruf/errors/debug_info.rb
+- lib/gruf/errors/field.rb
+- lib/gruf/errors/helpers.rb
+- lib/gruf/hooks/base.rb
+- lib/gruf/hooks/executor.rb
+- lib/gruf/hooks/registry.rb
+- lib/gruf/instrumentable_grpc_server.rb
+- lib/gruf/integrations/rails/railtie.rb
+- lib/gruf/interceptors/active_record/connection_reset.rb
+- lib/gruf/interceptors/authentication/basic.rb
+- lib/gruf/interceptors/base.rb
+- lib/gruf/interceptors/client_interceptor.rb
+- lib/gruf/interceptors/context.rb
+- lib/gruf/interceptors/instrumentation/output_metadata_timer.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/logstash.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/plain.rb
+- lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb
+- lib/gruf/interceptors/instrumentation/statsd.rb
+- lib/gruf/interceptors/registry.rb
+- lib/gruf/interceptors/server_interceptor.rb
+- lib/gruf/interceptors/timer.rb
+- lib/gruf/loggable.rb
+- lib/gruf/logging.rb
+- lib/gruf/outbound/request_context.rb
+- lib/gruf/response.rb
+- lib/gruf/serializers/errors/base.rb
+- lib/gruf/serializers/errors/json.rb
+- lib/gruf/server.rb
+- lib/gruf/synchronized_client.rb
+- lib/gruf/timer.rb
+- lib/gruf/version.rb
+homepage: https://github.com/bigcommerce/gruf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: gRPC Ruby Framework
+test_files: []