resolverutils

package

v0.0.0-...-4adb62b Latest Latest Go to latest Published: Jan 3, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	USERNAME_KEY  = "username"
	CHAT_ID_KEY   = "chatID"
	CHAT_NAME_KEY = "chatName"
	ACTION_KEY    = "action"
)

This section is empty.

func AssertHTTPError(t *testing.T, err *HTTPError, expectedStatus int, expectedMessage string)

func CommonSetup(body string) (*response.Writer, *http.Request, database.Connection)

Creates mock resolver arguments

func DisplayHTTPError(w *response.Writer, httpError *HTTPError) bool

Provides an error div for HTMX

func GetRequestBodyAndContext(
	r *http.Request,
	ptr any,
	paramKeys ...string,
) (*database.User, *RouteParams, *HTTPError)

Calls `resolverutils.GetRequestBody()` then, if successful, `resolverutils.GetRequestContext()`

func GetRequestContext(r *http.Request, paramKeys ...string) (*database.User, *RouteParams, *HTTPError)

Gets all requested context attached to a request. Writes an HTTP error response + logs on failure.

func ProcessHTTPError(w *response.Writer, httpError *HTTPError) bool

Writes message and status of HTTPError to the response Returns false if httpError is nil, true otherwise

func SetContext(
	t *testing.T,
	req *http.Request,
	user *database.User,
	params map[string]string,
) *http.Request

Adds a user and/or parameters to a new request context

type HTTPError struct {
	Status  int
	Message string
}

func GetRequestBody(r *http.Request, ptr any) *HTTPError

Decodes JSON from HTTP request body and binds it to a struct pointer. Writes an HTTP error response on failure.

func GetRequestQueryParam(r *http.Request, key string, isRequired bool) (string, *HTTPError)

Extracts query parameter from request errors if missing when isRequired is true errors if the parameter value is an empty string

func GetRequestQueryParamInt(r *http.Request, key string, isRequired bool) (int64, *HTTPError)

Calls GetRequestQueryParam, then casts the result to an integer

func HandleDatabaseError(err error) *HTTPError

Handles an unexpected error from the database

type RouteParams struct {
	Username string
	ChatID   int64
	ChatName string
}