Skip to content

Conversation

@ussaama
Copy link
Contributor

@ussaama ussaama commented Jul 14, 2025

Summary by CodeRabbit

  • New Features
    • Added a pre-configured terminal session setup for VSCode, enabling automatic startup of server, worker, scheduler, and frontend development environments with predefined commands.
  • Chores
    • Replaced terminal restoration extensions with a new extension for improved terminal session management in the development container configuration.

@linear
Copy link

linear bot commented Jul 14, 2025

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Walkthrough

This change updates the devcontainer configuration to include the "nguyenngoclong.terminal-keeper" VSCode extension and introduces a new sessions.json file for VSCode terminal session management. The session configuration automates launching multiple terminals with predefined commands for backend and frontend development workflows.

Changes

Files/Paths Change Summary
echo/.devcontainer/devcontainer.json Replaced "EthanSK.restore-terminals" extensions with "nguyenngoclong.terminal-keeper" extension.
echo/.vscode/sessions.json Added new VSCode terminal session config for automated multi-terminal development setup.
echo/.vscode/settings.json Removed previous terminal restore configuration and related terminal group commands.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant VSCode
    participant Terminal Keeper Extension

    Developer->>VSCode: Open devcontainer
    VSCode->>VSCode: Load extensions (including terminal-keeper)
    Developer->>VSCode: Start terminal session (sessions.json)
    VSCode->>Terminal Keeper Extension: Parse sessions.json
    Terminal Keeper Extension->>VSCode: Create terminal groups
    loop For each terminal group
        Terminal Keeper Extension->>VSCode: Create terminal(s) with auto-execute commands
    end
    VSCode->>Developer: Ready terminals with running processes
Loading

Assessment against linked issues

Objective Addressed Explanation
Find alternate to restore terminals for Echo (ECHO-335)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes detected. LGTM.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between df6a1e4 and 0ff6d2f.

📒 Files selected for processing (2)
  • echo/.devcontainer/devcontainer.json (1 hunks)
  • echo/.vscode/settings.json (0 hunks)
💤 Files with no reviewable changes (1)
  • echo/.vscode/settings.json
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ussaama
PR: Dembrane/echo#205
File: echo/frontend/src/lib/query.ts:1444-1506
Timestamp: 2025-07-10T12:48:20.663Z
Learning: ussaama prefers string concatenation over template literals for simple cases where readability is clearer, even when linting tools suggest template literals. Human readability takes precedence over strict linting rules in straightforward concatenation scenarios.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Cursor BugBot
  • GitHub Check: ci-check-server
🔇 Additional comments (2)
echo/.devcontainer/devcontainer.json (2)

24-31: Terminal persistence stack trimmed – LGTM.

Duplicate restore-terminals entries are gone and the list is now a single-source-of-truth with nguyenngoclong.terminal-keeper. Clean 💯.


17-32: No lingering restore-terminals artifacts found
Ran the ripgrep smoke-test for both "EthanSK.restore-terminals" and any restore-terminals occurrences—zero hits across the repo. Safe to ship. LGTM!


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.

@ussaama ussaama requested a review from spashii July 14, 2025 14:54
@ussaama ussaama enabled auto-merge July 14, 2025 14:55
@ussaama
Copy link
Contributor Author

ussaama commented Jul 14, 2025

@spashii i'll update the docs if we go forward with this solution after testing

Copy link
Contributor

@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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3618ec and 3a92060.

📒 Files selected for processing (2)
  • echo/.devcontainer/devcontainer.json (1 hunks)
  • echo/.vscode/sessions.json (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ussaama
PR: Dembrane/echo#205
File: echo/frontend/src/lib/query.ts:1444-1506
Timestamp: 2025-07-10T12:48:20.663Z
Learning: ussaama prefers string concatenation over template literals for simple cases where readability is clearer, even when linting tools suggest template literals. Human readability takes precedence over strict linting rules in straightforward concatenation scenarios.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: Cursor BugBot
  • GitHub Check: ci-check-frontend
  • GitHub Check: ci-check-server
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
echo/.vscode/sessions.json (1)

17-45: Nested array shape – double-check against Terminal-Keeper spec

The file mixes single objects and arrays to express split groups. The v10 spec expects:

[ Terminal | { split: [ Terminal, … ] }, … ]

Here we directly embed [ {…}, {…} ] without the split key (lines 17-45). It might still parse, but it’s undocumented. Verify in VS Code: if groups don’t split as intended, wrap them with a { "split": [...] }.

…dd icons for various terminal sessions for improved visual organization.
Copy link
Contributor

@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

♻️ Duplicate comments (2)
echo/.vscode/sessions.json (2)

2-2: Vendor the JSON schema locally for offline resilience

Pointing $schema at a CDN makes validation brittle when you’re on a plane or the CDN hiccups. Drop the file under .vscode/schema/terminal-keeper.json and reference it relatively.


14-15: Hard-coded .venv path → use a wrapper script

Four separate terminals break if the user’s venv isn’t named .venv (Poetry, Conda, etc.). Stick the activation logic in server/activate_and_run.sh and call that instead. Same advice as the previous review.

Also applies to: 24-26, 34-36, 44-46

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3a92060 and 9f362b0.

📒 Files selected for processing (1)
  • echo/.vscode/sessions.json (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ussaama
PR: Dembrane/echo#205
File: echo/frontend/src/lib/query.ts:1444-1506
Timestamp: 2025-07-10T12:48:20.663Z
Learning: ussaama prefers string concatenation over template literals for simple cases where readability is clearer, even when linting tools suggest template literals. Human readability takes precedence over strict linting rules in straightforward concatenation scenarios.

@spashii
Copy link
Member

spashii commented Jul 15, 2025

@ussaama in this branch remove the "restore-terminals" from the .devcontainer

@ussaama ussaama added this pull request to the merge queue Jul 15, 2025
Merged via the queue into main with commit 2b720f6 Jul 15, 2025
9 checks passed
@ussaama ussaama deleted the add-terminal-keeper branch July 15, 2025 13:19
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Bug: Mixed Array Types in Session Data

The default session array in sessions.json contains inconsistent element types, mixing a single terminal object ('server') with arrays of terminal objects (e.g., 'workers', 'scheduler'). This mixed structure will likely cause parsing errors in the terminal-keeper extension. Furthermore, the 'scheduler' terminal is now grouped with 'workers' and 'workers-cpu', altering its intended separate terminal organization.

echo/.vscode/sessions.json#L6-L70

"sessions": {
"default": [
{
"autoExecuteCommands": true,
"name": "server",
"icon": "server",
"commands": [
"cd server",
"source .venv/bin/activate",
"./run.sh"
]
},
[
{
"autoExecuteCommands": true,
"name": "workers",
"icon": "gear",
"commands": [
"cd server",
"source .venv/bin/activate",
"./run-worker.sh"
]
},
{
"autoExecuteCommands": true,
"name": "workers-cpu",
"icon": "gear",
"commands": [
"cd server",
"source .venv/bin/activate",
"./run-worker-cpu.sh"
]
},
{
"autoExecuteCommands": true,
"name": "scheduler",
"icon": "clock",
"commands": [
"cd server",
"source .venv/bin/activate",
"./run-scheduler.sh"
]
}
],
[
{
"autoExecuteCommands": true,
"name": "admin-dashboard",
"icon": "browser",
"commands": [
"cd frontend",
"pnpm run dev"
]
},
{
"autoExecuteCommands": true,
"name": "participant-portal",
"icon": "browser",
"commands": [
"cd frontend",
"pnpm run participant:dev"
]
}
]
]

Fix in CursorFix in Web


Was this report helpful? Give feedback by reacting with 👍 or 👎

spashii pushed a commit that referenced this pull request Nov 18, 2025
* Update devcontainer.json to include terminal-keeper extension for enhanced terminal management

* Remove activateOnStartup setting from VSCode sessions configuration for cleaner terminal management.

* Update VSCode sessions configuration to change theme to 'tribe' and add icons for various terminal sessions for improved visual organization.

* Update devcontainer.json to add terminal-keeper extension for enhanced terminal management.

* Remove "restore-terminals" extension and related terminal configurations from VSCode settings for cleaner setup.
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.

3 participants