Skip to content
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

🚸 Add log middleware to basic template #124

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

valentimarco
Copy link

@valentimarco valentimarco commented Dec 5, 2024

Please provide enough information so that others can review your pull request:

As title

Explain the details for making this change. What existing problem does the pull request solve?

The logging middleware can help a lot when developing

Summary by CodeRabbit

  • New Features
    • Enhanced new command for generating Fiber projects with improved templates.
    • Added middleware logger to the basic project template.
  • Bug Fixes
    • Improved error handling during project creation.
    • Refined cloning logic for repository URLs.
  • Documentation
    • Updated command usage examples for clarity.

Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in the pull request primarily enhance the functionality of the new command in the cmd/new.go file, which is used for generating Fiber projects. Key updates include improved error handling in the newRunE function, adjustments to the createProject function for correct working directory settings, and the addition of a middleware logger in the createBasic function's template. The createComplex function has also been refined for better repository cloning logic, while new variables have been introduced to support these enhancements.

Changes

File Change Summary
cmd/new.go - Enhanced newRunE with improved error handling and project creation logic.
- Updated createProject to ensure correct working directory after project creation.
- Modified createBasic to include a new middleware logger in the generated main.go.
- Refined createComplex for robust repository cloning and handling of repository URLs.
- Added variables: var newExamples, var newBasicTemplate, var newSuccessTemplate.
- Adjusted code formatting for consistency, particularly in function definitions and returns.

Poem

🐇 In the meadow where projects grow,
A new command brings a vibrant glow.
With logs to guide and errors tamed,
Fiber's magic is now proclaimed.
Hop along, let templates rise,
A world of code beneath the skies! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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 or @coderabbitai title 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
cmd/new.go (1)

Line range hint 82-116: Consider documenting the logger middleware feature

The basic template now includes a logger middleware by default, but this isn't reflected in the examples or documentation. Consider adding a note about this feature to help users understand what's included in the generated project.

Here's a suggested addition to the examples:

  fiber new fiber-demo
-  Generates a project with go module name fiber-demo
+  Generates a project with go module name fiber-demo (includes request logging middleware)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f345bf8 and f99a663.

📒 Files selected for processing (1)
  • cmd/new.go (1 hunks)
🔇 Additional comments (1)
cmd/new.go (1)

138-145: LGTM! Logger middleware integration looks good.

The logger middleware is correctly imported and properly registered at the application level, ensuring all requests will be logged. This will help developers during the development process by providing visibility into incoming requests.


log.Fatal(app.Listen(":3000"))
app.Listen(":3000")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add error handling for the server startup

The app.Listen() call should include error handling to prevent silent failures.

Here's the suggested improvement:

-	app.Listen(":3000")
+	if err := app.Listen(":3000"); err != nil {
+		log.Fatal(err)
+	}

Don't forget to add the log package to the imports:

+	"log"

Committable suggestion skipped: line range outside the PR's diff.


log.Fatal(app.Listen(":3000"))
app.Listen(":3000")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The log fatal is needed else you won't see why it failed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ops, i forgot xd

)

func main() {
app := fiber.New()
app := fiber.New()
app.Use(logger.New())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does add overhead, probably why the default server doesnt have it

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think is useful to have it, maybe i can add a check for a env like "DEBUG" and activate only when the enviroment is develop?

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.

2 participants