Files
onyx/tools/ods/internal/devstack/service.go
roshan a8033533d1 refactor(ods): unify launchers and protect shared infrastructure (#16246)
## 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 -->
2026-10-19 20:07:02 +00:00

118 lines
3.6 KiB
Go

package devstack
import (
"crypto/sha256"
"encoding/hex"
"sort"
"strings"
"time"
)
// Spec describes one application service to run.
type Spec struct {
// Name is the launch configuration name, such as "API Server".
Name string `json:"name"`
// Slug is the short CLI name, such as "api".
Slug string `json:"slug"`
// Command is the program and its arguments.
Command []string `json:"command"`
// Dir is the working directory.
Dir string `json:"dir"`
// Env is the full environment, KEY=VALUE.
Env []string `json:"-"`
// Port is the host port the service listens on, 0 when it has none.
Port int `json:"port,omitempty"`
// Health is a URL that answers 200 once the service is ready.
Health string `json:"health,omitempty"`
// Optional services may exit without making the stack unready.
Optional bool `json:"optional,omitempty"`
// FixedPort is a port the service binds that is not leased, such as
// the Slack bot's metrics port. The service is skipped when something
// other than this stack holds it.
FixedPort int `json:"fixed_port,omitempty"`
// Skip, when set, is the reason the service is not started.
Skip string `json:"skip,omitempty"`
}
// Hash identifies the spec so a reconcile can tell whether a running service
// still matches the plan. Secrets in Env never leave the hash.
func (sp Spec) Hash() string {
h := sha256.New()
write := func(parts ...string) {
for _, p := range parts {
h.Write([]byte(p))
h.Write([]byte{0})
}
}
write(sp.Name, sp.Slug, sp.Dir, sp.Health)
write(sp.Command...)
env := append([]string(nil), sp.Env...)
sort.Strings(env)
for _, entry := range env {
key, _, _ := strings.Cut(entry, "=")
if transientEnvironment(key) {
continue
}
write(entry)
}
return hex.EncodeToString(h.Sum(nil))[:16]
}
func transientEnvironment(key string) bool {
switch key {
case "PWD", "OLDPWD", "SHLVL", "_", "TERM", "TERM_PROGRAM", "TERM_PROGRAM_VERSION", "TERM_SESSION_ID", "SESSION_ID", "TMUX_PANE":
return true
}
for _, prefix := range []string{"CODEX_", "CLAUDE_", "OMX_", "SC_", "SUPERCONDUCTOR_", "VSCODE_", "SSH_"} {
if strings.HasPrefix(key, prefix) {
return true
}
}
return false
}
// ServiceRecord is a started (or skipped) service as persisted in State.
type ServiceRecord struct {
Name string `json:"name"`
Slug string `json:"slug"`
Command []string `json:"command"`
Dir string `json:"dir"`
SpecHash string `json:"spec_hash"`
Port int `json:"port,omitempty"`
Health string `json:"health,omitempty"`
Optional bool `json:"optional,omitempty"`
Skipped string `json:"skipped,omitempty"`
PID int `json:"pid,omitempty"`
PGID int `json:"pgid,omitempty"`
StartMarker string `json:"start_marker,omitempty"`
Members map[int]string `json:"members,omitempty"`
StartedAt time.Time `json:"started_at"`
Log string `json:"log,omitempty"`
}
// Slugify turns a launch configuration name into a CLI service name.
func Slugify(name string) string {
if slug, ok := knownSlugs[name]; ok {
return slug
}
var b strings.Builder
for _, r := range strings.ToLower(name) {
switch {
case r >= 'a' && r <= 'z', r >= '0' && r <= '9', r == '_', r == '-':
b.WriteRune(r)
case r == ' ':
b.WriteRune('-')
}
}
return strings.Trim(b.String(), "-")
}
var knownSlugs = map[string]string{
"Web Server": "web",
"API Server": "api",
"MCP Server": "mcp",
"Model Server": "model",
"Slack Bot": "slack-bot",
"Discord Bot": "discord-bot",
}