kirei 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f515625a7b5fda4fb1218d126c8c1c98c720186176d0b5eb3c01a2330de49017
-  data.tar.gz: b47e63f5d3f9298523809f151040ed5fd78168ffb7616645a48b45f0b02ad74a
+  metadata.gz: 1926e641bc2fa378b9444e97f33c7aef0bd97ce3c277a38fc572f12d501acb77
+  data.tar.gz: 2cdaff92504ea20fac445d791da1f9557fe3fbe6f4f780eab70c9022feacb3e1
 SHA512:
-  metadata.gz: 6eb332b813b427ecfaca012b17b3ba18729f7569fdb08544ee65bd5b52e6e20671e1c0185abee8dfd6d191ed4ce22d001bb1c2c2d8281bd96a2809ea151f7447
-  data.tar.gz: 35d98ccc9bd0f1bc9d81425229925c02e666a9d973d956bdd57ed181384c53e890feb30ae24e4225cc4ed5ea68e173d86cc1163d60e5075f74f60802a2dd50de
+  metadata.gz: 4111679c635210bd6a9389c839c2665e5fea9a1e4bd3e6186725e89022a8964cf7a2dc8c2b5347eaf76962b327a7c0a77243cfc7c6ac214e01f59592a08a132f
+  data.tar.gz: 8aaf9c748f52d790cc2be69cb29087c96f1ad1001ee629555b5727d93770a1b73be72fbb62a8d1b3993a3ef75676832463b401cb265e5dd18a277d9706b9fc68

data/README.md

@@ -6,7 +6,7 @@ Kirei's main advantages over other frameworks are its strict typing, low memory
 
 > Kirei (きれい) is a Japanese adjective that primarily means "beautiful" or "pretty." It can also be used to describe something that is "clean" or "neat."
 
-👉 AI-generated wiki available on [DeepWiki.com](https://deepwiki.com/swiknaba/kirei).
+👉 AI-generated wiki available on [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/swiknaba/kirei)
 
 ## Why another Ruby framework?
 

data/lib/cli/commands/new_app/files/app.rb

@@ -44,7 +44,10 @@ module Cli
 
               # Fifth: load configs
               Dir[File.join(__dir__, "config", "**", "*.rb")].each do |cnf|
-                require(cnf) unless cnf.split("/").include?("initializers")
+                next if cnf.split("/").include?("initializers")
+                next if cnf.end_with?("puma.rb") # Puma config uses DSL only available when loaded by Puma
+
+                require(cnf)
               end
 
               class #{app_name} < Kirei::App

data/lib/cli/commands/new_app/files/routes.rb

@@ -5,10 +5,9 @@ module Cli
     module NewApp
       module Files
         class Routes
-          def self.call(app_name)
+          def self.call(_app_name)
             File.write("config/routes.rb", router)
             File.write("app/controllers/base.rb", base_controller)
-            File.write("app/controllers/health.rb", health_controller(app_name))
           end
 
           def self.router
@@ -17,16 +16,7 @@ module Cli
               # frozen_string_literal: true
 
               module Kirei::Routing
-                Router.add_routes(
-                  [
-                    Route.new(
-                      verb: Verb::GET,
-                      path: "/livez",
-                      controller: Controllers::Health,
-                      action: "livez",
-                    ),
-                  ],
-                )
+                Router.add_health_routes!
               end
             RUBY
           end
@@ -43,24 +33,6 @@ module Cli
               end
             RUBY
           end
-
-          def self.health_controller(app_name)
-            <<~RUBY
-              # typed: strict
-              # frozen_string_literal: true
-
-              module Controllers
-                class Health < Base
-                  sig { returns(T.anything) }
-                  def livez
-                    #{app_name}.config.logger.info("Health check")
-                    #{app_name}.config.logger.info(params.inspect)
-                    render(#{app_name}.version, status: 200)
-                  end
-                end
-              end
-            RUBY
-          end
         end
       end
     end

data/lib/kirei/controllers/health.rb

@@ -0,0 +1,63 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Kirei
+  module Controllers
+    #
+    # Built-in health check controller implementing Kubernetes API health endpoints.
+    #
+    # Provides three endpoints following the Kubernetes convention:
+    #   - /livez   — Liveness probe. Indicates the process is alive.
+    #   - /readyz  — Readiness probe. Verifies downstream dependencies (DB) are reachable.
+    #   - /healthz — Deprecated alias for /livez (deprecated since Kubernetes v1.16).
+    #
+    # Reference: https://kubernetes.io/docs/reference/using-api/health-checks/
+    #
+    class Health < Kirei::Controller
+      extend T::Sig
+
+      sig { returns(Routing::RackResponseType) }
+      def livez
+        info = {
+          "status" => "ok",
+          "version" => App.version,
+          "app_name" => App.config.app_name,
+          "environment" => App.environment,
+          "req_host" => request.host,
+          "req_port" => request.port,
+          "req_ssl" => request.ssl?,
+        }
+
+        Kirei::Logging::Logger.call(
+          level: Kirei::Logging::Level::INFO,
+          label: "Health check",
+          meta: info,
+        )
+
+        render_json(info, status: 200)
+      end
+      alias healthz livez
+
+      sig { returns(Routing::RackResponseType) }
+      def readyz
+        T.unsafe(App.raw_db_connection).execute("SELECT 1")
+
+        Kirei::Logging::Logger.call(
+          level: Kirei::Logging::Level::INFO,
+          label: "Readiness check",
+          meta: { "status" => "ok" },
+        )
+
+        render_json({ "status" => "ok" }, status: 200)
+      rescue Sequel::Error => e
+        Kirei::Logging::Logger.call(
+          level: Kirei::Logging::Level::ERROR,
+          label: "Readiness check failed",
+          meta: { "error" => e.message },
+        )
+
+        render_json({ "status" => "unavailable", "reason" => e.message }, status: 503)
+      end
+    end
+  end
+end

data/lib/kirei/routing/base.rb

@@ -23,6 +23,7 @@ module Kirei
 
       sig { params(env: RackEnvType).returns(RackResponseType) }
       def call(env)
+        statsd_timing_tags = T.let({}, T::Hash[String, T.untyped])
         start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
         status = 500 # we use it in the "ensure" block, so we need to define early (Sorbet doesn't like `status ||= 418`)
 
@@ -62,7 +63,7 @@ module Kirei
                      body.rewind # TODO: maybe don't rewind if we don't need to?
                      T.cast(res, T::Hash[String, T.untyped])
                    end
-                 when Verb::HEAD, Verb::DELETE, Verb::OPTIONS, Verb::TRACE, Verb::CONNECT
+                 when Verb::HEAD, Verb::DELETE, Verb::OPTIONS
                    {}
                  else
                    T.absurd(http_verb)
@@ -90,14 +91,11 @@ module Kirei
           },
         )
 
-        statsd_timing_tags = {
-          "controller" => controller.name,
-          "route" => route.action,
-        }
-        Logging::Metric.inject_defaults(statsd_timing_tags)
+        statsd_timing_tags["controller"] = controller.name
+        statsd_timing_tags["route"] = route.action
 
         status, headers, response_body = case http_verb
-                                         when Verb::HEAD, Verb::OPTIONS, Verb::TRACE, Verb::CONNECT
+                                         when Verb::HEAD, Verb::OPTIONS
                                            [200, {}, []]
                                          when Verb::GET, Verb::POST, Verb::PUT, Verb::PATCH, Verb::DELETE
                                            T.cast(
@@ -124,10 +122,35 @@ module Kirei
           headers,
           response_body,
         ]
+      rescue StandardError => e
+        status = 500
+
+        Kirei::Logging::Logger.call(
+          level: Kirei::Logging::Level::ERROR,
+          label: "Unhandled Exception",
+          meta: {
+            "error.class" => e.class.name,
+            "error.message" => e.message,
+            "error.backtrace" => e.backtrace&.first(10)&.join("\n"),
+          },
+        )
+
+        detail = if Kirei::App.environment == "development"
+          "#{e.class}: #{e.message}\n#{e.backtrace&.first(10)&.join("\n")}"
+        else
+          "An unexpected error occurred"
+        end
+
+        error = Errors::JsonApiError.new(code: "internal_server_error", detail: detail)
+        body = Oj.dump({ "errors" => [error.serialize] }, Kirei::OJ_OPTIONS)
+        response_body = [body]
+
+        [status, { "Content-Type" => "application/json; charset=utf-8" }, response_body]
       ensure
         stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
-        if start # early return for 404
+        if start && statsd_timing_tags # early return for 404
           latency_in_ms = stop - start
+          Logging::Metric.inject_defaults(statsd_timing_tags)
           App.config.metrics_backend.measure("request", latency_in_ms, tags: statsd_timing_tags)
 
           Kirei::Logging::Logger.call(

data/lib/kirei/routing/router.rb

@@ -85,6 +85,18 @@ module Kirei
         end
       end
 
+      # must be added manually => we don't want to magically add routes for the user
+      sig { void }
+      def self.add_health_routes!
+        add_routes(
+          [
+            Route.new(verb: Verb::GET, path: "/livez", controller: Kirei::Controllers::Health, action: "livez"),
+            Route.new(verb: Verb::GET, path: "/readyz", controller: Kirei::Controllers::Health, action: "readyz"),
+            Route.new(verb: Verb::GET, path: "/healthz", controller: Kirei::Controllers::Health, action: "healthz"),
+          ],
+        )
+      end
+
       # Matches a request path against registered dynamic routes.
       # Returns [Route, extracted_params] or nil.
       sig do

data/lib/kirei/routing/verb.rb

@@ -25,12 +25,6 @@ module Kirei
 
         # idempotent
         OPTIONS = new("OPTIONS")
-
-        # idempotent
-        TRACE   = new("TRACE")
-
-        # non-idempotent
-        CONNECT = new("CONNECT")
       end
     end
   end

data/lib/kirei/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Kirei
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/kirei.rb

@@ -67,6 +67,4 @@ loader.eager_load
 
 Kirei.configure(&:itself)
 
-yjit_enabled = defined?(RubyVM::YJIT) ? RubyVM::YJIT.enabled? : false
-
-Kirei::Logging::Logger.logger.info("Kirei v#{Kirei::VERSION} booted; YJIT enabled: #{yjit_enabled}")
+Kirei::Logging::Logger.logger.info("Kirei v#{Kirei::VERSION} booted")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kirei
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Ludwig Reinmiedl
@@ -174,6 +174,7 @@ files:
 - lib/kirei/app.rb
 - lib/kirei/config.rb
 - lib/kirei/controller.rb
+- lib/kirei/controllers/health.rb
 - lib/kirei/domain/entity.rb
 - lib/kirei/domain/value_object.rb
 - lib/kirei/errors/json_api_error.rb
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Kirei is a typed Ruby micro/REST-framework for building scalable and performant
   microservices.