startback-websocket 0.14.0 → 0.14.1

data/spec/unit/hub/test_builder.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'startback/websocket'
+
+module Startback
+  module Websocket
+    module Hub
+      describe Builder do
+
+        class TestMiddleware
+
+          def initialize(app, opts = {})
+            @app = app
+            @@init = true
+            @@opts = opts
+          end
+
+          def call(data, socket)
+            @@calls ||= []
+            @@calls << data
+            @app.call(data, socket)
+          end
+
+          def self.reset
+            @@init = false
+            @@calls = []
+          end
+
+          def self.init
+            @@init
+          end
+
+          def self.calls
+            @@calls
+          end
+
+          def self.opts
+            @@opts
+          end
+        end
+
+        before(:each) do
+          TestMiddleware.reset
+        end
+
+        it 'calls the block given at initialization' do
+          called = false
+          Builder.new(SpecHelpers::SubContext.new) { called = true }
+          expect(called).to eql(true)
+        end
+
+        context 'to_websocket_app' do
+          it 'returns an App instance' do
+            builder = Builder.new(SpecHelpers::SubContext.new) do
+            end
+            app = builder.to_websocket_app
+            expect(app).to be_a(App)
+          end
+        end
+
+        context 'to_handler' do
+
+          it 'instantiates middleware classes' do
+            handler = Builder.new(SpecHelpers::SubContext.new) do
+              use TestMiddleware
+            end.to_handler
+
+            expect(TestMiddleware.init).to eql(true)
+          end
+
+          it 'allows options to be passed to middleware classes' do
+            handler = Builder.new(SpecHelpers::SubContext.new) do
+              use TestMiddleware, { some: 'option' }
+            end.to_handler
+
+            expect(TestMiddleware.init).to eql(true)
+            expect(TestMiddleware.opts).to eql({ some: 'option' })
+          end
+
+          it 'creates the correct chain of handlers' do
+            handler = Builder.new(SpecHelpers::SubContext.new) do
+              use TestMiddleware
+              use TestMiddleware
+            end.to_handler
+
+            handler.call({test: 42}, SpecHelpers::MockSocket.new)
+            expect(TestMiddleware.calls.size).to eql(2)
+          end
+
+          it 'supports commands' do
+            handler = Builder.new(SpecHelpers::SubContext.new) do
+              command :hello do |command, socket|
+                socket.send('from hello')
+              end
+
+              command :foo do |command, socket|
+                socket.send('from foo')
+              end
+            end.to_handler
+
+            socket = SpecHelpers::MockSocket.new
+
+            msg = SpecHelpers::MockFayeEvent.new({ :headers => { :command => 'hello' } })
+            handler.call(msg, socket, {})
+            expect(socket.last_message).to eql('from hello')
+
+            msg = SpecHelpers::MockFayeEvent.new({ :headers => { :command => 'foo' } })
+            handler.call(msg, socket, {})
+            expect(socket.last_message).to eql('from foo')
+          end
+
+          it 'supports rooms' do
+            handler = Builder.new(SpecHelpers::SubContext.new) do
+              room 'a' do |room|
+                command :hello do |command, socket|
+                  socket.send("hi from #{room.name}!")
+                end
+              end
+
+              room 'b' do
+                command :hello do |command, socket|
+                  socket.send(command)
+                end
+              end
+            end.to_handler
+
+            socket = SpecHelpers::MockSocket.new
+
+            msg = SpecHelpers::MockFayeEvent.new({ :headers => { command: 'hello', room: 'a' } })
+            handler.call(msg, socket, {})
+            expect(socket.last_message).to eql('hi from a!')
+
+            msg = SpecHelpers::MockFayeEvent.new({ :headers => { command: 'hello', room: 'b' } })
+            handler.call(msg, socket, {})
+            expect(socket.last_message).to eql(msg)
+          end
+
+        end
+      end # describe
+    end # module Hub
+  end # module Websocket
+end # module Startback

data/spec/unit/hub/test_room.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'startback/websocket'
+
+module Startback
+  module Websocket
+    module Hub
+      describe Room do
+
+        context 'add' do
+
+          room = Room.new('room-name')
+
+          it 'expects participant instances' do
+            expect { room.add SpecHelpers.MockSocket.new }.to raise_error
+          end
+
+          it 'allows adding participants to the room' do
+            room.add Participant.new(SpecHelpers::MockSocket.new, SpecHelpers::SubContext.new)
+            expect(room.participants.size).to eql(1)
+          end
+
+        end
+
+      end # describe
+    end # module Hub
+  end # module Websocket
+end # module Startback

data/spec/unit/test_app.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'startback/websocket'
+
+module Startback
+  module Websocket
+    describe App do
+      include Rack::Test::Methods
+
+      def app
+        App.new(SpecHelpers::SubContext.new)
+      end
+
+      it 'returns a 400 when not used with proper websocket handshake' do
+        get '/'
+        expect(last_response.status).to eql(400)
+        expect(last_response.body).to eql('Websocket only!')
+      end
+
+      it 'does respond with proper handshake in the context of websocket connections' do
+        header 'connection', 'upgrade'
+        header 'upgrade', 'websocket'
+        get '/'
+        # https://github.com/faye/faye-websocket-ruby/blob/main/lib/faye/websocket.rb#L93
+        expect(last_response.status).to eql(-1)
+      end
+
+      it 'serves the javascript client properly' do
+        get '/client.js'
+        expect(last_response.status).to eql(200)
+        expect(last_response['Content-Type']).to eql('application/javascript')
+      end
+
+    end # describe
+  end # module Web
+end # module Startback

data/tasks/test.rake

@@ -1,5 +1,4 @@
 require 'rspec/core/rake_task'
-require 'path'
 
 namespace :test do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback-websocket
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: startback
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -121,95 +121,24 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- lib/startback.rb
-- lib/startback/audit.rb
-- lib/startback/audit/prometheus.rb
-- lib/startback/audit/shared.rb
-- lib/startback/audit/trailer.rb
-- lib/startback/caching/entity_cache.rb
-- lib/startback/caching/no_store.rb
-- lib/startback/caching/store.rb
-- lib/startback/context.rb
-- lib/startback/context/h_factory.rb
-- lib/startback/context/middleware.rb
-- lib/startback/errors.rb
-- lib/startback/event.rb
-- lib/startback/event/agent.rb
-- lib/startback/event/bus.rb
-- lib/startback/event/bus/bunny.rb
-- lib/startback/event/bus/bunny/async.rb
-- lib/startback/event/bus/memory.rb
-- lib/startback/event/bus/memory/async.rb
-- lib/startback/event/bus/memory/sync.rb
-- lib/startback/event/engine.rb
-- lib/startback/event/ext/context.rb
-- lib/startback/event/ext/operation.rb
 - lib/startback/ext.rb
-- lib/startback/ext/date_time.rb
-- lib/startback/ext/time.rb
-- lib/startback/model.rb
-- lib/startback/operation.rb
-- lib/startback/operation/error_operation.rb
-- lib/startback/operation/multi_operation.rb
-- lib/startback/services.rb
-- lib/startback/support.rb
-- lib/startback/support/data_object.rb
-- lib/startback/support/env.rb
-- lib/startback/support/fake_logger.rb
-- lib/startback/support/hooks.rb
-- lib/startback/support/log_formatter.rb
-- lib/startback/support/logger.rb
-- lib/startback/support/operation_runner.rb
-- lib/startback/support/robustness.rb
-- lib/startback/support/transaction_manager.rb
-- lib/startback/support/transaction_policy.rb
-- lib/startback/support/world.rb
-- lib/startback/version.rb
-- lib/startback/web/api.rb
-- lib/startback/web/auto_caching.rb
-- lib/startback/web/catch_all.rb
-- lib/startback/web/cors_headers.rb
-- lib/startback/web/health_check.rb
-- lib/startback/web/magic_assets.rb
-- lib/startback/web/magic_assets/ng_html_transformer.rb
-- lib/startback/web/magic_assets/rake_tasks.rb
-- lib/startback/web/middleware.rb
-- lib/startback/web/prometheus.rb
-- lib/startback/web/shield.rb
+- lib/startback/ext/context.rb
+- lib/startback/websocket.rb
+- lib/startback/websocket/app.rb
+- lib/startback/websocket/hub.rb
+- lib/startback/websocket/hub/app.rb
+- lib/startback/websocket/hub/builder.rb
+- lib/startback/websocket/hub/errors.rb
+- lib/startback/websocket/hub/message.rb
+- lib/startback/websocket/hub/middleware.rb
+- lib/startback/websocket/hub/middleware/command_handler.rb
+- lib/startback/websocket/hub/middleware/room_handler.rb
+- lib/startback/websocket/hub/participant.rb
+- lib/startback/websocket/hub/room.rb
 - spec/spec_helper.rb
-- spec/unit/audit/test_prometheus.rb
-- spec/unit/audit/test_trailer.rb
-- spec/unit/caching/test_entity_cache.rb
-- spec/unit/context/test_abstraction_factory.rb
-- spec/unit/context/test_dup.rb
-- spec/unit/context/test_fork.rb
-- spec/unit/context/test_h_factory.rb
-- spec/unit/context/test_middleware.rb
-- spec/unit/context/test_with_world.rb
-- spec/unit/context/test_world.rb
-- spec/unit/event/bus/memory/test_async.rb
-- spec/unit/event/bus/memory/test_sync.rb
-- spec/unit/support/hooks/test_after_hook.rb
-- spec/unit/support/hooks/test_before_hook.rb
-- spec/unit/support/operation_runner/test_around_run.rb
-- spec/unit/support/operation_runner/test_before_after_call.rb
-- spec/unit/support/test_data_object.rb
-- spec/unit/support/test_env.rb
-- spec/unit/support/test_robusteness.rb
-- spec/unit/support/test_transaction_manager.rb
-- spec/unit/support/test_world.rb
-- spec/unit/test_event.rb
-- spec/unit/test_operation.rb
-- spec/unit/test_support.rb
-- spec/unit/web/fixtures/assets/app/hello.es6
-- spec/unit/web/fixtures/assets/app/hello.html
-- spec/unit/web/fixtures/assets/index.es6
-- spec/unit/web/test_api.rb
-- spec/unit/web/test_auto_caching.rb
-- spec/unit/web/test_catch_all.rb
-- spec/unit/web/test_cors_headers.rb
-- spec/unit/web/test_healthcheck.rb
-- spec/unit/web/test_magic_assets.rb
+- spec/unit/hub/test_builder.rb
+- spec/unit/hub/test_room.rb
+- spec/unit/test_app.rb
 - tasks/test.rake
 homepage: https://www.enspirit.be
 licenses:

data/lib/startback/audit/prometheus.rb

@@ -1,87 +0,0 @@
-require_relative 'shared'
-require 'prometheus/client'
-
-module Startback
-  module Audit
-    #
-    # Prometheus exporter abstraction, that can be registered as an around
-    # hook on OperationRunner and as a prometheus client on Context instances.
-    #
-    # The exporter uses the ruby client for prometheus to expose metrics regarding Operation runs.
-    #
-    # The following metrics are exported:
-    #
-    # A counter 'operation_errors' (failed runs)
-    # A histogram 'operation_calls'
-    #
-    # All these metrics use the following labels
-    # - operation : class name of the operation executed
-    #
-    # Given that this Exporter is intended to be used as around hook on an
-    # `OperationRunner`, operations that fail at construction time will not be
-    # exported at all, since they can't be ran in the first place. This may lead
-    # to metrics not containing important errors cases if operations check their
-    # input at construction time.
-    #
-    class Prometheus
-      include Shared
-
-      def initialize(options = {})
-        @prefix = options[:prefix] || "startback"
-        @options = options
-        @registry = ::Prometheus::Client.registry
-        all_labels = [:operation, :startback_version] + option_labels.keys
-        @errors = @registry.counter(
-          :"#{prefix}_operation_errors",
-          docstring: 'A counter of operation errors',
-          labels: all_labels)
-        @calls = @registry.histogram(
-          :"#{prefix}_operation_calls",
-          docstring: 'A histogram of operation latency',
-          labels: all_labels)
-      end
-      attr_reader :registry, :calls, :errors, :options, :prefix
-
-      def call(runner, op)
-        name = op_name(op)
-        result = nil
-        time = Benchmark.realtime{
-          result = yield
-        }
-        ignore_safely {
-          @calls.observe(time, labels: get_labels(name))
-        }
-        result
-      rescue => ex
-        ignore_safely {
-          @errors.increment(labels: get_labels(name))
-        }
-        raise
-      end
-
-    protected
-
-      def ignore_safely
-        yield
-      rescue => ex
-        nil
-      end
-
-      def get_labels(op_name)
-        option_labels.merge({
-          operation: op_name,
-          startback_version: version
-        })
-      end
-
-      def option_labels
-        @options[:labels] || {}
-      end
-
-      def version
-        Startback::VERSION
-      end
-
-    end # class Prometheus
-  end # module Audit
-end # module Startback

data/lib/startback/audit/shared.rb

@@ -1,17 +0,0 @@
-module Startback
-  module Audit
-    module Shared
-
-      def op_name(op)
-        return op.op_name if op.respond_to?(:op_name)
-
-        case op
-        when String then op
-        when Class  then op.name
-        else op.class.name
-        end
-      end
-
-    end # module Shared
-  end # module Audit
-end # module Startback

data/lib/startback/audit/trailer.rb

@@ -1,129 +0,0 @@
-require_relative 'shared'
-require 'forwardable'
-module Startback
-  module Audit
-    #
-    # Log & Audit trail abstraction, that can be registered as an around
-    # hook on OperationRunner and as an actual logger on Context instances.
-    #
-    # The trail is outputted as JSON lines, using a Logger on the "device"
-    # passed at construction. The following JSON entries are dumped:
-    #
-    # - severity  : INFO or ERROR
-    # - time      : ISO8601 Datetime of operation execution
-    # - op        : class name of the operation executed
-    # - op_took   : Execution duration of the operation
-    # - op_data   : Dump of operation input data
-    # - context   : Execution context, through its `h` information contract (IC)
-    #
-    # Dumping of operation data follows the following duck typing conventions:
-    #
-    # - If the operation instance responds to `to_trail`, this data is taken
-    # - If the operation instance responds to `input`, this data is taken
-    # - If the operation instance responds to `request`, this data is taken
-    # - Otherwise op_data is a JSON null
-    #
-    # By contributing to the Context's `h` IC, users can easily dump information that
-    # makes sense (such as the operation execution requester).
-    #
-    # The class implements a sanitization process when dumping the context and
-    # operation data. Blacklisted words taken in construction options are used to
-    # prevent dumping hash keys that match them (insentively). Default stop words
-    # are equivalent to:
-    #
-    #     Trailer.new("/var/log/trail.log", {
-    #       blacklist: "token password secret credential"
-    #     })
-    #
-    # Please note that the sanitization process does not apply recursively if
-    # the operation data is hierarchic. It only applies to the top object of
-    # Hash and [Hash]. Use `Operation#to_trail` to fine-tune your audit trail.
-    #
-    # Given that this Trailer is intended to be used as around hook on an
-    # `OperationRunner`, operations that fail at construction time will not be
-    # trailed at all, since they can't be ran in the first place. This may lead
-    # to trails not containing important errors cases if operations check their
-    # input at construction time.
-    #
-    class Trailer
-      include Shared
-      extend Forwardable
-      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
-
-      DEFAULT_OPTIONS = {
-
-        # Words used to stop dumping for, e.g., security reasons
-        blacklist: "token password secret credential"
-
-      }
-
-      def initialize(device, options = {})
-        @options = DEFAULT_OPTIONS.merge(options)
-        @logger = ::Logger.new(device, 'daily')
-        @logger.formatter = Support::LogFormatter.new
-      end
-      attr_reader :logger, :options
-
-      def call(runner, op)
-        result = nil
-        time = Benchmark.realtime{ result = yield }
-        logger.info(op_to_trail(op, time))
-        result
-      rescue => ex
-        logger.error(op_to_trail(op, time, ex))
-        raise
-      end
-
-    protected
-
-      def op_to_trail(op, time = nil, ex = nil)
-        log_msg = {
-          op_took: time ? time.round(8) : nil,
-          op: op_name(op),
-          context: op_context(op),
-          op_data: op_data(op)
-        }.compact
-        log_msg[:error] = ex if ex
-        log_msg
-      end
-
-      def op_context(op)
-        sanitize(op.respond_to?(:context, false) ? op.context.to_h : {})
-      end
-
-      def op_data(op)
-        data = if op.respond_to?(:op_data, false)
-          op.op_data
-        elsif op.respond_to?(:to_trail, false)
-          op.to_trail
-        elsif op.respond_to?(:input, false)
-          op.input
-        elsif op.respond_to?(:request, false)
-          op.request
-        elsif op.is_a?(Operation::MultiOperation)
-          op.ops.map{ |sub_op| op_to_trail(sub_op) }
-        end
-        sanitize(data)
-      end
-
-      def sanitize(data)
-        case data
-        when Hash, OpenStruct
-          data.dup.delete_if{|k| k.to_s =~ blacklist_rx }
-        when Enumerable
-          data.map{|elm| sanitize(elm) }.compact
-        else
-          data
-        end
-      end
-
-      def blacklist_rx
-        @blacklist_rx ||= Regexp.new(
-          options[:blacklist].split(/\s+/).join("|"),
-          Regexp::IGNORECASE
-        )
-      end
-
-    end # class Trailer
-  end # module Audit
-end # module Startback

data/lib/startback/audit.rb

@@ -1,3 +0,0 @@
-require_relative 'audit/shared'
-require_relative 'audit/trailer'
-require_relative 'audit/prometheus'