Function handleConfigurationChange

src/extension/extension.ts:799–845

()

function handleConfigurationChange() {
	// TODOs
	// SDK
	const prevObject = previousSettingsObject;
	// TODO(dantup): Could we switch this to using `affectsConfiguration`?
	const newObject = getSettingsThatRequireRestart();
	const changedSettingsNames = prevObject
		? Object.keys(prevObject).filter((k) => prevObject[k] !== newObject[k])
		: [];
	previousSettingsObject = newObject;

	if (prevObject && changedSettingsNames.length > 0) {
		// Delay the restart slightly, because the config change may be transmitted to the LSP server
		// and shutting the server down too quickly results in that trying to write to a closed
		// stream.
		logger.warn(`Configuration changed, reloading:`);
		for (const changedSettingsName of changedSettingsNames)
			logger.info(`    Setting ${changedSettingsName} changed from "${prevObject[changedSettingsName]}" to "${newObject[changedSettingsName]}"`);
		changedSettingsNames.sort();

		// If the SDK path changed and it's been < 1s since we started activating, it suggests something may be changing the SDK path automatically and
		// could be negatively affecting performance (we'll start an analysis server, terminate it, start another). In this case, prompt users to try
		// file issues so we can try to track down what's causing it.
		if (changedSettingsNames.includes("sdkPath") || changedSettingsNames.includes("flutterSdkPath")) {
			const sessionDurationMs = Date.now() - extensionThisSessionStart;
			if (sessionDurationMs <= 1500) {
				const ringLogContents = ringLog.toString();
				const tempLogPath = path.join(os.tmpdir(), `log-${getRandomInt(0x1000, 0x10000).toString(16)}.txt`);

				void vs.window.showWarningMessage(`Your SDK path changed unexpectedly during startup. Please review the log and file an issue on GitHub.`, showLogAction).then(async (action) => {
					if (action === showLogAction) {
						const logContents = `
Your SDK path changed unexpectedly during startup.

Please file an issue at https://github.com/Dart-Code/Dart-Code/issues/new?template=BLANK_ISSUE&title=SDK%20path%20changed%20during%20startup

${ringLogContents.split("\n").filter((l) => l.includes("[General]") || l.includes("[Warn]") || l.includes("[Error]")).join("\n")}
						`.trim();
						await util.openLogContents(undefined, logContents, tempLogPath);
					}
				});
			}
		}

		setTimeout(() => util.promptToReloadExtension(logger, { restartReason: ExtensionRestartReason.ConfigurationChange, restartData: changedSettingsNames.join(",") }), 50);
	}
}

function getSettingsThatRequireRestart(): Record<string, string | number | boolean | undefined> {
	return {