switch to falcon

Author: davidsiaw

.circleci/config.yml

@@ -46,6 +46,7 @@ jobs:
           name: request to start recording video
           command: |
             docker-compose -f .circleci/compose.yml exec rails curl chromevideo:9494/start
+
       - run:
           name: run tests
           command: |
@@ -78,6 +79,7 @@ jobs:
           command: |
             sleep 3 # wait a bit for the video to finish being made
             docker-compose -f .circleci/compose.yml exec rails curl chromevideo:9494/stop
+
       - run:
           name: download the video
           when: always
@@ -168,6 +170,7 @@ jobs:
           command: |
             sleep 3 # wait a bit for the video to finish being made
             docker-compose -f .circleci/compose-unit.yml exec rails-unit curl chromevideo:9494/stop
+
       - run:
           name: download the video
           when: always

.rubocop.yml

@@ -37,3 +37,8 @@ Layout/LineLength:
 Style/SignalException:
   Exclude:
     - 'Dangerfile'
+
+# We don't want this
+Rails/ApplicationRecord:
+  Exclude:
+    - 'app/models/paper_trail/version.rb'

.rubocop_todo.yml

@@ -1,19 +1,30 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-05-26 05:10:14 UTC using RuboCop version 1.64.0.
+# on 2024-05-28 13:58:15 UTC using RuboCop version 1.64.0.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 24
+
 # Offense count: 1
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Exclude:
     - 'spec/browser/restricted_area_spec.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Rails/ApplicationRecord:
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
   Exclude:
-    - 'app/models/paper_trail/version.rb'
+    - 'app/controllers/application_controller.rb'
+    - 'app/controllers/websocket_controller.rb'

Dockerfile

@@ -32,10 +32,13 @@ ADD --chown=srv:srv config /srv/config
 ADD --chown=srv:srv spec /srv/spec
 ADD --chown=srv:srv app /srv/app
 
+RUN chown -R srv /srv && \
+    chgrp -R srv /srv
+
 USER srv
 
 EXPOSE 3000
 
 ENV RAILS_ENV=development
 
-CMD ["sh", "-c", "rails s -b 0.0.0.0 -p 3000"]
+CMD ["sh", "-c", "rails s -u falcon -b 0.0.0.0 -p 3000"]

Gemfile

@@ -7,8 +7,8 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gem 'rails', '~> 7'
 # Use postgresql as the database for Active Record
 gem 'pg', '>= 0.18', '< 2.0'
-# Use Puma as the app server
-gem 'puma', '~> 6.3'
+# Use falcon as webserver
+gem 'falcon'
 # Use SCSS for stylesheets
 gem 'sass-rails', '~> 6.0'
 # Use Uglifier as compressor for JavaScript assets
@@ -50,15 +50,20 @@ gem 'ulid-rails', git: 'https://github.com/davidsiaw/ulid-rails'
 gem 'sidekiq'
 gem 'sidekiq-scheduler'
 
+gem 'async-io'
+gem 'async-redis'
+gem 'async-websocket'
+gem 'thread-local'
+
 group :development, :test do
   gem 'factory_bot_rails'
   gem 'pry-byebug', platforms: %i[mri mingw x64_mingw]
   gem 'rspec-rails'
 end
 
 group :test do
-  gem 'capybara'
   gem 'database_cleaner'
+  gem 'falcon-capybara'
   gem 'rspec_junit_formatter'
   gem 'selenium-webdriver'
   gem 'shoulda-matchers'

Gemfile.lock

@@ -91,6 +91,41 @@ GEM
     ar-uuid (0.2.3)
       activerecord
     ast (2.4.2)
+    async (2.11.0)
+      console (~> 1.25, >= 1.25.2)
+      fiber-annotation
+      io-event (~> 1.5, >= 1.5.1)
+      timers (~> 4.1)
+    async-container (0.18.2)
+      async (~> 2.10)
+    async-http (0.66.3)
+      async (>= 2.10.2)
+      async-pool (>= 0.6.1)
+      io-endpoint (~> 0.10, >= 0.10.3)
+      io-stream (~> 0.4)
+      protocol-http (~> 0.26.0)
+      protocol-http1 (~> 0.19.0)
+      protocol-http2 (~> 0.17.0)
+      traces (>= 0.10.0)
+    async-http-cache (0.4.3)
+      async-http (~> 0.56)
+    async-io (1.43.2)
+      async
+    async-pool (0.6.1)
+      async (>= 1.25)
+    async-redis (0.8.1)
+      async (>= 1.8, < 3.0)
+      async-pool (~> 0.2)
+      io-endpoint (~> 0.10)
+      io-stream (~> 0.4)
+      protocol-redis (~> 0.8.0)
+    async-service (0.12.0)
+      async
+      async-container (~> 0.16)
+    async-websocket (0.26.1)
+      async-http (~> 0.54)
+      protocol-rack (~> 0.5)
+      protocol-websocket (~> 0.11)
     base32-crockford (0.1.0)
     base64 (0.2.0)
     bcrypt (3.1.20)
@@ -123,6 +158,10 @@ GEM
     colored2 (3.1.2)
     concurrent-ruby (1.3.1)
     connection_pool (2.4.1)
+    console (1.25.2)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
     cork (0.3.0)
       colored2 (~> 3.1)
     crass (1.0.6)
@@ -181,6 +220,22 @@ GEM
       railties (>= 5.0.0)
     faker (3.4.1)
       i18n (>= 1.8.11, < 2)
+    falcon (0.47.6)
+      async
+      async-container (~> 0.18)
+      async-http (~> 0.66, >= 0.66.3)
+      async-http-cache (~> 0.4.0)
+      async-service (~> 0.10)
+      bundler
+      localhost (~> 1.1)
+      openssl (~> 3.0)
+      process-metrics (~> 0.2.0)
+      protocol-rack (~> 0.5)
+      samovar (~> 2.3)
+    falcon-capybara (1.6.1)
+      capybara (~> 3.37)
+      falcon
+      selenium-webdriver
     faraday (2.9.0)
       faraday-net_http (>= 2.0, < 3.2)
     faraday-http-cache (2.5.1)
@@ -191,6 +246,10 @@ GEM
       faraday (~> 2.0)
     ffaker (2.23.0)
     ffi (1.16.3)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (0.1.1)
     fugit (1.11.0)
       et-orbi (~> 1, >= 1.2.11)
       raabro (~> 1.4)
@@ -223,6 +282,9 @@ GEM
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
+    io-endpoint (0.10.3)
+    io-event (1.5.1)
+    io-stream (0.4.0)
     irb (1.13.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
@@ -238,6 +300,7 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    localhost (1.3.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -246,6 +309,7 @@ GEM
       net-imap
       net-pop
       net-smtp
+    mapping (1.1.1)
     marcel (1.0.4)
     matrix (0.4.2)
     method_source (1.1.0)
@@ -281,6 +345,7 @@ GEM
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
+    openssl (3.2.0)
     orm_adapter (0.5.0)
     paper_trail (15.1.0)
       activerecord (>= 6.1)
@@ -290,6 +355,22 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.6)
+    process-metrics (0.2.1)
+      console (~> 1.8)
+      samovar (~> 2.1)
+    protocol-hpack (1.4.3)
+    protocol-http (0.26.5)
+    protocol-http1 (0.19.1)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.17.0)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    protocol-rack (0.5.1)
+      protocol-http (~> 0.23)
+      rack (>= 1.0)
+    protocol-redis (0.8.1)
+    protocol-websocket (0.13.0)
+      protocol-http (~> 0.2)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -299,8 +380,6 @@ GEM
     psych (5.1.2)
       stringio
     public_suffix (5.0.5)
-    puma (6.4.2)
-      nio4r (~> 2.0)
     raabro (1.4.0)
     racc (1.8.0)
     rack (3.0.11)
@@ -421,6 +500,9 @@ GEM
     rubyzip (2.3.2)
     rufus-scheduler (3.9.1)
       fugit (~> 1.1, >= 1.1.6)
+    samovar (2.3.0)
+      console (~> 1.0)
+      mapping (~> 1.0)
     sass-rails (6.0.0)
       sassc-rails (~> 2.1, >= 2.1.1)
     sassc (2.4.0)
@@ -466,8 +548,11 @@ GEM
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.3.1)
+    thread-local (1.1.0)
     tilt (2.3.0)
     timeout (0.4.1)
+    timers (4.3.5)
+    traces (0.11.1)
     trailblazer-option (0.1.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -502,16 +587,20 @@ PLATFORMS
 
 DEPENDENCIES
   ar-uuid
+  async-io
+  async-redis
+  async-websocket
   bcrypt (~> 3.1.19)
   bootsnap (>= 1.1.0)
   brakeman
   bundler-audit
-  capybara
   danger
   database_cleaner
   devise
   factory_bot_rails
   faker
+  falcon
+  falcon-capybara
   faraday-retry
   ffaker
   grape
@@ -524,7 +613,6 @@ DEPENDENCIES
   paper_trail
   pg (>= 0.18, < 2.0)
   pry-byebug
-  puma (~> 6.3)
   rails (~> 7)
   redis (~> 5.0)
   rspec-rails
@@ -542,6 +630,7 @@ DEPENDENCIES
   sidekiq-scheduler
   spring
   spring-watcher-listen (~> 2.1.0)
+  thread-local
   tzinfo-data
   uglifier (>= 1.3.0)
   ulid-rails!

app/assets/javascripts/client.js

@@ -0,0 +1,47 @@
+function connectToChatServer(url) {
+  console.log("WebSocket Connecting...", url);
+  var server = new WebSocket(url.href);
+  
+  server.onopen = function(event) {
+    console.log("WebSocket Connected:", server);
+    chat.disabled = false;
+    
+    chat.onkeypress = function(event) {
+      if (event.keyCode == 13) {
+        server.send(JSON.stringify({text: chat.value}));
+        
+        chat.value = "";
+      }
+    }
+  };
+  
+  server.onmessage = function(event) {
+    console.log("WebSocket Message:", event);
+    
+    var message = JSON.parse(event.data);
+    
+    var pre = document.createElement('pre');
+    pre.innerText = message.text;
+    
+    response.appendChild(pre);
+  };
+  
+  server.onerror = function(event) {
+    console.log("WebSocket Error:", event);
+    chat.disabled = true;
+    server.close();
+  };
+  
+  server.onclose = function(event) {
+    console.log("WebSocket Close:", event);
+    
+    setTimeout(function() {
+      connectToChatServer(url);
+    }, 1000);
+  };
+}
+
+var url = new URL('/connect', window.location.href);
+url.protocol = url.protocol.replace('http', 'ws');
+
+connectToChatServer(url);

app/assets/stylesheets/application.css

@@ -13,3 +13,8 @@
  *= require_tree .
  *= require_self
  */
+
+body {
+	background: #000;
+	color: #fff;
+}

app/controllers/application_controller.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
+# Every controller should inherit this
 class ApplicationController < ActionController::Base
+  def logger
+    Rails.logger
+  end
 end