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

Abierto
  • ¿Algo no está bien?
#277 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
backend, cli

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Go
Estrellas
1
Forks
1
Merge medio
7 h 48 min
PR fusionados (30 d)
6

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/subenum

Todos los issues de TMHSDigital/subenum

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.