go/go-micro
1
0
Fork 0
mirror of https://github.com/go-micro/go-micro.git synced 2024-12-18 08:26:38 +02:00
Code Issues Releases Activity

fix: some linting issues (#2563)

Browse Source
This commit is contained in:
David Brouwer 2022-09-30 16:27:07 +02:00 committed by GitHub
parent 47e6a8d725
commit 85c0b0b8eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
221 changed files with 1025 additions and 1283 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.golangci.yaml
View File

@ -60,7 +60,7 @@ linters-settings:
# The longest distance, in source lines, that is being considered a "small scope".
# Variables used in at most this many lines will be ignored.
# Default: 5
max-distance: 16
max-distance: 26
ignore-names:
- err
- id
@ -86,7 +86,7 @@ linters-settings:
check-blank: true
govet:
# report about shadowed variables
check-shadowing: true
check-shadowing: false
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true
@ -182,6 +182,7 @@ linters:
- nonamedreturns
- makezero
- gofumpt
- nlreturn
# Can be considered to be enabled
- gochecknoinits

27
api/api.go
View File

@ -12,10 +12,10 @@ import (
"go-micro.dev/v4/server"
)
// The gateway interface provides a way to
// create composable API gateways
// API interface provides a way to
// create composable API gateways.
type Api interface {
// Initialise options
// Initialize options
Init(...Option) error
// Get the options
Options() Options
@ -29,6 +29,7 @@ type Api interface {
String() string
}
// Options are API options.
type Options struct {
// Address of the server
Address string
@ -36,9 +37,10 @@ type Options struct {
Router router.Router
}
// Option type are API option args.
type Option func(*Options) error
// Endpoint is a mapping between an RPC method and HTTP endpoint
// Endpoint is a mapping between an RPC method and HTTP endpoint.
type Endpoint struct {
// RPC Method e.g. Greeter.Hello
Name string
@ -56,7 +58,7 @@ type Endpoint struct {
Stream bool
}
// Service represents an API service
// Service represents an API service.
type Service struct {
// Name of service
Name string
@ -82,21 +84,22 @@ func slice(s string) []string {
return sl
}
// Encode encodes an endpoint to endpoint metadata
// Encode encodes an endpoint to endpoint metadata.
func Encode(e *Endpoint) map[string]string {
if e == nil {
return nil
}
// endpoint map
ep := make(map[string]string)
em := make(map[string]string)
// set vals only if they exist
set := func(k, v string) {
if len(v) == 0 {
return
}
ep[k] = v
em[k] = v
}
set("endpoint", e.Name)
@ -106,10 +109,10 @@ func Encode(e *Endpoint) map[string]string {
set("path", strings.Join(e.Path, ","))
set("host", strings.Join(e.Host, ","))
return ep
return em
}
// Decode decodes endpoint metadata into an endpoint
// Decode decodes endpoint metadata into an endpoint.
func Decode(e map[string]string) *Endpoint {
if e == nil {
return nil
@ -125,7 +128,7 @@ func Decode(e map[string]string) *Endpoint {
}
}
// Validate validates an endpoint to guarantee it won't blow up when being served
// Validate validates an endpoint to guarantee it won't blow up when being served.
func Validate(e *Endpoint) error {
if e == nil {
return errors.New("endpoint is nil")
@ -172,7 +175,7 @@ func WithEndpoint(e *Endpoint) server.HandlerOption {
return server.EndpointMetadata(e.Name, Encode(e))
}
// NewApi returns a new api gateway
// NewApi returns a new api gateway.
func NewApi(opts ...Option) Api {
return newApi(opts...)
}

1
api/api_test.go
View File

@ -148,5 +148,4 @@ func TestValidate(t *testing.T) {
if err := Validate(epPcreInvalid); err == nil {
t.Fatalf("invalid pcre %v", epPcreInvalid.Path[0])
}
}

47
api/client/client.go
View File

@ -12,14 +12,16 @@ import (
"time"
"github.com/gorilla/websocket"
"go-micro.dev/v4/logger"
)
const (
// local address for api
// local address for api.
localAddress = "http://localhost:8080"
)
// Options of the Client
// Options of the Client.
type Options struct {
// Token for authentication
Token string
@ -33,7 +35,7 @@ type Options struct {
Timeout time.Duration
}
// Request is the request of the generic `api-client` call
// Request is the request of the generic `api-client` call.
type Request struct {
// eg. "go.micro.srv.greeter"
Service string `json:"service"`
@ -55,17 +57,18 @@ type Response struct {
Status string `json:"status"`
}
// Client enables generic calls to micro
// Client enables generic calls to micro.
type Client struct {
options Options
}
// Stream is a websockets stream.
type Stream struct {
conn *websocket.Conn
service, endpoint string
}
// NewClient returns a generic micro client that connects to live by default
// NewClient returns a generic micro client that connects to live by default.
func NewClient(options *Options) *Client {
ret := new(Client)
ret.options = Options{
@ -93,17 +96,17 @@ func NewClient(options *Options) *Client {
return ret
}
// SetToken sets the api auth token
// SetToken sets the api auth token.
func (client *Client) SetToken(t string) {
client.options.Token = t
}
// SetTimeout sets the http client's timeout
// SetTimeout sets the http client's timeout.
func (client *Client) SetTimeout(d time.Duration) {
client.options.Timeout = d
}
// Call enables you to access any endpoint of any service on Micro
// Call enables you to access any endpoint of any service on Micro.
func (client *Client) Call(service, endpoint string, request, response interface{}) error {
// example curl: curl -XPOST -d '{"service": "go.micro.srv.greeter", "endpoint": "Say.Hello"}'
// -H 'Content-Type: application/json' http://localhost:8080/client {"body":"eyJtc2ciOiJIZWxsbyAifQ=="}
@ -115,7 +118,7 @@ func (client *Client) Call(service, endpoint string, request, response interface
// set the url to go through the v1 api
uri.Path = "/" + service + "/" + endpoint
b, err := marshalRequest(service, endpoint, request)
b, err := marshalRequest(endpoint, request)
if err != nil {
return err
}
@ -141,21 +144,28 @@ func (client *Client) Call(service, endpoint string, request, response interface
if err != nil {
return err
}
defer resp.Body.Close()
defer func() {
if err = resp.Body.Close(); err != nil {
logger.DefaultLogger.Log(logger.ErrorLevel, err)
}
}()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
if !(resp.StatusCode >= 200 && resp.StatusCode < 300) {
if resp.StatusCode <= 200 || resp.StatusCode > 300 {
return errors.New(string(body))
}
return unmarshalResponse(body, response)
}
// Stream enables the ability to stream via websockets
// Stream enables the ability to stream via websockets.
func (client *Client) Stream(service, endpoint string, request interface{}) (*Stream, error) {
b, err := marshalRequest(service, endpoint, request)
b, err := marshalRequest(endpoint, request)
if err != nil {
return nil, err
}
@ -177,9 +187,10 @@ func (client *Client) Stream(service, endpoint string, request interface{}) (*St
if len(client.options.Token) > 0 {
header.Set("Authorization", "Bearer "+client.options.Token)
}
header.Set("Content-Type", "application/json")
// dial the connection
// dial the connection, connection not closed as conn is returned
conn, _, err := websocket.DefaultDialer.Dial(uri.String(), header)
if err != nil {
return nil, err
@ -193,24 +204,28 @@ func (client *Client) Stream(service, endpoint string, request interface{}) (*St
return &Stream{conn, service, endpoint}, nil
}
// Recv will receive a message from a stream and unmarshal it.
func (s *Stream) Recv(v interface{}) error {
// read response
_, message, err := s.conn.ReadMessage()
if err != nil {
return err
}
return unmarshalResponse(message, v)
}
// Send will send a message into the stream.
func (s *Stream) Send(v interface{}) error {
b, err := marshalRequest(s.service, s.endpoint, v)
b, err := marshalRequest(s.endpoint, v)
if err != nil {
return err
}
return s.conn.WriteMessage(websocket.TextMessage, b)
}
func marshalRequest(service, endpoint string, v interface{}) ([]byte, error) {
func marshalRequest(endpoint string, v interface{}) ([]byte, error) {
return json.Marshal(v)
}

7
api/default.go
View File

@ -45,7 +45,6 @@ func newApi(opts ...Option) Api {
}
}
// Initialise options
func (a *api) Init(opts ...Option) error {
for _, o := range opts {
o(&a.options)
@ -53,17 +52,17 @@ func (a *api) Init(opts ...Option) error {
return nil
}
// Get the options
// Get the options.
func (a *api) Options() Options {
return a.options
}
// Register a http handler
// Register a http handler.
func (a *api) Register(*Endpoint) error {
return nil
}
// Register a route
// Register a route.
func (a *api) Deregister(*Endpoint) error {
return nil
}

2
api/handler/api/api.go
View File

@ -21,7 +21,7 @@ const (
Handler = "api"
)
// API handler is the default handler which takes api.Request and returns api.Response
// API handler is the default handler which takes api.Request and returns api.Response.
func (a *apiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
bsize := handler.DefaultMaxRecvSize
if a.opts.MaxRecvSize > 0 {

8
api/handler/api/util.go
View File

@ -14,7 +14,7 @@ import (
)
var (
// need to calculate later to specify useful defaults
// need to calculate later to specify useful defaults.
bufferPool = bpool.NewSizedBufferPool(1024, 8)
)
@ -34,11 +34,11 @@ func requestToProto(r *http.Request) (*api.Request, error) {
ct, _, err := mime.ParseMediaType(r.Header.Get("Content-Type"))
if err != nil {
ct = "text/plain; charset=UTF-8" //default CT is text/plain
ct = "text/plain; charset=UTF-8" // default CT is text/plain
r.Header.Set("Content-Type", ct)
}
//set the body:
// set the body:
if r.Body != nil {
switch ct {
case "application/x-www-form-urlencoded":
@ -110,7 +110,7 @@ func requestToProto(r *http.Request) (*api.Request, error) {
return req, nil
}
// strategy is a hack for selection
// strategy is a hack for selection.
func strategy(services []*registry.Service) selector.Strategy {
return func(_ []*registry.Service) selector.Next {
// ignore input to this function, use services above

2
api/handler/handler.go
View File

@ -5,7 +5,7 @@ import (
"net/http"
)
// Handler represents a HTTP handler that manages a request
// Handler represents a HTTP handler that manages a request.
type Handler interface {
// standard http handler
http.Handler

4
api/handler/http/http.go
View File

@ -42,7 +42,7 @@ func (h *httpHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
httputil.NewSingleHostReverseProxy(rp).ServeHTTP(w, r)
}
// getService returns the service for this request from the selector
// getService returns the service for this request from the selector.
func (h *httpHandler) getService(r *http.Request) (string, error) {
var service *router.Route
@ -74,7 +74,7 @@ func (h *httpHandler) String() string {
return "http"
}
// NewHandler returns a http proxy handler
// NewHandler returns a http proxy handler.
func NewHandler(opts ...handler.Option) handler.Handler {
options := handler.NewOptions(opts...)

2
api/handler/http/http_test.go
View File

@ -52,7 +52,7 @@ func testHttp(t *testing.T, path, service, ns string) {
t.Fatal(err)
}
// initialise the handler
// initialize the handler
rt := regRouter.NewRouter(
router.WithHandler("http"),
router.WithRegistry(r),

10
api/handler/options.go
View File

@ -20,7 +20,7 @@ type Options struct {
type Option func(o *Options)
// NewOptions fills in the blanks
// NewOptions fills in the blanks.
func NewOptions(opts ...Option) Options {
options := Options{
Logger: logger.DefaultLogger,
@ -45,14 +45,14 @@ func NewOptions(opts ...Option) Options {
return options
}
// WithNamespace specifies the namespace for the handler
// WithNamespace specifies the namespace for the handler.
func WithNamespace(s string) Option {
return func(o *Options) {
o.Namespace = s
}
}
// WithRouter specifies a router to be used by the handler
// WithRouter specifies a router to be used by the handler.
func WithRouter(r router.Router) Option {
return func(o *Options) {
o.Router = r
@ -65,14 +65,14 @@ func WithClient(c client.Client) Option {
}
}
// WithMaxRecvSize specifies max body size
// WithMaxRecvSize specifies max body size.
func WithMaxRecvSize(size int64) Option {
return func(o *Options) {
o.MaxRecvSize = size
}
}
// WithLogger specifies the logger
// WithLogger specifies the logger.
func WithLogger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

15
api/handler/rpc/rpc.go
View File

@ -34,14 +34,14 @@ const (
)
var (
// supported json codecs
// supported json codecs.
jsonCodecs = []string{
"application/grpc+json",
"application/json",
"application/json-rpc",
}
// support proto codecs
// support proto codecs.
protoCodecs = []string{
"application/grpc",
"application/grpc+proto",
@ -66,7 +66,7 @@ func (b *buffer) Write(_ []byte) (int, error) {
return 0, nil
}
// strategy is a hack for selection
// strategy is a hack for selection.
func strategy(services []*registry.Service) selector.Strategy {
return func(_ []*registry.Service) selector.Next {
// ignore input to this function, use services above
@ -141,7 +141,7 @@ func (h *rpcHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
if isStream(r, service) {
// drop older context as it can have timeouts and create new
// md, _ := metadata.FromContext(cx)
//serveWebsocket(context.TODO(), w, r, service, c)
// serveWebsocket(context.TODO(), w, r, service, c)
if err := serveWebsocket(cx, w, r, service, c); err != nil {
logger.Log(log.ErrorLevel, err)
}
@ -260,7 +260,7 @@ func hasCodec(ct string, codecs []string) bool {
// requestPayload takes a *http.Request.
// If the request is a GET the query string parameters are extracted and marshaled to JSON and the raw bytes are returned.
// If the request method is a POST the request body is read and returned
// If the request method is a POST the request body is read and returned.
func requestPayload(r *http.Request) ([]byte, error) {
var err error
@ -430,7 +430,7 @@ func requestPayload(r *http.Request) ([]byte, error) {
if jsonbody != nil {
dstmap[ps[0]] = jsonbody
} else {
// old unexpected behaviour
// old unexpected behavior
dstmap[ps[0]] = bodybuf
}
} else {
@ -438,7 +438,7 @@ func requestPayload(r *http.Request) ([]byte, error) {
if jsonbody != nil {
em[ps[len(ps)-1]] = jsonbody
} else {
// old unexpected behaviour
// old unexpected behavior
em[ps[len(ps)-1]] = bodybuf
}
for i := len(ps) - 2; i > 0; i-- {
@ -460,7 +460,6 @@ func requestPayload(r *http.Request) ([]byte, error) {
//fallback to previous unknown behaviour
return bodybuf, nil
}
return []byte{}, nil

5
api/handler/rpc/rpc_test.go
View File

@ -12,8 +12,7 @@ import (
)
func TestRequestPayloadFromRequest(t *testing.T) {
// our test event so that we can validate serialising / deserializing of true protos works
// our test event so that we can validate serializing / deserializing of true protos works
protoEvent := go_api.Event{
Name: "Test",
}
@ -85,7 +84,6 @@ func TestRequestPayloadFromRequest(t *testing.T) {
})
t.Run("extracting params from a GET request", func(t *testing.T) {
r, err := http.NewRequest("GET", "http://localhost/my/path", nil)
if err != nil {
t.Fatalf("Failed to created http.Request: %v", err)
@ -105,7 +103,6 @@ func TestRequestPayloadFromRequest(t *testing.T) {
})
t.Run("GET request with no params", func(t *testing.T) {
r, err := http.NewRequest("GET", "http://localhost/my/path", nil)
if err != nil {
t.Fatalf("Failed to created http.Request: %v", err)

4
api/handler/rpc/stream.go
View File

@ -19,7 +19,7 @@ import (
"go-micro.dev/v4/selector"
)
// serveWebsocket will stream rpc back over websockets assuming json
// serveWebsocket will stream rpc back over websockets assuming json.
func serveWebsocket(ctx context.Context, w http.ResponseWriter, r *http.Request, service *router.Route, c client.Client) (err error) {
var op ws.OpCode
@ -151,7 +151,7 @@ func serveWebsocket(ctx context.Context, w http.ResponseWriter, r *http.Request,
}
}
// writeLoop
// writeLoop.
func writeLoop(rw io.ReadWriter, stream client.Stream) error {
// close stream when done
defer stream.Close()

4
api/handler/web/web.go
View File

@ -50,7 +50,7 @@ func (wh *webHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
httputil.NewSingleHostReverseProxy(rp).ServeHTTP(w, r)
}
// getService returns the service for this request from the selector
// getService returns the service for this request from the selector.
func (wh *webHandler) getService(r *http.Request) (string, error) {
var service *router.Route
@ -78,7 +78,7 @@ func (wh *webHandler) getService(r *http.Request) (string, error) {
return fmt.Sprintf("http://%s", s.Address), nil
}
// serveWebSocket used to serve a web socket proxied connection
// serveWebSocket used to serve a web socket proxied connection.
func (wh *webHandler) serveWebSocket(host string, w http.ResponseWriter, r *http.Request) {
req := new(http.Request)
*req = *r

2
api/options.go
View File

@ -16,7 +16,7 @@ func NewOptions(opts ...Option) Options {
return options
}
// WithRouter sets the router to use e.g static or registry
// WithRouter sets the router to use e.g static or registry.
func WithRouter(r router.Router) Option {
return func(o *Options) error {
o.Router = r

5
api/resolver/options.go
View File

@ -4,7 +4,6 @@ import (
"net/http"
)
// NewOptions returns new initialised options
func NewOptions(opts ...Option) Options {
var options Options
for _, o := range opts {
@ -18,14 +17,14 @@ func NewOptions(opts ...Option) Options {
return options
}
// WithHandler sets the handler being used
// WithHandler sets the handler being used.
func WithHandler(h string) Option {
return func(o *Options) {
o.Handler = h
}
}
// WithNamespace sets the function which determines the namespace for a request
// WithNamespace sets the function which determines the namespace for a request.
func WithNamespace(n func(*http.Request) string) Option {
return func(o *Options) {
o.Namespace = n

6
api/resolver/resolver.go
View File

@ -11,13 +11,13 @@ var (
ErrInvalidPath = errors.New("invalid path")
)
// Resolver resolves requests to endpoints
// Resolver resolves requests to endpoints.
type Resolver interface {
Resolve(r *http.Request) (*Endpoint, error)
String() string
}
// Endpoint is the endpoint for a http request
// Endpoint is the endpoint for a http request.
type Endpoint struct {
// e.g greeter
Name string
@ -36,7 +36,7 @@ type Options struct {
type Option func(o *Options)
// StaticNamespace returns the same namespace for each request
// StaticNamespace returns the same namespace for each request.
func StaticNamespace(ns string) func(*http.Request) string {
return func(*http.Request) string {
return ns

2
api/resolver/vpath/vpath.go
View File

@ -1,4 +1,4 @@
// Package vpath resolves using http path and recognised versioned urls
// Package vpath resolves using http path and recognized versioned urls
package vpath
import (

6
api/router/endpoint.go
View File

@ -22,7 +22,7 @@ func slice(s string) []string {
return sl
}
// Encode encodes an endpoint to endpoint metadata
// Encode encodes an endpoint to endpoint metadata.
func Encode(e *Endpoint) map[string]string {
if e == nil {
return nil
@ -49,7 +49,7 @@ func Encode(e *Endpoint) map[string]string {
return ep
}
// Decode decodes endpoint metadata into an endpoint
// Decode decodes endpoint metadata into an endpoint.
func Decode(e map[string]string) *Endpoint {
if e == nil {
return nil
@ -65,7 +65,7 @@ func Decode(e map[string]string) *Endpoint {
}
}
// Validate validates an endpoint to guarantee it won't blow up when being served
// Validate validates an endpoint to guarantee it won't blow up when being served.
func Validate(e *Endpoint) error {
if e == nil {
return errors.New("endpoint is nil")

2
api/router/options.go
View File

@ -54,7 +54,7 @@ func WithResolver(r resolver.Resolver) Option {
}
}
// WithLogger sets the underline logger
// WithLogger sets the underline logger.
func WithLogger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

14
api/router/registry/registry.go
View File

@ -18,14 +18,14 @@ import (
"go-micro.dev/v4/registry/cache"
)
// endpoint struct, that holds compiled pcre
// endpoint struct, that holds compiled pcre.
type endpoint struct {
hostregs []*regexp.Regexp
pathregs []util.Pattern
pcreregs []*regexp.Regexp
}
// router is the default router
// router is the default router.
type registryRouter struct {
exit chan bool
opts router.Options
@ -48,7 +48,7 @@ func (r *registryRouter) isStopped() bool {
}
}
// refresh list of api services
// refresh list of api services.
func (r *registryRouter) refresh() {
var attempts int
logger := r.Options().Logger
@ -84,7 +84,7 @@ func (r *registryRouter) refresh() {
}
}
// process watch event
// process watch event.
func (r *registryRouter) process(res *registry.Result) {
logger := r.Options().Logger
// skip these things
@ -103,7 +103,7 @@ func (r *registryRouter) process(res *registry.Result) {
r.store(service)
}
// store local endpoint cache
// store local endpoint cache.
func (r *registryRouter) store(services []*registry.Service) {
logger := r.Options().Logger
// endpoints
@ -209,7 +209,7 @@ func (r *registryRouter) store(services []*registry.Service) {
}
}
// watch for endpoint changes
// watch for endpoint changes.
func (r *registryRouter) watch() {
var attempts int
logger := r.Options().Logger
@ -467,7 +467,7 @@ func newRouter(opts ...router.Option) *registryRouter {
return r
}
// NewRouter returns the default router
// NewRouter returns the default router.
func NewRouter(opts ...router.Option) router.Router {
return newRouter(opts...)
}

4
api/router/router.go
View File

@ -7,7 +7,7 @@ import (
"go-micro.dev/v4/registry"
)
// Router is used to determine an endpoint for a request
// Router is used to determine an endpoint for a request.
type Router interface {
// Returns options
Options() Options
@ -30,7 +30,7 @@ type Route struct {
Versions []*registry.Service
}
// Endpoint is a mapping between an RPC method and HTTP endpoint
// Endpoint is a mapping between an RPC method and HTTP endpoint.
type Endpoint struct {
// RPC Method e.g. Greeter.Hello
Name string

4
api/router/static/static.go
View File

@ -23,7 +23,7 @@ type endpoint struct {
pcreregs []*regexp.Regexp
}
// router is the default router
// router is the default router.
type staticRouter struct {
exit chan bool
opts router.Options
@ -341,7 +341,7 @@ func NewRouter(opts ...router.Option) *staticRouter {
opts: options,
eps: make(map[string]*endpoint),
}
//go r.watch()
// go r.watch()
//go r.refresh()
return r
}

2
api/router/util/parse.go
View File

@ -19,7 +19,7 @@ func (e InvalidTemplateError) Error() string {
return fmt.Sprintf("%s: %s", e.msg, e.tmpl)
}
// Parse parses the string representation of path template
// Parse parses the string representation of path template.
func Parse(tmpl string) (Compiler, error) {
if !strings.HasPrefix(tmpl, "/") {
return template{}, InvalidTemplateError{tmpl: tmpl, msg: "no leading /"}

12
api/router/util/pattern.go
View File

@ -7,17 +7,17 @@ type OpCode int
// These constants are the valid values of OpCode.
const (
// OpNop does nothing
// OpNop does nothing.
OpNop = OpCode(iota)
// OpPush pushes a component to stack
// OpPush pushes a component to stack.
OpPush
// OpLitPush pushes a component to stack if it matches to the literal
// OpLitPush pushes a component to stack if it matches to the literal.
OpLitPush
// OpPushM concatenates the remaining components and pushes it to stack
// OpPushM concatenates the remaining components and pushes it to stack.
OpPushM
// OpConcatN pops N items from stack, concatenates them and pushes it back to stack
// OpConcatN pops N items from stack, concatenates them and pushes it back to stack.
OpConcatN
// OpCapture pops an item and binds it to the variable
// OpCapture pops an item and binds it to the variable.
OpCapture
// OpEnd is the least positive invalid opcode.
OpEnd

2
api/router/util/runtime.go
View File

@ -49,7 +49,7 @@ type patternOptions struct {
// PatternOpt is an option for creating Patterns.
type PatternOpt func(*patternOptions)
// Logger sets the logger
// Logger sets the logger.
func PatternLogger(l log.Logger) PatternOpt {
return func(po *patternOptions) {
po.logger = l

6
api/server/acme/acme.go
View File

@ -9,11 +9,11 @@ import (
var (
// ErrProviderNotImplemented can be returned when attempting to
// instantiate an unimplemented provider
// instantiate an unimplemented provider.
ErrProviderNotImplemented = errors.New("Provider not implemented")
)
// Provider is a ACME provider interface
// Provider is a ACME provider interface.
type Provider interface {
// Listen returns a new listener
Listen(...string) (net.Listener, error)
@ -21,7 +21,7 @@ type Provider interface {
TLSConfig(...string) (*tls.Config, error)
}
// The Let's Encrypt ACME endpoints
// The Let's Encrypt ACME endpoints.
const (
LetsEncryptStagingCA = "https://acme-staging-v02.api.letsencrypt.org/directory"
LetsEncryptProductionCA = "https://acme-v02.api.letsencrypt.org/directory"

8
api/server/acme/autocert/autocert.go
View File

@ -13,17 +13,17 @@ import (
log "go-micro.dev/v4/logger"
)
// autoCertACME is the ACME provider from golang.org/x/crypto/acme/autocert
// autoCertACME is the ACME provider from golang.org/x/crypto/acme/autocert.
type autocertProvider struct {
logger log.Logger
}
// Listen implements acme.Provider
// Listen implements acme.Provider.
func (a *autocertProvider) Listen(hosts ...string) (net.Listener, error) {
return autocert.NewListener(hosts...), nil
}
// TLSConfig returns a new tls config
// TLSConfig returns a new tls config.
func (a *autocertProvider) TLSConfig(hosts ...string) (*tls.Config, error) {
logger := log.LoggerOrDefault(a.logger)
// create a new manager
@ -42,7 +42,7 @@ func (a *autocertProvider) TLSConfig(hosts ...string) (*tls.Config, error) {
return m.TLSConfig(), nil
}
// New returns an autocert acme.Provider
// New returns an autocert acme.Provider.
func NewProvider() acme.Provider {
return &autocertProvider{}
}

12
api/server/acme/options.go
View File

@ -6,10 +6,10 @@ import (
"go-micro.dev/v4/logger"
)
// Option (or Options) are passed to New() to configure providers
// Option (or Options) are passed to New() to configure providers.
type Option func(o *Options)
// Options represents various options you can present to ACME providers
// Options represents various options you can present to ACME providers.
type Options struct {
// AcceptTLS must be set to true to indicate that you have read your
// provider's terms of service.
@ -31,14 +31,14 @@ type Options struct {
Logger logger.Logger
}
// AcceptToS indicates whether you accept your CA's terms of service
// AcceptToS indicates whether you accept your CA's terms of service.
func AcceptToS(b bool) Option {
return func(o *Options) {
o.AcceptToS = b
}
}
// CA sets the CA of an acme.Options
// CA sets the CA of an acme.Options.
func CA(CA string) Option {
return func(o *Options) {
o.CA = CA
@ -63,14 +63,14 @@ func OnDemand(b bool) Option {
// Cache provides a cache / storage interface to the underlying ACME library
// as there is no standard, this needs to be validated by the underlying
// implentation.
// implementation.
func Cache(c interface{}) Option {
return func(o *Options) {
o.Cache = c
}
}
// Logger sets the underline logger
// Logger sets the underline logger.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

6
api/server/cors/cors.go
View File

@ -11,7 +11,7 @@ type Config struct {
AllowHeaders string
}
// CombinedCORSHandler wraps a server and provides CORS headers
// CombinedCORSHandler wraps a server and provides CORS headers.
func CombinedCORSHandler(h http.Handler, config *Config) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if config != nil {
@ -25,7 +25,7 @@ func CombinedCORSHandler(h http.Handler, config *Config) http.Handler {
})
}
// SetHeaders sets the CORS headers
// SetHeaders sets the CORS headers.
func SetHeaders(w http.ResponseWriter, _ *http.Request, config *Config) {
set := func(w http.ResponseWriter, k, v string) {
if v := w.Header().Get(k); len(v) > 0 {
@ -33,7 +33,7 @@ func SetHeaders(w http.ResponseWriter, _ *http.Request, config *Config) {
}
w.Header().Set(k, v)
}
//For forward-compatible code, default values may not be provided in the future
// For forward-compatible code, default values may not be provided in the future
if config.AllowCredentials {
set(w, "Access-Control-Allow-Credentials", "true")
} else {

2
api/server/http/http.go
View File

@ -94,7 +94,7 @@ func (s *httpServer) Start() error {
go func() {
if err := http.Serve(l, s.mux); err != nil {
// temporary fix
//logger.Log(log.FatalLevel, err)
// logger.Log(log.FatalLevel, err)
logger.Log(log.ErrorLevel, err)
}
}()

5
api/server/http/http_test.go
View File

@ -2,11 +2,12 @@ package http
import (
"fmt"
"go-micro.dev/v4/api/server"
"go-micro.dev/v4/api/server/cors"
"io"
"net/http"
"testing"
"go-micro.dev/v4/api/server"
"go-micro.dev/v4/api/server/cors"
)
func TestHTTPServer(t *testing.T) {

2
api/server/options.go
View File

@ -94,7 +94,7 @@ func Resolver(r resolver.Resolver) Option {
}
}
// Logger sets the underline logging framework
// Logger sets the underline logging framework.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

2
api/server/server.go
View File

@ -5,7 +5,7 @@ import (
"net/http"
)
// Server serves api requests
// Server serves api requests.
type Server interface {
Address() string
Init(opts ...Option) error

34
auth/auth.go
View File

@ -8,22 +8,22 @@ import (
)
const (
// BearerScheme used for Authorization header
// BearerScheme used for Authorization header.
BearerScheme = "Bearer "
// ScopePublic is the scope applied to a rule to allow access to the public
// ScopePublic is the scope applied to a rule to allow access to the public.
ScopePublic = ""
// ScopeAccount is the scope applied to a rule to limit to users with any valid account
// ScopeAccount is the scope applied to a rule to limit to users with any valid account.
ScopeAccount = "*"
)
var (
// ErrInvalidToken is when the token provided is not valid
// ErrInvalidToken is when the token provided is not valid.
ErrInvalidToken = errors.New("invalid token provided")
// ErrForbidden is when a user does not have the necessary scope to access a resource
// ErrForbidden is when a user does not have the necessary scope to access a resource.
ErrForbidden = errors.New("resource forbidden")
)
// Auth provides authentication and authorization
// Auth provides authentication and authorization.
type Auth interface {
// Init the auth
Init(opts ...Option)
@ -39,7 +39,7 @@ type Auth interface {
String() string
}
// Rules manages access to resources
// Rules manages access to resources.
type Rules interface {
// Verify an account has access to a resource using the rules
Verify(acc *Account, res *Resource, opts ...VerifyOption) error
@ -51,7 +51,7 @@ type Rules interface {
List(...ListOption) ([]*Rule, error)
}
// Account provided by an auth provider
// Account provided by an auth provider.
type Account struct {
// ID of the account e.g. email
ID string `json:"id"`
@ -67,7 +67,7 @@ type Account struct {
Secret string `json:"secret"`
}
// Token can be short or long lived
// Token can be short or long lived.
type Token struct {
// The token to be used for accessing resources
AccessToken string `json:"access_token"`
@ -79,12 +79,12 @@ type Token struct {
Expiry time.Time `json:"expiry"`
}
// Expired returns a boolean indicating if the token needs to be refreshed
// Expired returns a boolean indicating if the token needs to be refreshed.
func (t *Token) Expired() bool {
return t.Expiry.Unix() < time.Now().Unix()
}
// Resource is an entity such as a user or
// Resource is an entity such as a user or.
type Resource struct {
// Name of the resource, e.g. go.micro.service.notes
Name string `json:"name"`
@ -94,17 +94,17 @@ type Resource struct {
Endpoint string `json:"endpoint"`
}
// Access defines the type of access a rule grants
// Access defines the type of access a rule grants.
type Access int
const (
// AccessGranted to a resource
// AccessGranted to a resource.
AccessGranted Access = iota
// AccessDenied to a resource
// AccessDenied to a resource.
AccessDenied
)
// Rule is used to verify access to a resource
// Rule is used to verify access to a resource.
type Rule struct {
// ID of the rule, e.g. "public"
ID string
@ -125,13 +125,13 @@ type accountKey struct{}
// AccountFromContext gets the account from the context, which
// is set by the auth wrapper at the start of a call. If the account
// is not set, a nil account will be returned. The error is only returned
// when there was a problem retrieving an account
// when there was a problem retrieving an account.
func AccountFromContext(ctx context.Context) (*Account, bool) {
acc, ok := ctx.Value(accountKey{}).(*Account)
return acc, ok
}
// ContextWithAccount sets the account in the context
// ContextWithAccount sets the account in the context.
func ContextWithAccount(ctx context.Context, account *Account) context.Context {
return context.WithValue(ctx, accountKey{}, account)
}

18
auth/noop.go
View File

@ -30,24 +30,24 @@ type noop struct {
type noopRules struct{}
// String returns the name of the implementation
// String returns the name of the implementation.
func (n *noop) String() string {
return "noop"
}
// Init the auth
// Init the auth.
func (n *noop) Init(opts ...Option) {
for _, o := range opts {
o(&n.opts)
}
}
// Options set for auth
// Options set for auth.
func (n *noop) Options() Options {
return n.opts
}
// Generate a new account
// Generate a new account.
func (n *noop) Generate(id string, opts ...GenerateOption) (*Account, error) {
options := NewGenerateOptions(opts...)
@ -60,18 +60,18 @@ func (n *noop) Generate(id string, opts ...GenerateOption) (*Account, error) {
}, nil
}
// Grant access to a resource
// Grant access to a resource.
func (n *noopRules) Grant(rule *Rule) error {
return nil
}
// Revoke access to a resource
// Revoke access to a resource.
func (n *noopRules) Revoke(rule *Rule) error {
return nil
}
// Rules used to verify requests
// Verify an account has access to a resource
// Verify an account has access to a resource.
func (n *noopRules) Verify(acc *Account, res *Resource, opts ...VerifyOption) error {
return nil
}
@ -80,12 +80,12 @@ func (n *noopRules) List(opts ...ListOption) ([]*Rule, error) {
return []*Rule{}, nil
}
// Inspect a token
// Inspect a token.
func (n *noop) Inspect(token string) (*Account, error) {
return &Account{ID: uuid.New().String(), Issuer: n.Options().Namespace}, nil
}
// Token generation using an account id and secret
// Token generation using an account id and secret.
func (n *noop) Token(opts ...TokenOption) (*Token, error) {
return &Token{}, nil
}

32
auth/options.go
View File

@ -40,42 +40,42 @@ type Options struct {
type Option func(o *Options)
// Addrs is the auth addresses to use
// Addrs is the auth addresses to use.
func Addrs(addrs ...string) Option {
return func(o *Options) {
o.Addrs = addrs
}
}
// Namespace the service belongs to
// Namespace the service belongs to.
func Namespace(n string) Option {
return func(o *Options) {
o.Namespace = n
}
}
// PublicKey is the JWT public key
// PublicKey is the JWT public key.
func PublicKey(key string) Option {
return func(o *Options) {
o.PublicKey = key
}
}
// PrivateKey is the JWT private key
// PrivateKey is the JWT private key.
func PrivateKey(key string) Option {
return func(o *Options) {
o.PrivateKey = key
}
}
// WithLogger sets the underline logger
// WithLogger sets the underline logger.
func WithLogger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}
// Credentials sets the auth credentials
// Credentials sets the auth credentials.
func Credentials(id, secret string) Option {
return func(o *Options) {
o.ID = id
@ -83,7 +83,7 @@ func Credentials(id, secret string) Option {
}
}
// ClientToken sets the auth token to use when making requests
// ClientToken sets the auth token to use when making requests.
func ClientToken(token *Token) Option {
return func(o *Options) {
o.Token = token
@ -105,42 +105,42 @@ type GenerateOptions struct {
type GenerateOption func(o *GenerateOptions)
// WithSecret for the generated account
// WithSecret for the generated account.
func WithSecret(s string) GenerateOption {
return func(o *GenerateOptions) {
o.Secret = s
}
}
// WithType for the generated account
// WithType for the generated account.
func WithType(t string) GenerateOption {
return func(o *GenerateOptions) {
o.Type = t
}
}
// WithMetadata for the generated account
// WithMetadata for the generated account.
func WithMetadata(md map[string]string) GenerateOption {
return func(o *GenerateOptions) {
o.Metadata = md
}
}
// WithProvider for the generated account
// WithProvider for the generated account.
func WithProvider(p string) GenerateOption {
return func(o *GenerateOptions) {
o.Provider = p
}
}
// WithScopes for the generated account
// WithScopes for the generated account.
func WithScopes(s ...string) GenerateOption {
return func(o *GenerateOptions) {
o.Scopes = s
}
}
// NewGenerateOptions from a slice of options
// NewGenerateOptions from a slice of options.
func NewGenerateOptions(opts ...GenerateOption) GenerateOptions {
var options GenerateOptions
for _, o := range opts {
@ -162,7 +162,7 @@ type TokenOptions struct {
type TokenOption func(o *TokenOptions)
// WithExpiry for the token
// WithExpiry for the token.
func WithExpiry(ex time.Duration) TokenOption {
return func(o *TokenOptions) {
o.Expiry = ex
@ -182,14 +182,14 @@ func WithToken(rt string) TokenOption {
}
}
// NewTokenOptions from a slice of options
// NewTokenOptions from a slice of options.
func NewTokenOptions(opts ...TokenOption) TokenOptions {
var options TokenOptions
for _, o := range opts {
o(&options)
}
// set defualt expiry of token
// set default expiry of token
if options.Expiry == 0 {
options.Expiry = time.Minute
}

2
auth/rules.go
View File

@ -8,7 +8,7 @@ import (
// Verify an account has access to a resource using the rules provided. If the account does not have
// access an error will be returned. If there are no rules provided which match the resource, an error
// will be returned
// will be returned.
func Verify(rules []*Rule, acc *Account, res *Resource) error {
// the rule is only to be applied if the type matches the resource or is catch-all (*)
validTypes := []string{"*", res.Type}

38
auth/rules_test.go
View File

@ -42,7 +42,7 @@ func TestVerify(t *testing.T) {
Account: &Account{},
Resource: srvResource,
Rules: []*Rule{
&Rule{
{
Scope: "",
Resource: catchallResource,
},
@ -52,7 +52,7 @@ func TestVerify(t *testing.T) {
Name: "CatchallPublicNoAccount",
Resource: srvResource,
Rules: []*Rule{
&Rule{
{
Scope: "",
Resource: catchallResource,
},
@ -63,7 +63,7 @@ func TestVerify(t *testing.T) {
Account: &Account{},
Resource: srvResource,
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
},
@ -73,7 +73,7 @@ func TestVerify(t *testing.T) {
Name: "CatchallPrivateNoAccount",
Resource: srvResource,
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
},
@ -85,7 +85,7 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: srvResource.Type,
@ -100,7 +100,7 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: srvResource.Type,
@ -118,7 +118,7 @@ func TestVerify(t *testing.T) {
Scopes: []string{"neededscope"},
},
Rules: []*Rule{
&Rule{
{
Scope: "neededscope",
Resource: srvResource,
},
@ -131,7 +131,7 @@ func TestVerify(t *testing.T) {
Scopes: []string{"neededscope"},
},
Rules: []*Rule{
&Rule{
{
Scope: "invalidscope",
Resource: srvResource,
},
@ -143,7 +143,7 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessDenied,
@ -156,7 +156,7 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessDenied,
@ -169,13 +169,13 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessGranted,
Priority: 1,
},
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessDenied,
@ -188,13 +188,13 @@ func TestVerify(t *testing.T) {
Resource: srvResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessGranted,
Priority: 0,
},
&Rule{
{
Scope: "*",
Resource: catchallResource,
Access: AccessDenied,
@ -208,7 +208,7 @@ func TestVerify(t *testing.T) {
Resource: webResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: webResource,
},
@ -219,7 +219,7 @@ func TestVerify(t *testing.T) {
Resource: webResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: webResource.Type,
@ -235,7 +235,7 @@ func TestVerify(t *testing.T) {
Resource: webResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: webResource.Type,
@ -250,7 +250,7 @@ func TestVerify(t *testing.T) {
Resource: webResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: webResource.Type,
@ -265,7 +265,7 @@ func TestVerify(t *testing.T) {
Resource: webResource,
Account: &Account{},
Rules: []*Rule{
&Rule{
{
Scope: "*",
Resource: &Resource{
Type: webResource.Type,

4
broker/broker.go
View File

@ -23,7 +23,7 @@ type Message struct {
Body []byte
}
// Event is given to a subscription handler for processing
// Event is given to a subscription handler for processing.
type Event interface {
Topic() string
Message() *Message
@ -31,7 +31,7 @@ type Event interface {
Error() error
}
// Subscriber is a convenience return type for the Subscribe method
// Subscriber is a convenience return type for the Subscribe method.
type Subscriber interface {
Options() SubscribeOptions
Topic() string

6
broker/http.go
View File

@ -27,7 +27,7 @@ import (
mls "go-micro.dev/v4/util/tls"
)
// HTTP Broker is a point to point async broker
// HTTP Broker is a point to point async broker.
type httpBroker struct {
id string
address string
@ -315,7 +315,7 @@ func (h *httpBroker) ServeHTTP(w http.ResponseWriter, req *http.Request) {
}
topic := m.Header["Micro-Topic"]
//delete(m.Header, ":topic")
// delete(m.Header, ":topic")
if len(topic) == 0 {
errr := merr.InternalServerError("go.micro.broker", "Topic not found")
@ -703,7 +703,7 @@ func (h *httpBroker) String() string {
return "http"
}
// NewBroker returns a new http broker
// NewBroker returns a new http broker.
func NewBroker(opts ...Option) Broker {
return newHttpBroker(opts...)
}

2
broker/http_test.go
View File

@ -11,7 +11,7 @@ import (
)
var (
// mock data
// mock data.
testData = map[string][]*registry.Service{
"foo": {
{

18
broker/options.go
View File

@ -53,7 +53,7 @@ type Option func(*Options)
type PublishOption func(*PublishOptions)
// PublishContext set context
// PublishContext set context.
func PublishContext(ctx context.Context) PublishOption {
return func(o *PublishOptions) {
o.Context = ctx
@ -87,7 +87,7 @@ func NewSubscribeOptions(opts ...SubscribeOption) SubscribeOptions {
return opt
}
// Addrs sets the host addresses to be used by the broker
// Addrs sets the host addresses to be used by the broker.
func Addrs(addrs ...string) Option {
return func(o *Options) {
o.Addrs = addrs
@ -95,7 +95,7 @@ func Addrs(addrs ...string) Option {
}
// Codec sets the codec used for encoding/decoding used where
// a broker does not support headers
// a broker does not support headers.
func Codec(c codec.Marshaler) Option {
return func(o *Options) {
o.Codec = c
@ -111,14 +111,14 @@ func DisableAutoAck() SubscribeOption {
}
// ErrorHandler will catch all broker errors that cant be handled
// in normal way, for example Codec errors
// in normal way, for example Codec errors.
func ErrorHandler(h Handler) Option {
return func(o *Options) {
o.ErrorHandler = h
}
}
// Queue sets the name of the queue to share messages on
// Queue sets the name of the queue to share messages on.
func Queue(name string) SubscribeOption {
return func(o *SubscribeOptions) {
o.Queue = name
@ -131,28 +131,28 @@ func Registry(r registry.Registry) Option {
}
}
// Secure communication with the broker
// Secure communication with the broker.
func Secure(b bool) Option {
return func(o *Options) {
o.Secure = b
}
}
// Specify TLS Config
// Specify TLS Config.
func TLSConfig(t *tls.Config) Option {
return func(o *Options) {
o.TLSConfig = t
}
}
// Logger sets the underline logger
// Logger sets the underline logger.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}
// SubscribeContext set context
// SubscribeContext set context.
func SubscribeContext(ctx context.Context) SubscribeOption {
return func(o *SubscribeOptions) {
o.Context = ctx

6
cache/options.go vendored
View File

@ -36,21 +36,21 @@ func Items(i map[string]Item) Option {
}
}
// WithAddress sets the cache service address or connection information
// WithAddress sets the cache service address or connection information.
func WithAddress(addr string) Option {
return func(o *Options) {
o.Address = addr
}
}
// WithContext sets the cache context, for any extra configuration
// WithContext sets the cache context, for any extra configuration.
func WithContext(c context.Context) Option {
return func(o *Options) {
o.Context = c
}
}
// WithLogger sets underline logger
// WithLogger sets underline logger.
func WithLogger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

12
client/cache.go
View File

@ -11,29 +11,29 @@ import (
"go-micro.dev/v4/metadata"
)
// NewCache returns an initialised cache.
// NewCache returns an initialized cache.
func NewCache() *Cache {
return &Cache{
cache: cache.New(cache.NoExpiration, 30*time.Second),
}
}
// Cache for responses
// Cache for responses.
type Cache struct {
cache *cache.Cache
}
// Get a response from the cache
// Get a response from the cache.
func (c *Cache) Get(ctx context.Context, req *Request) (interface{}, bool) {
return c.cache.Get(key(ctx, req))
}
// Set a response in the cache
// Set a response in the cache.
func (c *Cache) Set(ctx context.Context, req *Request, rsp interface{}, expiry time.Duration) {
c.cache.Set(key(ctx, req), rsp, expiry)
}
// List the key value pairs in the cache
// List the key value pairs in the cache.
func (c *Cache) List() map[string]string {
items := c.cache.Items()
@ -46,7 +46,7 @@ func (c *Cache) List() map[string]string {
return rsp
}
// key returns a hash for the context and request
// key returns a hash for the context and request.
func key(ctx context.Context, req *Request) string {
ns, _ := metadata.Get(ctx, "Micro-Namespace")

44
client/client.go
View File

@ -22,19 +22,19 @@ type Client interface {
String() string
}
// Router manages request routing
// Router manages request routing.
type Router interface {
SendRequest(context.Context, Request) (Response, error)
}
// Message is the interface for publishing asynchronously
// Message is the interface for publishing asynchronously.
type Message interface {
Topic() string
Payload() interface{}
ContentType() string
}
// Request is the interface for a synchronous request used by Call or Stream
// Request is the interface for a synchronous request used by Call or Stream.
type Request interface {
// The service to call
Service() string
@ -52,7 +52,7 @@ type Request interface {
Stream() bool
}
// Response is the response received from a service
// Response is the response received from a service.
type Response interface {
// Read the response
Codec() codec.Reader
@ -62,7 +62,7 @@ type Response interface {
Read() ([]byte, error)
}
// Stream is the inteface for a bidirectional synchronous stream
// Stream is the inteface for a bidirectional synchronous stream.
type Stream interface {
Closer
// Context for the stream
@ -81,48 +81,48 @@ type Stream interface {
Close() error
}
// Closer handle client close
// Closer handle client close.
type Closer interface {
// CloseSend closes the send direction of the stream.
CloseSend() error
}
// Option used by the Client
// Option used by the Client.
type Option func(*Options)
// CallOption used by Call or Stream
// CallOption used by Call or Stream.
type CallOption func(*CallOptions)
// PublishOption used by Publish
// PublishOption used by Publish.
type PublishOption func(*PublishOptions)
// MessageOption used by NewMessage
// MessageOption used by NewMessage.
type MessageOption func(*MessageOptions)
// RequestOption used by NewRequest
// RequestOption used by NewRequest.
type RequestOption func(*RequestOptions)
var (
// DefaultClient is a default client to use out of the box
// DefaultClient is a default client to use out of the box.
DefaultClient Client = newRpcClient()
// DefaultBackoff is the default backoff function for retries
// DefaultBackoff is the default backoff function for retries.
DefaultBackoff = exponentialBackoff
// DefaultRetry is the default check-for-retry function for retries
// DefaultRetry is the default check-for-retry function for retries.
DefaultRetry = RetryOnError
// DefaultRetries is the default number of times a request is tried
// DefaultRetries is the default number of times a request is tried.
DefaultRetries = 1
// DefaultRequestTimeout is the default request timeout
// DefaultRequestTimeout is the default request timeout.
DefaultRequestTimeout = time.Second * 5
// DefaultPoolSize sets the connection pool size
// DefaultPoolSize sets the connection pool size.
DefaultPoolSize = 100
// DefaultPoolTTL sets the connection pool ttl
// DefaultPoolTTL sets the connection pool ttl.
DefaultPoolTTL = time.Minute
// NewClient returns a new client
// NewClient returns a new client.
NewClient func(...Option) Client = newRpcClient
)
// Makes a synchronous call to a service using the default client
// Makes a synchronous call to a service using the default client.
func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error {
return DefaultClient.Call(ctx, request, response, opts...)
}
@ -133,13 +133,13 @@ func Publish(ctx context.Context, msg Message, opts ...PublishOption) error {
return DefaultClient.Publish(ctx, msg, opts...)
}
// Creates a new message using the default client
// Creates a new message using the default client.
func NewMessage(topic string, payload interface{}, opts ...MessageOption) Message {
return DefaultClient.NewMessage(topic, payload, opts...)
}
// Creates a new request using the default client. Content Type will
// be set to the default within options and use the appropriate codec
// be set to the default within options and use the appropriate codec.
func NewRequest(service, endpoint string, request interface{}, reqOpts ...RequestOption) Request {
return DefaultClient.NewRequest(service, endpoint, request, reqOpts...)
}

2
client/common_test.go
View File

@ -5,7 +5,7 @@ import (
)
var (
// mock data
// mock data.
testData = map[string][]*registry.Service{
"foo": {
{

54
client/options.go
View File

@ -127,42 +127,42 @@ func NewOptions(options ...Option) Options {
return opts
}
// Broker to be used for pub/sub
// Broker to be used for pub/sub.
func Broker(b broker.Broker) Option {
return func(o *Options) {
o.Broker = b
}
}
// Codec to be used to encode/decode requests for a given content type
// Codec to be used to encode/decode requests for a given content type.
func Codec(contentType string, c codec.NewCodec) Option {
return func(o *Options) {
o.Codecs[contentType] = c
}
}
// Default content type of the client
// Default content type of the client.
func ContentType(ct string) Option {
return func(o *Options) {
o.ContentType = ct
}
}
// PoolSize sets the connection pool size
// PoolSize sets the connection pool size.
func PoolSize(d int) Option {
return func(o *Options) {
o.PoolSize = d
}
}
// PoolTTL sets the connection pool ttl
// PoolTTL sets the connection pool ttl.
func PoolTTL(d time.Duration) Option {
return func(o *Options) {
o.PoolTTL = d
}
}
// Registry to find nodes for a given service
// Registry to find nodes for a given service.
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Registry = r
@ -171,28 +171,28 @@ func Registry(r registry.Registry) Option {
}
}
// Transport to use for communication e.g http, rabbitmq, etc
// Transport to use for communication e.g http, rabbitmq, etc.
func Transport(t transport.Transport) Option {
return func(o *Options) {
o.Transport = t
}
}
// Select is used to select a node to route a request to
// Select is used to select a node to route a request to.
func Selector(s selector.Selector) Option {
return func(o *Options) {
o.Selector = s
}
}
// Adds a Wrapper to a list of options passed into the client
// Adds a Wrapper to a list of options passed into the client.
func Wrap(w Wrapper) Option {
return func(o *Options) {
o.Wrappers = append(o.Wrappers, w)
}
}
// Adds a Wrapper to the list of CallFunc wrappers
// Adds a Wrapper to the list of CallFunc wrappers.
func WrapCall(cw ...CallWrapper) Option {
return func(o *Options) {
o.CallOptions.CallWrappers = append(o.CallOptions.CallWrappers, cw...)
@ -200,7 +200,7 @@ func WrapCall(cw ...CallWrapper) Option {
}
// Backoff is used to set the backoff function used
// when retrying Calls
// when retrying Calls.
func Backoff(fn BackoffFunc) Option {
return func(o *Options) {
o.CallOptions.Backoff = fn
@ -230,14 +230,14 @@ func RequestTimeout(d time.Duration) Option {
}
}
// StreamTimeout sets the stream timeout
// StreamTimeout sets the stream timeout.
func StreamTimeout(d time.Duration) Option {
return func(o *Options) {
o.CallOptions.StreamTimeout = d
}
}
// Transport dial timeout
// Transport dial timeout.
func DialTimeout(d time.Duration) Option {
return func(o *Options) {
o.CallOptions.DialTimeout = d
@ -246,21 +246,21 @@ func DialTimeout(d time.Duration) Option {
// Call Options
// WithExchange sets the exchange to route a message through
// WithExchange sets the exchange to route a message through.
func WithExchange(e string) PublishOption {
return func(o *PublishOptions) {
o.Exchange = e
}
}
// PublishContext sets the context in publish options
// PublishContext sets the context in publish options.
func PublishContext(ctx context.Context) PublishOption {
return func(o *PublishOptions) {
o.Context = ctx
}
}
// WithAddress sets the remote addresses to use rather than using service discovery
// WithAddress sets the remote addresses to use rather than using service discovery.
func WithAddress(a ...string) CallOption {
return func(o *CallOptions) {
o.Address = a
@ -273,7 +273,7 @@ func WithSelectOption(so ...selector.SelectOption) CallOption {
}
}
// WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers
// WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers.
func WithCallWrapper(cw ...CallWrapper) CallOption {
return func(o *CallOptions) {
o.CallWrappers = append(o.CallWrappers, cw...)
@ -281,7 +281,7 @@ func WithCallWrapper(cw ...CallWrapper) CallOption {
}
// WithBackoff is a CallOption which overrides that which
// set in Options.CallOptions
// set in Options.CallOptions.
func WithBackoff(fn BackoffFunc) CallOption {
return func(o *CallOptions) {
o.Backoff = fn
@ -289,7 +289,7 @@ func WithBackoff(fn BackoffFunc) CallOption {
}
// WithRetry is a CallOption which overrides that which
// set in Options.CallOptions
// set in Options.CallOptions.
func WithRetry(fn RetryFunc) CallOption {
return func(o *CallOptions) {
o.Retry = fn
@ -297,7 +297,7 @@ func WithRetry(fn RetryFunc) CallOption {
}
// WithRetries is a CallOption which overrides that which
// set in Options.CallOptions
// set in Options.CallOptions.
func WithRetries(i int) CallOption {
return func(o *CallOptions) {
o.Retries = i
@ -305,14 +305,14 @@ func WithRetries(i int) CallOption {
}
// WithRequestTimeout is a CallOption which overrides that which
// set in Options.CallOptions
// set in Options.CallOptions.
func WithRequestTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.RequestTimeout = d
}
}
// WithStreamTimeout sets the stream timeout
// WithStreamTimeout sets the stream timeout.
func WithStreamTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.StreamTimeout = d
@ -320,7 +320,7 @@ func WithStreamTimeout(d time.Duration) CallOption {
}
// WithDialTimeout is a CallOption which overrides that which
// set in Options.CallOptions
// set in Options.CallOptions.
func WithDialTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.DialTimeout = d
@ -328,7 +328,7 @@ func WithDialTimeout(d time.Duration) CallOption {
}
// WithServiceToken is a CallOption which overrides the
// authorization header with the services own auth token
// authorization header with the services own auth token.
func WithServiceToken() CallOption {
return func(o *CallOptions) {
o.ServiceToken = true
@ -336,7 +336,7 @@ func WithServiceToken() CallOption {
}
// WithCache is a CallOption which sets the duration the response
// shoull be cached for
// shoull be cached for.
func WithCache(c time.Duration) CallOption {
return func(o *CallOptions) {
o.CacheExpiry = c
@ -363,14 +363,14 @@ func StreamingRequest() RequestOption {
}
}
// WithRouter sets the client router
// WithRouter sets the client router.
func WithRouter(r Router) Option {
return func(o *Options) {
o.Router = r
}
}
// WithLogger sets the underline logger
// WithLogger sets the underline logger.
func WithLogger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l

2
client/options_test.go
View File

@ -78,8 +78,6 @@ func TestCallOptions(t *testing.T) {
if e := o.CallOptions.DialTimeout * (time.Second * 10); callOpts.DialTimeout != e {
t.Fatalf("Expected %v got %v", e, callOpts.DialTimeout)
}
}
}
}

6
client/retry.go
View File

@ -6,15 +6,15 @@ import (
"go-micro.dev/v4/errors"
)
// note that returning either false or a non-nil error will result in the call not being retried
// note that returning either false or a non-nil error will result in the call not being retried.
type RetryFunc func(ctx context.Context, req Request, retryCount int, err error) (bool, error)
// RetryAlways always retry on error
// RetryAlways always retry on error.
func RetryAlways(ctx context.Context, req Request, retryCount int, err error) (bool, error) {
return true, nil
}
// RetryOnError retries a request on a 500 or timeout error
// RetryOnError retries a request on a 500 or timeout error.
func RetryOnError(ctx context.Context, req Request, retryCount int, err error) (bool, error) {
if err == nil {
return false, nil

2
client/rpc_client.go
View File

@ -320,7 +320,7 @@ func (r *rpcClient) Options() Options {
return r.opts
}
// next returns an iterator for the next nodes to call
// next returns an iterator for the next nodes to call.
func (r *rpcClient) next(request Request, opts CallOptions) (selector.Next, error) {
// try get the proxy
service, address, _ := net.Proxy(request.Service(), opts.Address)

1
client/rpc_client_test.go
View File

@ -58,7 +58,6 @@ func TestCallAddress(t *testing.T) {
if !called {
t.Fatal("wrapper not called")
}
}
func TestCallRetry(t *testing.T) {

6
client/rpc_codec.go
View File

@ -28,7 +28,7 @@ func (e serverError) Error() string {
return string(e)
}
// errShutdown holds the specific error for closing/closed connections
// errShutdown holds the specific error for closing/closed connections.
var (
errShutdown = errs.New("connection is shut down")
)
@ -63,7 +63,7 @@ var (
"application/octet-stream": raw.NewCodec,
}
// TODO: remove legacy codec list
// TODO: remove legacy codec list.
defaultCodecs = map[string]codec.NewCodec{
"application/json": jsonrpc.NewCodec,
"application/json-rpc": jsonrpc.NewCodec,
@ -127,7 +127,7 @@ func setHeaders(m *codec.Message, stream string) {
}
}
// setupProtocol sets up the old protocol
// setupProtocol sets up the old protocol.
func setupProtocol(msg *transport.Message, node *registry.Node) codec.NewCodec {
protocol := node.Metadata["protocol"]

2
client/rpc_stream.go
View File

@ -9,7 +9,7 @@ import (
"go-micro.dev/v4/codec"
)
// Implements the streamer interface
// Implements the streamer interface.
type rpcStream struct {
sync.RWMutex
id string

8
client/wrapper.go
View File

@ -6,14 +6,14 @@ import (
"go-micro.dev/v4/registry"
)
// CallFunc represents the individual call func
// CallFunc represents the individual call func.
type CallFunc func(ctx context.Context, node *registry.Node, req Request, rsp interface{}, opts CallOptions) error
// CallWrapper is a low level wrapper for the CallFunc
// CallWrapper is a low level wrapper for the CallFunc.
type CallWrapper func(CallFunc) CallFunc
// Wrapper wraps a client and returns a client
// Wrapper wraps a client and returns a client.
type Wrapper func(Client) Client
// StreamWrapper wraps a Stream and returns the equivalent
// StreamWrapper wraps a Stream and returns the equivalent.
type StreamWrapper func(Stream) Stream

2
codec/bytes/bytes.go
View File

@ -12,7 +12,7 @@ type Codec struct {
Conn io.ReadWriteCloser
}
// Frame gives us the ability to define raw data to send over the pipes
// Frame gives us the ability to define raw data to send over the pipes.
type Frame struct {
Data []byte
}

2
codec/codec.go
View File

@ -19,7 +19,7 @@ var (
type MessageType int
// Takes in a connection/buffer and returns a new Codec
// Takes in a connection/buffer and returns a new Codec.
type NewCodec func(io.ReadWriteCloser) Codec
// Codec encodes/decodes various types of messages used within go-micro.

2
codec/grpc/grpc.go
View File

@ -89,7 +89,7 @@ func (c *Codec) Write(m *codec.Message, b interface{}) error {
m.Header[":authority"] = m.Target
m.Header["content-type"] = c.ContentType
case codec.Response:
m.Header["Trailer"] = "grpc-status" //, grpc-message"
m.Header["Trailer"] = "grpc-status" // , grpc-message"
m.Header["content-type"] = c.ContentType
m.Header[":status"] = "200"
m.Header["grpc-status"] = "0"

2
codec/json/marshaler.go
View File

@ -11,7 +11,7 @@ import (
var jsonpbMarshaler = &jsonpb.Marshaler{}
// create buffer pool with 16 instances each preallocated with 256 bytes
// create buffer pool with 16 instances each preallocated with 256 bytes.
var bufferPool = bpool.NewSizedBufferPool(16, 256)
type Marshaler struct{}

6
codec/jsonrpc/jsonrpc.go
View File

@ -41,7 +41,7 @@ func (j *jsonCodec) Write(m *codec.Message, b interface{}) error {
_, err = j.rwc.Write(data)
return err
default:
return fmt.Errorf("Unrecognised message type: %v", m.Type)
return fmt.Errorf("Unrecognized message type: %v", m.Type)
}
}
@ -58,7 +58,7 @@ func (j *jsonCodec) ReadHeader(m *codec.Message, mt codec.MessageType) error {
_, err := io.Copy(j.buf, j.rwc)
return err
default:
return fmt.Errorf("Unrecognised message type: %v", mt)
return fmt.Errorf("Unrecognized message type: %v", mt)
}
}
@ -73,7 +73,7 @@ func (j *jsonCodec) ReadBody(b interface{}) error {
return json.Unmarshal(j.buf.Bytes(), b)
}
default:
return fmt.Errorf("Unrecognised message type: %v", j.mt)
return fmt.Errorf("Unrecognized message type: %v", j.mt)
}
return nil
}

2
codec/proto/marshaler.go
View File

@ -8,7 +8,7 @@ import (
"go-micro.dev/v4/codec"
)
// create buffer pool with 16 instances each preallocated with 256 bytes
// create buffer pool with 16 instances each preallocated with 256 bytes.
var bufferPool = bpool.NewSizedBufferPool(16, 256)
type Marshaler struct{}

6
codec/protorpc/protorpc.go
View File

@ -114,7 +114,7 @@ func (c *protoCodec) Write(m *codec.Message, b interface{}) error {
}
c.rwc.Write(data)
default:
return fmt.Errorf("Unrecognised message type: %v", m.Type)
return fmt.Errorf("Unrecognized message type: %v", m.Type)
}
return nil
}
@ -153,7 +153,7 @@ func (c *protoCodec) ReadHeader(m *codec.Message, mt codec.MessageType) error {
_, err := io.Copy(c.buf, c.rwc)
return err
default:
return fmt.Errorf("Unrecognised message type: %v", mt)
return fmt.Errorf("Unrecognized message type: %v", mt)
}
return nil
}
@ -170,7 +170,7 @@ func (c *protoCodec) ReadBody(b interface{}) error {
case codec.Event:
data = c.buf.Bytes()
default:
return fmt.Errorf("Unrecognised message type: %v", c.mt)
return fmt.Errorf("Unrecognized message type: %v", c.mt)
}
if b != nil {
return proto.Unmarshal(data, b.(proto.Message))

2
codec/text/text.go
View File

@ -12,7 +12,7 @@ type Codec struct {
Conn io.ReadWriteCloser
}
// Frame gives us the ability to define raw data to send over the pipes
// Frame gives us the ability to define raw data to send over the pipes.
type Frame struct {
Data []byte
}

24
config/config.go
View File

@ -10,7 +10,7 @@ import (
"go-micro.dev/v4/config/source/file"
)
// Config is an interface abstraction for dynamic configuration
// Config is an interface abstraction for dynamic configuration.
type Config interface {
// provide the reader.Values interface
reader.Values
@ -28,7 +28,7 @@ type Config interface {
Watch(path ...string) (Watcher, error)
}
// Watcher is the config watcher
// Watcher is the config watcher.
type Watcher interface {
Next() (reader.Value, error)
Stop() error
@ -48,51 +48,51 @@ type Options struct {
type Option func(o *Options)
var (
// Default Config Manager
// Default Config Manager.
DefaultConfig, _ = NewConfig()
)
// NewConfig returns new config
// NewConfig returns new config.
func NewConfig(opts ...Option) (Config, error) {
return newConfig(opts...)
}
// Return config as raw json
// Return config as raw json.
func Bytes() []byte {
return DefaultConfig.Bytes()
}
// Return config as a map
// Return config as a map.
func Map() map[string]interface{} {
return DefaultConfig.Map()
}
// Scan values to a go type
// Scan values to a go type.
func Scan(v interface{}) error {
return DefaultConfig.Scan(v)
}
// Force a source changeset sync
// Force a source changeset sync.
func Sync() error {
return DefaultConfig.Sync()
}
// Get a value from the config
// Get a value from the config.
func Get(path ...string) reader.Value {
return DefaultConfig.Get(path...)
}
// Load config sources
// Load config sources.
func Load(source ...source.Source) error {
return DefaultConfig.Load(source...)
}
// Watch a value for changes
// Watch a value for changes.
func Watch(path ...string) (Watcher, error) {
return DefaultConfig.Watch(path...)
}
// LoadFile is short hand for creating a file source and loading it
// LoadFile is short hand for creating a file source and loading it.
func LoadFile(path string) error {
return Load(file.NewSource(
file.WithPath(path),

2
config/default.go
View File

@ -159,7 +159,7 @@ func (c *config) Scan(v interface{}) error {
return c.vals.Scan(v)
}
// sync loads all the sources, calls the parser and updates the config
// sync loads all the sources, calls the parser and updates the config.
func (c *config) Sync() error {
if err := c.opts.Loader.Sync(); err != nil {
return err

8
config/loader/loader.go
View File

@ -8,7 +8,7 @@ import (
"go-micro.dev/v4/config/source"
)
// Loader manages loading sources
// Loader manages loading sources.
type Loader interface {
// Stop the loader
Close() error
@ -24,7 +24,7 @@ type Loader interface {
String() string
}
// Watcher lets you watch sources and returns a merged ChangeSet
// Watcher lets you watch sources and returns a merged ChangeSet.
type Watcher interface {
// First call to next may return the current Snapshot
// If you are watching a path then only the data from
@ -34,7 +34,7 @@ type Watcher interface {
Stop() error
}
// Snapshot is a merged ChangeSet
// Snapshot is a merged ChangeSet.
type Snapshot struct {
// The merged ChangeSet
ChangeSet *source.ChangeSet
@ -54,7 +54,7 @@ type Options struct {
type Option func(o *Options)
// Copy snapshot
// Copy snapshot.
func Copy(s *Snapshot) *Snapshot {
cs := *(s.ChangeSet)

7
config/loader/memory/memory.go
View File

@ -128,7 +128,7 @@ func (m *memory) loaded() bool {
return loaded
}
// reload reads the sets and creates new values
// reload reads the sets and creates new values.
func (m *memory) reload() error {
m.Lock()
@ -185,7 +185,7 @@ func (m *memory) update() {
}
}
// Snapshot returns a snapshot of the current loaded config
// Snapshot returns a snapshot of the current loaded config.
func (m *memory) Snapshot() (*loader.Snapshot, error) {
if m.loaded() {
m.RLock()
@ -207,7 +207,7 @@ func (m *memory) Snapshot() (*loader.Snapshot, error) {
return snap, nil
}
// Sync loads all the sources, calls the parser and updates the config
// Sync loads all the sources, calls the parser and updates the config.
func (m *memory) Sync() error {
//nolint:prealloc
var sets []*source.ChangeSet
@ -394,7 +394,6 @@ func (w *watcher) Next() (*loader.Snapshot, error) {
ChangeSet: cs,
Version: w.version,
}
}
for {

4
config/loader/memory/options.go
View File

@ -6,14 +6,14 @@ import (
"go-micro.dev/v4/config/source"
)
// WithSource appends a source to list of sources
// WithSource appends a source to list of sources.
func WithSource(s source.Source) loader.Option {
return func(o *loader.Options) {
o.Source = append(o.Source, s)
}
}
// WithReader sets the config reader
// WithReader sets the config reader.
func WithReader(r reader.Reader) loader.Option {
return func(o *loader.Options) {
o.Reader = r

6
config/options.go
View File

@ -6,21 +6,21 @@ import (
"go-micro.dev/v4/config/source"
)
// WithLoader sets the loader for manager config
// WithLoader sets the loader for manager config.
func WithLoader(l loader.Loader) Option {
return func(o *Options) {
o.Loader = l
}
}
// WithSource appends a source to list of sources
// WithSource appends a source to list of sources.
func WithSource(s source.Source) Option {
return func(o *Options) {
o.Source = append(o.Source, s)
}
}
// WithReader sets the config reader
// WithReader sets the config reader.
func WithReader(r reader.Reader) Option {
return func(o *Options) {
o.Reader = r

2
config/reader/json/json.go
View File

@ -73,7 +73,7 @@ func (j *jsonReader) String() string {
return "json"
}
// NewReader creates a json reader
// NewReader creates a json reader.
func NewReader(opts ...reader.Option) reader.Reader {
options := reader.NewOptions(opts...)
return &jsonReader{

2
config/reader/json/values.go
View File

@ -190,7 +190,7 @@ func (j *jsonValue) Scan(v interface{}) error {
func (j *jsonValue) Bytes() []byte {
b, err := j.Json.Bytes()
if err != nil {
// try return marshalled
// try return marshaled
b, err = j.Json.MarshalJSON()
if err != nil {
return []byte{}

6
config/reader/reader.go
View File

@ -7,14 +7,14 @@ import (
"go-micro.dev/v4/config/source"
)
// Reader is an interface for merging changesets
// Reader is an interface for merging changesets.
type Reader interface {
Merge(...*source.ChangeSet) (*source.ChangeSet, error)
Values(*source.ChangeSet) (Values, error)
String() string
}
// Values is returned by the reader
// Values is returned by the reader.
type Values interface {
Bytes() []byte
Get(path ...string) Value
@ -24,7 +24,7 @@ type Values interface {
Scan(v interface{}) error
}
// Value represents a value of any type
// Value represents a value of any type.
type Value interface {
Bool(def bool) bool
Int(def int) int

11
config/secrets/box/box.go
View File

@ -18,7 +18,7 @@ type box struct {
privateKey [keyLength]byte
}
// NewSecrets returns a nacl-box codec
// NewSecrets returns a nacl-box codec.
func NewSecrets(opts ...secrets.Option) secrets.Secrets {
b := &box{}
for _, o := range opts {
@ -27,7 +27,6 @@ func NewSecrets(opts ...secrets.Option) secrets.Secrets {
return b
}
// Init initialises a box
func (b *box) Init(opts ...secrets.Option) error {
for _, o := range opts {
o(&b.options)
@ -40,17 +39,17 @@ func (b *box) Init(opts ...secrets.Option) error {
return nil
}
// Options returns options
// Options returns options.
func (b *box) Options() secrets.Options {
return b.options
}
// String returns nacl-box
// String returns nacl-box.
func (*box) String() string {
return "nacl-box"
}
// Encrypt encrypts a message with the sender's private key and the receipient's public key
// Encrypt encrypts a message with the sender's private key and the receipient's public key.
func (b *box) Encrypt(in []byte, opts ...secrets.EncryptOption) ([]byte, error) {
var options secrets.EncryptOptions
for _, o := range opts {
@ -68,7 +67,7 @@ func (b *box) Encrypt(in []byte, opts ...secrets.EncryptOption) ([]byte, error)
return naclbox.Seal(nonce[:], in, &nonce, &recipientPublicKey, &b.privateKey), nil
}
// Decrypt Decrypts a message with the receiver's private key and the sender's public key
// Decrypt Decrypts a message with the receiver's private key and the sender's public key.
func (b *box) Decrypt(in []byte, opts ...secrets.DecryptOption) ([]byte, error) {
var options secrets.DecryptOptions
for _, o := range opts {

4
config/secrets/box/box_test.go
View File

@ -30,14 +30,14 @@ func TestBox(t *testing.T) {
}
aliceSecret := []byte("Why is a raven like a writing-desk?")
if _, err := alice.Encrypt(aliceSecret); err == nil {
t.Error("alice.Encrypt succeded without a public key")
t.Error("alice.Encrypt succeeded without a public key")
}
enc, err := alice.Encrypt(aliceSecret, secrets.RecipientPublicKey(bob.Options().PublicKey))
if err != nil {
t.Error("alice.Encrypt failed")
}
if _, err := bob.Decrypt(enc); err == nil {
t.Error("bob.Decrypt succeded without a public key")
t.Error("bob.Decrypt succeeded without a public key")
}
if dec, err := bob.Decrypt(enc, secrets.SenderPublicKey(alice.Options().PublicKey)); err == nil {
if !reflect.DeepEqual(dec, aliceSecret) {

2
config/secrets/secretbox/secretbox.go
View File

@ -18,7 +18,7 @@ type secretBox struct {
secretKey [keyLength]byte
}
// NewSecrets returns a secretbox codec
// NewSecrets returns a secretbox codec.
func NewSecrets(opts ...secrets.Option) secrets.Secrets {
sb := &secretBox{}
for _, o := range opts {

24
config/secrets/secrets.go
View File

@ -3,9 +3,9 @@ package secrets
import "context"
// Secrets encrypts or decrypts arbitrary data. The data should be as small as possible
// Secrets encrypts or decrypts arbitrary data. The data should be as small as possible.
type Secrets interface {
// Initialise options
// Initialize options
Init(...Option) error
// Return the options
Options() Options
@ -28,10 +28,10 @@ type Options struct {
Context context.Context
}
// Option sets options
// Option sets options.
type Option func(*Options)
// Key sets the symmetric secret key
// Key sets the symmetric secret key.
func Key(k []byte) Option {
return func(o *Options) {
o.Key = make([]byte, len(k))
@ -39,7 +39,7 @@ func Key(k []byte) Option {
}
}
// PublicKey sets the asymmetric Public Key of this codec
// PublicKey sets the asymmetric Public Key of this codec.
func PublicKey(key []byte) Option {
return func(o *Options) {
o.PublicKey = make([]byte, len(key))
@ -47,7 +47,7 @@ func PublicKey(key []byte) Option {
}
}
// PrivateKey sets the asymmetric Private Key of this codec
// PrivateKey sets the asymmetric Private Key of this codec.
func PrivateKey(key []byte) Option {
return func(o *Options) {
o.PrivateKey = make([]byte, len(key))
@ -55,15 +55,15 @@ func PrivateKey(key []byte) Option {
}
}
// DecryptOptions can be passed to Secrets.Decrypt
// DecryptOptions can be passed to Secrets.Decrypt.
type DecryptOptions struct {
SenderPublicKey []byte
}
// DecryptOption sets DecryptOptions
// DecryptOption sets DecryptOptions.
type DecryptOption func(*DecryptOptions)
// SenderPublicKey is the Public Key of the Secrets that encrypted this message
// SenderPublicKey is the Public Key of the Secrets that encrypted this message.
func SenderPublicKey(key []byte) DecryptOption {
return func(d *DecryptOptions) {
d.SenderPublicKey = make([]byte, len(key))
@ -71,15 +71,15 @@ func SenderPublicKey(key []byte) DecryptOption {
}
}
// EncryptOptions can be passed to Secrets.Encrypt
// EncryptOptions can be passed to Secrets.Encrypt.
type EncryptOptions struct {
RecipientPublicKey []byte
}
// EncryptOption Sets EncryptOptions
// EncryptOption Sets EncryptOptions.
type EncryptOption func(*EncryptOptions)
// RecipientPublicKey is the Public Key of the Secrets that will decrypt this message
// RecipientPublicKey is the Public Key of the Secrets that will decrypt this message.
func RecipientPublicKey(key []byte) EncryptOption {
return func(e *EncryptOptions) {
e.RecipientPublicKey = make([]byte, len(key))

2
config/source/changeset.go
View File

@ -5,7 +5,7 @@ import (
"fmt"
)
// Sum returns the md5 checksum of the ChangeSet data
// Sum returns the md5 checksum of the ChangeSet data.
func (c *ChangeSet) Sum() string {
h := md5.New()
h.Write(c.Data)

2
config/source/cli/cli.go
View File

@ -75,7 +75,7 @@ func (c *cliSource) Watch() (source.Watcher, error) {
return source.NewNoopWatcher()
}
// Write is unsupported
// Write is unsupported.
func (c *cliSource) Write(cs *source.ChangeSet) error {
return nil
}

1
config/source/cli/cli_test.go
View File

@ -104,7 +104,6 @@ func test(t *testing.T, withContext bool) {
if actualDB["host"] != "localhost" {
t.Errorf("expected localhost, got %v", actualDB["name"])
}
}
func TestCliSource(t *testing.T) {

2
config/source/cli/options.go
View File

@ -9,7 +9,7 @@ import (
type contextKey struct{}
// Context sets the cli context
// Context sets the cli context.
func Context(c *cli.Context) source.Option {
return func(o *source.Options) {
if o.Context == nil {

1
config/source/env/env.go vendored
View File

@ -24,7 +24,6 @@ func (e *env) Read() (*source.ChangeSet, error) {
var changes map[string]interface{}
for _, env := range os.Environ() {
if len(e.prefixes) > 0 || len(e.strippedPrefixes) > 0 {
notFound := true

1
config/source/file/format_test.go
View File

@ -27,5 +27,4 @@ func TestFormat(t *testing.T) {
t.Fatalf("%s: expected %s got %s", d.p, d.f, f)
}
}
}

4
config/source/file/options.go
View File

@ -10,7 +10,7 @@ import (
type filePathKey struct{}
type fsKey struct{}
// WithPath sets the path to file
// WithPath sets the path to file.
func WithPath(p string) source.Option {
return func(o *source.Options) {
if o.Context == nil {
@ -20,7 +20,7 @@ func WithPath(p string) source.Option {
}
}
// WithFS sets the underlying filesystem to lookup file from (default os.FS)
// WithFS sets the underlying filesystem to lookup file from (default os.FS).
func WithFS(fs fs.FS) source.Option {
return func(o *source.Options) {
if o.Context == nil {

5
config/source/flag/flag.go
View File

@ -3,10 +3,11 @@ package flag
import (
"errors"
"flag"
"github.com/imdario/mergo"
"go-micro.dev/v4/config/source"
"strings"
"time"
"github.com/imdario/mergo"
"go-micro.dev/v4/config/source"
)
type flagsrc struct {

6
config/source/memory/options.go
View File

@ -20,7 +20,7 @@ func withData(d []byte, f string) source.Option {
}
}
// WithChangeSet allows a changeset to be set
// WithChangeSet allows a changeset to be set.
func WithChangeSet(cs *source.ChangeSet) source.Option {
return func(o *source.Options) {
if o.Context == nil {
@ -30,12 +30,12 @@ func WithChangeSet(cs *source.ChangeSet) source.Option {
}
}
// WithJSON allows the source data to be set to json
// WithJSON allows the source data to be set to json.
func WithJSON(d []byte) source.Option {
return withData(d, "json")
}
// WithYAML allows the source data to be set to yaml
// WithYAML allows the source data to be set to yaml.
func WithYAML(d []byte) source.Option {
return withData(d, "yaml")
}

4
config/source/options.go
View File

@ -35,14 +35,14 @@ func NewOptions(opts ...Option) Options {
return options
}
// WithEncoder sets the source encoder
// WithEncoder sets the source encoder.
func WithEncoder(e encoder.Encoder) Option {
return func(o *Options) {
o.Encoder = e
}
}
// WithClient sets the source client
// WithClient sets the source client.
func WithClient(c client.Client) Option {
return func(o *Options) {
o.Client = c

8
config/source/source.go
View File

@ -7,11 +7,11 @@ import (
)
var (
// ErrWatcherStopped is returned when source watcher has been stopped
// ErrWatcherStopped is returned when source watcher has been stopped.
ErrWatcherStopped = errors.New("watcher stopped")
)
// Source is the source from which config is loaded
// Source is the source from which config is loaded.
type Source interface {
Read() (*ChangeSet, error)
Write(*ChangeSet) error
@ -19,7 +19,7 @@ type Source interface {
String() string
}
// ChangeSet represents a set of changes from a source
// ChangeSet represents a set of changes from a source.
type ChangeSet struct {
Data []byte
Checksum string
@ -28,7 +28,7 @@ type ChangeSet struct {
Timestamp time.Time
}
// Watcher watches a source for changes
// Watcher watches a source for changes.
type Watcher interface {
Next() (*ChangeSet, error)
Stop() error

4
debug/handler/debug.go
View File

@ -13,7 +13,7 @@ import (
"go-micro.dev/v4/server"
)
// NewHandler returns an instance of the Debug Handler
// NewHandler returns an instance of the Debug Handler.
func NewHandler(c client.Client) *Debug {
return &Debug{
log: log.DefaultLog,
@ -23,7 +23,7 @@ func NewHandler(c client.Client) *Debug {
}
type Debug struct {
// must honour the debug handler
// must honor the debug handler
proto.DebugHandler
// the logger for retrieving logs
log log.Log

18
debug/log/log.go
View File

@ -8,15 +8,15 @@ import (
)
var (
// Default buffer size if any
// Default buffer size if any.
DefaultSize = 1024
// DefaultLog logger
// DefaultLog logger.
DefaultLog = NewLog()
// Default formatter
// Default formatter.
DefaultFormat = TextFormat
)
// Log is debug log interface for reading and writing logs
// Log is debug log interface for reading and writing logs.
type Log interface {
// Read reads log entries from the logger
Read(...ReadOption) ([]Record, error)
@ -26,7 +26,7 @@ type Log interface {
Stream() (Stream, error)
}
// Record is log record entry
// Record is log record entry.
type Record struct {
// Timestamp of logged event
Timestamp time.Time `json:"timestamp"`
@ -36,22 +36,22 @@ type Record struct {
Message interface{} `json:"message"`
}
// Stream returns a log stream
// Stream returns a log stream.
type Stream interface {
Chan() <-chan Record
Stop() error
}
// Format is a function which formats the output
// Format is a function which formats the output.
type FormatFunc func(Record) string
// TextFormat returns text format
// TextFormat returns text format.
func TextFormat(r Record) string {
t := r.Timestamp.Format("2006-01-02 15:04:05")
return fmt.Sprintf("%s %v", t, r.Message)
}
// JSONFormat is a json Format func
// JSONFormat is a json Format func.
func JSONFormat(r Record) string {
b, _ := json.Marshal(r)
return string(b)

12
debug/log/memory/memory.go
View File

@ -9,16 +9,16 @@ import (
)
var (
// DefaultSize of the logger buffer
// DefaultSize of the logger buffer.
DefaultSize = 1024
)
// memoryLog is default micro log
// memoryLog is default micro log.
type memoryLog struct {
*ring.Buffer
}
// NewLog returns default Logger with
// NewLog returns default Logger with.
func NewLog(opts ...log.Option) log.Log {
// get default options
options := log.DefaultOptions()
@ -33,13 +33,13 @@ func NewLog(opts ...log.Option) log.Log {
}
}
// Write writes logs into logger
// Write writes logs into logger.
func (l *memoryLog) Write(r log.Record) error {
l.Buffer.Put(fmt.Sprint(r.Message))
return nil
}
// Read reads logs and returns them
// Read reads logs and returns them.
func (l *memoryLog) Read(opts ...log.ReadOption) ([]log.Record, error) {
options := log.ReadOptions{}
// initialize the read options
@ -83,7 +83,7 @@ func (l *memoryLog) Read(opts ...log.ReadOption) ([]log.Record, error) {
}
// Stream returns channel for reading log records
// along with a stop channel, close it when done
// along with a stop channel, close it when done.
func (l *memoryLog) Stream() (log.Stream, error) {
// get stream channel from ring buffer
stream, stop := l.Buffer.Stream()

18
debug/log/options.go
View File

@ -2,10 +2,10 @@ package log
import "time"
// Option used by the logger
// Option used by the logger.
type Option func(*Options)
// Options are logger options
// Options are logger options.
type Options struct {
// Name of the log
Name string
@ -15,14 +15,14 @@ type Options struct {
Format FormatFunc
}
// Name of the log
// Name of the log.
func Name(n string) Option {
return func(o *Options) {
o.Name = n
}
}
// Size sets the size of the ring buffer
// Size sets the size of the ring buffer.
func Size(s int) Option {
return func(o *Options) {
o.Size = s
@ -35,14 +35,14 @@ func Format(f FormatFunc) Option {
}
}
// DefaultOptions returns default options
// DefaultOptions returns default options.
func DefaultOptions() Options {
return Options{
Size: DefaultSize,
}
}
// ReadOptions for querying the logs
// ReadOptions for querying the logs.
type ReadOptions struct {
// Since what time in past to return the logs
Since time.Time
@ -52,17 +52,17 @@ type ReadOptions struct {
Stream bool
}
// ReadOption used for reading the logs
// ReadOption used for reading the logs.
type ReadOption func(*ReadOptions)
// Since sets the time since which to return the log records
// Since sets the time since which to return the log records.
func Since(s time.Time) ReadOption {
return func(o *ReadOptions) {
o.Since = s
}
}
// Count sets the number of log records to return
// Count sets the number of log records to return.
func Count(c int) ReadOption {
return func(o *ReadOptions) {
o.Count = c

8
debug/log/os.go
View File

@ -7,7 +7,7 @@ import (
"go-micro.dev/v4/util/ring"
)
// Should stream from OS
// Should stream from OS.
type osLog struct {
format FormatFunc
once sync.Once
@ -21,7 +21,7 @@ type osStream struct {
stream chan Record
}
// Read reads log entries from the logger
// Read reads log entries from the logger.
func (o *osLog) Read(...ReadOption) ([]Record, error) {
var records []Record
@ -33,13 +33,13 @@ func (o *osLog) Read(...ReadOption) ([]Record, error) {
return records, nil
}
// Write writes records to log
// Write writes records to log.
func (o *osLog) Write(r Record) error {
o.buffer.Put(r)
return nil
}
// Stream log records
// Stream log records.
func (o *osLog) Stream() (Stream, error) {
o.Lock()
defer o.Unlock()

4
debug/profile/http/http.go
View File

@ -20,7 +20,7 @@ var (
DefaultAddress = ":6060"
)
// Start the profiler
// Start the profiler.
func (h *httpProfile) Start() error {
h.Lock()
defer h.Unlock()
@ -42,7 +42,7 @@ func (h *httpProfile) Start() error {
return nil
}
// Stop the profiler
// Stop the profiler.
func (h *httpProfile) Stop() error {
h.Lock()
defer h.Unlock()

2
debug/profile/profile.go
View File

@ -35,7 +35,7 @@ type Options struct {
type Option func(o *Options)
// Name of the profile
// Name of the profile.
func Name(n string) Option {
return func(o *Options) {
o.Name = n

2
debug/stats/default.go
View File

@ -80,7 +80,7 @@ func (s *stats) Record(err error) error {
}
// NewStats returns a new in memory stats buffer
// TODO add options
// TODO add options.
func NewStats() Stats {
return &stats{
started: time.Now().Unix(),

4
debug/stats/stats.go
View File

@ -1,7 +1,7 @@
// Package stats provides runtime stats
package stats
// Stats provides stats interface
// Stats provides stats interface.
type Stats interface {
// Read stat snapshot
Read() ([]*Stat, error)
@ -11,7 +11,7 @@ type Stats interface {
Record(error) error
}
// A runtime stat
// A runtime stat.
type Stat struct {
// Timestamp of recording
Timestamp int64

6
debug/trace/options.go
View File

@ -14,7 +14,7 @@ type ReadOptions struct {
type ReadOption func(o *ReadOptions)
// Read the given trace
// Read the given trace.
func ReadTrace(t string) ReadOption {
return func(o *ReadOptions) {
o.Trace = t
@ -22,11 +22,11 @@ func ReadTrace(t string) ReadOption {
}
const (
// DefaultSize of the buffer
// DefaultSize of the buffer.
DefaultSize = 64
)
// DefaultOptions returns default options
// DefaultOptions returns default options.
func DefaultOptions() Options {
return Options{
Size: DefaultSize,

14
debug/trace/trace.go
View File

@ -8,7 +8,7 @@ import (
"go-micro.dev/v4/metadata"
)
// Tracer is an interface for distributed tracing
// Tracer is an interface for distributed tracing.
type Tracer interface {
// Start a trace
Start(ctx context.Context, name string) (context.Context, *Span)
@ -18,17 +18,17 @@ type Tracer interface {
Read(...ReadOption) ([]*Span, error)
}
// SpanType describe the nature of the trace span
// SpanType describe the nature of the trace span.
type SpanType int
const (
// SpanTypeRequestInbound is a span created when serving a request
// SpanTypeRequestInbound is a span created when serving a request.
SpanTypeRequestInbound SpanType = iota
// SpanTypeRequestOutbound is a span created when making a service call
// SpanTypeRequestOutbound is a span created when making a service call.
SpanTypeRequestOutbound
)
// Span is used to record an entry
// Span is used to record an entry.
type Span struct {
// Id of the trace
Trace string
@ -53,7 +53,7 @@ const (
spanIDKey = "Micro-Span-Id"
)
// FromContext returns a span from context
// FromContext returns a span from context.
func FromContext(ctx context.Context) (traceID string, parentSpanID string, isFound bool) {
traceID, traceOk := metadata.Get(ctx, traceIDKey)
microID, microOk := metadata.Get(ctx, "Micro-Id")
@ -68,7 +68,7 @@ func FromContext(ctx context.Context) (traceID string, parentSpanID string, isFo
return traceID, parentSpanID, ok
}
// ToContext saves the trace and span ids in the context
// ToContext saves the trace and span ids in the context.
func ToContext(ctx context.Context, traceID, parentSpanID string) context.Context {
return metadata.MergeContext(ctx, map[string]string{
traceIDKey: traceID,

6
errors/errors.go
View File

@ -117,7 +117,7 @@ func InternalServerError(id, format string, a ...interface{}) error {
}
}
// Equal tries to compare errors
// Equal tries to compare errors.
func Equal(err1 error, err2 error) bool {
verr1, ok1 := err1.(*Error)
verr2, ok2 := err2.(*Error)
@ -137,7 +137,7 @@ func Equal(err1 error, err2 error) bool {
return true
}
// FromError try to convert go error to *Error
// FromError try to convert go error to *Error.
func FromError(err error) *Error {
if err == nil {
return nil
@ -149,7 +149,7 @@ func FromError(err error) *Error {
return Parse(err.Error())
}
// As finds the first error in err's chain that matches *Error
// As finds the first error in err's chain that matches *Error.
func As(err error) (*Error, bool) {
if err == nil {
return nil, false

Some files were not shown because too many files have changed in this diff Show More