Repository navigation
feat(lib): reuse metadata cache across thread-safe scans #7608
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Mzack9999
merged 3 commits into
dev
from
dwisiswant0/feat/lib/reuse-metadata-cache-across-thread-safe-scans
Jul 26, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package nuclei | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/projectdiscovery/nuclei/v3/pkg/catalog/index" | ||
| ) | ||
|
|
||
| func BenchmarkExecuteNucleiWithOptsCtx(b *testing.B) { | ||
| templatePath := filepath.Join(b.TempDir(), "benchmark.yaml") | ||
| err := os.WriteFile(templatePath, []byte(`id: benchmark-execute-nuclei-with-opts-ctx | ||
|
|
||
| info: | ||
| name: Benchmark ExecuteNucleiWithOptsCtx | ||
| author: pdteam | ||
| severity: info | ||
|
|
||
| http: | ||
| - method: GET | ||
| path: | ||
| - "{{BaseURL}}" | ||
| matchers: | ||
| - type: status | ||
| status: | ||
| - 418 | ||
| `), 0o600) | ||
| if err != nil { | ||
| b.Fatalf("could not write benchmark template: %s", err) | ||
| } | ||
|
|
||
| server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusNoContent) | ||
| })) | ||
| b.Cleanup(server.Close) | ||
|
|
||
| metadataIndex, err := index.NewIndex(b.TempDir()) | ||
| if err != nil { | ||
| b.Fatalf("could not create benchmark metadata index: %s", err) | ||
| } | ||
|
|
||
| engine, err := NewThreadSafeNucleiEngineCtx( | ||
| b.Context(), | ||
| DisableUpdateCheck(), | ||
| WithTemplatesOrWorkflows(TemplateSources{Templates: []string{templatePath}}), | ||
| ) | ||
| if err != nil { | ||
| b.Fatalf("could not create thread-safe nuclei engine: %s", err) | ||
| } | ||
| b.Cleanup(engine.Close) | ||
|
|
||
| // Keep benchmark metadata isolated from the user's persistent cache. | ||
| engine.eng.metadataIndexOnce.Do(func() { | ||
| engine.eng.metadataIndex = metadataIndex | ||
| }) | ||
|
|
||
| targets := []string{server.URL} | ||
| if err := engine.ExecuteNucleiWithOptsCtx(b.Context(), targets); err != nil { | ||
| b.Fatalf("could not warm up nuclei execution: %s", err) | ||
| } | ||
|
|
||
| b.ReportAllocs() | ||
| b.ResetTimer() | ||
|
|
||
| for b.Loop() { | ||
| if err := engine.ExecuteNucleiWithOptsCtx(b.Context(), targets); err != nil { | ||
| b.Fatalf("could not execute nuclei: %s", err) | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🔴 Critical | ⚡ Quick win
Unsynchronized read of
e.metadataIndexraces with concurrentgetMetadataIndex()writers.e.metadataIndexis written insidemetadataIndexOnce.Do(...)(lines 107-123), butcloseInternalreads the raw field directly instead of going through the samesync.Once-guarded getter. IfClose()runs concurrently with an in-flightExecuteNucleiWithOptsCtxcall that's still initializing the index (a realistic scenario for a "thread-safe" engine), this is a data race per the Go memory model.🔒 Proposed fix: read through the synchronized getter
📝 Committable suggestion
🤖 Prompt for AI Agents