review suggestions: better proto name and code comments

Signed-off-by: Florent Poinsard <[email protected]>

go/vt/vterrors/code.go

@@ -235,6 +235,7 @@ func (o *VitessError) Cause() error {
 
 var _ error = (*VitessError)(nil)
 
+// errorWithoutState is an error that does not have any state, e.g. the state will be unknown
 func errorWithoutState(id string, code vtrpcpb.Code, short, long string) func(args ...any) *VitessError {
 	return func(args ...any) *VitessError {
 		s := short
@@ -268,6 +269,8 @@ func errorWithState(id string, code vtrpcpb.Code, state State, short, long strin
 	}
 }
 
+// errorWithNoCode creates a VitessError where the error code is set by the user when creating the error
+// instead of having a static error code that is declared in this file.
 func errorWithNoCode(id string, short, long string) func(code vtrpcpb.Code, args ...any) *VitessError {
 	return func(code vtrpcpb.Code, args ...any) *VitessError {
 		s := short

go/vt/vtgate/executor.go

@@ -622,7 +622,7 @@ func (e *Executor) handleRollback(ctx context.Context, safeSession *econtext.Saf
 	e.updateQueryCounts("Rollback", "", "", int64(logStats.ShardQueries))
 	err := e.txConn.Rollback(ctx, safeSession)
 	logStats.CommitTime = time.Since(execStart)
-	safeSession.SetTxErrorBlockNextQueries(false) // We have executed a ROLLBACK, if applicable: we can stop blocking queries on this session
+	safeSession.SetErrorUntilRollback(false) // We have executed a ROLLBACK, if applicable: we can stop blocking queries on this session
 	return &sqltypes.Result{}, err
 }
 

go/vt/vtgate/executorcontext/safe_session.go

@@ -390,16 +390,16 @@ func (session *SafeSession) GetCommitOrder() vtgatepb.CommitOrder {
 	return session.commitOrder
 }
 
-func (session *SafeSession) SetTxErrorBlockNextQueries(enable bool) {
+func (session *SafeSession) SetErrorUntilRollback(enable bool) {
 	session.mu.Lock()
 	defer session.mu.Unlock()
-	session.TxErrorBlockNextQueries = enable
+	session.ErrorUntilRollback = enable
 }
 
-func (session *SafeSession) GetTxErrorBlockNextQueries() bool {
+func (session *SafeSession) IsErrorUntilRollback() bool {
 	session.mu.Lock()
 	defer session.mu.Unlock()
-	return session.Session.GetTxErrorBlockNextQueries()
+	return session.Session.GetErrorUntilRollback()
 }
 
 // GetLogger returns executor logger.

go/vt/vtgate/plan_execute.go

@@ -153,7 +153,7 @@ func (e *Executor) newExecute(
 		defer cancel()
 
 		// If we have previously issued a VT15001 error, we block every queries on this session until we receive a ROLLBACK.
-		if plan.Type != sqlparser.StmtRollback && safeSession.GetTxErrorBlockNextQueries() {
+		if plan.Type != sqlparser.StmtRollback && safeSession.IsErrorUntilRollback() {
 			return vterrors.VT15002()
 		}
 
@@ -369,7 +369,7 @@ func (e *Executor) rollbackOnFatalTxError(ctx context.Context, safeSession *econ
 	}
 	// we already know one or more shards are going to fail rolling back, the error can be discarded
 	_ = e.txConn.Rollback(ctx, safeSession)
-	safeSession.SetTxErrorBlockNextQueries(true)
+	safeSession.SetErrorUntilRollback(true)
 	return true
 }
 

proto/vtgate.proto

@@ -160,7 +160,7 @@ message Session {
   // MigrationContext
   string migration_context = 27;
 
-  bool tx_error_block_next_queries = 28;
+  bool error_until_rollback = 28;
 }
 
 // PrepareData keeps the prepared statement and other information related for execution of it.