Merge pull request #462 from aerospike/stage

v8.0.0

Author: khaf

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change History
 
+## January 22 2025: v8.0.0
+
+- **New Features**
+  - [CLIENT-3257] Implement iterator support for `Recordset`.
+
+- **Fixes**
+  - [CLIENT-3275] Return an error when Transaction commit called, but transaction was already aborted.
+  - [CLIENT-3295] Duplicate parsing of fields in RecordParser.ParseRecord.
+  - [CLIENT-3261] New `OnLockingOnly` attribute for various write policies to write only if provisional does not exist.
+  - [CLIENT-3227] Clarify that `BasePolicy.UseCompression` requires Enterprise Edition.
+  - [CLIENT-3260] Add `MRT_ALREADY_LOCKED` and `MRT_MONITOR_EXISTS` error codes.
+  - [CLIENT-3292][CLIENT-3293] Update dependencies due to Snyk CVE reports.
+  - [CLIENT-3274] Fix Transaction related client exception inconsistency between clients.
+  - [CLIENT-3207] Do not close/delete Transaction monitor record on abort/commit when a write command in that Transaction fails and is `inDoubt`.
+  - [CLIENT-3283] Remove the txn instance from the copied write policy when adding Transaction monitor keys.
+  - [CLIENT-3270] Normalize API reference language with server 8.0 site docs.
+  - [CLIENT-3258] Transaction commit returns 'Failed to commit one or more record versions' error.
+
 ## December 20 2024: v8.0.0-beta.2
 
 - **New Features**

abort_status.go

@@ -14,13 +14,13 @@
 
 package aerospike
 
-// Multi-record transaction (MRT) abort status code.
+// Transaction abort status code.
 type AbortStatus string
 
 const (
 	AbortStatusOK                AbortStatus = "Abort succeeded"
 	AbortStatusAlreadyCommitted  AbortStatus = "Already committed"
 	AbortStatusAlreadyAborted    AbortStatus = "Already aborted"
-	AbortStatusRollBackAbandoned AbortStatus = "MRT client roll back abandoned. Server will eventually abort the MRT."
-	AbortStatusCloseAbandoned    AbortStatus = "MRT has been rolled back, but MRT client close was abandoned. Server will eventually close the MRT."
+	AbortStatusRollBackAbandoned AbortStatus = "Transaction client roll back abandoned. Server will eventually abort the Transaction."
+	AbortStatusCloseAbandoned    AbortStatus = "Transaction has been rolled back, but Transaction client close was abandoned. Server will eventually close the Transaction."
 )

batch_attr.go

@@ -115,6 +115,7 @@ func (ba *batchAttr) setRead(rp *BatchPolicy) {
 	case ReadModeSCAllowUnavailable:
 		ba.infoAttr = _INFO3_SC_READ_TYPE | _INFO3_SC_READ_RELAX
 	}
+	ba.txnAttr = 0
 	ba.expiration = uint32(rp.ReadTouchTTLPercent)
 	ba.generation = 0
 	ba.hasWrite = false
@@ -142,6 +143,7 @@ func (ba *batchAttr) setBatchRead(rp *BatchReadPolicy) {
 	case ReadModeSCAllowUnavailable:
 		ba.infoAttr = _INFO3_SC_READ_TYPE | _INFO3_SC_READ_RELAX
 	}
+	ba.txnAttr = 0
 	ba.expiration = uint32(rp.ReadTouchTTLPercent)
 	ba.generation = 0
 	ba.hasWrite = false
@@ -174,6 +176,7 @@ func (ba *batchAttr) setBatchWrite(wp *BatchWritePolicy) {
 	ba.readAttr = 0
 	ba.writeAttr = _INFO2_WRITE | _INFO2_RESPOND_ALL_OPS
 	ba.infoAttr = 0
+	ba.txnAttr = 0
 	ba.expiration = wp.Expiration
 	ba.hasWrite = true
 	ba.sendKey = wp.SendKey
@@ -209,6 +212,10 @@ func (ba *batchAttr) setBatchWrite(wp *BatchWritePolicy) {
 		ba.writeAttr |= _INFO2_DURABLE_DELETE
 	}
 
+	if wp.OnLockingOnly {
+		ba.txnAttr |= _INFO4_MRT_ON_LOCKING_ONLY
+	}
+
 	if wp.CommitLevel == COMMIT_MASTER {
 		ba.infoAttr |= _INFO3_COMMIT_MASTER
 	}
@@ -251,6 +258,7 @@ func (ba *batchAttr) setBatchUDF(up *BatchUDFPolicy) {
 	ba.readAttr = 0
 	ba.writeAttr = _INFO2_WRITE
 	ba.infoAttr = 0
+	ba.txnAttr = 0
 	ba.expiration = up.Expiration
 	ba.generation = 0
 	ba.hasWrite = true
@@ -260,6 +268,10 @@ func (ba *batchAttr) setBatchUDF(up *BatchUDFPolicy) {
 		ba.writeAttr |= _INFO2_DURABLE_DELETE
 	}
 
+	if up.OnLockingOnly {
+		ba.txnAttr |= _INFO4_MRT_ON_LOCKING_ONLY
+	}
+
 	if up.CommitLevel == COMMIT_MASTER {
 		ba.infoAttr |= _INFO3_COMMIT_MASTER
 	}
@@ -270,6 +282,7 @@ func (ba *batchAttr) setBatchDelete(dp *BatchDeletePolicy) {
 	ba.readAttr = 0
 	ba.writeAttr = _INFO2_WRITE | _INFO2_RESPOND_ALL_OPS | _INFO2_DELETE
 	ba.infoAttr = 0
+	ba.txnAttr = 0
 	ba.expiration = 0
 	ba.hasWrite = true
 	ba.sendKey = dp.SendKey

batch_command.go

@@ -90,7 +90,7 @@ func (cmd *batchCommand) retryBatch(ifc batcher, cluster *Cluster, deadline time
 
 	cmd.splitRetry = true
 
-	// Run batch requests sequentially in same thread.
+	// Run batch requests sequentially in same goroutine.
 	var ferr Error
 	for _, batchNode := range batchNodes {
 		command := ifc.cloneBatchCommand(batchNode)

batch_udf_policy.go

@@ -43,6 +43,16 @@ type BatchUDFPolicy struct {
 	// Valid for Aerospike Server Enterprise Edition 3.10+ only.
 	DurableDelete bool
 
+	// Execute the write command only if the record is not already locked by this transaction.
+	// If this field is true and the record is already locked by this transaction, the command
+	// will return an error with the [types.MRT_ALREADY_LOCKED] error code.
+	//
+	// This field is useful for safely retrying non-idempotent writes as an alternative to simply
+	// aborting the transaction.
+	//
+	// Default: false
+	OnLockingOnly bool
+
 	// SendKey determines to whether send user defined key in addition to hash digest on both reads and writes.
 	// If true and the UDF writes a record, the key will be stored with the record on the server.
 	// The default is to not send the user defined key.

batch_write_policy.go

@@ -67,6 +67,16 @@ type BatchWritePolicy struct {
 	// Valid for Aerospike Server Enterprise Edition 3.10+ only.
 	DurableDelete bool
 
+	// Execute the write command only if the record is not already locked by this transaction.
+	// If this field is true and the record is already locked by this transaction, the command
+	// will return an error with the [types.MRT_ALREADY_LOCKED] error code.
+	//
+	// This field is useful for safely retrying non-idempotent writes as an alternative to simply
+	// aborting the transaction.
+	//
+	// Default: false
+	OnLockingOnly bool
+
 	// SendKey determines to whether send user defined key in addition to hash digest on both reads and writes.
 	// If the key is sent on a write, the key will be stored with the record on
 	// the server.

client.go

@@ -61,9 +61,9 @@ type Client struct {
 	DefaultAdminPolicy *AdminPolicy
 	// DefaultInfoPolicy is used for all info commands without a specific policy.
 	DefaultInfoPolicy *InfoPolicy
-	// Default multi-record transaction (MRT) policy when verifying record versions in a batch on a commit.
+	// Default transaction policy when verifying record versions in a batch on a commit.
 	DefaultTxnVerifyPolicy *TxnVerifyPolicy
-	// Default multi-record transaction (MRT) policy when rolling the transaction records forward (commit)
+	// Default transaction policy when rolling the transaction records forward (commit)
 	// or back (abort) in a batch.
 	DefaultTxnRollPolicy *TxnRollPolicy
 }
@@ -1474,7 +1474,7 @@ func (clnt *Client) Commit(txn *Txn) (CommitStatus, Error) {
 	case TxnStateCommitted:
 		return CommitStatusAlreadyCommitted, nil
 	case TxnStateAborted:
-		return CommitStatusAlreadyAborted, nil
+		return CommitStatusAlreadyAborted, newError(types.TXN_ALREADY_ABORTED, "Transaction already aborted")
 	}
 }
 
@@ -1491,7 +1491,7 @@ func (clnt *Client) Abort(txn *Txn) (AbortStatus, Error) {
 	case TxnStateVerified:
 		return tr.Abort(&clnt.GetDefaultTxnRollPolicy().BatchPolicy)
 	case TxnStateCommitted:
-		return AbortStatusAlreadyCommitted, nil
+		return AbortStatusAlreadyCommitted, newError(types.TXN_ALREADY_COMMITTED, "Transaction already committed")
 	case TxnStateAborted:
 		return AbortStatusAlreadyAborted, nil
 	}

command.go

@@ -86,12 +86,14 @@ const (
 	// See Below
 	_INFO3_SC_READ_RELAX int = (1 << 7)
 
-	// Send MRT version to the server to be verified.
+	// Send Transaction version to the server to be verified.
 	_INFO4_MRT_VERIFY_READ = (1 << 0)
-	// Roll forward MRT.
+	// Roll forward Transaction.
 	_INFO4_MRT_ROLL_FORWARD = (1 << 1)
-	// Roll back MRT.
+	// Roll back Transaction.
 	_INFO4_MRT_ROLL_BACK = (1 << 2)
+	// Must be able to lock record in transaction.
+	_INFO4_MRT_ON_LOCKING_ONLY = (1 << 4)
 
 	// Interpret SC_READ bits in info3.
 	//
@@ -626,7 +628,7 @@ func (cmd *baseCommand) sizeTxn(key *Key, txn *Txn, hasWrite bool) int {
 
 func (cmd *baseCommand) sizeTxnBatch(txn *Txn, ver *uint64, hasWrite bool) {
 	if txn != nil {
-		cmd.dataOffset++ // Add info4 byte for MRT.
+		cmd.dataOffset++ // Add info4 byte for Transaction.
 		cmd.dataOffset += int(8 + _FIELD_HEADER_SIZE)
 
 		if ver != nil {
@@ -2892,6 +2894,7 @@ func (cmd *baseCommand) writeHeaderWrite(policy *WritePolicy, writeAttr, fieldCo
 	generation := uint32(0)
 	readAttr := 0
 	infoAttr := 0
+	txnAttr := 0
 
 	switch policy.RecordExistsAction {
 	case UPDATE:
@@ -2923,6 +2926,10 @@ func (cmd *baseCommand) writeHeaderWrite(policy *WritePolicy, writeAttr, fieldCo
 		writeAttr |= _INFO2_DURABLE_DELETE
 	}
 
+	if policy.OnLockingOnly {
+		txnAttr |= _INFO4_MRT_ON_LOCKING_ONLY
+	}
+
 	// if (policy.Xdr) {
 	// 	readAttr |= _INFO1_XDR;
 	// }
@@ -2932,7 +2939,7 @@ func (cmd *baseCommand) writeHeaderWrite(policy *WritePolicy, writeAttr, fieldCo
 	cmd.dataBuffer[9] = byte(readAttr)
 	cmd.dataBuffer[10] = byte(writeAttr)
 	cmd.dataBuffer[11] = byte(infoAttr)
-	cmd.dataBuffer[12] = 0 // unused
+	cmd.dataBuffer[12] = byte(txnAttr)
 	cmd.dataBuffer[13] = 0 // clear the result code
 	cmd.dataOffset = 14
 	cmd.WriteUint32(generation)
@@ -2954,6 +2961,7 @@ func (cmd *baseCommand) writeHeaderReadWrite(policy *WritePolicy, args *operateA
 	readAttr := args.readAttr
 	writeAttr := args.writeAttr
 	infoAttr := 0
+	txnAttr := 0
 	operationCount := len(args.operations)
 
 	switch policy.RecordExistsAction {
@@ -2986,6 +2994,10 @@ func (cmd *baseCommand) writeHeaderReadWrite(policy *WritePolicy, args *operateA
 		writeAttr |= _INFO2_DURABLE_DELETE
 	}
 
+	if policy.OnLockingOnly {
+		txnAttr |= _INFO4_MRT_ON_LOCKING_ONLY
+	}
+
 	// if (policy.xdr) {
 	// 	readAttr |= _INFO1_XDR;
 	// }
@@ -3013,7 +3025,7 @@ func (cmd *baseCommand) writeHeaderReadWrite(policy *WritePolicy, args *operateA
 	cmd.dataBuffer[9] = byte(readAttr)
 	cmd.dataBuffer[10] = byte(writeAttr)
 	cmd.dataBuffer[11] = byte(infoAttr)
-	cmd.dataBuffer[12] = 0 // unused
+	cmd.dataBuffer[12] = byte(txnAttr)
 	cmd.dataBuffer[13] = 0 // clear the result code
 	cmd.dataOffset = 14
 	cmd.WriteUint32(generation)
@@ -3113,7 +3125,7 @@ func (cmd *baseCommand) writeKeyAttr(
 	cmd.WriteByte(byte(attr.readAttr))
 	cmd.WriteByte(byte(attr.writeAttr))
 	cmd.WriteByte(byte(attr.infoAttr))
-	cmd.WriteByte(0) // unused
+	cmd.WriteByte(byte(attr.txnAttr))
 	cmd.WriteByte(0) // clear the result code
 	cmd.WriteUint32(attr.generation)
 	cmd.WriteUint32(attr.expiration)

commit_error.go

@@ -14,12 +14,12 @@
 
 package aerospike
 
-// Multi-record transaction (MRT) error status.
+// Transaction error status.
 type CommitError string
 
 const (
-	CommitErrorVerifyFail               CommitError = "MRT verify failed. MRT aborted."
-	CommitErrorVerifyFailCloseAbandoned CommitError = "MRT verify failed. MRT aborted. MRT client close abandoned. Server will eventually close the MRT."
-	CommitErrorVerifyFailAbortAbandoned CommitError = "MRT verify failed. MRT client abort abandoned. Server will eventually abort the MRT."
-	CommitErrorMarkRollForwardAbandoned CommitError = "MRT client mark roll forward abandoned. Server will eventually abort the MRT."
+	CommitErrorVerifyFail               CommitError = "Transaction verify failed. Transaction aborted."
+	CommitErrorVerifyFailCloseAbandoned CommitError = "Transaction verify failed. Transaction aborted. Transaction client close abandoned. Server will eventually close the Transaction."
+	CommitErrorVerifyFailAbortAbandoned CommitError = "Transaction verify failed. Transaction client abort abandoned. Server will eventually abort the Transaction."
+	CommitErrorMarkRollForwardAbandoned CommitError = "Transaction client mark roll forward abandoned. Server will eventually abort the Transaction."
 )

commit_status.go

@@ -14,14 +14,14 @@
 
 package aerospike
 
-// Multi-record transaction (MRT) commit status code.
+// Transaction commit status code.
 type CommitStatus string
 
 const (
 	CommitStatusOK                   CommitStatus = "Commit succeeded"
 	CommitStatusUnverified           CommitStatus = "Commit process was disrupted on client side and unverified"
 	CommitStatusAlreadyCommitted     CommitStatus = "Already committed"
 	CommitStatusAlreadyAborted       CommitStatus = "Already aborted"
-	CommitStatusRollForwardAbandoned CommitStatus = "MRT client roll forward abandoned. Server will eventually commit the MRT."
-	CommitStatusCloseAbandoned       CommitStatus = "MRT has been rolled forward, but MRT client close was abandoned. Server will eventually close the MRT."
+	CommitStatusRollForwardAbandoned CommitStatus = "Transaction client roll forward abandoned. Server will eventually commit the Transaction."
+	CommitStatusCloseAbandoned       CommitStatus = "Transaction has been rolled forward, but Transaction client close was abandoned. Server will eventually close the Transaction."
 )