types.go

// jsoff is JSONRPC 2.0 libaray in golang
package jsoff

import (
	log "github.com/sirupsen/logrus"
	"net/http"
)

type UID string

// message kinds
const (
	MKRequest = iota
	MKNotify
	MKResult
	MKError
)

// RPC error object
type RPCError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Data    any    `json:"data,omitempty"`
}

type MessageOptions struct {
	IdNotNull bool // Request.id cannot be null
}

// The abstract interface of JSONRPC message. refer to
// https://www.jsonrpc.org/specification
//
// data Message = Request id method params |
//
//	Notify method params |
//	Result id result |
//	Error id error={ code message data }
type Message interface {
	// Return's the judgement of message types
	IsRequest() bool
	IsNotify() bool
	IsResponse() bool
	IsResult() bool
	IsError() bool
	IsResultOrError() bool

	// TraceId can be used to analyse the flow of whole message
	// transportation
	SetTraceId(traceId string)
	TraceId() string

	// Returns template structures, this structure can be used to
	// marshal and turn into map
	Interface() any

	// MustXX are convenience methods to make code cleaner by
	// avoiding frequent type casting, Note that there will be
	// panics when used inproperly, add some IsXX type checking
	// beforehead to add guarantee.

	// MustId returns the Id field of a message, will panic when
	// message is a Notify
	MustId() any

	// MustMethod returns the method of a message, will panic when
	// message is an Result or Error.
	MustMethod() string

	// MustParams returns the params of a message, will panic when
	// message is a Result or Error
	MustParams() []any

	// MustResult returns the result field of a message, will
	// panic when the message is not a Result
	MustResult() any

	// MustError returns the error field of a message, will panic
	// when the message is not an Error
	MustError() *RPCError

	// Clone the message with a new Id
	ReplaceId(id any) Message

	// Log returns a Logger object with message specific
	// infomations attached.
	Log() *log.Entry
}

// The base class of JSONRPC types
type BaseMessage struct {
	kind    int
	traceId string
}

// Request message kind
type RequestMessage struct {
	BaseMessage
	Id            any
	Method        string
	Params        []any
	paramsAreList bool

	// request specific fields
}

// Notify message kind
type NotifyMessage struct {
	BaseMessage
	Method        string
	Params        []any
	paramsAreList bool
}

type ResponseMessage interface {
	HasResponseHeader() bool
	ResponseHeader() http.Header
}

// Result message kind
type ResultMessage struct {
	BaseMessage
	Id     any
	Result any

	responseHeader http.Header
}

// Error message kind
type ErrorMessage struct {
	BaseMessage
	Id    any
	Error *RPCError

	responseHeader http.Header
}