feat(unenv-preset): add native node:tty module support

Co-Authored-By: pbacondarwin@cloudflare.com <pete@bacondarwin.com>

Author: devin-ai-integration[bot]

.changeset/native-node-tty.md

@@ -0,0 +1,5 @@
+---
+"@cloudflare/unenv-preset": minor
+---
+
+Add support for native `node:tty` module when the `enable_nodejs_tty_module` and `experimental` compatibility flags are enabled.

packages/unenv-preset/src/preset.ts

@@ -83,6 +83,7 @@ export function getCloudflarePreset({
 	const sqliteOverrides = getSqliteOverrides(compat);
 	const dgramOverrides = getDgramOverrides(compat);
 	const streamWrapOverrides = getStreamWrapOverrides(compat);
+	const ttyOverrides = getTtyOverrides(compat);
 
 	// "dynamic" as they depend on the compatibility date and flags
 	const dynamicNativeModules = [
@@ -102,6 +103,7 @@ export function getCloudflarePreset({
 		...sqliteOverrides.nativeModules,
 		...dgramOverrides.nativeModules,
 		...streamWrapOverrides.nativeModules,
+		...ttyOverrides.nativeModules,
 	];
 
 	// "dynamic" as they depend on the compatibility date and flags
@@ -122,6 +124,7 @@ export function getCloudflarePreset({
 		...sqliteOverrides.hybridModules,
 		...dgramOverrides.hybridModules,
 		...streamWrapOverrides.hybridModules,
+		...ttyOverrides.hybridModules,
 	];
 
 	return {
@@ -752,3 +755,39 @@ function getStreamWrapOverrides({
 				hybridModules: [],
 			};
 }
+
+/**
+ * Returns the overrides for `node:tty` (unenv or workerd)
+ *
+ * The native tty implementation:
+ * - is experimental and has no default enable date
+ * - can be enabled with the "enable_nodejs_tty_module" flag
+ * - can be disabled with the "disable_nodejs_tty_module" flag
+ */
+function getTtyOverrides({
+	compatibilityFlags,
+}: {
+	compatibilityDate: string;
+	compatibilityFlags: string[];
+}): { nativeModules: string[]; hybridModules: string[] } {
+	const disabledByFlag = compatibilityFlags.includes(
+		"disable_nodejs_tty_module"
+	);
+
+	const enabledByFlag =
+		compatibilityFlags.includes("enable_nodejs_tty_module") &&
+		compatibilityFlags.includes("experimental");
+
+	const enabled = enabledByFlag && !disabledByFlag;
+
+	// When enabled, use the native `tty` module from workerd
+	return enabled
+		? {
+				nativeModules: ["tty"],
+				hybridModules: [],
+			}
+		: {
+				nativeModules: [],
+				hybridModules: [],
+			};
+}

packages/wrangler/e2e/unenv-preset/preset.test.ts

@@ -553,6 +553,27 @@ const localTestConfigs: TestConfig[] = [
 			},
 		},
 	],
+	// node:tty (experimental, no default enable date)
+	[
+		// TODO: add test for disabled by date (no date defined yet)
+		// TODO: add test for enabled by date (no date defined yet)
+		{
+			name: "tty enabled by flag",
+			compatibilityDate: "2024-09-23",
+			compatibilityFlags: ["enable_nodejs_tty_module", "experimental"],
+			expectRuntimeFlags: {
+				enable_nodejs_tty_module: true,
+			},
+		},
+		{
+			name: "tty disabled by flag",
+			compatibilityDate: "2024-09-23",
+			compatibilityFlags: ["disable_nodejs_tty_module", "experimental"],
+			expectRuntimeFlags: {
+				enable_nodejs_tty_module: false,
+			},
+		},
+	],
 ].flat() as TestConfig[];
 
 describe.each(localTestConfigs)(

packages/wrangler/e2e/unenv-preset/worker/index.ts

@@ -859,6 +859,38 @@ export const WorkerdTests: Record<string, () => void> = {
 		// `JSStreamSocket` is the default export of `node:_stream_wrap`
 		assertTypeOf(streamWrap, "default", "function");
 	},
+
+	async testTty() {
+		const tty = await import("node:tty");
+
+		// Common exports (both unenv stub and native workerd)
+		assertTypeOfProperties(tty, {
+			isatty: "function",
+			ReadStream: "function",
+			WriteStream: "function",
+		});
+
+		assertTypeOfProperties(tty.default, {
+			isatty: "function",
+			ReadStream: "function",
+			WriteStream: "function",
+		});
+
+		// isatty should return false (both unenv and workerd)
+		assert.strictEqual(tty.isatty(0), false);
+		assert.strictEqual(tty.isatty(1), false);
+		assert.strictEqual(tty.isatty(2), false);
+
+		// Both implementations throw when calling ReadStream/WriteStream constructors
+		assert.throws(
+			() => new (tty.ReadStream as any)(0),
+			/not implemented|ERR_METHOD_NOT_IMPLEMENTED/
+		);
+		assert.throws(
+			() => new (tty.WriteStream as any)(1),
+			/not implemented|ERR_METHOD_NOT_IMPLEMENTED/
+		);
+	},
 };
 
 /**