Method isOptedOutOfDartToolingTelemetry

src/extension/analytics.ts:241–265

()

	/// to Dart Code. The prompt from the analysis server mentions "VS Code IDE plugins" which suggests the
	/// mechanism for opting out would apply to Dart Code.
	private isOptedOutOfDartToolingTelemetry(): boolean {
		// Don't let this function ever throw.
		try {
			const configDirectory = isWin ? process.env.USERPROFILE : process.env.HOME;
			if (!configDirectory) {
				this.logger.warn(`No valid home dir to check Dart/Flutter analytics file, disabling analytics`);
				return true;
			}

			const configFile = path.join(configDirectory, ".dart-tool", "dart-flutter-telemetry.config");
			if (!fs.existsSync(configFile)) {
				return false; // No file, means not opted out.
			}
			const configFileContents = fs.readFileSync(configFile).toString();
			const optedOutRegex = /^reporting=0/m;
			if (optedOutRegex.test(configFileContents)) {
				this.logger.info(`Dart/Flutter tooling telemetry is opted-out, disabling for Dart Code`);
				return true;
			}
			return false;
		} catch (e) {
			this.logger.warn(`Failed to check Dart/Flutter analytics file, disabling analytics: ${e}`);
			return true;
		}
	}

	/**
	 * Whether analytics are suppressed for any reason.