Add MysqlAdapter transactions support (#58)

Author: joaopgmaria

.circleci/config.yml

@@ -41,6 +41,11 @@ jobs:
           POSTGRES_USER: "circleci"
           POSTGRES_DB: "safer_rails_console_test"
           POSTGRES_HOST_AUTH_METHOD: "trust"
+      - image: cimg/mysql:8.0
+        environment:
+          MYSQL_DATABASE: "safer_rails_console_test"
+          MYSQL_ROOT_HOST: "%"
+          MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
     working_directory: ~/safer_rails_console
     steps:
       - checkout
@@ -60,6 +65,9 @@ jobs:
           paths:
             - "vendor/bundle"
             - "gemfiles/vendor/bundle"
+      - run:
+          name: Wait for Mysql
+          command: dockerize -wait tcp://localhost:3306 -timeout 1m
       - run:
           name: Run Tests
           command: |

.gitignore

@@ -15,3 +15,5 @@
 /gemfiles/*.gemfile.lock
 out
 *.sqlite3
+
+.idea

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v0.9.0
+- Add MySql support
+
 ## v0.8.0
 - Drop support for Ruby 2.7.
 - Drop support for Rails 6.0.

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://circleci.com/gh/salsify/safer_rails_console.svg?style=svg)](https://circleci.com/gh/salsify/safer_rails_console)
 [![Gem Version](https://badge.fury.io/rb/safer_rails_console.svg)](https://badge.fury.io/rb/safer_rails_console)
 
-This gem makes Rails console sessions less dangerous in specified environments by warning, color-coding, and auto-sandboxing PostgreSQL connections. In the future we'd like to extend this to make other external connections read-only too (e.g. disable job queueing, non-GET HTTP requests, etc.)
+This gem makes Rails console sessions less dangerous in specified environments by warning, color-coding, and auto-sandboxing PostgreSQL and MySQL connections. In the future we'd like to extend this to make other external connections read-only too (e.g. disable job queueing, non-GET HTTP requests, etc.)
 
 ## Installation
 

lib/safer_rails_console/patches/sandbox/auto_rollback.rb

@@ -11,8 +11,8 @@ def self.rollback_and_begin_new_transaction
           connection.begin_db_transaction
         end
 
-        def self.handle_and_reraise_exception(error)
-          if error.message.include?('PG::ReadOnlySqlTransaction')
+        def self.handle_and_reraise_exception(error, message = 'PG::ReadOnlySqlTransaction')
+          if error.message.include?(message)
             puts SaferRailsConsole::Colors.color_text( # rubocop:disable Rails/Output
               'An operation could not be completed due to read-only mode.',
               SaferRailsConsole::Colors::RED
@@ -28,13 +28,27 @@ module PostgreSQLAdapterPatch
           def execute_and_clear(...)
             super
           rescue StandardError => e
-            SaferRailsConsole::Patches::Sandbox::AutoRollback.handle_and_reraise_exception(e)
+            # rubocop:disable Layout/LineLength
+            SaferRailsConsole::Patches::Sandbox::AutoRollback.handle_and_reraise_exception(e, 'PG::ReadOnlySqlTransaction')
+            # rubocop:enable Layout/LineLength
           end
         end
 
         if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
           ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(PostgreSQLAdapterPatch)
         end
+
+        module MySQLPatch
+          def execute_and_free(...)
+            super
+          rescue StandardError => e
+            SaferRailsConsole::Patches::Sandbox::AutoRollback.handle_and_reraise_exception(e, 'READ ONLY transaction')
+          end
+        end
+
+        if defined?(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter)
+          ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.prepend(MySQLPatch)
+        end
       end
     end
   end

lib/safer_rails_console/patches/sandbox/transaction_read_only.rb

@@ -11,13 +11,27 @@ def begin_db_transaction
           end
         end
 
+        module MySQLPatch
+          def begin_db_transaction
+            execute 'SET TRANSACTION READ ONLY'
+            super
+          end
+        end
+
         if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
           ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(PostgreSQLAdapterPatch)
 
           # Ensure transaction is read-only if it was began before this patch was loaded
           connection = ::ActiveRecord::Base.connection
           connection.execute 'SET TRANSACTION READ ONLY' if connection.open_transactions > 0
         end
+
+        if defined?(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter)
+          ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.prepend(MySQLPatch)
+
+          # Not possible to change a running transaction to read-only in MySQL
+          # https://dev.mysql.com/doc/refman/8.4/en/set-transaction.html
+        end
       end
     end
   end

lib/safer_rails_console/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SaferRailsConsole
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

safer_rails_console.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'climate_control', '~> 0.2.0'
   spec.add_development_dependency 'mixlib-shellout', '~> 2.2'
+  spec.add_development_dependency 'mysql2', '~> 0.5'
   spec.add_development_dependency 'overcommit', '~> 0.39.0'
   spec.add_development_dependency 'pg', '~> 1.1'
   spec.add_development_dependency 'rake', '~> 12.0'

spec/contexts/db_sandbox.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+shared_context "db sandbox context" do
+  let(:adapter) {}
+
+  shared_examples_for "auto_rollback" do
+    it "automatically executes rollback and begins a new transaction after executing a invalid SQL statement" do
+      run_console_commands('Model.create!', 'Model.where(invalid: :statement)', 'Model.create!')
+
+      # Run a new console session to ensure the database changes were not saved
+      result = run_console_commands("puts \"Model Count = \#{Model.count}\"")
+      expect(result.stdout).to include('Model Count = 0')
+    end
+  end
+
+  shared_examples_for "read_only" do
+    it "enforces a read_only transaction" do
+      # Run a console session that makes some database changes
+      run_console_commands('Model.create!', 'Model.create!')
+
+      # Run a new console session to ensure the database changes were not saved
+      result = run_console_commands("puts \"Model Count = \#{Model.count}\"")
+      expect(result.stdout).to include('Model Count = 0')
+    end
+
+    it "lets the user know that an operation could not be completed" do
+      result = run_console_commands('Model.create!')
+      expect(result.stdout).to include('An operation could not be completed due to read-only mode.')
+    end
+  end
+
+  def run_console_commands(*commands)
+    commands += ['exit']
+    environment = "development#{adapter.nil? ? '' : "-#{adapter}"}"
+    run_console('--sandbox', input: commands.join("\n"), rails_env: environment)
+  end
+end

spec/integration/patches/sandbox_spec.rb

@@ -1,34 +1,19 @@
 # frozen_string_literal: true
 
+require_relative '../../contexts/db_sandbox'
+
 describe "Integration: patches/sandbox" do
-  context "auto_rollback" do
-    it "automatically executes rollback and begins a new transaction after executing a invalid SQL statement" do
-      run_console_commands('Model.create!', 'Model.where(invalid: :statement)', 'Model.create!')
+  include_context "db sandbox context"
 
-      # Run a new console session to ensure the database changes were not saved
-      result = run_console_commands('puts "Model Count = #{Model.count}"') # rubocop:disable Lint/InterpolationCheck
-      expect(result.stdout).to include('Model Count = 0')
-    end
+  context "for PostgreSQL" do
+    it_behaves_like "auto_rollback"
+    it_behaves_like "read_only"
   end
 
-  context "read_only" do
-    it "enforces a read_only transaction" do
-      # Run a console session that makes some database changes
-      run_console_commands('Model.create!', 'Model.create!')
-
-      # Run a new console session to ensure the database changes were not saved
-      result = run_console_commands('puts "Model Count = #{Model.count}"') # rubocop:disable Lint/InterpolationCheck
-      expect(result.stdout).to include('Model Count = 0')
-    end
-
-    it "lets the user know that an operation could not be completed" do
-      result = run_console_commands('Model.create!')
-      expect(result.stdout).to include('An operation could not be completed due to read-only mode.')
-    end
-  end
+  context "for Mysql" do
+    let(:adapter) { :mysql2 }
 
-  def run_console_commands(*commands)
-    commands += ['exit']
-    run_console('--sandbox', input: commands.join("\n"))
+    it_behaves_like "auto_rollback"
+    it_behaves_like "read_only"
   end
 end