add "secret" dev panel

[mdroidian]

Summary by CodeRabbit

• New Features
  • Introduced a "Secret Dev Panel" accessible via a keyboard shortcut (Ctrl + Shift + D).
  • Added functionality for logging the Node environment and sending a test error email within the new panel.
• Bug Fixes
  • Cleaned up the code by removing unnecessary commented-out sections.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
discourse-graph	⬜️ Skipped (Inspect)			Dec 27, 2024 3:44am

[coderabbitai]

Walkthrough

The pull request introduces a new "Secret Dev Panel" to the Settings component, accessible via a keyboard shortcut (Ctrl + Shift + D). This panel provides developers with quick access to utility functions like logging the Node environment and sending test error emails. The implementation modifies the existing settings dialog to include this hidden development-focused tab, enhancing developer tooling within the application.

Changes

File	Change Summary
apps/roam/src/components/settings/Settings.tsx	- Added keyboard shortcut (Ctrl + Shift + D) to reveal secret dev panel - Implemented new tab with environment logging and test error email buttons - Removed commented-out code - Updated React imports to include useEffect

Sequence Diagram

sequenceDiagram
    participant User
    participant Settings
    participant DevPanel
    
    User->>Settings: Press Ctrl+Shift+D
    Settings->>DevPanel: Reveal Secret Dev Panel
    User->>DevPanel: Click "Log Node Env"
    DevPanel-->>User: Display Environment Details
    User->>DevPanel: Click "Send Test Error Email"
    DevPanel-->>User: Trigger Test Email

Loading

Poem

🐰 A dev's secret delight, hidden from sight,
Ctrl+Shift+D brings panels so bright!
Logs and emails, a rabbit's glee,
Debugging magic, just for me! 🔧
A playful shortcut, developer's might! 🚀

---

🪧 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

apps/roam/src/components/settings/Settings.tsx (3)

73-85: Consider keyboard event scope.
This keyboard listener is globally active and could potentially conflict with other shortcuts in the application or user browser. If you intend for this secret dev panel shortcut to only function in certain contexts (e.g., the settings dialog, or only if an input field is not focused), consider scoping or conditionally enabling the listener.

---

172-174: Confirm hidden tab approach.
Using hidden={true} hides the tab visually but still renders it. If you intend for this tab to be entirely inaccessible (until triggered), consider conditionally omitting it from the DOM, which can improve accessibility and make the feature truly undiscoverable by default.

---

177-184: Avoid logging environment variables in production.
While NODE_ENV is not highly sensitive, it's generally safer to avoid logs of environment variables in production builds to prevent accidental leakage. If this log is exclusively for local development, ensure it is gated behind development checks or removed in production.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e03404 and 5ed9fe4.

📒 Files selected for processing (1)

• apps/roam/src/components/settings/Settings.tsx (5 hunks)

🔇 Additional comments (1)

apps/roam/src/components/settings/Settings.tsx (1)

194-194: Provide user feedback or error handling.
When sending an error email, consider providing visual or console feedback indicating whether the message was successfully sent. This can enhance the developer experience by quickly confirming the action’s result, especially when debugging.