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 摘要。