common

README

common

Documentation

Index

• Variables
• func GenerateSpanID() string
• func GenerateTraceID() string
• type APIContext
• type AsmParam
• type ContextKey
• type DalContext
• type Debugger
• type EndpointMetas
• type Handler
• type HandlerFunc
  • func (hf HandlerFunc) Process(ctx APIContext) error
• type ParsedName
  • func ParseMethodName(method string) (*ParsedName, error)
• type PreparedQuery
• type QueryResult
• type RequestContext
• type RequestReader
• type RequestWriter
• type ResponseReader
• type ResponseWriter
• type RunnerContext

Variables

var ApiCtxKey = ContextKey{}

Functions

func GenerateSpanID

func GenerateSpanID() string

GenerateSpanID generates a 64-bit Span ID

func GenerateTraceID

func GenerateTraceID() string

GenerateTraceID generates a 128-bit Trace ID

Types

type APIContext

type APIContext interface {
	RequestReader
	ResponseReader
	RequestWriter
	ResponseWriter
	Debugger
}

APIContext combines request and response contexts

type AsmParam

type AsmParam struct {
	Api           string
	Param         []any
	SessionFilter map[string]string
	SessionValues map[string]string
}

type ContextKey

type ContextKey struct{}

type DalContext

type DalContext struct {
	// Container for transaction management.
	// Ensures that accessing the same database during a single API request uses the same connection,
	// and automatically commits or rolls back transactions when the request ends.
	Container *sync.Map

	TraceID  string
	ParentID string
	SpanID   string

	DebugInfo []map[string]any
}

type Debugger

type Debugger interface {
	SetDebugInfo([]map[string]any)
	DebugInfo() []map[string]any
}

type EndpointMetas

type EndpointMetas struct {
	Name          string
	SessionFilter map[string]any
	SessionValue  map[string]any
}

type Handler

type Handler interface {
	Process(APIContext) error
}

type HandlerFunc

type HandlerFunc func(APIContext) error

func (HandlerFunc) Process

func (hf HandlerFunc) Process(ctx APIContext) error

type ParsedName

type ParsedName struct {
	FullName     string `json:"fullName"` // FullName = EndpointName + ApiName
	EndpointName string `json:"endpointName"`
	ApiName      string `json:"apiName"` // ApiName = EntityName + EntityMethod
	EntityName   string `json:"entityName"`
	EntityMethod string `json:"entityMethod"`
}

func ParseMethodName

func ParseMethodName(method string) (*ParsedName, error)

type PreparedQuery

type PreparedQuery struct {
	Query     string `json:"query"`
	Bind      []any  `json:"bind"`
	QueryType string `json:"queryType"`

	CheckPoint      []*PreparedQuery `json:"checkPoint"`
	DatabaseUpdater []*PreparedQuery `json:"databaseUpdater"`
	ResultEnricher  []*PreparedQuery `json:"resultEnricher"`
}

type QueryResult

type QueryResult struct {
	QueryType    string
	LastInsertId int64
	RowsAffected int64
	Row          map[string]any
	Rows         []map[string]any
	Total        int64
}

type RequestContext

type RequestContext struct {
	ApiName     string
	RemoteAddr  string
	RemoteHost  string
	RequestTime time.Time
}

type RequestReader

type RequestReader interface {
	RequestID() string
	RequestContext() *RequestContext
	Method() string
	Params() any
	RawParams() []byte
	Metas() map[string]any
	EndpointMetas() *EndpointMetas
}

RequestReader contains request-related information

type RequestWriter

type RequestWriter interface {
	SetRequestID(string)
	SetMethod(string)
	SetParams(any)
	SetRawParams([]byte)
	SetMetas(map[string]any)
	SetEndpointMetas(*EndpointMetas)
}

RequestWriter allows modification of request-related information

type ResponseReader

type ResponseReader interface {
	Result() any
	Err() error
}

ResponseReader contains response-related information

type ResponseWriter

type ResponseWriter interface {
	SetResult(any)
	SetErr(error)
}

ResponseWriter allows modification of response-related information

type RunnerContext

type RunnerContext struct {
	// Provide the default entity name for getting database connections
	// only when the scripting language is native SQL.
	DefaultEntityName string

	GlobalThis map[string]any

	DalCtx *DalContext
}