rage-rb 1.22.1 → 1.24.0

data/lib/rage/telemetry/spans/broadcast_sse_stream.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+##
+# The **sse.stream.broadcast** span wraps the process of broadcasting a message to an unbounded SSE stream.
+#
+# This span is started when {Rage::SSE.broadcast Rage::SSE.broadcast} is called, and ends when the broadcast operation is complete.
+# See {handle handle} for the list of arguments passed to handler methods.
+#
+# @see Rage::Telemetry::Handler Rage::Telemetry::Handler
+#
+class Rage::Telemetry::Spans::BroadcastSSEStream
+  class << self
+    # @private
+    def id
+      "sse.stream.broadcast"
+    end
+
+    # @private
+    def span_parameters
+      %w[stream:]
+    end
+
+    # @private
+    def handler_arguments
+      {
+        name: '"Rage::SSE.broadcast"',
+        stream: "stream"
+      }
+    end
+
+    # @!parse [ruby]
+    #   # @param id ["sse.stream.broadcast"] ID of the span
+    #   # @param name ["Rage::SSE.broadcast"] human-readable name of the operation
+    #   # @param stream [Object] the identifier of the stream to which the message is being broadcasted
+    #   # @yieldreturn [Rage::Telemetry::SpanResult]
+    #   #
+    #   # @example
+    #   #   class MyTelemetryHandler < Rage::Telemetry::Handler
+    #   #     handle "sse.stream.broadcast", with: :my_handler
+    #   #
+    #   #     def my_handler(id:, name:, stream:)
+    #   #       yield
+    #   #     end
+    #   #   end
+    #   # @note Rage automatically detects which parameters your handler method accepts and only passes those parameters.
+    #   #   You can omit any of the parameters described here.
+    #   def handle(id:, name:, stream:)
+    #   end
+  end
+end

data/lib/rage/telemetry/spans/process_sse_stream.rb

@@ -6,6 +6,7 @@
 # This span starts when a connection is opened and ends when the stream is finished.
 # See {handle handle} for the list of arguments passed to handler methods.
 #
+# @note This span is not used for unbounded SSE streams created via {Rage::SSE.stream Rage::SSE.stream}.
 # @see Rage::Telemetry::Handler Rage::Telemetry::Handler
 #
 class Rage::Telemetry::Spans::ProcessSSEStream

data/lib/rage/telemetry/telemetry.rb

@@ -70,7 +70,7 @@ module Rage::Telemetry
   #
   # | ID | Reference | Description |
   # | --- | --- |
-  # | `core.fiber.dispatch` | {DispatchFiber} | Wraps the scheduling and processing of system-level fibers created by the framework to process requests and deferred tasks |
+  # | `core.fiber.dispatch` | {DispatchFiber} | Wraps the scheduling and processing of system-level fibers created by the framework to process requests, deferred tasks, or SSE streams |
   # | `core.fiber.spawn` | {SpawnFiber} | Wraps the scheduling and processing of application-level fibers created via {Fiber.schedule} |
   # | `core.fiber.await` | {AwaitFiber} | Wraps the processing of the {Fiber.await} calls |
   # | `controller.action.process` | {ProcessControllerAction} | Wraps the processing of controller actions |
@@ -83,6 +83,7 @@ module Rage::Telemetry
   # | `events.event.publish` | {PublishEvent} | Wraps the publishing of events via {Rage::Events Rage::Events} |
   # | `events.subscriber.process` | {ProcessEventSubscriber} | Wraps the processing of events by subscribers |
   # | `sse.stream.process` | {ProcessSSEStream} | Wraps the processing of an SSE stream |
+  # | `sse.stream.broadcast` | {BroadcastSSEStream} | Wraps the process of broadcasting a message to an unbounded SSE stream |
   #
   module Spans
   end

data/lib/rage/telemetry/tracer.rb

@@ -74,6 +74,7 @@ class Rage::Telemetry::Tracer
           #{calls_chain}
         rescue Exception => e
           Rage.logger.error("Telemetry handler failed with error \#{e}:\\n\#{e.backtrace.join("\\n")}")
+          Rage::Errors.report(e)
         end
 
         unless yield_called

data/lib/rage/uploaded_file.rb

@@ -7,6 +7,7 @@
 # of its interface is available directly for convenience.
 #
 # Rage will automatically unlink the files, so there is no need to clean them with a separate maintenance task.
+#
 class Rage::UploadedFile
   # The basename of the file in the client.
   attr_reader :original_filename
@@ -29,14 +30,9 @@ class Rage::UploadedFile
     @file.read(length, buffer)
   end
 
-  # Shortcut for `file.open`.
-  def open
-    @file.open
-  end
-
   # Shortcut for `file.close`.
-  def close(unlink_now = false)
-    @file.close(unlink_now)
+  def close
+    @file.close
   end
 
   # Shortcut for `file.path`.

data/lib/rage/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rage
-  VERSION = "1.22.1"
+  VERSION = "1.24.0"
 end

data/lib/rage-rb.rb

@@ -40,6 +40,12 @@ module Rage
     Rage::Events
   end
 
+  # Shorthand to access {Rage::Errors Rage::Errors}.
+  # @return [Rage::Errors]
+  def self.errors
+    Rage::Errors
+  end
+
   # Shorthand to access {Rage::SSE Rage::SSE}.
   # @return [Rage::SSE]
   def self.sse
@@ -191,10 +197,11 @@ module Rage
   autoload :OpenAPI, "rage/openapi/openapi"
   autoload :Deferred, "rage/deferred/deferred"
   autoload :Events, "rage/events/events"
-  autoload :SSE, "rage/sse/sse"
+  autoload :PubSub, "rage/pubsub/pubsub"
 end
 
 module RageController
+  autoload :Renderers, "rage/controller/renderers"
 end
 
 require_relative "rage/env"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.24.0
 platform: ruby
 authors:
 - Roman Samoilov
@@ -134,6 +134,7 @@ files:
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -143,8 +144,6 @@ files:
 - lib/rage.rb
 - lib/rage/all.rb
 - lib/rage/application.rb
-- lib/rage/cable/adapters/base.rb
-- lib/rage/cable/adapters/redis.rb
 - lib/rage/cable/cable.rb
 - lib/rage/cable/channel.rb
 - lib/rage/cable/connection.rb
@@ -157,6 +156,7 @@ files:
 - lib/rage/code_loader.rb
 - lib/rage/configuration.rb
 - lib/rage/controller/api.rb
+- lib/rage/controller/renderers.rb
 - lib/rage/cookies.rb
 - lib/rage/deferred/backends/disk.rb
 - lib/rage/deferred/backends/nil.rb
@@ -166,6 +166,7 @@ files:
 - lib/rage/deferred/middleware_chain.rb
 - lib/rage/deferred/proxy.rb
 - lib/rage/deferred/queue.rb
+- lib/rage/deferred/scheduler.rb
 - lib/rage/deferred/task.rb
 - lib/rage/env.rb
 - lib/rage/errors.rb
@@ -203,6 +204,8 @@ files:
 - lib/rage/openapi/parsers/shared_reference.rb
 - lib/rage/openapi/parsers/yaml.rb
 - lib/rage/params_parser.rb
+- lib/rage/pubsub/adapters/redis.rb
+- lib/rage/pubsub/pubsub.rb
 - lib/rage/rails.rb
 - lib/rage/request.rb
 - lib/rage/response.rb
@@ -225,10 +228,12 @@ files:
 - lib/rage/sse/connection_proxy.rb
 - lib/rage/sse/message.rb
 - lib/rage/sse/sse.rb
+- lib/rage/sse/stream.rb
 - lib/rage/tasks.rb
 - lib/rage/telemetry/handler.rb
 - lib/rage/telemetry/spans/await_fiber.rb
 - lib/rage/telemetry/spans/broadcast_cable_stream.rb
+- lib/rage/telemetry/spans/broadcast_sse_stream.rb
 - lib/rage/telemetry/spans/create_websocket_connection.rb
 - lib/rage/telemetry/spans/dispatch_fiber.rb
 - lib/rage/telemetry/spans/enqueue_deferred_task.rb
@@ -279,7 +284,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rage/cable/adapters/base.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-class Rage::Cable::Adapters::Base
-  def pick_a_worker(&block)
-    _lock, lock_path = Tempfile.new.yield_self { |file| [file, file.path] }
-
-    Iodine.on_state(:on_start) do
-      if File.new(lock_path).flock(File::LOCK_EX | File::LOCK_NB)
-        if Rage.logger.debug?
-          puts "INFO: #{Process.pid} is managing #{self.class.name.split("::").last} subscriptions."
-        end
-        block.call
-      end
-    end
-  end
-end