SG start bazel enhancements #59718

jamesmcnamara · 2024-01-19T04:17:17Z

Just getting this up in a draft status so it can get some eyes on it. There are a lot of changes and still some known bugs that I need to resolve but its close.

High Level Changes

Unified BazelCommands and Commands under one interface SGConfigCommand
Split runAndWatch into many different pieces
Added an Installer interface to capture events that can be installed
Brought together all uses of startedCmd by using a commandOptions struct

I'll call out more inline

Known Issues

iBazel output is suppressed after installation so errors are invisible. I need some sort of channel signal to start piping output after installation is complete (can't be before because it breaks the progress bars)
iBazel go routines are not properly managed/awaited
bazel targets take a long time to start up (unknown why)

Test plan

Manually tested locally

…-start-bazel

jamesmcnamara · 2024-01-19T04:22:36Z

.bazel_fix_commands.json

+[
+  {
+    "regex": "^Check that imports in Go sources match importpath attributes in deps.$",
+    "command": "./dev/bazel_configure_accept_changes.sh",
+    "args": []
+  },
+  {
+    "regex": "missing input file",
+    "command": "./dev/bazel_configure_accept_changes.sh",
+    "args": []
+  },
+  {
+    "regex": ": undefined:",
+    "command": "./dev/bazel_configure_accept_changes.sh",
+    "args": []
+  }
+]


Contains patterns of bazel output and the command to run to try to auto fix it. iBazel will use this to to try to auto-resolve build problems.

dev/sg/internal/run/ibazel.go

sg.config.yaml

jhchabran

only did a cursory review, will come back to this to follow properly the execution cinematic :)

lots of nits, don't pay attention too much to them

jhchabran · 2024-01-19T08:21:30Z

dev/bazel_configure_accept_changes.sh

+#! /bin/bash
+
+# Run bazel configure and if the error code is 110, exit with error code 0
+# This is because 110 means that configuration files were successfully


looks like the sentence is cut over here :D

jhchabran · 2024-01-19T08:23:53Z

dev/sg/internal/run/bazel_command.go


-	secretsEnv, err := getSecrets(ctx, bc.Name, bc.ExternalSecrets)
+func (bc BazelCommand) watchPaths() ([]string, error) {


nit: shouldn't this be watchedPaths? I intuitively read watchPaths as "I will watch those paths" not as "get me the paths that I should watch"

jhchabran · 2024-01-19T08:24:55Z

dev/sg/internal/run/bazel_command.go

-	if bc.IgnoreStderr {
-		std.Out.WriteLine(output.Styledf(output.StyleSuggestion, "Ignoring stderr of %s", bc.Name))
-		stderrWriter = sc.stderrBuf
+func (bc BazelCommand) StartWatch(ctx context.Context) (<-chan struct{}, error) {


nit: Watch(ctx context.Context) ... ?

Would love to but but both Command and BazelCommand use Watch for a local field.

jhchabran · 2024-01-19T08:29:50Z

dev/sg/internal/run/command.go

+}
+
+func (cmd Command) watchPaths() ([]string, error) {
+	root, err := root.RepositoryRoot()


nit: we're doing this over and over for every command, it's most likely harmless to run it each time, but we could do this at construction time, when we're building commands.

dev/sg/internal/run/command.go

jhchabran · 2024-01-19T08:38:36Z

dev/sg/internal/run/command.go

-	sc.cancel = cancel
+	ctx, cancel := context.WithCancel(ctx)
+	sc.cancel = func() {
+		sc.Cmd.Process.Signal(os.Interrupt)


As per the godoc in exec.Cmd

// If Cancel is non-nil, the command must have been created with // CommandContext and Cancel will be called when the command's // Context is done. By default, CommandContext sets Cancel to // call the Kill method on the command's Process.

// If the child process has failed to exit — perhaps because it ignored or // failed to receive a shutdown signal from a Cancel function, or because no // Cancel function was set — then it will be terminated using os.Process.Kill.

Therefore, I think we don't need to handle this explicitly, did this result of observing a different behaviour when you tested the implementation?

Yes I saw a ton of orphan child processes but there were lots of other bugs that have been resolved since then. Maybe this can be removed.

Yeah I am definitely still seeing this problem. I think the issue is exactly that it's using SIGKILL which doesn't do any cleanup, which specifically orphans any child processes. So for example docsite and web both spin up servers in child processes and then you get EADDRINUSE all over the place.

Adding a proper interrupt fixed it for me.

dev/sg/internal/run/ibazel.go

jhchabran · 2024-01-19T08:42:46Z

dev/sg/internal/run/ibazel.go

-	stderrWriter = io.MultiWriter(logger, sc.stderrBuf)
-	eg, err := process.PipeOutputUnbuffered(ctx, sc.Cmd, stdoutWriter, stderrWriter)
+func profileEventsFilePath(eventsDir string) string {
+	return path.Join(eventsDir, "profile.json")


IIRC this can be overriden by a command line flag, shouldn't we perhaps always explicitly set this when calling iBazel so we're 100% sure it'll be there?

dev/sg/internal/run/ibazel.go

jhchabran · 2024-01-19T08:51:16Z

dev/sg/internal/run/installer.go

+	"Might as well check Slack. %s is taking its time...",
+	"In German there's a saying: ein guter Käse braucht seine Zeit - a good cheese needs its time. Maybe %s is cheese?",
+	"If %ss turns out to be cheese I'm gonna lose it. Hey, hurry up, will ya",
+	"Still waiting for %s to finish installing...",


We should make a tradition for anyone editing this file to add a new one :D

…ph into jsm/sg-start-bazel

…-start-bazel

jhchabran

@jamesmcnamara I don't want to block you further and as long as we don't replace the default target, this isn't going to break anything, so I'm inclined to LGTM :)

sg.config.yaml

This reverts commit 00185f9.

…60362) * Revert "Made all file watches in `sg start` recursive (#60285)" This reverts commit 4b8a403. * Revert "SG start bazel enhancements (#59718)" This reverts commit 00185f9.

jamesmcnamara added 2 commits January 18, 2024 20:11

WIP draft

fcc49fc

Merge branch 'main' of github.com:sourcegraph/sourcegraph into jsm/sg…

c12eae5

…-start-bazel

cla-bot bot added the cla-signed label Jan 19, 2024

cleanup

0f47a01

jamesmcnamara commented Jan 19, 2024

View reviewed changes

jamesmcnamara requested a review from a team January 19, 2024 04:58

jhchabran reviewed Jan 19, 2024

View reviewed changes

jamesmcnamara added 3 commits January 19, 2024 13:31

added output buffering

1e0f25d

fixed process exiting (I think)

5a6a4b8

added bazel run targets

9de816c

jamesmcnamara marked this pull request as ready for review January 23, 2024 18:58

jamesmcnamara added 15 commits January 23, 2024 10:58

Merge branch 'main' into jsm/sg-start-bazel

016b419

ran go mod tidy and gazelle

a3f3ae5

WIP draft

6b36048

cleanup

b722598

added output buffering

3bb5155

fixed process exiting (I think)

cd1787a

added bazel run targets

3bd8396

ran go mod tidy and gazelle

83cb560

Merge branch 'jsm/sg-start-bazel' of github.com:sourcegraph/sourcegra…

a9407b8

…ph into jsm/sg-start-bazel

fixed installing progress bar render issue

d94df1f

Merge branch 'main' into jsm/sg-start-bazel

0f47f02

Removed closes that were causing race conditions

feeb869

Merge branch 'main' of github.com:sourcegraph/sourcegraph into jsm/sg…

f572b05

…-start-bazel

logging extracted from ibazel output

ebc2b71

only log first and relevant errors

291c219

jhchabran approved these changes Feb 5, 2024

View reviewed changes

sg.config.yaml Outdated Show resolved Hide resolved

jamesmcnamara added 2 commits February 5, 2024 10:43

Merge branch 'main' into jsm/sg-start-bazel

737bcbb

removed slow testing command

72958b9

jamesmcnamara merged commit 00185f9 into main Feb 6, 2024

jamesmcnamara deleted the jsm/sg-start-bazel branch February 6, 2024 04:30

eseliger added a commit that referenced this pull request Feb 9, 2024

Revert "SG start bazel enhancements (#59718)"

08f61b7

This reverts commit 00185f9.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SG start bazel enhancements #59718

SG start bazel enhancements #59718

jamesmcnamara commented Jan 19, 2024 •

edited

Loading

jamesmcnamara Jan 19, 2024

jhchabran left a comment •

edited

Loading

jhchabran Jan 19, 2024

jhchabran Jan 19, 2024

jhchabran Jan 19, 2024

jamesmcnamara Jan 19, 2024

jhchabran Jan 19, 2024

jhchabran Jan 19, 2024

jamesmcnamara Jan 19, 2024

jamesmcnamara Jan 19, 2024

jhchabran Jan 19, 2024

jhchabran Jan 19, 2024

jhchabran left a comment


		secretsEnv, err := getSecrets(ctx, bc.Name, bc.ExternalSecrets)
		func (bc BazelCommand) watchPaths() ([]string, error) {

SG start bazel enhancements #59718

SG start bazel enhancements #59718

Conversation

jamesmcnamara commented Jan 19, 2024 • edited Loading

High Level Changes

Known Issues

Test plan

Choose a reason for hiding this comment

jhchabran left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhchabran left a comment

Choose a reason for hiding this comment

jamesmcnamara commented Jan 19, 2024 •

edited

Loading

jhchabran left a comment •

edited

Loading