internal

type Authorization ¶ added in v0.20.7

type Authorization interface {
	Header(ctx context.Context, client HttpClient) (string, error)
}

func NewClientSecretAuthorization(loginApiPath, clientId, clientSecret string) Authorization

type BearerTokenAuthorization ¶ added in v0.20.7

type BearerTokenAuthorization struct {
	Token string
}

func (auth BearerTokenAuthorization) Header(_ context.Context, _ HttpClient) (string, error)

type ExponentialBackoff ¶ added in v0.20.7

type ExponentialBackoff struct {
	MinWait, MaxWait time.Duration
}

ExponentialBackoff increases the backoff exponentially: minWait * 2^(attempt-1).

func (b ExponentialBackoff) Calculate(attempt int) time.Duration

type HttpClient ¶

type HttpClient struct {
	*http.Client
	RootUrl       *url.URL
	UserAgent     string
	Authorization Authorization
}

HttpClient wraps http.Client with convenient request handling thanks to RequestOption.

func NewHttpClient(rootUrl *url.URL, userAgent string, auth Authorization) HttpClient

func WithRetry(c HttpClient, options RetryOptions) HttpClient

func (c HttpClient) GetMeshInfo(ctx context.Context) (*MeshInfo, error)

type HttpError ¶ added in v0.20.6

type HttpError struct {
	StatusCode   int
	ResponseBody []byte
}

HttpError represents an HTTP error response with status code. This error is returned when an HTTP request fails with a non-2XX status code.

func (e HttpError) Error() string

func (e HttpError) IsForbidden() bool

func (e HttpError) IsNotFound() bool

type Logger ¶

type Logger interface {
	Debug(ctx context.Context, msg string, args ...any)
	Info(ctx context.Context, msg string, args ...any)
	Warn(ctx context.Context, msg string, args ...any)
}

Logger supports Debug, Info, and Warn log levels. Note that msg is a short, descriptive statement what is logged, and args are key value pairs (values are string or implement fmt.Stringer).

var Log Logger = noopLogger{}

type MeshInfo ¶

type MeshInfo struct {
	Version version.Version `json:"version"`
}

type MeshObjectClient ¶

type MeshObjectClient[M any] struct {
	HttpClient
	Kind       string
	ApiVersion string
	ApiUrl     *url.URL
}

MeshObjectClient provides typed CRUD operations for meshStack API objects. It embeds HttpClient and adds meshObject-specific functionality including automatic MIME type handling and pagination. Also handles authentication in doAuthorizedRequest using the ApiKey/ApiSecret values, which are embedded in HttpClient for convenient construction with NewMeshObjectClient.

func NewMeshObjectClient[M any](ctx context.Context, httpClient HttpClient, apiVersion string, explicitApiPathElems ...string) MeshObjectClient[M]

func (c MeshObjectClient[M]) Delete(ctx context.Context, id string) (err error)

func (c MeshObjectClient[M]) Get(ctx context.Context, id string) (resp *M, err error)

func (c MeshObjectClient[M]) List(ctx context.Context, options ...RequestOption) ([]M, error)

func (c MeshObjectClient[M]) Post(ctx context.Context, payload any) (*M, error)

func (c MeshObjectClient[M]) Purge(ctx context.Context, id string) (err error)

func (c MeshObjectClient[M]) Put(ctx context.Context, id string, payload any) (*M, error)

type RequestOption ¶

type RequestOption func(opts *requestOptions)

RequestOption is a functional option for configuring HTTP requests.

func WithUrlQuery(key string, value any) RequestOption

type RetryBackoff ¶ added in v0.20.7

type RetryBackoff interface {
	Calculate(attempt int) time.Duration
}

RetryBackoff calculates the duration to wait before the next retry attempt.

type RetryOptions ¶ added in v0.20.7

type RetryOptions struct {
	// MaxRetries limits the attempts to retries. If zero, retries will never be attempted.
	MaxRetries int
	// Backoff to use when retrying. If nil, retries will never be attempted.
	Backoff RetryBackoff
	// WhitelistedPaths allow methods beyond GET and PUT to be retried as well, see WithRetry.
	WhitelistedPaths map[string][]string
}

RetryOptions configure WithRetry.