roda-sse 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e98e9c2879bb55ccadf0400d243d97ecff39fa4d6535a044cae739e3410878c
-  data.tar.gz: aa3d255a8cb4ecab1ddb9b5d71c916f6907c36529a934c38467ca57b4e3cb1a7
+  metadata.gz: e63c433081f53c50061c380222d40ba9ea30bedd06b5d95982c3dcf9bbd15fa3
+  data.tar.gz: 5bd7d45309f2903e6a953d59b9c02e58c6e965d758859f990ba435eed1372f23
 SHA512:
-  metadata.gz: dee16a19a420769ed068a7bf977b4ef3a05b1d5425e1f9bf4ab2899697e0e13ac2255dc96af84178cb18ada3d6e85645ce91b5b7b4d91508213ecb422fc9a08b
-  data.tar.gz: 946654c542c416ae617e641e5dff7b3cb16d9fa8c5873946db293f5ff98b1d6043fdf9e71c6caa16acdf9f655affe0a14b38cf10fa89edeea0c774ebe1af02c8
+  metadata.gz: 18b52b5dd1fc76864d52c74ee81ede34cdc266f3dde68e83c7235aae3f96fdb0a9af1c6451afe6be0a63ee4bd68bc830b275ae371d7cb6ae3fb81b56bc2bf882
+  data.tar.gz: b862451ef7df47f104892033286e14de121a5716c2857f8b31ce3bda2db1d66d130cbd6bcef22ddeedfdcd166372ca6c2505704cf2750efd752362ecf371027c

data/README.md

@@ -1,6 +1,10 @@
 # roda-sse
 
-The roda-sse Roda plugin adds SSE headers and provides Rack 3 streaming for you to send your own events.
+The roda-sse Roda plugin adds SSE provides a streaming interface for
+server-sent events. Each stream is wrapped in an [Async](https://github.com/socketry/async) reactor
+and events are sent asyncronously via tasks. The roda-sse plugin sets
+appropriate SSE headers, handles disconnection errors, ensures
+streams are properly closed and provies a `last_event_id` helper.
 
 ## Installation
 
@@ -15,6 +19,8 @@ https://github.com/havenwood/roda-sse
 
 ## Usage
 
+See the [examples/](https://github.com/havenwood/roda-sse/tree/main/example) directory for an example app.
+
 roda-sse is a Roda plugin, so you need to load it into your Roda
 application similar to other plugins:
 

data/lib/roda/plugins/sse.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'async'
-require 'async/barrier'
 
 class Roda
   module RodaPlugins
@@ -18,22 +17,15 @@ class Roda
     #     end
     #   end
     module SSE
-      class Stream
-        def initialize(&block)
-          @block = block
-          @barrier = Async::Barrier.new
+      class Output
+        def initialize(stream)
+          @stream = stream
         end
 
         def write(message)
           data = message.to_s
-
-          @barrier.async do
-            @stream.write(data)
-          rescue Errno::ECONNRESET, Errno::EPIPE
-            @barrier.close
-          end
-
-          data.bytesize
+          @stream.write(data)
+          return data.bytesize
         end
 
         def <<(message)
@@ -41,33 +33,37 @@ class Roda
           self
         end
 
-        def call(stream)
-          Sync do
-            @stream = stream
-            @block.call(stream)
-          ensure
-            close
+        def close(error = nil)
+          if stream = @stream
+            @stream = nil
+            stream.close_write(error)
           end
         end
+      end
 
-        def close
-          return if @closed
-
-          @barrier.stop
-          @stream&.close
-          @closed = true
+      class Body
+        def initialize(block)
+          @block = block
+        end
+        
+        def call(stream)
+          output = Output.new(stream)
+          @block.call(output)
+        rescue => error
+        ensure
+          stream.close_write(error)
         end
-
-        def closed? = @closed
       end
 
       module RequestMethods
+        HEADERS = {
+          'content-type' => 'text/event-stream',
+          'cache-control' => 'no-cache',
+        }.freeze
+
         def sse(&block)
           get do
-            response['Content-Type'] = 'text/event-stream'
-            response['Cache-Control'] = 'no-cache'
-
-            halt response.finish_with_body(Stream.new(&block))
+            halt [200, HEADERS.dup, Body.new(block)]
           end
         end
       end

data/spec/roda-sse_spec.rb

@@ -51,37 +51,13 @@ describe 'roda-sse plugin' do
 
       stream = Minitest::Mock.new
       stream.expect(:write, nil, ["data: hola\n\n"])
-      stream.expect(:close, nil)
+      stream.expect(:close_write, nil, [nil])
       response_body = last_response.instance_variable_get(:@body)
-      assert_instance_of Roda::RodaPlugins::SSE::Stream, response_body
+      assert_instance_of Roda::RodaPlugins::SSE::Body, response_body
 
       response_body.call(stream)
 
       stream.verify
     end
   end
-
-  describe 'stream class' do
-    before do
-      @stream = Roda::RodaPlugins::SSE::Stream.new do |stream|
-        stream << 42
-        stream.write(43)
-      end
-    end
-
-    it 'opens' do
-      refute @stream.closed?
-    end
-
-    it 'streams and closes' do
-      stream = Minitest::Mock.new
-      stream.expect(:<<, nil, [42])
-      stream.expect(:write, nil, [43])
-      stream.expect(:close, nil)
-      @stream.call(stream)
-      assert_instance_of Roda::RodaPlugins::SSE::Stream, @stream
-
-      stream.verify
-    end
-  end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda-sse
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shannon Skipper
+- Samuel Williams
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda