runtime

Documentation

Index

• Constants
• func DetermineTTL(req *http.Request, resp *http.Response) time.Duration
• func InitCache(c Cache)
• func InitHTTP(cache Cache)
• func LoadCacheModule() (starlark.StringDict, error)
• func LoadSecretModule() (starlark.StringDict, error)
• type Applet
  • func (a *Applet) Call(callable *starlark.Function, args starlark.Tuple, ...) (val starlark.Value, err error)
  • func (app *Applet) CallSchemaHandler(ctx context.Context, handlerName, parameter string) (result string, err error)
  • func (app *Applet) GetSchema() string
  • func (a *Applet) Load(filename string, src []byte, loader ModuleLoader) (err error)
  • func (a *Applet) Run(config map[string]string, initializers ...ThreadInitializer) (roots []render.Root, err error)
• type AppletConfig
  • func (a AppletConfig) Attr(name string) (starlark.Value, error)
  • func (a AppletConfig) AttrNames() []string
  • func (a AppletConfig) Freeze()
  • func (a AppletConfig) Get(key starlark.Value) (starlark.Value, bool, error)
  • func (a AppletConfig) Hash() (uint32, error)
  • func (a AppletConfig) String() string
  • func (a AppletConfig) Truth() starlark.Bool
  • func (a AppletConfig) Type() string
• type Cache
• type InMemoryCache
  • func NewInMemoryCache() *InMemoryCache
  • func (c *InMemoryCache) Get(_ *starlark.Thread, key string) (value []byte, found bool, err error)
  • func (c *InMemoryCache) Set(_ *starlark.Thread, key string, value []byte, ttl int64) error
• type InMemoryCacheRecord
• type ModuleLoader
• type SecretDecryptionKey
• type SecretEncryptionKey
  • func (sek *SecretEncryptionKey) Encrypt(appName, plaintext string) (string, error)
• type ThreadInitializer

Constants

const (
	MinRequestTTL    = 5 * time.Second
	MaxResponseTTL   = 1 * time.Hour
	HTTPTimeout      = 5 * time.Second
	MaxResponseBytes = 20 * 1024 * 1024 // 20MB
	HTTPCachePrefix  = "httpcache"
)

const DefaultExpirationSeconds = 60

Functions

func DetermineTTL

func DetermineTTL(req *http.Request, resp *http.Response) time.Duration

DetermineTTL determines the TTL for a request based on the request and response. We first check request method / response status code to determine if we should actually cache the response. Then we check the headers passed in from starlark to see if the user configured a TTL. Finally, if the response is cachable but the developer didn't configure a TTL, we check the response to get a hint at what the TTL should be.

func InitCache

func InitCache(c Cache)

func InitHTTP

func InitHTTP(cache Cache)

func LoadCacheModule

func LoadCacheModule() (starlark.StringDict, error)

func LoadSecretModule

func LoadSecretModule() (starlark.StringDict, error)

Types

type Applet

type Applet struct {
	Filename            string
	Id                  string
	Globals             starlark.StringDict
	SecretDecryptionKey *SecretDecryptionKey
	// contains filtered or unexported fields
}

func (*Applet) Call

func (a *Applet) Call(callable *starlark.Function, args starlark.Tuple, initializers ...ThreadInitializer) (val starlark.Value, err error)

Calls any callable from Applet.Globals. Pass args and receive a starlark Value, or an error if you're unlucky.

func (*Applet) CallSchemaHandler

func (app *Applet) CallSchemaHandler(ctx context.Context, handlerName, parameter string) (result string, err error)

CallSchemaHandler calls a schema handler, passing it a single string parameter and returning a single string value.

func (*Applet) GetSchema

func (app *Applet) GetSchema() string

GetSchema returns the config for the applet.

func (*Applet) Load

func (a *Applet) Load(filename string, src []byte, loader ModuleLoader) (err error)

Loads an applet. The script filename is used as a descriptor only, and the actual code should be passed in src. Optionally also pass loader to make additional starlark modules available to the script.

func (*Applet) Run

func (a *Applet) Run(config map[string]string, initializers ...ThreadInitializer) (roots []render.Root, err error)

Runs the applet's main function, passing it configuration as a starlark dict.

type AppletConfig

type AppletConfig map[string]string

func (AppletConfig) Attr

func (a AppletConfig) Attr(name string) (starlark.Value, error)

func (AppletConfig) AttrNames

func (a AppletConfig) AttrNames() []string

func (AppletConfig) Freeze

func (a AppletConfig) Freeze()

func (AppletConfig) Get

func (a AppletConfig) Get(key starlark.Value) (starlark.Value, bool, error)

func (AppletConfig) Hash

func (a AppletConfig) Hash() (uint32, error)

func (AppletConfig) String

func (a AppletConfig) String() string

func (AppletConfig) Truth

func (a AppletConfig) Truth() starlark.Bool

func (AppletConfig) Type

func (a AppletConfig) Type() string

type Cache

type Cache interface {
	Set(thread *starlark.Thread, key string, value []byte, ttl int64) error
	Get(thread *starlark.Thread, key string) ([]byte, bool, error)
}

type InMemoryCache

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

func NewInMemoryCache

func NewInMemoryCache() *InMemoryCache

func (*InMemoryCache) Get

func (c *InMemoryCache) Get(_ *starlark.Thread, key string) (value []byte, found bool, err error)

func (*InMemoryCache) Set

func (c *InMemoryCache) Set(_ *starlark.Thread, key string, value []byte, ttl int64) error

type InMemoryCacheRecord

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

type ModuleLoader

type ModuleLoader func(*starlark.Thread, string) (starlark.StringDict, error)

type SecretDecryptionKey

type SecretDecryptionKey struct {
	// EncryptedKeysetJSON is the encrypted JSON representation of a Tink keyset.
	EncryptedKeysetJSON []byte

	// KeyEncryptionKey is a Tink key that can be used to decrypt the keyset.
	KeyEncryptionKey tink.AEAD
}

SecretDecryptionKey is a key that can be used to decrypt secrets.

type SecretEncryptionKey

type SecretEncryptionKey struct {
	// PublicKeysetJSON is the serialized JSON representation of a Tink keyset.
	PublicKeysetJSON []byte
}

SecretEncryptionKey is a key that can be used to encrypt secrets, but not decrypt them.

func (*SecretEncryptionKey) Encrypt

func (sek *SecretEncryptionKey) Encrypt(appName, plaintext string) (string, error)

Encrypt encrypts a value for use as a secret in an app. Provide both a value and the name of the app the encrypted secret will be used in. The value will only be usable with the specified app.

type ThreadInitializer

type ThreadInitializer func(thread *starlark.Thread) *starlark.Thread

ThreadInitializer is called when building a Starlark thread to run an applet on. It can customize the thread by overriding behavior or attaching thread local data.