apihandler

Documentation

Index

• Constants
• func MergeJsonRightIntoLeft(left, right []byte) []byte
• func NewApiTransport(httpTransport *http.Transport, enableStreamingMode bool, ...) http.RoundTripper
• func NewRequestFromWunderGraphClientRequest(ctx context.Context, body []byte) (*http.Request, error)
• type Api
  • func (api *Api) HasCookieAuthEnabled() bool
• type ApiTransport
  • func (t *ApiTransport) RoundTrip(request *http.Request) (*http.Response, error)
• type ApiTransportFactory
  • func NewApiTransportFactory(opts ApiTransportOptions) ApiTransportFactory
• type ApiTransportOptions
• type Builder
  • func NewBuilder(pool *pool.Pool, log *zap.Logger, ...) *Builder
  • func (r *Builder) BuildAndMountApiHandler(ctx context.Context, router *mux.Router, api *Api, planCache *ristretto.Cache) (streamClosers []chan struct{}, err error)
  • func (r *Builder) Close() error
• type BuilderConfig
• type Claims
• type CookieBasedSecrets
  • func NewCookieBasedSecrets() (cookieBasedSecrets *CookieBasedSecrets, warnMessages []string)
  • func NewDevModeCookieBasedSecrets() (cookieBasedSecrets *CookieBasedSecrets, errorMessages []string)
• type EndpointUnavailableHandler
  • func (m *EndpointUnavailableHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type FunctionsHandler
  • func (h *FunctionsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GraphQLHandler
  • func (h *GraphQLHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GraphQLHandlerOptions
• type GraphQLPlaygroundHandler
  • func (h *GraphQLPlaygroundHandler) ServeHTTP(w http.ResponseWriter, _ *http.Request)
• type InternalApiHandler
  • func (h *InternalApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type InternalBuilder
  • func NewInternalBuilder(config InternalBuilderConfig) *InternalBuilder
  • func (i *InternalBuilder) BuildAndMountInternalApiHandler(ctx context.Context, router *mux.Router, api *Api, planCache *ristretto.Cache) (streamClosers []chan struct{}, err error)
• type InternalBuilderConfig
• type InternalSubscriptionApiHandler
  • func (h *InternalSubscriptionApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Listener
• type Logging
• type MutationHandler
  • func (h *MutationHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type OpenTelemetry
• type Options
• type PrometheusOptions
• type QueryHandler
  • func (h *QueryHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type QueryResolver
• type SubscriptionHandler
  • func (h *SubscriptionHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type SubscriptionResolver
• type WgRequestParams
  • func NewWgRequestParams(r *http.Request) WgRequestParams

Constants

const (
	WgEnvCsrfSecret = "WG_CSRF_TOKEN_SECRET"
	WgEnvHashKey    = "WG_SECURE_COOKIE_HASH_KEY"
	WgEnvBlockKey   = "WG_SECURE_COOKIE_BLOCK_KEY"
)

const (
	WgInternalApiCallHeader = "X-WG-Internal-GraphQL-API"

	WgPrefix             = "wg_"
	WgVariables          = WgPrefix + "variables"
	WgLiveParam          = WgPrefix + "live"
	WgJsonPatchParam     = WgPrefix + "json_patch"
	WgSseParam           = WgPrefix + "sse"
	WgSubscribeOnceParam = WgPrefix + "subscribe_once"
)

const (
	ErrMsgOperationParseFailed         = "failed to parse operation: %w"
	ErrMsgOperationNormalizationFailed = "failed to normalize operation: %w"
	ErrMsgOperationValidationFailed    = "operation validation failed: %w"
	ErrMsgOperationPlanningFailed      = "operation planning failed: %w"
)

Functions

func MergeJsonRightIntoLeft

func MergeJsonRightIntoLeft(left, right []byte) []byte

MergeJsonRightIntoLeft merges the right JSON into the left JSON while overriding the left side

func NewApiTransport

func NewApiTransport(httpTransport *http.Transport, enableStreamingMode bool, opts ApiTransportOptions) http.RoundTripper

func NewRequestFromWunderGraphClientRequest

func NewRequestFromWunderGraphClientRequest(ctx context.Context, body []byte) (*http.Request, error)

Types

type Api

type Api struct {
	PrimaryHost           string
	Hosts                 []string
	EngineConfiguration   *wgpb.EngineConfiguration
	EnableSingleFlight    bool
	EnableGraphqlEndpoint bool
	Operations            []*wgpb.Operation
	InvalidOperationNames []string
	CorsConfiguration     *wgpb.CorsConfiguration
	ApiConfigHash         string
	AuthenticationConfig  *wgpb.ApiAuthenticationConfig
	S3UploadConfiguration []*wgpb.S3UploadConfiguration
	Webhooks              []*wgpb.WebhookConfiguration
	Options               *Options
	CookieBasedSecrets    *CookieBasedSecrets
}

func (*Api) HasCookieAuthEnabled

func (api *Api) HasCookieAuthEnabled() bool

type ApiTransport

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

func (*ApiTransport) RoundTrip

func (t *ApiTransport) RoundTrip(request *http.Request) (*http.Response, error)

type ApiTransportFactory

type ApiTransportFactory interface {
	RoundTripper(transport *http.Transport, enableStreamingMode bool) http.RoundTripper
	DefaultTransportTimeout() time.Duration
	DefaultHTTPProxyURL() *url.URL
}

func NewApiTransportFactory

func NewApiTransportFactory(opts ApiTransportOptions) ApiTransportFactory

type ApiTransportOptions

type ApiTransportOptions struct {
	API                  *Api
	HooksClient          *hooks.Client
	EnableRequestLogging bool
	EnableTracing        bool
	Metrics              metrics.Metrics
}

type Builder

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

func NewBuilder

func NewBuilder(pool *pool.Pool,
	log *zap.Logger,
	loader *engineconfigloader.EngineConfigLoader,
	hooksClient *hooks.Client,
	config BuilderConfig,
) *Builder

func (*Builder) BuildAndMountApiHandler

func (r *Builder) BuildAndMountApiHandler(ctx context.Context, router *mux.Router, api *Api, planCache *ristretto.Cache) (streamClosers []chan struct{}, err error)

func (*Builder) Close

func (r *Builder) Close() error

type BuilderConfig

type BuilderConfig struct {
	InsecureCookies            bool
	ForceHttpsRedirects        bool
	EnableRequestLogging       bool
	EnableIntrospection        bool
	GitHubAuthDemoClientID     string
	GitHubAuthDemoClientSecret string
	DevMode                    bool
	Metrics                    metrics.Metrics
}

type Claims

type Claims struct {
	Name string `json:"name"`
	jwt.StandardClaims
}

type CookieBasedSecrets

type CookieBasedSecrets struct {
	CsrfSecret []byte
	BlockKey   []byte
	HashKey    []byte
}

func NewCookieBasedSecrets

func NewCookieBasedSecrets() (cookieBasedSecrets *CookieBasedSecrets, warnMessages []string)

func NewDevModeCookieBasedSecrets

func NewDevModeCookieBasedSecrets() (cookieBasedSecrets *CookieBasedSecrets, errorMessages []string)

type EndpointUnavailableHandler

type EndpointUnavailableHandler struct {
	OperationName string
	Logger        *zap.Logger
}

func (*EndpointUnavailableHandler) ServeHTTP

func (m *EndpointUnavailableHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type FunctionsHandler

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

func (*FunctionsHandler) ServeHTTP

func (h *FunctionsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GraphQLHandler

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

func (*GraphQLHandler) ServeHTTP

func (h *GraphQLHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GraphQLHandlerOptions

type GraphQLHandlerOptions struct {
	// GraphQLBaseURL indicates the base URL used by the playground to query the GraphQL API.
	// The GraphQL endpoint is determined as {GraphQLBaseURL}/graphql
	GraphQLBaseURL  string
	Internal        bool
	PlanConfig      plan.Configuration
	Definition      *ast.Document
	Resolver        *resolve.Resolver
	RenameTypeNames []resolve.RenameTypeName
	Pool            *pool.Pool
	Cache           *ristretto.Cache
	Log             *zap.Logger
}

type GraphQLPlaygroundHandler

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

func (*GraphQLPlaygroundHandler) ServeHTTP

func (h *GraphQLPlaygroundHandler) ServeHTTP(w http.ResponseWriter, _ *http.Request)

type InternalApiHandler

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

func (*InternalApiHandler) ServeHTTP

func (h *InternalApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type InternalBuilder

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

func NewInternalBuilder

func NewInternalBuilder(config InternalBuilderConfig) *InternalBuilder

func (*InternalBuilder) BuildAndMountInternalApiHandler

func (i *InternalBuilder) BuildAndMountInternalApiHandler(ctx context.Context, router *mux.Router, api *Api, planCache *ristretto.Cache) (streamClosers []chan struct{}, err error)

type InternalBuilderConfig

type InternalBuilderConfig struct {
	Pool                *pool.Pool
	Client              *hooks.Client
	Loader              *engineconfigloader.EngineConfigLoader
	EnableIntrospection bool
	InsecureCookies     bool
	Metrics             metrics.Metrics
	Log                 *zap.Logger
}

type InternalSubscriptionApiHandler

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

func (*InternalSubscriptionApiHandler) ServeHTTP

func (h *InternalSubscriptionApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Listener

type Listener struct {
	Host string
	Port uint16
}

type Logging

type Logging struct {
	Level zapcore.Level
}

type MutationHandler

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

func (*MutationHandler) ServeHTTP

func (h *MutationHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type OpenTelemetry

type OpenTelemetry struct {
	Enabled              bool
	ExporterHTTPEndpoint string
	AuthToken            string
	Sampler              float64
}

type Options

type Options struct {
	ServerUrl           string
	PublicNodeUrl       string
	Listener            *Listener
	InternalListener    *Listener
	Logging             Logging
	DefaultTimeout      time.Duration
	DefaultHTTPProxyURL *url.URL
	Prometheus          PrometheusOptions
	OpenTelemetry       OpenTelemetry
}

type PrometheusOptions

type PrometheusOptions struct {
	Enabled bool
	Port    int
}

type QueryHandler

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

func (*QueryHandler) ServeHTTP

func (h *QueryHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type QueryResolver

type QueryResolver interface {
	ResolveGraphQLResponse(ctx *resolve.Context, response *resolve.GraphQLResponse, data []byte, writer io.Writer) (err error)
}

type SubscriptionHandler

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

func (*SubscriptionHandler) ServeHTTP

func (h *SubscriptionHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type SubscriptionResolver

type SubscriptionResolver interface {
	ResolveGraphQLSubscription(ctx *resolve.Context, subscription *resolve.GraphQLSubscription, writer resolve.FlushWriter) (err error)
}

type WgRequestParams

type WgRequestParams struct {
	UseJsonPatch bool
	UseSse       bool
	SubsribeOnce bool
}

func NewWgRequestParams

func NewWgRequestParams(r *http.Request) WgRequestParams