grape_rails_logger 1.1.3

data/lib/grape_rails_logger/timings.rb

@@ -0,0 +1,36 @@
+module GrapeRailsLogger
+  # Thread-safe storage for DB timing metrics per request
+  module Timings
+    # Use IsolatedExecutionState for Rails 7.1+ thread/Fiber safety
+    # Falls back to Thread.current for Rails 6-7.0
+    if defined?(ActiveSupport::IsolatedExecutionState)
+      def self.execution_state
+        ActiveSupport::IsolatedExecutionState
+      end
+    else
+      def self.execution_state
+        Thread.current
+      end
+    end
+
+    def self.reset_db_runtime
+      state = execution_state
+      state[:grape_db_runtime] = 0
+      state[:grape_db_calls] = 0
+    end
+
+    def self.db_runtime
+      execution_state[:grape_db_runtime] ||= 0
+    end
+
+    def self.db_calls
+      execution_state[:grape_db_calls] ||= 0
+    end
+
+    def self.append_db_runtime(event)
+      state = execution_state
+      state[:grape_db_runtime] = (state[:grape_db_runtime] || 0) + event.duration
+      state[:grape_db_calls] = (state[:grape_db_calls] || 0) + 1
+    end
+  end
+end

data/lib/grape_rails_logger/version.rb

@@ -0,0 +1,3 @@
+module GrapeRailsLogger
+  VERSION = "1.1.3"
+end

data/lib/grape_rails_logger.rb

@@ -0,0 +1,78 @@
+require "active_support"
+require "active_support/notifications"
+require "grape"
+
+# Load all required files first to ensure constants are available
+# This must happen before the module definition (like other gems do)
+require "grape_rails_logger/version"
+require "grape_rails_logger/timings"
+require "grape_rails_logger/status_extractor"
+require "grape_rails_logger/subscriber"
+require "grape_rails_logger/endpoint_patch"
+require "grape_rails_logger/endpoint_wrapper"
+require "grape_rails_logger/debug_tracer"
+
+module GrapeRailsLogger
+  # Configuration for GrapeRailsLogger
+  #
+  # When running in Rails, use Rails.application.config.grape_rails_logger instead:
+  #
+  # @example Configure in Rails initializer
+  #   # config/initializers/grape_rails_logger.rb
+  #   Rails.application.config.grape_rails_logger.enabled = true
+  #   Rails.application.config.grape_rails_logger.subscriber_class = CustomSubscriber
+  #
+  # @example Standalone usage (non-Rails)
+  #   GrapeRailsLogger.config.enabled = false
+  class Config
+    attr_accessor :enabled, :subscriber_class, :logger, :tag
+
+    def initialize
+      @enabled = true
+      @subscriber_class = GrapeRequestLogSubscriber
+      @logger = nil # Default to nil, will use Rails.logger if available
+      @tag = "Grape" # Default tag for TaggedLogging
+    end
+  end
+
+  # Global configuration instance (for non-Rails usage)
+  #
+  # @return [Config] The configuration object
+  def self.config
+    @config ||= Config.new
+  end
+
+  # Configure the logger (for non-Rails usage)
+  #
+  # @yield [config] Yields the configuration object
+  # @example
+  #   GrapeRailsLogger.configure do |config|
+  #     config.enabled = false
+  #   end
+  def self.configure
+    yield config
+  end
+
+  # Get the effective configuration (Rails-aware)
+  #
+  # @return [Config] The active configuration object
+  def self.effective_config
+    if defined?(Rails) && Rails.application && Rails.application.config.respond_to?(:grape_rails_logger)
+      # Use Rails config if available
+      rails_config = Rails.application.config.grape_rails_logger
+      config_obj = Config.new
+      config_obj.enabled = rails_config.enabled if rails_config.respond_to?(:enabled)
+      config_obj.subscriber_class = rails_config.subscriber_class if rails_config.respond_to?(:subscriber_class)
+      config_obj.logger = rails_config.logger if rails_config.respond_to?(:logger)
+      config_obj.tag = rails_config.tag if rails_config.respond_to?(:tag)
+      config_obj
+    else
+      # Fall back to module-level config for non-Rails usage
+      config
+    end
+  end
+end
+
+# Load Railtie for Rails integration
+# Rails will automatically discover and initialize this Railtie
+require "grape_rails_logger/railtie"

data/sig/grape_rails_logger.rbs

@@ -0,0 +1,47 @@
+module GrapeRailsLogger
+  VERSION: String
+
+  class Config
+    attr_accessor enabled: bool
+    attr_accessor subscriber_class: Class
+    attr_accessor logger: Logger?
+    attr_accessor tag: String
+
+    def initialize: () -> void
+  end
+
+  def self.config: () -> Config
+  def self.configure: () { (Config) -> void } -> void
+  def self.effective_config: () -> Config
+
+  module Timings
+    def self.execution_state: () -> untyped
+    def self.reset_db_runtime: () -> void
+    def self.db_runtime: () -> Float
+    def self.db_calls: () -> Integer
+    def self.append_db_runtime: (ActiveSupport::Notifications::Event event) -> void
+  end
+
+  module StatusExtractor
+    def self.extract_status_from_exception: (Exception exception) -> Integer
+  end
+
+  module EndpointPatch
+    def build_stack: (*untyped args) -> untyped
+  end
+
+  class GrapeRequestLogSubscriber
+    def initialize: () -> void
+    def grape_request: (ActiveSupport::Notifications::Event event) -> void
+  end
+
+  class EndpointWrapper
+    def initialize: (untyped app, untyped endpoint) -> void
+    def call: (Hash[String, untyped] env) -> Array[Integer, Hash[String, String], Array[String]]
+  end
+
+  class DebugTracer < Grape::Middleware::Base
+    def call!: (Hash[String, untyped] env) -> Array[Integer, Hash[String, String], Array[String]]
+  end
+end
+

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: grape_rails_logger
+version: !ruby/object:Gem::Version
+  version: 1.1.3
+platform: ruby
+authors:
+- amkisko
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rails-compatible, ActiveSupport-integrated logging for Grape APIs, including
+  request context and ActiveRecord timings.
+email:
+- contact@kiskolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/grape_rails_logger.rb
+- lib/grape_rails_logger/debug_tracer.rb
+- lib/grape_rails_logger/endpoint_patch.rb
+- lib/grape_rails_logger/endpoint_wrapper.rb
+- lib/grape_rails_logger/railtie.rb
+- lib/grape_rails_logger/status_extractor.rb
+- lib/grape_rails_logger/subscriber.rb
+- lib/grape_rails_logger/timings.rb
+- lib/grape_rails_logger/version.rb
+- sig/grape_rails_logger.rbs
+homepage: https://github.com/amkisko/grape_rails_logger.rb
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/amkisko/grape_rails_logger.rb
+  changelog_uri: https://github.com/amkisko/grape_rails_logger.rb/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/amkisko/grape_rails_logger.rb/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Unified JSON request logging for Grape on Rails with DB timing.
+test_files: []