Disable io_uring use in libuv (heroku#1347) (#12)

* Disable `io_uring` use in `libuv`

amazonlinux/amazon-linux-2023#840 (comment)

* Update CHANGELOG.md

Co-authored-by: Colin Casey <[email protected]>

Author: htiwari1987

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## main
 
+- Setting `UV_USE_IO_URING=0` to disable `io_uring` use in `libuv` to prevent build timeouts. ([#1347](https://github.com/heroku/heroku-buildpack-nodejs/pull/1347))
+
 ## v232 (2023-12-07)
 
 - Added Node.js version 21.4.0.

bin/compile

@@ -61,6 +61,19 @@ source "$BP_DIR/lib/yarn-2.sh"
 
 export PATH="$BUILD_DIR/.heroku/node/bin:$BUILD_DIR/.heroku/yarn/bin":$PATH
 
+# 2024-11-20:
+# We started getting reports on build timeouts on the platform that were unexpected
+# due to the specific versions on Node.js and npm which had been working fine up until
+# this date. After some extensive digging, we believe we narrowed down the cause to
+# a bug in io_uring that affects the Amazon Linux 2023 release. There is a pending fix
+# which will be released around Dec. 9th but, until then, the workaround is set disable
+# the use of io_uring in libuv.
+#
+# See https://github.com/npm/cli/issues/7814#issuecomment-2488626736
+# → https://github.com/amazonlinux/amazon-linux-2023/issues/840#issuecomment-2485782075
+# → https://lore.kernel.org/io-uring/[email protected]/T/#m57570b5f8f2fc00d5a17cfe18ffeeba9fc23a43d
+export UV_USE_IO_URING=${UV_USE_IO_URING:-0}
+
 LOG_FILE=$(mktemp -t node-build-log.XXXXX)
 echo "" > "$LOG_FILE"
 

test/fixtures/libuv_io_uring_fix/README.md

@@ -0,0 +1 @@
+A fake README, to keep npm from polluting stderr.

test/fixtures/libuv_io_uring_fix/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "libuv-uring-fix",
+  "version": "0.0.1",
+  "description": "node buildpack integration test app",
+  "repository" : {
+    "type" : "git",
+    "url" : "http://github.com/example/example.git"
+  },
+  "engines": {
+    "node": "22.x"
+  },
+  "scripts": {
+    "build": "echo \"UV_USE_IO_URING is set to $UV_USE_IO_URING\""
+  }
+}

test/run

@@ -1535,6 +1535,21 @@ testUseNpm10() {
   assertCapturedSuccess
 }
 
+testDisableIoUringFix() {
+  compile "libuv_io_uring_fix"
+  assertCaptured "UV_USE_IO_URING is set to 0"
+  assertCapturedSuccess
+}
+
+testDisableIoUringFixUserOverride() {
+  cache_dir=$(mktmpdir)
+  env_dir=$(mktmpdir)
+  echo "1" > "$env_dir/UV_USE_IO_URING"
+  compile "libuv_io_uring_fix" "$cache_dir" "$env_dir"
+  assertCaptured "UV_USE_IO_URING is set to 1"
+  assertCapturedSuccess
+}
+
 # Utils
 
 pushd "$(dirname 0)" >/dev/null