Class FlutterDaemon

src/extension/flutter/flutter_daemon.ts:23–420

import { getGlobalFlutterArgs, getToolEnv, runToolProcess, safeToolSpawn } from "../utils/processes";

export class FlutterDaemon extends StdIOService<UnknownNotification> implements IFlutterDaemon {
	private startTime: Date | undefined;
	private get hasStarted() { return !!this.startTime; };
	private hasShownTerminatedError = false;
	private hasLoggedDaemonTimeout = false;
	private isShuttingDown = false;
	private startupReporter: vs.Progress<{ message?: string; increment?: number }> | undefined;
	private daemonResponsiveCompleter = new PromiseCompleter<void>();
	private daemonResponsive = this.daemonResponsiveCompleter.promise;
	private daemonInitializedCompleter = new PromiseCompleter<void>();
	private daemonInitialized = this.daemonInitializedCompleter.promise;
	private pingIntervalId?: NodeJS.Timeout;
	public capabilities: DaemonCapabilities = DaemonCapabilities.empty;
	private didSpawnWithAdditionalArgs = false;

	constructor(logger: Logger, private readonly analytics: Analytics, private readonly workspaceContext: FlutterWorkspaceContext, flutterCapabilities: FlutterCapabilities, private readonly runIfNoDevices?: () => void, portFromLocalExtension?: number) {
		super(new CategoryLogger(logger, LogCategory.FlutterDaemon), config.maxLogLineLength, true, true);

		const folder = workspaceContext.sdks.flutter;

		this.registerForDaemonConnected((e) => {
			this.additionalPidsToTerminate.push(e.pid);
			this.capabilities.version = e.version;
			void vs.commands.executeCommand("setContext", FLUTTER_SUPPORTS_ATTACH, this.capabilities.canFlutterAttach);

			// Delay marking as initialized for a few seconds to see whether it helps prevent
			// the first emulator requests from hanging.
			// https://github.com/Dart-Code/Dart-Code/issues/5793
			const completer = this.daemonInitializedCompleter;
			const markInitializedAfterDelay = () => setTimeout(() => completer.resolve(), 2000);
			void this.deviceEnable().then(markInitializedAfterDelay, markInitializedAfterDelay);
		});

		const daemonArgs = [];

		const showWebServer = config.flutterShowWebServerDevice === "always" || !isRunningLocally;
		if (showWebServer)
			daemonArgs.push("--show-web-server-device");

		if (isDartCodeTestRun)
			daemonArgs.push("--show-test-device");

		if (portFromLocalExtension) {
			this.createNcProcess(portFromLocalExtension);
			this.startPing();
		} else if (workspaceContext.config.forceFlutterWorkspace && config.daemonPort) {
			this.createNcProcess(config.daemonPort);
			this.startPing(workspaceContext.config.restartMacDaemonMessage);
		} else {
			const execution = usingCustomScript(
				path.join(workspaceContext.sdks.flutter, flutterPath),
				["daemon"].concat(daemonArgs),
				workspaceContext.config?.flutterDaemonScript,
			);

			const flutterAdditionalArgs = config.for(vs.Uri.file(folder)).flutterAdditionalArgs;
			this.didSpawnWithAdditionalArgs = !!flutterAdditionalArgs.length;
			const args = getGlobalFlutterArgs().concat(flutterAdditionalArgs).concat(execution.args);