Session execute_read/write implementation (#251)

* Session execute_read/write implementation

* Added deprecation warning

* Session specs refactoring

* Used ActiveSupport for deprecation warning

* Session specs refactoring

* Replaced read/write_transaction with execute_read/write in specs

* Moved deprecation warning implementation to /lib

* Silence deprecation warning in specs, execute_write/read refactoring

* Added DelegatingTransactionContext for execute_read/write

* Implementation of execute_write/read for MRI

---------

Co-authored-by: Heinrich Klobuczek <[email protected]>

Author: JuliaKovtun

jruby/neo4j/driver.rb

@@ -51,6 +51,7 @@ module Types
 Java::OrgNeo4jDriverInternal::InternalResult.prepend Neo4j::Driver::Ext::InternalResult
 Java::OrgNeo4jDriverInternal::InternalSession.prepend Neo4j::Driver::Ext::InternalSession
 Java::OrgNeo4jDriverInternal::InternalTransaction.prepend Neo4j::Driver::Ext::InternalTransaction
+Java::OrgNeo4jDriverInternal::DelegatingTransactionContext.prepend Neo4j::Driver::Ext::DelegatingTransactionContext
 Java::OrgNeo4jDriverInternalAsync::InternalAsyncSession.prepend Neo4j::Driver::Ext::Internal::Async::InternalAsyncSession
 Java::OrgNeo4jDriverInternalShadedBoltConnectionRoutedImplCluster::RoutingTableRegistryImpl.include Neo4j::Driver::Ext::Internal::Cluster::RoutingTableRegistryImpl
 # Java::OrgNeo4jDriverInternalCursor::DisposableAsyncResultCursor.prepend Neo4j::Driver::Ext::Internal::Cursor::DisposableAsyncResultCursor

jruby/neo4j/driver/ext/delegating_transaction_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Neo4j
+  module Driver
+    module Ext
+      module DelegatingTransactionContext
+        include ExceptionCheckable
+        include RunOverride
+
+        def run(statement, **parameters)
+          check { super(to_statement(statement, parameters)) }
+        end
+      end
+    end
+  end
+end

jruby/neo4j/driver/ext/internal_session.rb

@@ -14,10 +14,14 @@ module InternalSession
         # work around jruby issue https://github.com/jruby/jruby/issues/5603
         Struct.new('Wrapper', :object)
 
-        %i[read write].each do |prefix|
-          define_method("#{prefix}_transaction") do |**config, &block|
-            check do
-              super(->(tx) { Struct::Wrapper.new(reverse_check { block.call(tx) }) }, to_java_config(Neo4j::Driver::TransactionConfig, **config)).object
+        # implementation of read_transaction, write_transaction, execute_read, execute_write
+        %i[read write].each do |mode|
+          ["#{mode}_transaction", "execute_#{mode}"].each do |method_name|
+            define_method(method_name) do |**config, &block|
+              Driver::Internal::Deprecator.log_warning(method_name, "execute_#{mode}".to_sym, '6.0') if method_name.include? 'transaction'
+              check do
+                super(->(tx) { Struct::Wrapper.new(reverse_check { block.call(tx) }) }, to_java_config(Neo4j::Driver::TransactionConfig, **config)).object
+              end
             end
           end
         end

lib/neo4j/driver/internal/deprecator.rb

@@ -0,0 +1,15 @@
+module Neo4j
+  module Driver
+    module Internal
+      module Deprecator
+        def self.deprecator
+          @deprecator ||= ActiveSupport::Deprecation.new('6.0', 'neo4j-ruby-driver')
+        end
+
+        def self.log_warning(old_method, new_method, version)
+          deprecator.deprecation_warning(old_method, new_method)
+        end
+      end
+    end
+  end
+end

ruby/neo4j/driver/internal/internal_session.rb

@@ -38,10 +38,20 @@ def begin_transaction(**config)
       end
 
       def read_transaction(**config, &block)
+        Deprecator.log_warning(:read_transaction, :execute_read, '6.0')
         transaction(AccessMode::READ, **config, &block)
       end
 
       def write_transaction(**config, &block)
+        Deprecator.log_warning(:write_transaction, :execute_write, '6.0')
+        transaction(AccessMode::WRITE, **config, &block)
+      end
+
+      def execute_read(**config, &block)
+        transaction(AccessMode::READ, **config, &block)
+      end
+
+      def execute_write(**config, &block)
         transaction(AccessMode::WRITE, **config, &block)
       end
 

spec/integration/bookmark_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe 'Bookmark' do
   def create_node_in_tx(session)
-    session.write_transaction { |tx| tx.run('CREATE (a:Person)') }
+    session.execute_write { |tx| tx.run('CREATE (a:Person)') }
   end
 
   def preamble(session)
@@ -93,7 +93,7 @@ def expect_single_value(bookmark, value)
   it 'fails on invalid bookmark using tx func' do
     bookmark = Neo4j::Driver::Bookmark.from('hi, this is an invalid bookmark')
     driver.session(bookmarks: bookmark) do |session|
-      expect { session.read_transaction { |tx| tx.run('RETURN 1').single } }
+      expect { session.execute_read { |tx| tx.run('RETURN 1').single } }
         .to raise_error Neo4j::Driver::Exceptions::ClientException do |e|
         expect(e.code).to eq 'Neo.ClientError.Transaction.InvalidBookmark'
       end

spec/integration/causal_clustering_spec.rb

@@ -163,7 +163,7 @@ def new_session(mode)
     create_driver(leader.routing_uri, routing_table_purge_delay: 3.minutes) do |driver|
       database = 'neo4j'
       driver.session(database: database) do |session|
-        session.read_transaction { |tx| tx.run('RETURN 1').consume }
+        session.execute_read { |tx| tx.run('RETURN 1').consume }
       end
       expect(driver.session_factory.connection_provider.routing_table_registry
                    .routing_table_handler(database).routing_table.routers.to_a.size).to eq 3
@@ -181,7 +181,7 @@ def new_session(mode)
         leader.bolt_address,
       ] }) do |driver|
       driver.session do |session|
-        expect(session.read_transaction { |tx| tx.run('RETURN 1').single.first }).to eq 1
+        expect(session.execute_read { |tx| tx.run('RETURN 1').single.first }).to eq 1
       end
     end
   end