mirror of
https://github.com/obra/superpowers.git
synced 2026-04-24 02:19:05 +08:00
fix: session isolation and blocking wait for visual companion
- Each session gets unique temp directory (/tmp/brainstorm-{pid}-{timestamp})
- Server outputs screen_dir and screen_file in startup JSON
- stop-server.sh takes screen_dir arg and cleans up session directory
- Document blocking TaskOutput pattern: 10-min timeouts, retry up to 3x,
then prompt user "let me know when you want to continue"
This commit is contained in:
@@ -68,17 +68,22 @@ Only proceed with visual companion if they agree. Otherwise, describe options in
|
||||
### Starting the Visual Companion
|
||||
|
||||
```bash
|
||||
# Start server (outputs JSON with URL)
|
||||
# Start server (creates unique session directory)
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/start-server.sh
|
||||
|
||||
# Output looks like: {"type":"server-started","port":52341,"url":"http://localhost:52341"}
|
||||
# Output looks like:
|
||||
# {"type":"server-started","port":52341,"url":"http://localhost:52341",
|
||||
# "screen_dir":"/tmp/brainstorm-12345-1234567890",
|
||||
# "screen_file":"/tmp/brainstorm-12345-1234567890/screen.html"}
|
||||
```
|
||||
|
||||
**Save the `screen_dir` and `screen_file` paths from the response** - you'll need them throughout the session.
|
||||
|
||||
Tell the user to open the URL in their browser.
|
||||
|
||||
### Showing Content
|
||||
|
||||
Write complete HTML to `/tmp/brainstorm/screen.html`. The browser auto-refreshes.
|
||||
Write complete HTML to the session's `screen_file` path. The browser auto-refreshes.
|
||||
|
||||
Use the frame template structure from `${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/frame-template.html`:
|
||||
- Keep the header and feedback-footer intact
|
||||
@@ -89,31 +94,37 @@ See `${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/CLAUDE-INSTRUCTIONS.md` for det
|
||||
|
||||
### Waiting for User Feedback
|
||||
|
||||
Run the watcher as a background bash command:
|
||||
Start the watcher as a background bash command, then use TaskOutput with block=true to wait:
|
||||
|
||||
```bash
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/wait-for-event.sh /tmp/brainstorm/.server.log
|
||||
# 1. Start watcher in background
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/wait-for-event.sh $SCREEN_DIR/.server.log
|
||||
|
||||
# 2. Call TaskOutput(task_id, block=true, timeout=600000) to wait
|
||||
# 3. If timeout, call TaskOutput again (watcher is still running)
|
||||
# 4. After 3 timeouts (30 min), say "Let me know when you want to continue" and stop looping
|
||||
```
|
||||
|
||||
When the user clicks Send in the browser, the watcher exits and you receive their feedback as JSON:
|
||||
When the user clicks Send in the browser, the watcher exits and TaskOutput returns with feedback:
|
||||
```json
|
||||
{"choice": "a", "feedback": "I like this but make the header smaller"}
|
||||
```
|
||||
|
||||
### The Loop
|
||||
|
||||
1. Write screen HTML
|
||||
1. Write screen HTML to `screen_file`
|
||||
2. Start watcher (background bash)
|
||||
3. Watcher completes when user sends feedback
|
||||
4. Read feedback, respond with new screen
|
||||
5. Repeat until done
|
||||
3. Call TaskOutput(task_id, block=true) to wait
|
||||
4. TaskOutput returns with feedback
|
||||
5. Respond with new screen
|
||||
6. Repeat until done
|
||||
|
||||
### Cleaning Up
|
||||
|
||||
When the visual brainstorming session is complete:
|
||||
When the visual brainstorming session is complete, pass the screen_dir to stop:
|
||||
|
||||
```bash
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/stop-server.sh
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/stop-server.sh $SCREEN_DIR
|
||||
```
|
||||
|
||||
### Tips
|
||||
|
||||
@@ -6,32 +6,34 @@ Quick reference for using the visual brainstorming companion.
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `lib/brainstorm-server/start-server.sh` | Start server, outputs JSON with URL |
|
||||
| `lib/brainstorm-server/stop-server.sh` | Stop server and clean up |
|
||||
| `lib/brainstorm-server/start-server.sh` | Start server, outputs JSON with URL and session paths |
|
||||
| `lib/brainstorm-server/stop-server.sh` | Stop server and clean up session directory |
|
||||
| `lib/brainstorm-server/wait-for-event.sh` | Wait for user feedback |
|
||||
| `lib/brainstorm-server/frame-template.html` | Base HTML template with CSS |
|
||||
| `lib/brainstorm-server/CLAUDE-INSTRUCTIONS.md` | Detailed usage guide |
|
||||
| `/tmp/brainstorm/screen.html` | Write your screens here |
|
||||
| `/tmp/brainstorm/.server.log` | Server output (for watcher) |
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Start server
|
||||
# 1. Start server (creates unique session directory)
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/start-server.sh
|
||||
# Returns: {"type":"server-started","port":52341,"url":"http://localhost:52341"}
|
||||
# Returns: {"type":"server-started","port":52341,"url":"http://localhost:52341",
|
||||
# "screen_dir":"/tmp/brainstorm-12345-1234567890",
|
||||
# "screen_file":"/tmp/brainstorm-12345-1234567890/screen.html"}
|
||||
|
||||
# 2. Write screen
|
||||
# Write HTML to /tmp/brainstorm/screen.html
|
||||
# 2. Write screen to the session's screen_file
|
||||
# Use Bash with heredoc to write HTML
|
||||
|
||||
# 3. Wait for feedback (background)
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/wait-for-event.sh /tmp/brainstorm/.server.log
|
||||
|
||||
# 4. Read watcher output when it completes
|
||||
# 3. Wait for feedback using TaskOutput with block=true
|
||||
# Start watcher in background:
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/wait-for-event.sh $SCREEN_DIR/.server.log
|
||||
# Then call TaskOutput(task_id, block=true, timeout=600000) to wait
|
||||
# If timeout, call TaskOutput again (watcher still running)
|
||||
# After 3 timeouts (30 min), say "Let me know when you want to continue"
|
||||
# Returns: {"choice":"a","feedback":"user notes"}
|
||||
|
||||
# 5. Clean up when done
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/stop-server.sh
|
||||
# 4. Clean up when done (pass screen_dir as argument)
|
||||
${CLAUDE_PLUGIN_ROOT}/lib/brainstorm-server/stop-server.sh $SCREEN_DIR
|
||||
```
|
||||
|
||||
## CSS Classes
|
||||
|
||||
Reference in New Issue
Block a user