mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-23 03:42:59 -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 -->
157 lines
5.1 KiB
Go
157 lines
5.1 KiB
Go
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/onyx-dot-app/onyx/tools/ods/internal/devstack"
|
|
"github.com/onyx-dot-app/onyx/tools/ods/internal/docker"
|
|
"github.com/onyx-dot-app/onyx/tools/ods/internal/paths"
|
|
)
|
|
|
|
const (
|
|
legacyEndpointVar = "S3_LEGACY_ENDPOINT_URL"
|
|
minioContainerPort = 9000
|
|
)
|
|
|
|
// minioEnv starts MinIO although the dev stack keeps it at zero replicas, on
|
|
// a free host port because a compose .env from an earlier ods may pin it to
|
|
// the object store's port.
|
|
var minioEnv = []string{"MINIO_REPLICAS=1", "MINIO_API_HOST_PORT=0"}
|
|
|
|
// NewObjectStoreCommand creates the parent "object-store" command.
|
|
func NewObjectStoreCommand() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "object-store",
|
|
Short: "Manage the dev object store (SeaweedFS)",
|
|
}
|
|
cmd.AddCommand(newObjectStoreMigrateCommand())
|
|
return cmd
|
|
}
|
|
|
|
func newObjectStoreMigrateCommand() *cobra.Command {
|
|
var keepMinio bool
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "migrate",
|
|
Short: "Copy a dev MinIO's files into the object store, then stop MinIO",
|
|
Long: `Copy the files a dev MinIO holds into the object store, then stop MinIO.
|
|
|
|
The dev stack runs the object store only. A checkout that used MinIO before it
|
|
still has its files in the minio_data volume, and this command moves them
|
|
across once: it starts MinIO, retires it with the app's legacy copy (every
|
|
object is copied, since a multitenant checkout keeps its file records in
|
|
tenant schemas; a quiet minute then confirms nothing still writes to MinIO
|
|
alone, and the retired marker stops running backend processes from using it),
|
|
drops S3_LEGACY_ENDPOINT_URL from .vscode/.env so the app never writes to both
|
|
stores, and stops MinIO. The infra stack must be running. A failed copy leaves
|
|
MinIO running and .vscode/.env untouched, so fix the cause and rerun.
|
|
|
|
Examples:
|
|
ods object-store migrate
|
|
ods object-store migrate --keep-minio`,
|
|
Args: cobra.NoArgs,
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
if err := runObjectStoreMigrate(keepMinio); err != nil {
|
|
exitBackendService(err)
|
|
}
|
|
},
|
|
}
|
|
|
|
cmd.Flags().BoolVar(&keepMinio, "keep-minio", false, "Leave MinIO running afterwards")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runObjectStoreMigrate(keepMinio bool) error {
|
|
target, err := resolveRuntimeTarget()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
release, err := lockRuntimeTarget(target, true)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer release()
|
|
root, err := paths.GitRoot()
|
|
if err != nil {
|
|
return fatalErrorf("Failed to find git root: %v", err)
|
|
}
|
|
proj := target.Project
|
|
databasePort, err := runningPort(proj, docker.RelationalDB)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
objectStorePort, err := runningPort(proj, docker.ObjectStore)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info("Starting MinIO...")
|
|
if err := execDockerCompose(append(baseArgs("dev", proj), "up", "-d", "--wait", "minio"), minioEnv); err != nil {
|
|
return err
|
|
}
|
|
minioPort, err := docker.GetHostPort(docker.ContainerName(proj, "minio"), minioContainerPort)
|
|
if err != nil {
|
|
return fatalErrorf("MinIO started but publishes no port: %v", err)
|
|
}
|
|
|
|
if _, _, err := devstack.PrepareEnvFiles(root); err != nil {
|
|
return err
|
|
}
|
|
envFile := filepath.Join(root, ".vscode", ".env")
|
|
fileVars, err := devstack.LoadEnvFile(envFile)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
objectStore := docker.ObjectStore.Ports[0]
|
|
overrides := []string{
|
|
fmt.Sprintf("%s=http://localhost:%d", legacyEndpointVar, minioPort),
|
|
"LEGACY_COPY_ALL_OBJECTS=true",
|
|
}
|
|
env := devstack.MergeEnv(devstack.HostServiceEnv(map[string]int{
|
|
"POSTGRES_HOST_PORT": databasePort,
|
|
objectStore.ComposeVar: objectStorePort,
|
|
}).With(fileVars), overrides)
|
|
|
|
log.Infof("Copying MinIO (localhost:%d) into the object store (localhost:%d) and retiring it...", minioPort, objectStorePort)
|
|
copyCmd := exec.Command("uv", "run", "python", "-m", "onyx.file_store.legacy_copy", "--retire")
|
|
copyCmd.Dir = filepath.Join(root, "backend")
|
|
copyCmd.Stdout = os.Stdout
|
|
copyCmd.Stderr = os.Stderr
|
|
copyCmd.Stdin = os.Stdin
|
|
copyCmd.Env = env
|
|
if err := copyCmd.Run(); err != nil {
|
|
return fatalErrorf("Failed to copy MinIO's files: %w", err)
|
|
}
|
|
|
|
if err := removeEnvKey(envFile, legacyEndpointVar); err != nil {
|
|
return fatalErrorf("Failed to update %s: %v", envFile, err)
|
|
}
|
|
log.Infof("MinIO's files are in the object store and %s no longer names MinIO.", envFile)
|
|
if keepMinio {
|
|
log.Infof("MinIO is still running on localhost:%d.", minioPort)
|
|
return nil
|
|
}
|
|
if err := execDockerCompose(append(baseArgs("dev", proj), "stop", "minio"), minioEnv); err != nil {
|
|
return err
|
|
}
|
|
log.Infof("MinIO is stopped; the %s_minio_data volume stays until you remove it.", proj)
|
|
return nil
|
|
}
|
|
|
|
// runningPort is the host port of a project's infra service, or an error
|
|
// naming what to start: the copy needs Postgres and the object store.
|
|
func runningPort(proj string, svc docker.ServiceSpec) (int, error) {
|
|
port, err := docker.GetHostPort(docker.ContainerName(proj, svc.Name), svc.Ports[0].ContainerPort)
|
|
if err != nil {
|
|
return 0, fatalErrorf("%s is not running (start the infra stack with \"ods compose dev --infra\"): %v", svc.Name, err)
|
|
}
|
|
return port, nil
|
|
}
|