Do not crash with cmake 3.7-3.13 with CMakePresets.json present

[linquize]

Brief Issue Summary

Do not crash with cmake 3.7-3.13 with CMakePresets.json present.
If I start VScode directly (cmake auto-detected version is 3.12), or start VSCode in VS2017 command prompt (cmake version is 3.12), this problem exists.
If I start VSCode in Ubuntu 18.04 (cmake from ubuntu bionic is 3.10), this problem exists.

If I start VSCode in VS2019 command prompt (cmake version is 3.20), there is no problem.
If I start VSCode in Ubuntu 20.04 (cmake from focal is 3.16), there is no problem.

Open a workspace with CMakePresets.json present.

CMakePresets.json

{
  "version": 2,
  "cmakeMinimumRequired": { "major": 3, "minor": 20, "patch": 0 },
  "configurePresets": [
    {
      "name": "default",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build/default"
    }
  ],
  "buildPresets": [ { "name": "default", "configurePreset": "default" }
  ]
}

Expected:

No Configure Preset Selected is available for choosing configure preset.

Apparent Behavior:

Configure Presets list is not available.
If No Configure Preset Selected clicked, a toast shows command 'cmake.selectConfigurePreset' not found

CMake Tools Log

[variant] Loaded new set of variants
[kit] Successfully loaded 16 kits from C:\Users\User\AppData\Local\CMakeTools\cmake-tools-kits.json
[presetController] Successfully validated presets in c:\project\cmaketest\CMakePresets.json
[rollbar] CMake version 3.12.18081601 may not be supported. Minimum version required is 3.20.0. {}
[main] Unable to determine what CMake generator to use. Please install or configure a preferred generator, or update settings.json, your Kit configuration or PATH variable. Error: No usable generator found.
[expand] Invalid variable reference ${sourceDir} in string: ${sourceDir}/build/default

Platform and Versions

• Operating System: Windows
• CMake Version: 3.12 (auto detected from VS2017)
• VSCode Version: 1.58
• CMake Tools Extension Version: 1.7.3
• Compiler/Toolchain: Both Visual C++ 2017 and 2019 installed

Platform and Versions

• Operating System: Linux
• CMake Version: 3.10 (from Ubuntu bionic)
• VSCode Version: 1.58
• CMake Tools Extension Version: 1.7.3
• Compiler/Toolchain: gcc 7.5, ninja 1.8.2

Other Notes/Information

[linquize]

Possible fix:

vscode-cmake-tools/src/cmake-tools.ts

Lines 1998 to 2007 in e767115

	get sourceDir() {
	const drv = this.getCMakeDriverInstance();
	return drv.then(d => {
	if (!d) {
	return '';
	}
	return d.sourceDir;
	});
	}

Since the instance drv is used once only, do not start cmake server if the implementation is CMakeServerClientDriver which is serverapi mode that targets cmake 3.7-3.13

[bobbrow]

@xisui-MSFT could you take a look at this?

[xisui-MSFT]

This issue can be reproed using setting "cmake.cmakeCommunicationMode": "serverApi" with later version of CMake. Source dir is required to evaluate presets. Presets contain generator info. Generator info is required for server api. Source dir currently requires driver. So this becomes a circular dependency, and I'll change cmake-tools.sourceDir to use config.sourceDir instead.

[bobbrow]

A build with this fix is available for you to test. Could you download the VSIX from here: https://github.com/microsoft/vscode-cmake-tools/suites/3599000085/artifacts/86773353

then unzip the file and run the "Install from VSIX..." command in VS Code to install it and try it out?

[linquize]

@bobbrow The VSIX download link is not found.

[bobbrow]

Hmm... it works for me. Can you try this one instead?
cmake-tools.vsix.zip

[bobbrow]

The fix for this was released today in version 1.8.1