browser

Documentation

Overview

Package browser manages headless Chrome/Chromium for rendering themes.

Package browser - headless rendering using Chrome DevTools Protocol.

Index

• Variables
• func BrowserPath() (string, error)
• func Download(ctx context.Context, progress func(downloaded, total int64)) error
• func GetChromePath() (string, error)
• func IsInstalled() bool
• func Remove() error
• func SystemChromePath() (string, error)
• func Version() string
• type Renderer
  • func NewRenderer(width, height int) (*Renderer, error)
  • func (r *Renderer) Capture() (image.Image, error)
  • func (r *Renderer) CaptureToFile(path string) error
  • func (r *Renderer) SendSensorData(jsonData string) error
  • func (r *Renderer) ServerPort() int
  • func (r *Renderer) Start(ctx context.Context, themeDistDir string) error
  • func (r *Renderer) Stop()

Variables

var (
	// ErrUnsupportedPlatform is returned for unsupported OS/arch combinations.
	ErrUnsupportedPlatform = errors.New("unsupported platform")
	// ErrBrowserNotFound is returned when the browser binary is not found.
	ErrBrowserNotFound = errors.New("browser not found")
	// ErrDownloadFailed is returned when browser download fails.
	ErrDownloadFailed = errors.New("browser download failed")
)

Functions

func BrowserPath

func BrowserPath() (string, error)

BrowserPath returns the path to the Chrome binary if installed.

func Download

func Download(ctx context.Context, progress func(downloaded, total int64)) error

Download downloads and installs Chrome for Testing.

func GetChromePath

func GetChromePath() (string, error)

GetChromePath returns the path to Chrome, preferring cached version. Falls back to system Chrome if cached version is not available.

func IsInstalled

func IsInstalled() bool

IsInstalled checks if Chrome is installed in the cache directory.

func Remove

func Remove() error

Remove removes the cached browser.

func SystemChromePath

func SystemChromePath() (string, error)

SystemChromePath tries to find a system-installed Chrome/Chromium.

func Version

func Version() string

Version returns the version of Chrome for Testing being used.

Types

type Renderer

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

Renderer manages a headless Chrome instance for rendering themes.

func NewRenderer

func NewRenderer(width, height int) (*Renderer, error)

NewRenderer creates a new headless browser renderer.

func (*Renderer) Capture

func (r *Renderer) Capture() (image.Image, error)

Capture takes a screenshot and returns it as an image.

func (*Renderer) CaptureToFile

func (r *Renderer) CaptureToFile(path string) error

CaptureToFile takes a screenshot and saves it to a file.

func (*Renderer) SendSensorData

func (r *Renderer) SendSensorData(jsonData string) error

SendSensorData sends sensor data to the theme via JavaScript.

func (*Renderer) ServerPort

func (r *Renderer) ServerPort() int

ServerPort returns the port the theme server is running on.

func (*Renderer) Start

func (r *Renderer) Start(ctx context.Context, themeDistDir string) error

Start starts the headless browser and serves the theme.

func (*Renderer) Stop

func (r *Renderer) Stop()

Stop stops the renderer and cleans up.