Files
onyx/tools/ods/internal/devstack/frontend.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

105 lines
2.8 KiB
Go

package devstack
import (
"context"
"fmt"
"time"
)
func (s *Stack) lockFrontendService(ctx context.Context, target Target, wait time.Duration) (func(), error) {
source := &Stack{Root: target.Root, Project: target.Project, StateDir: target.StateDir, Mode: target.Mode}
releaseSource, err := source.Lock(ctx, "frontend API lookup", wait)
if err != nil {
return nil, err
}
fail := func(err error) (func(), error) { releaseSource(); return nil, err }
st, err := source.ReadState()
if err != nil {
return fail(err)
}
if st == nil || st.Project != target.Project {
return fail(fmt.Errorf("no managed API for project %s; run 'ods stack up' or 'ods backend api' first", target.Project))
}
local, err := Open(s.Root, "", Isolated)
if err != nil {
return fail(err)
}
releaseLocal := func() {}
if local.StateDir != source.StateDir {
releaseLocal, err = local.Lock(ctx, "frontend checkout lookup", wait)
if err != nil {
return fail(err)
}
}
release := func() { releaseLocal(); releaseSource() }
localState, err := local.ReadState()
if err != nil {
release()
return nil, err
}
for _, candidate := range []*State{st, localState} {
if candidate == nil || candidate.Root != s.Root {
continue
}
for _, rec := range candidate.Services {
if rec.Slug == "web" && isCurrent(rec) {
release()
return nil, fmt.Errorf("a frontend already runs in this checkout at http://localhost:%d; reuse it", rec.Port)
}
}
}
for _, rec := range st.Services {
if rec.Slug == "api" && rec.Port > 0 && isCurrent(rec) && rec.Health != "" && healthy(ctx, rec.Health) {
target.Ports["api"] = rec.Port
return release, nil
}
}
release()
return nil, fmt.Errorf("no healthy managed API in %s; run 'ods stack up' or 'ods backend api' there first", st.Root)
}
func (s *Stack) lockFrontendCheckout(ctx context.Context, wait time.Duration) (func(), error) {
local, err := Open(s.Root, "", Isolated)
if err != nil {
return nil, err
}
if local.StateDir == s.StateDir {
return func() {}, nil
}
return local.Lock(ctx, "full stack handoff", wait)
}
func (s *Stack) stopFrontendPreview(ctx context.Context, opts Options) (int, error) {
preview, err := Open(s.Root, "", Frontend)
if err != nil {
return 0, err
}
release, err := preview.Lock(ctx, "full stack handoff", opts.LockWait)
if err != nil {
return 0, err
}
defer release()
st, err := preview.ReadState()
if err != nil || st == nil {
return 0, err
}
if st.Root != s.Root {
return 0, preview.ownerError(st)
}
port := 0
for _, rec := range st.Services {
if rec.Slug == "web" && isCurrent(rec) {
port = rec.Port
}
}
if err := preview.stopServices(opts.StopTimeout); err != nil {
return 0, err
}
if s.Registry != nil {
if err := s.Registry.Release(preview.StateDir); err != nil {
return 0, err
}
}
return port, nil
}