thrift_server 0.1.1 → 1.0.0

data/test/thread_pool_server_test.rb

@@ -0,0 +1,101 @@
+require_relative 'test_helper'
+
+class ThreadPoolSeverTest < MiniTest::Unit::TestCase
+  include ServerTests
+
+  attr_reader :service
+
+  def setup
+    @service = TestService
+  end
+
+  def build(*args, &block)
+    ThriftServer.send :thread_pool, *args, &block
+  end
+
+  def test_returns_thread_pool_server
+    server = build service, stub
+
+    assert_kind_of Thrift::ThreadPoolServer, server
+  end
+
+  def test_defaults_to_25_threads
+    server = build service, stub
+
+    assert_equal 25, server.threads
+  end
+
+  def test_accepts_threads_option
+    server = build(service, stub, {
+      threads: 8
+    })
+
+    assert_equal 8, server.threads
+  end
+
+  def test_attaches_its_own_log_subscriber
+    ThriftServer::ThreadPoolServer::LogSubscriber.expects(:new).with(:stdout).returns(:custom)
+
+    server = build(service, stub) do |server|
+      server.log :stdout
+    end
+
+    assert_includes server.publisher, :custom
+  end
+
+  def test_start_up_logging
+    logger = mock
+    subscriber = ThriftServer::ThreadPoolServer::LogSubscriber.new LogYielder.new(logger)
+
+    server = stub({
+      port: 9999,
+      threads: 30,
+      transport: 'StubTransport',
+      protocol: 'StubProtocol'
+    })
+
+    logger.expects(:info).with do |line|
+      line =~ /9999/
+    end
+
+    logger.expects(:info).with do |line|
+      line =~ /30/
+    end
+
+    logger.expects(:info).with do |line|
+      line =~ /StubTransport/
+    end
+
+    logger.expects(:info).with do |line|
+      line =~ /StubProtocol/
+    end
+
+    subscriber.server_start server
+  end
+
+  def test_attaches_own_metrics_subcriber
+    ThriftServer::ThreadPoolServer::MetricsSubscriber.expects(:new).with(:statsd).returns(:custom)
+
+    server = build(service, stub) do |server|
+      server.metrics :statsd
+    end
+
+    assert_includes server.publisher, :custom
+  end
+
+  def test_thread_pool_server_pool_change_with_positive_delta
+    statsd = mock
+    subscriber = ThriftServer::ThreadPoolServer::MetricsSubscriber.new statsd
+
+    statsd.expects(:gauge).with('server.pool.size', '+1')
+    subscriber.thread_pool_server_pool_change delta: 1
+  end
+
+  def test_thread_pool_server_pool_change_with_negative_delta
+    statsd = mock
+    subscriber = ThriftServer::ThreadPoolServer::MetricsSubscriber.new statsd
+
+    statsd.expects(:gauge).with('server.pool.size', '-1')
+    subscriber.thread_pool_server_pool_change delta: -1
+  end
+end

data/test/threaded_server_test.rb

@@ -0,0 +1,56 @@
+require_relative 'test_helper'
+
+class ThreadedServerTest < MiniTest::Unit::TestCase
+  include ServerTests
+
+  attr_reader :service
+
+  def setup
+    @service = TestService
+  end
+
+  def build(*args, &block)
+    ThriftServer.send :threaded, *args, &block
+  end
+
+  def test_is_threaded_server
+    server = build service, stub
+
+    assert_kind_of Thrift::ThreadedServer, server
+  end
+
+  def test_attaches_its_own_log_subscriber
+    ThriftServer::ThreadedServer::LogSubscriber.expects(:new).with(:stdout).returns(:custom)
+
+    server = build(service, stub) do |server|
+      server.log :stdout
+    end
+
+    assert_includes server.publisher, :custom
+  end
+
+  def test_start_up_logging
+    logger = mock
+    subscriber = ThriftServer::ThreadedServer::LogSubscriber.new LogYielder.new(logger)
+
+    server = stub({
+      port: 9999,
+      transport: 'StubTransport',
+      protocol: 'StubProtocol'
+    })
+
+    logger.expects(:info).with do |line|
+      line =~ /9999/
+    end
+
+    logger.expects(:info).with do |line|
+      line =~ /StubTransport/
+    end
+
+    logger.expects(:info).with do |line|
+      line =~ /StubProtocol/
+    end
+
+    subscriber.server_start server
+  end
+end

data/test/validation_middleware_test.rb

@@ -0,0 +1,71 @@
+require_relative 'test_helper'
+
+class ValidationMiddlewareTest < MiniTest::Unit::TestCase
+  class StructResponse
+    include ::Thrift::Struct
+
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def ==(other)
+      id == other.id
+    end
+  end
+
+  class UnionResponse
+    include ::Thrift::Struct_Union
+
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def ==(other)
+      id == other.id
+    end
+  end
+
+  attr_reader :rpc, :validator
+
+  def setup
+    @rpc = ThriftServer::RPC.new :foo, :bar
+    @validator = mock
+  end
+
+  def test_validates_struct_responses
+    response = StructResponse.new :struct
+    Thrift::Validator.expects(:new).returns validator
+    validator.expects(:validate).with(response)
+
+    app = stub call: response
+
+    middleware = ThriftServer::ValidationMiddleware.new app
+
+    assert_equal response, middleware.call(rpc)
+  end
+
+  def test_validates_union_responses
+    response = UnionResponse.new :union
+    Thrift::Validator.expects(:new).returns validator
+    validator.expects(:validate).with(response)
+
+    app = stub call: response
+
+    middleware = ThriftServer::ValidationMiddleware.new app
+
+    assert_equal response, middleware.call(rpc)
+  end
+
+  def test_passes_on_non_structs
+    app = stub call: :response
+    validator.expects(:validate).never
+
+    middleware = ThriftServer::ValidationMiddleware.new app
+
+    assert_equal :response, middleware.call(rpc)
+  end
+end

data/thrift_server.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "thrift_server"
   spec.version       = ThriftServer::VERSION
   spec.authors       = ["ahawkins"]
-  spec.email         = ["adam@saltside.se"]
+  spec.email         = ["hi@ahawkins.me"]
   spec.summary       = %q{Encapsulate error handling, logging, and metrics for thrift servers}
   spec.description   = %q{}
   spec.homepage      = "https://github.com/saltside/thrift_server-ruby"
@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "statsd-ruby"
   spec.add_dependency "middleware"
   spec.add_dependency "concord"
-  spec.add_dependency "honeybadger"
   spec.add_dependency "thrift"
+  spec.add_dependency "thrift-validator"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thrift_server
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - ahawkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: honeybadger
+  name: thrift
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thrift
+  name: thrift-validator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,7 +152,7 @@ dependencies:
         version: '0'
 description: ''
 email:
-- adam@saltside.se
+- hi@ahawkins.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -167,23 +167,31 @@ files:
 - Rakefile
 - Vagrantfile
 - benchmark/server.rb
+- circle.yml
 - echo_client.rb
 - echo_server.rb
 - echo_service.thrift
 - lib/thrift_server.rb
-- lib/thrift_server/error_tracking_middleware.rb
-- lib/thrift_server/honeybadger_error_tracker.rb
-- lib/thrift_server/logging_middleware.rb
-- lib/thrift_server/metrics_middleware.rb
+- lib/thrift_server/instrumentation_middleware.rb
+- lib/thrift_server/log_subscriber.rb
+- lib/thrift_server/publisher.rb
+- lib/thrift_server/rpc_metrics_subscriber.rb
+- lib/thrift_server/server_metrics_subscriber.rb
+- lib/thrift_server/thread_pool_server.rb
+- lib/thrift_server/threaded_server.rb
+- lib/thrift_server/validation_middleware.rb
 - lib/thrift_server/version.rb
-- script/buildbox/ci
-- script/buildbox/step_failed
-- test/acceptance_test.rb
-- test/error_tracking_middleware_test.rb
-- test/honeybadger_error_tracking_test.rb
-- test/logging_middleware_test.rb
-- test/metrics_middleware_test.rb
+- script/circleci/cache-image
+- test/log_subscriber_test.rb
+- test/processor_test.rb
+- test/rpc_metrics_subscriber_test.rb
+- test/server_metrics_subscriber_test.rb
+- test/support/log_yielder.rb
+- test/support/server_tests.rb
 - test/test_helper.rb
+- test/thread_pool_server_test.rb
+- test/threaded_server_test.rb
+- test/validation_middleware_test.rb
 - thrift_server.gemspec
 homepage: https://github.com/saltside/thrift_server-ruby
 licenses:
@@ -205,14 +213,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Encapsulate error handling, logging, and metrics for thrift servers
 test_files:
-- test/acceptance_test.rb
-- test/error_tracking_middleware_test.rb
-- test/honeybadger_error_tracking_test.rb
-- test/logging_middleware_test.rb
-- test/metrics_middleware_test.rb
+- test/log_subscriber_test.rb
+- test/processor_test.rb
+- test/rpc_metrics_subscriber_test.rb
+- test/server_metrics_subscriber_test.rb
+- test/support/log_yielder.rb
+- test/support/server_tests.rb
 - test/test_helper.rb
+- test/thread_pool_server_test.rb
+- test/threaded_server_test.rb
+- test/validation_middleware_test.rb

data/lib/thrift_server/error_tracking_middleware.rb

@@ -1,12 +0,0 @@
-class ThriftServer
-  class ErrorTrackingMiddleware
-    include Concord.new(:app, :logger)
-
-    def call(rpc)
-      app.call rpc
-    rescue => ex
-      logger.track rpc, ex
-      raise ex
-    end
-  end
-end

data/lib/thrift_server/honeybadger_error_tracker.rb

@@ -1,11 +0,0 @@
-class ThriftServer
-  class HoneybadgerErrorTracker
-    def initialize(client = Honeybadger)
-      @client = client
-    end
-
-    def track(rpc, error)
-      @client.notify_or_ignore error
-    end
-  end
-end

data/lib/thrift_server/logging_middleware.rb

@@ -1,13 +0,0 @@
-class ThriftServer
-  class LoggingMiddleware
-    include Concord.new(:app, :logger)
-
-    def call(rpc)
-      logger.info "Incoming RPC: #{rpc.name}"
-      app.call rpc
-    rescue => ex
-      logger.error ex
-      raise ex
-    end
-  end
-end

data/lib/thrift_server/metrics_middleware.rb

@@ -1,16 +0,0 @@
-class ThriftServer
-  class MetricsMiddleware
-    include Concord.new(:app, :statsd)
-
-    def call(rpc)
-      statsd.increment rpc.name
-
-      statsd.time rpc.name do
-        app.call rpc
-      end
-    rescue => ex
-      statsd.increment 'errors'
-      raise ex
-    end
-  end
-end

data/script/buildbox/ci

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-set -eou pipefail
-
-make test-ci clean

data/script/buildbox/step_failed

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-set -eou pipefail
-
-make clean

data/test/acceptance_test.rb

@@ -1,225 +0,0 @@
-require_relative 'test_helper'
-
-class AcceptanceTest < MiniTest::Unit::TestCase
-  attr_reader :processor
-
-  def setup
-    @processor = Processor(:getItems)
-  end
-
-  def wrap(klass, &block)
-    ThriftServer.wrap(processor, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new,
-    }, &block)
-  end
-
-  def test_wrap_fails_if_no_logger
-    ex = assert_raises ArgumentError do
-      ThriftServer.wrap(processor, {
-        statsd: FakeStatsd.new,
-        error_tracker: NullErrorTracker.new,
-      })
-    end
-
-    assert_match /logger/, ex.to_s
-  end
-
-  def test_wrap_fails_if_no_stats
-    ex = assert_raises ArgumentError do
-      ThriftServer.wrap(processor, {
-        logger: NullLogger.new,
-        error_tracker: NullErrorTracker.new,
-      })
-    end
-
-    assert_match /statsd/, ex.to_s
-  end
-
-  def test_wrap_fails_if_no_error_tracker
-    ex = assert_raises ArgumentError do
-      ThriftServer.wrap(processor, {
-        logger: NullLogger.new,
-        statsd: FakeStatsd.new
-      })
-    end
-
-    assert_match /error_tracker/, ex.to_s
-  end
-
-  def test_wraps_methods_defined_by_the_protocol
-    handler = stub
-    handler.expects(:getItems).with(:request).returns(:response)
-
-    stack = wrap(processor).new(handler)
-
-    assert_equal :response, stack.process_getItems(:request)
-  end
-
-  def test_can_add_new_middleware_after_wrapping
-    handler = mock
-    handler.expects(:getItems).with(:modified_args)
-
-    stack = wrap(processor).new(handler)
-
-    test_middleware = Class.new do
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        env.args = :modified_args
-        @app.call env
-      end
-    end
-
-    stack.use test_middleware
-
-    stack.process_getItems :request
-  end
-
-  def test_cannot_add_middleware_to_stack_after_first_rpc
-    handler = stub getItems: :response
-
-    stack = wrap(processor).new(handler)
-
-    stack.process_getItems :request
-
-    ex = assert_raises RuntimeError do
-      stack.use ->(rpc) { rpc }
-    end
-
-    assert_match /frozen/, ex.to_s
-  end
-
-  def test_wrap_yields_the_middleware_stack
-    handler = mock
-    handler.expects(:getItems).with(:from_block)
-
-    test_middleware = Class.new do
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        env.args = :from_block
-        @app.call env
-      end
-    end
-
-    stack_processor = wrap processor do |stack|
-      stack.use test_middleware
-    end
-    stack = stack_processor.new(handler)
-
-    stack.process_getItems :request
-  end
-
-  def test_build_returns_thread_pool_server
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_instance_of Thrift::ThreadPoolServer, server
-  end
-
-  def test_build_defaults_to_port_9090
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_equal 9090, server.port
-  end
-
-  def test_build_accepts_port_options
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new,
-      port: 5000
-    })
-
-    assert_equal 5000, server.port
-  end
-
-  def test_build_defaults_to_4_threads
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_equal 4, server.threads
-  end
-
-  def test_build_accepts_threads_option
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new,
-      threads: 8
-    })
-
-    assert_equal 8, server.threads
-  end
-
-  def test_builds_creates_server_with_framed_transport
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_instance_of Thrift::FramedTransportFactory, server.transport_factory
-  end
-
-  def test_build_uses_server_socket_transport
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_instance_of Thrift::ServerSocket, server.server_transport
-  end
-
-  def test_build_creates_server_with_binary_protocol
-    handler = stub getItems: :response
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    })
-
-    assert_instance_of Thrift::BinaryProtocolFactory, server.protocol_factory
-  end
-
-  def test_buil_accepts_a_block_to_customize_the_middleware_stack
-    handler = stub getItems: :response
-    block_yielded = false
-
-    server = ThriftServer.build(processor, handler, {
-      logger: NullLogger.new,
-      statsd: FakeStatsd.new,
-      error_tracker: NullErrorTracker.new
-    }) do |stack|
-      block_yielded = true
-
-      assert_instance_of ThriftServer::MiddlewareStack, stack
-    end
-
-    assert block_yielded, 'Block not used'
-  end
-end