Skip to content

Support system toolchains from Swiftly #1846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2025
+217 −9
Merged

Support system toolchains from Swiftly #1846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/commands/installSwiftlyToolchain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ import { QuickPickItem } from "vscode";

import { WorkspaceContext } from "../WorkspaceContext";
import {
AvailableToolchain,
Swiftly,
SwiftlyProgressData,
SwiftlyToolchain,
isSnapshotVersion,
isStableVersion,
} from "../toolchain/swiftly";
import { showReloadExtensionNotification } from "../ui/ReloadExtension";

interface SwiftlyToolchainItem extends QuickPickItem {
toolchain: AvailableToolchain;
toolchain: SwiftlyToolchain;
}

async function downloadAndInstallToolchain(selected: SwiftlyToolchainItem, ctx: WorkspaceContext) {
Expand Down Expand Up @@ -225,7 +225,7 @@ export async function installSwiftlySnapshotToolchain(ctx: WorkspaceContext): Pr
/**
* Sorts toolchains by version with most recent first
*/
function sortToolchainsByVersion(toolchains: AvailableToolchain[]): AvailableToolchain[] {
function sortToolchainsByVersion(toolchains: SwiftlyToolchain[]): SwiftlyToolchain[] {
return toolchains.sort((a, b) => {
// First sort by type (stable before snapshot)
if (a.version.type !== b.version.type) {
Expand Down
29 changes: 23 additions & 6 deletions src/toolchain/swiftly.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const ListResult = z.object({
z.object({
inUse: z.boolean(),
isDefault: z.boolean(),
version: z.discriminatedUnion("type", [
version: z.union([
z.object({
major: z.union([z.number(), z.undefined()]),
minor: z.union([z.number(), z.undefined()]),
Expand All @@ -47,6 +47,11 @@ const ListResult = z.object({
name: z.string(),
type: z.literal("snapshot"),
}),
z.object({
name: z.string(),
type: z.literal("system"),
}),
z.object(),
]),
})
),
Expand Down Expand Up @@ -77,12 +82,20 @@ const SnapshotVersion = z.object({

export type SnapshotVersion = z.infer<typeof SnapshotVersion>;

export interface SwiftlyToolchain {
inUse: boolean;
installed: boolean;
isDefault: boolean;
version: StableVersion | SnapshotVersion;
}

const AvailableToolchain = z.object({
inUse: z.boolean(),
installed: z.boolean(),
isDefault: z.boolean(),
version: z.discriminatedUnion("type", [StableVersion, SnapshotVersion]),
version: z.union([StableVersion, SnapshotVersion, z.object()]),
});
type AvailableToolchain = z.infer<typeof AvailableToolchain>;

export function isStableVersion(
version: StableVersion | SnapshotVersion
Expand All @@ -99,7 +112,6 @@ export function isSnapshotVersion(
const ListAvailableResult = z.object({
toolchains: z.array(AvailableToolchain),
});
export type AvailableToolchain = z.infer<typeof AvailableToolchain>;

export interface SwiftlyProgressData {
step?: {
Expand Down Expand Up @@ -180,7 +192,9 @@ export class Swiftly {
try {
const { stdout } = await execFile("swiftly", ["list", "--format=json"]);
const response = ListResult.parse(JSON.parse(stdout));
return response.toolchains.map(t => t.version.name);
return response.toolchains
.filter(t => ["stable", "snapshot", "system"].includes(t.version?.type))
.map(t => t.version.name);
} catch (error) {
logger?.error(`Failed to retrieve Swiftly installations: ${error}`);
return [];
Expand Down Expand Up @@ -293,7 +307,7 @@ export class Swiftly {
public static async listAvailable(
logger?: SwiftLogger,
branch?: string
): Promise<AvailableToolchain[]> {
): Promise<SwiftlyToolchain[]> {
if (!this.isSupported()) {
return [];
}
Expand All @@ -315,7 +329,10 @@ export class Swiftly {
args.push(branch);
}
const { stdout: availableStdout } = await execFile("swiftly", args);
return ListAvailableResult.parse(JSON.parse(availableStdout)).toolchains;
const result = ListAvailableResult.parse(JSON.parse(availableStdout));
return result.toolchains.filter((t): t is SwiftlyToolchain =>
["stable", "snapshot"].includes(t.version.type)
);
} catch (error) {
logger?.error(`Failed to retrieve available Swiftly toolchains: ${error}`);
return [];
Expand Down
191 changes: 191 additions & 0 deletions test/unit-tests/toolchain/swiftly.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ suite("Swiftly Unit Tests", () => {
// Mock list-available command with JSON output
const jsonOutput = {
toolchains: [
{
inUse: false,
isDefault: false,
version: {
name: "xcode",
type: "system",
},
},
{
inUse: true,
isDefault: true,
Expand Down Expand Up @@ -118,6 +126,100 @@ suite("Swiftly Unit Tests", () => {
const result = await Swiftly.listAvailableToolchains();

expect(result).to.deep.equal([
"xcode",
"swift-5.9.0-RELEASE",
"swift-5.8.0-RELEASE",
"swift-DEVELOPMENT-SNAPSHOT-2023-10-15-a",
]);

expect(mockUtilities.execFile).to.have.been.calledWith("swiftly", ["--version"]);
expect(mockUtilities.execFile).to.have.been.calledWith("swiftly", [
"list",
"--format=json",
]);
});

test("should be able to parse future additions to the output and ignore unexpected types", async () => {
// Mock version check to return 1.1.0
mockUtilities.execFile.withArgs("swiftly", ["--version"]).resolves({
stdout: "1.1.0\n",
stderr: "",
});

// Mock list-available command with JSON output
const jsonOutput = {
toolchains: [
{
inUse: false,
isDefault: false,
version: {
name: "xcode",
type: "system",
newProp: 1, // Try adding a new property.
},
newProp: 1, // Try adding a new property.
},
{
inUse: false,
isDefault: false,
version: {
// Try adding an unexpected version type.
type: "something_else",
},
newProp: 1, // Try adding a new property.
},
{
inUse: true,
isDefault: true,
version: {
major: 5,
minor: 9,
patch: 0,
name: "swift-5.9.0-RELEASE",
type: "stable",
newProp: 1, // Try adding a new property.
},
newProp: 1, // Try adding a new property.
},
{
inUse: false,
isDefault: false,
version: {
major: 5,
minor: 8,
patch: 0,
name: "swift-5.8.0-RELEASE",
type: "stable",
newProp: 1, // Try adding a new property.
},
newProp: "", // Try adding a new property.
},
{
inUse: false,
isDefault: false,
version: {
major: 5,
minor: 10,
branch: "development",
date: "2023-10-15",
name: "swift-DEVELOPMENT-SNAPSHOT-2023-10-15-a",
type: "snapshot",
newProp: 1, // Try adding a new property.
},
newProp: 1, // Try adding a new property.
},
],
};

mockUtilities.execFile.withArgs("swiftly", ["list", "--format=json"]).resolves({
stdout: JSON.stringify(jsonOutput),
stderr: "",
});

const result = await Swiftly.listAvailableToolchains();

expect(result).to.deep.equal([
"xcode",
"swift-5.9.0-RELEASE",
"swift-5.8.0-RELEASE",
"swift-DEVELOPMENT-SNAPSHOT-2023-10-15-a",
Expand Down Expand Up @@ -342,6 +444,95 @@ suite("Swiftly Unit Tests", () => {
]);
});

test("should be able to parse future additions to the output and ignore unexpected types", async () => {
mockedPlatform.setValue("darwin");

mockUtilities.execFile.withArgs("swiftly", ["--version"]).resolves({
stdout: "1.1.0\n",
stderr: "",
});

const availableResponse = {
toolchains: [
{
inUse: false,
installed: false,
isDefault: false,
version: {
// Try adding an unexpected version type.
type: "something_else",
},
newProp: 1, // Try adding a new property.
},
{
inUse: false,
installed: false,
isDefault: false,
version: {
type: "stable",
major: 6,
minor: 0,
patch: 0,
name: "6.0.0",
newProp: 1, // Try adding a new property.
},
newProp: 1, // Try adding a new property.
},
{
inUse: false,
installed: false,
isDefault: false,
version: {
type: "snapshot",
major: 6,
minor: 1,
branch: "main",
date: "2025-01-15",
name: "main-snapshot-2025-01-15",
newProp: 1, // Try adding a new property.
},
newProp: 1, // Try adding a new property.
},
],
};

mockUtilities.execFile
.withArgs("swiftly", ["list-available", "--format=json"])
.resolves({
stdout: JSON.stringify(availableResponse),
stderr: "",
});

const result = await Swiftly.listAvailable();
expect(result).to.deep.equal([
{
inUse: false,
installed: false,
isDefault: false,
version: {
type: "stable",
major: 6,
minor: 0,
patch: 0,
name: "6.0.0",
},
},
{
inUse: false,
installed: false,
isDefault: false,
version: {
type: "snapshot",
major: 6,
minor: 1,
branch: "main",
date: "2025-01-15",
name: "main-snapshot-2025-01-15",
},
},
]);
});

test("should handle errors when fetching available toolchains", async () => {
mockedPlatform.setValue("darwin");
mockUtilities.execFile.withArgs("swiftly", ["--version"]).resolves({
Expand Down