mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-23 11:53:08 -05:00
## Description
Make ODS reuse shared development infrastructure by default, with
`--isolated` for separate datasets.
- Use the same service specifications and launchers for `stack`, `web
dev`, and `backend` commands. Remove the duplicate `stack
--frontend-only` option.
- Enforce project ownership across checkouts and resolve database
commands to the actual managed database.
- Stop services before pending migrations, preserve them when already at
head, and reject manual migrations beneath managed services.
- Harden startup cancellation, shutdown grace, descendant cleanup,
terminal input, and frontend API validation. Preserve Windows foreground
commands.
- Consolidate environment helpers, protect symlinked environment files,
propagate restore errors, and update help and documentation.
This PR contains only ODS and its development-stack skill. It does not
include the plugins implementation.
## How Has This Been Tested?
- Targeted command and regression tests using fake tools and disposable
Git repositories.
- Race tests for runtime targeting, ownership, migration ordering,
process cleanup, and terminal input.
- `go vet ./...`, pre-commit checks, native builds, and Windows
cross-builds.
- The full Go suite was run. Its remaining failures are the existing
macOS devcontainer SSH-mount fixture expectations in
`TestDevcontainerCommands` and `TestRunDevRebuild`.
No real database migrations, restores, or development-stack restarts
ran. Native Windows execution remains untested.
## Additional Options
- [ ] [Optional] Please cherry-pick this PR to the latest release
version.
- [x] [Optional] Override Linear Check
<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
ODS now shares development infrastructure across worktrees by default,
with `--isolated` for separate datasets. `stack`, `web dev`, and
`backend` use the same service specs and launchers, and the duplicate
`stack --frontend-only` option is removed.
- Direct launches run the same dependency-prepare step as stack startup,
so `backend` and `web dev` work with fresh or stale Python environments.
- A stopped preview discards its former project state before retargeting
to another API owner.
- Enforces project ownership across checkouts and resolves database
commands to the managed database. New tests reject conflicting targets
before any mutation.
- Stops services before pending migrations, preserves them when already
at head, and rejects manual migrations beneath managed services.
Migration probe failures fail closed.
- Hardens startup cancellation, shutdown grace, and descendant cleanup;
ODS keeps the terminal foreground group so Ctrl-C still honors shutdown
timeouts, and tmux pane identifiers no longer change service identity.
- Database passwords reach tools through the child environment only,
never in process arguments; Windows foreground commands are preserved.
- Consolidates environment helpers, protects symlinked env files,
propagates restore errors, and refreshes help and documentation. Test
commits exercise the new migration-target and preview-launch paths.
<sup>Written for commit 14500cb051.
Summary will update on new commits.</sup>
<a
href="https://cubic.dev/pr/onyx-dot-app/onyx/pull/16246?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="View guided diff"
src="https://www.cubic.dev/buttons/review-in-cubic-light.svg"></picture></a>
<a
href="https://www.cubic.dev/action/auto-fix/pr/onyx-dot-app/onyx/16246?returnTo=https%3A%2F%2Fgithub.com%2Fonyx-dot-app%2Fonyx%2Fpull%2F16246&source=description"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"><img
alt="Turn on auto-fix"
src="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"></picture></a>
<!-- End of auto-generated description by cubic. -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added the global `--isolated` option for separate development stacks;
shared infrastructure is the default, with clearer project ownership and
status information.
* Added `ods web dev` previews that can use a healthy managed API on
macOS and Linux, plus foreground startup on Windows.
* Expanded command guidance for development workflows, database
targeting, and dump formats.
* **Bug Fixes**
* Pending migrations now stop managed application services first;
healthy services remain running when no migrations are needed.
* Database operations verify project ownership and target selection
before making changes. Restore errors now fail the command, SQL restores
stop on errors, and temporary files are cleaned up after failures.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
120 lines
4.5 KiB
Go
120 lines
4.5 KiB
Go
//go:build !windows
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/onyx-dot-app/onyx/tools/ods/internal/devstack"
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// runStackCommandExit runs "ods stack <args>" and returns stdout, stderr
|
|
// (including the log) and the exit code a log.Fatal or os.Exit would use.
|
|
func runStackCommandExit(t *testing.T, args ...string) (stdout, stderr string, code int) {
|
|
t.Helper()
|
|
logger := log.StandardLogger()
|
|
var logBuf bytes.Buffer
|
|
originalOut, originalExit := logger.Out, logger.ExitFunc
|
|
logger.SetOutput(&logBuf)
|
|
t.Cleanup(func() { logger.SetOutput(originalOut); logger.ExitFunc = originalExit })
|
|
type exitCode int
|
|
logger.ExitFunc = func(c int) { panic(exitCode(c)) }
|
|
|
|
cmd := NewRootCommand()
|
|
cmd.SetArgs(append([]string{"stack"}, args...))
|
|
stderr = composeCapture(t, &os.Stderr, func() {
|
|
stdout = composeCapture(t, &os.Stdout, func() {
|
|
defer func() {
|
|
if got := recover(); got != nil {
|
|
c, ok := got.(exitCode)
|
|
if !ok {
|
|
panic(got)
|
|
}
|
|
code = int(c)
|
|
}
|
|
}()
|
|
if err := cmd.Execute(); err != nil {
|
|
t.Error(err)
|
|
}
|
|
})
|
|
})
|
|
return stdout, stderr + logBuf.String(), code
|
|
}
|
|
|
|
func stackFailureRepo(t *testing.T, python, launch string) string {
|
|
t.Helper()
|
|
root, _ := stackTestRepo(t)
|
|
python = strings.Replace(python, "#!/bin/sh\n", "#!/bin/sh\nif [ \"$1\" = -c ]; then exit 10; fi\n", 1)
|
|
writeFile(t, filepath.Join(root, ".venv", "bin", "python"), python)
|
|
if err := os.Chmod(filepath.Join(root, ".venv", "bin", "python"), 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
writeFile(t, filepath.Join(root, ".vscode", "launch.json"), launch)
|
|
stack, _ := openStack(nil)
|
|
t.Cleanup(func() {
|
|
if err := stack.Stop(context.Background(), devstack.Options{StopTimeout: time.Second, LockWait: time.Second}); err != nil {
|
|
t.Errorf("fixture cleanup: %v", err)
|
|
}
|
|
})
|
|
return root
|
|
}
|
|
|
|
const workerOnlyLaunch = `{
|
|
"compounds": [{"name": "Run All Onyx Services", "configurations": ["Celery primary"]}],
|
|
"configurations": [
|
|
{"name": "Celery primary", "type": "debugpy", "request": "launch", "program": "${workspaceFolder}/backend/scripts/dev_celery_reload.py", "cwd": "${workspaceFolder}/backend", "args": ["-A", "primary"]}
|
|
]
|
|
}`
|
|
|
|
func TestStackUp_reportsMigrationFailure(t *testing.T) {
|
|
root := stackFailureRepo(t, "#!/bin/sh\nexec /bin/sleep 300\n", workerOnlyLaunch)
|
|
writeFile(t, filepath.Join(root, ".venv", "bin", "alembic"), "#!/bin/sh\necho 'INFO [alembic.runtime.migration] Running upgrade abc -> def'\necho 'sqlalchemy.exc.ProgrammingError: relation \"user\" already exists' >&2\nexit 1\n")
|
|
stdout, stderr, code := runStackCommandExit(t, "up", "--profile", "full", "--skip-prepare", "--timeout", "10s", "--json")
|
|
t.Logf("exit=%d\nstdout:\n%s\nstderr:\n%s", code, stdout, stderr)
|
|
if code == 0 {
|
|
t.Fatal("migration failure exited 0")
|
|
}
|
|
if !strings.Contains(stdout, `"phase": "failed"`) {
|
|
t.Errorf("stdout has no failed status JSON")
|
|
}
|
|
if !strings.Contains(stdout, "already exists") {
|
|
t.Errorf("status JSON does not carry the alembic error")
|
|
}
|
|
}
|
|
|
|
func TestStackUp_reportsServiceExit(t *testing.T) {
|
|
stackFailureRepo(t, "#!/bin/sh\necho 'ModuleNotFoundError: No module named celery' >&2\nexit 3\n", workerOnlyLaunch)
|
|
stdout, stderr, code := runStackCommandExit(t, "up", "--profile", "full", "--skip-prepare", "--timeout", "10s", "--json")
|
|
t.Logf("exit=%d\nstdout:\n%s\nstderr:\n%s", code, stdout, stderr)
|
|
if code == 0 {
|
|
t.Fatal("service exit exited 0")
|
|
}
|
|
if !strings.Contains(stdout, `"state": "exited"`) || !strings.Contains(stdout, "ModuleNotFoundError") {
|
|
t.Errorf("status JSON does not show the exited service with its log tail")
|
|
}
|
|
}
|
|
|
|
func TestStackUp_reportsUnhealthyService(t *testing.T) {
|
|
stackFailureRepo(t, "#!/bin/sh\necho 'listening but never healthy'\nexec /bin/sleep 300\n", `{
|
|
"compounds": [{"name": "Run All Onyx Services", "configurations": ["API Server"]}],
|
|
"configurations": [
|
|
{"name": "API Server", "type": "debugpy", "request": "launch", "module": "uvicorn", "cwd": "${workspaceFolder}/backend", "args": ["onyx.main:app", "--port", "8080"]}
|
|
]
|
|
}`)
|
|
stdout, stderr, code := runStackCommandExit(t, "up", "--profile", "minimal", "--skip-prepare", "--timeout", "3s", "--json")
|
|
t.Logf("exit=%d\nstdout:\n%s\nstderr:\n%s", code, stdout, stderr)
|
|
if code != 2 {
|
|
t.Errorf("not-ready exit = %d, want 2", code)
|
|
}
|
|
if !strings.Contains(stdout, `"healthy": false`) || !strings.Contains(stdout, "never healthy") {
|
|
t.Errorf("status JSON does not show the unhealthy service with its log tail")
|
|
}
|
|
}
|