gofr

Documentation

Index

• Constants
• Variables
• func OpenAPIHandler(c *Context) (interface{}, error)
• func ShutdownWithContext(ctx context.Context, shutdownFunc func(ctx context.Context) error, ...) error
• func SwaggerUIHandler(c *Context) (interface{}, error)
• type App
  • func New() *App
  • func NewCMD() *App
  • func (a *App) AddCassandra(db container.CassandraProvider)
  • func (a *App) AddClickhouse(db container.ClickhouseProvider)
  • func (a *App) AddCronJob(schedule, jobName string, job CronFunc)
  • func (a *App) AddDgraph(db container.DgraphProvider)
  • func (a *App) AddFTP(fs file.FileSystemProvider)
  • func (a *App) AddFileStore(fs file.FileSystemProvider)
  • func (a *App) AddHTTPService(serviceName, serviceAddress string, options ...service.Options)
  • func (a *App) AddKVStore(db container.KVStoreProvider)
  • func (a *App) AddMongo(db container.MongoProvider)
  • func (a *App) AddRESTHandlers(object interface{}) error
  • func (a *App) AddSolr(db container.SolrProvider)
  • func (a *App) AddStaticFiles(endpoint, filePath string)
  • func (a *App) DELETE(pattern string, handler Handler)
  • func (a *App) EnableAPIKeyAuth(apiKeys ...string)
  • func (a *App) EnableAPIKeyAuthWithFunc(validateFunc func(apiKey string) bool)
  • func (a *App) EnableAPIKeyAuthWithValidator(validateFunc func(c *container.Container, apiKey string) bool)
  • func (a *App) EnableBasicAuth(credentials ...string)
  • func (a *App) EnableBasicAuthWithFunc(validateFunc func(username, password string) bool)
  • func (a *App) EnableBasicAuthWithValidator(validateFunc func(c *container.Container, username, password string) bool)
  • func (a *App) EnableOAuth(jwksEndpoint string, refreshInterval int)
  • func (a *App) GET(pattern string, handler Handler)
  • func (a *App) Logger() logging.Logger
  • func (a *App) Metrics() metrics.Manager
  • func (a *App) Migrate(migrationsMap map[int64]migration.Migrate)
  • func (a *App) OverrideWebsocketUpgrader(wsUpgrader websocket.Upgrader)
  • func (a *App) PATCH(pattern string, handler Handler)
  • func (a *App) POST(pattern string, handler Handler)
  • func (a *App) PUT(pattern string, handler Handler)
  • func (a *App) RegisterService(desc *grpc.ServiceDesc, impl any)
  • func (a *App) Run()
  • func (a *App) Shutdown(ctx context.Context) error
  • func (a *App) SubCommand(pattern string, handler Handler, options ...Options)
  • func (a *App) Subscribe(topic string, handler SubscribeFunc)
  • func (a *App) UseMiddleware(middlewares ...gofrHTTP.Middleware)
  • func (a *App) UseMongo(db container.Mongo)
  • func (a *App) WebSocket(route string, handler Handler)
• type CRUD
• type Context
  • func (c *Context) Bind(i interface{}) error
  • func (c *Context) Trace(name string) trace.Span
  • func (c *Context) WriteMessageToSocket(data any) error
• type Create
• type CronFunc
• type Crontab
  • func NewCron(cntnr *container.Container) *Crontab
  • func (c *Crontab) AddJob(schedule, jobName string, fn CronFunc) error
• type Delete
• type ErrCommandNotFound
  • func (ErrCommandNotFound) Error() string
• type ErrorLogEntry
  • func (el *ErrorLogEntry) PrettyPrint(writer io.Writer)
• type Exporter
  • func NewExporter(endpoint string, logger logging.Logger) *Exporter
  • func (e *Exporter) ExportSpans(ctx context.Context, spans []sdktrace.ReadOnlySpan) error
  • func (*Exporter) Shutdown(context.Context) error
• type Get
• type GetAll
• type Handler
• type Options
  • func AddDescription(descString string) Options
  • func AddHelp(helperString string) Options
• type Request
• type Responder
• type RestPathOverrider
• type Span
• type SubscribeFunc
• type SubscriptionManager
• type TableNameOverrider
• type Update

Constants

const (
	OpenAPIJSON = "openapi.json"
)

Variables

var ErrMarshalingResponse = errors.New("error marshaling response")

Functions

func OpenAPIHandler

func OpenAPIHandler(c *Context) (interface{}, error)

OpenAPIHandler serves the `openapi.json` file at the specified path. It reads the file from the disk and returns its content as a response.

func ShutdownWithContext

func ShutdownWithContext(ctx context.Context, shutdownFunc func(ctx context.Context) error, forceCloseFunc func() error) error

ShutdownWithContext handles the shutdown process with context timeout. It takes a shutdown function and a force close function as parameters. If the context times out, the force close function is called.

func SwaggerUIHandler

func SwaggerUIHandler(c *Context) (interface{}, error)

SwaggerUIHandler serves the static files of the Swagger UI.

Types

type App

type App struct {
	// Config can be used by applications to fetch custom configurations from environment or file.
	Config config.Config // If we directly embed, unnecessary confusion between app.Get and app.GET will happen.
	// contains filtered or unexported fields
}

App is the main application in the GoFr framework.

func New

func New() *App

New creates an HTTP Server Application and returns that App.

func NewCMD

func NewCMD() *App

NewCMD creates a command-line application.

func (*App) AddCassandra

func (a *App) AddCassandra(db container.CassandraProvider)

AddCassandra sets the Cassandra datasource in the app's container.

func (*App) AddClickhouse

func (a *App) AddClickhouse(db container.ClickhouseProvider)

AddClickhouse initializes the clickhouse client. Official implementation is available in the package : gofr.dev/pkg/gofr/datasource/clickhouse .

func (*App) AddCronJob

func (a *App) AddCronJob(schedule, jobName string, job CronFunc)

AddCronJob registers a cron job to the cron table. The cron expression can be either a 5-part or 6-part format. The 6-part format includes an optional second field (in beginning) and others being minute, hour, day, month and day of week respectively.

func (*App) AddDgraph

func (a *App) AddDgraph(db container.DgraphProvider)

AddDgraph sets the Dgraph datasource in the app's container.

func (*App) AddFTP

func (a *App) AddFTP(fs file.FileSystemProvider)

AddFTP sets the FTP datasource in the app's container. Deprecated: Use the AddFile method instead.

func (*App) AddFileStore

func (a *App) AddFileStore(fs file.FileSystemProvider)

AddFile sets the FTP,SFTP,S3 datasource in the app's container.

func (*App) AddHTTPService

func (a *App) AddHTTPService(serviceName, serviceAddress string, options ...service.Options)

AddHTTPService registers HTTP service in container.

func (*App) AddKVStore

func (a *App) AddKVStore(db container.KVStoreProvider)

AddKVStore sets the KV-Store datasource in the app's container.

func (*App) AddMongo

func (a *App) AddMongo(db container.MongoProvider)

AddMongo sets the Mongo datasource in the app's container.

func (*App) AddRESTHandlers

func (a *App) AddRESTHandlers(object interface{}) error

AddRESTHandlers creates and registers CRUD routes for the given struct, the struct should always be passed by reference.

func (*App) AddSolr

func (a *App) AddSolr(db container.SolrProvider)

AddSolr sets the Solr datasource in the app's container.

func (*App) AddStaticFiles

func (a *App) AddStaticFiles(endpoint, filePath string)

AddStaticFiles registers a static file endpoint for the application.

The provided `endpoint` will be used as the prefix for the static file server. The `filePath` specifies the directory containing the static files. If `filePath` starts with "./", it will be interpreted as a relative path to the current working directory.

func (*App) DELETE

func (a *App) DELETE(pattern string, handler Handler)

DELETE adds a Handler for HTTP DELETE method for a route pattern.

func (*App) EnableAPIKeyAuth

func (a *App) EnableAPIKeyAuth(apiKeys ...string)

EnableAPIKeyAuth enables API key authentication for the application.

It requires at least one API key to be provided. The provided API keys will be used to authenticate requests.

func (*App) EnableAPIKeyAuthWithFunc

func (a *App) EnableAPIKeyAuthWithFunc(validateFunc func(apiKey string) bool)

Deprecated: EnableAPIKeyAuthWithFunc is deprecated and will be removed in future releases, users must use EnableAPIKeyAuthWithValidator as it has access to application datasources.

func (*App) EnableAPIKeyAuthWithValidator

func (a *App) EnableAPIKeyAuthWithValidator(validateFunc func(c *container.Container, apiKey string) bool)

EnableAPIKeyAuthWithValidator enables API key authentication for the application with a custom validation function.

The provided `validateFunc` is used to determine the validity of an API key. It receives the request container and the API key as arguments and should return `true` if the key is valid, `false` otherwise.

func (*App) EnableBasicAuth

func (a *App) EnableBasicAuth(credentials ...string)

EnableBasicAuth enables basic authentication for the application.

It takes a variable number of credentials as alternating username and password strings. An error is logged if an odd number of arguments is provided.

func (*App) EnableBasicAuthWithFunc

func (a *App) EnableBasicAuthWithFunc(validateFunc func(username, password string) bool)

Deprecated: EnableBasicAuthWithFunc is deprecated and will be removed in future releases, users must use EnableBasicAuthWithValidator as it has access to application datasources.

func (*App) EnableBasicAuthWithValidator

func (a *App) EnableBasicAuthWithValidator(validateFunc func(c *container.Container, username, password string) bool)

EnableBasicAuthWithValidator enables basic authentication for the HTTP server with a custom validator.

The provided `validateFunc` is invoked for each authentication attempt. It receives a container instance, username, and password. The function should return `true` if the credentials are valid, `false` otherwise.

func (*App) EnableOAuth

func (a *App) EnableOAuth(jwksEndpoint string, refreshInterval int)

EnableOAuth configures OAuth middleware for the application.

It registers a new HTTP service for fetching JWKS and sets up OAuth middleware with the given JWKS endpoint and refresh interval.

The JWKS endpoint is used to retrieve JSON Web Key Sets for verifying tokens. The refresh interval specifies how often to refresh the token cache.

func (*App) GET

func (a *App) GET(pattern string, handler Handler)

GET adds a Handler for HTTP GET method for a route pattern.

func (*App) Logger

func (a *App) Logger() logging.Logger

Logger returns the logger instance associated with the App.

func (*App) Metrics

func (a *App) Metrics() metrics.Manager

Metrics returns the metrics manager associated with the App.

func (*App) Migrate

func (a *App) Migrate(migrationsMap map[int64]migration.Migrate)

Migrate applies a set of migrations to the application's database.

The migrationsMap argument is a map where the key is the version number of the migration and the value is a migration.Migrate instance that implements the migration logic.

func (*App) OverrideWebsocketUpgrader

func (a *App) OverrideWebsocketUpgrader(wsUpgrader websocket.Upgrader)

func (*App) PATCH

func (a *App) PATCH(pattern string, handler Handler)

PATCH adds a Handler for HTTP PATCH method for a route pattern.

func (*App) POST

func (a *App) POST(pattern string, handler Handler)

POST adds a Handler for HTTP POST method for a route pattern.

func (*App) PUT

func (a *App) PUT(pattern string, handler Handler)

PUT adds a Handler for HTTP PUT method for a route pattern.

func (*App) RegisterService

func (a *App) RegisterService(desc *grpc.ServiceDesc, impl any)

RegisterService adds a gRPC service to the GoFr application.

func (*App) Run

func (a *App) Run()

Run starts the application. If it is an HTTP server, it will start the server.

func (*App) Shutdown

func (a *App) Shutdown(ctx context.Context) error

Shutdown stops the service(s) and close the application. It shuts down the HTTP, gRPC, Metrics servers and closes the container's active connections to datasources.

func (*App) SubCommand

func (a *App) SubCommand(pattern string, handler Handler, options ...Options)

SubCommand adds a sub-command to the CLI application. Can be used to create commands like "kubectl get" or "kubectl get ingress".

func (*App) Subscribe

func (a *App) Subscribe(topic string, handler SubscribeFunc)

Subscribe registers a handler for the given topic.

If the subscriber is not initialized in the container, an error is logged and the subscription is not registered.

func (*App) UseMiddleware

func (a *App) UseMiddleware(middlewares ...gofrHTTP.Middleware)

UseMiddleware is a setter method for adding user defined custom middleware to GoFr's router.

func (*App) UseMongo

func (a *App) UseMongo(db container.Mongo)

UseMongo sets the Mongo datasource in the app's container. Deprecated: Use the AddMongo method instead.

func (*App) WebSocket

func (a *App) WebSocket(route string, handler Handler)

WebSocket registers a handler function for a WebSocket route. This method allows you to define a route handler for WebSocket connections. It internally handles the WebSocket handshake and provides a `websocket.Connection` object within the handler context. User can access the underlying WebSocket connection using `ctx.GetWebsocketConnection()`.

type CRUD

type CRUD interface {
	Create
	GetAll
	Get
	Update
	Delete
}

type Context

type Context struct {
	context.Context

	// Request needs to be public because handlers need to access request details. Else, we need to provide all
	// functionalities of the Request as a method on context. This is not needed because Request here is an interface
	// So, internals are not exposed anyway.
	Request

	// Same logic as above.
	*container.Container
	// contains filtered or unexported fields
}

func (*Context) Bind

func (c *Context) Bind(i interface{}) error

func (*Context) Trace

func (c *Context) Trace(name string) trace.Span

Trace returns an open telemetry span. We have to always close the span after corresponding work is done. Usages:

span := c.Trace("Some Work")
// Do some work here.
defer span.End()

If an entire function has to traced as span, we can use a simpler format:

defer c.Trace("ExampleHandler").End()

We can write this at the start of function and because of how defer works, trace will start at that line but End will be called after function ends.

Developer Note: If you chain methods in a defer statement, everything except the last function will be evaluated at call time.

func (*Context) WriteMessageToSocket

func (c *Context) WriteMessageToSocket(data any) error

WriteMessageToSocket writes a message to the WebSocket connection associated with the context. The data parameter can be of type string, []byte, or any struct that can be marshaled to JSON. It retrieves the WebSocket connection from the context and sends the message as a TextMessage.

type Create

type Create interface {
	Create(c *Context) (interface{}, error)
}

type CronFunc

type CronFunc func(ctx *Context)

type Crontab

type Crontab struct {
	// contains filtered or unexported fields
}

Crontab maintains the job scheduling and runs the jobs at their scheduled time by going through them at each tick using a ticker.

func NewCron

func NewCron(cntnr *container.Container) *Crontab

NewCron initializes and returns new cron tab.

func (*Crontab) AddJob

func (c *Crontab) AddJob(schedule, jobName string, fn CronFunc) error

AddJob to cron tab, returns error if the cron syntax can't be parsed or is out of bounds.

type Delete

type Delete interface {
	Delete(c *Context) (interface{}, error)
}

type ErrCommandNotFound

type ErrCommandNotFound struct{}

func (ErrCommandNotFound) Error

func (ErrCommandNotFound) Error() string

type ErrorLogEntry

type ErrorLogEntry struct {
	TraceID string `json:"trace_id,omitempty"`
	Error   string `json:"error,omitempty"`
}

func (*ErrorLogEntry) PrettyPrint

func (el *ErrorLogEntry) PrettyPrint(writer io.Writer)

type Exporter

type Exporter struct {
	// contains filtered or unexported fields
}

Exporter is responsible for exporting spans to a remote endpoint.

func NewExporter

func NewExporter(endpoint string, logger logging.Logger) *Exporter

NewExporter creates a new Exporter instance with a custom endpoint and logger.

func (*Exporter) ExportSpans

func (e *Exporter) ExportSpans(ctx context.Context, spans []sdktrace.ReadOnlySpan) error

ExportSpans exports spans to the configured remote endpoint.

func (*Exporter) Shutdown

func (*Exporter) Shutdown(context.Context) error

Shutdown shuts down the exporter.

type Get

type Get interface {
	Get(c *Context) (interface{}, error)
}

type GetAll

type GetAll interface {
	GetAll(c *Context) (interface{}, error)
}

type Handler

type Handler func(c *Context) (interface{}, error)

type Options

type Options func(c *route)

func AddDescription

func AddDescription(descString string) Options

AddDescription adds the description text for a specified subcommand.

func AddHelp

func AddHelp(helperString string) Options

AddHelp adds the helper text for the given subcommand this is displayed when -h or --help option/flag is provided.

type Request

type Request interface {
	Context() context.Context
	Param(string) string
	PathParam(string) string
	Bind(interface{}) error
	HostName() string
	Params(string) []string
}

Request is an interface which is written because it allows us to create applications without being aware of the transport. In both cmd or server application, this abstraction can be used.

type Responder

type Responder interface {
	Respond(data interface{}, err error)
}

Responder is used by the application to provide output. This is implemented for both cmd and HTTP server application.

type RestPathOverrider

type RestPathOverrider interface {
	RestPath() string
}

type Span

type Span struct {
	TraceID       string            `json:"traceId"`            // Trace ID of the span.
	ID            string            `json:"id"`                 // ID of the span.
	ParentID      string            `json:"parentId,omitempty"` // Parent ID of the span.
	Name          string            `json:"name"`               // Name of the span.
	Timestamp     int64             `json:"timestamp"`          // Timestamp of the span.
	Duration      int64             `json:"duration"`           // Duration of the span.
	Tags          map[string]string `json:"tags,omitempty"`     // Tags associated with the span.
	LocalEndpoint map[string]string `json:"localEndpoint"`      // Local endpoint of the span.
}

Span represents a span that will be exported.

type SubscribeFunc

type SubscribeFunc func(c *Context) error

type SubscriptionManager

type SubscriptionManager struct {
	// contains filtered or unexported fields
}

type TableNameOverrider

type TableNameOverrider interface {
	TableName() string
}

type Update

type Update interface {
	Update(c *Context) (interface{}, error)
}