activerecord-transaction_subscriber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e25d9a11d8fad7fdba04fcd94e6513a13886f581543769d30e9c3b2fc7e61d6b
+  data.tar.gz: bd6c3674e9434f2ae33e2d92b049a368361b8215244848e6328f50be976f029f
+SHA512:
+  metadata.gz: af959006c45665488fd8963c572c8ecbe770515f432db0afea270cabf2f0eae20f2fcd1b07518d8460ef28981c8e7a7ab44899e594cf2462b39b2c96b697c732
+  data.tar.gz: e4ce7bdff8c8366d5210dc00fa319b122afbdc9886dfaf87cbda0ca9cea7175ec2ffd52d4ed87a38c9951c385783d0e0de3f14507f6bc22537ef4f3c89d291f7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ueda Satoshi
+
+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,35 @@
+# ActiveRecord::TransactionSubscriber
+
+Log the execution time of ActiveRecord transactions.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activerecord-transaction_subscriber
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activerecord-transaction_subscriber
+
+## Usage
+
+Write the following in `config/initializer/activerecord-transaction_subscriber.rb`
+
+```ruby
+ActiveRecord::TransactionSubscriber.attach_to :active_record
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gunyoki/activerecord-transaction_subscriber.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/activerecord/transaction_subscriber/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class TransactionSubscriber
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/transaction_subscriber.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "transaction_subscriber/version"
+
+module ActiveRecord
+  class TransactionSubscriber < ActiveRecord::LogSubscriber
+    thread_mattr_accessor :transactions
+
+    def sql(event)
+      payload = event.payload
+      return if payload[:cached]
+
+      sql = payload[:sql]
+
+      case payload[:name]
+      when 'TRANSACTION'
+        case sql
+        when 'BEGIN', 'SAVEPOINT'
+          my_transactions << { start_at: event.time }
+        when 'COMMIT', 'ROLLBACK'
+          tx = my_transactions.pop
+          if tx
+            logging(payload[:name], tx, event.end)
+          end
+        else
+          # Unknown transaction
+        end
+      when *IGNORE_PAYLOAD_NAMES
+        # no-op
+      else
+        tx = my_transactions.last
+        if tx
+          type = sql_type(sql)
+          if type
+            tx[type] ||= []
+            tx[type] << event.duration
+          end
+        end
+      end
+    end
+
+    def my_transactions
+      self.class.transactions ||= []
+    end
+
+    def logging(name, tx, end_at)
+      elapsed_time = ((end_at - tx[:start_at]) * 1000.0).round(1)
+      text = "  Transaction #{name} real time: #{elapsed_time}ms"
+      %i[lock select insert update delete].each do |type|
+        next unless tx[type]
+        count = tx[type].size
+        total = tx[type].sum.round(1)
+        text << ", #{type}: #{count} (#{total}ms)"
+      end
+      info color(text, :magenta, true)
+    end
+
+    def sql_type(sql)
+      case sql
+      when /select .*for update/mi, /\A\s*lock/mi
+        :lock
+      when /\A\s*select/i
+        :select
+      when /\A\s*insert/i
+        :insert
+      when /\A\s*update/i
+        :update
+      when /\A\s*delete/i
+        :delete
+      else
+        nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-transaction_subscriber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ueda Satoshi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: The number of queries executed in a transaction, the execution time,
+  and the wall-clock time of the transaction are logged at the end of the transaction.
+email:
+- gunyoki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord/.transaction_subscriber.rb.swp
+- lib/activerecord/transaction_subscriber.rb
+- lib/activerecord/transaction_subscriber/version.rb
+homepage: https://github.com/gunyoki/activerecord-transaction_subscriber
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gunyoki/activerecord-transaction_subscriber
+  source_code_uri: https://github.com/gunyoki/activerecord-transaction_subscriber
+  changelog_uri: https://github.com/gunyoki/activerecord-transaction_subscriber/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Log the execution time of ActiveRecord transactions.
+test_files: []