Log file fixes

.changeset/honest-jeans-smoke.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Changes the default directory for log files to workaround frameworks that are watching the entire `.wrangler` directory in the project root for changes

packages/wrangler/src/logger.ts

@@ -4,7 +4,7 @@ import CLITable from "cli-table3";
 import { formatMessagesSync } from "esbuild";
 import { getEnvironmentVariableFactory } from "./environment-variables/factory";
 import { getSanitizeLogs } from "./environment-variables/misc-variables";
-import { appendToDebugLogFile } from "./utils/debug-log-file";
+import { appendToDebugLogFile } from "./utils/log-file";
 import type { Message } from "esbuild";
 export const LOGGER_LEVELS = {
 	none: -1,

packages/wrangler/src/utils/debug-log-file.ts → packages/wrangler/src/utils/log-file.ts

@@ -2,17 +2,16 @@
 import path from "node:path";
 import { Mutex } from "miniflare";
 import onExit from "signal-exit";
-import { findWranglerToml } from "../config";
 import { getEnvironmentVariableFactory } from "../environment-variables/factory";
+import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
 import { logger, type LoggerLevel } from "../logger";
 
 const getDebugFileDir = getEnvironmentVariableFactory({
 	variableName: "WRANGLER_LOG_PATH",
 	defaultValue() {
-		const configPath = findWranglerToml();
-		const configDir = configPath ? path.dirname(configPath) : process.cwd();
+		const gobalWranglerConfigDir = getGlobalWranglerConfigPath();
 
-		return path.join(configDir, ".wrangler", "logs");
+		return path.join(gobalWranglerConfigDir, "logs");
 	},
 });
 
@@ -45,6 +44,7 @@
 
 let hasLoggedLocation = false;
 let hasLoggedError = false;
+let hasSeenErrorMessage = false;
 
 /**
  * Appends a message to the log file after waiting for pending writes to complete
@@ -62,21 +62,30 @@
 	if (!hasLoggedLocation) {
 		hasLoggedLocation = true;
 		const relativeFilepath = path.relative(process.cwd(), debugLogFilepath);
-		logger.debug(`🐛 Writing logs to "${relativeFilepath}"`); // use logger.debug here to not show this message by default -- since logging to a file is no longer opt-in
+		logger.debug(`🪵 Writing logs to "${relativeFilepath}"`); // use logger.debug here to not show this message by default -- since logging to a file is no longer opt-in
 		onExit(() => {
-			console.info(`🐛 Logs were written to "${relativeFilepath}"`);
+			// only print the log file location if the log file contains an error message
+			// TODO(consider): recommend opening an issue with the contents of this file?
+			if (hasSeenErrorMessage) {
+				logger.warn(`🪵 Logs were written to "${relativeFilepath}"`); // use logger.warn here so not to pollute stdout -- some commands print json to stdout
+			}
 		});
 	}
 
+	if (!hasSeenErrorMessage) {
+		// TODO(consider): adding `|| messageLevel === "warn"`
+		hasSeenErrorMessage = messageLevel === "error";
+	}
+
 	await mutex.runWith(async () => {
 		try {
 			await ensureDirectoryExists(debugLogFilepath);
 			await appendFile(debugLogFilepath, entry);
 		} catch (err) {
 			if (!hasLoggedError) {
 				hasLoggedError = true;
-				console.error(`Failed to write to log file`, err);
-				console.error(`Would have written:`, entry);
+				logger.error(`Failed to write to log file`, err);
+				logger.error(`Would have written:`, entry);
 			}
 		}
 	});