roda-sse 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bbd096f5155da3f8593b8e3d37771daedd543a9cf4816d5bab36f3192bb203
-  data.tar.gz: 88366dcfba9fb10fcf5a810c540c3ae5b77c9f52989cdea5c03ea1b0a9aa9641
+  metadata.gz: 5e98e9c2879bb55ccadf0400d243d97ecff39fa4d6535a044cae739e3410878c
+  data.tar.gz: aa3d255a8cb4ecab1ddb9b5d71c916f6907c36529a934c38467ca57b4e3cb1a7
 SHA512:
-  metadata.gz: 8375dd84ecfefe94dafb591d5edfb1e22a3413aa0f574b7c7a965b1adcf7ef62cd70397fb133a8f0e2468183edae44f82208742d357f45a43a69e53d9f352e6c
-  data.tar.gz: 9bf26ed27a75bb355f1468baa668e0c3b569b9313d1468b60ac9aa6bbe7a2c142592011bacb7f931232e18a2bb90c932011b375a6b73e7d654a942ae0bb57210
+  metadata.gz: dee16a19a420769ed068a7bf977b4ef3a05b1d5425e1f9bf4ab2899697e0e13ac2255dc96af84178cb18ada3d6e85645ce91b5b7b4d91508213ecb422fc9a08b
+  data.tar.gz: 946654c542c416ae617e641e5dff7b3cb16d9fa8c5873946db293f5ff98b1d6043fdf9e71c6caa16acdf9f655affe0a14b38cf10fa89edeea0c774ebe1af02c8

data/README.md

@@ -30,7 +30,5 @@ In your routing block, you can then use `r.sse` to stream with the correct heade
 r.sse do |stream|
   stream << "data: hello\n\n"
   stream << "data: world\n\n"
-ensure
-  stream.close
 end
 ```

data/lib/roda/plugins/sse.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'async'
+require 'async/barrier'
+
 class Roda
   module RodaPlugins
     # Example:
@@ -11,22 +14,69 @@ class Roda
     #       # GET /
     #       r.sse do |stream|
     #         stream.write "data: hola\n\n"
-    #       ensure
-    #         stream.close
     #       end
     #     end
     #   end
     module SSE
+      class Stream
+        def initialize(&block)
+          @block = block
+          @barrier = Async::Barrier.new
+        end
+
+        def write(message)
+          data = message.to_s
+
+          @barrier.async do
+            @stream.write(data)
+          rescue Errno::ECONNRESET, Errno::EPIPE
+            @barrier.close
+          end
+
+          data.bytesize
+        end
+
+        def <<(message)
+          write(message)
+          self
+        end
+
+        def call(stream)
+          Sync do
+            @stream = stream
+            @block.call(stream)
+          ensure
+            close
+          end
+        end
+
+        def close
+          return if @closed
+
+          @barrier.stop
+          @stream&.close
+          @closed = true
+        end
+
+        def closed? = @closed
+      end
+
       module RequestMethods
         def sse(&block)
-          response['Content-Type'] = 'text/event-stream'
-          response['Cache-Control'] = 'no-cache'
+          get do
+            response['Content-Type'] = 'text/event-stream'
+            response['Cache-Control'] = 'no-cache'
 
-          always do
-            halt response.finish_with_body(block)
+            halt response.finish_with_body(Stream.new(&block))
           end
         end
       end
+
+      module InstanceMethods
+        def last_event_id
+          env['HTTP_LAST_EVENT_ID']
+        end
+      end
     end
 
     register_plugin(:sse, SSE)

data/spec/roda-sse_spec.rb

@@ -12,9 +12,8 @@ class App < Roda
   route do |r|
     r.root do
       r.sse do |stream|
+        last_event_id
         stream.write "data: hola\n\n"
-      ensure
-        stream.close
       end
     end
   end
@@ -23,34 +22,66 @@ end
 def app = App.freeze.app
 
 describe 'roda-sse plugin' do
-  include Rack::Test::Methods
-
   prove_it!
 
-  it 'responds 200 OK' do
-    get '/'
+  describe 'roda app' do
+    include Rack::Test::Methods
 
-    assert last_response.ok?
-  end
+    it 'responds 200 OK' do
+      get '/'
+
+      assert last_response.ok?
+    end
+
+    it 'does not respond to PUT' do
+      post '/'
 
-  it 'has SSE headers' do
-    get '/'
+      refute last_response.ok?
+    end
+
+    it 'has SSE headers' do
+      get '/'
+
+      headers = {'content-type' => 'text/event-stream', 'cache-control' => 'no-cache'}
+      assert_equal headers, last_response.headers
+    end
 
-    headers = {'content-type' => 'text/event-stream', 'cache-control' => 'no-cache'}
-    assert_equal headers, last_response.headers
+    it 'streams the body' do
+      get '/'
+
+      stream = Minitest::Mock.new
+      stream.expect(:write, nil, ["data: hola\n\n"])
+      stream.expect(:close, nil)
+      response_body = last_response.instance_variable_get(:@body)
+      assert_instance_of Roda::RodaPlugins::SSE::Stream, response_body
+
+      response_body.call(stream)
+
+      stream.verify
+    end
   end
 
-  it 'streams the body' do
-    get '/'
+  describe 'stream class' do
+    before do
+      @stream = Roda::RodaPlugins::SSE::Stream.new do |stream|
+        stream << 42
+        stream.write(43)
+      end
+    end
 
-    stream = Minitest::Mock.new
-    stream.expect(:write, nil, ["data: hola\n\n"])
-    stream.expect(:close, nil)
-    response_body = last_response.instance_variable_get(:@body)
-    assert_instance_of Proc, response_body
+    it 'opens' do
+      refute @stream.closed?
+    end
 
-    response_body.call(stream)
+    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
+      stream.verify
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: roda-sse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shannon Skipper
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.85'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.85'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
 description: The roda-sse gem integrates simple SSE streaming into the roda web toolkit.
 email: shannonskipper@gmail.com
 executables: []