esse-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f617e7597afa910dbfde6b428b6c3cab87bb03c75a192718dad856d692163fe2
+  data.tar.gz: 7f161a6e35bf664bfd20ec28cd681c066675f23b179d82463fac83177d28a7e1
+SHA512:
+  metadata.gz: 9bb4b60191ad204c857279422077d8f74b642891f8d54de5c83d64732320362e16c8b0c22e700ad422af125ca7bee34a8c97bce9dfa0c85a9f36140361af1228
+  data.tar.gz: 3fbb84943825c3a87263b11edd4132f3e528b466062c2bcceb63644eef1badeeaf0b583bc7f4e63378cb154b91d559cdaff1641b884f19e6bfb3c3d81ace6e71

data/.rubocop.yml

@@ -0,0 +1,23 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2023-11-10
+The first release of the Esse::Rails. This release includes the following features:
+* Instrumentation for Esse search operations

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "esse", github: "marcosgz/esse", branch: "master"
+gem "activesupport", "~> 5.2"
+
+# Specify your gem's dependencies in esse-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,183 @@
+GIT
+  remote: https://github.com/marcosgz/esse.git
+  revision: 7b9bf919265464e20dd42fc58d7908a1b90d73fa
+  branch: master
+  specs:
+    esse (0.2.2)
+      multi_json
+      thor (>= 0.19)
+
+PATH
+  remote: .
+  specs:
+    esse-rails (0.0.1)
+      activesupport (>= 4.2, < 8)
+      esse
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.8.1)
+      actionview (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.8.1)
+      activesupport (= 5.2.8.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    erubi (1.12.0)
+    hashdiff (1.0.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    lograge (0.11.1)
+      actionpack (>= 4)
+      activesupport (>= 4)
+      railties (>= 4)
+      request_store (~> 1.0)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    multi_json (1.15.0)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.3)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (5.2.8.1)
+      actionpack (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.8.2)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    standard (1.32.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    thor (1.3.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.11)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 5.2)
+  awesome_print
+  dotenv
+  esse!
+  esse-rails!
+  lograge
+  pry
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 1.20)
+  rubocop-performance (~> 1.11, >= 1.11.5)
+  rubocop-rspec (~> 2.4)
+  standard (~> 1.3)
+  webmock (~> 3.14)
+  yard (~> 0.9.20)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marcos G. Zimmermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# esse-rails
+ Ruby on Rails extensions for "esse" elasticsearch/opensearch client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Instrumentation
+
+Esse::Rails provides instrumentation for Esse search operations. It uses Esse::Events to instrument when a search is performed.
+
+If you are using [lograge](https://github.com/roidrage/lograge), you can optionally require `esse/rails/lograge` to log search operations:
+
+```ruby
+require 'esse/rails/lograge'
+```

data/lib/esse/rails/cli/autoloader.rb

@@ -0,0 +1,27 @@
+# require "rails/app_loader"
+
+# # If we are inside a Rails application this method performs an exec and thus
+# # the rest of this script is not run.
+# Rails::AppLoader.exec_app
+
+require "esse/cli"
+
+module Esse
+  module Rails
+    module CLI
+      module Autoloader
+        def after_initialize
+          begin
+            env_file = File.expand_path("config/environment.rb", Dir.pwd)
+            require env_file if File.exist?(env_file)
+          rescue LoadError
+            # keep going
+          end
+          super
+        end
+      end
+    end
+  end
+end
+
+Esse::CLI::Root.prepend(Esse::Rails::CLI::Autoloader)

data/lib/esse/rails/instrumentation/controller_runtime.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/attr_internal"
+
+module Esse
+  module Rails
+    module Instrumentation
+      # Hooks into ActionController to display search runtime
+      #
+      # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/controller_runtime.rb
+      #
+      module ControllerRuntime
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def log_process_action(payload)
+            messages, esse_runtime = super, payload[:esse_runtime]
+            messages << ("Search: %.1fms" % esse_runtime.to_f) if esse_runtime
+            messages
+          end
+        end
+
+        def initialize(*args)
+          super(*args)
+          self.esse_runtime = nil
+        end
+
+        protected
+
+        attr_internal :esse_runtime
+
+        def process_action(action, *args)
+          Esse::Rails::Instrumentation::RuntimeRegistry.reset
+          super
+        end
+
+        def cleanup_view_runtime
+          if logger&.info?
+            search_rt_before_render = Esse::Rails::Instrumentation::RuntimeRegistry.reset
+            self.esse_runtime = (db_runtime || 0) + search_rt_before_render
+            runtime = super
+            search_rt_after_render = Esse::Rails::Instrumentation::RuntimeRegistry.reset
+            self.esse_runtime += search_rt_after_render
+            runtime - search_rt_after_render
+          else
+            super
+          end
+        end
+
+        def append_info_to_payload(payload)
+          super
+          payload[:esse_runtime] = (esse_runtime || 0) + Esse::Rails::Instrumentation::RuntimeRegistry.reset
+        end
+      end
+    end
+  end
+end

data/lib/esse/rails/instrumentation/runtime_registry.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Esse
+  module Rails
+    module Instrumentation
+      # A log subscriber to attach to Elastic/Open Search related events
+      #
+      # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/log_subscriber.rb
+      #
+      class RuntimeRegistry
+        def self.runtime=(value)
+          Thread.current["esse_runtime"] = value
+        end
+
+        def self.runtime
+          Thread.current["esse_runtime"] ||= 0
+        end
+
+        def self.reset
+          rt, self.runtime = runtime, 0
+          rt
+        end
+      end
+    end
+  end
+end
+
+Esse::Events.__bus__.events.keys.grep(/^elasticsearch/).each do |event_name|
+  Esse::Events.subscribe(event_name) do |event|
+    Esse::Rails::Instrumentation::RuntimeRegistry.runtime += event[:runtime].to_f
+  end
+end

data/lib/esse/rails/instrumentation.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "esse/rails/instrumentation/runtime_registry"
+require "esse/rails/instrumentation/controller_runtime"
+
+ActiveSupport.on_load(:action_controller) do
+  include Esse::Rails::Instrumentation::ControllerRuntime
+end

data/lib/esse/rails/lograge.rb

@@ -0,0 +1,23 @@
+module Esse
+  module Rails
+    module Lograge
+      # Require the component in your `application.rb` file and enable Lograge:
+      #
+      #     require 'esse/rails/lograge'
+      #
+      # You should see the full duration of the request to Elasticsearch as part of each log event:
+      #
+      #     method=GET path=/search ... status=200 duration=380.89 view=99.64 db=0.00 search=279.37
+      #
+      # @see https://github.com/roidrage/lograge
+      #
+      class Railtie < ::Rails::Railtie
+        initializer "esse.lograge" do |app|
+          config.lograge.custom_options = lambda do |event|
+            {search: event.payload[:esse_runtime].to_f.round(2)}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esse/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Esse
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/esse/rails.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "esse"
+require "rails"
+require "active_support"
+require "rails/railtie"
+
+require_relative "rails/instrumentation"
+require_relative "rails/version"
+require_relative "rails/cli/autoloader"
+
+module Esse
+  module Rails
+  end
+end

data/lib/esse-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "esse/rails"

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: esse-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+description: A Ruby on Rails integration for Esse gem
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/esse-rails.rb
+- lib/esse/rails.rb
+- lib/esse/rails/cli/autoloader.rb
+- lib/esse/rails/instrumentation.rb
+- lib/esse/rails/instrumentation/controller_runtime.rb
+- lib/esse/rails/instrumentation/runtime_registry.rb
+- lib/esse/rails/lograge.rb
+- lib/esse/rails/version.rb
+homepage: https://github.com/marcosgz/esse-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-rails
+  source_code_uri: https://github.com/marcosgz/esse-rails
+  changelog_uri: https://github.com/marcosgz/esse-rails/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+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: Esse on Rails
+test_files: []