runtime

Documentation

Index

• Constants
• func DetermineTTL(req *http.Request, resp *http.Response) time.Duration
• func ExtractRoots(val starlark.Value) ([]render.Root, error)
• func InitCache(c Cache)
• func InitHTTP(cache Cache)
• func LoadCacheModule() (starlark.StringDict, error)
• func LoadSecretModule() (starlark.StringDict, error)
• type Applet
  • func NewApplet(id string, src []byte, opts ...AppletOption) (*Applet, error)
  • func NewAppletFromFS(id string, fsys fs.FS, opts ...AppletOption) (*Applet, error)
  • func (a *Applet) Call(ctx context.Context, callable *starlark.Function, args ...starlark.Value) (val starlark.Value, err error)
  • func (app *Applet) CallSchemaHandler(ctx context.Context, handlerName, parameter string) (result string, err error)
  • func (a *Applet) PathsForBundle() []string
  • func (a *Applet) Run(ctx context.Context) (roots []render.Root, err error)
  • func (app *Applet) RunTests(t *testing.T)
  • func (a *Applet) RunWithConfig(ctx context.Context, config map[string]string) (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 AppletOption
  • func WithModuleLoader(loader ModuleLoader) AppletOption
  • func WithPrintDisabled() AppletOption
  • func WithPrintFunc(print PrintFunc) AppletOption
  • func WithSecretDecryptionKey(key *SecretDecryptionKey) AppletOption
  • func WithThreadInitializer(init ThreadInitializer) AppletOption
• 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 PrintFunc
• type SecretDecryptionKey
• type SecretEncryptionKey
  • func (sek *SecretEncryptionKey) Encrypt(appID, 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"
	TTLHeader        = "X-Tidbyt-Cache-Seconds"
)

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 ExtractRoots

func ExtractRoots(val starlark.Value) ([]render.Root, error)

ExtractRoots extracts render roots from a Starlark value. It expects the value to be either a single render root or a list of render roots.

It's used internally by RunWithConfig to extract the roots returned by the applet.

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 {
	ID       string
	Globals  map[string]starlark.StringDict
	MainFile string

	Schema     *schema.Schema
	SchemaJSON []byte
	// contains filtered or unexported fields
}

func NewApplet

func NewApplet(id string, src []byte, opts ...AppletOption) (*Applet, error)

func NewAppletFromFS

func NewAppletFromFS(id string, fsys fs.FS, opts ...AppletOption) (*Applet, error)

func (*Applet) Call

func (a *Applet) Call(ctx context.Context, callable *starlark.Function, args ...starlark.Value) (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) PathsForBundle

func (a *Applet) PathsForBundle() []string

PathsForBundle returns a list of all the paths that have been loaded by the applet. This is useful for creating a bundle of the applet.

func (*Applet) Run

func (a *Applet) Run(ctx context.Context) (roots []render.Root, err error)

Run executes the applet's main function. It returns the render roots that are returned by the applet.

func (*Applet) RunTests

func (app *Applet) RunTests(t *testing.T)

RunTests runs all test functions that are defined in the applet source.

func (*Applet) RunWithConfig

func (a *Applet) RunWithConfig(ctx context.Context, config map[string]string) (roots []render.Root, err error)

RunWithConfig exceutes the applet's main function, passing it configuration as a starlark dict. It returns the render roots that are returned by the applet.

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 AppletOption

type AppletOption func(*Applet) error

func WithModuleLoader

func WithModuleLoader(loader ModuleLoader) AppletOption

func WithPrintDisabled

func WithPrintDisabled() AppletOption

func WithPrintFunc

func WithPrintFunc(print PrintFunc) AppletOption

func WithSecretDecryptionKey

func WithSecretDecryptionKey(key *SecretDecryptionKey) AppletOption

func WithThreadInitializer

func WithThreadInitializer(init ThreadInitializer) AppletOption

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 PrintFunc

type PrintFunc func(thread *starlark.Thread, msg string)

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(appID, plaintext string) (string, error)

Encrypt encrypts a value for use as a secret in an app. Provide both a value and the ID 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.