Skip to content

Feat/production logging winston#48

Merged
hexawulf merged 2 commits intomainfrom
feat/production-logging-winston
Jun 24, 2025
Merged

Feat/production logging winston#48
hexawulf merged 2 commits intomainfrom
feat/production-logging-winston

Conversation

@hexawulf
Copy link
Copy Markdown
Owner

@hexawulf hexawulf commented Jun 24, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced logging with structured, detailed logs for server activity, including request and WebSocket context.
  • Bug Fixes
    • Improved security by avoiding logging of sensitive information.
  • Chores
    • Updated log directory resolution to ensure consistent log file storage regardless of server start location.
  • Refactor
    • Replaced all console-based logging with a unified logger for better observability and maintainability.
  • Revert
    • Removed legacy server routes and WebSocket implementation.

hexawulf and others added 2 commits June 24, 2025 09:22
Merge pull request #46 from hexawulf/feat/production-logging-winston
- Updated Winston logger file transport paths in `server/src/logger/index.ts` to use `path.resolve(__dirname, '../../logs')` for more robust path resolution, ensuring logs are correctly written regardless of the application's CWD.
- Deleted the deprecated `server/routes-old.ts` file.
- Completed a comprehensive sweep of all `console.log` and `console.error` (and other console variants) calls within the `server/` directory (excluding `server/vite.ts` which has its own specific logger) and replaced them with appropriate Winston logger methods (e.g., `logger.info`, `logger.error`, `logger.warn`, `logger.debug`). This includes thorough updates in `server/firebaseAuth.ts` and `server/routes.ts`.
- Added a test log message `logger.info('Winston logger initialized – startup check')` to `server/index.ts` to help verify logger initialization.

User has manually tested and confirmed that logs are now appearing as expected in both the console (development mode) and the `logs/combined.log` and `logs/error.log` files.
@hexawulf hexawulf merged commit 1e472c0 into main Jun 24, 2025
1 check failed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jun 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Console-based logging across server modules is replaced with structured Winston logger calls, enhancing log detail and security. Log statements now include contextual metadata and avoid exposing sensitive information. The logs directory path resolution is updated for reliability. The legacy route and WebSocket server implementation is removed.

Changes

File(s) Change Summary
server/firebaseAuth.ts Replaced all console logs with Winston logger; improved log metadata; avoided logging sensitive info; no logic changes.
server/index.ts Added an informational Winston logger statement to confirm logger initialization at server startup.
server/routes-old.ts Deleted file: legacy Express and WebSocket server with authentication, REST API, and real-time collaboration.
server/routes.ts Replaced all console logs with Winston logger; improved context in logs; updated WebSocket message handler signature for logging.
server/src/logger/index.ts Changed logs directory resolution to be relative to logger file location, not process cwd.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ExpressServer
    participant Logger
    participant FirebaseAuth
    participant WebSocketServer

    Client->>ExpressServer: HTTP request
    ExpressServer->>Logger: logger.info/debug/warn/error (with metadata)
    ExpressServer->>FirebaseAuth: Validate authentication
    FirebaseAuth->>Logger: logger.info/debug/warn/error (with metadata)
    ExpressServer-->>Client: HTTP response

    Client->>WebSocketServer: WebSocket connect/message
    WebSocketServer->>Logger: logger.info/debug/warn/error (with client IP)
    WebSocketServer-->>Client: Broadcast/response
Loading

Possibly related PRs

Suggested labels

codex

Poem

Logs now sparkle, neat and bright,
Winston guides us through the night.
No secrets spilled, just structured cheer,
With every warning loud and clear.
Old routes hop away, new logs take the stage—
A rabbit’s delight, on every page!
🐇✨


📜 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 c5640de and 0015891.

📒 Files selected for processing (5)
  • server/firebaseAuth.ts (3 hunks)
  • server/index.ts (1 hunks)
  • server/routes-old.ts (0 hunks)
  • server/routes.ts (20 hunks)
  • server/src/logger/index.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

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.

1 participant