gateway

Documentation

Index

• type Handle
  • func (gw *Handle) NewSourceStat(arctx *gwtypes.AuthRequestContext, reqType string) *gwstats.SourceStat
  • func (gw *Handle) ProcessWebRequest(w *http.ResponseWriter, r *http.Request, reqType string, payload []byte, ...) string
  • func (gw *Handle) SaveWebhookFailures(reqs []*model.FailedWebhookPayload) error
  • func (gw *Handle) Setup(ctx context.Context, config *config.Config, logger logger.Logger, ...) error
  • func (gw *Handle) Shutdown() error
  • func (gw *Handle) StartWebHandler(ctx context.Context) error
  • func (gw *Handle) TrackRequestMetrics(errorMessage string)
• type ImportRequestHandler
  • func (irh *ImportRequestHandler) ProcessRequest(w *http.ResponseWriter, r *http.Request, _ string, payload []byte, ...) string
• type RegularRequestHandler
  • func (rrh *RegularRequestHandler) ProcessRequest(w *http.ResponseWriter, r *http.Request, reqType string, payload []byte, ...) string
• type RequestHandler

Types

type Handle

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

func (*Handle) NewSourceStat

func (gw *Handle) NewSourceStat(arctx *gwtypes.AuthRequestContext, reqType string) *gwstats.SourceStat

NewSourceStat creates a new source stat for a gateway request

func (*Handle) ProcessWebRequest

func (gw *Handle) ProcessWebRequest(w *http.ResponseWriter, r *http.Request, reqType string, payload []byte, arctx *gwtypes.AuthRequestContext) string

ProcessWebRequest is an interface wrapper for webhook

func (*Handle) SaveWebhookFailures

func (gw *Handle) SaveWebhookFailures(reqs []*model.FailedWebhookPayload) error

SaveWebhookFailures saves errors to the error db

func (*Handle) Setup

func (gw *Handle) Setup(
	ctx context.Context,
	config *config.Config, logger logger.Logger, stat stats.Stats,
	application app.App, backendConfig backendconfig.BackendConfig, jobsDB, errDB jobsdb.JobsDB,
	rateLimiter throttler.Throttler, versionHandler func(w http.ResponseWriter, r *http.Request),
	rsourcesService rsources.JobService, sourcehandle sourcedebugger.SourceDebugger,
) error

Setup initializes this module: - Monitors backend config for changes. - Starts web request batching goroutine, that batches incoming messages. - Starts web request batch db writer goroutine, that writes incoming batches to JobsDB. - Starts debugging goroutine that prints gateway stats.

This function will block until backend config is initially received.

func (*Handle) Shutdown

func (gw *Handle) Shutdown() error

Shutdown the gateway

func (*Handle) StartWebHandler

func (gw *Handle) StartWebHandler(ctx context.Context) error

StartWebHandler starts all gateway web handlers, listening on gateway port. Supports CORS from all origins. This function will block.

func (*Handle) TrackRequestMetrics

func (gw *Handle) TrackRequestMetrics(errorMessage string)

TrackRequestMetrics updates the track counters (success and failure counts)

type ImportRequestHandler

type ImportRequestHandler struct {
	*Handle
}

ImportRequestHandler is an empty struct to capture import specific request handling functionality

func (*ImportRequestHandler) ProcessRequest

func (irh *ImportRequestHandler) ProcessRequest(w *http.ResponseWriter, r *http.Request, _ string, payload []byte, arctx *gwtypes.AuthRequestContext) string

ProcessRequest on ImportRequestHandler splits payload by user and throws them into the webrequestQ and waits for all their responses before returning

type RegularRequestHandler

type RegularRequestHandler struct {
	*Handle
}

RegularRequestHandler is an empty struct to capture non-import specific request handling functionality

func (*RegularRequestHandler) ProcessRequest

func (rrh *RegularRequestHandler) ProcessRequest(w *http.ResponseWriter, r *http.Request, reqType string, payload []byte, arctx *gwtypes.AuthRequestContext) string

ProcessRequest throws a webRequest into the queue and waits for the response before returning

type RequestHandler

type RequestHandler interface {
	ProcessRequest(w *http.ResponseWriter, r *http.Request, reqType string, payload []byte, arctx *gwtypes.AuthRequestContext) string
}

RequestHandler interface for abstracting out server-side import request processing and rest of the calls