[BUG]: Compatibility issue with Cloudflare Workers

[liblaf]

What happened?

I attempted to use @octokit/webhooks in a Cloudflare Worker. When processing GitHub webhook events, the worker throws a TypeError: setTimeout(...).unref is not a function. This occurs because, quoting from Cloudflare Workers Timers Docs:

When called from a global level (on globalThis), functions such as clearTimeout and setTimeout will respect web standards rather than Node.js-specific functionality. For complete Node.js compatibility, you must call functions from the node:timers module.

webhooks.js/src/middleware/web/middleware.ts

Lines 83 to 91 in 6dd5d30

	timeout = setTimeout(() => {
	didTimeout = true;
	resolve(
	new Response("still processing\n", {
	status: 202,
	headers: { "Content-Type": "text/plain" },
	}),
	);
	}, 9000).unref();

Expected Behavior: The library should work in Cloudflare Workers without errors. Since unref() is not available in browser-like environments or CF Workers, the code should check for its existence before calling it or avoid using unref() in web-targeted builds.

Versions

@octokit/webhooks@13.8.0
octokit@4.1.3

# wrangler.toml
compatibility_date = "2025-04-27"
compatibility_flags = ["nodejs_compat"]

Relevant log output

2025-04-27 12:51:29.308 ERROR   /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170
 TypeError  setTimeout(...).unref is not a function
error stack:
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:148
  • 

  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:147
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:1
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:1
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170
  • index.js
        /home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/dev-pYYrLd/index.js:170

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[wolfy1339]

It would be good to know what files are being used, as in what files the module resolves to.

It would also be good to have an actual traceback that shows the references to the Octokit code, and not just your bundled code.

[liblaf]

It would be good to know what files are being used, as in what files the module resolves to.

It would also be good to have an actual traceback that shows the references to the Octokit code, and not just your bundled code.

@wolfy1339 Indeed, thanks for the suggestion. It took me some time to get the traceback working, but wrangler dev doesn't seem to have support for source maps.

[wrangler:err] TypeError: setTimeout(...).unref is not a function
    at null.<anonymous> (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/@octokit/webhooks/dist-bundle/index.js:752:13)
    at [object Object]
    at middleware2 (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/@octokit/webhooks/dist-bundle/index.js:743:26)
    at Object.fetch (file:///home/liblaf/github/liblaf/liblaf-bot/index.js:38:24)
    at fetchDispatcher (file:///home/liblaf/github/liblaf/liblaf-bot/.wrangler/tmp/bundle-FaKCCY/middleware-loader.entry.ts:54:17)
    at __facade_invokeChain__ (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/wrangler/templates/middleware/common.ts:53:9)
    at Object.next (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/wrangler/templates/middleware/common.ts:50:11)
    at jsonError (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/wrangler/templates/middleware/middleware-miniflare3-json-error.ts:22:30)
    at __facade_invokeChain__ (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/wrangler/templates/middleware/common.ts:53:9)
    at Object.next (file:///home/liblaf/github/liblaf/liblaf-bot/node_modules/wrangler/templates/middleware/common.ts:50:11)

Here is the code snippet around @octokit/webhooks/dist-bundle/index.js:743:26:

  const timeoutPromise = new Promise((resolve) => {
    timeout = setTimeout(() => {
      didTimeout = true;
      resolve(
        new Response("still processing\n", {
          status: 202,
          headers: { "Content-Type": "text/plain" }
        })
      );
    }, 9e3).unref();
  });

I believe this is the same code snippet I mentioned earlier.

[liblaf]

According to Web APIs | MDN, setTimeout() method returns a positive integer, rather than a Timeout object as in Node.js.