Repository navigation
Expand file tree
/
Copy pathlifecycle.ts
More file actions
716 lines (670 loc) · 26.5 KB
/
Copy pathlifecycle.ts
File metadata and controls
716 lines (670 loc) · 26.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
import { spawnSync } from 'node:child_process'
import { existsSync, readFileSync } from 'node:fs'
import path from 'node:path'
import { ensureProductionComposeFile } from './compose-asset'
import {
choosePostgresPassword,
composeFileRequiresPostgresPassword,
postgresUser,
reportPostgresPasswordChoice,
} from './compose-database'
import { legacyComposeProjectName } from './compose-project'
import { directoryOverride, resolveSetupContextAtRoot, SETUP_CONTEXT } from './context'
import { DB_CONTAINER, type Detection, REDIS_CONTAINER, runDetection } from './detect'
import { archiveEnvFile, archiveFile, parseEnv, ROOT, upsertEnv, writeEnvFile } from './env-files'
import { SetupError } from './errors'
import { forwardCommands, isLocalKubeContext } from './modes/k8s'
import { httpHealth } from './probes'
import * as p from './prompter'
import { glyph, theme } from './theme'
import { APP_SIGNUP_URL, APP_URL } from './urls'
const REALTIME_HEALTH = 'http://localhost:3002/health'
const POSTGRES_VOLUME = 'sim-postgres-data'
const COMPOSE_FILES = ['docker-compose.prod.yml', 'docker-compose.local.yml'] as const
const K8S_RELEASE = 'sim-dev'
const K8S_NAMESPACE = 'sim-dev'
export const LIFECYCLE_COMMANDS = [
'start',
'stop',
'restart',
'update',
'status',
'logs',
'down',
'reset',
] as const
export type LifecycleCommand = (typeof LIFECYCLE_COMMANDS)[number]
export function isLifecycleCommand(value: string): value is LifecycleCommand {
return (LIFECYCLE_COMMANDS as readonly string[]).includes(value)
}
/**
* POSIX-quote a value for a copyable shell hint — a kube-context can contain
* whitespace or metacharacters that would break a copied command.
*/
function shq(value: string): string {
if (/^[A-Za-z0-9._/-]+$/.test(value)) return value
return `'${value.replace(/'/g, `'\\''`)}'`
}
/** Is the Docker daemon reachable? Distinguishes "nothing installed" from "can't see". */
function dockerReachable(): boolean {
return spawnSync('docker', ['info'], { stdio: 'ignore' }).status === 0
}
/** Non-throwing docker probe; returns trimmed stdout or null on any failure. */
function dockerText(args: string[], cwd: string = ROOT): string | null {
const result = spawnSync('docker', args, { cwd, encoding: 'utf8' })
return result.status === 0 ? result.stdout.trim() : null
}
/** A service's container state, or `'unknown'` when the Docker query itself failed. */
export type ServiceState = { state: 'running' | 'stopped' } | null | 'unknown'
/**
* Reduces `docker ps --format '{{.State}}'` output for one Compose service to the
* same shape `runDetection` uses for standalone containers. A scaled service can
* have several replicas; any running replica counts as running. `null` means the
* query failed, which is not the same as "no containers", so it maps to `'unknown'`.
*/
export function composeServiceState(stateOutput: string | null): ServiceState {
if (stateOutput === null) return 'unknown'
const states = stateOutput
.split('\n')
.map((state) => state.trim())
.filter(Boolean)
if (states.length === 0) return null
return { state: states.includes('running') ? 'running' : 'stopped' }
}
/**
* Compose names containers `<project>-<service>-<n>`, so the standalone
* `sim-postgres` / `sim-redis` name lookup never sees them. Find the service by
* the labels Compose stamps on every container instead.
*/
export function composeServiceQuery(project: string, service: 'db' | 'redis'): string[] {
return [
'ps',
'-a',
'--filter',
`label=com.docker.compose.project=${project}`,
'--filter',
`label=com.docker.compose.service=${service}`,
'--format',
'{{.State}}',
]
}
export interface ServiceRow {
label: string
state: ServiceState
}
/**
* Container rows for `status`. Standalone `sim-postgres` / `sim-redis` belong to
* the dev install; each Compose stack runs its own `db` / `redis` services, which
* are looked up by label through `query` (Docker by default, a fake in tests).
*/
export function serviceStatusRows(
installs: Install[],
standalone: { db: ServiceState; redis: ServiceState },
query: (args: string[]) => string | null = (args) => dockerText(args)
): ServiceRow[] {
const rows: ServiceRow[] = []
const stacks = installs.filter((install): install is ComposeInstall => install.kind === 'compose')
if (stacks.length === 0 || installs.some((install) => install.kind === 'dev')) {
rows.push(
{ label: `postgres (${DB_CONTAINER})`, state: standalone.db },
{ label: `redis (${REDIS_CONTAINER})`, state: standalone.redis }
)
}
for (const stack of stacks) {
const scope = stacks.length > 1 ? `${stack.project} ` : ''
rows.push(
{
label: `${scope}postgres (compose db)`,
state: composeServiceState(query(composeServiceQuery(stack.project, 'db'))),
},
{
label: `${scope}redis (compose redis)`,
state: composeServiceState(query(composeServiceQuery(stack.project, 'redis'))),
}
)
}
return rows
}
/** Docker command whose output the user should see (up, logs); returns exit code. */
function dockerInherit(args: string[], cwd: string = ROOT): number {
return spawnSync('docker', args, { cwd, stdio: 'inherit' }).status ?? 1
}
/** Docker command that must succeed; throws a SetupError with stderr on failure. */
function dockerRun(args: string[], failMessage: string, cwd: string = ROOT): void {
const result = spawnSync('docker', args, { cwd, encoding: 'utf8' })
if (result.status !== 0) {
throw new SetupError(`${failMessage}: ${result.stderr.trim() || result.stdout.trim()}`)
}
}
export interface ComposeInstall {
kind: 'compose'
/** Absolute path to the compose file Docker recorded for the project. */
file: string
/** Directory the stack was brought up from — every compose op runs here. */
dir: string
project: string
}
interface DevInstall {
kind: 'dev'
postgres: boolean
redis: boolean
}
interface K8sInstall {
kind: 'k8s'
context: string
/** False when the context's API server is outside the local allowlist — flagged before destructive ops. */
local: boolean
}
export type Install = ComposeInstall | DevInstall | K8sInstall
interface ComposeProject {
Name: string
Status: string
ConfigFiles: string
}
/**
* Markers that a compose file is actually Sim's: the published app image
* (docker-compose.prod.yml) or the app Dockerfile this repo builds
* (docker-compose.local.yml).
*/
const SIM_COMPOSE_MARKERS = ['ghcr.io/simstudioai/simstudio', 'docker/app.Dockerfile'] as const
/**
* `docker-compose.prod.yml` is a common filename, so the name alone cannot say a
* project is ours — and `reset` runs `compose down -v`, which would destroy
* an unrelated stack's volumes. Read the file Docker recorded for the project and
* require a Sim marker inside it. The old ROOT-scoped `-f` probe was implicitly
* safe because it could only ever see the local project; discovering projects
* globally means identifying them by content instead.
*/
function isSimComposeFile(file: string): boolean {
if (!(COMPOSE_FILES as readonly string[]).includes(path.basename(file))) return false
try {
const contents = readFileSync(file, 'utf8')
return SIM_COMPOSE_MARKERS.some((marker) => contents.includes(marker))
} catch {
// Unreadable or deleted since the stack started — better to not manage it
// than to guess from the filename.
return false
}
}
/**
* Ask Docker which compose projects exist rather than guessing from the working
* directory. Compose derives a project name from the directory it was started
* in, so probing `-f <file> ps` only ever finds a stack when you happen to stand
* in the checkout that launched it — a globally linked `sim` would never see one
* — and it reports the same stack once per candidate file, since both files map
* to the same directory-derived project. `compose ls` records the real project
* and the exact config file, so one running stack yields exactly one install
* wherever it was started from.
*/
function composeInstalls(): ComposeInstall[] {
const raw = dockerText(['compose', 'ls', '-a', '--format', 'json'])
if (!raw) return []
let projects: ComposeProject[]
try {
projects = JSON.parse(raw)
} catch {
return []
}
const installs: ComposeInstall[] = []
for (const project of projects) {
// ConfigFiles is a comma-separated list when a stack was started with -f more than once.
const file = (project.ConfigFiles ?? '')
.split(',')
.map((entry) => entry.trim())
.find(isSimComposeFile)
if (!file) continue
installs.push({
kind: 'compose',
file,
dir: path.dirname(file),
project: project.Name,
})
}
return installs
}
/** Restores a setup-managed Compose target from disk even when `down` removed every container. */
export function composeInstallFromDirectory(
root: string,
activeInstalls: readonly ComposeInstall[]
): ComposeInstall | null {
const file = path.join(root, 'docker-compose.prod.yml')
if (!isSimComposeFile(file)) return null
if (activeInstalls.some((install) => path.resolve(install.file) === path.resolve(file)))
return null
const envFile = path.join(root, '.env')
const configuredProject = existsSync(envFile)
? parseEnv(readFileSync(envFile, 'utf8')).get('COMPOSE_PROJECT_NAME')
: undefined
return {
kind: 'compose',
file,
dir: root,
project: configuredProject || legacyComposeProjectName(root),
}
}
/**
* Compose args for an op on a detected install. `-p` is not optional: without it
* Compose re-derives the project from the working directory, and that name is
* frequently NOT the one `compose ls` reported — a directory is lowercased and
* stripped of dots (`Sim.Demo` becomes `simdemo`), and an explicit `-p` or
* COMPOSE_PROJECT_NAME at creation time diverges outright. Acting on a
* re-derived name means `stop`/`down`/`reset` can target a different project
* than the one named in the confirm — and `reset` runs `down -v`. Pinning the
* recorded name makes the op hit exactly what was detected; cwd stays because
* the file's own relative paths (build contexts, env_file) resolve against it.
*/
function composeArgs(install: ComposeInstall, ...verb: string[]): string[] {
return ['compose', '-p', install.project, '-f', install.file, ...verb]
}
/**
* Gives a Compose install the `POSTGRES_PASSWORD` its file requires before the
* stack is brought up, matching whatever its data volume was created with.
*/
function ensureComposePostgresPassword(install: ComposeInstall): void {
if (!composeFileRequiresPostgresPassword(install.file)) return
const envPath = path.join(install.dir, '.env')
const content = existsSync(envPath) ? readFileSync(envPath, 'utf8') : ''
const vars = parseEnv(content)
const choice = choosePostgresPassword(vars.get('POSTGRES_PASSWORD'), install.project)
if (!choice) return
writeEnvFile(envPath, upsertEnv(content, 'POSTGRES_PASSWORD', choice.value))
reportPostgresPasswordChoice(choice, {
compose: `docker compose -p ${install.project} -f ${install.file}`,
user: postgresUser(vars.get('POSTGRES_USER')),
envPath,
})
}
/** Dev mode owns the split env files and, usually, the managed Postgres/Redis. */
function devInstall(detection: Detection): DevInstall | null {
const postgres = detection.dbContainer?.managed ?? false
const redis = detection.redisContainer?.managed ?? false
const splitEnv = detection.envFiles.sim || detection.envFiles.realtime || detection.envFiles.db
if (!postgres && !redis && !splitEnv) return null
return { kind: 'dev', postgres, redis }
}
/**
* Detection is factual: a release either exists on the current context or it
* doesn't. Setup lets the user explicitly confirm a context whose API server is
* outside the local allowlist, so gating detection on locality would strand that
* release — `status`/`start`/`stop`/`down`/`reset` would all claim there is no
* Kubernetes install. Instead the locality is recorded and surfaced: every
* destructive path names the target (and flags a non-local one) before acting.
*/
function k8sInstall(detection: Detection): K8sInstall | null {
const context = detection.kubeContext
if (!context) return null
const status = spawnSync(
'helm',
['status', K8S_RELEASE, '--kube-context', context, '-n', K8S_NAMESPACE],
{ stdio: 'ignore' }
)
if (status.status !== 0) return null
return { kind: 'k8s', context, local: isLocalKubeContext(context) }
}
function detectInstalls(detection: Detection): Install[] {
const compose = composeInstalls()
if (SETUP_CONTEXT.kind === 'standalone' && SETUP_CONTEXT.existing) {
const fromDirectory = composeInstallFromDirectory(SETUP_CONTEXT.root, compose)
if (fromDirectory) compose.push(fromDirectory)
}
const installs: Install[] = [...compose]
const dev = devInstall(detection)
if (dev) installs.push(dev)
const k8s = k8sInstall(detection)
if (k8s) installs.push(k8s)
return installs
}
/** Limits an explicit standalone `--dir` command to that installation. */
function scopeInstallsToInvocation(installs: Install[]): Install[] {
if (SETUP_CONTEXT.kind !== 'standalone' || directoryOverride(process.argv.slice(2)) === null) {
return installs
}
return installs.filter(
(install) => install.kind === 'compose' && path.resolve(install.dir) === SETUP_CONTEXT.root
)
}
function describeInstall(install: Install): string {
if (install.kind === 'compose')
return `Docker Compose (project ${install.project} in ${install.dir})`
if (install.kind === 'dev') return 'Local dev (managed Postgres/Redis)'
// Naming a non-local cluster is the guard against acting on the wrong one after
// an ambient context switch — every destructive confirm renders this string.
const scope = install.local ? '' : ' — NOT a verified-local cluster'
return `Kubernetes (context ${install.context}${scope})`
}
/** One install → use it; several → let the user pick; none → null. */
async function resolveInstall(installs: Install[]): Promise<Install | null> {
if (installs.length <= 1) return installs[0] ?? null
const choice = await p.select({
message: 'Multiple installs detected — which one?',
options: installs.map((install, index) => ({
value: String(index),
label: describeInstall(install),
})),
initialValue: '0',
})
return installs[Number(choice)]
}
function managedNames(install: DevInstall): string[] {
const names: string[] = []
if (install.postgres) names.push(DB_CONTAINER)
if (install.redis) names.push(REDIS_CONTAINER)
return names
}
/**
* Reuses the wizard's forward commands rather than restating them — reaching a
* ClusterIP release needs both, and an app-only hint here would leave the
* editor's socket dead exactly the way the setup path used to.
*/
function k8sReachHints(context: string): string {
return [
...forwardCommands(context),
`kubectl --context ${shq(context)} -n ${K8S_NAMESPACE} get pods`,
].join('\n')
}
function start(install: Install): void {
if (install.kind === 'compose') {
ensureComposePostgresPassword(install)
const spin = p.spinner()
spin.start('Starting containers…')
dockerRun(composeArgs(install, 'up', '-d'), 'docker compose up failed', install.dir)
spin.stop('Containers up')
p.note(
[
`open ${APP_SIGNUP_URL}`,
'follow logs: npx sim-setup logs',
'stop: npx sim-setup stop',
].join('\n'),
'Running'
)
return
}
if (install.kind === 'dev') {
const names = managedNames(install)
for (const name of names) dockerRun(['start', name], `docker start ${name} failed`)
if (names.length) p.log.step(`Started ${names.join(', ')}`)
p.note(
['start the dev server: bun run dev:full', 'stop DB/Redis: npx sim-setup stop'].join(
'\n'
),
'Ready'
)
return
}
p.note(k8sReachHints(install.context), 'Kubernetes is managed with kubectl')
}
function stop(install: Install): void {
if (install.kind === 'compose') {
const spin = p.spinner()
spin.start('Stopping containers…')
dockerRun(composeArgs(install, 'stop'), 'docker compose stop failed', install.dir)
spin.stop('Containers stopped (data kept)')
p.note(
['start again: npx sim-setup start', 'remove: npx sim-setup down'].join('\n'),
'Stopped'
)
return
}
if (install.kind === 'dev') {
const names = managedNames(install)
for (const name of names) dockerRun(['stop', name], `docker stop ${name} failed`)
if (names.length) p.log.step(`Stopped ${names.join(', ')}`)
p.note(
'The dev server runs in the foreground — stop it with Ctrl-C in its terminal.',
'Dev server'
)
return
}
const c = shq(install.context)
p.note(
[
`scale down: kubectl --context ${c} -n ${K8S_NAMESPACE} scale deploy --all --replicas=0`,
`scale up: kubectl --context ${c} -n ${K8S_NAMESPACE} scale deploy --all --replicas=1`,
'tear down: npx sim-setup down',
].join('\n'),
'Kubernetes'
)
}
function restart(install: Install): void {
if (install.kind === 'compose') {
ensureComposePostgresPassword(install)
const spin = p.spinner()
spin.start('Restarting containers…')
dockerRun(composeArgs(install, 'restart'), 'docker compose restart failed', install.dir)
spin.stop('Containers restarted')
p.note(`open ${APP_SIGNUP_URL}`, 'Running')
return
}
if (install.kind === 'dev') {
const names = managedNames(install)
for (const name of names) dockerRun(['restart', name], `docker restart ${name} failed`)
if (names.length) p.log.step(`Restarted ${names.join(', ')}`)
p.note('Restart the dev server manually (Ctrl-C, then bun run dev:full).', 'Dev server')
return
}
p.note(k8sReachHints(install.context), 'Kubernetes is managed with kubectl')
}
export type ComposeUpdateMode = 'pull' | 'build'
/** Resolves how a setup-managed Compose install obtains its next image. */
export function getComposeUpdateMode(file: string): ComposeUpdateMode {
const name = path.basename(file)
if (name === 'docker-compose.prod.yml') return 'pull'
if (name === 'docker-compose.local.yml') return 'build'
throw new Error(`Unsupported Sim Compose file: ${file}`)
}
/** Refreshes a published install's managed Compose file before applying an update. */
export function refreshComposeFileForUpdate(file: string, dir: string): string {
if (getComposeUpdateMode(file) === 'build') return file
return ensureProductionComposeFile(resolveSetupContextAtRoot(dir))
}
function update(install: Install): void {
if (install.kind === 'dev') {
throw new SetupError('update is only available for Docker Compose installs.', [
'update the source checkout with git, run bun install, then restart bun run dev:full',
])
}
if (install.kind === 'k8s') {
throw new SetupError('update does not upgrade Kubernetes releases.', [
'upgrade the release with helm after reviewing the chart and release notes',
])
}
const mode = getComposeUpdateMode(install.file)
if (mode === 'pull') install.file = refreshComposeFileForUpdate(install.file, install.dir)
ensureComposePostgresPassword(install)
const spin = p.spinner()
if (mode === 'pull') {
spin.start('Pulling configured Sim images…')
dockerRun(composeArgs(install, 'pull'), 'docker compose pull failed', install.dir)
} else {
spin.start('Rebuilding Sim images with current base images…')
dockerRun(composeArgs(install, 'build', '--pull'), 'docker compose build failed', install.dir)
}
spin.message('Applying updated images and running migrations…')
dockerRun(composeArgs(install, 'up', '-d'), 'docker compose up failed', install.dir)
spin.stop('Sim updated (data volumes kept)')
p.note(
[
`version: ${theme.command(`SIM_VERSION in ${path.join(install.dir, '.env')}`)} (latest when unset)`,
`check: ${theme.command('npx sim-setup status')}`,
`logs: ${theme.command('npx sim-setup logs')}`,
].join('\n'),
'Update complete'
)
}
function showLogs(install: Install): void {
if (install.kind === 'compose') {
dockerInherit(composeArgs(install, 'logs', '-f', '--tail', '100'), install.dir)
return
}
if (install.kind === 'dev') {
const names = managedNames(install)
p.note(
[
'the dev server logs stream in its own terminal (bun run dev:full)',
...names.map((name) => `container: docker logs -f ${name}`),
].join('\n'),
'Logs'
)
return
}
spawnSync(
'kubectl',
['--context', install.context, '-n', K8S_NAMESPACE, 'logs', '-f', `deploy/${K8S_RELEASE}-app`],
{ stdio: 'inherit' }
)
}
async function down(install: Install): Promise<void> {
const ok = await p.confirm({
message: `Remove ${describeInstall(install)} containers? Data volumes are kept.`,
initialValue: false,
})
if (!ok) {
p.log.info('Left it running.')
return
}
if (install.kind === 'compose') {
dockerRun(composeArgs(install, 'down'), 'docker compose down failed', install.dir)
p.log.step('Containers removed (volumes kept)')
return
}
if (install.kind === 'dev') {
const names = managedNames(install)
if (names.length) {
dockerRun(['rm', '-f', ...names], 'docker rm failed')
p.log.step(`Removed ${names.join(', ')} (Postgres volume ${POSTGRES_VOLUME} kept)`)
} else {
p.log.info('No managed containers to remove.')
}
return
}
const result = spawnSync(
'helm',
['uninstall', K8S_RELEASE, '--kube-context', install.context, '-n', K8S_NAMESPACE],
{ stdio: 'inherit' }
)
if (result.status !== 0) throw new SetupError('helm uninstall failed')
p.log.step(`Uninstalled ${K8S_RELEASE}`)
}
async function reset(install: Install | null): Promise<void> {
// Name the exact target: k8s acts on the ambient context, so spelling out which
// cluster (or compose file / dev containers) is about to be wiped keeps a reset
// from silently hitting the wrong same-named install after a context switch.
const target = install ? ` ${describeInstall(install)} will be removed.` : ''
const ok = await p.confirm({
message: theme.error(
`Reset archives your .env files and wipes managed data (volumes).${target} Continue?`
),
initialValue: false,
})
if (!ok) {
p.log.info('Reset cancelled.')
return
}
if (install?.kind === 'compose') {
const backup = archiveFile(path.join(install.dir, '.env'))
if (backup) p.log.step(`Archived ${backup}`)
} else {
for (const target of ['sim', 'realtime', 'db', 'root'] as const) {
const backup = archiveEnvFile(target)
if (backup) p.log.step(`Archived ${backup}`)
}
}
if (install?.kind === 'compose') {
dockerRun(composeArgs(install, 'down', '-v'), 'docker compose down -v failed', install.dir)
p.log.step('Containers and volumes removed')
} else if (install?.kind === 'dev') {
const names = managedNames(install)
if (names.length) spawnSync('docker', ['rm', '-f', ...names], { cwd: ROOT, stdio: 'ignore' })
spawnSync('docker', ['volume', 'rm', POSTGRES_VOLUME], { cwd: ROOT, stdio: 'ignore' })
p.log.step('Managed containers and Postgres volume removed')
} else if (install?.kind === 'k8s') {
const uninstall = spawnSync(
'helm',
['uninstall', K8S_RELEASE, '--kube-context', install.context, '-n', K8S_NAMESPACE],
{ stdio: 'inherit' }
)
// Env files are already archived, so a failed uninstall leaves a live release
// with no local config — the worst thing to do is call that a success.
if (uninstall.status !== 0) {
throw new SetupError(
`env files were archived, but helm uninstall failed — the ${K8S_RELEASE} release is still running.`,
[
`retry: ${theme.command(`helm uninstall ${K8S_RELEASE} --kube-context ${shq(install.context)} -n ${K8S_NAMESPACE}`)}`,
`check the release: ${theme.command(`helm status ${K8S_RELEASE} --kube-context ${shq(install.context)} -n ${K8S_NAMESPACE}`)}`,
]
)
}
p.log.step(`Uninstalled ${K8S_RELEASE}`)
}
p.note(`start fresh with ${theme.command('npx sim-setup')}`, 'Reset complete')
}
async function status(): Promise<void> {
const detection = await runDetection()
const installs = scopeInstallsToInvocation(detectInstalls(detection))
const docker = dockerReachable()
console.log(`\n${theme.heading('◆ Sim status')}\n`)
// Every container probe goes through Docker, so when the daemon is down the
// honest answer is "unknown", not "absent" — and a compose stack is invisible
// entirely. Saying "no install detected" there sends the user to re-run setup
// for what is really a stopped Docker Desktop.
if (!docker) {
console.log(
` ${glyph.warn} Docker is not reachable — container and Compose state below is unknown.`
)
console.log(` ${theme.muted('start Docker Desktop (or OrbStack), then re-run this.')}\n`)
}
if (installs.length === 0) {
console.log(
docker
? ` ${glyph.warn} No Sim install detected — run ${theme.command('npx sim-setup')}.`
: ` ${glyph.warn} No install detected, but that may just be Docker being down.`
)
return
}
for (const install of installs) console.log(` ${glyph.pass} ${describeInstall(install)}`)
const containerState = (state: ServiceState) => {
if (!docker) return 'unknown (docker down)'
if (state === 'unknown') return 'unknown (docker query failed)'
return state ? state.state : 'absent'
}
console.log()
const rows = serviceStatusRows(installs, {
db: detection.dbContainer,
redis: detection.redisContainer,
})
const width = Math.max(...rows.map((row) => row.label.length)) + 3
for (const row of rows)
console.log(` ${`${row.label}:`.padEnd(width)}${containerState(row.state)}`)
const [app, realtime] = await Promise.all([
httpHealth(`${APP_URL}/api/health`),
httpHealth(REALTIME_HEALTH),
])
console.log()
console.log(` app (:3000) ${app ? glyph.pass : glyph.fail}`)
console.log(` realtime (:3002) ${realtime ? glyph.pass : glyph.fail}`)
}
export async function runLifecycle(command: LifecycleCommand): Promise<void> {
if (command === 'status') return status()
const installs = scopeInstallsToInvocation(detectInstalls(await runDetection()))
// Reset stays useful with nothing running — it still archives stray .env files.
if (command === 'reset') return reset(await resolveInstall(installs))
const install = await resolveInstall(installs)
if (!install) {
p.log.warn(`No Sim install detected. Run ${theme.command('npx sim-setup')} first.`)
return
}
switch (command) {
case 'start':
return start(install)
case 'stop':
return stop(install)
case 'restart':
return restart(install)
case 'update':
return update(install)
case 'logs':
return showLogs(install)
case 'down':
return down(install)
}
}