Smarter decisions on if user should be prompted for Xcode change (#1640)

award999 · web-flow · commit 0190644676b9 · 2025-06-23T15:50:27.000-04:00
* Smarter decisions on if user should be prompted for Xcode change If you use a swiftly path then you are prompted everytime VSCode opens even if the xcode-select -p is the same. Example settings: ``` "swift.path": "${userHome}/.swiftly/bin", "swift.swiftEnvironmentVariables": { "DEVELOPER_DIR": "/Applications/Xcode.app/Contents/Developer" }, ``` So consider the DEVELOPER_DIR as well to know if this changed. Issue: #1472 * Re-fetch DEVELOPER_DIR each time * Fix formatting issues
diff --git a/src/toolchain/SelectedXcodeWatcher.ts b/src/toolchain/SelectedXcodeWatcher.ts
@@ -67,10 +67,14 @@ export class SelectedXcodeWatcher implements vscode.Disposable {
      */
     private async setup() {
         this.xcodePath = await this.xcodeSymlink();
+        const developerDir = () => configuration.swiftEnvironmentVariables["DEVELOPER_DIR"];
+        const matchesPath = (xcodePath: string) =>
+            configuration.path && configuration.path.startsWith(xcodePath);
+        const matchesDeveloperDir = (xcodePath: string) => developerDir()?.startsWith(xcodePath);
         if (
             this.xcodePath &&
-            configuration.path &&
-            !configuration.path.startsWith(this.xcodePath)
+            (configuration.path || developerDir()) &&
+            !(matchesPath(this.xcodePath) || matchesDeveloperDir(this.xcodePath))
         ) {
             this.xcodePath = undefined; // Notify user when initially launching that xcode changed since last session
         }
@@ -89,7 +93,18 @@ export class SelectedXcodeWatcher implements vscode.Disposable {
                     await showReloadExtensionNotification(
                         "The Swift Extension has detected a change in the selected Xcode. Please reload the extension to apply the changes."
                     );
-                } else {
+                } else if (developerDir() && !matchesDeveloperDir(this.xcodePath)) {
+                    const selected = await vscode.window.showWarningMessage(
+                        'The Swift Extension has detected a change in the selected Xcode which does not match the value of your DEVELOPER_DIR in the "swift.swiftEnvironmentVariables" setting. Would you like to update your configured "swift.swiftEnvironmentVariables" setting?',
+                        "Remove From Settings",
+                        "Select Toolchain"
+                    );
+                    if (selected === "Remove From Settings") {
+                        await removeToolchainPath();
+                    } else if (selected === "Select Toolchain") {
+                        await selectToolchain();
+                    }
+                } else if (!matchesPath(this.xcodePath)) {
                     const selected = await vscode.window.showWarningMessage(
                         'The Swift Extension has detected a change in the selected Xcode which does not match the value of your "swift.path" setting. Would you like to update your configured "swift.path" setting?',
                         "Remove From Settings",
diff --git a/test/unit-tests/toolchain/SelectedXcodeWatcher.test.ts b/test/unit-tests/toolchain/SelectedXcodeWatcher.test.ts
@@ -31,6 +31,7 @@ suite("Selected Xcode Watcher", () => {
     const mockedVSCodeWindow = mockGlobalObject(vscode, "window");
     let mockOutputChannel: MockedObject<SwiftOutputChannel>;
     const pathConfig = mockGlobalValue(configuration, "path");
+    const envConfig = mockGlobalValue(configuration, "swiftEnvironmentVariables");
     const mockWorkspace = mockGlobalObject(vscode, "workspace");
     const mockCommands = mockGlobalObject(vscode, "commands");
     let mockSwiftConfig: MockedObject<vscode.WorkspaceConfiguration>;
@@ -94,50 +95,101 @@ suite("Selected Xcode Watcher", () => {
         );
     });
 
-    test("Warns that setting is out of date", async () => {
-        pathConfig.setValue("/path/to/swift/bin");
+    suite('"swift.path" is out of date', () => {
+        setup(() => {
+            pathConfig.setValue("/path/to/swift/bin");
+        });
 
-        await run(["/path/to/swift/bin", "/foo", "/foo"]);
+        test("Warns that setting is out of date on startup", async () => {
+            await run(["/foo", "/foo"]);
 
-        expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
-            'The Swift Extension has detected a change in the selected Xcode which does not match the value of your "swift.path" setting. Would you like to update your configured "swift.path" setting?',
-            "Remove From Settings",
-            "Select Toolchain"
-        );
-    });
+            expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
+                'The Swift Extension has detected a change in the selected Xcode which does not match the value of your "swift.path" setting. Would you like to update your configured "swift.path" setting?',
+                "Remove From Settings",
+                "Select Toolchain"
+            );
+        });
 
-    test("Warns that setting is out of date on startup", async () => {
-        pathConfig.setValue("/path/to/swift/bin");
+        test("Remove setting", async () => {
+            mockedVSCodeWindow.showWarningMessage.resolves("Remove From Settings" as any);
 
-        await run(["/foo", "/foo"]);
+            await run(["/foo", "/foo"]);
 
-        expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
-            'The Swift Extension has detected a change in the selected Xcode which does not match the value of your "swift.path" setting. Would you like to update your configured "swift.path" setting?',
-            "Remove From Settings",
-            "Select Toolchain"
-        );
-    });
+            expect(mockSwiftConfig.update.args).to.deep.equal([
+                ["path", undefined, vscode.ConfigurationTarget.Global],
+                ["path", undefined, vscode.ConfigurationTarget.Workspace],
+            ]);
+        });
 
-    test("Remove setting", async () => {
-        pathConfig.setValue("/path/to/swift/bin");
+        test("Select toolchain", async () => {
+            mockedVSCodeWindow.showWarningMessage.resolves("Select Toolchain" as any);
 
-        mockedVSCodeWindow.showWarningMessage.resolves("Remove From Settings" as any);
+            await run(["/foo", "/foo"]);
 
-        await run(["/foo", "/foo"]);
+            expect(mockCommands.executeCommand).to.have.been.calledOnceWith(
+                Commands.SELECT_TOOLCHAIN
+            );
+        });
+
+        test("Warns that setting is out of date", async () => {
+            envConfig.setValue({ DEVELOPER_DIR: "/bar" });
+            await run([undefined, "/bar", "/bar"]);
 
-        expect(mockSwiftConfig.update.args).to.deep.equal([
-            ["path", undefined, vscode.ConfigurationTarget.Global],
-            ["path", undefined, vscode.ConfigurationTarget.Workspace],
-        ]);
+            expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
+                'The Swift Extension has detected a change in the selected Xcode which does not match the value of your "swift.path" setting. Would you like to update your configured "swift.path" setting?',
+                "Remove From Settings",
+                "Select Toolchain"
+            );
+        });
     });
 
-    test("Select toolchain", async () => {
-        pathConfig.setValue("/path/to/swift/bin");
+    suite("DEVELOPER_DIR is out of date", () => {
+        setup(() => {
+            pathConfig.setValue("/path/to/swift/bin");
+            envConfig.setValue({ DEVELOPER_DIR: "/bar" });
+        });
 
-        mockedVSCodeWindow.showWarningMessage.resolves("Select Toolchain" as any);
+        test("Warns that environment is out of date on startup", async () => {
+            pathConfig.setValue("/path/to/swift/bin");
 
-        await run(["/foo", "/foo"]);
+            await run(["/foo", "/foo"]);
+
+            expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
+                'The Swift Extension has detected a change in the selected Xcode which does not match the value of your DEVELOPER_DIR in the "swift.swiftEnvironmentVariables" setting. Would you like to update your configured "swift.swiftEnvironmentVariables" setting?',
+                "Remove From Settings",
+                "Select Toolchain"
+            );
+        });
+
+        test("Remove setting", async () => {
+            mockedVSCodeWindow.showWarningMessage.resolves("Remove From Settings" as any);
+
+            await run(["/foo", "/foo"]);
+
+            expect(mockSwiftConfig.update.args).to.deep.equal([
+                ["path", undefined, vscode.ConfigurationTarget.Global],
+                ["path", undefined, vscode.ConfigurationTarget.Workspace],
+            ]);
+        });
+
+        test("Select toolchain", async () => {
+            mockedVSCodeWindow.showWarningMessage.resolves("Select Toolchain" as any);
 
-        expect(mockCommands.executeCommand).to.have.been.calledOnceWith(Commands.SELECT_TOOLCHAIN);
+            await run(["/foo", "/foo"]);
+
+            expect(mockCommands.executeCommand).to.have.been.calledOnceWith(
+                Commands.SELECT_TOOLCHAIN
+            );
+        });
+
+        test("Warns that setting is out of date", async () => {
+            await run(["/bar", "/foo", "/foo"]);
+
+            expect(mockedVSCodeWindow.showWarningMessage).to.have.been.calledOnceWithExactly(
+                'The Swift Extension has detected a change in the selected Xcode which does not match the value of your DEVELOPER_DIR in the "swift.swiftEnvironmentVariables" setting. Would you like to update your configured "swift.swiftEnvironmentVariables" setting?',
+                "Remove From Settings",
+                "Select Toolchain"
+            );
+        });
     });
 });
