Files
kandev/apps/backend/internal/github/poller.go
T
João Salavisa c11a6bbfd2 feat(github): add issue watcher with task creation and auto-cleanup (#672)
* feat(github): add issue watcher with task creation and auto-cleanup

Add a GitHub Issue Watcher feature that polls for new issues matching
configurable filters and automatically creates tasks for them. This
complements the existing PR Review Watcher with the same patterns.

Backend:
- Issue watch CRUD (models, store, service, controller, WS handlers)
- Poller integration with configurable intervals
- Event-driven task creation via orchestrator
- Repository resolution and worktree support for issue tasks
- Auto-cleanup of tasks for closed issues (CleanupClosedIssueTasks)
- GetIssueState client method across all implementations
- Default branch auto-detection from cloned repo HEAD

Frontend:
- Issue watch settings UI (table, dialog, placeholders)
- Issue link icon on task cards (green circle-dot)
- API client, store slice, and hook for issue watches
- SSR and WS hydration of issue metadata

* fix: resolve golangci-lint errors (goconst, nestif, dupl) and prettier formatting

* fix(github): fix issue watch update shape, trigger key, and label quoting

- httpUpdateIssueWatch now returns the full IssueWatch object instead of
  {updated:true} so the frontend store correctly refreshes after edits
- httpTriggerIssueWatch returns new_issues_found to match TriggerIssueResponse
  type; was returning new_issues so the toast count was always 0
- buildIssueFilter uses conditional quoting instead of fmt.Sprintf %q to
  avoid Go escape sequences in GitHub search qualifiers

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* fix: resolve eslint warnings (max-lines-per-function, no-nested-ternary)

* test(github): add issue watcher tests and fix review feedback

- Add TestInterpolateIssuePrompt (4 cases: empty/all/none/partial)
- Add TestCreateIssueTask (3 cases: skip/reserve+assign/release on fail)
- Add TestShouldDeleteIssueTask (4 cases: open/closed+sessions/closed/error)
- Fix WS response key new_issues -> new_issues_found
- Fix fmt.Printf -> fmt.Fprintf(os.Stderr) in store.go
- Add CleanupClosedIssueTasks call in WS trigger handler

* fix: address PR review feedback and CI failures

- Split test files to fix revive file-length-limit (service_test.go,
  event_handlers_github_test.go)
- Add session checker guard in CleanupClosedIssueTasks
- Normalize poll intervals on UpdateIssueWatch
- Add cleanup call in TriggerAllIssueChecks loop
- Log cleanup errors in controller and WS handler
- Prefer refs/remotes/origin/HEAD in detectGitDefaultBranch
- Add aria-label to issue task icon
- Fix TypeScript type errors: add linkedIssues to GitHubSlice,
  fix hook exports, remove invalid imports

* fix: split test files exceeding revive limit and clean up minor issues

- Split service_test.go (883→779 lines): move TestTriggerPRSync_* to
  service_pr_sync_test.go
- Split event_handlers_github_test.go (806→677 lines): move
  TestCreateReviewTask_* and helpers to event_handlers_github_review_test.go
- Remove redundant s.taskSessionChecker nil-check inside shouldDeleteIssueTask
  (early guard at CleanupClosedIssueTasks already ensures it is non-nil)
- Remove unreachable dead guard in detectAndPersistDefaultBranch
  (repo.DefaultBranch is always "" at that call site)
- Fix bogus #0 issue badge in task-session-sidebar.tsx when issueNumber is absent

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* fix: address Claude review — poll clamp and prompt injection

- Handle v <= 0 in UpdateIssueWatch poll interval (fall back to default)
- Remove {{issue.body}} from default template to prevent prompt injection
- Update test expected output for new default template

* fix: remove {{issue.body}} from frontend DEFAULT_ISSUE_WATCH_PROMPT

Mirrors the backend fix — the UI pre-fills the prompt so the backend
fallback was never reached. The placeholder stays in
ISSUE_WATCH_PLACEHOLDERS for explicit opt-in.

* feat(github): add isIssueWatch sidebar filter dimension

Add isIssueWatch boolean to KanbanState, TaskSwitcherItem, and sidebar
filter registry — mirroring the isPRReview pattern. Issue-watch tasks
(created from issue_watch_id in metadata) can now be explicitly filtered
in the sidebar, just like PR review tasks.

Files changed:
- sidebar-view-types: add isIssueWatch dimension
- filter-dimension-registry: add Issue watch filter meta
- apply-view: add isIssueWatch extractor
- kanban types: add isIssueWatch field
- TaskSwitcherItem: add isIssueWatch field
- use-all-workflow-snapshots: derive isIssueWatch from metadata
- ssr/mapper: derive isIssueWatch from metadata
- task-session-sidebar: pass isIssueWatch, extract helpers to fix complexity

* fix: correct deleteIssueWatch response type to match backend

Backend httpDeleteIssueWatch returns {"deleted": true}; the frontend
type was { success: boolean } — a mismatch with no functional impact
(return value is ignored) but wrong per TypeScript contract.

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* refactor: extract metadata helpers to shared lib/metadata-utils.ts

- Move isPRReviewFromMetadata, isIssueWatchFromMetadata, and
  issueFieldsFromMetadata to a shared module to eliminate duplicate
  definitions (sonarjs/no-identical-functions).
- Fix deleteIssueWatch response type: { success: boolean } -> { deleted: boolean }
  to match the actual backend response.

* style: fix prettier formatting

* test(web): add tests for isIssueWatch filter dimension and metadata-utils

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* style: fix prettier formatting in test files

* fix(github): cascade-delete issue watch tasks on watch deletion and add isPRReview to SSR mapper

- DeleteIssueWatch now wraps in a transaction and deletes related
  github_issue_watch_tasks rows before removing the watch; prevents
  orphaned dedup rows accumulating after a watch is deleted
- snapshotToState in mapper.ts now also sets isPRReview from metadata,
  matching the mapping already done in use-all-workflow-snapshots.ts

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* style: extract duplicate string constant in metadata-utils test

* style: extract repeated WS error strings into constants in handlers.go

goconst min-occurrences: 3 — 'invalid payload' (6x) and 'id required' (4x)
both exceed the threshold. Extract to package-level constants.

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* style: extract repeated issue key strings into constants in event_handlers_github.go

goconst min-occurrences: 3 — 'issue_number' (9x) and 'issue_watch_id' (5x)
both newly introduced in this PR exceed the threshold.

Co-authored-by: João Salavisa <undefined@users.noreply.github.com>

* style: fix prettier formatting in metadata-utils test

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: João Salavisa <undefined@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-21 17:32:46 +01:00

428 lines
13 KiB
Go

package github
import (
"context"
"sync"
"time"
"go.uber.org/zap"
"github.com/kandev/kandev/internal/common/logger"
"github.com/kandev/kandev/internal/events"
"github.com/kandev/kandev/internal/events/bus"
)
const (
defaultPRPollInterval = 30 * time.Second
defaultReviewPollInterval = 5 * time.Minute
defaultIssuePollInterval = 5 * time.Minute
)
// TaskBranchInfo describes a task+session that may need a PR watch.
type TaskBranchInfo struct {
TaskID string
SessionID string
Owner string
Repo string
Branch string
}
// TaskBranchProvider lists tasks that should have PR watches and resolves branches.
type TaskBranchProvider interface {
ListTasksNeedingPRWatch(ctx context.Context) ([]TaskBranchInfo, error)
// ResolveBranchForSession returns the current branch for a task+session pair.
// Used to detect branch renames and update stale PR watches.
ResolveBranchForSession(ctx context.Context, taskID, sessionID string) string
}
// Poller runs background loops for PR monitoring and review queue checking.
type Poller struct {
service *Service
eventBus bus.EventBus
logger *logger.Logger
taskBranchProvider TaskBranchProvider
cancel context.CancelFunc
wg sync.WaitGroup
started bool
}
// NewPoller creates a new background poller.
func NewPoller(svc *Service, eventBus bus.EventBus, log *logger.Logger) *Poller {
return &Poller{
service: svc,
eventBus: eventBus,
logger: log,
}
}
// Start begins the background polling loops.
// Calling Start more than once without Stop is a no-op.
func (p *Poller) Start(ctx context.Context) {
if p.started {
return
}
p.started = true
ctx, p.cancel = context.WithCancel(ctx)
p.wg.Add(3) //nolint:mnd
go p.prMonitorLoop(ctx)
go p.reviewQueueLoop(ctx)
go p.issueWatchLoop(ctx)
p.logger.Info("GitHub poller started")
}
// Stop cancels the polling loops and waits for them to finish.
func (p *Poller) Stop() {
if !p.started {
return
}
if p.cancel != nil {
p.cancel()
}
p.wg.Wait()
p.started = false
p.logger.Info("GitHub poller stopped")
}
// prMonitorLoop polls PR watches for new feedback.
func (p *Poller) prMonitorLoop(ctx context.Context) {
defer p.wg.Done()
// Run an initial check immediately so existing watches are evaluated on startup.
p.checkPRWatches(ctx)
ticker := time.NewTicker(defaultPRPollInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
p.checkPRWatches(ctx)
}
}
}
func (p *Poller) checkPRWatches(ctx context.Context) {
p.reconcileWatches(ctx)
watches, err := p.service.ListActivePRWatches(ctx)
if err != nil {
p.logger.Error("failed to list PR watches", zap.Error(err))
return
}
for _, watch := range watches {
p.checkSinglePRWatch(ctx, watch)
}
}
func (p *Poller) checkSinglePRWatch(ctx context.Context, watch *PRWatch) {
// PRWatch with pr_number=0 means we're still searching for a PR on this branch.
if watch.PRNumber == 0 {
p.detectPRForWatch(ctx, watch)
return
}
status, hasNew, err := p.service.CheckPRWatch(ctx, watch)
if err != nil {
p.logger.Debug("failed to check PR watch",
zap.String("id", watch.ID), zap.Error(err))
return
}
if status == nil {
return
}
// Always sync latest PR state to the task-PR record.
if syncErr := p.service.SyncTaskPR(ctx, watch.TaskID, status); syncErr != nil {
p.logger.Error("failed to sync task PR",
zap.String("task_id", watch.TaskID), zap.Error(syncErr))
return // Keep watch so the next cycle can retry
}
// When the tracked PR is merged or closed, reset the watch back to the
// "searching" state (pr_number=0) rather than deleting it. This lets the
// poller discover a follow-up PR opened on the same branch (e.g. the user
// closes #1 and opens #2 as a replacement) without requiring manual
// intervention. The watch is only deleted when its owning session is gone.
if status.PR != nil && (status.PR.State == prStateMerged || status.PR.State == prStateClosed) {
p.publishPRStatusEvent(ctx, watch, status)
if resetErr := p.service.store.UpdatePRWatchPRNumber(ctx, watch.ID, 0); resetErr != nil {
p.logger.Error("failed to reset completed PR watch",
zap.String("id", watch.ID), zap.Error(resetErr))
} else {
p.logger.Info("reset PR watch after PR completion",
zap.String("id", watch.ID),
zap.String("state", status.PR.State),
zap.Int("pr_number", watch.PRNumber))
}
return
}
if !hasNew {
return
}
p.publishPRStatusEvent(ctx, watch, status)
}
// detectPRForWatch searches GitHub for a PR on the watch's branch.
// If found, updates the watch with the PR number and creates the TaskPR association.
func (p *Poller) detectPRForWatch(ctx context.Context, watch *PRWatch) {
if p.service.client == nil {
return
}
pr, err := p.service.client.FindPRByBranch(ctx, watch.Owner, watch.Repo, watch.Branch)
if err != nil {
p.logger.Debug("failed to search for PR by branch",
zap.String("watch_id", watch.ID),
zap.String("branch", watch.Branch),
zap.Error(err))
return
}
// Update last_checked_at regardless of result
now := time.Now().UTC()
_ = p.service.store.UpdatePRWatchTimestamps(ctx, watch.ID, now, nil, "", "")
if pr == nil {
return
}
// Found a PR — update the watch and create association
if updateErr := p.service.store.UpdatePRWatchPRNumber(ctx, watch.ID, pr.Number); updateErr != nil {
p.logger.Error("failed to update PR watch with detected PR",
zap.String("watch_id", watch.ID),
zap.Int("pr_number", pr.Number),
zap.Error(updateErr))
return
}
if _, assocErr := p.service.AssociatePRWithTask(ctx, watch.TaskID, pr); assocErr != nil {
p.logger.Error("failed to associate detected PR with task",
zap.String("task_id", watch.TaskID),
zap.Int("pr_number", pr.Number),
zap.Error(assocErr))
return
}
p.logger.Info("detected PR for session branch",
zap.String("watch_id", watch.ID),
zap.String("branch", watch.Branch),
zap.Int("pr_number", pr.Number))
}
func (p *Poller) publishPRStatusEvent(ctx context.Context, watch *PRWatch, status *PRStatus) {
if p.eventBus == nil {
return
}
evt := &PRFeedbackEvent{
SessionID: watch.SessionID,
TaskID: watch.TaskID,
PRNumber: watch.PRNumber,
Owner: watch.Owner,
Repo: watch.Repo,
NewCheckStatus: status.ChecksState,
NewReviewState: status.ReviewState,
}
event := bus.NewEvent(events.GitHubPRFeedback, "github_poller", evt)
if err := p.eventBus.Publish(ctx, events.GitHubPRFeedback, event); err != nil {
p.logger.Debug("failed to publish PR feedback event", zap.Error(err))
}
}
// SetTaskBranchProvider sets the provider used for watch reconciliation.
func (p *Poller) SetTaskBranchProvider(provider TaskBranchProvider) {
p.taskBranchProvider = provider
}
// reconcileWatches ensures PR watches exist for all tasks that need them,
// and refreshes stale branches on existing watches that haven't found a PR yet.
func (p *Poller) reconcileWatches(ctx context.Context) {
if p.taskBranchProvider == nil {
return
}
// 1. Refresh branches on existing pr_number=0 watches (branch may have changed).
p.refreshStaleBranches(ctx)
// 2. Create new watches for sessions that don't have one.
tasks, err := p.taskBranchProvider.ListTasksNeedingPRWatch(ctx)
if err != nil {
p.logger.Error("failed to list tasks needing PR watch", zap.Error(err))
return
}
for _, task := range tasks {
if _, ensureErr := p.service.EnsurePRWatch(
ctx, task.SessionID, task.TaskID, task.Owner, task.Repo, task.Branch,
); ensureErr != nil {
p.logger.Error("failed to ensure PR watch",
zap.String("session_id", task.SessionID), zap.Error(ensureErr))
}
}
}
// refreshStaleBranches re-resolves branches for watches that haven't found a PR yet.
// If the user renamed/changed the branch, the watch is updated so the next poll
// searches on the correct branch.
func (p *Poller) refreshStaleBranches(ctx context.Context) {
watches, err := p.service.ListActivePRWatches(ctx)
if err != nil {
return
}
for _, watch := range watches {
if watch.PRNumber != 0 {
continue // already found a PR, branch is correct
}
currentBranch := p.taskBranchProvider.ResolveBranchForSession(
ctx, watch.TaskID, watch.SessionID,
)
if currentBranch == "" || currentBranch == watch.Branch {
continue
}
p.logger.Info("PR watch branch changed, updating",
zap.String("session_id", watch.SessionID),
zap.String("old_branch", watch.Branch),
zap.String("new_branch", currentBranch))
if updateErr := p.service.UpdatePRWatchBranchIfSearching(ctx, watch.ID, currentBranch); updateErr != nil {
p.logger.Error("failed to update PR watch branch",
zap.String("watch_id", watch.ID), zap.Error(updateErr))
}
}
}
// reviewQueueLoop polls review watches for new PRs.
func (p *Poller) reviewQueueLoop(ctx context.Context) {
defer p.wg.Done()
// Run an initial check immediately so existing watches are evaluated on startup.
p.checkReviewWatches(ctx)
ticker := time.NewTicker(defaultReviewPollInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
p.checkReviewWatches(ctx)
}
}
}
func (p *Poller) checkReviewWatches(ctx context.Context) {
watches, err := p.service.store.ListEnabledReviewWatches(ctx)
if err != nil {
p.logger.Error("failed to list review watches", zap.Error(err))
return
}
if len(watches) == 0 {
return
}
p.logger.Debug("checking review watches", zap.Int("count", len(watches)))
for _, watch := range watches {
p.logger.Debug("polling review watch",
zap.String("watch_id", watch.ID),
zap.String("workspace_id", watch.WorkspaceID),
zap.String("custom_query", watch.CustomQuery),
zap.Int("repo_filters", len(watch.Repos)),
zap.String("review_scope", watch.ReviewScope))
newPRs, err := p.service.CheckReviewWatch(ctx, watch)
if err != nil {
p.logger.Debug("failed to check review watch",
zap.String("id", watch.ID), zap.Error(err))
continue
}
p.logger.Debug("review watch checked",
zap.String("watch_id", watch.ID),
zap.Int("new_prs", len(newPRs)))
for _, pr := range newPRs {
p.logger.Info("new PR found for review",
zap.String("watch_id", watch.ID),
zap.String("repo", pr.RepoOwner+"/"+pr.RepoName),
zap.Int("pr_number", pr.Number),
zap.String("title", pr.Title))
p.service.publishNewReviewPREvent(ctx, watch, pr)
}
// Clean up tasks for merged/closed PRs that the user hasn't opened.
if cleaned, err := p.service.CleanupMergedReviewTasks(ctx, watch); err != nil {
p.logger.Warn("failed to cleanup merged review tasks",
zap.String("watch_id", watch.ID), zap.Error(err))
} else if cleaned > 0 {
p.logger.Info("cleaned up merged review tasks",
zap.String("watch_id", watch.ID), zap.Int("deleted", cleaned))
}
}
}
// issueWatchLoop polls issue watches for new GitHub issues.
func (p *Poller) issueWatchLoop(ctx context.Context) {
defer p.wg.Done()
// Run an initial check immediately so existing watches are evaluated on startup.
p.checkIssueWatches(ctx)
ticker := time.NewTicker(defaultIssuePollInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
p.checkIssueWatches(ctx)
}
}
}
func (p *Poller) checkIssueWatches(ctx context.Context) {
watches, err := p.service.store.ListEnabledIssueWatches(ctx)
if err != nil {
p.logger.Error("failed to list issue watches", zap.Error(err))
return
}
if len(watches) == 0 {
return
}
p.logger.Debug("checking issue watches", zap.Int("count", len(watches)))
for _, watch := range watches {
p.logger.Debug("polling issue watch",
zap.String("watch_id", watch.ID),
zap.String("workspace_id", watch.WorkspaceID),
zap.String("custom_query", watch.CustomQuery),
zap.Int("repo_filters", len(watch.Repos)))
newIssues, err := p.service.CheckIssueWatch(ctx, watch)
if err != nil {
p.logger.Debug("failed to check issue watch",
zap.String("id", watch.ID), zap.Error(err))
continue
}
p.logger.Debug("issue watch checked",
zap.String("watch_id", watch.ID),
zap.Int("new_issues", len(newIssues)))
for _, issue := range newIssues {
p.logger.Info("new issue found for watch",
zap.String("watch_id", watch.ID),
zap.String("repo", issue.RepoOwner+"/"+issue.RepoName),
zap.Int("issue_number", issue.Number),
zap.String("title", issue.Title))
p.service.publishNewIssueEvent(ctx, watch, issue)
}
// Clean up tasks for closed issues that the user hasn't opened.
if cleaned, err := p.service.CleanupClosedIssueTasks(ctx, watch); err != nil {
p.logger.Warn("failed to cleanup closed issue tasks",
zap.String("watch_id", watch.ID), zap.Error(err))
} else if cleaned > 0 {
p.logger.Info("cleaned up closed issue tasks",
zap.String("watch_id", watch.ID), zap.Int("deleted", cleaned))
}
}
}