lantern-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b544123b390d3e7fee816bd3f27fdd485334fb5688f45754a52551294d39ef98
-  data.tar.gz: 74b280feb07f0d4bdac527c56d206c47b0fd009d293348c7924df76d46c900f8
+  metadata.gz: 93b5aad3eb2484e765586589b5cb3e7cbd931d25fb20d1e249e21b521b336d91
+  data.tar.gz: f8739f45b42a61c0ece6db30ae517dba6c30fe9ed4382ef315342a00c4cecfcb
 SHA512:
-  metadata.gz: a14c62f42e4b69f19ae193061a17d981f005e110c691f1f6b13200020cbb7bb1e50182d2c471814244a06b68d69bef54bab6f51230e5291226f3c3653f8bf788
-  data.tar.gz: d0f5344237d2684d8a8891a2ce9941669a26d455a3a05fdf01b6102c9c26322410f505db446c76b8043400e39b0b86491af165e5341d0a0b9366066ec92ffb48
+  metadata.gz: 89caa7f682946b0143c7bc2f2917c4070549bb0d178ea87c3574a0a6324d3289aa8feb100dcadf42ee300443876cec5d8c2101ab0ec291383f461d56b7a6579f
+  data.tar.gz: 2e1536b62d7292e113279e807bc61d59a166052a37cb9b8b8d834c6a733f0a24f0f3393db28e21598766e60ab4b2fbebfe2fb578c77fc91185114d31761595a2

data/README.md

@@ -18,12 +18,44 @@ bundle install
 
 ## Setup
 
-Generate an API key at [uselantern.dev](https://uselantern.dev), then create an initializer:
+1. Generate an API key at [uselantern.dev](https://uselantern.dev)
+2. Store the key using one of the options below
+3. Create an initializer
+
+### Store your API key
+
+**Option A: Environment variable**
+
+```
+LANTERN_API_KEY=lnt_your_key_here
+```
+
+**Option B: Rails credentials**
+
+```
+bin/rails credentials:edit
+```
+
+Flat:
+```yaml
+lantern_api_key: lnt_your_key_here
+```
+
+Or nested:
+```yaml
+lantern:
+  api_key: lnt_your_key_here
+```
+
+### Create the initializer
 
 ```ruby
 # config/initializers/lantern.rb
 Lantern::Rails.configure do |config|
+  # Match how you stored the key above:
   config.api_key = ENV["LANTERN_API_KEY"]
+  # Or: config.api_key = Rails.application.credentials.lantern_api_key
+  # Or: config.api_key = Rails.application.credentials.dig(:lantern, :api_key)
 end
 ```
 

data/lib/lantern/rails/query_aggregator.rb

@@ -0,0 +1,71 @@
+require "monitor"
+
+module Lantern
+  module Rails
+    class QueryAggregator
+      include MonitorMixin
+
+      def initialize
+        super() # MonitorMixin requires this
+        @requests = []
+      end
+
+      # Called at the end of each request with the queries captured during it.
+      # request_data is a Hash:
+      #   { controller_action: "orders#index", queries: { fingerprint => { count: N, sample_sql: "..." } } }
+      def record_request(request_data)
+        synchronize { @requests << request_data }
+      end
+
+      # Drain the buffer and return aggregated N+1 candidates.
+      # Returns an Array of Hashes ready to send as query_patterns in the snapshot payload.
+      def drain
+        captured = synchronize do
+          data = @requests
+          @requests = []
+          data
+        end
+
+        aggregate(captured)
+      end
+
+      private
+
+      def aggregate(requests)
+        return [] if requests.empty?
+
+        # Group by (controller_action, fingerprint)
+        grouped = Hash.new { |h, k| h[k] = { counts: [], sample_sql: nil } }
+
+        requests.each do |req|
+          action = req[:controller_action]
+          next if action.nil? || action.empty?
+
+          req[:queries]&.each do |fingerprint, data|
+            key = "#{action}||#{fingerprint}"
+            grouped[key][:counts] << data[:count]
+            grouped[key][:sample_sql] ||= data[:sample_sql]
+            grouped[key][:controller_action] = action
+            grouped[key][:fingerprint] = fingerprint
+          end
+        end
+
+        # Filter to N+1 candidates (avg > 2 calls per request) and build output
+        grouped.filter_map do |_key, data|
+          counts = data[:counts]
+          avg = counts.sum.to_f / counts.size
+          next if avg <= 2.0
+
+          {
+            query_fingerprint: data[:fingerprint],
+            controller_action: data[:controller_action],
+            calls_per_request_avg: avg.round(1),
+            calls_per_request_max: counts.max,
+            requests_sampled: counts.size,
+            sample_sql: data[:sample_sql]&.then { |s| s.length > 2000 ? s[0, 2000] : s }
+          }
+        end.sort_by { |qp| -qp[:calls_per_request_avg] }
+      end
+    end
+  end
+end

data/lib/lantern/rails/query_fingerprinter.rb

@@ -0,0 +1,29 @@
+module Lantern
+  module Rails
+    class QueryFingerprinter
+      # Normalize SQL into a fingerprint by replacing literal values with placeholders.
+      # "SELECT * FROM users WHERE id = 42 AND name = 'Eric'" becomes
+      # "SELECT * FROM users WHERE id = $1 AND name = $1"
+      def self.fingerprint(sql)
+        return "" if sql.nil?
+
+        normalized = sql.dup
+
+        # Replace quoted strings (single-quoted, with escaped quotes handled)
+        normalized.gsub!(/'(?:[^'\\]|\\.)*'/, "$1")
+
+        # Replace numeric literals (integers and floats, not part of identifiers)
+        normalized.gsub!(/\b\d+(?:\.\d+)?\b/, "$1")
+
+        # Replace IN lists: IN ($1, $1, $1) -> IN ($1)
+        normalized.gsub!(/IN\s*\(\s*(\$1(?:\s*,\s*\$1)*)\s*\)/i, "IN ($1)")
+
+        # Collapse whitespace
+        normalized.gsub!(/\s+/, " ")
+        normalized.strip!
+
+        normalized
+      end
+    end
+  end
+end

data/lib/lantern/rails/railtie.rb

@@ -1,6 +1,15 @@
 module Lantern
   module Rails
     class Railtie < ::Rails::Railtie
+      initializer "lantern.request_tracker" do |app|
+        config = Lantern::Rails.configuration
+        next unless config.valid?
+        next unless config.enabled
+        next unless config.collect_in_environments.include?(::Rails.env.to_s)
+
+        app.middleware.use Lantern::Rails::RequestTracker, Lantern::Rails.query_aggregator
+      end
+
       config.after_initialize do
         config = Lantern::Rails.configuration
         next unless config.valid?

data/lib/lantern/rails/request_tracker.rb

@@ -0,0 +1,73 @@
+module Lantern
+  module Rails
+    class RequestTracker
+      IGNORED_SQL = /\A\s*(BEGIN|COMMIT|ROLLBACK|SAVEPOINT|RELEASE|SET|SHOW|PRAGMA)/i
+      SCHEMA_SQL  = /\A\s*(CREATE|ALTER|DROP|INSERT INTO "schema_migrations")/i
+
+      def initialize(app, aggregator)
+        @app = app
+        @aggregator = aggregator
+      end
+
+      def call(env)
+        # Only track actual controller requests, skip assets/healthchecks
+        return @app.call(env) unless trackable_request?(env)
+
+        request_queries = {}
+
+        subscriber = ActiveSupport::Notifications.subscribe("sql.active_record") do |*, payload|
+          sql = payload[:sql]
+          next if sql.blank?
+          next if payload[:name] == "SCHEMA" || payload[:cached]
+          next if IGNORED_SQL.match?(sql)
+          next if SCHEMA_SQL.match?(sql)
+
+          fingerprint = QueryFingerprinter.fingerprint(sql)
+          next if fingerprint.blank?
+
+          entry = (request_queries[fingerprint] ||= { count: 0, sample_sql: nil })
+          entry[:count] += 1
+          entry[:sample_sql] ||= sql.truncate(2000)
+        end
+
+        status, headers, response = @app.call(env)
+
+        [status, headers, response]
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
+
+        if request_queries&.any?
+          controller_action = extract_controller_action(env)
+          if controller_action
+            @aggregator.record_request(
+              controller_action: controller_action,
+              queries: request_queries
+            )
+          end
+        end
+      end
+
+      private
+
+      def trackable_request?(env)
+        # Skip asset pipeline, action cable, health checks
+        path = env["PATH_INFO"].to_s
+        return false if path.start_with?("/assets", "/cable", "/up")
+        return false if path.match?(/\.\w+\z/) # static files
+
+        true
+      end
+
+      def extract_controller_action(env)
+        params = env["action_dispatch.request.parameters"]
+        return nil unless params
+
+        controller = params["controller"]
+        action = params["action"]
+        return nil unless controller && action
+
+        "#{controller}##{action}"
+      end
+    end
+  end
+end

data/lib/lantern/rails/runner.rb

@@ -35,6 +35,10 @@ module Lantern
         payload = Collector.new.collect
         return unless payload
 
+        # Drain accumulated N+1 query data from the request tracker
+        query_patterns = Lantern::Rails.query_aggregator.drain
+        payload[:query_patterns] = query_patterns if query_patterns.any?
+
         Reporter.new(@config).report_snapshot(payload)
       rescue => e
         ::Rails.logger.error("[Lantern] Runner error: #{e.message}")

data/lib/lantern/rails/version.rb

@@ -1,5 +1,5 @@
 module Lantern
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/lantern-rails.rb

@@ -2,6 +2,9 @@ require "lantern/rails/version"
 require "lantern/rails/configuration"
 require "lantern/rails/git_metadata"
 require "lantern/rails/collector"
+require "lantern/rails/query_fingerprinter"
+require "lantern/rails/query_aggregator"
+require "lantern/rails/request_tracker"
 require "lantern/rails/reporter"
 require "lantern/rails/runner"
 require "lantern/rails/railtie" if defined?(::Rails)
@@ -17,6 +20,10 @@ module Lantern
         yield configuration
       end
 
+      def query_aggregator
+        @query_aggregator ||= QueryAggregator.new
+      end
+
       # Manually report a deploy event. Call this from your CI/CD pipeline
       # or a deploy hook in your Rails app.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lantern-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Mumbower
@@ -33,14 +33,18 @@ files:
 - lib/lantern/rails/collector.rb
 - lib/lantern/rails/configuration.rb
 - lib/lantern/rails/git_metadata.rb
+- lib/lantern/rails/query_aggregator.rb
+- lib/lantern/rails/query_fingerprinter.rb
 - lib/lantern/rails/railtie.rb
 - lib/lantern/rails/reporter.rb
+- lib/lantern/rails/request_tracker.rb
 - lib/lantern/rails/runner.rb
 - lib/lantern/rails/version.rb
 homepage: https://uselantern.dev
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/emum/lantern-rails
 rdoc_options: []
 require_paths:
 - lib