bramble

May 1, 2024

Changes in this version

type BasePlugin

+ func (p *BasePlugin) SetupGatewayHandler(handler *handler.Server)

type Plugin

+ SetupGatewayHandler func(handler *handler.Server)

Mar 19, 2024

Changes in this version

+ func InitTelemetry(ctx context.Context, cfg TelemetryConfig) (func(context.Context) error, error)

type AllowedFields

+ func (a AllowedFields) String() string

type Config

+ Telemetry TelemetryConfig

type Request

+ OperationType string

+ func (r *Request) WithOperationType(operation string) *Request

+ type TelemetryConfig struct

+ Enabled bool

+ Endpoint string

+ Insecure bool

+ ServiceName string

+ type TelemetryErrHandler struct

+ func (e *TelemetryErrHandler) Handle(err error)

Nov 28, 2023

Changes in this version

type Config

+ DefaultTimeouts TimeoutConfig

+ GatewayTimeouts TimeoutConfig

+ PrivateTimeouts TimeoutConfig

+ type TimeoutConfig struct

+ IdleTimeout string

+ IdleTimeoutDuration time.Duration

+ ReadTimeout string

+ ReadTimeoutDuration time.Duration

+ WriteTimeout string

+ WriteTimeoutDuration time.Duration

May 3, 2023

Changes in this version

type BasePlugin

+ func (p *BasePlugin) InterceptResponse(ctx context.Context, operationName, rawQuery string, ...) *graphql.Response

type Plugin

+ InterceptResponse func(ctx context.Context, operationName, rawQuery string, ...) *graphql.Response

Nov 22, 2022

Changes in this version

type Request

+ func (r *Request) WithOperationName(operationName string) *Request

+ func (r *Request) WithVariables(variables map[string]interface{}) *Request

Sep 21, 2022

Changes in this version

type Config

+ DisableIntrospection bool

May 1, 2022

Changes in this version

type BasePlugin

+ func (p *BasePlugin) InterceptRequest(ctx context.Context, operationName, rawQuery string, ...)

+ func (p *BasePlugin) WrapGraphQLClientTransport(transport http.RoundTripper) http.RoundTripper

type GraphQLClient

+ func NewClientWithPlugins(plugins []Plugin, opts ...ClientOpt) *GraphQLClient

type Plugin

+ InterceptRequest func(ctx context.Context, operationName, rawQuery string, ...)

+ WrapGraphQLClientTransport func(http.RoundTripper) http.RoundTripper

Apr 11, 2022

Changes in this version

type GraphQLClient

+ func NewClientWithoutKeepAlive(opts ...ClientOpt) *GraphQLClient

Apr 7, 2022

Changes in this version

type ExecutableSchema

+ func NewExecutableSchema(plugins []Plugin, maxRequestsPerQuery int64, client *GraphQLClient, ...) *ExecutableSchema

Feb 17, 2022

Changes in this version

type ClientOpt

+ func WithHTTPClient(client *http.Client) ClientOpt

type Config

+ QueryHTTPClient *http.Client

Dec 20, 2021

Changes in this version

+ var IdFieldName = "id"

type BoundaryField

+ Argument string

type Config

+ IdFieldName string

Nov 3, 2021

Changes in this version

+ type BoundaryField struct

+ Array bool

+ Field string

+ type BoundaryFieldsMap map[string]map[string]BoundaryField

+ func (m BoundaryFieldsMap) Field(serviceURL, typeName string) (BoundaryField, error)

+ func (m BoundaryFieldsMap) RegisterField(serviceURL, typeName, field string, array bool)

type Config

+ GatewayListenAddress string

+ MetricsListenAddress string

+ PrivateListenAddress string

+ func (c *Config) PrivateHttpAddress(path string) string

type GraphqlError

+ Path ast.Path

type Request

+ func (r *Request) WithHeaders(headers http.Header) *Request

Jun 28, 2021

Changes in this version

type FieldURLMap

+ func (m FieldURLMap) URLFor(parent, parentLocation, field string) (string, error)

+ type QueryPlan struct

+ RootSteps []*QueryPlanStep

+ type QueryPlanStep struct

+ InsertionPoint []string

+ ParentType string

+ SelectionSet ast.SelectionSet

+ ServiceName string

+ ServiceURL string

+ Then []*QueryPlanStep

+ func (s *QueryPlanStep) MarshalJSON() ([]byte, error)

May 23, 2021

Changes in this version

+ var Version = "dev"

+ func GenerateUserAgent(operation string) string

May 21, 2021

Changes in this version

type ClientOpt

+ func WithUserAgent(userAgent string) ClientOpt

type GraphQLClient

+ UserAgent string

type GraphqlError

+ Extensions map[string]interface{}

Apr 14, 2021

Changes in this version

type AllowedFields

+ func MergeAllowedFields(allowedFields ...AllowedFields) AllowedFields

type OperationPermissions

+ func MergePermissions(perms ...OperationPermissions) OperationPermissions

Mar 25, 2021

Changes in this version

+ type BoundaryQueriesMap map[string]map[string]BoundaryQuery

+ func (m BoundaryQueriesMap) Query(serviceURL, typeName string) BoundaryQuery

+ func (m BoundaryQueriesMap) RegisterQuery(serviceURL, typeName, query string, array bool)

+ type BoundaryQuery struct

+ Array bool

+ Query string

+ type ClientOpt func(*GraphQLClient)

+ func WithMaxResponseSize(maxResponseSize int64) ClientOpt

type Config

+ MaxServiceResponseSize int64

type ExecutableSchema

+ BoundaryQueries BoundaryQueriesMap

Feb 28, 2021

Changes in this version

+ const DebugKey

+ func AddField(ctx context.Context, name string, value interface{})

+ func AddFields(ctx context.Context, fields EventFields)

+ func AddOutgoingRequestsHeaderToContext(ctx context.Context, key, value string) context.Context

+ func AddPermissionsToContext(ctx context.Context, perms OperationPermissions) context.Context

+ func GetOutgoingRequestHeadersFromContext(ctx context.Context) http.Header

+ func Main()

+ func MergeSchemas(schemas ...*ast.Schema) (*ast.Schema, error)

+ func NewMetricsHandler() http.Handler

+ func Plan(ctx *PlanningContext) (*queryPlan, error)

+ func RegisterMetrics()

+ func RegisterPlugin(p Plugin)

+ func RegisteredPlugins() map[string]Plugin

+ func TraceIDFromContext(ctx context.Context) string

+ func ValidateSchema(schema *ast.Schema) error

+ type AllowedFields struct

+ AllowAll bool

+ AllowedSubfields map[string]AllowedFields

+ func (a *AllowedFields) UnmarshalJSON(input []byte) error

+ func (a AllowedFields) IsAllowed(fieldName string) (bool, AllowedFields)

+ func (a AllowedFields) MarshalJSON() ([]byte, error)

+ type BasePlugin struct

+ func (p *BasePlugin) ApplyMiddlewarePrivateMux(h http.Handler) http.Handler

+ func (p *BasePlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler

+ func (p *BasePlugin) Configure(*Config, json.RawMessage) error

+ func (p *BasePlugin) GraphqlQueryPath() (bool, string)

+ func (p *BasePlugin) Init(s *ExecutableSchema)

+ func (p *BasePlugin) ModifyExtensions(ctx context.Context, e *QueryExecution, extensions map[string]interface{}) error

+ func (p *BasePlugin) SetupPrivateMux(mux *http.ServeMux)

+ func (p *BasePlugin) SetupPublicMux(mux *http.ServeMux)

+ type Config struct

+ Extensions map[string]json.RawMessage

+ GatewayPort int

+ LogLevel log.Level

+ MaxRequestsPerQuery int64

+ MetricsPort int

+ Plugins []PluginConfig

+ PollInterval string

+ PollIntervalDuration time.Duration

+ PrivatePort int

+ Services []string

+ func GetConfig(configFiles []string) (*Config, error)

+ func (c *Config) ConfigurePlugins() []Plugin

+ func (c *Config) GatewayAddress() string

+ func (c *Config) Init() error

+ func (c *Config) MetricAddress() string

+ func (c *Config) PrivateAddress() string

+ func (cfg *Config) Load() error

+ func (cfg *Config) Watch()

+ type DebugInfo struct

+ Plan bool

+ Query bool

+ Timing bool

+ TraceID bool

+ Variables bool

+ type EventFields map[string]interface

+ type ExecutableSchema struct

+ GraphqlClient *GraphQLClient

+ IsBoundary map[string]bool

+ Locations FieldURLMap

+ MaxRequestsPerQuery int64

+ MergedSchema *ast.Schema

+ Services map[string]*Service

+ Tracer opentracing.Tracer

+ func (s *ExecutableSchema) Complexity(typeName, fieldName string, childComplexity int, args map[string]interface{}) (int, bool)

+ func (s *ExecutableSchema) Exec(ctx context.Context) graphql.ResponseHandler

+ func (s *ExecutableSchema) ExecuteQuery(ctx context.Context) *graphql.Response

+ func (s *ExecutableSchema) Schema() *ast.Schema

+ func (s *ExecutableSchema) UpdateSchema(forceRebuild bool) error

+ func (s *ExecutableSchema) UpdateServiceList(services []string) error

+ type FieldURLMap map[string]string

+ func (m FieldURLMap) KeyFor(parent string, field string) string

+ func (m FieldURLMap) RegisterURL(parent string, field string, location string)

+ func (m FieldURLMap) UrlFor(parent, parentLocation, field string) (string, error)

+ type Gateway struct

+ ExecutableSchema *ExecutableSchema

+ func NewGateway(executableSchema *ExecutableSchema, plugins []Plugin) *Gateway

+ func (g *Gateway) PrivateRouter() http.Handler

+ func (g *Gateway) Router() http.Handler

+ func (g *Gateway) UpdateSchemas(interval time.Duration)

+ type GraphQLClient struct

+ HTTPClient *http.Client

+ MaxResponseSize int64

+ Tracer opentracing.Tracer

+ func NewClient() *GraphQLClient

+ func (c *GraphQLClient) Request(ctx context.Context, url string, request *Request, out interface{}) error

+ type GraphqlError struct

+ Message string

+ type GraphqlErrors []GraphqlError

+ func (e GraphqlErrors) Error() string

+ type OperationPermissions struct

+ AllowedRootMutationFields AllowedFields

+ AllowedRootQueryFields AllowedFields

+ AllowedRootSubscriptionFields AllowedFields

+ func GetPermissionsFromContext(ctx context.Context) (OperationPermissions, bool)

+ func (o *OperationPermissions) FilterAuthorizedFields(op *ast.OperationDefinition) gqlerror.List

+ func (o *OperationPermissions) FilterSchema(schema *ast.Schema) *ast.Schema

+ func (o OperationPermissions) MarshalJSON() ([]byte, error)

+ type PlanningContext struct

+ IsBoundary map[string]bool

+ Locations FieldURLMap

+ Operation *ast.OperationDefinition

+ Schema *ast.Schema

+ Services map[string]*Service

+ type Plugin interface

+ ApplyMiddlewarePrivateMux func(http.Handler) http.Handler

+ ApplyMiddlewarePublicMux func(http.Handler) http.Handler

+ Configure func(cfg *Config, pluginCfg json.RawMessage) error

+ GraphqlQueryPath func() (bool, string)

+ ID func() string

+ Init func(schema *ExecutableSchema)

+ ModifyExtensions func(ctx context.Context, e *QueryExecution, extensions map[string]interface{}) error

+ SetupPrivateMux func(mux *http.ServeMux)

+ SetupPublicMux func(mux *http.ServeMux)

+ type PluginConfig struct

+ Config json.RawMessage

+ Name string

+ type QueryExecution struct

+ Errors []*gqlerror.Error

+ RequestCount int64

+ Schema *ast.Schema

+ type Request struct

+ Headers http.Header

+ OperationName string

+ Query string

+ Variables map[string]interface{}

+ func NewRequest(body string) *Request

+ type Response struct

+ Data interface{}

+ Errors GraphqlErrors

+ type Service struct

+ Name string

+ Schema *ast.Schema

+ SchemaSource string

+ ServiceURL string

+ Status string

+ Version string

+ func NewService(serviceURL string) *Service

+ func (s *Service) Update() (bool, error)