rage-rb 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abee0787faa5947d8ecb03f9c5851cb669295bc2bd52abe5513e7b10940ddfff
-  data.tar.gz: d167a4d6a48dbced809578f3c3a569c5ccdb913ed7bf51eba3e8d054b61e1c75
+  metadata.gz: 1c3041038ae63ae245e261a7a2096195ab56291d236414e086646ae96a4a6d16
+  data.tar.gz: a64817ded16716fe714310c7318d8e1d318454615da43d37055b333e76778fa2
 SHA512:
-  metadata.gz: eea4d03aa25b675fdf1f19836037dceaeb7f38e2227af9cafc1609d59b8f322d3e3fa49da7905b4c0dd783615d16ce6e592aa11f2fa934056d711f03aaafbb43
-  data.tar.gz: adf6eaaee9a88eef39631581ce52eaa311b5ac61797f481a95e28502ccabf166615a87e215b5f5b3260ebdfbb5c28f8c32e1e8342566d9d23836e56eb97b14d8
+  metadata.gz: 350f5150012852a3ca2532c031ce8ef28338da6d985ef66dff59095dea6b3dbbc4498826996876722bc5b7991683fed82c2fd3854313f7ed59f9fff20aaf4315
+  data.tar.gz: 84cd798056a43c8eb0e94809f72f6b0ac602076aa904831a3a049a8ed13352cad9321329233063343b73e65c0fbf1521564b0cee6f3696c89877a0af15191c94

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+## [0.7.0] - 2024-01-09
+
+- Add conditional GET using `stale?` by [@tonekk](https://github.com/tonekk) (#55).
+- Add Rails integration (#57).
+- Add JSON log formatter (#59).
+
+## [0.6.0] - 2023-12-22
+
+### Added
+
+- Implement after actions (#53).
+- Zeitwerk autoloading and reloading by [@alex-rogachev](https://github.com/alex-rogachev) (#54).
+- Support the `environment`, `binding`, `timeout`, and `max_clients` options when using `rage s` (#52).
+- Add CORS middleware (#49).
+
+### Fixed
+
+- Prevent `block` and `sleep` channels from conflicting (#51).
+
 ## [0.5.2] - 2023-12-11
 
 ### Added

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at roman.samoilov@wework.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at developers@rage-rb.dev. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/README.md

@@ -52,6 +52,7 @@ Check out in-depth API docs for more information:
 - [Routing API](https://rage-rb.pages.dev/Rage/Router/DSL/Handler)
 - [Fiber API](https://rage-rb.pages.dev/Fiber)
 - [Logger API](https://rage-rb.pages.dev/Rage/Logger)
+- [Configuration API](https://rage-rb.pages.dev/Rage/Configuration)
 
 Also, see the [changelog](https://github.com/rage-rb/rage/blob/master/CHANGELOG.md) and [upcoming-releases](https://github.com/rage-rb/rage#upcoming-releases) for currently supported and planned features.
 
@@ -142,17 +143,17 @@ end
 
 ## Upcoming releases
 
-Version | Changes
-------- |------------
-0.2 :white_check_mark: | ~~Gem configuration by env.<br>Add `skip_before_action`.<br>Add `rescue_from`.<br>Router updates:<br>&emsp;• make the `root` helper work correctly with `scope`;<br>&emsp;• support the `defaults` option;~~
-0.3 :white_check_mark: | ~~CLI updates:<br>&emsp;• `routes` task;<br>&emsp;• `console` task;<br>Support the `:if` and `:unless` options in `before_action`.<br>Allow to set response headers.~~
-0.4 :white_check_mark: | ~~Expose the `params` object.<br>Support header authentication with `authenticate_with_http_token`.<br>Router updates:<br>&emsp;• add the `resources` route helper;<br>&emsp;• add the `namespace` route helper;~~
-0.5 :white_check_mark:  | ~~Add request logging.~~
-0.6 | Automatic code reloading in development with Zeitwerk.
-0.7 | Expose the `send_data` and `send_file` methods.
-0.8 | Support conditional get with `etag` and `last_modified`.
-0.9 | Expose the `cookies` and `session` objects.
-1.0 | Implement Iodine-based equivalent of Action Cable.
+Status | Changes
+-- | ------------
+:white_check_mark: | ~~Gem configuration by env.<br>Add `skip_before_action`.<br>Add `rescue_from`.<br>Router updates:<br>&emsp;• make the `root` helper work correctly with `scope`;<br>&emsp;• support the `defaults` option;~~
+:white_check_mark: | ~~CLI updates:<br>&emsp;• `routes` task;<br>&emsp;• `console` task;<br>Support the `:if` and `:unless` options in `before_action`.<br>Allow to set response headers.~~
+:white_check_mark: | ~~Expose the `params` object.<br>Support header authentication with `authenticate_with_http_token`.<br>Router updates:<br>&emsp;• add the `resources` route helper;<br>&emsp;• add the `namespace` route helper;~~
+:white_check_mark:  | ~~Add request logging.~~
+:white_check_mark: | ~~Automatic code reloading in development with Zeitwerk.~~
+⏳ | Expose the `send_data` and `send_file` methods.
+⏳ | Support conditional get with `etag` and `last_modified`.
+⏳ | Expose the `cookies` and `session` objects.
+⏳ | Implement Iodine-based equivalent of Action Cable.
 
 ## Development
 

data/lib/rage/all.rb

@@ -6,10 +6,11 @@ require_relative "fiber"
 require_relative "fiber_scheduler"
 require_relative "configuration"
 require_relative "request"
+require_relative "response"
 require_relative "uploaded_file"
 require_relative "errors"
 require_relative "params_parser"
-require_relative "fiber_wrapper"
+require_relative "code_loader"
 
 require_relative "router/strategies/host"
 require_relative "router/backend"
@@ -21,8 +22,13 @@ require_relative "router/node"
 require_relative "controller/api"
 
 require_relative "logger/text_formatter"
+require_relative "logger/json_formatter"
 require_relative "logger/logger"
 
+require_relative "middleware/fiber_wrapper"
+require_relative "middleware/cors"
+require_relative "middleware/reloader"
+
 if defined?(Sidekiq)
   require_relative "sidekiq_session"
 end

data/lib/rage/application.rb

@@ -3,6 +3,7 @@
 class Rage::Application
   def initialize(router)
     @router = router
+    @exception_app = build_exception_app
   end
 
   def call(env)
@@ -17,10 +18,11 @@ class Rage::Application
       [404, {}, ["Not Found"]]
     end
 
+  rescue Rage::Errors::BadRequest => e
+    response = @exception_app.call(400, e)
+
   rescue Exception => e
-    exception_str = "#{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}"
-    Rage.logger.error(exception_str)
-    response = [500, {}, [exception_str]]
+    response = @exception_app.call(500, e)
 
   ensure
     finalize_logger(env, response, params)
@@ -50,4 +52,20 @@ class Rage::Application
     Rage.logger.info("")
     logger[:final] = nil
   end
+
+  def build_exception_app
+    if Rage.env.development?
+      ->(status, e) do
+        exception_str = "#{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}"
+        Rage.logger.error(exception_str)
+        [status, {}, [exception_str]]
+      end
+    else
+      ->(status, e) do
+        exception_str = "#{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}"
+        Rage.logger.error(exception_str)
+        [status, {}, []]
+      end
+    end
+  end
 end

data/lib/rage/cli.rb

@@ -16,18 +16,24 @@ module Rage
 
     desc "s", "Start the app server."
     option :port, aliases: "-p", desc: "Runs Rage on the specified port - defaults to 3000."
+    option :environment, aliases: "-e", desc: "Specifies the environment to run this server under (test/development/production)."
+    option :binding, aliases: "-b", desc: "Binds Rails to the specified IP - defaults to 'localhost' in development and '0.0.0.0' in other environments."
+    option :config, aliases: "-c", desc: "Uses a custom rack configuration."
+    option :help, aliases: "-h", desc: "Show this message."
     def server
-      app = ::Rack::Builder.parse_file("config.ru")
+      return help("server") if options.help?
+
+      set_env(options)
+
+      app = ::Rack::Builder.parse_file(options[:config] || "config.ru")
       app = app[0] if app.is_a?(Array)
 
-      unless app.is_a?(Rage::FiberWrapper)
-        raise <<-ERR
-          Couldn't find the default middleware. Make sure to add the following line to your config.ru file:
-          Rage.load_middlewares(self)
-        ERR
-      end
+      port = options[:port] || Rage.config.server.port
+      address = options[:binding] || (Rage.env.production? ? "0.0.0.0" : "localhost")
+      timeout = Rage.config.server.timeout
+      max_clients = Rage.config.server.max_clients
 
-      ::Iodine.listen service: :http, handler: app, port: options[:port] || Rage.config.server.port
+      ::Iodine.listen service: :http, handler: app, port: port, address: address, timeout: timeout, max_clients: max_clients
       ::Iodine.threads = Rage.config.server.threads_count
       ::Iodine.workers = Rage.config.server.workers_count
 
@@ -36,12 +42,15 @@ module Rage
 
     desc 'routes', 'List all routes.'
     option :grep, aliases: "-g", desc: "Filter routes by pattern"
+    option :help, aliases: "-h", desc: "Show this message."
     def routes
+      return help("routes") if options.help?
       # the result would be something like this:
       # Verb  Path  Controller#Action
       # GET   /     application#index
 
       # load config/application.rb
+      set_env(options)
       environment
 
       routes = Rage.__router.routes
@@ -90,7 +99,12 @@ module Rage
     end
 
     desc "c", "Start the app console."
+    option :help, aliases: "-h", desc: "Show this message."
     def console
+      return help("console") if options.help?
+
+      set_env(options)
+
       require "irb"
       environment
       ARGV.clear
@@ -101,6 +115,16 @@ module Rage
 
     def environment
       require File.expand_path("config/application.rb", Dir.pwd)
+
+      # in Rails mode we delegate code loading to Rails, and thus need
+      # to manually load application code for CLI utilities to work
+      if Rage.config.internal.rails_mode
+        require "rage/setup"
+      end
+    end
+
+    def set_env(options)
+      ENV["RAGE_ENV"] = options[:environment] || ENV["RAGE_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
     end
   end
 

data/lib/rage/code_loader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+class Rage::CodeLoader
+  def initialize
+    @reloading = false
+  end
+
+  def setup
+    @loader = Zeitwerk::Loader.new
+
+    autoload_path = "#{Rage.root}/app"
+    enable_reloading = Rage.env.development?
+    enable_eager_loading = !Rage.env.development? && !Rage.env.test?
+
+    @loader.push_dir(autoload_path)
+    # The first level of directories in app directory won't be treated as modules
+    # e.g. app/controllers/pages_controller.rb will be linked to PagesController class
+    # instead of Controllers::PagesController
+    @loader.collapse("#{Rage.root}/app/*")
+    @loader.enable_reloading if enable_reloading
+    @loader.setup
+    @loader.eager_load if enable_eager_loading
+  end
+
+  # in standalone mode - reload the code and the routes
+  def reload
+    return unless @loader
+
+    @reloading = true
+    @loader.reload
+    Rage.__router.reset_routes
+    load("#{Rage.root}/config/routes.rb")
+  end
+
+  # in Rails mode - reset the routes; everything else will be done by Rails
+  def rails_mode_reload
+    return if @loader
+
+    @reloading = true
+    Rage.__router.reset_routes
+  end
+
+  def reloading?
+    @reloading
+  end
+end

data/lib/rage/configuration.rb

@@ -1,9 +1,106 @@
+# frozen_string_literal: true
+
+##
+# # General Configuration
+#
+# • _config.logger_
+#
+# > The logger that will be used for `Rage.logger` and any related `Rage` logging. Custom loggers should implement Ruby's {https://ruby-doc.org/3.2.2/stdlibs/logger/Logger.html#class-Logger-label-Entries Logger} interface.
+#
+# • _config.log_formatter_
+#
+# > The formatter of the Rage logger. Built in options include `Rage::TextFormatter` and `Rage::JSONFormatter`. Defaults to an instance of `Rage::TextFormatter`.
+#
+# • _config.log_level_
+#
+# > Defines the verbosity of the Rage logger. This option defaults to `:debug` for all environments except production, where it defaults to `:info`. The available log levels are: `:debug`, `:info`, `:warn`, `:error`, `:fatal`, and `:unknown`.
+#
+# # Middleware Configuration
+#
+# • _config.middleware.use_
+#
+# > Adds a middleware to the top of the middleware stack. **This is the preferred way of adding a middleware.**
+# > ```
+# config.middleware.use Rack::Cors do
+#   allow do
+#     origins "*"
+#     resource "*", headers: :any
+#   end
+# end
+# > ```
+#
+# • _config.middleware.insert_before_
+#
+# > Adds middleware at a specified position before another middleware. The position can be either an index or another middleware.
+#
+# > **_❗️Heads up:_** By default, Rage always uses the `Rage::FiberWrapper` middleware, which wraps every request in a separate fiber. Make sure to always have this middleware in the top of the stack. Placing other middlewares in front may lead to undefined behavior.
+#
+# > ```
+# config.middleware.insert_before Rack::Head, Magical::Unicorns
+# config.middleware.insert_before 0, Magical::Unicorns
+# > ```
+#
+# • _config.middleware.insert_after_
+#
+# > Adds middleware at a specified position after another middleware. The position can be either an index or another middleware.
+#
+# > ```
+# config.middleware.insert_after Rack::Head, Magical::Unicorns
+# > ```
+#
+# # Server Configuration
+#
+# _• config.server.max_clients_
+#
+# > Limits the number of simultaneous connections the server can accept. Defaults to the maximum number of open files.
+#
+# > **_❗️Heads up:_** Decreasing this number is almost never a good idea. Depending on your application specifics, you are encouraged to use other methods to limit the number of concurrent connections:
+#
+# > 1. If your application is exposed to the public, you may want to use a cloud rate limiter, like {https://developers.cloudflare.com/waf Cloudflare WAF} or {https://docs.fastly.com/en/ngwaf Fastly WAF}.
+# > 2. Otherwise, consider using tools like {https://github.com/rack/rack-attack Rack::Attack} or {https://github.com/mperham/connection_pool connection_pool}.
+#
+# > ```
+# # Limit the amount of connections your application can accept
+# config.middleware.use Rack::Attack
+# Rack::Attack.throttle("req/ip", limit: 300, period: 5.minutes) do |req|
+#   req.ip
+# end
+# #
+# # Limit the amount of connections to a specific resource
+# HTTP = ConnectionPool.new(size: 5, timeout: 5) { Net::HTTP }
+# HTTP.with do |conn|
+#   conn.get("/my-resource")
+# end
+# > ```
+#
+# • _config.server.port_
+#
+# > Specifies what port the server will listen on.
+#
+# • _config.server.workers_count_
+#
+# > Specifies the number of server processes to run.
+#
+# • _config.server.timeout_
+#
+# > Specifies connection timeout.
+#
 class Rage::Configuration
-  attr_accessor :logger, :log_formatter, :log_level
+  attr_accessor :logger
+  attr_reader :log_formatter, :log_level
 
   # used in DSL
   def config = self
 
+  def log_formatter=(formatter)
+    raise "Custom log formatter should respond to `#call`" unless formatter.respond_to?(:call)
+    @log_formatter = formatter
+  end
+
+  def log_level=(level)
+    @log_level = level.is_a?(Symbol) ? Logger.const_get(level.to_s.upcase) : level
+  end
+
   def server
     @server ||= Server.new
   end
@@ -12,8 +109,12 @@ class Rage::Configuration
     @middleware ||= Middleware.new
   end
 
+  def internal
+    @internal ||= Internal.new
+  end
+
   class Server
-    attr_accessor :port, :workers_count
+    attr_accessor :port, :workers_count, :timeout, :max_clients
     attr_reader :threads_count
 
     def initialize
@@ -36,6 +137,9 @@ class Rage::Configuration
 
     def insert_before(existing_middleware, new_middleware, *args, &block)
       index = find_middleware_index(existing_middleware)
+      if index == 0 && @middlewares[0][0] == Rage::FiberWrapper
+        puts("Warning: inserting #{new_middleware} before Rage::FiberWrapper may lead to undefined behavior.")
+      end
       @middlewares = (@middlewares[0...index] + [[new_middleware, args, block]] + @middlewares[index..]).uniq(&:first)
     end
 
@@ -60,9 +164,22 @@ class Rage::Configuration
     end
   end
 
+  # @private
+  class Internal
+    attr_accessor :rails_mode, :rails_console
+
+    def inspect
+      "#<#{self.class.name}>"
+    end
+  end
+
+  # @private
   def __finalize
-    @logger ||= Rage::Logger.new(nil)
-    @logger.formatter = @log_formatter if @logger && @log_formatter
-    @logger.level = @log_level if @logger && @log_level
+    if @logger
+      @logger.formatter = @log_formatter if @log_formatter
+      @logger.level = @log_level if @log_level
+    else
+      @logger = Rage::Logger.new(nil)
+    end
   end
 end