rage-rb 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c42516bec6fabfb0b06d9f11a5156298474a48f7988edba746122ae4ec172dc
-  data.tar.gz: 3b6b5b7692bb693ba53137d11bc1d7883ace69e496b5a99ec367da9a78ec4675
+  metadata.gz: d2f73c4770587ebabc7d8fa0c4793d53742196b928f21cc362799cb068849982
+  data.tar.gz: aecaa4ae2848bc1b15a38da29d3030d718d74697faaf8525e60e82d10b24396c
 SHA512:
-  metadata.gz: b72d88f12c3608006637d822c7d3f955ef549e61ee644fc3d7748f507381cfe4917d3eea7f6cb75cf49f053f7ba34ce407a8ed06033a06e89e95208a15b6144e
-  data.tar.gz: f60d1950bce78665acfe6af71aeff1694692b6063cbf76e6c39a0af5dbcf8a79672b8603c0a39ce5d2b0beb0ecf61edfba310d6140fb94b899d85dbad0dd2c21
+  metadata.gz: bb31ef275be5dc22322af8c9d563befc000ad2d15bb22454f2d3664736e6e7881ccdac365e6687fc123c23da1a06ee3cd4d63d08b8b5123c1fee67ebb97fbc57
+  data.tar.gz: 7debadefde85efa180f73e963b252cb1065a6b6f1bf4b8ca6e64e19d82a0ed838d3b321ddf9222006204ab59c3d90213e1a4eb6e1ff04d1d45572c1e166b3d77

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.13.0] - 2025-02-12
+
+### Added
+
+- [CLI] Support the PORT ENV variable by [@TheBlackArroVV](https://github.com/TheBlackArroVV) (#124).
+- Add the `RequestId` middleware (#127).
+
+### Fixed
+
+- Correctly process persistent HTTP connections (#128).
+- [OpenAPI] Ignore empty comments (#126).
+- [Cable] Improve the time to connect (#129).
+
 ## [1.12.0] - 2025-01-21
 
 ### Added

data/Gemfile

@@ -15,6 +15,7 @@ group :test do
   gem "http"
   gem "pg"
   gem "mysql2"
+  gem "bigdecimal"
   gem "connection_pool", "~> 2.0"
   gem "rbnacl"
   gem "domain_name"

data/lib/rage/all.rb

@@ -30,6 +30,7 @@ require_relative "middleware/origin_validator"
 require_relative "middleware/fiber_wrapper"
 require_relative "middleware/cors"
 require_relative "middleware/reloader"
+require_relative "middleware/request_id"
 
 if defined?(Sidekiq)
   require_relative "sidekiq_session"

data/lib/rage/application.rb

@@ -7,7 +7,7 @@ class Rage::Application
   end
 
   def call(env)
-    init_logger
+    init_logger(env)
 
     handler = @router.lookup(env)
 
@@ -33,9 +33,9 @@ class Rage::Application
   DEFAULT_LOG_CONTEXT = {}.freeze
   private_constant :DEFAULT_LOG_CONTEXT
 
-  def init_logger
+  def init_logger(env)
     Thread.current[:rage_logger] = {
-      tags: [Iodine::Rack::Utils.gen_request_tag],
+      tags: [(env["rage.request_id"] ||= Iodine::Rack::Utils.gen_request_tag)],
       context: DEFAULT_LOG_CONTEXT,
       request_start: Process.clock_gettime(Process::CLOCK_MONOTONIC)
     }

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

@@ -14,6 +14,7 @@ end
 class Rage::Cable::Adapters::Redis < Rage::Cable::Adapters::Base
   REDIS_STREAM_NAME = "rage:cable:messages"
   DEFAULT_REDIS_OPTIONS = { reconnect_attempts: [0.05, 0.1, 0.5] }
+  REDIS_MIN_VERSION_SUPPORTED = Gem::Version.create(6)
 
   def initialize(config)
     @redis_stream = if (prefix = config.delete(:channel_prefix))
@@ -26,8 +27,8 @@ class Rage::Cable::Adapters::Redis < Rage::Cable::Adapters::Base
     @server_uuid = SecureRandom.uuid
 
     redis_version = get_redis_version
-    if redis_version < Gem::Version.create(5)
-      raise "Redis adapter only supports Redis 5+. Detected Redis version: #{redis_version}."
+    if redis_version < REDIS_MIN_VERSION_SUPPORTED
+      raise "Redis adapter only supports Redis 6+. Detected Redis version: #{redis_version}."
     end
 
     @trimming_strategy = redis_version < Gem::Version.create("6.2.0") ? :maxlen : :minid
@@ -73,7 +74,7 @@ class Rage::Cable::Adapters::Redis < Rage::Cable::Adapters::Base
   rescue RedisClient::Error => e
     puts "FATAL: Couldn't connect to Redis - all broadcasts will be limited to the current server."
     puts e.backtrace.join("\n")
-    Gem::Version.create(5)
+    REDIS_MIN_VERSION_SUPPORTED
 
   ensure
     service_redis.close

data/lib/rage/cable/cable.rb

@@ -51,33 +51,22 @@ module Rage::Cable
         end
 
         @protocol = protocol
+        @default_log_context = {}.freeze
       end
 
       def on_open(connection)
-        Fiber.schedule do
-          @protocol.on_open(connection)
-        rescue => e
-          log_error(e)
-        end
+        connection.env["rage.request_id"] ||= Iodine::Rack::Utils.gen_request_tag
+        schedule_fiber(connection) { @protocol.on_open(connection) }
       end
 
       def on_message(connection, data)
-        Fiber.schedule do
-          @protocol.on_message(connection, data)
-        rescue => e
-          log_error(e)
-        end
+        schedule_fiber(connection) { @protocol.on_message(connection, data) }
       end
 
       if protocol.respond_to?(:on_close)
         def on_close(connection)
           return unless ::Iodine.running?
-
-          Fiber.schedule do
-            @protocol.on_close(connection)
-          rescue => e
-            log_error(e)
-          end
+          schedule_fiber(connection) { @protocol.on_close(connection) }
         end
       end
 
@@ -91,6 +80,15 @@ module Rage::Cable
 
       private
 
+      def schedule_fiber(connection)
+        Fiber.schedule do
+          Thread.current[:rage_logger] = { tags: [connection.env["rage.request_id"]], context: @default_log_context }
+          yield
+        rescue => e
+          log_error(e)
+        end
+      end
+
       def log_error(e)
         Rage.logger.error("Unhandled exception has occured - #{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}")
       end

data/lib/rage/cable/protocol/actioncable_v1_json.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "zlib"
+require "set"
 
 ##
 # A protocol defines the structure, rules and semantics for exchanging data between the client and the server.
@@ -69,8 +70,8 @@ class Rage::Cable::Protocol::ActioncableV1Json
       end
     end
 
-    # Hash<String(stream name) => Array<Hash>(subscription params)>
-    @subscription_identifiers = Hash.new { |hash, key| hash[key] = [] }
+    # Hash<String(stream name) => Set<Hash>(subscription params)>
+    @subscription_identifiers = Hash.new { |hash, key| hash[key] = Set.new }
 
     # this is a fallback to synchronize subscription identifiers across different worker processes;
     # we expect connections to be distributed among all workers, so this code will almost never be called;
@@ -78,7 +79,7 @@ class Rage::Cable::Protocol::ActioncableV1Json
     # of the crashed ones also had access to the identifiers;
     Iodine.subscribe("cable:synchronize") do |_, subscription_msg|
       stream_name, params = Rage::ParamsParser.json_parse(subscription_msg)
-      @subscription_identifiers[stream_name] << params unless @subscription_identifiers[stream_name].include?(params)
+      @subscription_identifiers[stream_name] << params
     end
 
     Iodine.on_state(:on_finish) do
@@ -181,12 +182,8 @@ class Rage::Cable::Protocol::ActioncableV1Json
   # @param name [String] the stream name
   # @param data [Object] the data to send
   def self.broadcast(name, data)
-    i, identifiers = 0, @subscription_identifiers[name]
-
-    while i < identifiers.length
-      params = identifiers[i]
+    @subscription_identifiers[name].each do |params|
       ::Iodine.publish("cable:#{name}:#{Zlib.crc32(params.to_s)}", serialize(params, data))
-      i += 1
     end
   end
 end

data/lib/rage/cli.rb

@@ -71,7 +71,7 @@ module Rage
 
       server_options = { service: :http, handler: app }
 
-      server_options[:port] = options[:port] || Rage.config.server.port
+      server_options[:port] = options[:port] || ENV["PORT"] || Rage.config.server.port
       server_options[:address] = options[:binding] || (Rage.env.production? ? "0.0.0.0" : "localhost")
       server_options[:timeout] = Rage.config.server.timeout
       server_options[:max_clients] = Rage.config.server.max_clients

data/lib/rage/controller/api.rb

@@ -585,27 +585,27 @@ class RageController::API
 
   if !defined?(::ActionController::Parameters)
     # Get the request data. The keys inside the hash are symbols, so `params.keys` returns an array of `Symbol`.<br>
-    # You can also load Strong Params to have Rage automatically wrap `params` in an instance of `ActionController::Parameters`.<br>
+    # You can also load Strong Parameters to have Rage automatically wrap `params` in an instance of `ActionController::Parameters`.<br>
     # At the same time, if you are not implementing complex filtering rules or working with nested structures, consider using native `Hash#fetch` and `Hash#slice` instead.
     #
     # For multipart file uploads, the uploaded files are represented by an instance of {Rage::UploadedFile}.
     #
     # @return [Hash{Symbol=>String,Array,Hash,Numeric,NilClass,TrueClass,FalseClass}]
-    # @example
-    #   # make sure to load strong params before the `require "rage/all"` call
-    #   require "active_support/all"
-    #   require "action_controller/metal/strong_parameters"
+    # @example With Strong Parameters
+    #   # in the Gemfile:
+    #   gem "activesupport", require: "active_support/all"
+    #   gem "actionpack", require: "action_controller/metal/strong_parameters"
     #
-    #   params.permit(:user).require(:full_name, :dob)
-    # @example
-    #   # without strong params
+    #   # in the controller:
+    #   params.require(:user).permit(:full_name, :dob)
+    # @example Without Strong Parameters
     #   params.fetch(:user).slice(:full_name, :dob)
     def params
       @__params
     end
   else
     def params
-      @params ||= ActionController::Parameters.new(@__params)
+      @__params__ ||= ActionController::Parameters.new(@__params)
     end
   end
 

data/lib/rage/fiber_scheduler.rb

@@ -12,10 +12,10 @@ class Rage::FiberScheduler
 
   def io_wait(io, events, timeout = nil)
     f = Fiber.current
-    ::Iodine::Scheduler.attach(io.fileno, events, timeout&.ceil || 0) { |err| f.resume(err) }
+    ::Iodine::Scheduler.attach(io.fileno, events, timeout&.ceil) { |err| f.resume(err) }
 
     err = Fiber.defer(io.fileno)
-    if err && err < 0
+    if err == false || (err && err < 0)
       err
     else
       events

data/lib/rage/middleware/request_id.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+# The middleware establishes a connection between the `X-Request-Id` header (typically generated by a firewall, load balancer, or web server) and
+# Rage's internal logging system. It ensures that:
+#
+# 1. All logs produced during the request are tagged with the value submitted in the `X-Request-Id` header.
+# 2. The request ID is added back to the response in the `X-Request-Id` header. If no `X-Request-Id` header was provided in the request, the middleware adds an internally generated ID to the response.
+#
+# Additionally, the `X-Request-Id` header value is sanitized to a maximum of 255 characters, allowing only alphanumeric characters and dashes.
+#
+# @example
+#   Rage.configure do
+#     config.middleware.use Rage::RequestId
+#   end
+#
+class Rage::RequestId
+  BLACKLISTED_CHARACTERS = /[^\w\-@]/
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    env["rage.request_id"] = validate_external_request_id(env["HTTP_X_REQUEST_ID"])
+    response = @app.call(env)
+    response[1]["X-Request-Id"] = env["rage.request_id"]
+
+    response
+  end
+
+  private
+
+  def validate_external_request_id(request_id)
+    if request_id && !request_id.empty?
+      request_id = request_id[0...255] if request_id.size > 255
+      request_id = request_id.gsub(BLACKLISTED_CHARACTERS, "") if request_id =~ BLACKLISTED_CHARACTERS
+
+      request_id
+    end
+  end
+end

data/lib/rage/openapi/openapi.rb

@@ -119,7 +119,7 @@ module Rage::OpenAPI
 
   # @private
   def self.__log_warn(log)
-    puts "WARNING: #{log}"
+    puts "[OpenAPI] WARNING: #{log}"
   end
 
   module Nodes

data/lib/rage/openapi/parser.rb

@@ -16,7 +16,7 @@ class Rage::OpenAPI::Parser
         else
           node.deprecated = true
         end
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
       elsif expression =~ /@private\b/
         if node.private
@@ -24,7 +24,7 @@ class Rage::OpenAPI::Parser
         else
           node.private = true
         end
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
       elsif expression =~ /@version\s/
         if node.root.version
@@ -45,7 +45,7 @@ class Rage::OpenAPI::Parser
 
       elsif expression =~ /@auth\s/
         method, name, tail_name = expression[6..].split(" ", 3)
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
         if tail_name
           Rage::OpenAPI.__log_warn "incorrect `@auth` name detected at #{location_msg(comments[i])}; security scheme name cannot contain spaces"
@@ -83,7 +83,9 @@ class Rage::OpenAPI::Parser
       children = nil
       expression = comments[i].slice.delete_prefix("#").strip
 
-      if !expression.start_with?("@")
+      if expression.empty?
+        # no-op
+      elsif !expression.start_with?("@")
         if node.summary
           Rage::OpenAPI.__log_warn "invalid summary entry detected at #{location_msg(comments[i])}; summary should only be one line"
         else
@@ -96,7 +98,7 @@ class Rage::OpenAPI::Parser
         else
           node.deprecated = true
         end
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
       elsif expression =~ /@private\b/
         if node.parents.any?(&:private)
@@ -104,10 +106,10 @@ class Rage::OpenAPI::Parser
         else
           node.private = true
         end
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
       elsif expression =~ /@description\s/
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
         node.description = [expression[13..]] + children
 
       elsif expression =~ /@response\s/
@@ -132,7 +134,7 @@ class Rage::OpenAPI::Parser
 
       elsif expression =~ /@internal\b/
         # no-op
-        children = find_children(comments[i + 1..])
+        children = find_children(comments[i + 1..], node)
 
       else
         Rage::OpenAPI.__log_warn "unrecognized `#{expression.split(" ")[0]}` tag detected at #{location_msg(comments[i])}"
@@ -148,16 +150,21 @@ class Rage::OpenAPI::Parser
 
   private
 
-  def find_children(comments)
+  def find_children(comments, node)
     children = []
 
     comments.each do |comment|
-      expression = comment.slice.sub(/^#\s/, "")
+      expression = comment.slice.sub(/^#\s?/, "")
 
-      if expression.start_with?(/\s{2}/)
+      if expression.empty?
+        # no-op
+      elsif expression.start_with?(/\s{2}/)
         children << expression.strip
       elsif expression.start_with?("@")
         break
+      elsif !node.summary
+        # no-op - this is likely the summary entry
+        break
       else
         Rage::OpenAPI.__log_warn "unrecognized expression detected at #{location_msg(comment)}; use two spaces to mark multi-line expressions"
         break

data/lib/rage/request.rb

@@ -76,6 +76,14 @@ class Rage::Request
     @env["HTTP_USER_AGENT"]
   end
 
+  # Returns the unique request ID. By default, this ID is internally generated, and all log entries created during the request
+  # are tagged with it. Alternatively, you can use the {Rage::RequestId} middleware to derive the ID from the `X-Request-Id` header.
+  def request_id
+    @env["rage.request_id"]
+  end
+
+  alias_method :uuid, :request_id
+
   private
 
   def if_none_match

data/lib/rage/templates/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "rage-rb", "~> <%= Rage::VERSION[0..2] %>"
+gem "rage-rb", "~> <%= Rage::VERSION.match(/\d+.\d+/).to_s %>"
 
 # Build JSON APIs with ease
 # gem "alba"

data/lib/rage/version.rb

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

data/rage.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 1.0"
   spec.add_dependency "rack", "~> 2.0"
-  spec.add_dependency "rage-iodine", "~> 4.0"
+  spec.add_dependency "rage-iodine", "~> 4.1"
   spec.add_dependency "zeitwerk", "~> 2.6"
   spec.add_dependency "rack-test", "~> 2.1"
   spec.add_dependency "rake", ">= 12.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-21 00:00:00.000000000 Z
+date: 2025-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - lib/rage/middleware/fiber_wrapper.rb
 - lib/rage/middleware/origin_validator.rb
 - lib/rage/middleware/reloader.rb
+- lib/rage/middleware/request_id.rb
 - lib/rage/openapi/builder.rb
 - lib/rage/openapi/collector.rb
 - lib/rage/openapi/converter.rb