datastar 1.0.0 → 1.0.2

data/lib/datastar/dispatcher.rb

@@ -44,7 +44,8 @@ module Datastar
       executor: Datastar.config.executor,
       error_callback: Datastar.config.error_callback,
       finalize: Datastar.config.finalize,
-      heartbeat: Datastar.config.heartbeat
+      heartbeat: Datastar.config.heartbeat,
+      compression: Datastar.config.compression
     )
       @on_connect = []
       @on_client_disconnect = []
@@ -68,6 +69,11 @@ module Datastar
 
       @heartbeat = heartbeat
       @heartbeat_on = false
+
+      # Negotiate compression
+      compression = CompressionConfig.build(compression) unless compression.is_a?(CompressionConfig)
+      @compressor = compression.negotiate(request)
+      @compressor.prepare_response(@response)
     end
 
     # Check if the request accepts SSE responses
@@ -283,9 +289,10 @@ module Datastar
     # @api private
     def stream_one(streamer)
       proc do |socket|
+        socket = wrap_socket(socket)
         generator = ServerSentEventGenerator.new(socket, signals:, view_context: @view_context)
         @on_connect.each { |callable| callable.call(generator) }
-        handling_errors(generator, socket) do
+        handling_sync_errors(generator, socket) do
           streamer.call(generator)
         end
       ensure
@@ -308,14 +315,16 @@ module Datastar
       @queue ||= @executor.new_queue
 
       proc do |socket|
+        socket = wrap_socket(socket)
         signs = signals
         conn_generator = ServerSentEventGenerator.new(socket, signals: signs, view_context: @view_context)
         @on_connect.each { |callable| callable.call(conn_generator) }
 
         threads = @streamers.map do |streamer|
+          duped_signals = signs.dup.freeze
           @executor.spawn do
             # TODO: Review thread-safe view context
-            generator = ServerSentEventGenerator.new(@queue, signals: signs, view_context: @view_context)
+            generator = ServerSentEventGenerator.new(@queue, signals: duped_signals, view_context: @view_context)
             streamer.call(generator)
             @queue << :done
           rescue StandardError => e
@@ -323,7 +332,12 @@ module Datastar
           end
         end
 
-        handling_errors(conn_generator, socket) do
+        # Now launch the control thread that actually writes to the socket
+        # We don't want to block the main thread, so that servers like Puma
+        # which have a limited thread pool can keep serving other requests
+        # Other streamers will push any StandardError exceptions to the queue
+        # So we handle them here
+        @executor.spawn do
           done_count = 0
           threads_size = @heartbeat_on ? threads.size - 1 : threads.size
 
@@ -332,24 +346,53 @@ module Datastar
               done_count += 1
               @queue << nil if done_count == threads_size
             elsif data.is_a?(Exception)
-              raise data
+              handle_streaming_error(data, socket)
+              @queue << nil
             else
-              socket << data
+              # Here we attempt writing to the actual socket
+              # which may raise an IOError if the client disconnected
+              begin
+                socket << data
+              rescue Exception => e
+                handle_streaming_error(e, socket)
+                @queue << nil
+              end
             end
           end
+
+        ensure
+          @on_server_disconnect.each { |callable| callable.call(conn_generator) }
+          @executor.stop(threads) if threads
+          socket.close
         end
-      ensure
-        @executor.stop(threads) if threads
-        socket.close
       end
     end
 
-    # Run a streaming block while handling errors
+    # Wrap socket in a CompressedSocket if compression is negotiated
+    # @param socket [IO]
+    # @return [CompressedSocket, IO]
+    def wrap_socket(socket)
+      @compressor.wrap_socket(socket)
+    end
+
+    # Handle errors caught during streaming
+    # @param error [Exception] the error that occurred
+    # @param socket [IO] the socket to pass to error handlers
+    def handle_streaming_error(error, socket)
+      case error
+      when IOError, Errno::EPIPE, Errno::ECONNRESET
+        @on_client_disconnect.each { |callable| callable.call(socket) }
+      when Exception
+        @on_error.each { |callable| callable.call(error) }
+      end
+    end
+
+    # Run a block while handling errors
     # @param generator [ServerSentEventGenerator]
     # @param socket [IO]
     # @yield
     # @api private
-    def handling_errors(generator, socket, &)
+    def handling_sync_errors(generator, socket, &)
       yield
 
       @on_server_disconnect.each { |callable| callable.call(generator) }

data/lib/datastar/server_sent_event_generator.rb

@@ -3,9 +3,46 @@
 require 'json'
 
 module Datastar
+  module ElementPatchMode
+    # Morphs the element into the existing element.
+    OUTER = 'outer'
+
+    # Replaces the inner HTML of the existing element.
+    INNER = 'inner'
+
+    # Removes the existing element.
+    REMOVE = 'remove'
+
+    # Replaces the existing element with the new element.
+    REPLACE = 'replace'
+
+    # Prepends the element inside to the existing element.
+    PREPEND = 'prepend'
+
+    # Appends the element inside the existing element.
+    APPEND = 'append'
+
+    # Inserts the element before the existing element.
+    BEFORE = 'before'
+
+    # Inserts the element after the existing element.
+    AFTER = 'after'
+  end
+
   class ServerSentEventGenerator
     MSG_END = "\n"
 
+    DEFAULT_SSE_RETRY_DURATION = 1000
+    DEFAULT_ELEMENTS_USE_VIEW_TRANSITIONS = false
+    DEFAULT_PATCH_SIGNALS_ONLY_IF_MISSING = false
+
+    SELECTOR_DATALINE_LITERAL = 'selector'
+    MODE_DATALINE_LITERAL = 'mode'
+    ELEMENTS_DATALINE_LITERAL = 'elements'
+    USE_VIEW_TRANSITION_DATALINE_LITERAL = 'useViewTransition'
+    SIGNALS_DATALINE_LITERAL = 'signals'
+    ONLY_IF_MISSING_DATALINE_LITERAL = 'onlyIfMissing'
+
     SSE_OPTION_MAPPING = {
       'eventId' => 'id',
       'retryDuration' => 'retry',
@@ -13,17 +50,22 @@ module Datastar
       'retry' => 'retry',
     }.freeze
 
+    DEFAULT_ELEMENT_PATCH_MODE = ElementPatchMode::OUTER
+
     OPTION_DEFAULTS = {
-      'retry' => Consts::DEFAULT_SSE_RETRY_DURATION,
-      Consts::MODE_DATALINE_LITERAL => Consts::DEFAULT_ELEMENT_PATCH_MODE,
-      Consts::USE_VIEW_TRANSITION_DATALINE_LITERAL => Consts::DEFAULT_ELEMENTS_USE_VIEW_TRANSITIONS,
-      Consts::ONLY_IF_MISSING_DATALINE_LITERAL => Consts::DEFAULT_PATCH_SIGNALS_ONLY_IF_MISSING,
+      'retry' => DEFAULT_SSE_RETRY_DURATION,
+      MODE_DATALINE_LITERAL => DEFAULT_ELEMENT_PATCH_MODE,
+      USE_VIEW_TRANSITION_DATALINE_LITERAL => DEFAULT_ELEMENTS_USE_VIEW_TRANSITIONS,
+      ONLY_IF_MISSING_DATALINE_LITERAL => DEFAULT_PATCH_SIGNALS_ONLY_IF_MISSING,
     }.freeze
 
     SIGNAL_SEPARATOR = '.'
 
     attr_reader :signals
 
+    # @param stream [IO, Queue] The IO stream or Queue to write to
+    # @option signals [Hash] A hash of signals (params)
+    # @option view_context [Object] The view context for rendering elements, if applicable.
     def initialize(stream, signals:, view_context: nil)
       @stream = stream
       @signals = signals
@@ -49,7 +91,7 @@ module Datastar
 
       buffer = +"event: datastar-patch-elements\n"
       build_options(options, buffer)
-      element_lines.each { |line| buffer << "data: #{Consts::ELEMENTS_DATALINE_LITERAL} #{line}\n" }
+      element_lines.each { |line| buffer << "data: #{ELEMENTS_DATALINE_LITERAL} #{line}\n" }
 
       write(buffer)
     end
@@ -58,7 +100,7 @@ module Datastar
       patch_elements(
         nil, 
         options.merge(
-          Consts::MODE_DATALINE_LITERAL => Consts::ElementPatchMode::REMOVE,
+          MODE_DATALINE_LITERAL => ElementPatchMode::REMOVE,
           selector:
         )
       )
@@ -72,7 +114,7 @@ module Datastar
         signals = JSON.dump(signals)
         buffer << "data: signals #{signals}\n"
       when String
-        multi_data_lines(signals, buffer, Consts::SIGNALS_DATALINE_LITERAL)
+        multi_data_lines(signals, buffer, SIGNALS_DATALINE_LITERAL)
       end
       write(buffer)
     end
@@ -98,8 +140,8 @@ module Datastar
       script_tag << %( data-effect="el.remove()") if auto_remove
       script_tag << ">#{script}</script>"
 
-      options[Consts::SELECTOR_DATALINE_LITERAL] = 'body'
-      options[Consts::MODE_DATALINE_LITERAL] = Consts::ElementPatchMode::APPEND
+      options[SELECTOR_DATALINE_LITERAL] = 'body'
+      options[MODE_DATALINE_LITERAL] = ElementPatchMode::APPEND
 
       patch_elements(script_tag, options)
     end
@@ -140,7 +182,7 @@ module Datastar
             buffer << "data: #{k} #{kk} #{vv}\n"
           end
         elsif v.is_a?(Array)
-          if k == Consts::SELECTOR_DATALINE_LITERAL
+          if k == SELECTOR_DATALINE_LITERAL
             buffer << "data: #{k} #{v.join(', ')}\n"
           else
             buffer << "data: #{k} #{v.join(' ')}\n"

data/lib/datastar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Datastar
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/datastar.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'datastar/version'
-require_relative 'datastar/consts'
-
 module Datastar
   BLANK_OPTIONS = {}.freeze
 
@@ -27,6 +25,7 @@ module Datastar
 end
 
 require_relative 'datastar/configuration'
+require_relative 'datastar/compression_config'
 require_relative 'datastar/dispatcher'
 require_relative 'datastar/server_sent_event_generator'
 require_relative 'datastar/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datastar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ismael Celis
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.14
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.14
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -75,18 +75,22 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- benchmarks/compression.rb
 - examples/hello-world/Gemfile
 - examples/hello-world/Gemfile.lock
 - examples/hello-world/hello-world.html
 - examples/hello-world/hello-world.ru
+- examples/progress/progress.ru
 - examples/test.ru
 - examples/threads/Gemfile
 - examples/threads/Gemfile.lock
 - examples/threads/threads.ru
 - lib/datastar.rb
 - lib/datastar/async_executor.rb
+- lib/datastar/compression_config.rb
+- lib/datastar/compressor/brotli.rb
+- lib/datastar/compressor/gzip.rb
 - lib/datastar/configuration.rb
-- lib/datastar/consts.rb
 - lib/datastar/dispatcher.rb
 - lib/datastar/rails_async_executor.rb
 - lib/datastar/rails_thread_executor.rb
@@ -113,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Ruby SDK for Datastar. Rack-compatible.
 test_files: []

data/lib/datastar/consts.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# This is auto-generated by Datastar. DO NOT EDIT.
-module Datastar
-  module Consts
-    DATASTAR_KEY = 'datastar'
-    VERSION = '1.0.0-RC.1'
-
-    # The default duration for retrying SSE on connection reset. This is part of the underlying retry mechanism of SSE.
-    DEFAULT_SSE_RETRY_DURATION = 1000
-
-    # Should elements be patched using the ViewTransition API?
-    DEFAULT_ELEMENTS_USE_VIEW_TRANSITIONS = false
-
-    # Should a given set of signals patch if they are missing?
-    DEFAULT_PATCH_SIGNALS_ONLY_IF_MISSING = false
-
-    module ElementPatchMode
-
-      # Morphs the element into the existing element.
-      OUTER = 'outer';
-
-      # Replaces the inner HTML of the existing element.
-      INNER = 'inner';
-
-      # Removes the existing element.
-      REMOVE = 'remove';
-
-      # Replaces the existing element with the new element.
-      REPLACE = 'replace';
-
-      # Prepends the element inside to the existing element.
-      PREPEND = 'prepend';
-
-      # Appends the element inside the existing element.
-      APPEND = 'append';
-
-      # Inserts the element before the existing element.
-      BEFORE = 'before';
-
-      # Inserts the element after the existing element.
-      AFTER = 'after';
-    end
-
-
-    # The mode in which an element is patched into the DOM.
-    DEFAULT_ELEMENT_PATCH_MODE = ElementPatchMode::OUTER
-
-    # Dataline literals.
-    SELECTOR_DATALINE_LITERAL = 'selector'
-    MODE_DATALINE_LITERAL = 'mode'
-    ELEMENTS_DATALINE_LITERAL = 'elements'
-    USE_VIEW_TRANSITION_DATALINE_LITERAL = 'useViewTransition'
-    SIGNALS_DATALINE_LITERAL = 'signals'
-    ONLY_IF_MISSING_DATALINE_LITERAL = 'onlyIfMissing'
-  end
-end