eyeloupe 0.1.0

data/lib/eyeloupe/processors/in_request.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+require 'singleton'
+
+module Eyeloupe
+  module Processors
+    class InRequest
+
+      include Singleton
+
+      # @return [ActionDispatch::Request]
+      attr_accessor :request
+
+      # @return [Hash, nil]
+      attr_accessor :env
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Hash, nil]
+      attr_accessor :headers
+
+      # @return [String, nil, Rack::BodyProxy, ActionDispatch::Response]
+      attr_accessor :response
+
+      # @return [Hash]
+      attr_accessor :timings
+
+      # @return [Time, nil]
+      attr_accessor :started_at
+
+      # @return [Array]
+      attr_accessor :subs
+
+      def initialize
+        @env = {}
+        @request = ActionDispatch::Request.new(@env)
+        @status = nil
+        @headers = nil
+        @response = nil
+        @timings = {}
+        @started_at = nil
+        @subs = []
+      end
+
+      # @param [ActionDispatch::Request] request The request object
+      # @param [Hash, nil] env Rack environment
+      # @param [Integer, nil] status HTTP status code
+      # @param [Hash, nil] headers HTTP headers
+      # @param [String, nil] response HTTP response
+      # @return [Eyeloupe::Processors::InRequest]
+      def init(request, env, status, headers, response)
+        unsubscribe
+
+        @request = request
+        @env = env
+        @status = status
+        @headers = headers
+        @response = response
+
+        self
+      end
+
+      def start_timer
+        @started_at = Time.now
+
+        subscribe('process_action.action_controller') do |event|
+          @timings[:controller_time] = event.duration
+          @timings[:db_time] = event.payload[:db_runtime]
+          @timings[:view_time] = event.payload[:view_runtime]
+        end
+      end
+
+      # @return [Eyeloupe::InRequest]
+      def process
+        Eyeloupe::InRequest.create(
+          verb: @request.request_method,
+          hostname: @request.host,
+          path: @env["REQUEST_URI"],
+          controller: get_controller,
+          status: @status,
+          format: @request.format,
+          duration: get_total_duration,
+          db_duration: @timings[:db_time].present? ? @timings[:db_time].round : nil,
+          view_duration: @timings[:view_time].present? ? @timings[:view_time].round : nil,
+          ip: @request.ip,
+          payload: @env['rack.input'].read,
+          headers: @headers&.to_json,
+          session: (@request.session || {}).to_json,
+          response: get_response,
+        )
+      end
+
+      protected
+
+      # @return [Float]
+      def get_total_duration
+        if @timings[:controller_time].present?
+          @timings[:controller_time].round
+        elsif @started_at.present?
+          (Time.now - @started_at) * 1000
+        else
+          0.0
+        end
+      end
+
+      # @return [String, nil]
+      def get_response
+        if @request.format.to_s =~ /html/
+          "HTML content"
+        elsif @response.is_a?(ActionDispatch::Response)
+          @response.body
+        elsif @response.is_a?(Rack::BodyProxy)
+          @response.first
+        else
+          @response
+        end
+      end
+
+      # @return [String, nil]
+      def get_controller
+        if @request.controller_class.to_s =~ /PASS_NOT_FOUND/
+          nil
+        else
+          "#{@request.controller_class.to_s}##{@request.path_parameters[:action]}"
+        end
+      end
+
+      private
+
+      # @param [String] event The event to subscribe to
+      # @param [Proc] block The block to execute when the event is triggered
+      # @yield [ActiveSupport::Notifications::Event] The event object
+      def subscribe(event, &block)
+        @subs << ActiveSupport::Notifications.subscribe(event) do |*args|
+          block.call(ActiveSupport::Notifications::Event.new(*args))
+        end
+      end
+
+      def unsubscribe
+        @subs.each do |sub|
+          ActiveSupport::Notifications.unsubscribe(sub)
+        end
+        @subs = []
+      end
+
+    end
+  end
+end

data/lib/eyeloupe/processors/out_request.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Eyeloupe
+  module Processors
+    class OutRequest
+      include Singleton
+
+      # @return [Net::HTTPRequest, nil]
+      attr_accessor :request
+
+      # @return [String]
+      attr_accessor :body
+
+      # @return [Hash]
+      attr_accessor :req_headers
+
+      # @return [Hash]
+      attr_accessor :res_headers
+
+      # @return [Net::HTTPResponse, nil]
+      attr_accessor :response
+
+      # @return [Time, nil]
+      attr_accessor :started_at
+
+      def initialize
+        @request = nil
+        @body = ""
+        @req_headers = {}
+        @res_headers = {}
+        @started_at = nil
+        @response = nil
+      end
+
+      # @param [Net::HTTPRequest] request The request object
+      # @param [String] body The request body
+      def init(request, body)
+        @request = request
+        @body = body
+        @started_at = Time.now
+      end
+
+      # @param [Net::HTTPResponse] response The response object
+      # @return [Net::HTTPResponse] The response object
+      def process(response)
+        @response = response
+
+        Eyeloupe::OutRequest.create(
+          verb: @request.method,
+          hostname: @request['host'],
+          path: @request.path,
+          status: @response.code,
+          format: @response.content_type,
+          duration: (Time.now - @started_at) * 1000,
+          payload: @request.body,
+          req_headers: (get_headers(@request) || {}).to_json,
+          res_headers: (get_headers(@response) || {}).to_json,
+          response: @response.body,
+          )
+        response
+      end
+
+      protected
+
+      # @param [Net::HTTPRequest, Net::HTTPResponse] el The request or response object to get headers from
+      def get_headers(el)
+        headers = {}
+        el.each_header do |key, value|
+          headers[key] = value
+        end
+        headers
+      end
+
+    end
+  end
+end

data/lib/eyeloupe/request_middleware.rb

@@ -0,0 +1,72 @@
+module Eyeloupe
+
+  class RequestMiddleware
+
+    # @return [Eyeloupe::Processors::InRequest]
+    attr_accessor :inrequest_processor
+
+    def initialize(app)
+      @app = app
+      @inrequest_processor = Processors::InRequest.instance
+    end
+
+    # @param [Hash] env Rack environment
+    def call(env)
+
+      request = ActionDispatch::Request.new(env)
+
+      if enabled?(request) && !skip_request?(request)
+        @inrequest_processor.start_timer
+
+        begin
+          status, headers, response = @app.call(env)
+          [status, headers, response]
+        rescue Exception => e
+          exception = ActionDispatch::ExceptionWrapper.new(env, e)
+          status = exception.status_code
+          headers = {}
+          response = e.message
+          raise
+        ensure
+          @inrequest_processor.init(request, env, status, headers, response).process
+        end
+      else
+        @app.call(env)
+      end
+
+    end
+
+    protected
+
+    # Check if capture is enabled, if so we are looking to the capture cookie, if no cookie present capture is enabled by default
+    #
+    # @param [ActionDispatch::Request] request
+    # @return [Boolean]
+    def enabled?(request)
+      if Eyeloupe.configuration.capture
+        if request.cookies['eyeloupe_capture'].present?
+          request.cookies['eyeloupe_capture'] == "true"
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    # Check if the request path is in the excluded paths
+    #
+    # @param [ActionDispatch::Request] request
+    # @return [Boolean]
+    def skip_request?(request)
+      excluded_paths = %w[mini-profiler eyeloupe active_storage] + Eyeloupe.configuration.excluded_paths
+
+      excluded_paths.each do |item|
+        return true if request.path =~ /#{item}/
+      end
+
+      false
+    end
+
+  end
+end

data/lib/eyeloupe/version.rb

@@ -0,0 +1,4 @@
+module Eyeloupe
+  # @return [String]
+  VERSION = "0.1.0"
+end

data/lib/eyeloupe.rb

@@ -0,0 +1,21 @@
+require "eyeloupe/version"
+require "eyeloupe/engine"
+
+require 'eyeloupe/request_middleware'
+require 'eyeloupe/configuration'
+require 'eyeloupe/http'
+require 'eyeloupe/processors/in_request'
+require 'eyeloupe/processors/out_request'
+
+module Eyeloupe
+
+  # @return [Eyeloupe::Configuration]
+  def self.configuration
+    Configuration.instance
+  end
+
+  # @yieldparam [Eyeloupe::Configuration] configuration
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/tasks/eyeloupe_tasks.rake

@@ -0,0 +1,9 @@
+desc "Compiling TailwindCSS files"
+task :tailwind_watch do
+  require "tailwindcss-rails"
+  system "#{Tailwindcss::Engine.root.join("exe/tailwindcss")} \
+         -i #{Eyeloupe::Engine.root.join("app/assets/stylesheets/application.tailwind.css")} \
+         -o #{Eyeloupe::Engine.root.join("app/assets/builds/eyeloupe.css")} \
+         -c #{Eyeloupe::Engine.root.join("config/tailwind.config.js")} \
+         --minify -w"
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: eyeloupe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Lion
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: The All in one Rails monitoring tool
+email:
+- dev@alexandrelion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/builds/eyeloupe.css
+- app/assets/config/eyeloupe_manifest.js
+- app/assets/images/eyeloupe/logo.png
+- app/assets/javascripts/eyeloupe/application.js
+- app/assets/javascripts/eyeloupe/controllers/application.js
+- app/assets/javascripts/eyeloupe/controllers/eyeloupe/nav_controller.js
+- app/assets/javascripts/eyeloupe/controllers/eyeloupe/pause_controller.js
+- app/assets/javascripts/eyeloupe/controllers/eyeloupe/refresh_controller.js
+- app/assets/javascripts/eyeloupe/controllers/eyeloupe/search_controller.js
+- app/assets/javascripts/eyeloupe/controllers/index.js
+- app/assets/stylesheets/application.tailwind.css
+- app/assets/stylesheets/eyeloupe/application.css
+- app/controllers/concerns/eyeloupe/searchable.rb
+- app/controllers/eyeloupe/application_controller.rb
+- app/controllers/eyeloupe/configs_controller.rb
+- app/controllers/eyeloupe/data_controller.rb
+- app/controllers/eyeloupe/in_requests_controller.rb
+- app/controllers/eyeloupe/out_requests_controller.rb
+- app/helpers/eyeloupe/application_helper.rb
+- app/jobs/eyeloupe/application_job.rb
+- app/mailers/eyeloupe/application_mailer.rb
+- app/models/eyeloupe/application_record.rb
+- app/models/eyeloupe/in_request.rb
+- app/models/eyeloupe/out_request.rb
+- app/views/eyeloupe/in_requests/_frame.html.erb
+- app/views/eyeloupe/in_requests/index.html.erb
+- app/views/eyeloupe/in_requests/show.html.erb
+- app/views/eyeloupe/out_requests/_frame.html.erb
+- app/views/eyeloupe/out_requests/index.html.erb
+- app/views/eyeloupe/out_requests/show.html.erb
+- app/views/eyeloupe/shared/_status_code.html.erb
+- app/views/eyeloupe/shared/_verb.html.erb
+- app/views/layouts/eyeloupe/application.html.erb
+- config/importmap.rb
+- config/routes.rb
+- config/tailwind.config.js
+- db/migrate/20230518175305_create_eyeloupe_in_requests.rb
+- db/migrate/20230525125352_create_eyeloupe_out_requests.rb
+- lib/eyeloupe.rb
+- lib/eyeloupe/configuration.rb
+- lib/eyeloupe/engine.rb
+- lib/eyeloupe/http.rb
+- lib/eyeloupe/processors/in_request.rb
+- lib/eyeloupe/processors/out_request.rb
+- lib/eyeloupe/request_middleware.rb
+- lib/eyeloupe/version.rb
+- lib/tasks/eyeloupe_tasks.rake
+homepage: https://github.com/alxlion/eyeloupe
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alxlion/eyeloupe
+  source_code_uri: https://github.com/alxlion/eyeloupe
+  changelog_uri: https://github.com/alxlion/eyeloupe/blob/master/CHANGELOG.md
+post_install_message:
+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.3.7
+signing_key:
+specification_version: 4
+summary: The elegant Rails debug assistant
+test_files: []