rails_live_reload 0.1.0 → 0.2.0

data/lib/rails_live_reload/web_socket/event_loop.rb

@@ -0,0 +1,131 @@
+require "nio"
+
+module RailsLiveReload
+  module WebSocket
+    # This class is basically copied from ActionCable
+    # https://github.com/rails/rails/blob/v7.0.3/actioncable/lib/action_cable/connection/stream_event_loop.rb
+    class EventLoop
+      def initialize
+        @nio = @executor = @thread = nil
+        @map = {}
+        @stopping = false
+        @todo = Queue.new
+        @spawn_mutex = Mutex.new
+      end
+
+      def timer(interval, &block)
+        Concurrent::TimerTask.new(execution_interval: interval, &block).tap(&:execute)
+      end
+
+      def post(task = nil, &block)
+        task ||= block
+
+        spawn
+        @executor << task
+      end
+
+      def attach(io, stream)
+        @todo << lambda do
+          @map[io] = @nio.register(io, :r)
+          @map[io].value = stream
+        end
+        wakeup
+      end
+
+      def detach(io, stream)
+        @todo << lambda do
+          @nio.deregister io
+          @map.delete io
+          io.close
+        end
+        wakeup
+      end
+
+      def writes_pending(io)
+        @todo << lambda do
+          if monitor = @map[io]
+            monitor.interests = :rw
+          end
+        end
+        wakeup
+      end
+
+      def stop
+        @stopping = true
+        wakeup if @nio
+      end
+
+      private
+
+      def spawn
+        return if @thread && @thread.status
+
+        @spawn_mutex.synchronize do
+          return if @thread && @thread.status
+
+          @nio ||= NIO::Selector.new
+
+          @executor ||= Concurrent::ThreadPoolExecutor.new(
+            min_threads: 1,
+            max_threads: 10,
+            max_queue: 0,
+          )
+
+          @thread = Thread.new { run }
+
+          return true
+        end
+      end
+
+      def wakeup
+        spawn || @nio.wakeup
+      end
+
+      def run
+        loop do
+          if @stopping
+            @nio.close
+            break
+          end
+
+          until @todo.empty?
+            @todo.pop(true).call
+          end
+
+          next unless monitors = @nio.select
+
+          monitors.each do |monitor|
+            io = monitor.io
+            stream = monitor.value
+
+            begin
+              if monitor.writable?
+                if stream.flush_write_buffer
+                  monitor.interests = :r
+                end
+                next unless monitor.readable?
+              end
+
+              incoming = io.read_nonblock(4096, exception: false)
+              case incoming
+              when :wait_readable
+                next
+              when nil
+                stream.close
+              else
+                stream.receive incoming
+              end
+            rescue
+              begin
+                stream.close
+              rescue
+                @nio.deregister io
+                @map.delete io
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_live_reload/web_socket/message_buffer.rb

@@ -0,0 +1,53 @@
+module RailsLiveReload
+  module WebSocket
+    # This class is basically copied from ActionCable
+    # https://github.com/rails/rails/blob/v7.0.3/actioncable/lib/action_cable/connection/message_buffer.rb
+    class MessageBuffer
+      def initialize(connection)
+        @connection = connection
+        @buffered_messages = []
+      end
+
+      def append(message)
+        if valid? message
+          if processing?
+            receive message
+          else
+            buffer message
+          end
+        else
+          raise ArgumentError, "Couldn't handle non-string message: #{message.class}"
+        end
+      end
+
+      def processing?
+        @processing
+      end
+
+      def process!
+        @processing = true
+        receive_buffered_messages
+      end
+
+      private
+
+      attr_reader :connection, :buffered_messages
+
+      def valid?(message)
+        message.is_a?(String)
+      end
+
+      def receive(message)
+        connection.receive message
+      end
+
+      def buffer(message)
+        buffered_messages << message
+      end
+
+      def receive_buffered_messages
+        receive buffered_messages.shift until buffered_messages.empty?
+      end
+    end
+  end
+end

data/lib/rails_live_reload/web_socket/stream.rb

@@ -0,0 +1,109 @@
+module RailsLiveReload
+  module WebSocket
+    # This class is basically copied from ActionCable
+    # https://github.com/rails/rails/blob/v7.0.3/actioncable/lib/action_cable/connection/stream.rb
+    class Stream
+      def initialize(event_loop, socket)
+        @event_loop    = event_loop
+        @socket_object = socket
+        @stream_send   = socket.env["stream.send"]
+
+        @rack_hijack_io = nil
+        @write_lock = Mutex.new
+
+        @write_head = nil
+        @write_buffer = Queue.new
+      end
+
+      def each(&callback)
+        @stream_send ||= callback
+      end
+
+      def close
+        shutdown
+        @socket_object.client_gone
+      end
+
+      def shutdown
+        clean_rack_hijack
+      end
+
+      def write(data)
+        if @stream_send
+          return @stream_send.call(data)
+        end
+
+        if @write_lock.try_lock
+          begin
+            if @write_head.nil? && @write_buffer.empty?
+              written = @rack_hijack_io.write_nonblock(data, exception: false)
+
+              case written
+              when :wait_writable
+              when data.bytesize
+                return data.bytesize
+              else
+                @write_head = data.byteslice(written, data.bytesize)
+                @event_loop.writes_pending @rack_hijack_io
+
+                return data.bytesize
+              end
+            end
+          ensure
+            @write_lock.unlock
+          end
+        end
+
+        @write_buffer << data
+        @event_loop.writes_pending @rack_hijack_io
+
+        data.bytesize
+      rescue EOFError, Errno::ECONNRESET
+        @socket_object.client_gone
+      end
+
+      def flush_write_buffer
+        @write_lock.synchronize do
+          loop do
+            if @write_head.nil?
+              return true if @write_buffer.empty?
+              @write_head = @write_buffer.pop
+            end
+
+            written = @rack_hijack_io.write_nonblock(@write_head, exception: false)
+            case written
+            when :wait_writable
+              return false
+            when @write_head.bytesize
+              @write_head = nil
+            else
+              @write_head = @write_head.byteslice(written, @write_head.bytesize)
+              return false
+            end
+          end
+        end
+      end
+
+      def receive(data)
+        @socket_object.parse(data)
+      end
+
+      def hijack_rack_socket
+        return unless @socket_object.env["rack.hijack"]
+
+        @rack_hijack_io = @socket_object.env["rack.hijack"].call
+        @rack_hijack_io ||= @socket_object.env["rack.hijack_io"]
+
+        @event_loop.attach(@rack_hijack_io, self)
+      end
+
+      private
+
+      def clean_rack_hijack
+        return unless @rack_hijack_io
+        @event_loop.detach(@rack_hijack_io, self)
+        @rack_hijack_io = nil
+      end
+    end
+  end
+end

data/lib/rails_live_reload/web_socket/wrapper.rb

@@ -0,0 +1,27 @@
+require "websocket/driver"
+
+module RailsLiveReload
+  module WebSocket
+    # This class is basically copied from ActionCable
+    # https://github.com/rails/rails/blob/v7.0.3/actioncable/lib/action_cable/connection/web_socket.rb
+    class Wrapper
+      delegate :transmit, :close, :protocol, :rack_response, to: :websocket
+
+      def initialize(env, event_target, event_loop, protocols: RailsLiveReload::INTERNAL[:protocols])
+        @websocket = ::WebSocket::Driver.websocket?(env) ? ClientSocket.new(env, event_target, event_loop, protocols) : nil
+      end
+
+      def possible?
+        websocket
+      end
+
+      def alive?
+        websocket && websocket.alive?
+      end
+
+      private
+
+      attr_reader :websocket
+    end
+  end
+end

data/lib/rails_live_reload.rb

@@ -1,11 +1,11 @@
 require "listen"
 require "rails_live_reload/version"
 require "rails_live_reload/config"
-require "rails_live_reload/client"
 require "rails_live_reload/watcher"
-require "rails_live_reload/rails/middleware/base"
-require "rails_live_reload/rails/middleware/long_polling"
-require "rails_live_reload/rails/middleware/polling"
+require "rails_live_reload/middleware/base"
+require "rails_live_reload/middleware/long_polling"
+require "rails_live_reload/middleware/web_socket"
+require "rails_live_reload/middleware/polling"
 require "rails_live_reload/instrument/metrics_collector"
 require "rails_live_reload/thread/current_request"
 require "rails_live_reload/checker"
@@ -16,16 +16,24 @@ module RailsLiveReload
   mattr_accessor :watcher
   @@watcher = {}
 
+  INTERNAL = {
+    message_types: {
+      welcome: "welcome",
+      disconnect: "disconnect",
+      ping: "ping",
+    },
+    disconnect_reasons: {
+      invalid_request: "invalid_request",
+      remote: "remote"
+    },
+    protocols: ["rails-live-reload-v1-json"].freeze
+  }
+
   def self.middleware
     case config.mode
-    when :polling then RailsLiveReload::Rails::Middleware::Polling
-    when :long_polling then RailsLiveReload::Rails::Middleware::LongPolling
+    when :polling then RailsLiveReload::Middleware::Polling
+    when :long_polling then RailsLiveReload::Middleware::LongPolling
+    when :websocket then RailsLiveReload::Middleware::WebSocket
     end
   end
 end
-
-# These configs work for 95% apps, see README for more info
-RailsLiveReload.configure do |config|
-  config.watch %r{app/views/.+\.(erb|haml|slim)$}
-  config.watch %r{(app|vendor)/(assets|javascript)/\w+/(.+\.(css|js|html|png|jpg|ts|jsx)).*}, reload: :always
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_live_reload
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,10 +9,10 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,41 +40,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -82,13 +54,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,17 +95,26 @@ files:
 - Rakefile
 - lib/rails_live_reload.rb
 - lib/rails_live_reload/checker.rb
-- lib/rails_live_reload/client.rb
 - lib/rails_live_reload/command.rb
 - lib/rails_live_reload/config.rb
 - lib/rails_live_reload/engine.rb
 - lib/rails_live_reload/instrument/metrics_collector.rb
-- lib/rails_live_reload/rails/middleware/base.rb
-- lib/rails_live_reload/rails/middleware/long_polling.rb
-- lib/rails_live_reload/rails/middleware/polling.rb
+- lib/rails_live_reload/javascript/long_polling.js
+- lib/rails_live_reload/javascript/polling.js
+- lib/rails_live_reload/javascript/websocket.js
+- lib/rails_live_reload/middleware/base.rb
+- lib/rails_live_reload/middleware/long_polling.rb
+- lib/rails_live_reload/middleware/polling.rb
+- lib/rails_live_reload/middleware/web_socket.rb
 - lib/rails_live_reload/thread/current_request.rb
 - lib/rails_live_reload/version.rb
 - lib/rails_live_reload/watcher.rb
+- lib/rails_live_reload/web_socket/base.rb
+- lib/rails_live_reload/web_socket/client_socket.rb
+- lib/rails_live_reload/web_socket/event_loop.rb
+- lib/rails_live_reload/web_socket/message_buffer.rb
+- lib/rails_live_reload/web_socket/stream.rb
+- lib/rails_live_reload/web_socket/wrapper.rb
 homepage: https://github.com/railsjazz/rails_live_reload
 licenses:
 - MIT
@@ -153,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby on Rails Live Reload

data/lib/rails_live_reload/client.rb

@@ -1,75 +0,0 @@
-module RailsLiveReload
-  module Client
-
-    def Client.long_polling_js
-      <<~HTML.html_safe
-        <script>
-          (function() {
-            const files = #{CurrentRequest.current.data.to_a.to_json};
-            let retries_count = 0;
-            function poll() {
-              const formData = new FormData();
-              formData.append('dt', #{Time.now.to_i})
-              formData.append('files', JSON.stringify(files))
-
-              fetch(
-                "#{RailsLiveReload.config.url}", 
-                {
-                  method: "post",
-                  headers: { 'Accept': 'application/json', },
-                  body: formData
-                }
-              )
-                .then(response => response.json())
-                .then(data => {
-                  retries_count = 0;
-                  if(data['command'] === 'RELOAD') {
-                    window.location.reload();
-                  } else {
-                    poll();
-                  }
-                }).catch(() => {
-                  retries_count++;
-
-                  if(retries_count < 10) {
-                    setTimeout(poll, 5000)
-                  }
-                })
-            }
-            poll();
-          })();
-        </script>
-      HTML
-    end
-
-    def Client.polling_js
-      <<~HTML.html_safe
-        <script>
-          const files = #{CurrentRequest.current.data.to_a.to_json};
-          const timer = setInterval(
-            () => {
-              const formData = new FormData();
-              formData.append('dt', #{Time.now.to_i})
-              formData.append('files', JSON.stringify(files))
-              fetch(
-                "#{RailsLiveReload.config.url}", 
-                {
-                  method: "post",
-                  headers: { 'Accept': 'application/json', },
-                  body: formData
-                }
-              )
-                .then(response => response.json())
-                .then(data => {
-                  if(data['command'] === 'RELOAD') {
-                    clearInterval(timer);
-                    window.location.reload();
-                  }
-                })
-            }, #{RailsLiveReload.config.polling_interval}
-          )
-        </script>
-      HTML
-    end
-  end
-end

data/lib/rails_live_reload/rails/middleware/base.rb

@@ -1,63 +0,0 @@
-module RailsLiveReload
-  module Rails
-    module Middleware
-      class Base
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          dup.call!(env)
-        end
-
-        def call!(env)
-          request = Rack::Request.new(env)
-
-          if env["REQUEST_PATH"] == RailsLiveReload.config.url
-            rails_live_response(request)
-          else
-            @status, @headers, @response = @app.call(env)
-
-            if html? && @response.respond_to?(:[]) && (@status == 500 || (@status.to_s =~ /20./ && request.get?))
-              new_response = make_new_response(@response[0])
-              @headers['Content-Length'] = new_response.bytesize.to_s
-              @response = [new_response]
-            end
-
-            [@status, @headers, @response]
-          end
-        rescue Exception => ex
-          puts ex.message
-          puts ex.backtrace.take(10)
-          raise ex
-        end
-
-        private
-
-        def rails_live_response(request)
-          raise NotImplementedError
-        end
-
-        def client_javascript(request)
-          raise NotImplementedError
-        end
-
-        def make_new_response(body)
-          body.sub("</head>", "</head>#{client_javascript}")
-        end
-
-        def html?
-          @headers["Content-Type"].to_s.include?("text/html")
-        end
-
-        def new_thread
-          Thread.new {
-            t2 = Thread.current
-            t2.abort_on_exception = true
-            yield
-          }
-        end
-      end
-    end
-  end
-end

data/lib/rails_live_reload/rails/middleware/long_polling.rb

@@ -1,53 +0,0 @@
-module RailsLiveReload
-  module Rails
-    module Middleware
-      class LongPolling < Base
-        private
-
-        POLLING_SLEEP = 0.1
-
-        def rails_live_response(request)
-          params = request.params
-          body = lambda do |stream|
-            new_thread do
-              counter = 0
-
-              loop do
-                command = RailsLiveReload::Command.new(params)
-
-                if command.reload?
-                  stream.write(command.payload.to_json) and break
-                end
-
-                sleep(POLLING_SLEEP)
-                counter += 1
-
-                stream.write(command.payload.to_json) and break if counter >= max_sleeps_count
-              end
-            ensure
-              stream.close
-            end
-          end
-
-          [ 200, { 'Content-Type' => 'application/json', 'rack.hijack' => body }, nil ]
-        end
-
-        def client_javascript
-          RailsLiveReload::Client.long_polling_js
-        end
-
-        def max_sleeps_count
-          RailsLiveReload.config.timeout * (1 / POLLING_SLEEP)
-        end
-
-        def new_thread
-          Thread.new {
-            t2 = Thread.current
-            t2.abort_on_exception = true
-            yield
-          }
-        end
-      end
-    end
-  end
-end

data/lib/rails_live_reload/rails/middleware/polling.rb

@@ -1,21 +0,0 @@
-module RailsLiveReload
-  module Rails
-    module Middleware
-      class Polling < Base
-        private
-
-        def rails_live_response(request)
-          [
-            200,
-            { 'Content-Type' => 'application/json' },
-            [ RailsLiveReload::Command.new(request.params).payload.to_json ]
-          ]
-        end
-
-        def client_javascript
-          RailsLiveReload::Client.polling_js
-        end
-      end
-    end
-  end
-end