Files
kandev/apps/backend/internal/task/share/service.go
T
João Salavisa 0f1081d423 feat(share): add public share links via GitHub Gists (#995)
* feat(share): add public share links via GitHub Gists

Adds a Share button to the chat panel header that publishes the
current session as a secret GitHub Gist on the user's account. The
share link routes through gistpreview.github.io to render share.html
as a styled kandev-themed page; snapshot.json + README.md ride along
for machine-readable + fallback views.

Snapshots run a redaction pass (absolute paths, common credential
shapes, .env contents, shell env vars) and strip <kandev-system>
prompt blocks via the shared sysprompt helper. Message filtering
whitelists user prose + tool_* types so internal noise never leaks
into shares.

Spec at docs/specs/public-share-links/spec.md.

* fix(share): coerce pendingClarification to bool for ClarificationSection

A late refactor extracted ClarificationSection with `pendingClarification: boolean`
on its props, but the call site passes the actual Message|null value. CI's tsc
build catches the mismatch; runtime was unaffected because the section only uses
the value in a truthiness check. Coerce with Boolean() at the call site to keep
the prop's intent narrow.

* fix(share): address PR #995 review feedback

Bugs (flagged by Greptile, Cubic, Claude):
 - abs-path redaction split on `root + "/"` so sibling dirs like
   /home/user/proj2 don't get corrupted when workspaceRoot is
   /home/user/proj; regression test added.
 - GHClient.DeleteGist now wraps "HTTP 404" stderr as *GitHubAPIError so
   share.IsAlreadyGone matches consistently with the PAT client; this
   restores the "gist already revoked upstream" soft-success path for
   CLI-authenticated users.
 - SnapshotSizeBytes is now measured from the same MarshalIndent payload
   the gist backend uploads, so the size shown in the UI matches the
   actual gist bytes (was ~20-40% underreported).

Polish (flagged by CodeRabbit, Cubic):
 - Tool name + tool output now HTML-escaped; tool call args and output
   render via <pre><code> instead of triple-backtick fences so payloads
   containing ``` can't break out of the code block.
 - share-list.tsx: clear `busy` via finally and break error layout out
   of the justify-between row.
 - use-shares.ts: convert UseSharesResult to interface (repo TS rules);
   reset error+isLoading when ids are missing.
 - use-shares.test.tsx: wait on the actual async outcome (shares
   populated, listShares called) instead of isLoading flipping false.
 - provider.go: replace `repo.Close` cleanup with an explicit noop
   closure so the comment ("Cleanup is a no-op") and the impl match.
 - spec.md: aligned the shareability rule across What/Failure/Scenarios/
   Out-of-scope — any non-prehistory state can be shared; added language
   tags to fenced code blocks for markdownlint.

Skipped intentionally (reply on each thread):
 - HTML-escape every metadata badge: the values are controlled enum
   strings from kandev's own schema, not user input. Defense-in-depth
   noise. Tool name (which can come from agent runtime) IS escaped.
 - useShares request-token guard against stale responses: the dialog
   owns the hook lifecycle and opens against a single (taskId,
   sessionId) — the race the comment describes can't occur here.

* fix(share): redact paths for every worktree, not just the first

A single TaskSession can carry multiple worktrees when the task spans
multiple repos. The redactor previously only saw the first worktree
path, so absolute paths from secondary worktrees leaked into public
shares instead of being rewritten to repo-relative form.

NewRedactor is now variadic and applies the abs-path rule against every
root it receives, sorted longest-first so a root that is a prefix of
another (e.g. /workspace vs /workspace/repo1) gets matched by the more
specific one first. workspaceRootFor in builder.go becomes
workspaceRootsFor and emits every WorktreePath plus the WorkspacePath
fallback.

Flagged by Cubic on PR #995.

* fix(share): address PR #995 review round 3

Bugs (flagged by Cubic + Claude on gh_client.go:714):
 - DeleteGist now calls the existing isNotFoundErr helper instead of an
   inline strings.Contains(err, "HTTP 404"). The helper also covers
   "404 Not Found" and "status: 404", which some gh versions emit, so
   the share service's "gist already revoked upstream" soft-success
   path now fires consistently across CLI auth users.

Bugs (flagged by Claude on builder.go:220):
 - toolCallBlock used to read metadata["tool_name"] and metadata["args"]
   but production never writes those keys; the typed payload lives under
   metadata["normalized"] (a *streams.NormalizedPayload) and the tool
   kind is on Message.Type. Switched to deriving ToolName from
   strings.TrimPrefix(m.Type, "tool_") (gives "read", "execute", "edit",
   …) and reading args from metadata["normalized"], with backward-compat
   fallback to the older "tool_name"/"args" keys for the debug-fixture
   replay path. New TestBuildSnapshot_ToolCall_ProductionMetadataShape
   exercises the real session shape.

Bugs (flagged by CodeRabbit on redaction.go:110):
 - Bare workspace-root occurrences (pwd output, end-of-sentence, quoted
   paths) used to leak because the matcher only handled root + "/".
   Switched to a precompiled regex per root —
   regexp.QuoteMeta(root) + `(?:/|\b)` — so both `root/...` and standalone
   `root` get stripped, while sibling dirs like /workspace2 still don't
   match. Test TestRedactor_AbsPath_StandaloneRootStripped covers the
   bare-root variants.

Doc (flagged by Claude on spec.md):
 - Two malformed fence closers (`go and `text on closing fences) corrected
   to plain ``` so the file is markdownlint-clean.

* fix(share): narrow abs-path boundary to avoid sibling-prefix corruption

Round 4 review (Claude + CodeRabbit) caught a regression in the regex
introduced by 436cb66: `(?:/|\b)` used `\b` (word boundary) to catch
bare-root cases, but `\b` fires on any word↔non-word transition. So a
sibling path like `/workspace.bak`, `/workspace-old`, or
`/workspace-other` would false-match the `/workspace` root (since
e→. and e→- are word boundaries), stripping it and leaving a
corrupted `.bak` / `-old/file.ts` in the share.

Replaced the matcher with `(/|\s|$)`: path separator, whitespace, or
end-of-string only — never punctuation or quote chars. The boundary
is captured and re-emitted via ReplaceAllStringFunc (or dropped, in
the `/` case) so prose loses only the root, not the surrounding space.

Added TestRedactor_AbsPath_SiblingsWithPunctuationNotCorrupted covering
`.bak`, `-old`, `_alt` siblings; the digit-sibling test still passes.
The quoted-bare-root case (`"/workspace"`) no longer matches and was
dropped from the standalone-root test — contrived enough that a small
leak there is preferable to corrupting realistic sibling paths.

* refactor(share): move share button into chat status bar

Replaces the dedicated PanelHeaderBarSplit above the message list with
a slot in ChatStatusBar (the existing row holding TodoIndicator and
PRStatusChip just above the chat input). The button anchors right via
ml-auto; when the "proceed to next step" affordance is present it
takes the right anchor instead and the share button stays inline.

Also tightens the iconOnly variant in ShareButton to a ghost style
that matches the muted-foreground chips in the status bar, and exports
shareableSessionStateClient from share-button.tsx so the gating logic
lives next to the entry point it controls.

Net -23 lines in task-chat-panel.tsx: the extra header bar and the
local gate helper are gone.

* docs(share): broaden tooltip + add share/ to CLAUDE.md tree

The share tooltip read "Share this completed task with a public link",
but shareableSessionStateClient allows RUNNING / IDLE / WAITING_FOR_INPUT
/ FAILED / CANCELLED too. A user hovering mid-run saw misleading copy;
reworded to "Share this task conversation as a public link" which
matches the actual gate.

Also added the missing internal/task/share/ entry to the task/ subtree
in CLAUDE.md so the new package shows up in the repo map — flagged
across multiple rounds.

* docs: add internal/task/share/ to repo map

Carryover from the share PR — AGENTS.md (which CLAUDE.md symlinks to)
was missing the share/ subpackage under task/. Adding it now so the
repo map matches what's checked in.

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
2026-05-21 23:35:41 +01:00

131 lines
4.1 KiB
Go

package share
import (
"context"
"encoding/json"
"fmt"
"time"
"github.com/google/uuid"
"go.uber.org/zap"
"github.com/kandev/kandev/internal/common/logger"
)
// Service coordinates snapshot construction, backend upload, and persistence.
type Service struct {
repo *Repository
taskRepo TaskReader
backend Backend
log *logger.Logger
kandevVer string
}
// New constructs a Service. All arguments are required.
func New(repo *Repository, taskRepo TaskReader, backend Backend, log *logger.Logger, kandevVer string) *Service {
return &Service{
repo: repo,
taskRepo: taskRepo,
backend: backend,
log: log,
kandevVer: kandevVer,
}
}
// PreviewSnapshot builds and returns the redacted snapshot that would be
// uploaded for the given session, without uploading or persisting anything.
// Returns ErrSessionNotCompleted if the session is not yet completed.
func (s *Service) PreviewSnapshot(ctx context.Context, taskSessionID string) (*Snapshot, error) {
return BuildSnapshot(ctx, s.taskRepo, taskSessionID, s.kandevVer)
}
// CreateShare builds a snapshot, uploads it via the configured backend, and
// records the row in the repository.
func (s *Service) CreateShare(ctx context.Context, taskSessionID string) (*Share, error) {
snap, err := BuildSnapshot(ctx, s.taskRepo, taskSessionID, s.kandevVer)
if err != nil {
return nil, err
}
// Use the same indented marshal as the gist backend so the size we
// surface to the UI matches the bytes actually uploaded to GitHub.
body, err := json.MarshalIndent(snap, "", " ")
if err != nil {
return nil, fmt.Errorf("marshal snapshot: %w", err)
}
extID, extURL, err := s.backend.Upload(ctx, snap)
if err != nil {
return nil, fmt.Errorf("upload snapshot: %w", err)
}
row := &Share{
ID: uuid.New().String(),
TaskSessionID: taskSessionID,
Backend: s.backend.Name(),
ExternalID: extID,
ExternalURL: extURL,
SnapshotSizeBytes: int64(len(body)),
CreatedAt: time.Now().UTC(),
}
if err := s.repo.Create(ctx, row); err != nil {
// The gist exists on GitHub but we failed to persist the row.
// Best-effort: try to clean up the orphaned gist; log if that
// also fails so the user can manually delete it.
if delErr := s.backend.Delete(ctx, extID); delErr != nil {
s.logWarn("orphaned gist after row insert failed",
zap.String("gist_id", extID), zap.Error(delErr))
}
return nil, fmt.Errorf("persist share: %w", err)
}
return row, nil
}
// RevokeShare deletes the underlying gist and marks the row revoked. A
// 404 from the gist backend (gist already deleted on GitHub) is treated
// as success, logged at INFO, and still marks the row revoked.
func (s *Service) RevokeShare(ctx context.Context, shareID string) error {
row, err := s.repo.GetByID(ctx, shareID)
if err != nil {
return err
}
if row.IsRevoked() {
return nil
}
if delErr := s.backend.Delete(ctx, row.ExternalID); delErr != nil {
if !IsAlreadyGone(delErr) {
return fmt.Errorf("delete from backend: %w", delErr)
}
s.logInfo("gist already gone on upstream; marking share revoked anyway",
zap.String("share_id", shareID),
zap.String("external_id", row.ExternalID))
}
if err := s.repo.MarkRevoked(ctx, shareID, time.Now().UTC()); err != nil {
// Repository failure after a successful upstream delete leaves an
// inconsistent row. Surface the error so the caller can retry.
return fmt.Errorf("mark revoked: %w", err)
}
return nil
}
// ListBySession returns every share row for a session (including revoked).
func (s *Service) ListBySession(ctx context.Context, taskSessionID string) ([]*Share, error) {
return s.repo.ListByTaskSession(ctx, taskSessionID)
}
// GetByID exposes repo.GetByID for handlers that need to inspect a row.
func (s *Service) GetByID(ctx context.Context, shareID string) (*Share, error) {
return s.repo.GetByID(ctx, shareID)
}
func (s *Service) logInfo(msg string, fields ...zap.Field) {
if s.log == nil {
return
}
s.log.Info(msg, fields...)
}
func (s *Service) logWarn(msg string, fields ...zap.Field) {
if s.log == nil {
return
}
s.log.Warn(msg, fields...)
}