refactor and test

Author: davidsiaw

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-05-28 13:58:15 UTC using RuboCop version 1.64.0.
+# on 2024-06-12 14:52:30 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,22 +9,47 @@
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 26
+  Max: 21
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 24
+  Max: 20
+
+# Offense count: 4
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/redis_connections/application_redis_connection_spec.rb'
+    - 'spec/redis_connections/bridge_redis_connection_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Exclude:
     - 'spec/browser/restricted_area_spec.rb'
 
-# Offense count: 3
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
+# Offense count: 6
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 20
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  Exclude:
+    - 'spec/redis_connections/application_redis_connection_spec.rb'
+    - 'spec/redis_connections/bridge_redis_connection_spec.rb'
+
+# Offense count: 2
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 8
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
-    - 'app/controllers/application_controller.rb'
-    - 'app/controllers/websocket_controller.rb'
+    - 'spec/redis_connections/application_redis_connection_spec.rb'
+    - 'spec/redis_connections/bridge_redis_connection_spec.rb'
+    - 'spec/services/async_redis_service_spec.rb'
+    - 'spec/sockets/chat_socket_spec.rb'

Gemfile

@@ -56,6 +56,7 @@ gem 'async-websocket'
 gem 'thread-local'
 
 group :development, :test do
+  gem 'async-rspec'
   gem 'factory_bot_rails'
   gem 'pry-byebug', platforms: %i[mri mingw x64_mingw]
   gem 'rspec-rails'

Gemfile.lock

@@ -119,6 +119,10 @@ GEM
       io-endpoint (~> 0.10)
       io-stream (~> 0.4)
       protocol-redis (~> 0.8.0)
+    async-rspec (1.17.0)
+      rspec (~> 3.0)
+      rspec-files (~> 1.0)
+      rspec-memory (~> 1.0)
     async-service (0.12.0)
       async
       async-container (~> 0.16)
@@ -447,11 +451,19 @@ GEM
       railties (>= 5.2)
     rexml (3.3.0)
       strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-files (1.1.3)
+      rspec (~> 3.0)
+    rspec-memory (1.0.4)
+      rspec (~> 3.0)
     rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
@@ -587,6 +599,7 @@ DEPENDENCIES
   ar-uuid
   async-io
   async-redis
+  async-rspec
   async-websocket
   bcrypt (~> 3.1.19)
   bootsnap (>= 1.1.0)

app/channels/application_cable/channel.rb

@@ -1,22 +1,5 @@
 # frozen_string_literal: true
 
-require 'async/websocket/adapters/rails'
-
-require 'async/redis'
-require 'thread/local'
-
-module Chat
-  # Websocket control class
-  module Redis
-    extend Thread::Local
-
-    def self.local
-      endpoint = ::IO::Endpoint.tcp('redis', 6379)
-      Async::Redis::Client.new(endpoint)
-    end
-  end
-end
-
 # Entrypoint for all websocket connections to this server
 class WebsocketController < ApplicationController
   def index; end
@@ -26,34 +9,6 @@ def index; end
   def connect
     channel = params.fetch(:channel, 'chat.general')
 
-    self.response = Async::WebSocket::Adapters::Rails.open(request) do |connection|
-      Sync do
-        redisclient = Chat::Redis.instance
-        subscription_task = Async do
-          # Subscribe to the channel and broadcast incoming messages:
-          redisclient.subscribe(channel) do |context|
-            loop do
-              _type, _name, message = context.listen
-
-              # The message is text, but contains JSON.
-              connection.send_text(message)
-              connection.flush
-            end
-          end
-        end
-
-        # Perpetually read incoming messages and publish them to Redis:
-        while (message = connection.read)
-          logger.info "Messaged received => #{message.buffer}"
-          redisclient.publish(channel, message.buffer)
-        end
-      rescue Protocol::WebSocket::ClosedError
-        logger.info 'Websocket closed'
-        # Ignore.
-      ensure
-        logger.info "Subscription #{subscription_task} stopped"
-        subscription_task&.stop
-      end
-    end
+    self.response = ChatSocket.new(channel).open(request)
   end
 end

app/channels/application_cable/connection.rb

@@ -0,0 +1,25 @@
+Jobs
+----
+
+This is where you put your job classes. All workers must be named `something_job.rb`.
+
+To make a new kind of job just run the generator:
+
+`rails generate job Something`
+
+This will create
+
+```
+class SomethingJob < ApplicationJob
+  queue_as :default
+
+  def perform(*args)
+  end
+end
+```
+
+To run any job just run `SomethingJob.perform_later(params)`.
+
+More info:
+
+https://github.com/sidekiq/sidekiq/wiki/Active-Job

app/controllers/websocket_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Generic Redis Connection for applications to use
+class ApplicationRedisConnection
+  def initialize(channel)
+    @channel = channel
+    async_task
+  end
+
+  def on_message(msg_type, msg_name, msg_content); end
+
+  def publish(message)
+    async_redis.publish(@channel, message)
+  end
+
+  def close
+    return if @async_task.nil?
+
+    @async_task&.stop
+    @async_task = nil
+  end
+
+  private
+
+  def async_task
+    @async_task ||= Async do
+      async_redis.subscribe(@channel) do |context|
+        loop do
+          msg_type, msg_name, msg_content = context.listen
+          on_message(msg_type, msg_name, msg_content)
+        end
+      end
+    end
+  end
+
+  def async_redis
+    AsyncRedisService.default
+  end
+end

app/jobs/README.md

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# class to accept messages from redis channel and send it to the delegate
+class BridgeRedisConnection < ApplicationRedisConnection
+  def initialize(channel, delegate)
+    @delegate = delegate
+    super(channel)
+  end
+
+  def on_message(msg_type, msg_name, msg_content)
+    Rails.logger.debug { "redis message: #{msg_type}, #{msg_name}, #{msg_content}" }
+    return unless @delegate.respond_to?(:redis_message)
+
+    Rails.logger.debug 'send redis message'
+    @delegate&.redis_message(msg_content)
+  end
+end

app/redis_connections/application_redis_connection.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'async/redis'
+require 'thread/local'
+
+# Asynchronous Redis Client for pub sub purposes
+module AsyncRedisService
+  extend Thread::Local
+
+  def self.default
+    uri = URI.parse(default_redis_url)
+    endpoint = ::IO::Endpoint.tcp(uri.host, uri.port)
+    Async::Redis::Client.new(endpoint)
+  end
+
+  def self.default_redis_url
+    ENV.fetch('REDIS_URL', nil)
+  end
+end

app/redis_connections/bridge_redis_connection.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'async/websocket/adapters/rails'
+
+# Generic socket system for the application
+class ApplicationSocket
+  attr_reader :connection
+
+  def open(request)
+    Async::WebSocket::Adapters::Rails.open(request) do |connection|
+      Sync do
+        Rails.logger.debug { "Connection #{connection} opened" }
+        @connection = connection
+        on_open(connection)
+
+        while (message = connection.read)
+          on_message(message)
+        end
+      rescue Protocol::WebSocket::ClosedError
+        Rails.logger.debug { "Connection #{connection} closed" }
+        on_closed
+      rescue StandardError => e
+        Rails.logger.debug { "Connection #{connection} errored" }
+        Rails.logger.debug e
+        Rails.logger.debug e.backtrace
+        on_error(e)
+      ensure
+        Rails.logger.debug { "Connection #{connection} stopped" }
+      end
+    end
+  end
+
+  def on_message(message); end
+
+  def on_open(connection); end
+
+  def on_closed; end
+
+  def on_error(err); end
+end

app/services/async_redis_service.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# websocket handler for chat application
+class ChatSocket < ApplicationSocket
+  def initialize(channel_name)
+    @rc = BridgeRedisConnection.new(channel_name, self)
+    super()
+  end
+
+  def on_message(message)
+    Rails.logger.debug { "message callback: #{message.buffer}" }
+    @rc.publish(message.buffer)
+  end
+
+  def redis_message(message)
+    Rails.logger.debug { "redis receive: #{message}" }
+    connection.send_text(message)
+    connection.flush
+  rescue StandardError => e
+    Rails.logger.debug { "error: #{e.message}" }
+    @rc.close
+  end
+end

app/sockets/application_socket.rb

@@ -8,6 +8,7 @@
     sessions: 'admins/sessions'
   }
 
+  # remove these if you do not want the websocket endpoints
   get 'websocket', to: 'websocket#index'
   match 'connect', to: 'websocket#connect', via: %i[get connect]
 

app/sockets/chat_socket.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails_helper'
-
 RSpec.describe HealthApi, type: :request do
   it 'returns ok' do
     get '/api/v1/health'

app/workers/README.md

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails_helper'
 require 'browser_helper'
 
 RSpec.describe 'Restricted Area', :js, type: :browser do