handlers

Documentation

Overview

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Package handlers //

Index

• Variables
• func Activate(w http.ResponseWriter, r *http.Request)
• func NotificationEventSteamHandler(w http.ResponseWriter, r *http.Request)
• func OptimizelyConfig(w http.ResponseWriter, r *http.Request)
• func Override(w http.ResponseWriter, r *http.Request)
• func ParseRequestBody(r *http.Request, v interface{}) error
• func RenderError(err error, status int, w http.ResponseWriter, r *http.Request)
• func TrackEvent(w http.ResponseWriter, r *http.Request)
• type ActivateBody
• type Admin
  • func NewAdmin(conf config.AgentConfig) *Admin
  • func (a Admin) AppConfig(w http.ResponseWriter, r *http.Request)
  • func (a Admin) AppInfo(w http.ResponseWriter, r *http.Request)
  • func (a Admin) AppInfoHeader(next http.Handler) http.Handler
  • func (a Admin) Metrics(w http.ResponseWriter, r *http.Request)
• type ClientCredentials
• type ClientCredentialsError
  • func (err *ClientCredentialsError) Error() string
• type DatafileUpdateData
• type ErrorResponse
• type Info
• type JSON
• type MessageChan
• type OAuthHandler
  • func NewOAuthHandler(authConfig *config.ServiceAuthConfig) *OAuthHandler
  • func (h *OAuthHandler) CreateAPIAccessToken(w http.ResponseWriter, r *http.Request)
  • func (h *OAuthHandler) CreateAdminAccessToken(w http.ResponseWriter, r *http.Request)
• type OptlyMessage
• type OptlyWebhookHandler
  • func NewWebhookHandler(optlyCache optimizely.Cache, projectMap map[int64]config.WebhookProject) *OptlyWebhookHandler
  • func (h *OptlyWebhookHandler) HandleWebhook(w http.ResponseWriter, r *http.Request)
• type OverrideBody

Variables

var ErrEmptyUserID = errors.New(`missing "userId" in request payload`)

ErrEmptyUserID is a constant error if userId is omitted from the request

Functions

func Activate

func Activate(w http.ResponseWriter, r *http.Request)

Activate makes feature and experiment decisions for the selected query parameters.

func NotificationEventSteamHandler

func NotificationEventSteamHandler(w http.ResponseWriter, r *http.Request)

NotificationEventSteamHandler implements the http.Handler interface.

func OptimizelyConfig

func OptimizelyConfig(w http.ResponseWriter, r *http.Request)

OptimizelyConfig returns the entire OptimizelyConfig object directly from the SDK

func Override

func Override(w http.ResponseWriter, r *http.Request)

Override is used to set forced variations for a given experiment or feature test

func ParseRequestBody

func ParseRequestBody(r *http.Request, v interface{}) error

ParseRequestBody reads the request body from the request and unmarshals it into the provided interface. Note that we're sanitizing the returned error so that it is not leaked back to the requestor.

func RenderError

func RenderError(err error, status int, w http.ResponseWriter, r *http.Request)

RenderError sets the request status and renders the error message.

func TrackEvent

func TrackEvent(w http.ResponseWriter, r *http.Request)

TrackEvent - track a given event for the current user

Types

type ActivateBody

type ActivateBody struct {
	UserID         string                 `json:"userId"`
	UserAttributes map[string]interface{} `json:"userAttributes"`
}

ActivateBody defines the request body for an activation

type Admin

type Admin struct {
	Config config.AgentConfig
	Info   Info
}

Admin is holding info to pass to admin handlers

func NewAdmin

func NewAdmin(conf config.AgentConfig) *Admin

NewAdmin initializes admin

func (Admin) AppConfig

func (a Admin) AppConfig(w http.ResponseWriter, r *http.Request)

AppConfig returns the agent configuration

func (Admin) AppInfo

func (a Admin) AppInfo(w http.ResponseWriter, r *http.Request)

AppInfo returns custom app-info

func (Admin) AppInfoHeader

func (a Admin) AppInfoHeader(next http.Handler) http.Handler

AppInfoHeader adds custom app-info to the response header

func (Admin) Metrics

func (a Admin) Metrics(w http.ResponseWriter, r *http.Request)

Metrics returns expvar info

type ClientCredentials

type ClientCredentials struct {
	ID         string
	TTL        time.Duration
	SecretHash []byte
	SDKKeys    []string
}

ClientCredentials has all info for client credentials

type ClientCredentialsError

type ClientCredentialsError struct {
	ErrorCode        string `json:"error"`
	ErrorDescription string `json:"error_description,omitempty"`
}

ClientCredentialsError is the response body returned when the provided client credentials are invalid

func (*ClientCredentialsError) Error

func (err *ClientCredentialsError) Error() string

type DatafileUpdateData

type DatafileUpdateData struct {
	Revision    int32  `json:"revision"`
	OriginURL   string `json:"origin_url"`
	CDNUrl      string `json:"cdn_url"`
	Environment string `json:"environment"`
}

DatafileUpdateData model which represents data specific to datafile update

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse Model

type Info

type Info struct {
	Version string `json:"version,omitempty"`
	Author  string `json:"author,omitempty"`
	AppName string `json:"app_name,omitempty"`
	Uptime  string `json:"uptime"`
	Host    string `json:"host,omitempty"`
}

Info holds the detail to support the info endpoint

type JSON

type JSON map[string]interface{}

JSON is a map alias, just for convenience

type MessageChan

type MessageChan chan []byte

A MessageChan is a channel of bytes Each http handler call creates a new channel and pumps decision service messages onto it.

type OAuthHandler

type OAuthHandler struct {
	ClientCredentials map[string]ClientCredentials
	// contains filtered or unexported fields
}

OAuthHandler provides handler for auth

func NewOAuthHandler

func NewOAuthHandler(authConfig *config.ServiceAuthConfig) *OAuthHandler

NewOAuthHandler creates new handler for auth

func (*OAuthHandler) CreateAPIAccessToken

func (h *OAuthHandler) CreateAPIAccessToken(w http.ResponseWriter, r *http.Request)

CreateAPIAccessToken returns a JWT access token for the API service

func (*OAuthHandler) CreateAdminAccessToken

func (h *OAuthHandler) CreateAdminAccessToken(w http.ResponseWriter, r *http.Request)

CreateAdminAccessToken returns a JWT access token for the Admin service

type OptlyMessage

type OptlyMessage struct {
	ProjectID int64              `json:"project_id"`
	Timestamp int64              `json:"timestamp"`
	Event     string             `json:"event"`
	Data      DatafileUpdateData `json:"data"`
}

OptlyMessage model which represents any message received from Optimizely

type OptlyWebhookHandler

type OptlyWebhookHandler struct {
	ProjectMap map[int64]config.WebhookProject
	// contains filtered or unexported fields
}

OptlyWebhookHandler handles incoming messages from Optimizely

func NewWebhookHandler

func NewWebhookHandler(optlyCache optimizely.Cache, projectMap map[int64]config.WebhookProject) *OptlyWebhookHandler

NewWebhookHandler returns a new instance of OptlyWebhookHandler

func (*OptlyWebhookHandler) HandleWebhook

func (h *OptlyWebhookHandler) HandleWebhook(w http.ResponseWriter, r *http.Request)

HandleWebhook handles incoming webhook messages from Optimizely application

type OverrideBody

type OverrideBody struct {
	UserID        string `json:"userId"`
	ExperimentKey string `json:"experimentKey"`
	VariationKey  string `json:"variationKey"`
}

OverrideBody defines the request body for an override