live 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c6f4d6d5b5fc0e7ba635b617256c06ca84c925b528b99e4ab758bf6461af19'
-  data.tar.gz: 69266f1a602d85f9f3d14104a2548304498ed38310f34ffa5dfe9e3e9d48aed6
+  metadata.gz: 63034baadcba271590245009b106e82bc142734cbc4978d7a47c264a8368d92c
+  data.tar.gz: ddb382c9499a3560ece8341a61e6d78076b2b2544fbb7ff3de1371e315e321bd
 SHA512:
-  metadata.gz: a4e608d98be19c629dd8cba31cb5be8eeac52de4a5fb007ba4822f0baf8b473e16aa4db604585b8ff481d39292c2986408b2d3977667b77552de1cff31b4a85c
-  data.tar.gz: 1fa963047b5369012f008c57061a585345d98922082d3c744b032ae15c8599a928f7a9c5b12169ac2242cb1f013b55404cce13f4cd4a2763259eda23b8fe06ac
+  metadata.gz: c8c7edabe0b494d83b0260e803cf39899eb4a2bd91a8eba9e714ccf255f23cd7bb76ee19df9811bc255f316cc113c67fa9814b0152fcd0d05382e3c5e8f93877
+  data.tar.gz: d4e8a3bfebf1bd77374cba4bac80d428b218834c2f0acb773268093aeb14ea14f3131194533c7a8aa0094431d20ee224f584d4babe6c27d9e7852119223cb578

data/lib/live/element.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require 'json'
-require 'securerandom'
+require "json"
+require "securerandom"
 
 module Live
 	class PageError < RuntimeError
@@ -79,7 +79,7 @@ module Live
 		def rpc(*arguments)
 			if @page
 				# This update might not be sent right away. Therefore, mutable arguments may be serialized to JSON at a later time (or never). This could be a race condition:
-				@page.updates.enqueue(arguments)
+				@page.enqueue(arguments)
 			else
 				# This is a programming error, as it probably means the element is still part of the logic of the server side (e.g. async loop), but it is not bound to a page, so there is nothing to update/access/rpc.
 				raise PageError, "Element is not bound to a page, make sure to implement #close!"

data/lib/live/page.rb

@@ -3,14 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
-require_relative 'resolver'
+require_relative "element"
+require_relative "resolver"
 
-require 'async'
-require 'async/queue'
+require "async"
+require "async/queue"
 
-require 'protocol/websocket'
-require 'protocol/websocket/message'
+require "protocol/websocket"
+require "protocol/websocket/message"
+
+require "console/event/failure"
 
 module Live
 	# Represents a connected client page with bound dynamic content areas.
@@ -25,9 +27,6 @@ module Live
 			@updates = Async::Queue.new
 		end
 		
-		# The queue of outstanding events to be sent to the client.
-		attr :updates
-		
 		# Bind a client-side element to a server side element.
 		# @parameter element [Live::Element] The element to bind.
 		def bind(element)
@@ -74,30 +73,38 @@ module Live
 		
 		def close
 			@elements.each do |id, element|
-				element.close
+				begin
+					element.close
+				rescue => error
+					Console::Event::Failure.for(error).emit(self)
+				end
 			end
 		end
 		
+		def enqueue(update)
+			@updates.enqueue(::Protocol::WebSocket::TextMessage.generate(update))
+		end
+		
 		# Process a single incoming message from the network.
 		def process_message(message)
 			case message[0]
-			when 'bind'
+			when "bind"
 				# Bind a client-side element to a server-side element.
 				if element = self.resolve(message[1], message[2])
 					self.bind(element)
 				else
 					Console.warn(self, "Could not resolve element:", message)
-					@updates.enqueue(['error', message[1], "Could not resolve element!"])
+					self.enqueue(["error", message[1], "Could not resolve element!"])
 				end
-			when 'unbind'
+			when "unbind"
 				# Unbind a client-side element from a server-side element.
 				if element = @elements.delete(message[1])
 					element.close unless @attached.key?(message[1])
 				else
 					Console.warn(self, "Could not unbind element:", message)
-					@updates.enqueue(['error', message[1], "Could not unbind element!"])
+					self.enqueue(["error", message[1], "Could not unbind element!"])
 				end
-			when 'event'
+			when "event"
 				# Handle an event from the client.
 				self.handle(message[1], message[2])
 			else
@@ -107,22 +114,43 @@ module Live
 		
 		# Run the event handling loop with the given websocket connection.
 		# @parameter connection [Async::WebSocket::Connection]
-		def run(connection)
+		def run(connection, keep_alive: 10)
 			Sync do |task|
+				last_update = Async::Clock.now
+				
 				queue_task = task.async do
 					while update = @updates.dequeue
-						Console.debug(self, "Sending update:", update)
-						::Protocol::WebSocket::TextMessage.generate(update).send(connection)
-						connection.flush if @updates.empty?
+						update.send(connection)
+						
+						# Flush the output if there are no more updates:
+						if @updates.empty?
+							connection.flush
+						end
+					end
+				end
+				
+				keep_alive_task = task.async do
+					while true
+						sleep(keep_alive)
+						
+						duration = Async::Clock.now - last_update
+						
+						# We synchronize all writes to the update queue:
+						if duration > keep_alive
+							@updates.enqueue(::Protocol::WebSocket::PingMessage.new)
+						end
 					end
 				end
 				
 				while message = connection.read
-					Console.debug(self, "Reading message:", message)
+					last_update = Async::Clock.now
 					process_message(message.parse)
 				end
 			ensure
+				keep_alive_task&.stop
+				
 				self.close
+				
 				queue_task&.stop
 			end
 		end

data/lib/live/resolver.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
+require_relative "element"
 
 module Live
 	# Resolves a client-side tag into a server-side instance.

data/lib/live/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2024, by Samuel Williams.
 
 module Live
-  VERSION = "0.13.0"
+	VERSION = "0.14.0"
 end

data/lib/live/view.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
-require 'xrb/builder'
+require_relative "element"
+require "xrb/builder"
 
 module Live
 	# Represents a single division of content on the page an provides helpers for rendering the content.
@@ -12,7 +12,7 @@ module Live
 		# @returns [Object] The generated HTML.
 		def to_html
 			XRB::Builder.fragment do |builder|
-				builder.inline_tag :div, id: @id, class: 'live', data: @data do
+				builder.inline_tag :div, id: @id, class: "live", data: @data do
 					render(builder)
 				end
 			end

data/lib/live.rb

@@ -5,6 +5,6 @@
 
 require_relative "live/version"
 
-require_relative 'live/page'
-require_relative 'live/view'
-require_relative 'live/resolver'
+require_relative "live/page"
+require_relative "live/view"
+require_relative "live/resolver"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -55,6 +55,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: protocol-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: xrb
   requirement: !ruby/object:Gem::Requirement