codehost

type CodeHost interface {
	PullRequest(ctx context.Context, ref domain.PRRef) (domain.PullRequest, error)
	// Commits lists the PR's commits, oldest first.
	Commits(ctx context.Context, ref domain.PRRef) ([]domain.Commit, error)
	// Dashboard lists the open PRs awaiting the viewer's review and those
	// they authored.
	Dashboard(ctx context.Context) (Dashboard, error)

	// Checks reads the Checks on the PR's head commit and its MergeState.
	Checks(ctx context.Context, ref domain.PRRef) (domain.Checks, error)
	// Status reports reachability and rate limits. Reads are served from
	// cache while the code host is unreachable.
	Status() Status

	// ReviewState reads the PR's Review Threads, Conversation Comments,
	// Reactions, the viewer's Pending Review and Viewed files.
	ReviewState(ctx context.Context, ref domain.PRRef) (domain.ReviewState, error)
	// Forget drops whatever the code host adapter has cached locally for
	// the PR. Nothing on the code host itself changes.
	Forget(ctx context.Context, ref domain.PRRef) error
	// StartReview creates a Pending Review anchored to commit.
	StartReview(ctx context.Context, prID string, commit domain.SHA) (reviewID string, err error)
	// AddThread adds a Review Thread to a Pending Review.
	AddThread(ctx context.Context, reviewID string, t NewThread) error
	// Reply adds a Review Comment to a thread, within a Pending Review.
	Reply(ctx context.Context, reviewID, threadID, body string) error
	SetThreadResolved(ctx context.Context, threadID string, resolved bool) error
	// EditReviewComment replaces a Review Comment's body, pending or not.
	EditReviewComment(ctx context.Context, commentID, body string) error
	// DeleteReviewComment deletes a Review Comment; a thread left with no
	// comments goes with it.
	DeleteReviewComment(ctx context.Context, commentID string) error
	// AddConversationComment posts a Conversation Comment immediately.
	AddConversationComment(ctx context.Context, prID, body string) error
	// EditConversationComment replaces a Conversation Comment's body.
	EditConversationComment(ctx context.Context, commentID, body string) error
	DeleteConversationComment(ctx context.Context, commentID string) error
	// SetReaction adds or removes the viewer's Reaction on a comment or PR.
	SetReaction(ctx context.Context, subjectID string, r domain.Reaction, on bool) error
	// SubmitReview submits the Pending Review, or when reviewID is empty
	// creates and submits a review at commit in one step.
	SubmitReview(ctx context.Context, prID, reviewID string, commit domain.SHA, event domain.ReviewEvent, body string) error
	SetViewed(ctx context.Context, prID, path string, viewed bool) error
	// RenderMarkdown renders a comment body as the code host would show it,
	// sanitised, with references resolved against the PR's repo.
	RenderMarkdown(ctx context.Context, repo domain.Repo, body string) (string, error)
}

type Dashboard struct {
	ReviewRequested []domain.PRSummary
	Authored        []domain.PRSummary
}

type Fake struct {
	PRs         map[domain.PRRef]domain.PullRequest
	CommitsOf   map[domain.PRRef][]domain.Commit
	Dash        Dashboard
	States      map[domain.PRRef]*domain.ReviewState
	Submissions []Submission
	ChecksOf    map[domain.PRRef]domain.Checks
	Health      Status
	// Forgotten lists the PRs Forget was called for.
	Forgotten []domain.PRRef
	// FailAddThread, when set, makes AddThread fail with it.
	FailAddThread error
	// contains filtered or unexported fields
}

type NewThread struct {
	Path            string
	Line, StartLine int
	Side, StartSide domain.DiffSide
	Body            string
}

type RateLimit struct {
	Remaining, Limit int
	Reset            time.Time
	Resource         string // which limit, e.g. "core", "graphql" or "search"
}

type Status struct {
	Online bool
	// Unauthorized is set while the code host rejects the credentials.
	Unauthorized bool
	// RateLimit is the most constrained limit seen; Limit is zero before
	// any response has reported one.
	RateLimit RateLimit
}

type Submission struct {
	PR     domain.PRRef
	Commit domain.SHA
	Event  domain.ReviewEvent
	Body   string
}