upload

package

v0.2.1 Latest Latest Go to latest Published: Jul 2, 2026 License: AGPL-3.0 Imports: 24 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jssblck/akari

Links

Open Source Insights

Documentation ¶

Overview ¶

Package upload drives the ingest protocol from the client side, statelessly. The server is authoritative for how many bytes of each file it holds, so the client persists nothing: it announces, reconciles against the server's cursor and content hash, and streams the gap in newline-terminated chunks.

Index ¶

type Action
type Client
- func New(httpClient *http.Client, baseURL, token string) *Client
- func (c *Client) SyncFile(ctx context.Context, t Target) (Outcome, error)
type Outcome
type Target

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Action ¶

type Action string

Action describes what SyncFile did for a file.

const (
	ActionUpToDate Action = "uptodate" // server already had the whole file
	ActionUploaded Action = "uploaded" // appended new bytes
	ActionReset    Action = "reset"    // diverged, re-uploaded from zero
)

type Client ¶

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

Client talks to one akari server with one bearer token.

func New ¶

func New(httpClient *http.Client, baseURL, token string) *Client

New builds a Client. baseURL is the server root (trailing slash optional).

func (*Client) SyncFile ¶

func (c *Client) SyncFile(ctx context.Context, t Target) (Outcome, error)

SyncFile announces a file, reconciles against the server's cursor, and uploads any new complete lines. It is safe to call repeatedly: an up-to-date file moves no bytes.

A mid-stream offset conflict (HTTP 409) means the server's cursor moved out from under us, so the prefix verified at announce is stale. Rather than trust the conflict's reported cursor blindly (which could append onto a divergent prefix), SyncFile re-announces and re-verifies the prefix from scratch, up to maxConflictRetries times.

type Outcome ¶

type Outcome struct {
	Action        Action
	UploadedBytes int64
	StoredBytes   int64
	MessageCount  int
}

Outcome reports the result of syncing one file.

type Target ¶

type Target struct {
	Agent      string
	Path       string
	SourceID   string
	Kind       string
	ProjectKey string
	LocalRoot  string
	GitBranch  string
	Cwd        string
	Machine    string
}

Target is everything needed to upload one resolved session file. Kind is the session's classification ("remote", "standalone", or "orphaned"). ProjectKey is set only for a remote session; for standalone and orphaned sessions the server derives the project key from Machine and the local location. LocalRoot, set only for a standalone session in a live worktree, is the repo root shared by every worktree; the server keys on it so a local-only repo's worktrees collapse into one project. When it is empty the server falls back to Cwd.

Source Files ¶

View all Source files

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