Deprecate commit, rollback and close in ManagedTransaction

Author: bigmontz

packages/core/src/index.ts

@@ -70,6 +70,7 @@ import ConnectionProvider from './connection-provider'
 import Connection from './connection'
 import Transaction from './transaction'
 import TransactionPromise from './transaction-promise'
+import ManagedTransaction from './transaction-managed'
 import Session, { TransactionConfig } from './session'
 import Driver, * as driver from './driver'
 import auth from './auth'
@@ -136,6 +137,7 @@ const forExport = {
   Result,
   Transaction,
   TransactionPromise,
+  ManagedTransaction,
   Session,
   Driver,
   Connection,
@@ -194,6 +196,7 @@ export {
   Connection,
   Transaction,
   TransactionPromise,
+  ManagedTransaction,
   Session,
   Driver,
   types,

packages/core/src/session.ts

@@ -32,9 +32,10 @@ import { Query, SessionMode } from './types'
 import Connection from './connection'
 import { NumberOrInteger } from './graph-types'
 import TransactionPromise from './transaction-promise'
+import ManagedTransaction from './transaction-managed'
 
 type ConnectionConsumer = (connection: Connection | void) => any | undefined
-type TransactionWork<T> = (tx: Transaction) => Promise<T> | T
+type TransactionWork<T> = (tx: ManagedTransaction) => Promise<T> | T
 
 interface TransactionConfig {
   timeout?: NumberOrInteger
@@ -336,7 +337,7 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
+   * @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given
@@ -358,7 +359,7 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
+   * @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given

packages/core/src/transaction-promise.ts

@@ -170,6 +170,7 @@ class TransactionPromise extends Transaction implements Promise<Transaction>{
 
   /**
    * @access private
+   * @returns {void}
    */
   private _onBeginError(error: Error): void {
     this._beginError = error;
@@ -180,6 +181,7 @@ class TransactionPromise extends Transaction implements Promise<Transaction>{
 
   /**
    * @access private
+   * @returns {void}
    */
   private _onBeginMetadata(metadata: any): void {
     this._beginMetadata = metadata || {};

packages/core/test/transaction.test.ts

@@ -21,10 +21,12 @@ import { ConnectionProvider, newError, Transaction, TransactionPromise } from ".
 import { Bookmarks } from "../src/internal/bookmarks";
 import { ConnectionHolder } from "../src/internal/connection-holder";
 import { TxConfig } from "../src/internal/tx-config";
+import ManagedTransaction from "../src/transaction-managed";
 import FakeConnection from "./utils/connection.fake";
 
 
 testTx('Transaction', newRegularTransaction)
+testTx('ManagedTransaction', newManagedTransaction)
 
 testTx('TransactionPromise', newTransactionPromise, () => {
   describe('Promise', () => {
@@ -498,6 +500,39 @@ function newRegularTransaction({
   return transaction
 }
 
+function newManagedTransaction({
+  connection,
+  fetchSize = 1000,
+  highRecordWatermark = 700,
+  lowRecordWatermark = 300
+}: {
+  connection: FakeConnection
+  fetchSize?: number
+  highRecordWatermark?: number,
+  lowRecordWatermark?: number
+}): ManagedTransaction {
+  const connectionProvider = new ConnectionProvider()
+  connectionProvider.acquireConnection = () => Promise.resolve(connection)
+  connectionProvider.close = () => Promise.resolve()
+
+  const connectionHolder = new ConnectionHolder({ connectionProvider })
+  connectionHolder.initializeConnection()
+
+  const transaction = new ManagedTransaction({
+    connectionHolder,
+    onClose: () => { },
+    onBookmarks: (_: Bookmarks) => { },
+    onConnection: () => { },
+    reactive: false,
+    fetchSize,
+    impersonatedUser: "",
+    highRecordWatermark,
+    lowRecordWatermark
+  })
+
+  return transaction
+}
+
 function newFakeConnection(): FakeConnection {
   return new FakeConnection()
 }

packages/neo4j-driver-lite/src/index.ts

@@ -63,6 +63,7 @@ import {
   Session,
   Transaction,
   TransactionPromise,
+  ManagedTransaction,
   ServerInfo,
   Connection,
   driver as coreDriver,
@@ -427,6 +428,7 @@ const forExport = {
   Session,
   Transaction,
   TransactionPromise,
+  ManagedTransaction,
   Point,
   Duration,
   LocalTime,
@@ -476,6 +478,7 @@ export {
   Session,
   Transaction,
   TransactionPromise,
+  ManagedTransaction,
   Point,
   Duration,
   LocalTime,

packages/neo4j-driver/test/types/session.test.ts

@@ -27,6 +27,7 @@ import {
   Session,
   TransactionConfig
 } from 'neo4j-driver-core'
+import ManagedTransaction from 'neo4j-driver-core/types/transaction-managed'
 
 const dummy: any = null
 const intValue: Integer = Integer.fromInt(42)

packages/neo4j-driver/types/index.d.ts

@@ -57,6 +57,8 @@ import {
   ResultObserver,
   QueryResult,
   Transaction,
+  TransactionPromise,
+  ManagedTransaction,
   Session,
   ConnectionProvider
 } from 'neo4j-driver-core'
@@ -189,6 +191,8 @@ declare const forExport: {
   NotificationPosition: NotificationPosition
   Session: Session
   Transaction: Transaction
+  TransactionPromise: TransactionPromise
+  ManagedTransaction: ManagedTransaction
   Point: Point
   isPoint: typeof isPoint
   Duration: Duration
@@ -246,6 +250,8 @@ export {
   NotificationPosition,
   Session,
   Transaction,
+  TransactionPromise,
+  ManagedTransaction,
   Point,
   isPoint,
   Duration,