Skip to content

print verbose output in case of -duc #6195

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

dogancanbakir
Copy link
Member

@dogancanbakir dogancanbakir commented Apr 25, 2025

Proposed changes

Closes #6150

$ go run . -duc

                     __     _
   ____  __  _______/ /__  (_)
  / __ \/ / / / ___/ / _ \/ /
 / / / / /_/ / /__/ /  __/ /
/_/ /_/\__,_/\___/_/\___/_/   v3.4.2

                projectdiscovery.io

[INF] Current nuclei version: v3.4.2 (unknown) - remove '-duc' flag to enable update checks
[INF] Current nuclei-templates version: v10.1.7 (unknown) - remove '-duc' flag to enable update checks
[WRN] Scan results upload to cloud is disabled.
[INF] New templates added in latest release: 64
[INF] Templates loaded for current scan: 7905
[WRN] Loading 208 unsigned templates for scan. Use with caution.
[INF] Executing 7697 signed templates from projectdiscovery/nuclei-templates
[INF] No results found. Better luck next time!

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • Refactor
    • Improved the version display logic for nuclei and nuclei-templates, providing clearer information when update checks are disabled.
  • Chores
    • Updated a dependency to the latest version for enhanced stability.

@dogancanbakir dogancanbakir requested a review from ehsandeep April 25, 2025 11:50
@dogancanbakir dogancanbakir self-assigned this Apr 25, 2025
@auto-assign auto-assign bot requested a review from dwisiswant0 April 25, 2025 11:50
Copy link
Contributor

coderabbitai bot commented Apr 25, 2025

Walkthrough

The changes update the github.com/projectdiscovery/utils dependency to version v0.4.18 in the go.mod file. Additionally, the version display logic in the Runner struct's displayExecutionInfo method is refactored. A helper function is introduced to improve the handling of version status messages, especially when update checks are disabled, ensuring the version status is shown as "unknown" instead of "outdated" in such cases. No exported or public entities are altered.

Changes

File(s) Change Summary
go.mod Updated github.com/projectdiscovery/utils dependency from v0.4.17 to v0.4.18.
internal/runner/runner.go Refactored version display logic; added helper to show "unknown" status if update checks disabled.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Runner
    participant Logger

    User->>Runner: Run nuclei with or without -disable-update-check
    Runner->>Runner: displayExecutionInfo()
    Runner->>Runner: versionInfo(current, latest, type)
    alt Update checks enabled
        Runner->>Logger: Log version with update status
    else Update checks disabled
        Runner->>Logger: Log version as "unknown" (bright yellow)
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent latest version from being marked as "outdated" when -disable-update-check is used (#6150)

Poem

A hop and a skip, a version anew,
Now "unknown" is shown when updates can't view!
No more "outdated" to cause alarm,
Even with checks off, there's no harm.
The code is now clear, the logic refined—
A rabbit's delight, with bugs left behind! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24311cc and d0a44aa.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (2)
  • go.mod (1 hunks)
  • internal/runner/runner.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Lint
🔇 Additional comments (3)
go.mod (1)

103-103:

❓ Verification inconclusive

Dependency version updated to support new version display logic.

The update from v0.4.17 to v0.4.18 of the github.com/projectdiscovery/utils package aligns with the PR objective to improve verbose output when -duc flag is used.


🏁 Script executed:

#!/bin/bash
# Verify the changes in the projectdiscovery/utils package between versions

# Compare changes between v0.4.17 and v0.4.18
echo "Checking changes between utils v0.4.17 and v0.4.18"
git clone --quiet https://github.com/projectdiscovery/utils.git /tmp/utils
cd /tmp/utils
git log --oneline v0.4.17..v0.4.18

Length of output: 265


Confirm projectdiscovery/utils v0.4.18 includes display improvements

It looks like there are no commits between v0.4.17 and v0.4.18 (git log shows an empty range), which suggests this bump may not include any changes to the version‐display logic. Please verify that the release you’re targeting actually contains the enhancements needed for the -duc flag:

  • Review the v0.4.18 release notes or tag annotation for any mention of verbose output or version‐display fixes
  • Check that the code paths exercised by -duc rely on new functionality in v0.4.18
  • If the needed changes aren’t in v0.4.18, update to the correct tag/version or adjust your PR accordingly
internal/runner/runner.go (2)

834-839: Well-structured helper function for improved version display.

The local helper function versionInfo handles version display formatting based on whether update checks are enabled, providing clearer information when -duc flag is used.


841-842: Consistent version information display for both nuclei and nuclei-templates.

The refactored code uses the same helper function for displaying both nuclei and nuclei-templates version information, making the output consistent and more informative, especially when update checks are disabled.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dogancanbakir
Copy link
Member Author

ignore func tests, tracking at #6157

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] nuclei latest version termed as outdated if -disable-update-check is used
1 participant