Regression: scan.Run is a 248-line function in the engine's most-changed file

未關閉
  • 哪裡不對？
#277 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
35/100
Issue 類型
重構
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
go
領域
backend, cli

研究方向

Start with Run in internal/scan/runner.go (lines 556-803) and the deferred "done not sent" closure at lines 596-601, then trace each early return. Before moving any code, add or confirm tests in go test ./internal/scan/ that each early exit (scope refusal, recursion ceiling, preflight failure, wildcard without force, cancellation during preflight) emits exactly one done event. Done means those tests pass and the preflight extraction is a pure move with no behaviour change.

由索引模型根據 Issue 內容生成。

描述

severity: medium tech-debt

Summary

scan.Run is a 248-line function in the engine's most-changed file. A few other functions are past 100 lines. The configured linters (no funlen or gocyclo) do not flag any of them.

Where

  • internal/scan/runner.go:556-803 (Run): it does limiter setup, scope refusal, recursion ceiling, resolver preflight, wildcard detection, wiring for the ticker, dispatcher and workers, retry pass, and the final snapshot. Every early return depends on the deferred "done not sent" closure at :596-601.
  • runner.go has 1,064 lines (the largest Go file), and 44 of the last 500 commits touched it.
  • Counters mix raw *int64 with atomic.LoadInt64 (processed, found, total) and atomic.Int64 (queriesSent).
  • Other hotspots:
    • internal/tui/form.go:366 validate: 116 lines
    • pkg/subenum/subenum.go:563 options: 114 lines
    • main_session.go:602 scanOneTarget: 95 lines

Why it hurts now

Every new preflight feature (AXFR, pools, auto-rate, deadline) landed inside Run. The phase order and the "exactly one done event" contract (#99, #23) are easy to break with each edit.

Plan

  1. Tests first: confirm that each early exit (scope refusal, ceiling refusal, preflight failure, wildcard without force, cancellation during preflight) emits exactly one done event. Add any that are missing.
  2. Extract preflight(ctx, &cfg, events) (wildcardRoot bool, fp *fingerprint, ok bool) as a pure move.
  3. Extract startTicker and startWorkers.
  4. Move processed, found and total to atomic.Int64 fields on scanState.
  5. Consider enabling funlen with a generous limit, to stop new 200-line functions.

#159 lifted the dispatcher out of scan.Run and was closed. Since then, preflight, wildcard, retry, pool and deadline work has grown Run back to 248 lines.

Getting started

  • Relevant files: internal/scan/runner.go
  • How to run tests: go test ./internal/scan/ (lint with golangci-lint run ./...)
  • Related docs: docs/ARCHITECTURE.md

Filed by repo-audit/full-audit at 3f671b2. Severity: medium. Effort: M. audit-key: tech-debt|internal/scan/runner.go|Run

主要語言
Go
星號
1
分支
1
平均合併
7 小時 48 分鐘
30 天內合併 PR
6

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

TMHSDigital/subenum 的其他 Issue

查看 TMHSDigital/subenum 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。