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

Ouverte
  • Quelque chose ne va pas ?
#277 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Refactorisation
Clarté
Plutôt claire
Activité
Active
Stack technique
go
Domaine
backend, cli

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Go
Étoiles
1
Forks
1
Merge moyen
7 h 48 min
PR mergées (30 j)
6

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/subenum

Toutes les issues de TMHSDigital/subenum

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.