Files
goclaw/internal/http/tenant_restore_handler.go
f5917b0e46 fix(backup): harden tenant restore preview and lookup handling (#920)
* fix(backup): harden tenant restore preview and lookup handling

* test(pg): fix hook test migration path

* test(ci): stabilize race coverage tests

* fix(hooks): scope GetByID and allow loopback tests

* fix(backup): harden tenant restore replace/new contracts + race-safe SSRF flag

- Replace mode no longer deletes the tenants row (FK safe vs excluded
  diagnostic tables: traces, activity_logs, usage_snapshots, spans,
  embedding_cache, pairing_requests, paired_devices,
  channel_pending_messages, cron_run_logs). Metadata is preserved in place.
- shouldRestoreTable now excludes tenants for both new and replace modes.
- CLI: add validateTenantRestoreFlags guardrail. mode=new requires
  --new-tenant-slug and rejects --tenant/--tenant-id; upsert/replace warn
  on stray --new-tenant-slug; invalid --mode values rejected. TAB in help
  text fixed; flag descriptions clarified.
- HTTP: resolveRestoreTarget rejects tenant_id for mode=new regardless
  of tenant_slug (matches CLI contract). New i18n key
  MsgRestoreNewModeRejectsTenantID (en/vi/zh).
- security/ssrf: allowLoopbackForTest switched to atomic.Bool so
  concurrent reads from outbound dialers are race-safe.
- Polish: vi backup.json key order matches en/zh; TenantRestoreOptions.Mode
  doc comment documents upsert/replace/new semantics including clone
  behavior for new.
- Tests: unit coverage for validator (12 cases), HTTP guardrails
  (3 cases), shouldRestoreTable replace branch. Integration test
  tests/integration/tenant_restore_replace_test.go regression-guards
  the FK fix using activity_logs seed + DeleteTenantDataForTest helper.

---------

Co-authored-by: Viet Tran <viettranx@gmail.com>
2026-04-16 15:49:50 +07:00

119 lines
3.7 KiB
Go

package http
import (
"log/slog"
"net/http"
"os"
"github.com/nextlevelbuilder/goclaw/internal/backup"
"github.com/nextlevelbuilder/goclaw/internal/config"
"github.com/nextlevelbuilder/goclaw/internal/i18n"
"github.com/nextlevelbuilder/goclaw/internal/store"
"github.com/nextlevelbuilder/goclaw/pkg/protocol"
)
// handleRestore accepts a multipart tar.gz upload and restores a tenant via SSE.
// Query params:
// - mode (upsert|replace|new): restore strategy. Default "upsert".
// - dry_run (true|1): inspect archive without applying changes.
// - tenant_id | tenant_slug: target tenant for mode=upsert|replace.
// - tenant_slug (required for mode=new): slug for the new tenant to create.
// tenant_id is rejected for mode=new — the new tenant's UUID is generated
// server-side; the archived tenant metadata (name/status/settings) is used
// and bound to the provided slug.
// Only system owners may restore (cross-tenant operation).
func (h *TenantBackupHandler) handleRestore(w http.ResponseWriter, r *http.Request) {
userID := store.UserIDFromContext(r.Context())
locale := extractLocale(r)
if !h.isOwnerUser(userID) {
slog.Warn("security.tenant_restore_owner_denied", "user_id", userID)
writeError(w, http.StatusForbidden, protocol.ErrUnauthorized,
i18n.T(locale, i18n.MsgNoAccess, "tenant restore"))
return
}
q := r.URL.Query()
mode := q.Get("mode")
if mode == "" {
mode = "upsert"
}
dryRun := q.Get("dry_run") == "true" || q.Get("dry_run") == "1"
tenantID, tenantSlug, ok := h.resolveRestoreTarget(w, r, mode)
if !ok {
return
}
r.Body = http.MaxBytesReader(w, r.Body, maxRestoreSize)
if err := r.ParseMultipartForm(32 << 20); err != nil {
writeError(w, http.StatusBadRequest, protocol.ErrInvalidRequest,
i18n.T(locale, i18n.MsgFileTooLarge))
return
}
file, _, err := r.FormFile("archive")
if err != nil {
writeError(w, http.StatusBadRequest, protocol.ErrInvalidRequest,
i18n.T(locale, i18n.MsgMissingFileField))
return
}
defer file.Close()
tmp, err := os.CreateTemp("", "goclaw-tenant-restore-*.tar.gz")
if err != nil {
writeError(w, http.StatusInternalServerError, protocol.ErrInternal,
i18n.T(locale, i18n.MsgInternalError))
return
}
tmpPath := tmp.Name()
defer os.Remove(tmpPath)
written, copyErr := copyWithLimit(tmp, file, maxRestoreSize)
tmp.Close()
if copyErr != nil || written == 0 {
writeError(w, http.StatusBadRequest, protocol.ErrInvalidRequest,
i18n.T(locale, i18n.MsgFileTooLarge))
return
}
flusher := initSSE(w)
if flusher == nil {
writeError(w, http.StatusInternalServerError, protocol.ErrInternal, "streaming not supported")
return
}
dataDir := config.TenantDataDir(h.cfg.ResolvedDataDir(), tenantID, tenantSlug)
wsDir := config.TenantWorkspace(h.cfg.WorkspacePath(), tenantID, tenantSlug)
opts := backup.TenantRestoreOptions{
DB: h.db,
ArchivePath: tmpPath,
TenantID: tenantID,
TenantSlug: tenantSlug,
DataDir: dataDir,
WorkspacePath: wsDir,
Mode: mode,
Force: true, // authenticated as owner above
DryRun: dryRun,
ProgressFn: func(phase, detail string) {
sendSSE(w, flusher, "progress", ProgressEvent{Phase: phase, Status: "running", Detail: detail})
},
}
result, runErr := backup.TenantRestore(r.Context(), opts)
if runErr != nil {
slog.Error("tenant.restore.sse", "error", runErr, "user", userID)
sendSSE(w, flusher, "error", ProgressEvent{Phase: "restore", Status: "error", Detail: runErr.Error()})
return
}
sendSSE(w, flusher, "complete", map[string]any{
"tenant_id": result.TenantID,
"tables_restored": result.TablesRestored,
"files_extracted": result.FilesExtracted,
"warnings": result.Warnings,
"dry_run": dryRun,
})
}