webview

package
v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 4, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AckWebsocketRequest added in v0.10.25

type AckWebsocketRequest struct {
	// The ToCheckpoint on the received LogList.
	ToCheckpoint int32 `json:"toCheckpoint,omitempty"`

	// Allows us to synchronize on a running Tilt instance,
	// so we can tell when we're talking to the same Tilt.
	TiltStartTime metav1.MicroTime `json:"tiltStartTime,omitempty"`
}

NOTE(nick): This is obsolete.

Our websocket service has two kinds of messages:

  1. On initialization, we send down the complete view state
  2. On every change, we send down the resources that have changed since the last send().

type AckWebsocketResponse added in v0.10.25

type AckWebsocketResponse struct{}

type LogLevel added in v0.10.25

type LogLevel string

LogLevel represents the severity level of a log entry.

const (
	LogLevel_NONE    LogLevel = "NONE"
	LogLevel_INFO    LogLevel = "INFO"
	LogLevel_VERBOSE LogLevel = "VERBOSE"
	LogLevel_DEBUG   LogLevel = "DEBUG"
	LogLevel_WARN    LogLevel = "WARN"
	LogLevel_ERROR   LogLevel = "ERROR"
)

type LogList added in v0.10.24

type LogList struct {
	Spans    map[string]*LogSpan `json:"spans,omitempty"`
	Segments []*LogSegment       `json:"segments,omitempty"`
	// FromCheckpoint and ToCheckpoint express an interval on the
	// central log-store, with an inclusive start and an exclusive end
	//
	// [FromCheckpoint, ToCheckpoint)
	//
	// An interval of [0, 0) means that the server isn't using
	// the incremental load protocol.
	//
	// An interval of [-1, -1) means that the server doesn't have new logs
	// to send down.
	FromCheckpoint int32 `json:"fromCheckpoint,omitempty"`
	ToCheckpoint   int32 `json:"toCheckpoint,omitempty"`
}

type LogSegment added in v0.10.24

type LogSegment struct {
	SpanId string           `json:"spanId,omitempty"`
	Time   metav1.MicroTime `json:"time,omitempty"`
	Text   string           `json:"text,omitempty"`
	Level  LogLevel         `json:"level,omitempty"`
	// When we store warnings in the LogStore, we break them up into lines and
	// store them as a series of line segments. 'anchor' marks the beginning of a
	// series of logs that should be kept together.
	//
	// Anchor warning1, line1
	//        warning1, line2
	// Anchor warning2, line1
	Anchor bool `json:"anchor,omitempty"`

	// Context-specific optional fields for a log segment.
	// Used for experimenting with new types of log metadata.
	Fields map[string]string `json:"fields,omitempty"`
}

type LogSpan added in v0.10.24

type LogSpan struct {
	ManifestName string `json:"manifestName,omitempty"`
}

type Snapshot added in v0.10.16

type Snapshot struct {
	View              *View              `json:"view,omitempty"`
	IsSidebarClosed   bool               `json:"isSidebarClosed,omitempty"`
	Path              string             `json:"path,omitempty"`
	SnapshotHighlight *SnapshotHighlight `json:"snapshotHighlight,omitempty"`
	SnapshotLink      string             `json:"snapshotLink,omitempty"`
	CreatedAt         metav1.MicroTime   `json:"createdAt,omitempty"`
}

type SnapshotHighlight added in v0.10.16

type SnapshotHighlight struct {
	BeginningLogID string `json:"beginningLogID,omitempty"`
	EndingLogID    string `json:"endingLogID,omitempty"`
	Text           string `json:"text,omitempty"`
}

type TiltBuild

type TiltBuild struct {
	Version   string `json:"version,omitempty"`
	CommitSHA string `json:"commitSHA,omitempty"`
	Date      string `json:"date,omitempty"`
	Dev       bool   `json:"dev,omitempty"`
}

type UploadSnapshotResponse added in v0.10.16

type UploadSnapshotResponse struct {
	Url string `json:"url,omitempty"`
}

type VersionSettings added in v0.10.19

type VersionSettings struct {
	CheckUpdates bool `json:"checkUpdates,omitempty"`
}

type View

type View struct {
	Log                  string           `json:"log,omitempty"`
	FeatureFlags         map[string]bool  `json:"featureFlags,omitempty"`
	NeedsAnalyticsNudge  bool             `json:"needsAnalyticsNudge,omitempty"`
	RunningTiltBuild     *TiltBuild       `json:"runningTiltBuild,omitempty"`
	SuggestedTiltVersion string           `json:"suggestedTiltVersion,omitempty"`
	VersionSettings      *VersionSettings `json:"versionSettings,omitempty"`
	TiltCloudUsername    string           `json:"tiltCloudUsername,omitempty"`
	TiltCloudTeamName    string           `json:"tiltCloudTeamName,omitempty"`
	TiltCloudSchemeHost  string           `json:"tiltCloudSchemeHost,omitempty"`
	TiltCloudTeamID      string           `json:"tiltCloudTeamID,omitempty"`
	FatalError           string           `json:"fatalError,omitempty"`
	LogList              *LogList         `json:"logList,omitempty"`
	// Allows us to synchronize on a running Tilt instance,
	// so we can tell when Tilt restarted.
	TiltStartTime metav1.MicroTime `json:"tiltStartTime,omitempty"`

	// An identifier for the tiltfile that is running, so that the web ui
	// can store data per tiltfile.
	TiltfileKey string `json:"tiltfileKey,omitempty"`

	// New API-server based data models.
	UiSession   *v1alpha1.UISession   `json:"uiSession,omitempty"`
	UiResources []v1alpha1.UIResource `json:"uiResources,omitempty"`
	UiButtons   []v1alpha1.UIButton   `json:"uiButtons,omitempty"`
	Clusters    []v1alpha1.Cluster    `json:"clusters,omitempty"`

	// Indicates that this view is a complete representation of the app.
	// If false, this view just contains deltas from a previous view.
	IsComplete bool `json:"isComplete,omitempty"`
}

Our websocket service has two kinds of View messages:

  1. On initialization, we send down the complete view state (TiltStartTime, UISession, UIResources, and LogList)

  2. On every change, we send down the resources that have changed since the last send(). (new logs and any updated UISession/UIResource objects).

All other fields are obsolete, but are needed for deserializing old snapshots.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL