github.com/matrixorigin/matrixone@v1.2.0/pkg/pb/txn/txn.go

// Copyright 2021 - 2022 Matrix Origin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package txn

import (
	"bytes"
	"encoding/hex"
	"fmt"
	"strings"

	"github.com/matrixorigin/matrixone/pkg/common/moerr"
	"github.com/matrixorigin/matrixone/pkg/pb/metadata"
)

const (
	// SkipResponseFlag skip response.
	SkipResponseFlag uint32 = 1
)

// NewTxnRequest create TxnRequest by CNOpRequest
func NewTxnRequest(request *CNOpRequest) TxnRequest {
	return TxnRequest{CNRequest: request}
}

// GetCNOpResponse returns the CNOpResponse from TxnResponse
func GetCNOpResponse(response TxnResponse) CNOpResponse {
	return *response.CNOpResponse
}

// HasFlag returns true if has the spec flag
func (m TxnResponse) HasFlag(flag uint32) bool {
	return m.Flag&flag > 0
}

// DebugString returns debug string
func (m TxnRequest) DebugString() string {
	return m.DebugStringWithPayload(true)
}

// DebugStringWithPayload returns debug string with payload bytes if
// withPayload is true
func (m TxnRequest) DebugStringWithPayload(withPayload bool) string {
	var buffer bytes.Buffer

	buffer.WriteString(fmt.Sprintf("%d: ", m.RequestID))

	buffer.WriteString("<")
	buffer.WriteString(m.Txn.DebugString())
	buffer.WriteString(">/")

	buffer.WriteString(m.Method.String())
	buffer.WriteString("/")
	buffer.WriteString(fmt.Sprintf("F-%d", m.Flag))

	if withPayload && m.CNRequest != nil {
		buffer.WriteString("/<")
		buffer.WriteString(m.CNRequest.DebugString())
		buffer.WriteString(">")
	}
	buffer.WriteString("/=><")
	buffer.WriteString(m.GetTargetTN().DebugString())
	buffer.WriteString(">")
	return buffer.String()
}

// DebugString returns debug string
func (m TxnError) DebugString() string {
	return fmt.Sprintf("%d: %s", m.TxnErrCode, m.UnwrapError().Error())
}

// DebugString returns debug string
func (m TxnResponse) DebugString() string {
	var buffer bytes.Buffer

	buffer.WriteString(fmt.Sprintf("%d: ",
		m.RequestID))

	if m.Txn != nil {
		buffer.WriteString("<")
		buffer.WriteString(m.Txn.DebugString())
		buffer.WriteString(">/")
	}

	buffer.WriteString(m.Method.String())
	buffer.WriteString("/")
	buffer.WriteString(fmt.Sprintf("F:%d", m.Flag))

	if m.TxnError != nil {
		buffer.WriteString("/")
		buffer.WriteString(m.TxnError.DebugString())
	}

	if m.CNOpResponse != nil {
		buffer.WriteString("/")
		buffer.WriteString(m.CNOpResponse.DebugString())
	}

	return buffer.String()
}

// DebugString returns debug string
func (m CNOpRequest) DebugString() string {
	return fmt.Sprintf("O:%d-D:%d", m.OpCode, len(m.Payload))
}

// DebugString returns debug string
func (m CNOpResponse) DebugString() string {
	return fmt.Sprintf("D:%d", len(m.Payload))
}

// DebugString returns debug string
func (m TxnMeta) DebugString() string {
	var buffer bytes.Buffer

	buffer.WriteString(hex.EncodeToString(m.ID))
	buffer.WriteString("/")
	buffer.WriteString(m.Status.String())
	buffer.WriteString("/S:")
	buffer.WriteString(m.SnapshotTS.DebugString())

	if !m.PreparedTS.IsEmpty() {
		buffer.WriteString("/P:")
		buffer.WriteString(m.PreparedTS.DebugString())
	}

	if !m.CommitTS.IsEmpty() {
		buffer.WriteString("/C:")
		buffer.WriteString(m.CommitTS.DebugString())
	}

	n := len(m.TNShards)
	var buf bytes.Buffer
	buf.WriteString("/<")
	for idx, tn := range m.TNShards {
		buf.WriteString(tn.DebugString())
		if idx < n-1 {
			buf.WriteString(", ")
		}
	}
	buf.WriteString(">")
	return buffer.String()
}

// GetTargetTN return tn shard ID that message need send to.
func (m TxnRequest) GetTargetTN() metadata.TNShard {
	switch m.Method {
	case TxnMethod_Read, TxnMethod_Write, TxnMethod_DEBUG:
		return m.CNRequest.Target
	case TxnMethod_Commit:
		return m.Txn.TNShards[0]
	case TxnMethod_Rollback:
		return m.Txn.TNShards[0]
	case TxnMethod_Prepare:
		return m.PrepareRequest.TNShard
	case TxnMethod_GetStatus:
		return m.GetStatusRequest.TNShard
	case TxnMethod_CommitTNShard:
		return m.CommitTNShardRequest.TNShard
	case TxnMethod_RollbackTNShard:
		return m.RollbackTNShardRequest.TNShard
	default:
		panic(fmt.Sprintf("unknown txn request method: %v", m.Method))
	}
}

// SetID implement morpc Messgae
func (m *TxnRequest) SetID(id uint64) {
	m.RequestID = id
}

// GetID implement morpc Messgae
func (m *TxnRequest) GetID() uint64 {
	return m.RequestID
}

// SetID implement morpc Messgae
func (m *TxnResponse) SetID(id uint64) {
	m.RequestID = id
}

// GetID implement morpc Messgae
func (m *TxnResponse) GetID() uint64 {
	return m.RequestID
}

// RequestsDebugString returns requests debug string
func RequestsDebugString(requests []TxnRequest, withPayload bool) string {
	n := len(requests)
	var buf bytes.Buffer
	buf.WriteString("[")
	for idx, req := range requests {
		buf.WriteString(req.DebugStringWithPayload(withPayload))
		if idx < n-1 {
			buf.WriteString(", ")
		}
	}
	buf.WriteString("]")
	return buf.String()
}

// ResponsesDebugString returns responses debug string
func ResponsesDebugString(responses []TxnResponse) string {
	n := len(responses)
	var buf bytes.Buffer
	buf.WriteString("[")
	for idx, resp := range responses {
		buf.WriteString(resp.DebugString())
		if idx < n-1 {
			buf.WriteString(", ")
		}
	}
	buf.WriteString("]")
	return buf.String()
}

// WrapError wrapper error to TxnError
func WrapError(err error, internalCode uint16) *TxnError {
	if me, ok := err.(*moerr.Error); ok {
		data, e := me.MarshalBinary()
		if e != nil {
			panic(e)
		}
		v := &TxnError{Error: data, Code: uint32(me.ErrorCode())}
		v.TxnErrCode = v.Code
		if internalCode != 0 {
			v.TxnErrCode = uint32(internalCode)
		}
		return v
	}

	return WrapError(moerr.NewInternalErrorNoCtx(err.Error()), internalCode)
}

// UnwrapError unwrap the moerr from the TxnError
func (m TxnError) UnwrapError() error {
	err := &moerr.Error{}
	if e := err.UnmarshalBinary(m.Error); e != nil {
		panic(e)
	}
	return err
}

// GetTxnMode get txn mode from string
func GetTxnMode(value string) TxnMode {
	for name, m := range TxnMode_value {
		if strings.EqualFold(name, value) {
			return TxnMode(m)
		}
	}
	panic("BUG")
}

// GetTxnIsolation get txn mode from string
func GetTxnIsolation(value string) TxnIsolation {
	for name, m := range TxnIsolation_value {
		if strings.EqualFold(name, value) {
			return TxnIsolation(m)
		}
	}
	panic("BUG")
}

// ValidTxnMode valid txn mode
func ValidTxnMode(value string) bool {
	found := true
	for name := range TxnMode_value {
		if strings.EqualFold(name, value) {
			found = true
			break
		}
	}
	return found
}

// ValidTxnIsolation valid txn isolation
func ValidTxnIsolation(value string) bool {
	found := true
	for name := range TxnIsolation_value {
		if strings.EqualFold(name, value) {
			found = true
			break
		}
	}
	return found
}

// IsRCIsolation returns the isolation of current txn
func (m TxnMeta) IsRCIsolation() bool {
	return m.Isolation == TxnIsolation_RC
}

// IsPessimistic returns true if txn is in pessimistic mode
func (m TxnMeta) IsPessimistic() bool {
	return m.Mode == TxnMode_Pessimistic
}