Method searchPaths

src/extension/sdk/utils.ts:652–732

(paths: string[], executableFilename: string, postFilter?: (s: string) => boolean)

	}

	public searchPaths(paths: string[], executableFilename: string, postFilter?: (s: string) => boolean): SdkSearchResults {
		this.logger.info(`Searching for ${executableFilename}`);

		const rawSdkPaths =
			paths
				.filter((p) => p)
				.map(resolvePaths)
				.filter(notUndefined);

		// Any that don't end with bin, add it on (as an extra path) since some of our
		// paths may come from places that don't already include it (for ex. the
		// user config.sdkPath).
		const isBinFolder = (f: string) => ["bin", "sbin"].includes(path.basename(f));
		let sdkPaths = flatMap(
			rawSdkPaths,
			(p): SdkSearchResult[] => isBinFolder(p)
				? [{ originalPath: p, sdkPath: p }]
				: [{ originalPath: p, sdkPath: p }, { originalPath: p, sdkPath: path.join(p, "bin") }],
		);

		// TODO: Make the list unique, but preserve the order of the first occurrences. We currently
		// have uniq() and unique(), so also consolidate them.

		this.logger.info(`    Looking for ${executableFilename} in:`);
		for (const p of sdkPaths)
			this.logger.info(`        ${this.sdkDisplayString(p)}`);

		// Restrict only to the paths that have the executable.
		sdkPaths = sdkPaths.filter((p) => fs.existsSync(path.join(p.sdkPath, executableFilename)));

		this.logger.info(`    Found at:`);
		for (const p of sdkPaths)
			this.logger.info(`        ${this.sdkDisplayString(p)}`);

		// Keep track if we find something that looks like a package manager init script. These are
		// symlinks like `flutter` that resolve to other binaries (like `snap` or `hermit`) and may need
		// to be executed if we don't find a real SDK.
		let sdkInitScript: string | undefined;

		// Convert all the paths to their resolved locations.
		sdkPaths = sdkPaths.map((sdkPath): SdkSearchResult => {
			// In order to handle symlinks on the binary (not folder), we need to add the executableName before calling realpath.
			const fullPath = path.join(sdkPath.sdkPath, executableFilename);
			const realExecutableLocation = safeRealpathSync(fullPath);

			if (realExecutableLocation.toLowerCase() !== fullPath.toLowerCase())
				this.logger.info(`Following symlink: ${fullPath} -> ${realExecutableLocation}`);

			// If the symlink resolves to a package manager binary, it's not a real SDK
			// and we should return as-is rather than walk up two levels, as we
			// may want to use the presence of this to trigger initialisation.
			const targetBaseName = path.basename(realExecutableLocation);
			if (targetBaseName !== executableFilename) {
				this.logger.info(`Target ${targetBaseName} is not ${executableFilename}, assuming ${fullPath} is a package manager init script`);
				sdkInitScript = fullPath;
				return { originalPath: sdkPath.originalPath, sdkPath: fullPath };
			}