Skip to content

Commit 5b601f7

Browse files
fix(desktop): align Linux prerequisites
1 parent e79c08b commit 5b601f7

3 files changed

Lines changed: 30 additions & 93 deletions

File tree

‎docs/internals/scripts.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,27 +76,26 @@ authenticated.
7676

7777
### Linux AppImage prerequisites
7878

79-
Linux AppImage packaging compiles the Rust resource monitor and rebuilds the `uiohook-napi` native
80-
addon. Install a Rust toolchain, the standard C/C++ build tools, and the X11 development headers
81-
before running `vp run dist:desktop:linux`.
79+
Linux AppImage packaging compiles the Rust resource monitor. Install a Rust toolchain, the standard
80+
C/C++ build tools, and ImageMagick before running `vp run dist:desktop:linux`.
8281

8382
Ubuntu and Debian:
8483

8584
```bash
8685
sudo apt-get update
87-
sudo apt-get install cargo rustc build-essential imagemagick libx11-dev libxrandr-dev libxtst-dev libxt-dev
86+
sudo apt-get install cargo rustc build-essential imagemagick
8887
```
8988

9089
Fedora:
9190

9291
```bash
93-
sudo dnf install rust cargo gcc gcc-c++ make ImageMagick libX11-devel libXrandr-devel libXtst-devel libXt-devel
92+
sudo dnf install rust cargo gcc gcc-c++ make ImageMagick
9493
```
9594

9695
Arch Linux:
9796

9897
```bash
99-
sudo pacman -S rust base-devel imagemagick libx11 libxrandr libxtst libxt
98+
sudo pacman -S rust base-devel imagemagick
10099
```
101100

102101
The artifact script checks these capabilities before starting the web and desktop builds. If

‎scripts/build-desktop-artifact.test.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -831,9 +831,7 @@ it.layer(NodeServices.layer)("build-desktop-artifact", (it) => {
831831
readonly args: ReadonlyArray<string>;
832832
};
833833
commands.push(childProcess);
834-
const fails =
835-
childProcess.command === "cargo" ||
836-
childProcess.args.includes("X11/extensions/Xrandr.h");
834+
const fails = childProcess.command === "cargo" || childProcess.command === "rustc";
837835
return Effect.succeed(mockProcess(fails ? 1 : 0));
838836
}),
839837
);
@@ -844,10 +842,11 @@ it.layer(NodeServices.layer)("build-desktop-artifact", (it) => {
844842
);
845843

846844
assert.instanceOf(error, LinuxDesktopBuildPrerequisitesMissingError);
847-
assert.deepStrictEqual(error.missing, ["cargo", "xrandr"]);
845+
assert.deepStrictEqual(error.missing, ["cargo", "rust-target"]);
848846
assert.include(error.message, "Rust compiler and Cargo (cargo, rustc)");
849-
assert.include(error.message, "Xrandr headers and linker library (libxrandr-dev)");
850-
assert.include(error.message, "sudo apt-get install cargo rustc libxrandr-dev");
847+
assert.include(error.message, "Requested Rust standard library");
848+
assert.include(error.message, "sudo apt-get install cargo rustc");
849+
assert.include(error.message, "rustup target add aarch64-unknown-linux-gnu");
851850
assert.isTrue(
852851
commands.some(
853852
(command) =>

‎scripts/build-desktop-artifact.ts‎

Lines changed: 20 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -289,31 +289,29 @@ export class BuildCommandFailedError extends Schema.TaggedErrorClass<BuildComman
289289

290290
export const LINUX_DESKTOP_BUILD_PREREQUISITES = [
291291
{ id: "cargo", description: "Rust compiler and Cargo", packages: ["cargo", "rustc"] },
292+
{ id: "rust-target", description: "Requested Rust standard library", packages: [] },
292293
{ id: "cc", description: "C/C++ build toolchain", packages: ["build-essential"] },
293294
{ id: "make", description: "Make", packages: ["build-essential"] },
294295
{ id: "imagemagick", description: "ImageMagick", packages: ["imagemagick"] },
295-
{ id: "x11", description: "X11 headers and linker library", packages: ["libx11-dev"] },
296-
{
297-
id: "xrandr",
298-
description: "Xrandr headers and linker library",
299-
packages: ["libxrandr-dev"],
300-
},
301-
{ id: "xtst", description: "Xtst headers and linker library", packages: ["libxtst-dev"] },
302-
{ id: "xt", description: "Xt headers and linker library", packages: ["libxt-dev"] },
303296
] as const;
304297

305298
export class LinuxDesktopBuildPrerequisitesMissingError extends Schema.TaggedErrorClass<LinuxDesktopBuildPrerequisitesMissingError>()(
306299
"LinuxDesktopBuildPrerequisitesMissingError",
307300
{
308301
missing: Schema.Array(Schema.String),
302+
rustTarget: Schema.String,
309303
},
310304
) {
311305
override get message(): string {
312306
const missingRequirements = LINUX_DESKTOP_BUILD_PREREQUISITES.filter((requirement) =>
313307
this.missing.includes(requirement.id),
314308
);
315309
const details = missingRequirements
316-
.map((requirement) => ` - ${requirement.description} (${requirement.packages.join(", ")})`)
310+
.map((requirement) =>
311+
requirement.packages.length > 0
312+
? ` - ${requirement.description} (${requirement.packages.join(", ")})`
313+
: ` - ${requirement.description}`,
314+
)
317315
.join("\n");
318316
const packages = [
319317
...new Set(missingRequirements.flatMap((requirement) => requirement.packages)),
@@ -322,8 +320,12 @@ export class LinuxDesktopBuildPrerequisitesMissingError extends Schema.TaggedErr
322320
"Linux desktop build prerequisites are missing:",
323321
details,
324322
"",
325-
"On Ubuntu/Debian, install them with:",
326-
` sudo apt-get install ${packages.join(" ")}`,
323+
...(packages.length > 0
324+
? ["On Ubuntu/Debian, install them with:", ` sudo apt-get install ${packages.join(" ")}`]
325+
: []),
326+
...(this.missing.includes("rust-target")
327+
? ["Add the requested Rust target with:", ` rustup target add ${this.rustTarget}`]
328+
: []),
327329
"",
328330
"For other distributions, see docs/internals/scripts.md#linux-appimage-prerequisites.",
329331
"Then rerun `vp run dist:desktop:linux`.",
@@ -1621,25 +1623,19 @@ const rustTargetIsInstalled = Effect.fn("rustTargetIsInstalled")(function* (targ
16211623
export const preflightLinuxDesktopBuild = Effect.fn("preflightLinuxDesktopBuild")(function* (
16221624
arch: typeof BuildArch.Type = "x64",
16231625
) {
1624-
const fs = yield* FileSystem.FileSystem;
1625-
const path = yield* Path.Path;
16261626
const reuseResourceMonitor = yield* Config.boolean("T3CODE_DESKTOP_REUSE_RESOURCE_MONITOR").pipe(
16271627
Config.withDefault(false),
16281628
);
1629-
const probeDir = yield* fs.makeTempDirectoryScoped({
1630-
prefix: "t3code-linux-build-preflight-",
1631-
});
1632-
const sourcePath = path.join(probeDir, "probe.c");
1633-
yield* fs.writeFileString(sourcePath, "int main(void) { return 0; }\n");
1629+
const rustTarget = resolveResourceMonitorRustTargets("linux", arch)[0]!;
16341630

1635-
const commandChecks = yield* Effect.all(
1631+
const checks = yield* Effect.all(
16361632
{
16371633
cargo: reuseResourceMonitor
16381634
? Effect.succeed(true)
1639-
: Effect.all([
1640-
desktopBuildProbeSucceeds(ChildProcess.make("cargo", ["--version"]), "cargo"),
1641-
rustTargetIsInstalled(resolveResourceMonitorRustTargets("linux", arch)[0]!),
1642-
]).pipe(Effect.map(([cargo, target]) => cargo && target)),
1635+
: desktopBuildProbeSucceeds(ChildProcess.make("cargo", ["--version"]), "cargo"),
1636+
"rust-target": reuseResourceMonitor
1637+
? Effect.succeed(true)
1638+
: rustTargetIsInstalled(rustTarget),
16431639
cc: desktopBuildProbeSucceeds(ChildProcess.make("cc", ["--version"]), "cc"),
16441640
make: desktopBuildProbeSucceeds(ChildProcess.make("make", ["--version"]), "make"),
16451641
imagemagick: Effect.all([
@@ -1649,69 +1645,12 @@ export const preflightLinuxDesktopBuild = Effect.fn("preflightLinuxDesktopBuild"
16491645
},
16501646
{ concurrency: "unbounded" },
16511647
);
1652-
1653-
const nativeChecks = commandChecks.cc
1654-
? yield* Effect.all(
1655-
{
1656-
x11: desktopBuildProbeSucceeds(
1657-
ChildProcess.make("cc", [
1658-
sourcePath,
1659-
"-include",
1660-
"X11/keysym.h",
1661-
"-lX11",
1662-
"-o",
1663-
path.join(probeDir, "x11"),
1664-
]),
1665-
"X11 build prerequisite probe",
1666-
),
1667-
xrandr: desktopBuildProbeSucceeds(
1668-
ChildProcess.make("cc", [
1669-
sourcePath,
1670-
"-include",
1671-
"X11/extensions/Xrandr.h",
1672-
"-lXrandr",
1673-
"-o",
1674-
path.join(probeDir, "xrandr"),
1675-
]),
1676-
"Xrandr build prerequisite probe",
1677-
),
1678-
xtst: desktopBuildProbeSucceeds(
1679-
ChildProcess.make("cc", [
1680-
sourcePath,
1681-
"-include",
1682-
"X11/extensions/XTest.h",
1683-
"-lXtst",
1684-
"-o",
1685-
path.join(probeDir, "xtst"),
1686-
]),
1687-
"Xtst build prerequisite probe",
1688-
),
1689-
xt: desktopBuildProbeSucceeds(
1690-
ChildProcess.make("cc", [
1691-
sourcePath,
1692-
"-include",
1693-
"X11/Intrinsic.h",
1694-
"-lXt",
1695-
"-o",
1696-
path.join(probeDir, "xt"),
1697-
]),
1698-
"Xt build prerequisite probe",
1699-
),
1700-
},
1701-
{ concurrency: "unbounded" },
1702-
)
1703-
: { x11: true, xrandr: true, xtst: true, xt: true };
1704-
1705-
const checks = {
1706-
...commandChecks,
1707-
...nativeChecks,
1708-
};
17091648
const missing = LINUX_DESKTOP_BUILD_PREREQUISITES.filter(
17101649
(requirement) => !checks[requirement.id],
17111650
).map((requirement) => requirement.id);
17121651

17131652
if (missing.length > 0) {
1714-
return yield* new LinuxDesktopBuildPrerequisitesMissingError({ missing });
1653+
return yield* new LinuxDesktopBuildPrerequisitesMissingError({ missing, rustTarget });
17151654
}
17161655
});
17171656

0 commit comments

Comments
 (0)