trx_ext 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 489053db9c987c891db8ef10bc7ce8d513c49193c99b543a5d9610dc80cfe18b
-  data.tar.gz: a964c8bbf189217897b61237ac6be0fb8c35ba669efae9b65a24f7a5323a7789
+  metadata.gz: d86c6295c4d141b3bcf938c95e8856cf390d5bd1a0454f81dfde3a135c35b9ff
+  data.tar.gz: d47c2e2425bf29d242824da94551acd8f44cb4489c811935ef5bd16169892544
 SHA512:
-  metadata.gz: b09b5eb4644c73a3717d27808b6d9fc7c570b9447a0cfb038952ed862ee240ff880d3650e9688482ea9084c28d429b86663a3e39f55950a179c9b870b33cec00
-  data.tar.gz: 74bcdd9e164756cfcdf97132a32d3c08d0cc19785261e4ae827a7f73732db504171494eb52bdea994848aaffa6b25675ba7a7395f76297ae9718e06f0b27cb24
+  metadata.gz: 1dd474ef6d21fe8443b14b7d3d12a3af00c030d14ff45924cf5130495cd12e5e37b8890d6af9303100e7acf269564fce405b9f00848661079c4e2627735ccfe7
+  data.tar.gz: 98ea0710b3c50b96741511c50ce627b06e8d8a7e8701c53935db1696c7aec2e61db9474bfa4239f11aa15e2243a7754a7de1590d3e2a157a885d8e6f9b4d1d93

data/.rspec

@@ -1,3 +1,3 @@
 --format Fivemat
---require spec_helper
+--require rails_helper
 --require fivemat

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.0

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 ## [Unreleased]
 
-Nothing new yet
+## [2.0.0] - 2024-04-14
 
-## [1.0.5] - 2022-01-27
+- `trx_ext` now supports any adapter(except `mysql`; `mysql2` is supported though), supported by rails
+- **Requirement is rails v7.1+ now**. This is because rails v7.1 introduced unification of connection adapters which allowed to implement the integration with all of them
+- Support multiple databases configurations
+
+## [1.0.6] - 2023-08-25
+
+- Refactoring the retry implementation
+
+## [1.0.5] - 2023-05-11
 
 - Load `Object` extension earlier
 

data/Gemfile

@@ -5,8 +5,29 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in trx_ext.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
 if ENV['AR_VERSION']
-  gem 'activerecord', ENV['AR_VERSION']
+  # Given ENV['AR_VERSION'] to equal "6.0" will produce
+  # ```ruby
+  # gem 'activerecord', "~> 6.0", "< 6.1"
+  # ```
+  gem 'rails', "~> #{ENV['AR_VERSION']}", "< #{ENV['AR_VERSION'].next}"
+else
+  gem 'rails'
 end
+
+gem "rake", "~> 13.0"
+gem 'rspec', '~> 3.12'
+gem 'timecop', '~> 0.9.8'
+# To support postgresql adapter
+gem 'pg', '~> 1.5', '>= 1.5.4'
+# To support sqlite3 adapter
+gem 'sqlite3', '~> 1.7', '>= 1.7.1'
+# To support mysql2 adapter
+gem 'mysql2', '~> 0.5.5'
+# To support trilogy adapter
+gem 'trilogy', '~> 2.8'
+gem 'factory_bot_rails', '~> 6.4', '>= 6.4.3'
+gem 'fivemat', '~> 1.3', '>= 1.3.7'
+gem 'rspec-its', '~> 1.3'
+gem "bootsnap", require: false
+gem 'rspec-rails',  '~> 6.0'

data/README.md

@@ -1,20 +1,22 @@
 # TrxExt
 
-Extends functionality of ActiveRecord's transaction to auto-retry failed SQL transaction in case of deadlock, serialization error or unique constraint error. It also allows you to define `on_complete` callback that is being executed after SQL transaction is finished(either COMMIT-ed or ROLLBACK-ed).
+Extends functionality of ActiveRecord's transaction to auto-retry failed SQL transaction in case of deadlock, serialization error or unique constraint error. It also allows you to define `on_complete` callback that is being executed after SQL transaction is finished(either COMMIT-ed or ROLLBACK-ed). The implementation is not bound to any database, but relies on the rails connection adapters instead. Thus, if your database is supported by rails out of the box, then the gem's features will just work. Currently supported adapters:
 
-Currently, the implementation only works for ActiveRecord PostgreSQL adapter. Feel free to improve it.
+- `postgresql`
+- `mysql2`
+- `sqlite3`
+- `trilogy`
 
 **WARNING!**
 
-Because the implementation of this gem is a patch for `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter` - carefully test its integration into your project. For example, if your project patches ActiveRecord or if some of your gems patches ActiveRecord - there might be conflicts in the implementation which could potentially lead to the data loss.
+Because the implementation of this gem patches ActiveRecord - carefully test its integration into your project. For example, if your application patches ActiveRecord or if some of your gems patches ActiveRecord - there might be conflicts in the implementation which could potentially lead to the data loss.
 
-Currently, the implementation is tested for `6.0.4.4`, `6.1.4.4` and `7.0.1` versions of ActiveRecord(see [TrxExt::SUPPORTED_AR_VERSIONS](lib/trx_ext/version.rb))
+Currently, the implementation is tested for rails v7.1+. **If you need the support of rails v6.0, v6.1, v7.0 - please use v1.x of this gem, but it works with PostgreSQL only.**
 
 ## Requirements
 
-- ActiveRecord 6+
+- ActiveRecord 7.1+
 - Ruby 3
-- PostgreSQL 9.1+
 
 ## Installation
 
@@ -36,7 +38,6 @@ Or install it yourself as:
 
 ```ruby
 require 'trx_ext'
-require 'active_record'
 
 # Object#trx is a shorthand of ActiveRecord::Base.transaction
 trx do
@@ -66,6 +67,27 @@ class DummyRecord
 end
 ```
 
+If you are using non-primary connection for your model - you have to explicitly call `trx` method over that class:
+
+```ruby
+DummyRecord.trx do
+  DummyRecord.first || DummyRecord.create
+end
+```
+In general, you should know about this if you are using multi-databases configuration.
+
+If you want to wrap some method into a transaction using `wrap_in_trx` outside the ActiveRecord model context, you can pass a model name as a second argument explicitly:
+
+```ruby
+class MyAwesomeLib
+  # Wrap method in transaction
+  def some_method_with_quieries
+    DummyRecord.first || DummyRecord.create    
+  end
+  wrap_in_trx :some_method_with_quieries, 'DummyRecord'
+end
+```
+
 ## Configuration
 
 ```ruby
@@ -77,15 +99,11 @@ end
 
 ## How it works?
 
-Your either every single AR SQL query or whole AR transaction is retried whenever it throws deadlock error, serialization error or unique constraint error. In case of AR transaction - the block of code that the AR transaction belongs to is re-executed, thus the transaction is retried.
+When an ActiveRecord SQL query fails due to deadlock error, serialization error or unique constraint error - it is automatically retried. In case of ActiveRecord transaction - the block of code the AR transaction belongs to is re-executed, thus the transaction query is retried.
 
 ## Rules you have to stick when using this gem
 
-> "Don't put more into a single transaction than needed for integrity purposes."
->
-> — [PostgreSQL documentation]
-
-Since `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter` is now patched with `TrxExt::Retry.with_retry_until_serialized`, there's no need to wrap every AR query in a `trx` block to ensure integrity. Wrap code in an explicit `trx` block if and only if it can or does produce two or more SQL queries *and* it is important to run those queries together atomically.
+**Don't put into a single transaction more than needed for integrity purposes.**
 
 There is "On complete" feature that allows you to define callbacks(blocks of code) that will be executed after transaction is complete. See `On complete callbacks` section bellow for the docs. See `On complete callbacks integrity` section bellow to be aware about different situations with them.
 
@@ -583,23 +601,20 @@ end
 
 ### Setup
 
-  - After checking out the repo, run `bin/setup` to install dependencies.
-  - Setup postgresql server with `serializable` transaction isolation level - you have to set `default_transaction_isolation` config option to `serializable` in your `postgresql.conf` file
-  - Create pg user and a database. This database will be used to run tests. When running console, this database will be used as a default database to connect to. Example:
-    ```shell
-    sudo -u postgres createuser postgres --superuser
-    sudo -u postgres psql --command="CREATE DATABASE trx_ext_db OWNER postgres"    
-    ```
-  - Setup db connection settings. Copy config sample and edit it to match your created pg user and database:
-    ```shell
-    cp spec/support/config/database.yml.sample spec/support/config/database.yml  
-    ```
+- After checking out the repo, run `bundle install` to install dependencies.
+- Run docker-compose using `docker-compose up` command - it starts necessary services
+- Run next command to create dev and test databases:
+
+```shell
+bundle exec rails db:create db:migrate
+RAILS_ENV=test bundle exec rails db:migrate
+```
     
 Now you can run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ### Tests
 
-You can run tests for currently installed AR using `rspec` command. There is `bin/test_all_ar_versions` executable that allows you to run tests within all supported AR versions(see [TrxExt::SUPPORTED_AR_VERSIONS](lib/trx_ext/version.rb)) as well.
+You can run tests for currently installed AR using `rspec` command. There is `bin/test_all_ar_versions` executable that allows you to run tests within all supported AR versions.
 
 ### Other
 
@@ -616,7 +631,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the TrxExt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/intale/trx_ext/blob/master/CODE_OF_CONDUCT.md).
-
-## TODO
-
-- integrate GitHub Actions

data/bin/console

@@ -13,17 +13,5 @@ require "trx_ext"
 # Pry.start
 
 require "irb"
-require "logger"
-require 'active_record'
-require_relative '../spec/support/config'
-require_relative '../spec/support/dummy_record'
-
-ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
-TrxExt.logger = ActiveSupport::Logger.new(STDOUT)
-
-if Config.db_config
-  ActiveRecord::Base.establish_connection(Config.db_config)
-  DummyRecord.setup
-end
 
 IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+Dir.chdir(File.expand_path("../dummy_app", __dir__))
+ENV['BUNDLE_GEMFILE'] = "#{__dir__}/Gemfile"
+
+APP_PATH = File.expand_path("../dummy_app/config/application", __dir__)
+require_relative "../dummy_app/config/boot"
+
+require "rails/commands"

data/bin/test_all_ar_versions

@@ -2,9 +2,7 @@
 
 # frozen_string_literal: true
 
-require_relative '../lib/trx_ext/version'
-
-TrxExt::SUPPORTED_AR_VERSIONS.each do |ar_version|
+%w[7.1].each do |ar_version|
   `rm Gemfile.lock`
   Process.waitpid(Kernel.spawn({ 'AR_VERSION' => ar_version }, "bundle install --quiet", close_others: true))
   Process.waitpid(Kernel.spawn({ 'AR_VERSION' => ar_version }, "rspec", close_others: true))

data/docker/my.cnf

@@ -0,0 +1,13 @@
+[mysqld]
+# Log General
+general_log = 1
+general_log_file = /var/log/mysql_general.log
+
+# Log Error
+log_error = /var/log/mysql_error.log
+
+# Log Slow
+slow_query_log = 1
+slow_query_log_file = /var/log/mysql_slow_query.log
+long_query_time = 0  # 0 has the effect of logging all queries
+log_queries_not_using_indexes = 1

data/docker/mysqld.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+##
+# This script exists to work-around the fact that
+# mysql does not support logging to stdout
+#
+# This will tail the file logs configured in ./my.cnf
+##
+
+LOG_PATHS=(
+  '/var/log/mysql_general.log'
+  '/var/log/mysql_error.log'
+  '/var/log/mysql_slow_query.log'
+)
+for LOG_PATH in "${LOG_PATHS[@]}"; do
+  # https://serverfault.com/a/599209
+  ( umask 0 && truncate -s0 "$LOG_PATH" )
+  tail --pid $$ -n0 -F "$LOG_PATH" &
+done
+
+docker-entrypoint.sh mysqld

data/docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3.5"
+
+services:
+  postgres:
+    image: postgres:16
+    command: ["postgres", "-c", "log_statement=all", "-c", "default_transaction_isolation=serializable"]
+    ports:
+      - 5532:5432
+    environment:
+      - POSTGRES_PASSWORD=postgres
+  mysql:
+    image: mysql:8.3
+    command:
+      - /usr/local/bin/mysqld.sh
+    volumes:
+      - ./docker/my.cnf:/etc/mysql/conf.d/my.cnf
+      - ./docker/mysqld.sh:/usr/local/bin/mysqld.sh
+    ports:
+      - 3406:3306
+      - 34060:33060
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=true

data/dummy_app/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/dummy_app/.gitignore

@@ -0,0 +1,38 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+Gemfile.lock
+db/schema.rb
+db/primary_sqlite_schema.rb
+db/primary_mysql_schema.rb
+db/primary_trilogy_schema.rb

data/dummy_app/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/dummy_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/dummy_app/app/models/application_mysql_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationMysqlRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connects_to database: { writing: :primary_mysql, reading: :primary_mysql }
+end

data/dummy_app/app/models/application_pg_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationPgRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connects_to database: { writing: :primary_pg, reading: :primary_pg }
+end

data/dummy_app/app/models/application_sqlite_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationSqliteRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connects_to database: { writing: :primary_sqlite, reading: :primary_sqlite }
+end

data/dummy_app/app/models/application_trilogy_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationTrilogyRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connects_to database: { writing: :primary_trilogy, reading: :primary_trilogy }
+end

data/dummy_app/app/models/dummy_mysql_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Dummy record. It is used to test transaction integration.
+class DummyMysqlRecord < ApplicationMysqlRecord
+  class << self
+    def find_or_create_by(attributes, &block)
+      find_by(attributes) || create(attributes, &block)
+    end
+    wrap_in_trx :find_or_create_by
+  end
+end

data/dummy_app/app/models/dummy_pg_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Dummy record. It is used to test transaction integration.
+class DummyPgRecord < ApplicationPgRecord
+  class << self
+    def find_or_create_by(attributes, &block)
+      find_by(attributes) || create(attributes, &block)
+    end
+    wrap_in_trx :find_or_create_by
+  end
+end

data/dummy_app/app/models/dummy_sqlite_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Dummy record. It is used to test transaction integration.
+class DummySqliteRecord < ApplicationSqliteRecord
+  class << self
+    def find_or_create_by(attributes, &block)
+      find_by(attributes) || create(attributes, &block)
+    end
+    wrap_in_trx :find_or_create_by
+  end
+end

data/dummy_app/app/models/dummy_trilogy_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Dummy record. It is used to test transaction integration.
+class DummyTrilogyRecord < ApplicationTrilogyRecord
+  class << self
+    def find_or_create_by(attributes, &block)
+      find_by(attributes) || create(attributes, &block)
+    end
+    wrap_in_trx :find_or_create_by
+  end
+end

data/dummy_app/bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/dummy_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/dummy_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/dummy_app/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end