Update BSP connection build server config lookup path

[Rajveer100]

Resolves #1695

Adopt <workspace_root>/.bsp search locations in addition to <workspace_root>/.

[ahoppen]

https://build-server-protocol.github.io/docs/overview/server-discovery#default-locations-for-bsp-connection-files specifies a number of other search locations that we should also adopt.

Also, I don’t see any mention of the buildServer.json file so we shouldn’t hardcode that. For the lack of a better idea, I think we should pick the lexicographically first file in one of the search directories that is a valid BSP configuration file.

[Rajveer100]

Let me know about the updated logic.

Regarding picking the file, did you mean to say that if we had multiple .json files in different valid directories, we should pick the lexicographically first one?

[ahoppen]

Regarding picking the file, did you mean to say that if we had multiple .json files in different valid directories, we should pick the lexicographically first one?

Kind of. I’m saying that if in a single search location there are multiple .json files, we should pick the lexicographically first one. But we should still always prefer a build server config in the workspace .bsp folder over one in a system location.

---

Also, you need to update the logic that actually loads the build server config in createConnectionToBspServer. Could you also add test cases to make sure that we find BSP server config files in the <workspace folder>/.bsp location to BuildServerBuildSystemTests?

[Rajveer100]

I am not quite sure about the testing part, which path should be considered as the project workspace root for testing? Also, what do you recommend to invoke getConfigPath, do we add @testable import BuildSystemIntegration for accessing the private methods?

[ahoppen]

I am not quite sure about the testing part, which path should be considered as the project workspace root for testing? Also, what do you recommend to invoke getConfigPath, do we add @testable import BuildSystemIntegration for accessing the private methods?

I would create a MultiFileTestProject similar to how it’s done in

sourcekit-lsp/Sources/SKTestSupport/BuildServerTestProject.swift

Lines 61 to 86 in 01640ee

	var files = files
	files["buildServer.json"] = """
	{
	"name": "client name",
	"version": "10",
	"bspVersion": "2.0",
	"languages": ["a", "b"],
	"argv": ["server.py"]
	}
	"""
	files["server.py"] = """
	import sys
	from typing import Dict, List, Optional
	sys.path.append("\(skTestSupportInputsDirectory.path)")
	from AbstractBuildServer import AbstractBuildServer, LegacyBuildServer
	\(buildServer)
	BuildServer().run()
	""".replacing("$SDK_ARGS", with: sdkArgs)
	try await super.init(
	files: files,
	testName: testName
	)

, just put the build server configuration in a .bsp folder inside the workspace root.

[Rajveer100]

@ahoppen
I have made the changes.

[ahoppen]

I have updated your test case to make it pass, made a few more adjustments and pushed the changes to your branch.

[ahoppen]

@swift-ci Please test

[ahoppen]

@swift-ci Please test Windows

[Rajveer100]

Thanks @ahoppen!