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

オープン
#277 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
6

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/subenum のほかの issue

TMHSDigital/subenum の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。