utils

README

WebTeleport Utils

Documentation

Index

• Constants
• Variables
• func AsURL(s string) string
• func CompactHeadersMiddleware(next http.Handler, keys []string) http.Handler
• func EnvAltSvc(fallback string) string
• func EnvCert(fallback string) string
• func EnvHTTPPort(fallback string) string
• func EnvHost(fallback string) string
• func EnvKey(fallback string) string
• func EnvPort(fallback string) string
• func EnvUDPPort(fallback string) string
• func EnvUI(fallback string) string
• func ExtractURLPort(u *url.URL) string
• func Formatter(writer io.Writer, params handlers.LogFormatterParams)
• func GinLoggerMiddleware(next http.Handler) http.Handler
• func Graft(base, alt string) string
• func HostNotFoundHandler() http.Handler
• func Hyperlink(name, url string) string
• func InterceptMiddleware(next http.Handler) http.Handler
• func Isatty() bool
• func Jupyter(next http.Handler) http.Handler
• func LoggingMiddleware(next http.Handler) http.Handler
• func LookupEnv(key string) *string
• func LookupEnvPort(key string) *string
• func LookupHostTXT(domain, server string) ([]string, error)
• func MaybeHyperlink(l string) string
• func ParseBasicAuth(auth string) (username, password string, ok bool)
• func ParseDomainCandidates(p string) []string
• func ReverseProxy(addr string) http.Handler
• func ReverseProxyLogger() *log.Logger
• func ToIdna(s string) string
• func UnwrapInnermost(err error) error
• func WellKnownHealthMiddleware(next http.Handler) http.Handler
• type AugmentedHandler
• type Body
  • func (b *Body) Read(p []byte) (int, error)
• type GinLogger
  • func (m *GinLogger) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Interceptor
  • func (w *Interceptor) Flush()
  • func (w *Interceptor) Hijack() (net.Conn, *bufio.ReadWriter, error)
  • func (w *Interceptor) WriteHeader(statusCode int)
• type LogFormatter
• type LogFormatterParams
  • func (p *LogFormatterParams) IsOutputColor() bool
  • func (p *LogFormatterParams) MethodColor() string
  • func (p *LogFormatterParams) ResetColor() string
  • func (p *LogFormatterParams) StatusCodeColor() string
• type LogWriter
  • func (lw *LogWriter) Write(p []byte) (n int, err error)
• type NotFoundData

Constants

const NOT_FOUND_TEMPLATE = `Not found: {{.Host}}`

const WellKnownHealthPath = "/.well-known/health"

Variables

var AllowAllCorsMiddleware = func(next http.Handler) http.Handler {
	return cors.AllowAll().Handler(next)
}

var GzipMiddleware = handlers.CompressHandler

Functions

func AsURL

func AsURL(s string) string

AsURL expands :port and hostname to http://localhost:port & http://hostname respectively

func CompactHeadersMiddleware

func CompactHeadersMiddleware(next http.Handler, keys []string) http.Handler

func EnvAltSvc

func EnvAltSvc(fallback string) string

func EnvCert

func EnvCert(fallback string) string

func EnvHTTPPort

func EnvHTTPPort(fallback string) string

func EnvHost

func EnvHost(fallback string) string

func EnvKey

func EnvKey(fallback string) string

func EnvPort

func EnvPort(fallback string) string

func EnvUDPPort

func EnvUDPPort(fallback string) string

func EnvUI

func EnvUI(fallback string) string

func ExtractURLPort

func ExtractURLPort(u *url.URL) string

ExtractURLPort returns the :port part from URL.Host (host[:port])

An empty string is returned if no port is found

func Formatter

func Formatter(writer io.Writer, params handlers.LogFormatterParams)

func GinLoggerMiddleware

func GinLoggerMiddleware(next http.Handler) http.Handler

func Graft

func Graft(base, alt string) string

Graft returns Host(base):Port(alt)

assuming - base is host[:port] - alt is [host]:port

func HostNotFoundHandler

func HostNotFoundHandler() http.Handler

func Hyperlink

func Hyperlink(name, url string) string

Print Hyperlink via OSC 8 ansi sequence. The syntax is: 'OSC 8 ; params ; url ST text OSC 8 ; ; ST' for more info see https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda

func InterceptMiddleware

func InterceptMiddleware(next http.Handler) http.Handler

InterceptMiddleware prints request & response info to stdout

func Isatty

func Isatty() bool

func Jupyter

func Jupyter(next http.Handler) http.Handler

VSCode web edition makes cors request to /hub/api endpoint in order to determine if the backend api is a JupyterHub or JupyterLab/JupyterServer

If the Access-Control-Allow-Origin header is absent, the request will not make through. Here we add this header to make VSCode web happy

Tested on: - github.dev - vscode.dev - insider.vscode.dev

Needs to have Jupyter extension installed

- /login is used to check if server has authentication enabled - /hub/api is used to check if server is JupyterHub

with authentication disabled, the /login endpoint won't respond with cors header so we need to manually add it to make vscode-web happy

jupyter server doesn't have the /hub/api endpoint, so the same hack needs to be applied

func LoggingMiddleware

func LoggingMiddleware(next http.Handler) http.Handler

func LookupEnv

func LookupEnv(key string) *string

func LookupEnvPort

func LookupEnvPort(key string) *string

func LookupHostTXT

func LookupHostTXT(domain, server string) ([]string, error)

func MaybeHyperlink

func MaybeHyperlink(l string) string

MaybeHyperlink turns input into ANSI hyperlink when stdin is a tty

func ParseBasicAuth

func ParseBasicAuth(auth string) (username, password string, ok bool)

func ParseDomainCandidates

func ParseDomainCandidates(p string) []string

ParseDomainCandidates splits a path string like /a/b/cd/😏 into a list of subdomains: [a, b, cd, 😏]

when result is empty, a random subdomain will be assigned by the server

func ReverseProxy

func ReverseProxy(addr string) http.Handler

ReverseProxy

• upstream: http://user:pass@example.com behavior: use upstream credential by default
• upstream: http://example.com behavior: passthrough client credential if any
• upstream: http://-@example.com behavior: don't pass any credential to upstream

func ReverseProxyLogger

func ReverseProxyLogger() *log.Logger

func ToIdna

func ToIdna(s string) string

ToIdna converts a string to its idna form at best effort Should only be used on the hostname part without port

func UnwrapInnermost

func UnwrapInnermost(err error) error

func WellKnownHealthMiddleware

func WellKnownHealthMiddleware(next http.Handler) http.Handler

Types

type AugmentedHandler

type AugmentedHandler interface {
	http.Handler
	PkgPath() string
}

type Body

type Body struct {
	io.ReadCloser
	Writer io.Writer
}

func (*Body) Read

func (b *Body) Read(p []byte) (int, error)

type GinLogger

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

func (*GinLogger) ServeHTTP

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

type Interceptor

type Interceptor struct {
	http.ResponseWriter
	StatusCode int
}

func (*Interceptor) Flush

func (w *Interceptor) Flush()

func (*Interceptor) Hijack

func (w *Interceptor) Hijack() (net.Conn, *bufio.ReadWriter, error)

func (*Interceptor) WriteHeader

func (w *Interceptor) WriteHeader(statusCode int)

type LogFormatter

type LogFormatter func(params LogFormatterParams) string

type LogFormatterParams

type LogFormatterParams struct {
	Request      *http.Request
	TimeStamp    time.Time
	StatusCode   int
	Latency      time.Duration
	ClientIP     string
	Host         string
	Method       string
	Proto        string
	Path         string
	ErrorMessage string
	BodySize     int
	Keys         map[string]interface{}
}

func (*LogFormatterParams) IsOutputColor

func (p *LogFormatterParams) IsOutputColor() bool

func (*LogFormatterParams) MethodColor

func (p *LogFormatterParams) MethodColor() string

func (*LogFormatterParams) ResetColor

func (p *LogFormatterParams) ResetColor() string

func (*LogFormatterParams) StatusCodeColor

func (p *LogFormatterParams) StatusCodeColor() string

type LogWriter

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

func (*LogWriter) Write

func (lw *LogWriter) Write(p []byte) (n int, err error)

type NotFoundData

type NotFoundData struct {
	Host string
}