@muggleai/works 4.8.4 → 4.9.0

package/plugin/skills/muggle-test-prepare/SKILL.md

@@ -0,0 +1,276 @@
+---
+name: muggle-test-prepare
+description: "Make sure dev servers and sibling services are ready on the user's machine before running E2E acceptance tests. Checks which services need to be running, discovers sibling directories by folder name, verifies what's already listening, and offers to start anything that's missing — with the user's approval at every step. Use this skill whenever the user needs to prepare their local environment for E2E testing, verify their services are up, get their local dev stack ready, or when other muggle skills detect that required services are not listening on common ports. Triggers on: 'prepare for testing', 'make sure my services are running', 'check my local env', 'get ready for tests', 'are my services up', 'prepare local environment', 'spin up services', 'set up for E2E', 'verify my setup'. Also use when muggle-test, muggle-do, or muggle-test-feature-local need services running."
+---
+
+# Muggle Test Prepare
+
+Make sure the local services a user needs for E2E acceptance testing are up and ready. Check what's already running, discover sibling service directories by folder name, and offer to start anything that's missing — always with the user in control.
+
+Some users start their own services (tmux scripts, docker-compose, a terminal per service). Others want help launching them. This skill handles both: it verifies readiness first, and only offers to start things when something is missing.
+
+## Privacy Boundary
+
+This skill touches the user's local machine — processes, ports, directories outside the current repo. Every action is explicit and confirmed.
+
+- **Folder names are public.** You may list directory names in a parent folder to discover sibling services.
+- **File contents are private until confirmed.** Never read files inside a directory the user hasn't explicitly identified as a service to start. Once confirmed, you may inspect only top-level project indicator files (`package.json`, `Makefile`, `Cargo.toml`, `go.mod`, `pyproject.toml`, `docker-compose.yml`) to determine the start command.
+- **Never traverse upward more than one level** from the current working directory to list folders.
+
+## PID Tracking
+
+All launched processes are tracked in `/tmp/muggle-test-prepare.json`:
+
+```json
+{
+  "session_started": "2025-01-15T10:30:00Z",
+  "testing_scope": "frontend",
+  "excluded_services": [
+    {"name": "payment-gateway", "reason": "Needs production certificates"}
+  ],
+  "services": [
+    {
+      "name": "backend-api",
+      "dir": "/Users/user/Github/backend-api",
+      "command": "npm run dev",
+      "pid": 12345,
+      "port": 3001,
+      "log": "/tmp/muggle-prepare-backend-api.log"
+    }
+  ]
+}
+```
+
+The `testing_scope` field records what the user is testing (from Step 1). The `excluded_services` field records services the user said can't run locally (from Step 2), so other skills understand what's intentionally absent vs. forgotten.
+
+**On every invocation**, check this file first. If it exists with live PIDs (verify with `kill -0`), present the running services and ask:
+
+Use `AskQuestion`:
+- Option 1: "Keep them running — skip to testing"
+- Option 2: "Tear down and start fresh"
+- Option 3: "Add more services to the running set"
+
+Prune any dead PIDs silently (the process crashed on its own — no point asking about it).
+
+## Workflow
+
+### Step 1: What Are You Testing?
+
+Before discovering services, understand the shape of the testing so you can scope correctly. Use `AskQuestion`:
+
+> "What are you testing locally?"
+
+- Option 1: "A frontend feature — I need the UI and its backend dependencies running"
+- Option 2: "A backend API — I just need the API server running"
+- Option 3: "The full stack — everything needs to be up"
+
+This scopes the rest of the workflow. If the user is testing a backend API, they probably don't need a frontend dev server. If they're testing a frontend feature, they need the frontend plus whatever backends it talks to. Keep this answer in mind when presenting service candidates in Step 3 — pre-check the ones that match and leave the rest unchecked.
+
+### Step 2: Viability Check
+
+Some services can't run on a developer's machine by design — they need production secrets, HSMs, specific certificates, or cloud-only infrastructure. Don't waste time trying to discover or start them.
+
+**If the user already volunteered this information** in their initial message (e.g., "the payment-gateway can't run locally"), acknowledge it and skip the question — don't re-ask what they already answered.
+
+Otherwise, use `AskQuestion`:
+
+> "Are there any services in your stack that **can't** run locally? (e.g., needs production secrets, specific certificates, or cloud-only infra)"
+
+- Option 1: "All my services can run locally"
+- Option 2: "Some can't — I'll tell you which"
+
+If the user picks option 2, collect the names. Acknowledge them and exclude from discovery.
+
+If an excluded service is a hard dependency for the app under test, **suggest testing in a preview/staging environment instead** — the user can merge first and use `/muggle-test` in remote mode, where everything is already up and running. Frame it as an alternative, not a dead end:
+
+> "Since **payment-gateway** can't run locally, you might get better coverage by merging and running `/muggle-test` against your preview environment — everything's wired up there. Want to continue with a partial local setup, or switch to remote testing?"
+
+- Option 1: "Continue locally — I'll work around the missing service"
+- Option 2: "Switch to remote — I'll merge and test on preview"
+
+If the user chooses remote, hand off to `/muggle-test` in remote mode and exit this skill.
+
+### Step 3: Identify Required Services & How to Start Them
+
+Figure out which services need to be running. Start by listing folder names in the **parent directory** of the current working directory — these are the most likely candidates.
+
+```bash
+ls -d "$(dirname "$PWD")"/*/ | xargs -I{} basename {}
+```
+
+Present folder names only (not contents) as candidates. Use `AskQuestion` with `multiSelect: true`:
+
+> "Which of these need to be running for your tests?"
+
+List each folder name as an option. Pre-check the ones that match the testing scope from Step 1 (e.g., if testing a frontend feature, pre-check the frontend and likely backends). Always include these fixed tail options:
+- "Just the current project (no other services needed)"
+- "None of these — I'll tell you what I need"
+
+If the user provides manual paths, verify they exist before continuing. If a path doesn't exist, report it and ask for correction.
+
+**Include the current working directory as a candidate** — the user might be editing the backend but also need the frontend (a sibling) started, or vice versa.
+
+**Immediately after the user selects services**, ask how they want to handle startup. This avoids making someone who prefers their own scripts wait through command detection before they get to say "I'll handle it."
+
+Use `AskQuestion`:
+
+> "How do you want to handle these?"
+
+- Option 1: "Check what's running, start what's missing for me"
+- Option 2: "I'll start them myself — just verify they're up when I'm done"
+
+If the user picks **option 2**: skip Steps 4-6. Wait for them to confirm they're ready, then go straight to Step 4 (Check What's Already Running) to verify everything is listening, and report readiness (Step 7).
+
+If the user picks **option 1**: proceed through Steps 4-7 as normal.
+
+### Step 4: Check What's Already Running
+
+Before offering to start anything, check what's already listening on common dev ports:
+
+```bash
+lsof -iTCP -sTCP:LISTEN -nP 2>/dev/null | grep -E ':(3000|3001|3002|4200|5173|5174|8080|8081|8000|8888|4000|9000)'
+```
+
+Cross-reference against the selected service directories. If a selected service appears to already be running (match by port or by the process's working directory), report it as ready:
+
+> "**backend-api** is already listening on port 3001 (PID 54321) — looks good."
+
+If **all** required services are already running, report readiness and skip straight to Step 7. No need to go through Steps 5-6.
+
+If some are running and some aren't, acknowledge the running ones and continue to Step 5 only for the missing services. Use `AskQuestion` for any already-running service the user might want restarted:
+- Option 1: "It's fine, keep it"
+- Option 2: "Restart it"
+
+For services that are already running and the user wants to keep, add them to the PID tracking file so cleanup can find them later, but mark them as `external: true` so cleanup knows not to kill them (the user started them independently).
+
+### Step 5: Determine Start Commands
+
+For each required service that isn't already running, figure out how to start it. Propose the command so there's a shared understanding.
+
+Read **only** the indicator file that exists — don't read additional files.
+
+**Detection order:**
+
+| Indicator | Stack | Default command | What to check |
+|:----------|:------|:----------------|:--------------|
+| `package.json` | Node.js | `npm run dev` | Read `scripts` field: prefer `dev` > `start` > `serve` |
+| `Makefile` | Various | `make dev` | Just check existence; propose `make dev` or `make run` |
+| `Cargo.toml` | Rust | `cargo run` | Just check existence |
+| `go.mod` | Go | `go run .` | Just check existence |
+| `pyproject.toml` | Python | Check for framework | Read `[project.scripts]` or `[tool.poetry.scripts]` if present |
+| `requirements.txt` | Python | `python app.py` | Just check existence |
+| `docker-compose.yml` | Docker | `docker compose up` | Just check existence |
+
+If no indicator file is found, tell the user and ask them to provide the start command manually.
+
+**Present all proposed commands in a single summary:**
+
+```
+Service              Directory                          Command
+────────────────────────────────────────────────────────────────
+backend-api          ~/Github/backend-api               npm run dev
+auth-service         ~/Github/auth-service              go run .
+frontend             ~/Github/frontend                  npm run dev
+────────────────────────────────────────────────────────────────
+```
+
+Use `AskQuestion`:
+- Option 1: "Looks good, start them"
+- Option 2: "I need to edit some commands"
+
+If the user needs edits, collect corrections and re-present.
+
+### Step 6: Start Services
+
+For each service, launch in the background:
+
+```bash
+cd "<service-dir>" && nohup <command> > /tmp/muggle-prepare-<service-name>.log 2>&1 &
+echo $!
+```
+
+Capture the PID. Write all service entries to `/tmp/muggle-test-prepare.json`.
+
+**Startup verification** — after a short pause (~3-5 seconds per service), check:
+
+1. PID is alive: `kill -0 <pid> 2>/dev/null`
+2. Port is listening (if known): `lsof -iTCP:<port> -sTCP:LISTEN -nP 2>/dev/null`
+
+If a service's PID dies immediately, read the last 20 lines of its log and show the user:
+
+> "**backend-api** exited right after starting. Here's the tail of its log:"
+
+Then ask how to proceed:
+- Option 1: "Skip it and continue with the others"
+- Option 2: "Let me fix it — I'll re-invoke later"
+
+**Port discovery** — if the port isn't known upfront, after the service starts, re-scan listening ports and try to identify which new port appeared. Record it in the tracking file if found. If not found within ~10 seconds, note the port as unknown — the service may take longer to boot.
+
+### Step 7: Report Readiness
+
+Whether you started the services or the user did, confirm that everything is listening:
+
+```
+Service              PID      Port     Status
+──────────────────────────────────────────────
+backend-api          12345    3001     Running
+auth-service         12346    8080     Running
+frontend             12347    3000     Running
+──────────────────────────────────────────────
+All 3 services verified. Ready for E2E testing.
+```
+
+If you launched the services, also show:
+```
+Logs: /tmp/muggle-prepare-*.log
+Cleanup: say "stop services" or re-invoke this skill.
+```
+
+## Cleanup
+
+Cleanup is triggered when:
+- The user says "stop services", "tear down", "clean up", or "I'm done testing"
+- Another skill signals that a test run is complete
+- This skill is re-invoked and the user chooses "tear down and start fresh"
+
+**Cleanup steps:**
+
+1. Read `/tmp/muggle-test-prepare.json`
+2. Skip any services marked `external: true` (the user started them independently)
+3. For each managed service, send `SIGTERM`: `kill <pid>`
+4. Wait ~2 seconds, verify with `kill -0`
+5. If still alive, `kill -9 <pid>`
+6. Remove log files: `rm -f /tmp/muggle-prepare-*.log`
+7. Remove the tracking file: `rm -f /tmp/muggle-test-prepare.json`
+
+Report:
+
+```
+Stopped 3 services:
+  backend-api    (PID 12345)
+  auth-service   (PID 12346)
+  frontend       (PID 12347)
+```
+
+## Integration Contract (for other skills)
+
+When `muggle-test`, `muggle-do`, or `muggle-test-feature-local` want to check if services are ready:
+
+1. Check if `/tmp/muggle-test-prepare.json` exists
+2. Verify PIDs are alive with `kill -0`
+3. If all live → services are ready, proceed to test execution
+4. If missing or stale → invoke `muggle-test-prepare`
+
+After a test run completes, the calling skill can invoke cleanup by re-invoking this skill with cleanup intent, or leave services running for the next run (the user chose lifecycle management, not clean-state resets).
+
+## Guardrails
+
+- **Verify first, offer to start second** — always check what's already running before proposing to start anything. If everything is up, just confirm readiness and move on.
+- **The user may prefer to start services themselves** — always offer that option. Some developers have their own startup scripts, tmux layouts, or docker-compose setups they'd rather use.
+- **Never start a process the user didn't approve** — every command is presented and confirmed before execution.
+- **Never read file contents outside confirmed directories** — folder names are discoverable; file contents require explicit user selection.
+- **Never leave orphan processes untracked** — every background PID goes into the tracking file.
+- **Never kill a process the user started independently** — services marked `external: true` survive cleanup.
+- **Never assume start commands** — always verify by checking project indicator files; always confirm with the user.
+- **Bail early on non-viable services** — don't attempt to start something the user said can't run locally.
+- **Idempotent** — if services are already tracked and alive, offer to keep them rather than double-starting.

package/plugin/skills/muggle-test-regenerate-missing/SKILL.md

@@ -9,6 +9,24 @@ A bulk maintenance skill for Muggle AI projects. It finds every test case in a p
 
 Execution is **remote only** — Muggle's cloud generates the scripts in parallel against the project URL. The user's machine is not involved beyond making API calls.
 
+## Preferences
+
+User preferences are available in the session context (injected at session start). Look for the line starting with `Muggle Preferences` — it contains key=value pairs like `autoLogin=ask showElectronBrowser=always ...`.
+
+If no preferences line is present, treat all preferences as `"ask"`.
+
+When you reach a decision gated by a preference:
+- **`always`** → proceed without asking the user
+- **`never`** → skip without asking the user  
+- **`ask`** → ask the user, then offer: "Want me to remember this choice for future sessions?" If yes, call `muggle-local-preferences-set` with the key, their chosen value, and scope `global`.
+
+This skill uses these preferences:
+
+| Preference | Decision it gates |
+|------------|------------------|
+| `autoLogin` | Reuse saved credentials when auth is required |
+| `autoSelectProject` | Reuse last-used Muggle project for this repo |
+
 ## Concept: what counts as "no active script"
 
 In the Muggle data model, a test case carries a status that reflects whether it has a usable script attached:

package/dist/src-ZRUONWKV.js

@@ -1 +0,0 @@
-export { buildElectronAppChecksumsUrl, buildElectronAppReleaseAssetUrl, buildElectronAppReleaseTag, calculateFileChecksum, createApiKeyWithToken, createChildLogger, deleteApiKeyData, deleteCredentials, e2e_exports as e2e, getApiKey, getApiKeyFilePath, getAuthService, getBundledElectronAppVersion, getCallerCredentials, getCallerCredentialsAsync, getChecksumForPlatform, getConfig, getCredentialsFilePath, getDataDir, getDownloadBaseUrl, getElectronAppChecksums, getElectronAppDir, getElectronAppVersion, getElectronAppVersionSource, getLocalQaTools, getLogger, getPlatformKey, getQaTools, getValidApiKeyData, getValidCredentials, hasApiKey, isElectronAppInstalled, loadApiKeyData, loadCredentials, local_exports as localQa, mcp_exports as mcp, openBrowserUrl, performLogin, performLogout, pollDeviceCode, e2e_exports as qa, resetConfig, resetLogger, saveApiKey, saveApiKeyData, saveCredentials, startDeviceCodeFlow, toolRequiresAuth, verifyFileChecksum } from './chunk-44I5ROCB.js';