-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathmain.go
More file actions
1049 lines (955 loc) · 31.3 KB
/
main.go
File metadata and controls
1049 lines (955 loc) · 31.3 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
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//go:build !windows
// Command develop orchestrates the Coder development environment. It
// builds the binary, starts the API server and frontend dev server,
// sets up a first user, and handles graceful shutdown on signals.
package main
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"os"
"os/exec"
"os/signal"
"path/filepath"
"runtime"
"slices"
"strconv"
"strings"
"sync"
"syscall"
"time"
"github.com/google/uuid"
"golang.org/x/sync/errgroup"
"golang.org/x/xerrors"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/sloghuman"
"github.com/coder/coder/v2/cli"
"github.com/coder/coder/v2/cli/config"
"github.com/coder/coder/v2/coderd/util/slice"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/serpent"
)
const (
defaultAPIPort = "3000"
defaultWebPort = "8080"
defaultProxyPort = "3010"
// defaultPrometheusPort avoids 2112 (agent prometheus) and
// 2113 (agent debug) already bound inside Coder workspaces.
defaultPrometheusPort = "2114"
defaultAccessURL = "http://127.0.0.1:%d"
defaultPassword = "SomeSecurePassword!"
defaultStarterTemplate = "docker"
healthTimeout = 60 * time.Second
shutdownTimeout = 15 * time.Second
)
func main() {
var cfg devConfig
cmd := &serpent.Command{
Use: "develop",
Short: "Orchestrate the Coder development environment.",
Options: serpent.OptionSet{
{
Flag: "port",
Env: "CODER_DEV_PORT",
Default: defaultAPIPort,
Description: "API server port.",
Value: serpent.Int64Of(&cfg.apiPort),
},
{
Flag: "web-port",
Env: "CODER_DEV_WEB_PORT",
Default: defaultWebPort,
Description: "Frontend dev server port.",
Value: serpent.Int64Of(&cfg.webPort),
},
{
Flag: "proxy-port",
Env: "CODER_DEV_PROXY_PORT",
Default: defaultProxyPort,
Description: "Workspace proxy port.",
Value: serpent.Int64Of(&cfg.proxyPort),
},
{
Flag: "prometheus-port",
Env: "CODER_DEV_PROMETHEUS_PORT",
Default: defaultPrometheusPort,
Description: "Prometheus metrics port. Set to 0 to disable.",
Value: serpent.Int64Of(&cfg.prometheusPort),
},
{
Flag: "agpl",
Env: "CODER_BUILD_AGPL",
Description: "Build AGPL-licensed code only.",
Value: serpent.BoolOf(&cfg.agpl),
},
{
Flag: "access-url",
Env: "CODER_DEV_ACCESS_URL",
Default: defaultAccessURL,
Description: "Override access URL. The %d placeholder will be replaced with the API port. Set to empty to enable devtunnel (pit-1.try.coder.app).",
Value: serpent.StringOf(&cfg.accessURL),
},
{
Flag: "password",
Env: "CODER_DEV_ADMIN_PASSWORD",
Default: defaultPassword,
Description: "Admin user password.",
Value: serpent.StringOf(&cfg.password),
},
{
Flag: "use-proxy",
Description: "Start a workspace proxy.",
Value: serpent.BoolOf(&cfg.useProxy),
},
{
Flag: "multi-organization",
Description: "Create a second organization.",
Value: serpent.BoolOf(&cfg.multiOrg),
},
{
Flag: "debug",
Description: "Run under Delve debugger.",
Value: serpent.BoolOf(&cfg.debug),
},
{
Flag: "starter-template",
Env: "CODER_DEV_STARTER_TEMPLATE",
Default: defaultStarterTemplate,
Description: "Starter template to create (empty to skip).",
Value: serpent.StringOf(&cfg.starterTemplate),
},
{
Flag: "db-rollback",
Env: "CODER_DEV_DB_ROLLBACK",
Description: "Roll back database migrations that no longer exist on the current branch.",
Value: serpent.BoolOf(&cfg.dbRollback),
},
{
Flag: "db-reset",
Env: "CODER_DEV_DB_RESET",
Description: "Destroy the development database and start fresh.",
Value: serpent.BoolOf(&cfg.dbReset),
},
{
Flag: "db-continue",
Env: "CODER_DEV_DB_CONTINUE",
Description: "Accept changed migration files and update tracking. Use when you've manually fixed the DB to match the new migrations.",
Value: serpent.BoolOf(&cfg.dbContinue),
},
},
Handler: func(inv *serpent.Invocation) error {
cfg.serverExtraArgs = inv.Args
logger := slog.Make(sloghuman.Sink(inv.Stderr))
if err := cfg.validate(); err != nil {
return err
}
if err := cfg.resolveEnv(); err != nil {
return err
}
return develop(inv.Context(), logger, &cfg)
},
}
err := cmd.Invoke(os.Args[1:]...).WithOS().Run()
if err != nil {
_, _ = fmt.Fprintf(os.Stderr, "error: %v\n", err)
os.Exit(1)
}
}
type devConfig struct {
apiPort int64
webPort int64
proxyPort int64
prometheusPort int64
agpl bool
accessURL string
password string
useProxy bool
multiOrg bool
debug bool
starterTemplate string
dbRollback bool
dbReset bool
dbContinue bool
projectRoot string
binaryPath string
configDir string
childEnv []string
// Extra args after flags forwarded to "coder server".
serverExtraArgs []string
}
func (c *devConfig) validate() error {
if c.agpl && c.useProxy {
return xerrors.New("cannot use both --agpl and --use-proxy")
}
if c.agpl && c.multiOrg {
return xerrors.New("cannot use both --agpl and --multi-organization")
}
if c.dbRollback && c.dbReset {
return xerrors.New("cannot use both --db-rollback and --db-reset")
}
if c.dbContinue && c.dbReset {
return xerrors.New("cannot use both --db-continue and --db-reset")
}
for _, p := range []struct {
name string
val int64
}{
{"--port", c.apiPort},
{"--web-port", c.webPort},
{"--proxy-port", c.proxyPort},
} {
if p.val < 1 || p.val > 65535 {
return xerrors.Errorf("%s must be between 1 and 65535", p.name)
}
}
if c.prometheusPort < 0 || c.prometheusPort > 65535 {
return xerrors.Errorf("--prometheus-port must be 0 (disabled) or between 1 and 65535")
}
if c.apiPort == c.webPort {
return xerrors.Errorf("--port %d conflicts with frontend dev server", c.webPort)
}
if c.useProxy && c.apiPort == c.proxyPort {
return xerrors.Errorf("--port %d conflicts with workspace proxy", c.proxyPort)
}
if c.useProxy && c.webPort == c.proxyPort {
return xerrors.Errorf("--web-port %d conflicts with --proxy-port", c.webPort)
}
if c.prometheusPort != 0 {
if c.prometheusPort == c.apiPort {
return xerrors.Errorf("--prometheus-port %d conflicts with API server", c.prometheusPort)
}
if c.prometheusPort == c.webPort {
return xerrors.Errorf("--prometheus-port %d conflicts with frontend dev server", c.prometheusPort)
}
if c.useProxy && c.prometheusPort == c.proxyPort {
return xerrors.Errorf("--prometheus-port %d conflicts with workspace proxy", c.prometheusPort)
}
}
return nil
}
// resolveEnv sets defaults, unsets leaked credentials, resolves
// filesystem paths, and computes the child process environment.
func (c *devConfig) resolveEnv() error {
if strings.Contains(c.accessURL, "%d") {
c.accessURL = fmt.Sprintf(c.accessURL, c.apiPort)
}
// Prevent inherited credentials from leaking into child
// processes or being picked up by config reads.
_ = os.Unsetenv("CODER_SESSION_TOKEN")
_ = os.Unsetenv("CODER_URL")
var err error
c.projectRoot, err = os.Getwd()
if err != nil {
return xerrors.Errorf("getting working directory: %w", err)
}
c.binaryPath = filepath.Join(c.projectRoot, "build",
fmt.Sprintf("coder_%s_%s", runtime.GOOS, runtime.GOARCH))
c.configDir = filepath.Join(c.projectRoot, ".coderv2")
// Compute once, reused by cmd().
c.childEnv = filterEnv(os.Environ(), "CODER_SESSION_TOKEN", "CODER_URL")
return nil
}
// cmd builds an exec.Cmd rooted in the project directory with a
// clean child environment. The context controls process lifetime.
func (c *devConfig) cmd(ctx context.Context, bin string, args ...string) *exec.Cmd {
cmd := exec.CommandContext(ctx, bin, args...)
cmd.Dir = c.projectRoot
cmd.Env = slices.Clone(c.childEnv)
return cmd
}
// filterEnv returns env with any variables whose key matches
// exclude removed.
func filterEnv(env []string, exclude ...string) []string {
out := make([]string, 0, len(env))
for _, e := range env {
k, _, _ := strings.Cut(e, "=")
if !slices.Contains(exclude, k) {
out = append(out, e)
}
}
return out
}
// procGroup tracks child processes using an errgroup. When any
// child exits, the errgroup cancels its derived context, aborting
// all downstream operations. Graceful shutdown is handled by
// cmd.Cancel/WaitDelay on each command.
type procGroup struct {
eg *errgroup.Group
ctx context.Context
logger slog.Logger
}
func newProcGroup(ctx context.Context, logger slog.Logger) *procGroup {
eg, ctx := errgroup.WithContext(ctx)
return &procGroup{eg: eg, ctx: ctx, logger: logger}
}
// Start registers a long-running command with the group. It sets up
// graceful shutdown (SIGINT on context cancel, SIGKILL after
// timeout), wires stdout/stderr to structured logging, starts the
// process, and registers a goroutine that waits for it to exit.
func (g *procGroup) Start(name string, cmd *exec.Cmd) error {
// Guard against nil env: appending to nil creates a non-nil
// slice that exec.Cmd treats as an explicit (empty) env.
if cmd.Env == nil {
cmd.Env = os.Environ()
}
cmd.Env = append(cmd.Env, "FORCE_COLOR=1")
// Run in a new process group so signals reach the entire
// child tree (e.g. pnpm → vite), not just the direct child.
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
// Graceful shutdown: SIGINT the process group on context
// cancel, escalate to SIGKILL after WaitDelay.
cmd.Cancel = func() error {
return syscall.Kill(-cmd.Process.Pid, syscall.SIGINT)
}
cmd.WaitDelay = shutdownTimeout
named := g.logger.Named(name)
w := &logWriter{logger: named}
cmd.Stdout = w
cmd.Stderr = w
named.Info(g.ctx, "starting", slog.F("cmd", strings.Join(cmd.Args, " ")))
if err := cmd.Start(); err != nil {
return xerrors.Errorf("starting %s: %w", name, err)
}
g.eg.Go(func() error {
err := cmd.Wait()
if err != nil {
return xerrors.Errorf("process %q exited: %w", name, err)
}
// Clean exit is still unexpected for a long-running dev
// process. Report it so the orchestrator shuts down.
return xerrors.Errorf("process %q exited unexpectedly", name)
})
return nil
}
// Wait blocks until all started processes have exited.
func (g *procGroup) Wait() error { return g.eg.Wait() }
// Ctx returns the errgroup's derived context. It cancels when the
// parent context fires (signal) or any child process exits.
func (g *procGroup) Ctx() context.Context { return g.ctx }
// poll calls cond every interval until it returns a value and true,
// or the context is canceled. If cond returns a non-nil error,
// polling stops immediately.
func poll[T any](ctx context.Context, interval time.Duration, cond func(ctx context.Context) (T, bool, error)) (T, error) {
ticker := time.NewTicker(interval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
var zero T
return zero, ctx.Err()
case <-ticker.C:
v, done, err := cond(ctx)
if err != nil {
return v, err
}
if done {
return v, nil
}
}
}
}
func develop(ctx context.Context, logger slog.Logger, cfg *devConfig) error {
sigCtx, stop := signal.NotifyContext(ctx, cli.StopSignals...)
defer stop()
if err := preflight(sigCtx, logger, cfg); err != nil {
return err
}
// Check the database before building. The mismatch check is
// a cheap file read; only starts temp postgres on actual
// mismatch. This avoids a wasted build cycle when the
// developer needs to re-run with --db-rollback or --db-reset.
if err := recoverDB(sigCtx, logger, cfg); err != nil {
return xerrors.Errorf("database recovery: %w", err)
}
if err := buildBinary(sigCtx, logger, cfg); err != nil {
return xerrors.Errorf("build: %w", err)
}
// Wrap in a cancelable context so deferred cleanup can
// trigger graceful shutdown on early return.
cancelCtx, cancelAll := context.WithCancel(sigCtx)
group := newProcGroup(cancelCtx, logger)
defer func() {
cancelAll()
_ = group.Wait()
}()
ctx = group.Ctx()
if err := startServer(cfg, group); err != nil {
return err
}
// The vite dev server proxies to the API and handles the
// case where the API isn't ready yet, so start it in parallel.
if err := group.Start("site", pnpmCmd(ctx, cfg)); err != nil {
return xerrors.Errorf("starting frontend: %w", err)
}
apiURL := fmt.Sprintf("http://127.0.0.1:%d", cfg.apiPort)
if err := waitForHealthy(ctx, logger, apiURL); err != nil {
return err
}
client, err := setupFirstUser(ctx, logger, cfg, apiURL)
if err != nil {
return xerrors.Errorf("setup: %w", err)
}
if cfg.multiOrg {
if err := setupMultiOrg(ctx, logger, cfg, client, group); err != nil {
logger.Warn(ctx, "multi-org setup failed, continuing",
slog.Error(err))
}
}
if cfg.starterTemplate != "" {
if err := setupStarterTemplate(ctx, logger, cfg, client); err != nil {
logger.Warn(ctx, "starter template setup failed, continuing", slog.Error(err))
}
}
// Update migration tracking after the server has applied
// any new migrations. This keeps the cache current so the
// next run detects mismatches correctly.
if err := updateMigrationTracking(ctx, logger, cfg); err != nil {
logger.Warn(ctx, "failed to update migration tracking",
slog.Error(err))
}
if cfg.useProxy {
if err := setupWorkspaceProxy(ctx, cfg, client, group); err != nil {
logger.Warn(ctx, "proxy setup failed, continuing",
slog.Error(err))
}
}
printBanner(ctx, logger, cfg)
// Block until a signal fires or a child process exits.
<-ctx.Done()
waitErr := group.Wait()
// If a signal triggered shutdown, process exit errors are
// expected (SIGINT deaths). Report clean shutdown.
if sigCtx.Err() != nil {
logger.Info(ctx, "signal received, shutting down")
return nil
}
return waitErr
}
func preflight(ctx context.Context, logger slog.Logger, cfg *devConfig) error {
// Source lib.sh to run its dependency checks (bash 4+, GNU
// getopt, make 4+) and then check command dependencies,
// matching the original develop.sh. Prints helpful install
// instructions on failure and exits non-zero.
libSh := filepath.Join(cfg.projectRoot, "scripts", "lib.sh")
libCheck := exec.CommandContext(ctx, "bash", "-c", //nolint:gosec // libSh is a project-relative path, not user input
"source "+libSh+" && dependencies curl git go jq make pnpm")
libCheck.Stdout = os.Stderr
libCheck.Stderr = os.Stderr
if err := libCheck.Run(); err != nil {
return xerrors.New("dependency check failed, see above")
}
apiAddr := fmt.Sprintf("http://127.0.0.1:%d", cfg.apiPort)
if isCoderRunning(ctx, apiAddr) {
logger.Info(ctx, "coder is already running on this port",
slog.F("port", cfg.apiPort))
return nil
}
if isPortBusy(ctx, cfg.apiPort) {
return xerrors.Errorf("port %d is already in use", cfg.apiPort)
}
if isPortBusy(ctx, cfg.webPort) {
return xerrors.Errorf("port %d is already in use (frontend)", cfg.webPort)
}
if cfg.useProxy && isPortBusy(ctx, cfg.proxyPort) {
return xerrors.Errorf("port %d is already in use (proxy)", cfg.proxyPort)
}
if cfg.prometheusPort != 0 && isPortBusy(ctx, cfg.prometheusPort) {
return xerrors.Errorf("port %d is already in use (prometheus)", cfg.prometheusPort)
}
return nil
}
// buildBinary uses os.Environ() directly (not cfg.cmd()) because
// the build needs the full unfiltered parent environment.
func buildBinary(ctx context.Context, logger slog.Logger, cfg *devConfig) error {
target := fmt.Sprintf("build/coder_%s_%s", runtime.GOOS, runtime.GOARCH)
cmd := exec.CommandContext(ctx, "make", "-j", target)
cmd.Dir = cfg.projectRoot
w := &logWriter{logger: logger.Named("build")}
cmd.Stdout = w
cmd.Stderr = w
cmd.Env = append(os.Environ(),
"DEVELOP_IN_CODER="+shellBool(developInCoder()),
"MAKE_TIMED=1",
)
if cfg.agpl {
cmd.Env = append(cmd.Env, "CODER_BUILD_AGPL=1")
}
return cmd.Run()
}
func startServer(cfg *devConfig, group *procGroup) error {
serverArgs := []string{
"--global-config", cfg.configDir,
"server",
"--http-address", fmt.Sprintf("0.0.0.0:%d", cfg.apiPort),
"--swagger-enable",
"--access-url", cfg.accessURL,
"--dangerous-allow-cors-requests=true",
"--enable-terraform-debug-mode",
}
if cfg.prometheusPort != 0 {
serverArgs = append(serverArgs,
"--prometheus-enable",
"--prometheus-address", fmt.Sprintf("0.0.0.0:%d", cfg.prometheusPort),
"--prometheus-collect-agent-stats",
"--prometheus-collect-db-metrics",
)
}
serverArgs = append(serverArgs, cfg.serverExtraArgs...)
if cfg.debug {
return startServerDebug(cfg, serverArgs, group)
}
cmd := cfg.cmd(group.Ctx(), cfg.binaryPath, serverArgs...)
return group.Start("api", cmd)
}
func startServerDebug(cfg *devConfig, serverArgs []string, group *procGroup) error {
ctx := group.Ctx()
logger := group.logger
debugBin := filepath.Join(cfg.projectRoot, "build",
fmt.Sprintf("coder_debug_%s_%s", runtime.GOOS, runtime.GOARCH))
dlvBinDir := filepath.Join(cfg.projectRoot, "build", ".bin")
dlvBin := filepath.Join(dlvBinDir, "dlv")
// Build debug binary and install dlv in parallel.
eg, egCtx := errgroup.WithContext(ctx)
eg.Go(func() error {
buildArgs := []string{
"--os", runtime.GOOS, "--arch", runtime.GOARCH,
"--output", debugBin, "--debug",
}
if cfg.agpl {
buildArgs = append(buildArgs, "--agpl")
}
cmd := cfg.cmd(egCtx,
filepath.Join(cfg.projectRoot, "scripts", "build_go.sh"),
buildArgs...)
w := &logWriter{logger: logger.Named("build-debug")}
cmd.Stdout = w
cmd.Stderr = w
return cmd.Run()
})
eg.Go(func() error {
goVer := strings.TrimPrefix(runtime.Version(), "go")
cmd := cfg.cmd(egCtx, "go", "install",
"github.com/go-delve/delve/cmd/dlv@latest")
cmd.Env = append(cmd.Env,
"GOBIN="+dlvBinDir, "GOTOOLCHAIN=go"+goVer)
w := &logWriter{logger: logger.Named("dlv-install")}
cmd.Stdout = w
cmd.Stderr = w
return cmd.Run()
})
if err := eg.Wait(); err != nil {
return xerrors.Errorf("debug build: %w", err)
}
srvCmd := cfg.cmd(ctx, debugBin, serverArgs...)
if err := group.Start("api", srvCmd); err != nil {
return err
}
dlvCmd := cfg.cmd(ctx, dlvBin, "attach",
strconv.Itoa(srvCmd.Process.Pid),
"--headless", "--continue",
"--listen", "127.0.0.1:12345",
"--accept-multiclient")
if err := group.Start("dlv", dlvCmd); err != nil {
return xerrors.Errorf("attaching dlv: %w", err)
}
logger.Info(ctx, "delve debugger listening", slog.F("addr", "127.0.0.1:12345"))
return nil
}
func waitForHealthy(ctx context.Context, logger slog.Logger, apiURL string) error {
logger.Info(ctx, "waiting for server to become ready")
ctx, cancel := context.WithTimeout(ctx, healthTimeout)
defer cancel()
_, err := poll(ctx, 500*time.Millisecond,
func(ctx context.Context) (struct{}, bool, error) {
req, err := http.NewRequestWithContext(
ctx, "GET", apiURL+"/healthz", nil)
if err != nil {
return struct{}{}, false, nil
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
return struct{}{}, false, nil
}
_ = resp.Body.Close()
return struct{}{}, resp.StatusCode == http.StatusOK, nil
})
if err != nil {
return xerrors.Errorf("server did not become ready in %s: %w", healthTimeout, err)
}
logger.Info(ctx, "server is ready to accept connections")
return nil
}
func setupFirstUser(ctx context.Context, logger slog.Logger, cfg *devConfig, apiURL string) (*codersdk.Client, error) {
serverURL, _ := url.Parse(apiURL)
client := codersdk.New(serverURL)
cfgRoot := config.Root(cfg.configDir)
// Try reusing an existing session.
loggedIn := false
if token, err := cfgRoot.Session().Read(); err == nil && token != "" {
client.SetSessionToken(token)
if _, err := client.User(ctx, codersdk.Me); err == nil {
loggedIn = true
} else {
client.SetSessionToken("")
}
}
if !loggedIn {
hasUser, err := client.HasFirstUser(ctx)
if err != nil {
return nil, xerrors.Errorf("checking first user: %w", err)
}
if !hasUser {
logger.Info(ctx, "creating first user",
slog.F("email", "admin@coder.com"),
slog.F("password", cfg.password))
_, err := client.CreateFirstUser(ctx, codersdk.CreateFirstUserRequest{
Email: "admin@coder.com",
Username: "admin",
Name: "Admin User",
Password: cfg.password,
})
if err != nil {
return nil, xerrors.Errorf("creating first user: %w", err)
}
}
loginResp, err := client.LoginWithPassword(ctx, codersdk.LoginWithPasswordRequest{
Email: "admin@coder.com",
Password: cfg.password,
})
if err != nil {
return nil, xerrors.Errorf("login: %w", err)
}
client.SetSessionToken(loginResp.SessionToken)
if err := cfgRoot.Session().Write(loginResp.SessionToken); err != nil {
return nil, xerrors.Errorf("writing session: %w", err)
}
if err := cfgRoot.URL().Write(apiURL); err != nil {
return nil, xerrors.Errorf("writing url: %w", err)
}
}
logger.Info(ctx, "authenticated as admin user", slog.F("email", "admin@coder.com"))
// Look up the default org for member creation.
defaultOrg, err := client.OrganizationByName(ctx, codersdk.DefaultOrganization)
if err != nil {
return nil, xerrors.Errorf("looking up default org: %w", err)
}
// Member user is best-effort.
if _, err := client.User(ctx, "member"); err != nil {
_, err = client.CreateUserWithOrgs(ctx, codersdk.CreateUserRequestWithOrgs{
Email: "member@coder.com",
Username: "member",
Name: "Regular User",
Password: cfg.password,
UserLoginType: codersdk.LoginTypePassword,
OrganizationIDs: []uuid.UUID{defaultOrg.ID},
})
if err != nil {
logger.Warn(ctx, "failed to create member user", slog.Error(err))
} else {
logger.Info(ctx, "created member user", slog.F("email", "member@coder.com"))
}
}
return client, nil
}
func setupMultiOrg(ctx context.Context, logger slog.Logger, cfg *devConfig, client *codersdk.Client, group *procGroup) error {
const orgName = "second-organization"
org, err := client.OrganizationByName(ctx, orgName)
if err != nil {
logger.Info(ctx, "creating organization",
slog.F("name", orgName))
org, err = client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{Name: orgName})
if err != nil {
return xerrors.Errorf("creating org: %w", err)
}
}
members, err := client.OrganizationMembers(ctx, org.ID)
if err == nil {
found := false
for _, m := range members {
if m.Username == "member" {
found = true
break
}
}
if !found {
if _, err := client.PostOrganizationMember(ctx, org.ID, "member"); err != nil {
logger.Warn(ctx, "failed to add member to org", slog.Error(err))
}
}
}
cmd := cfg.cmd(ctx, cfg.binaryPath,
"--global-config", cfg.configDir,
"provisionerd", "start",
"--tag", "scope=organization",
"--name", "second-org-daemon",
"--org", orgName)
return group.Start("ext-provisioner", cmd)
}
func setupWorkspaceProxy(ctx context.Context, cfg *devConfig, client *codersdk.Client, group *procGroup) error {
_ = client.DeleteWorkspaceProxyByName(ctx, "local-proxy")
resp, err := client.CreateWorkspaceProxy(ctx,
codersdk.CreateWorkspaceProxyRequest{
Name: "local-proxy",
DisplayName: "Local Proxy",
Icon: "/emojis/1f4bb.png",
})
if err != nil {
return xerrors.Errorf("creating proxy: %w", err)
}
cmd := cfg.cmd(ctx, cfg.binaryPath,
"--global-config", cfg.configDir,
"wsproxy", "server",
"--dangerous-allow-cors-requests=true",
"--http-address", fmt.Sprintf("localhost:%d", cfg.proxyPort),
"--proxy-session-token", resp.ProxyToken,
"--primary-access-url", fmt.Sprintf("http://localhost:%d", cfg.apiPort))
return group.Start("proxy", cmd)
}
// setupStarterTemplate creates a template from a starter example.
// For starters tagged with "docker", it checks Docker availability
// and resolves the Docker host for template variables.
func setupStarterTemplate(ctx context.Context, logger slog.Logger, cfg *devConfig, client *codersdk.Client) error {
templateID := cfg.starterTemplate
// Fetch starter template metadata from the running coderd.
examples, err := client.StarterTemplates(ctx)
if err != nil {
return xerrors.Errorf("fetch starter templates failed: %w", err)
}
example, ok := slice.Find(examples, func(e codersdk.TemplateExample) bool {
return e.ID == templateID
})
if !ok {
return xerrors.Errorf("starter template %q not found", templateID)
}
// Docker-specific: check availability and resolve host.
var userVars []codersdk.VariableValue
if slices.Contains(example.Tags, "docker") {
if err := exec.CommandContext(ctx, "docker", "info").Run(); err != nil {
logger.Debug(ctx, "docker not available, skipping template setup")
return nil
}
dockerHost := ""
if out, err := exec.CommandContext(ctx, "docker", "context", "inspect",
"--format", "{{ .Endpoints.docker.Host }}").Output(); err == nil {
dockerHost = strings.TrimSpace(string(out))
}
userVars = []codersdk.VariableValue{
{Name: "docker_arch", Value: runtime.GOARCH},
{Name: "docker_host", Value: dockerHost},
}
}
if err := createTemplateInOrg(ctx, logger, client, codersdk.DefaultOrganization, example, userVars); err != nil {
return err
}
if cfg.multiOrg {
if err := createTemplateInOrg(ctx, logger, client, "second-organization", example, userVars); err != nil {
logger.Warn(ctx, "failed to create starter template in second org", slog.Error(err))
}
}
return nil
}
// waitForVersion polls until a template version's provisioner job
// reaches a terminal state.
func waitForVersion(ctx context.Context, client *codersdk.Client, id uuid.UUID) (codersdk.TemplateVersion, error) {
return poll(ctx, 500*time.Millisecond,
func(ctx context.Context) (codersdk.TemplateVersion, bool, error) {
v, err := client.TemplateVersion(ctx, id)
if err != nil {
return v, false, err
}
switch v.Job.Status {
case codersdk.ProvisionerJobSucceeded:
return v, true, nil
case codersdk.ProvisionerJobFailed:
return v, false, xerrors.Errorf("job failed: %s", v.Job.Error)
case codersdk.ProvisionerJobCanceled:
return v, false, xerrors.New("job was canceled")
default:
return v, false, nil // Still pending/running.
}
})
}
// createTemplateInOrg ensures a starter template exists in the
// given org, creating it from the example if needed.
func createTemplateInOrg(ctx context.Context, logger slog.Logger, client *codersdk.Client, orgName string, example codersdk.TemplateExample, userVars []codersdk.VariableValue) error {
org, err := client.OrganizationByName(ctx, orgName)
if err != nil {
return xerrors.Errorf("look up org %q failed: %w", orgName, err)
}
if _, err := client.TemplateByName(ctx, org.ID, example.ID); err == nil {
logger.Debug(ctx, "template already exists, skipping creation", slog.F("template", example.ID), slog.F("org", orgName))
return nil
}
version, err := client.CreateTemplateVersion(ctx, org.ID,
codersdk.CreateTemplateVersionRequest{
StorageMethod: codersdk.ProvisionerStorageMethodFile,
ExampleID: example.ID,
Provisioner: codersdk.ProvisionerTypeTerraform,
UserVariableValues: userVars,
})
if err != nil {
return xerrors.Errorf("create template version failed: %w", err)
}
version, err = waitForVersion(ctx, client, version.ID)
if err != nil {
return err
}
_, err = client.CreateTemplate(ctx, org.ID,
codersdk.CreateTemplateRequest{
Name: example.ID,
DisplayName: example.Name,
Description: example.Description,
Icon: example.Icon,
VersionID: version.ID,
})
if err != nil {
return xerrors.Errorf("create template failed: %w", err)
}
logger.Info(ctx, "template created in org", slog.F("template", example.ID), slog.F("org", orgName))
return nil
}
func pnpmCmd(ctx context.Context, cfg *devConfig) *exec.Cmd {
cmd := cfg.cmd(ctx, "pnpm", "--dir", "./site", "dev", "--host")
cmd.Env = append(cmd.Env,
fmt.Sprintf("PORT=%d", cfg.webPort),
fmt.Sprintf("CODER_HOST=http://127.0.0.1:%d", cfg.apiPort),
)
return cmd
}
func printBanner(ctx context.Context, logger slog.Logger, cfg *devConfig) {
ifaces := []string{"localhost"}
if addrs, err := net.InterfaceAddrs(); err == nil {
for _, addr := range addrs {
if ipnet, ok := addr.(*net.IPNet); ok && !ipnet.IP.IsLoopback() && ipnet.IP.To4() != nil {
ifaces = append(ifaces, ipnet.IP.String())
}
}
}
if os.Getenv("CODER") == "true" {
// Inside a workspace, add Coder Desktop entry.
ifaces = append(ifaces, fmt.Sprintf("%s.%s.me.coder", os.Getenv("CODER_WORKSPACE_AGENT_NAME"), os.Getenv("CODER_WORKSPACE_NAME")))
ifaces = append(ifaces, fmt.Sprintf("%s.%s.%s.coder", os.Getenv("CODER_WORKSPACE_AGENT_NAME"), os.Getenv("CODER_WORKSPACE_NAME"), os.Getenv("CODER_WORKSPACE_OWNER_NAME")))
}
var b strings.Builder
w := 64
line := func(content ...string) {
for _, c := range content {
_, _ = fmt.Fprintf(&b, "║ %-*s ║\n", w, c)
}
}
indent := func(s string) string {
return " " + s
}
divider := "╔" + strings.Repeat("═", w+2) + "╗"
bottom := "╚" + strings.Repeat("═", w+2) + "╝"
_, _ = fmt.Fprintln(&b)
_, _ = fmt.Fprintln(&b, divider)
line(
"",
indent("Coder is now running in development mode."),
"",
"API:",
)
for _, h := range ifaces {
line(indent(fmt.Sprintf("http://%s:%d", h, cfg.apiPort)))
}
line(
"",
"Web UI:",
)
for _, h := range ifaces {
line(indent(fmt.Sprintf("http://%s:%d", h, cfg.webPort)))
}
if cfg.useProxy {
line(
"",
"Proxy:",
)
for _, h := range ifaces {
line(indent(fmt.Sprintf("http://%s:%d", h, cfg.proxyPort)))
}
}
if cfg.prometheusPort != 0 {
line(
"",
"Metrics:",
)
for _, h := range ifaces {
line(indent(fmt.Sprintf("http://%s:%d", h, cfg.prometheusPort)))
}
}
line(
"",
"Use ./scripts/coder-dev.sh to talk to this instance!",
fmt.Sprintf(" alias cdr=%s/scripts/coder-dev.sh", cfg.projectRoot),
"",
)
_, _ = fmt.Fprintln(&b, bottom)
logger.Info(ctx, b.String())
}
// logWriter adapts an slog.Logger into an io.Writer. Each complete
// line of text written is logged at Info level. Partial lines are
// buffered until a newline arrives. Safe for concurrent use.
type logWriter struct {
logger slog.Logger
mu sync.Mutex
buf []byte
}
func (w *logWriter) Write(p []byte) (int, error) {
w.mu.Lock()
defer w.mu.Unlock()
w.buf = append(w.buf, p...)
for {
idx := bytes.IndexByte(w.buf, '\n')
if idx < 0 {
break
}