Skip to content

Commit

Permalink
build(tilt): refactor build cmds to speed up initial dev:up
Browse files Browse the repository at this point in the history 
This change changes the build step for a Tilt local resource (called the
`cmd` attribute) to a common `buck2 build` command with all core backend
targets enumerated. In other words, all the following services:

- `//app/web:dev`
- `//bin/forklift:forklift`
- `//bin/pinga:pinga`
- `//bin/rebaser:rebaser`
- `//bin/sdf:sdf`
- `//bin/veritech:veritech`

will use the *same* `buck2 build ...` command.

Why and How?

Prior to this change, each service only tried to build itself (that is,
the Rebaser only attempted to build `//bin/rebaser:rebaser`). The
problem with this approach is that each `buck2 build` subcommand would
interfere with other in-flight `buck2 build` commands as they share a
single `buckd` daemon (this is enforced by design in the Buck2 daemon).
With this change, the first service to start building will build *all*
the other core services in parallel via a single `buck2 build` command.
That means that once the first build is done, all subsequent `buck2
build` commands will immediately return as the daemon knows no inputs
have been modified since the last build invocation for those targets.

Signed-off-by: Fletcher Nichol <[email protected]>
  • Loading branch information
@fnichol
fnichol committed Jan 20, 2025
1 parent 3f2d191 commit d9b5583
Showing 1 changed file with 63 additions and 46 deletions.
109 changes: 63 additions & 46 deletions dev/Tiltfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ config.define_bool("debug-no-rebaser-rustc-build-mode")
cfg = config.parse()

# Define groups of services

groups = {
"platform": [
"db",
Expand All @@ -17,17 +16,18 @@ groups = {
"spicedb",
],
"backend": [
"pinga",
"veritech",
"sdf",
"rebaser",
"forklift",
"auth-api",
"forklift",
"module-index",
"pinga",
"rebaser",
"sdf",
"veritech",
],
"frontend": [
"web",
"auth-portal",
"docs",
"web",
],
"testing": [
"db-test",
Expand All @@ -43,6 +43,15 @@ groups = {
],
}

core_backend_targets = [
"//app/web:dev",
"//bin/forklift:forklift",
"//bin/pinga:pinga",
"//bin/rebaser:rebaser",
"//bin/sdf:sdf",
"//bin/veritech:veritech",
]

# Add "all" group as a sorted set of all services
_all = {}
for group_values in groups.values():
Expand All @@ -61,40 +70,49 @@ config.set_enabled_resources(enabled_resources)

RUST_RESOURCE_ARGS = {
"serve_env": {"SI_FORCE_COLOR": "true"},
"allow_parallel": True,
"trigger_mode": TRIGGER_MODE_MANUAL,
}

# Get build mode for Buck2 commands
#
# TODO(nick): The Tiltfile logic for writing arguments out does not know how to group string
# ("config.define_string") arguments with the argument call (i.e. it thinks "--foo bar" is one
# argument rather than having argument "--foo" be passed value "bar"). Thus, we use two booleans to
# get around this. If we get both, greedily choose the standard mode.
def mode_and_targets(cfg, targets):
targets_str = " ".join(targets)

if cfg.get("standard-rustc-build-mode", False):
return targets_str
if cfg.get("debug-rustc-build-mode", False):
return "@//mode/debug {}".format(targets_str)
if cfg.get("debug-no-rebaser-rustc-build-mode", False) and "//bin/rebaser:rebaser" not in targets:
return "@//mode/debug {}".format(targets_str)

return "@//mode/release {}".format(targets_str)

def si_buck2_resource(
target,
*,
name = None,
allow_parallel = True,
buck2_serve_args = None,
tee = True,
**kwargs):
# Figure name from build command: //app/web:dev -> web
if name == None:
name = target.split("/")[-1].split(":")[0]

# Get build mode for buck2 commands
# TODO(nick): the bzl logic for writing arguments out does not know how
# to group string ("config.define_string") arguments with the argument
# call (i.e. it thinks "--foo bar" is one argument rather than having
# argument "--foo" be passed value "bar"). Thus, we use two booleans to
# get around this. If we get both, greedily choose the standard mode.
if cfg.get("standard-rustc-build-mode", False):
mode_and_target = target
elif cfg.get("debug-rustc-build-mode", False):
mode_and_target = "@//mode/debug {}".format(target)
elif cfg.get("debug-no-rebaser-rustc-build-mode", False) and target != "//bin/rebaser:rebaser":
mode_and_target = "@//mode/debug {}".format(target)
if target in core_backend_targets:
build_targets = core_backend_targets
else:
mode_and_target = "@//mode/release {}".format(target)
build_targets = [target]

# Get buck2 build command
cmd = "buck2 build {}".format(mode_and_target)
# Get Buck2 build command
cmd = "buck2 build {}".format(mode_and_targets(cfg, build_targets))

# Get buck2 run command
# Get Buck2 run command
mode_and_target = mode_and_targets(cfg, [target])
serve_cmd = "buck2 run {}".format(mode_and_target)
if buck2_serve_args != None:
serve_cmd += " -- {}".format(buck2_serve_args)
Expand All @@ -103,18 +121,31 @@ def si_buck2_resource(
# error but ask around to see if it's intended.
serve_cmd += " | tee /tmp/si-logs/{}".format(name)

# Bring in deps
deps_cmd = "buck2 uquery \"inputs(deps('{}'))\"".format(target)
# Compute Buck2 source inputs to populate Tilt local_resource/deps
deps = str(
local(
"buck2 uquery \"inputs(deps('{}'))\"".format(target),
quiet = True,
),
).splitlines()

# Lookup group and add to labels
group_names = [group for group in groups if group != "all" and name in groups[group]]

print("local_resource(")
print(" name = \"{}\"".format(name))
print(" cmd = \"{}\"".format(cmd))
print(" serve_cmd = \"{}\"".format(serve_cmd))
print(")")
print("")

local_resource(
name,
allow_parallel = allow_parallel,
labels = group_names,
cmd = cmd,
serve_cmd = serve_cmd,
deps = str(local(deps_cmd)).splitlines(),
deps = deps,
**kwargs
)

Expand Down Expand Up @@ -157,11 +188,11 @@ compose_services = [
for service in compose_services:
if service == "jaeger":
links = [
link("http://localhost:16686", "ui"),
link("http://localhost:16686", "jaeger-ui"),
]
elif service == "grafana":
links = [
link("http://localhost:3000", "ui"),
link("http://localhost:3000", "grafana-ui"),
]
elif service == "localstack":
links = [
Expand Down Expand Up @@ -239,16 +270,12 @@ si_buck2_resource(
path = "/api/",
),
),
links = [
"localhost:5156",
],
**RUST_RESOURCE_ARGS
)

# Locally build and run `web` in dev mode
si_buck2_resource(
"//app/web:dev",
allow_parallel = True,
resource_deps = [
"sdf",
],
Expand All @@ -260,23 +287,20 @@ si_buck2_resource(
),
links = [
link("http://127.0.0.1:8080", "web"),
link("https://auth.systeminit.com", "auth"),
link("https://auth.systeminit.com", "auth-prod"),
],
)

si_buck2_resource(
"//app/docs:dev",
allow_parallel = True,
auto_init = False,
resource_deps = [],
readiness_probe = probe(
period_secs = 5,
http_get = http_get_action(
port = 5173,
),
),
links = [
link("http://localhost:5173", "docs"),
],
)

# Locally build and run `module-index`
Expand All @@ -295,9 +319,6 @@ si_buck2_resource(
path = "/",
),
),
links = [
"localhost:5157",
],
**RUST_RESOURCE_ARGS
)

Expand All @@ -315,17 +336,13 @@ si_buck2_resource(
path = "/",
),
),
links = [
"localhost:9001",
],
trigger_mode = TRIGGER_MODE_MANUAL,
)

# Locally build and run `auth-portal` in dev mode
si_buck2_resource(
"//app/auth-portal:dev",
auto_init = False,
allow_parallel = True,
resource_deps = [
"auth-api",
],
Expand All @@ -336,6 +353,6 @@ si_buck2_resource(
),
),
links = [
link("http://127.0.0.1:9000", "web"),
link("http://127.0.0.1:9000", "auth"),
],
)

0 comments on commit d9b5583

Please sign in to comment.